rspec_api_documentation 0.5.1 → 0.5.2

data/lib/rspec_api_documentation/dsl.rb

@@ -1,218 +1,17 @@
-require 'rspec/core/formatters/base_formatter'
-
-module RspecApiDocumentation
-  module DSL
-    extend ActiveSupport::Concern
-
-    delegate :response_headers, :status, :response_body, :to => :client
-    delegate :request_method, :request_headers, :request_body, :to => :destination
-
-    module ClassMethods
-      def self.define_action(method)
-        define_method method do |*args, &block|
-          options = if args.last.is_a?(Hash) then args.pop else {} end
-          options[:method] = method
-          options[:route] = args.first
-          args.push(options)
-          args[0] = "#{method.to_s.upcase} #{args[0]}"
-          context(*args, &block)
-        end
-      end
-
-      define_action :get
-      define_action :post
-      define_action :put
-      define_action :delete
-
-      def parameter(name, description, options = {})
-        parameters.push(options.merge(:name => name.to_s, :description => description))
-      end
-
-      def required_parameters(*names)
-        names.each do |name|
-          param = parameters.find { |param| param[:name] == name.to_s }
-          raise "Undefined parameters can not be required." unless param
-          param[:required] = true
-        end
-      end
-
-      def callback(description, &block)
-        require 'webmock'
-        self.send(:include, WebMock::API)
-        context(description, &block)
-      end
-
-      def trigger_callback(&block)
-        define_method(:do_callback) do
-          require 'rack'
-          stub_request(:any, callback_url).to_rack(destination)
-          instance_eval &block
-        end
-      end
-
-      def scope_parameters(scope, keys)
-        return unless metadata[:parameters]
-
-        if keys == :all
-          keys = parameter_keys.map(&:to_s)
-        else
-          keys = keys.map(&:to_s)
-        end
-
-        keys.each do |key|
-          param = parameters.detect { |param| param[:name] == key }
-          param[:scope] = scope if param
-        end
-      end
-
-      def example_request(description, params = {}, &block)
-        file_path = caller.first[0, caller.first =~ /:/]
-
-        location = caller.first[0, caller.first =~ /(:in|$)/]
-        location = RSpec::Core::Formatters::BaseFormatter::relative_path(location)
-
-        example description, :location => location, :file_path => file_path do
-          do_request(params)
-          instance_eval &block if block_given?
-        end
-      end
-
-      private
-      def parameters
-        metadata[:parameters] ||= []
-        if superclass_metadata && metadata[:parameters].equal?(superclass_metadata[:parameters])
-          metadata[:parameters] = Marshal.load(Marshal.dump(superclass_metadata[:parameters]))
-        end
-        metadata[:parameters]
-      end
-
-      def parameter_keys
-        parameters.map { |param| param[:name] }
-      end
-    end
-
-    def client
-      @client ||= RackTestClient.new(self)
-    end
-
-    def destination
-      @destination ||= TestServer.new(self)
-    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
-
-      if method == :get && !query_string.blank?
-        path_or_query = path + "?#{query_string}"
-      else
-        params_or_body = respond_to?(:raw_post) ? raw_post : params
-      end
-
-      client.send(method, path_or_query, params_or_body)
-    end
-
-    def no_doc(&block)
-      requests = example.metadata[:requests]
-      example.metadata[:requests] = []
-
-      instance_eval &block
-
-      example.metadata[:requests] = requests
-    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
-
-    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 method
-      example.metadata[:method]
-    end
-
-    def in_path?(param)
-      path_params.include?(param)
-    end
-
-    def path_params
-      example.metadata[:route].scan(/:(\w+)/).flatten
-    end
-
-    def path
-      example.metadata[:route].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 explanation(text)
-      example.metadata[:explanation] = text
-    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 delete_extra_param(key)
-      @extra_params.delete(key.to_sym) || @extra_params.delete(key.to_s)
-    end
-
-    def set_param(hash, param)
-      key = param[:name]
-      return hash if !respond_to?(key) || in_path?(key)
-
-      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
+require "rspec_api_documentation/dsl/resource"
+require "rspec_api_documentation/dsl/endpoint"
+require "rspec_api_documentation/dsl/callback"
 
 def self.resource(*args, &block)
   options = if args.last.is_a?(Hash) then args.pop else {} end
