rspec_api_documentation 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb2fb26b05b35089944ce6878bb2d866b2c64831
-  data.tar.gz: af9e4d78d7b53feb8233e9bf0770b1b0d168fbd7
+  metadata.gz: b1f384a163dd016f784e49be257ea8c41b36c462
+  data.tar.gz: dd948cacf84ba686f5368bafdc39bf70dfa5fc2b
 SHA512:
-  metadata.gz: 9677cb19ce2dc7e77067feaa666cda455ea57bf018b16119f2b94a1d188fb1e8d433e1cba207a400f43e7050a0161d19b391744940257e0734a31b6749eb92f5
-  data.tar.gz: 381d5c452e78ebd9ea62f8435d41211cb1c28ab48de53f0b8bd392a44ef89fd297bdf9b789e1305caf5e6ac5f50904ea023b08bc9a99e5804367705ef7a1b992
+  metadata.gz: 0eeb83e3a3f341a0df20d1cd50826d34ba29dc45dde5ddfcc1b82d8be3c36936cbcaf093d7f6d2c96b5fb44af6f5954e8267069b172b6030904e418377245837
+  data.tar.gz: 84093be0b80f3550526e337e0038dfab66e857cd66e3629e29ca3568e1a87e486a54b29897f0ed7b37ef58f744e7b2eb53d4d5c99db5b8e5cd4d03f63fc0ad80

data/lib/rspec_api_documentation.rb

@@ -1,6 +1,7 @@
 require 'active_support'
 require 'active_support/inflector'
 require 'active_support/core_ext/hash/conversions'
+require 'active_support/core_ext/hash/deep_merge'
 require 'cgi'
 require 'json'
 

data/lib/rspec_api_documentation/assets/stylesheets/rspec_api_documentation/styles.css

@@ -45,11 +45,6 @@ a{
   font-weight: inherit;
 }
 
-p {
-  padding: 15px;
-  font-size: 130%;
-}
-
 h1, h2, h3, h4, h5, h6 {
   font-weight: bold;
   color: #404040;
@@ -99,4 +94,4 @@ table th, table td {
   padding: 10px 10px 9px;
   line-height: 18px;
   text-align: left;
-}
+}

data/lib/rspec_api_documentation/client_base.rb

@@ -84,5 +84,19 @@ module RspecApiDocumentation
     def headers(method, path, params, request_headers)
       request_headers || {}
     end
+
+    def clean_out_uploaded_data(params, request_body)
+      params.each do |_, value|
+        if value.is_a?(Hash)
+          if value.has_key?(:tempfile)
+            data = value[:tempfile].read
+            request_body = request_body.gsub(data, "[uploaded data]")
+          else
+            request_body = clean_out_uploaded_data(value,request_body)
+          end
+        end
+      end
+      request_body
+    end
   end
 end

data/lib/rspec_api_documentation/configuration.rb

@@ -106,6 +106,18 @@ module RspecApiDocumentation
       @client_method ||= :client
     end
 
+    def disable_dsl_status!
+      RspecApiDocumentation::DSL::Endpoint.module_eval <<-RUBY
+        undef status
+      RUBY
+    end
+
+    def disable_dsl_method!
+      RspecApiDocumentation::DSL::Endpoint.module_eval <<-RUBY
+        undef method
+      RUBY
+    end
+
     def settings
       @settings ||= {}
     end

data/lib/rspec_api_documentation/dsl.rb

@@ -35,3 +35,8 @@ RSpec.configuration.include RspecApiDocumentation::DSL::Resource, :api_doc_dsl =
 RSpec.configuration.include RspecApiDocumentation::DSL::Endpoint, :api_doc_dsl => :endpoint
 RSpec.configuration.include RspecApiDocumentation::DSL::Callback, :api_doc_dsl => :callback
 RSpec.configuration.backtrace_exclusion_patterns << %r{lib/rspec_api_documentation/dsl/}
+
+if defined? RSpec::Rails
+  RSpec::Rails::DIRECTORY_MAPPINGS[:acceptance] = %w[spec acceptance]
+  RSpec.configuration.infer_spec_type_from_file_location!
+end

data/lib/rspec_api_documentation/dsl/endpoint.rb

