Data in cURL examples is not quoted properly

[mindscratch]

The cURL examples genreated when doing a POST or PUT don't properly quote the data associated with the -d flag.

For example, the rad-example app has the following cURL example for creating an order:

curl "http://rad-example.herokuapp.com/orders" -d "{"order":{"name":"Order 1","paid":true,"email":"email@example.com"}}" -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Host: example.org" -H "Cookie: "

source: http://rad-example.herokuapp.com/docs/orders/creating_an_order

If you copy/paste that example it'll fail because the data uses all double quotes. Instead the outer quotes should be single quotes such as:

-d '{"order":{"name":"Order 1","paid":true,"email":"email@example.com"}}'

[mindscratch]

If I was at home, I'd fork and fix it but I believe the double-quotes here just need to be changed to single quotes.

[mrbrdo]

Temporary fix, put this into spec/support/api_doc.rb

RspecApiDocumentation::Curl # force autoload
module RspecApiDocumentation
  class Curl
    def post_data
      escaped_data = data.gsub('"', '\\"')
      "-d \"#{escaped_data}\""
    end
  end
end

This should be updated, I ran into this issue as well.
This is better than using single quotes since then you'd have to escape the single quotes anyway.

[mrbrdo]

A little better, quote in single quotes and escape any single quote (can't use ', but \u0027 works).

RspecApiDocumentation::Curl
module RspecApiDocumentation
  class Curl
    def post_data
      escaped_data = data.gsub("'", "\\u0027")
      "-d '#{escaped_data}'"
    end
  end
end