rspec_api_documentation 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33e8850c767dbaf09a5469f45db448b6119a1d9d
-  data.tar.gz: 7b83d526470ad8734fa2bdaa8c22d48792da4dd7
+  metadata.gz: cb2fb26b05b35089944ce6878bb2d866b2c64831
+  data.tar.gz: af9e4d78d7b53feb8233e9bf0770b1b0d168fbd7
 SHA512:
-  metadata.gz: c75314c9d799bc9296b7b3217e08261cf0df0b6bb4ba3ece99faaf36f2b08fa31a4ffba57a4b745bf877aa919937ecbbe2237ccd66bd62e0ad62d27da34c04a8
-  data.tar.gz: 50ef1cca010fb51adaaf3d8776e17d6fb5ed6b89baa65d377b5eb4153d59c0ea4396e482f206f6592d8044df50258ade305466e324f03789627dc7c7396cafcb
+  metadata.gz: 9677cb19ce2dc7e77067feaa666cda455ea57bf018b16119f2b94a1d188fb1e8d433e1cba207a400f43e7050a0161d19b391744940257e0734a31b6749eb92f5
+  data.tar.gz: 381d5c452e78ebd9ea62f8435d41211cb1c28ab48de53f0b8bd392a44ef89fd297bdf9b789e1305caf5e6ac5f50904ea023b08bc9a99e5804367705ef7a1b992

data/lib/rspec_api_documentation.rb

@@ -19,6 +19,7 @@ module RspecApiDocumentation
     autoload :Index
     autoload :ClientBase
     autoload :Headers
+    autoload :HttpTestClient
   end
 
   autoload :DSL

data/lib/rspec_api_documentation/client_base.rb

@@ -43,12 +43,16 @@ module RspecApiDocumentation
       document_example(method.to_s.upcase, path)
     end
 
+    def read_request_body
+      input = last_request.env["rack.input"]
+      input.rewind
+      input.read
+    end
+
     def document_example(method, path)
       return unless metadata[:document]
 
-      input = last_request.env["rack.input"]
-      input.rewind
-      request_body = input.read
+      request_body = read_request_body
 
       request_metadata = {}
 
@@ -58,7 +62,7 @@ module RspecApiDocumentation
 
       request_metadata[:request_method] = method
       request_metadata[:request_path] = path
-      request_metadata[:request_body] = request_body.empty? ? nil : request_body
+      request_metadata[:request_body] = request_body.empty? ? nil : request_body.force_encoding("UTF-8")
       request_metadata[:request_headers] = request_headers
       request_metadata[:request_query_parameters] = query_hash
       request_metadata[:request_content_type] = request_content_type

data/lib/rspec_api_documentation/dsl.rb

@@ -1,26 +1,36 @@
+require "rspec_api_documentation"
 require "rspec_api_documentation/dsl/resource"
 require "rspec_api_documentation/dsl/endpoint"
 require "rspec_api_documentation/dsl/callback"
 
-# Custom describe block that sets metadata to enable the rest of RAD
-#
-#   resource "Orders", :meta => :data do
-#     # ...
-#   end
-#
-# Params:
-# +args+:: Glob of RSpec's `describe` arguments
-# +block+:: Block to pass into describe
-#
-def self.resource(*args, &block)
-  options = if args.last.is_a?(Hash) then args.pop else {} end
-  options[:api_doc_dsl] = :resource
-  options[:resource_name] = args.first
-  options[:document] ||= :all
-  args.push(options)
-  describe(*args, &block)
+
+module RspecApiDocumentation
+  module DSL
+
+    # Custom describe block that sets metadata to enable the rest of RAD
+    #
+    #   resource "Orders", :meta => :data do
+    #     # ...
+    #   end
+    #
+    # Params:
+    # +args+:: Glob of RSpec's `describe` arguments
+    # +block+:: Block to pass into describe
+    #
+    def resource(*args, &block)
+      options = if args.last.is_a?(Hash) then args.pop else {} end
+      options[:api_doc_dsl] = :resource
+      options[:resource_name] = args.first
+      options[:document] ||= :all
+      args.push(options)
+      describe(*args, &block)
+    end
+  end
 end
 