-  options[:api_docs_dsl] = true
+  options[:api_doc_dsl] = :resource
   options[:resource_name] = args.first
   options[:document] ||= :all
   args.push(options)
   describe(*args, &block)
 end
 
-RSpec.configuration.include RspecApiDocumentation::DSL, :api_docs_dsl => true
+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
 RSpec.configuration.backtrace_clean_patterns << %r{lib/rspec_api_documentation/dsl\.rb}

data/lib/rspec_api_documentation/dsl/callback.rb

@@ -0,0 +1,25 @@
+module RspecApiDocumentation::DSL
+  module Callback
+    extend ActiveSupport::Concern
+
+    delegate :request_method, :request_headers, :request_body, :to => :destination
+
+    module ClassMethods
+      def trigger_callback(&block)
+        define_method(:do_callback) do
+          require 'rack'
+          stub_request(:any, callback_url).to_rack(destination)
+          instance_eval &block
+        end
+      end
+    end
+
+    def destination
+      @destination ||= RspecApiDocumentation::TestServer.new(self)
+    end
+
+    def callback_url
+      raise "You must define callback_url"
+    end
+  end
+end

data/lib/rspec_api_documentation/dsl/endpoint.rb

@@ -0,0 +1,119 @@
+require 'rspec/core/formatters/base_formatter'
+
+module RspecApiDocumentation::DSL
+  module Endpoint
+    extend ActiveSupport::Concern
+
+    delegate :response_headers, :status, :response_body, :to => :client
+
+    module ClassMethods
+      def example_request(description, params = {}, &block)
+        file_path = caller.first[0, caller.first =~ /:/]
+
+        location = caller.first[0, caller.first =~ /(:in|$)/]
+        location = relative_path(location)
+
+        example description, :location => location, :file_path => file_path do
+          do_request(params)
+          instance_eval &block if block_given?
+        end
+      end
+
+      private
+      # from rspec-core
+      def relative_path(line)
+        line = line.sub(File.expand_path("."), ".")
+        line = line.sub(/\A([^:]+:\d+)$/, '\\1')
+        return nil if line == '-e:1'
+        line
+      end
+    end
+
+    def do_request(extra_params = {})
+      @extra_params = extra_params
+
+      params_or_body = nil
+      path_or_query = path
+
+      if method == :get && !query_string.blank?
+        path_or_query = path + "?#{query_string}"
+      else
+        params_or_body = respond_to?(:raw_post) ? raw_post : params
+      end
+
+      client.send(method, path_or_query, params_or_body)
+    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
+
+    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 method
+      example.metadata[:method]
+    end
+
+    def in_path?(param)
+      path_params.include?(param)
+    end
+
+    def path_params
+      example.metadata[:route].scan(/:(\w+)/).flatten
+    end
+
+    def path
+      example.metadata[:route].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 explanation(text)
+      example.metadata[:explanation] = text
+    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 delete_extra_param(key)
+      @extra_params.delete(key.to_sym) || @extra_params.delete(key.to_s)
+    end
+
+    def set_param(hash, param)
+      key = param[:name]
+      return hash if !respond_to?(key) || in_path?(key)
+
+      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/dsl/resource.rb

