rspec_api_documentation 0.3.1 → 0.4.0

data/lib/rspec_api_documentation.rb

@@ -1,4 +1,6 @@
 require 'active_support'
+require 'cgi'
+require 'json'
 
 module RspecApiDocumentation
   extend ActiveSupport::Autoload
@@ -21,6 +23,7 @@ module RspecApiDocumentation
   autoload :HtmlWriter
   autoload :JsonWriter
   autoload :IndexWriter
+  autoload :Curl
 
   def self.configuration
     @configuration ||= Configuration.new

data/lib/rspec_api_documentation/configuration.rb

@@ -46,6 +46,7 @@ module RspecApiDocumentation
     add_setting :template_path, :default => File.expand_path("../../../templates", __FILE__)
     add_setting :filter, :default => :all
     add_setting :exclusion_filter, :default => nil
+    add_setting :url_prefix, :default => ""
     add_setting :app, :default => lambda { |config|
       if defined?(Rails)
         Rails.application
@@ -54,6 +55,8 @@ module RspecApiDocumentation
       end
     }
 
+    add_setting :curl_host, :default => nil
+
     def settings
       @settings ||= {}
     end

data/lib/rspec_api_documentation/curl.rb

@@ -0,0 +1,52 @@
+require 'active_support/core_ext/object/to_query'
+
+module RspecApiDocumentation
+  class Curl < Struct.new(:method, :path, :data, :headers)
+    attr_accessor :host
+
+    def output(config_host)
+      self.host = config_host
+      send(method.downcase)
+    end
+
+    def post
+      "curl #{url} #{post_data} -X POST #{headers}"
+    end
+
+    def get
+      "curl #{url}#{get_data} -X GET #{headers}"
+    end
+
+    def put
+      "curl #{url} #{post_data} -X PUT #{headers}"
+    end
+
+    def delete
+      "curl #{url} -X DELETE #{headers}"
+    end
+
+    def url
+      "#{host}#{path}"
+    end
+
+    def headers
+      super.map do |k, v|
+        "-H \"#{format_header(k, v)}\""
+      end.join(" ")
+    end
+
+    def get_data
+      "?#{data}" unless data.blank?
+    end
+
+    def post_data
+      "-d \"#{data}\""
+    end
+
+    private
+    def format_header(header, value)
+      formatted_header = header.gsub(/^HTTP_/, '').titleize.split.join("-")
+      "#{formatted_header}: #{value}"
+    end
+  end
+end

data/lib/rspec_api_documentation/dsl.rb

@@ -1,5 +1,4 @@
-require 'rack/test/methods'
-require 'rack'
+require 'rack/test'
 require 'webmock'
 
 module RspecApiDocumentation
@@ -83,110 +82,115 @@ module RspecApiDocumentation
       end
     end
 
-    module InstanceMethods
-      def client
-        @client ||= TestClient.new(self)
-      end
+    def client
+      @client ||= TestClient.new(self)
+    end
 
-      def destination
-        @destination ||= TestServer.new(self)
-      end
+    def destination
+      @destination ||= TestServer.new(self)
+    end
 
-      def callback_url
-        raise "You must define callback_url"
-      end
+    def callback_url
+      raise "You must define callback_url"
+    end
 
-      def do_request(extra_params = {})
-        @extra_params = extra_params
-        params_or_body = nil
-        path_or_query = path
+    def do_request(extra_params = {})
+      @extra_params = extra_params
 
-        if method == :get && !query_string.blank?
-          path_or_query = path + "?#{query_string}"
-        else
-          params_or_body = respond_to?(:raw_post) ? raw_post : params
-        end
+      params_or_body = nil
+      path_or_query = path
 
-        client.send(method, path_or_query, params_or_body)
+      if method == :get && !query_string.blank?
+        path_or_query = path + "?#{query_string}"
+      else
+        params_or_body = respond_to?(:raw_post) ? raw_post : params
       end
 
-      def query_string
-        query = params.to_a.map do |param|
-          param.map! { |a| CGI.escape(a.to_s) }
-          param.join("=")
-        end
-        query.join("&")
-      end
+      client.send(method, path_or_query, params_or_body)
+    end
 
-      def params
-        return unless example.metadata[:parameters]
-        parameters = example.metadata[:parameters].inject({}) do |hash, param|
-          set_param(hash, param)
-        end
-        parameters.merge!(extra_params)
-        parameters
+    def query_string
+      query = params.to_a.map do |param|
+        param.map! { |a| CGI.escape(a.to_s) }
+        param.join("=")
       end