+RSpec::Core::ExampleGroup.extend(RspecApiDocumentation::DSL)
+RSpec::Core::DSL.expose_example_group_alias(:resource)
+
 RSpec.configuration.include RspecApiDocumentation::DSL::Resource, :api_doc_dsl => :resource
 RSpec.configuration.include RspecApiDocumentation::DSL::Endpoint, :api_doc_dsl => :endpoint
 RSpec.configuration.include RspecApiDocumentation::DSL::Callback, :api_doc_dsl => :callback

data/lib/rspec_api_documentation/http_test_client.rb

@@ -0,0 +1,120 @@
+begin
+  require 'faraday'
+rescue LoadError
+  raise "Faraday needs to be installed before using the HttpTestClient"
+end
+
+Faraday::Request.register_middleware :request_saver => lambda { RspecApiDocumentation::RequestSaver }
+
+module RspecApiDocumentation
+  class RequestSaver < Faraday::Middleware
+    attr_reader :client
+
+    def initialize(app, client)
+      super(app)
+      @client = client
+    end
+
+    def call(env)
+      client.last_request = env
+
+      @app.call(env).on_complete do |env|
+        client.last_response = env
+      end
+    end
+  end
+
+  class HttpTestClient < ClientBase
+    attr_reader :last_response, :last_request
+
+    LastRequest = Struct.new(:url, :method, :request_headers, :body)
+
+    def request_headers
+      env_to_headers(last_request.request_headers)
+    end
+
+    def response_headers
+      last_response.response_headers
+    end
+
+    def query_string
+      last_request.url.query
+    end
+
+    def status
+      last_response.status
+    end
+
+    def response_body
+      last_response.body
+    end
+
+    def request_content_type
+      last_request.request_headers["CONTENT_TYPE"]
+    end
+
+    def response_content_type
+      last_response.request_headers["CONTENT_TYPE"]
+    end
+
+    def do_request(method, path, params, request_headers)
+      http_test_session.send(method, path, params, headers(method, path, params, request_headers))
+    end
+
+    def last_request=(env)
+      @last_request = LastRequest.new(env.url, env.method, env.request_headers, env.body)
+    end
+
+    def last_response=(env)
+      @last_response = env
+    end
+
+    protected
+
+    def headers(*args)
+      headers_to_env(super)
+    end
+
+    def handle_multipart_body(request_headers, request_body)
+      parsed_parameters = Rack::Request.new({
+        "CONTENT_TYPE" => request_headers["Content-Type"],
+        "rack.input" => StringIO.new(request_body)
+      }).params
+
+      clean_out_uploaded_data(parsed_parameters, request_body)
+    end
+
+    def read_request_body
+      if [:post, :put].include?(last_request.method)
+        last_request.body || ""
+      else
+        ""
+      end
+    end
+
+    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
+        faraday.request :request_saver, self    # save the request and response
+        faraday.adapter Faraday.default_adapter # make requests with Net::HTTP
+      end
+    end
+  end
+end

data/templates/rspec_api_documentation/html_example.mustache

@@ -4,7 +4,7 @@
     <title>{{resource_name}} API</title>
     <meta charset="utf-8">
     <style>
-      {{ styles }}
+      {{{ styles }}}
     </style>
   </head>
   <body>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec_api_documentation
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Chris Cahoon
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-24 00:00:00.000000000 Z
+date: 2014-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -206,6 +206,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: thin
+  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'
 description: Generate API docs from your test suite
 email:
 - chris@smartlogicsolutions.com
@@ -228,6 +256,7 @@ files:
 - lib/rspec_api_documentation/dsl/resource.rb
 - lib/rspec_api_documentation/example.rb
 - lib/rspec_api_documentation/headers.rb
+- lib/rspec_api_documentation/http_test_client.rb
 - lib/rspec_api_documentation/index.rb
 - lib/rspec_api_documentation/oauth2_mac_client.rb
 - lib/rspec_api_documentation/rack_test_client.rb