@@ -8,7 +8,7 @@ module RspecApiDocumentation::DSL
     extend ActiveSupport::Concern
     include Rack::Test::Utils
 
-    delegate :response_headers, :status, :response_status, :response_body, :to => :rspec_api_documentation_client
+    delegate :response_headers, :response_status, :response_body, :to => :rspec_api_documentation_client
 
     module ClassMethods
       def example_request(description, params = {}, &block)
@@ -35,16 +35,16 @@ module RspecApiDocumentation::DSL
       params_or_body = nil
       path_or_query = path
 
-      if method == :get && !query_string.blank?
+      if http_method == :get && !query_string.blank?
         path_or_query += "?#{query_string}"
       else
-        if respond_to?(:raw_post) 
+        if respond_to?(:raw_post)
           params_or_body = raw_post
         else
           formatter = RspecApiDocumentation.configuration.post_body_formatter
           case formatter
           when :json
-            params_or_body = params.to_json
+            params_or_body = params.empty? ? nil : params.to_json
           when :xml
             params_or_body = params.to_xml
           when Proc
@@ -55,7 +55,7 @@ module RspecApiDocumentation::DSL
         end
       end
 
-      rspec_api_documentation_client.send(method, path_or_query, params_or_body, headers)
+      rspec_api_documentation_client.send(http_method, path_or_query, params_or_body, headers)
     end
 
     def query_string
@@ -66,7 +66,7 @@ module RspecApiDocumentation::DSL
       parameters = example.metadata.fetch(:parameters, {}).inject({}) do |hash, param|
         set_param(hash, param)
       end
-      parameters.merge!(extra_params)
+      parameters.deep_merge!(extra_params)
       parameters
     end
 
@@ -87,10 +87,18 @@ module RspecApiDocumentation::DSL
       end
     end
 
-    def method
+    def http_method
       example.metadata[:method]
     end
 
+    def method
+      http_method
+    end
+
+    def status
+      rspec_api_documentation_client.status
+    end
+
     def in_path?(param)
       path_params.include?(param)
     end
@@ -128,6 +136,7 @@ module RspecApiDocumentation::DSL
     def extra_params
       return {} if @extra_params.nil?
       @extra_params.inject({}) do |h, (k, v)|
+        v = v.is_a?(Hash) ? v.stringify_keys : v
         h[k.to_s] = v
         h
       end

data/lib/rspec_api_documentation/dsl/resource.rb

@@ -51,28 +51,25 @@ module RspecApiDocumentation::DSL
       end
 
       private
-      def parameters
-        metadata[:parameters] ||= []
-        if superclass_metadata && metadata[:parameters].equal?(superclass_metadata[:parameters])
-          metadata[:parameters] = Marshal.load(Marshal.dump(superclass_metadata[:parameters]))
+
+      def safe_metadata(field, default)
+        metadata[field] ||= default
+        if superclass_metadata && metadata[field].equal?(superclass_metadata[field])
+          metadata[field] = Marshal.load(Marshal.dump(superclass_metadata[field]))
         end
-        metadata[:parameters]
+        metadata[field]
+      end
+
+      def parameters
+        safe_metadata(:parameters, [])
       end
 
       def response_fields
-        metadata[:response_fields] ||= []
-        if superclass_metadata && metadata[:response_fields].equal?(superclass_metadata[:response_fields])
-          metadata[:response_fields] = Marshal.load(Marshal.dump(superclass_metadata[:response_fields]))
-        end
-        metadata[:response_fields]
+        safe_metadata(:response_fields, [])
       end
 
       def headers
-        metadata[:headers] ||= {}
-        if superclass_metadata && metadata[:headers].equal?(superclass_metadata[:headers])
-          metadata[:headers] = Marshal.load(Marshal.dump(superclass_metadata[:headers]))
-        end
-        metadata[:headers]
+        safe_metadata(:headers, {})
       end
 
       def parameter_keys

data/lib/rspec_api_documentation/headers.rb

@@ -8,6 +8,7 @@ module RspecApiDocumentation
         # HTTP_ACCEPT_CHARSET => Accept-Charset
         if key =~ /^(HTTP_|CONTENT_TYPE)/
           header = key.gsub(/^HTTP_/, '').titleize.split.join("-")