+      query.join("&")
+    end
 
-      def method
-        example.metadata[:method]
+    def params
+      return unless example.metadata[:parameters]
+      parameters = example.metadata[:parameters].inject({}) do |hash, param|
+        set_param(hash, param)
       end
+      parameters.merge!(extra_params)
+      parameters
+    end
 
-      def in_path?(param)
-        path_params.include?(param)
-      end
+    def method
+      example.metadata[:method]
+    end
 
-      def path_params
-        example.metadata[:path].scan(/:(\w+)/).flatten
-      end
+    def in_path?(param)
+      path_params.include?(param)
+    end
 
-      def path
-        example.metadata[:path].gsub(/:(\w+)/) do |match|
-          if respond_to?($1)
-            send($1)
-          else
-            match
-          end
+    def path_params
+      example.metadata[:path].scan(/:(\w+)/).flatten
+    end
+
+    def path
+      example.metadata[:path].gsub(/:(\w+)/) do |match|
+        if extra_params.keys.include?($1)
+          delete_extra_param($1)
+        elsif respond_to?($1)
+          send($1)
+        else
+          match
         end
       end
+    end
 
-      def app
-        RspecApiDocumentation.configuration.app
-      end
+    def app
+      RspecApiDocumentation.configuration.app
+    end
 
-      def explanation(text)
-        example.metadata[:explanation] = text
-      end
+    def explanation(text)
+      example.metadata[:explanation] = text
+    end
 
-      def status
-        last_response.status
-      end
+    def status
+      last_response.status
+    end
 
-      def response_body
-        last_response.body
-      end
+    def response_body
+      last_response.body
+    end
 
-      private
-      def extra_params
-        return {} if @extra_params.nil?
-        @extra_params.inject({}) do |h, (k, v)|
-          h[k.to_s] = v
-          h
-        end
+    private
+    def extra_params
+      return {} if @extra_params.nil?
+      @extra_params.inject({}) do |h, (k, v)|
+        h[k.to_s] = v
+        h
       end
+    end
 
-      def set_param(hash, param)
-        key = param[:name]
-        return hash if !respond_to?(key) || in_path?(key)
+    def delete_extra_param(key)
+      @extra_params.delete(key.to_sym) || @extra_params.delete(key.to_s)
+    end
 
-        if param[:scope]
-          hash[param[:scope].to_s] ||= {}
-          hash[param[:scope].to_s][key] = send(key)
-        else
-          hash[key] = send(key)
-        end
+    def set_param(hash, param)
+      key = param[:name]
+      return hash if !respond_to?(key) || in_path?(key)
 
-        hash
+      if param[:scope]
+        hash[param[:scope].to_s] ||= {}
+        hash[param[:scope].to_s][key] = send(key)
+      else
+        hash[key] = send(key)
       end
+
+      hash
     end
   end
 end

data/lib/rspec_api_documentation/html_writer.rb

@@ -49,6 +49,7 @@ module RspecApiDocumentation
 
     def initialize(example, configuration)
       @example = example
+      @host = configuration.curl_host
       self.template_path = configuration.template_path
     end
 
@@ -68,5 +69,20 @@ module RspecApiDocumentation
       basename = description.downcase.gsub(/\s+/, '_').gsub(/[^a-z_]/, '')
       "#{basename}.html"
     end
+
+    def requests
+      super.map do |hash|
+        if @host
+          hash[:curl] = hash[:curl].output(@host) if hash[:curl].is_a? RspecApiDocumentation::Curl
+        else
+          hash[:curl] = nil
+        end
+        hash
+      end
+    end
+
+    def url_prefix
+      configuration.url_prefix
+    end
   end
 end

data/lib/rspec_api_documentation/json_writer.rb

@@ -15,10 +15,10 @@ module RspecApiDocumentation
 
     def write
       File.open(docs_dir.join("index.json"), "w+") do |f|
-        f.write JsonIndex.new(index).to_json
+        f.write JsonIndex.new(index, configuration).to_json
       end
       index.examples.each do |example|
-        json_example = JsonExample.new(example)
+        json_example = JsonExample.new(example, configuration)
         FileUtils.mkdir_p(docs_dir.join(json_example.dirname))
         File.open(docs_dir.join(json_example.dirname, json_example.filename), "w+") do |f|
           f.write json_example.to_json
