rspec_api_documentation 0.8.0 → 0.9.0

data/lib/rspec_api_documentation/client_base.rb

@@ -21,6 +21,14 @@ module RspecApiDocumentation
       process :delete, *args
     end
 
+    def head(*args)
+      process :head, *args
+    end
+
+    def patch(*args)
+      process :patch, *args
+    end
+
     def response_status
       status
     end
@@ -62,7 +70,7 @@ module RspecApiDocumentation
       strings = query_string.split("&")
       arrays = strings.map do |segment|
         k,v = segment.split("=")
-        [k, CGI.unescape(v)]
+        [k, v && CGI.unescape(v)]
       end
       Hash[arrays]
     end

data/lib/rspec_api_documentation/curl.rb

@@ -40,7 +40,8 @@ module RspecApiDocumentation
     end
 
     def post_data
-      "-d \"#{data}\""
+      escaped_data = data.to_s.gsub("'", "\\u0027")
+      "-d '#{escaped_data}'"
     end
 
     private

data/lib/rspec_api_documentation/dsl/endpoint.rb

@@ -1,8 +1,11 @@
 require 'rspec/core/formatters/base_formatter'
+require 'rack/utils'
+require 'rack/test/utils'
 
 module RspecApiDocumentation::DSL
   module Endpoint
     extend ActiveSupport::Concern
+    include Rack::Test::Utils
 
     delegate :response_headers, :status, :response_status, :response_body, :to => :client
 
@@ -36,7 +39,7 @@ module RspecApiDocumentation::DSL
       path_or_query = path
 
       if method == :get && !query_string.blank?
-        path_or_query = path + "?#{query_string}"
+        path_or_query += "?#{query_string}"
       else
         params_or_body = respond_to?(:raw_post) ? raw_post : params
       end
@@ -45,11 +48,7 @@ module RspecApiDocumentation::DSL
     end
 
     def query_string
-      query = params.to_a.map do |param|
-        param.map! { |a| CGI.escape(a.to_s) }
-        param.join("=")
-      end
-      query.join("&")
+      build_nested_query(params || {})
     end
 
     def params
@@ -62,7 +61,15 @@ module RspecApiDocumentation::DSL
     end
 
     def headers
-      example.metadata[:headers]
+      return unless example.metadata[:headers]
+      example.metadata[:headers].inject({}) do |hash, (header, value)|
+        if value.is_a?(Symbol)
+          hash[header] = send(value) if respond_to?(value)
+        else
+          hash[header] = value
+        end
+        hash
+      end
     end
 
     def method

data/lib/rspec_api_documentation/dsl/resource.rb

@@ -19,6 +19,8 @@ module RspecApiDocumentation::DSL
       define_action :post
       define_action :put
       define_action :delete
+      define_action :head
+      define_action :patch
 
       def callback(*args, &block)
         require 'webmock'

data/lib/rspec_api_documentation/json_writer.rb

@@ -81,14 +81,20 @@ module RspecApiDocumentation
       "#{basename}.json"
     end
 
-    def to_json
+    def as_json
       {
         :resource => resource_name,
+        :http_method => http_method,
+        :route => route,
         :description => description,
         :explanation => explanation,
         :parameters => respond_to?(:parameters) ? parameters : [],
         :requests => requests
-      }.to_json
+      }
+    end
+
+    def to_json
+      as_json.to_json
     end
 
     def requests

data/lib/rspec_api_documentation/oauth2_mac_client.rb

@@ -48,9 +48,15 @@ module RspecApiDocumentation
 
     class ProxyApp < Struct.new(:client, :app)
       def call(env)
+        env["QUERY_STRING"] = query_string_hack(env)
         client.last_request = Struct.new(:env, :content_type).new(env, env["CONTENT_TYPE"])
         app.call(env.merge("SCRIPT_NAME" => ""))
       end