+          header.concat('-Id') if key.scan(/_ID\Z/).any?
           headers[header] = value
         end
       end

data/lib/rspec_api_documentation/http_test_client.rb

@@ -94,21 +94,6 @@ module RspecApiDocumentation
 
     private
 
-    def clean_out_uploaded_data(params, request_body)
-      params.each do |_, value|
-        if value.is_a?(Hash)
-          if value.has_key?(:tempfile)
-            data = value[:tempfile].read
-            request_body = request_body.gsub(data, "[uploaded data]")
-          else
-            request_body = clean_out_uploaded_data(value,request_body)
-          end
-        end
-      end
-      request_body
-    end
-
-
     def http_test_session
       ::Faraday.new(:url => options[:host]) do |faraday|
         faraday.request :url_encoded            # form-encode POST params

data/lib/rspec_api_documentation/rack_test_client.rb

@@ -53,20 +53,6 @@ module RspecApiDocumentation
 
     private
 
-    def clean_out_uploaded_data(params,request_body)
-      params.each do |_, value|
-        if value.is_a?(Hash)
-          if value.has_key?(:tempfile)
-            data = value[:tempfile].read
-            request_body = request_body.gsub(data, "[uploaded data]")
-          else
-            request_body = clean_out_uploaded_data(value,request_body)
-          end
-        end
-      end
-      request_body
-    end
-
     def rack_test_session
       @rack_test_session ||= Struct.new(:app) do
         begin

data/lib/rspec_api_documentation/views/markup_example.rb

@@ -19,7 +19,7 @@ module RspecApiDocumentation
       end
 
       def dirname
-        resource_name.downcase.gsub(/\s+/, '_').gsub(":", "_")
+        resource_name.to_s.downcase.gsub(/\s+/, '_').gsub(":", "_")
       end
 
       def filename

data/lib/rspec_api_documentation/writers/combined_text_writer.rb

@@ -44,7 +44,7 @@ module RspecApiDocumentation
       end
 
       def resource_name
-        example.resource_name.downcase.gsub(/\s+/, '_')
+        example.resource_name.to_s.downcase.gsub(/\s+/, '_')
       end
 
       def description

data/lib/rspec_api_documentation/writers/json_writer.rb

@@ -74,7 +74,7 @@ module RspecApiDocumentation
       end
 
       def dirname
-        resource_name.downcase.gsub(/\s+/, '_')
+        resource_name.to_s.downcase.gsub(/\s+/, '_').sub(/^\//,'')
       end
 
       def filename

data/templates/rspec_api_documentation/html_example.mustache

@@ -16,7 +16,7 @@
         <h3>{{ http_method }} {{ route }}</h3>
         {{# explanation }}
           <p class="explanation">
-            {{ explanation }}
+            {{{ explanation }}}
           </p>
         {{/ explanation }}
 
@@ -81,8 +81,10 @@
         {{# requests }}
           <h3>Request</h3>
 
-          <h4>Headers</h4>
-          <pre class="request headers">{{ request_headers_text }}</pre>
+          {{# request_headers_text }}
+            <h4>Headers</h4>
+            <pre class="request headers">{{ request_headers_text }}</pre>
+          {{/ request_headers_text }}
 
           <h4>Route</h4>
           <pre class="request route highlight">{{ request_method }} {{ request_path }}</pre>
@@ -104,8 +106,10 @@
 
           {{# response_status }}
             <h3>Response</h3>
-            <h4>Headers</h4>
-            <pre class="response headers">{{ response_headers_text }}</pre>
+            {{# response_headers_text }}
+              <h4>Headers</h4>
+              <pre class="response headers">{{ response_headers_text }}</pre>
+            {{/ response_headers_text }}
             <h4>Status</h4>
             <pre class="response status">{{ response_status }} {{ response_status_text}}</pre>
             {{# response_body }}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec_api_documentation
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Chris Cahoon
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-09 00:00:00.000000000 Z
+date: 2015-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: fakefs
   requirement: !ruby/object:Gem::Requirement
@@ -309,7 +323,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A double black belt for your docs