@@ -28,8 +28,9 @@ module RspecApiDocumentation
   end
 
   class JsonIndex
-    def initialize(index)
+    def initialize(index, configuration)
       @index = index
+      @configuration = configuration
     end
 
     def sections
@@ -37,7 +38,7 @@ module RspecApiDocumentation
     end
 
     def examples
-      @index.examples.map { |example| JsonExample.new(example) }
+      @index.examples.map { |example| JsonExample.new(example, @configuration) }
     end
 
     def to_json
@@ -59,8 +60,9 @@ module RspecApiDocumentation
   class JsonExample
     delegate :method, :to => :@example
 
-    def initialize(example)
+    def initialize(example, configuration)
       @example = example
+      @host = configuration.curl_host
     end
 
     def method_missing(method, *args, &block)
@@ -89,5 +91,16 @@ module RspecApiDocumentation
         :requests => requests
       }.to_json
     end
+
+    def requests
+      super.map do |hash|
+        if @host
+          hash[:curl] = hash[:curl].output(@host) if hash[:curl].is_a? RspecApiDocumentation::Curl
+        else
+          hash[:curl] = nil
+        end
+        hash
+      end
+    end
   end
 end

data/lib/rspec_api_documentation/test_client.rb

@@ -26,9 +26,10 @@ module RspecApiDocumentation
     end
 
     def last_headers
-      session.last_request.env.select do |k, v|
+      headers = session.last_request.env.select do |k, v|
         k =~ /^(HTTP_|CONTENT_TYPE)/
       end
+      Hash[headers]
     end
 
     def last_query_string
@@ -80,6 +81,7 @@ module RspecApiDocumentation
       request_metadata[:response_status_text] = Rack::Utils::HTTP_STATUS_CODES[last_response.status]
       request_metadata[:response_body] = prettify_json(last_response.body)
       request_metadata[:response_headers] = format_headers(last_response.headers)
+      request_metadata[:curl] = Curl.new(method.to_s, action, request_body, last_headers)
 
       metadata[:requests] ||= []
       metadata[:requests] << request_metadata

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec_api_documentation
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,77 +11,88 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-25 00:00:00.000000000Z
+date: 2012-02-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70151618292380 !ruby/object:Gem::Requirement
+  requirement: &70173877407600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *70151618292380
+  version_requirements: *70173877407600
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70151618291040 !ruby/object:Gem::Requirement
+  requirement: &70173877407120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70151618291040
+  version_requirements: *70173877407120
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70151618289580 !ruby/object:Gem::Requirement
+  requirement: &70173877406600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70151618289580
+  version_requirements: *70173877406600
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70151618288780 !ruby/object:Gem::Requirement
+  requirement: &70173877406140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.5
   type: :runtime
   prerelease: false
-  version_requirements: *70151618288780
+  version_requirements: *70173877406140
 - !ruby/object:Gem::Dependency
   name: mustache
-  requirement: &70151618287740 !ruby/object:Gem::Requirement
+  requirement: &70173877405680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.99.0
   type: :runtime
   prerelease: false
-  version_requirements: *70151618287740
+  version_requirements: *70173877405680
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70151618286920 !ruby/object:Gem::Requirement
+  requirement: &70173877405220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70173877405220
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70173877404740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *70151618286920
+  version_requirements: *70173877404740
 - !ruby/object:Gem::Dependency
   name: fakefs
-  requirement: &70151618285800 !ruby/object:Gem::Requirement
+  requirement: &70173877404360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,10 +100,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70151618285800
+  version_requirements: *70173877404360
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70151618283740 !ruby/object:Gem::Requirement
+  requirement: &70173877403900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -100,7 +111,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70151618283740
+  version_requirements: *70173877403900
 description: Generate API docs from your test suite
 email:
 - chris@smartlogicsolutions.com
@@ -113,6 +124,7 @@ files:
 - lib/rspec_api_documentation/api_documentation.rb
 - lib/rspec_api_documentation/api_formatter.rb
 - lib/rspec_api_documentation/configuration.rb
+- lib/rspec_api_documentation/curl.rb
 - lib/rspec_api_documentation/dsl.rb
 - lib/rspec_api_documentation/example.rb
 - lib/rspec_api_documentation/html_writer.rb