+
+    private
+      def query_string_hack(env)
+        env["QUERY_STRING"].gsub('%5B', '[').gsub('%5D', ']').gsub(/\[\d+/) { |s| "#{$1}[" }
+      end
     end
 
     def access_token

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec_api_documentation
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-10 00:00:00.000000000 Z
+date: 2013-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -196,7 +196,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.5.5
+        version: 0.6.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -204,7 +204,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.5.5
+        version: 0.6.2
 - !ruby/object:Gem::Dependency
   name: rack-oauth2
   requirement: !ruby/object:Gem::Requirement
@@ -230,51 +230,51 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/rspec_api_documentation/api_documentation.rb
+- lib/rspec_api_documentation.rb
+- lib/tasks/docs.rake
+- lib/rspec_api_documentation/rack_test_client.rb
 - lib/rspec_api_documentation/api_formatter.rb
-- lib/rspec_api_documentation/client_base.rb
-- lib/rspec_api_documentation/combined_json_writer.rb
-- lib/rspec_api_documentation/combined_text_writer.rb
-- lib/rspec_api_documentation/configuration.rb
+- lib/rspec_api_documentation/html_writer.rb
 - lib/rspec_api_documentation/curl.rb
+- lib/rspec_api_documentation/json_iodocs_writer.rb
+- lib/rspec_api_documentation/index.rb
+- lib/rspec_api_documentation/headers.rb
+- lib/rspec_api_documentation/wurl_writer.rb
+- lib/rspec_api_documentation/oauth2_mac_client.rb
 - lib/rspec_api_documentation/dsl/callback.rb
 - lib/rspec_api_documentation/dsl/endpoint.rb
 - lib/rspec_api_documentation/dsl/resource.rb
+- lib/rspec_api_documentation/json_writer.rb
 - lib/rspec_api_documentation/dsl.rb
+- lib/rspec_api_documentation/configuration.rb
+- lib/rspec_api_documentation/combined_json_writer.rb
 - lib/rspec_api_documentation/example.rb
-- lib/rspec_api_documentation/headers.rb
-- lib/rspec_api_documentation/html_writer.rb
-- lib/rspec_api_documentation/index.rb
-- lib/rspec_api_documentation/index_writer.rb
-- lib/rspec_api_documentation/json_iodocs_writer.rb
-- lib/rspec_api_documentation/json_writer.rb
-- lib/rspec_api_documentation/oauth2_mac_client.rb
-- lib/rspec_api_documentation/rack_test_client.rb
-- lib/rspec_api_documentation/railtie.rb
+- lib/rspec_api_documentation/api_documentation.rb
 - lib/rspec_api_documentation/test_server.rb
-- lib/rspec_api_documentation/wurl_writer.rb
-- lib/rspec_api_documentation.rb
-- lib/tasks/docs.rake
-- templates/assets/img/glyphicons-halflings-white.png
-- templates/assets/img/glyphicons-halflings.png
-- templates/assets/javascripts/application.js
-- templates/assets/javascripts/codemirror.js
+- lib/rspec_api_documentation/railtie.rb
+- lib/rspec_api_documentation/index_writer.rb
+- lib/rspec_api_documentation/combined_text_writer.rb
+- lib/rspec_api_documentation/client_base.rb
 - templates/assets/javascripts/jquery-1-7-2.js
+- templates/assets/javascripts/codemirror.js
 - templates/assets/javascripts/jquery-base64.js
-- templates/assets/javascripts/jquery-livequery.js
 - templates/assets/javascripts/jquery-ui-1-8-16-min.js
-- templates/assets/javascripts/mode/css/css.js
-- templates/assets/javascripts/mode/htmlmixed/htmlmixed.js
 - templates/assets/javascripts/mode/javascript/javascript.js
+- templates/assets/javascripts/mode/css/css.js
 - templates/assets/javascripts/mode/xml/xml.js
+- templates/assets/javascripts/mode/htmlmixed/htmlmixed.js
+- templates/assets/javascripts/jquery-livequery.js
+- templates/assets/javascripts/application.js
+- templates/assets/img/glyphicons-halflings-white.png
+- templates/assets/img/glyphicons-halflings.png
 - templates/assets/stylesheets/application.css
-- templates/assets/stylesheets/bootstrap.css
 - templates/assets/stylesheets/codemirror.css
-- templates/rspec_api_documentation/example.json
-- templates/rspec_api_documentation/html_example.mustache
+- templates/assets/stylesheets/bootstrap.css
 - templates/rspec_api_documentation/html_index.mustache
 - templates/rspec_api_documentation/index.json
 - templates/rspec_api_documentation/wurl_example.mustache
+- templates/rspec_api_documentation/html_example.mustache
+- templates/rspec_api_documentation/example.json
 - templates/rspec_api_documentation/wurl_index.mustache
 homepage: http://smartlogicsolutions.com
 licenses: []
@@ -296,7 +296,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A double black belt for your docs