@@ -0,0 +1,92 @@
+module RspecApiDocumentation::DSL
+  module Resource
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def self.define_action(method)
+        define_method method do |*args, &block|
+          options = if args.last.is_a?(Hash) then args.pop else {} end
+          options[:method] = method
+          options[:route] = args.first
+          options[:api_doc_dsl] = :endpoint
+          args.push(options)
+          args[0] = "#{method.to_s.upcase} #{args[0]}"
+          context(*args, &block)
+        end
+      end
+
+      define_action :get
+      define_action :post
+      define_action :put
+      define_action :delete
+
+      def callback(*args, &block)
+        require 'webmock'
+        self.send(:include, WebMock::API)
+
+        options = if args.last.is_a?(Hash) then args.pop else {} end
+        options[:api_doc_dsl] = :callback
+        args.push(options)
+
+        context(*args, &block)
+      end
+
+      def parameter(name, description, options = {})
+        parameters.push(options.merge(:name => name.to_s, :description => description))
+      end
+
+      def required_parameters(*names)
+        names.each do |name|
+          param = parameters.find { |param| param[:name] == name.to_s }
+          raise "Undefined parameters can not be required." unless param
+          param[:required] = true
+        end
+      end
+
+      def scope_parameters(scope, keys)
+        return unless metadata[:parameters]
+
+        if keys == :all
+          keys = parameter_keys.map(&:to_s)
+        else
+          keys = keys.map(&:to_s)
+        end
+
+        keys.each do |key|
+          param = parameters.detect { |param| param[:name] == key }
+          param[:scope] = scope if param
+        end
+      end
+
+      private
+      def parameters
+        metadata[:parameters] ||= []
+        if superclass_metadata && metadata[:parameters].equal?(superclass_metadata[:parameters])
+          metadata[:parameters] = Marshal.load(Marshal.dump(superclass_metadata[:parameters]))
+        end
+        metadata[:parameters]
+      end
+
+      def parameter_keys
+        parameters.map { |param| param[:name] }
+      end
+    end
+
+    def app
+      RspecApiDocumentation.configuration.app
+    end
+
+    def client
+      @client ||= RspecApiDocumentation::RackTestClient.new(self)
+    end
+
+    def no_doc(&block)
+      requests = example.metadata[:requests]
+      example.metadata[:requests] = []
+
+      instance_eval &block
+
+      example.metadata[:requests] = requests
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec_api_documentation
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-25 00:00:00.000000000 Z
+date: 2012-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70231343311200 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,15 @@ dependencies:
         version: 2.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *70231343311200
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70231343308540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +39,15 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70231343308540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70231343307960 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +55,15 @@ dependencies:
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70231343307960
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: mustache
-  requirement: &70231343307180 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +71,15 @@ dependencies:
         version: 0.99.4
   type: :runtime
   prerelease: false
-  version_requirements: *70231343307180
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.99.4
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70231343306160 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +87,15 @@ dependencies:
         version: 1.7.0
   type: :runtime
   prerelease: false
-  version_requirements: *70231343306160
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70231343305120 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +103,15 @@ dependencies:
         version: 1.4.6
   type: :runtime
   prerelease: false
-  version_requirements: *70231343305120
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.6
 - !ruby/object:Gem::Dependency
   name: coderay
-  requirement: &70231343303560 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,10 +119,15 @@ dependencies:
         version: 1.0.7.rc1
   type: :runtime
   prerelease: false
-  version_requirements: *70231343303560
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.7.rc1
 - !ruby/object:Gem::Dependency
   name: fakefs
-  requirement: &70231343302400 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -100,10 +135,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70231343302400
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70231343301140 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -111,10 +151,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70231343301140
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &70231343300100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -122,10 +167,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70231343300100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &70231343299600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -133,10 +183,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70231343299600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70231343299140 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -144,10 +199,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70231343299140
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70231343298220 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -155,10 +215,15 @@ dependencies:
         version: 0.5.5
   type: :development
   prerelease: false
-  version_requirements: *70231343298220
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.5
 - !ruby/object:Gem::Dependency
   name: rack-oauth2
-  requirement: &70231343297460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -166,7 +231,12 @@ dependencies:
         version: 0.14.4
   type: :development
   prerelease: false
-  version_requirements: *70231343297460
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.14.4
 description: Generate API docs from your test suite
 email:
 - chris@smartlogicsolutions.com
@@ -181,6 +251,9 @@ files:
 - lib/rspec_api_documentation/client_base.rb
 - lib/rspec_api_documentation/configuration.rb
 - lib/rspec_api_documentation/curl.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/dsl.rb
 - lib/rspec_api_documentation/example.rb
 - lib/rspec_api_documentation/headers.rb
@@ -219,7 +292,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.22
 signing_key: 
 specification_version: 3
 summary: A double black belt for your docs