http_spec 0.0.2 → 0.1.0

data/lib/http_spec/clients/rack.rb

@@ -11,15 +11,11 @@ module HTTPSpec
       def dispatch(request)
         opts = headers_to_env(request.headers)
         opts[:input] = request.body
-        from_rack @session.request(request.method, request.path, opts)
+        @session.request(request.method, request.path, opts)
       end
 
       private
 
-      def from_rack(response)
-        Response.new(response.status, response.body, response.headers)
-      end
-
       def headers_to_env(headers)
         return {} unless headers
         headers.inject({}) do |env, (k, v)|

data/lib/http_spec/clients/raddocs_proxy.rb

@@ -0,0 +1,137 @@
+require "http_spec/types"
+require "raddocs"
+require "fileutils"
+
+module HTTPSpec
+  module Clients
+    class RaddocsProxy
+      def initialize(inner, metadata, dir = Raddocs.configuration.docs_dir)
+        @inner = inner
+        @resource_name = metadata.fetch(:resource_name)
+        @description = metadata[:description]
+        raise KeyError, "key not found :description" unless @description
+        @parameters = metadata[:parameters]
+        @explanation = metadata[:explanation]
+        @dir = dir
+      end
+
+      def dispatch(request)
+        write_index
+        response = @inner.dispatch(request)
+        write_example(request, response)
+        response
+      end
+
+      private
+
+      def write_index
+        filepath = File.join(@dir, "index.json")
+        index = load_or_new(Index, filepath)
+        index.add_example(@resource_name, @description, example_path)
+        File.open(filepath, "w") { |file| index.dump(file) }
+      end
+
+      def write_example(request, response)
+        filepath = File.join(@dir, example_path)
+        FileUtils.mkdir_p(File.dirname(filepath))
+        example = load_or_new(Example, filepath, @resource_name, @description)
+        example.explanation = @explanation
+        example.parameters = @parameters
+        example.add_request(request, response)
+        File.open(filepath, "w") { |file| example.dump(file) }
+      end
+
+      def example_path
+        dirname = @resource_name.gsub(/\s+/, '_').gsub(/\W/, '')
+        filename = @description.downcase.gsub(/\s+/, '_').gsub(/\W/, '')
+        File.join(dirname, filename + ".json")
+      end
+
+      def load_or_new(klass, filepath, *args)
+        if File.exists?(filepath)
+          File.open(filepath, "r") { |file| klass.load(file) }
+        else
+          klass.new(*args)
+        end
+      end
+
+      class Index
+        attr_reader :resources
+
+        def initialize(resources = [])
+          @resources = resources
+        end
+
+        def self.load(io, serializer = JSON)
+          content = serializer.load(io)
+          resources = content.fetch("resources")
+          new(resources)
+        end
+
+        def dump(io, serializer = JSON)
+          content = { "resources" => resources }
+          serializer.dump(content, io)
+        end
+
+        def add_example(resource_name, description, link)
+          resource = resources.find { |r| r["name"] == resource_name }
+          unless resource
+            resource = { "name" => resource_name, "examples" => [] }
+            resources.push(resource)
+          end
+          examples = resource.fetch("examples")
+          example = examples.find { |e| e["description"] == description }
+          unless example
+            example = { "description" => description, "link" => link }
+            examples.push(example)
+          end
+        end
+      end
+
+      class Example
+        attr_reader :resource_name, :description, :requests
+        attr_accessor :explanation, :parameters
+
+        def initialize(resource_name, description, requests = [])
+          @resource_name = resource_name
+          @description = description
+          @requests = requests
+        end
+
+        def self.load(io, serializer = JSON)
+          content = serializer.load(io)
+          resource_name = content.fetch("resource")
+          description = content.fetch("description")
+          requests = content.fetch("requests")
+          new(resource_name, description, requests).tap do |example|
+            example.explanation = content["explanation"]
+            example.parameters = content["parameters"]
+          end
+        end
+
+        def dump(io, serializer = JSON)
+          content = {
+            "resource" => resource_name,
+            "description" => description,
+            "explanation" => explanation,
+            "parameters" => parameters,
+            "requests" => requests
+          }
+          serializer.dump(content, io)
+        end
+
+        def add_request(request, response)
+          requests.push(
+            "request_headers" => request.headers || {},
+            "request_method" => request.method.upcase,
+            "request_path" => request.path,
+            "request_body" => request.body,
+            "response_status" => response.status,
+            "response_headers" => response.headers,
+            "response_body" => response.body
+          )
+        end
+      end
+    end
+  end
+end

data/lib/http_spec/dsl/methods.rb

@@ -1,3 +1,4 @@
+require "http_spec"
 require "http_spec/types"
 
 module HTTPSpec
@@ -7,7 +8,7 @@ module HTTPSpec
         methods.each do |method|
           define_method(method) do |path, body=nil, headers=nil|
             request = Request.new(method, path, body, headers)
-            client.dispatch(request)
+            HTTPSpec.dispatch(request)
           end
         end
       end

data/lib/http_spec/dsl/parameters.rb

@@ -0,0 +1,35 @@
+module HTTPSpec
+  module DSL
+    module Parameters
+      def self.included(base)
+        base.extend(ClassMethods)
+        base.metadata[:parameters] = []
+      end
+
+      module ClassMethods
+        def parameter(name, description, extra = {})
+          param = extra.merge(:name => name, :description => description)
+          copy_superclass_metadata(:parameters)
+          metadata[:parameters].push(param)
+        end
+
+        def copy_superclass_metadata(key)
+          return unless superclass_metadata && superclass_metadata[key]
+          if superclass_metadata[key].equal?(metadata[key])
+            metadata[key] = superclass_metadata[key].dup
+          end
+        end
+      end
+
+      def params
+        return {} unless example.metadata[:parameters]
+        @params ||= {}
+        example.metadata[:parameters].each do |param|
+          name = param[:name]
+          @params[name] ||= send(name) if respond_to?(name)
+        end
+        @params
+      end
+    end
+  end
+end

data/lib/http_spec/dsl/resource.rb

@@ -1,3 +1,4 @@
+require "http_spec"
 require "http_spec/types"
 
 module HTTPSpec
@@ -5,30 +6,24 @@ module HTTPSpec
     module Resource
       def self.included(base)
         base.extend(ClassMethods)
+        base.metadata[:default_headers] = {}
       end
 
       module ClassMethods
         def self.define_actions(*methods)
           methods.each do |method|
-            define_method(method) do |route, &block|
+            define_method(method) do |route, metadata = {}, &block|
               description = "#{method.to_s.upcase} #{route}"
-              request = Request.new(method, route)
-              context(description, :request => request, &block)
+              metadata[:request] = Request.new(method, route)
+              context(description, metadata, &block)
             end
           end
         end
 
         define_actions :get, :post, :put, :patch, :delete, :options, :head
 
-        def parameter(name, description, extra = {})
-          copy_superclass_metadata(:parameters)
-          metadata[:parameters] ||= {}
-          metadata[:parameters][name] = extra.merge(:description => description)
-        end
-
         def header(name, value)
           copy_superclass_metadata(:default_headers)
-          metadata[:default_headers] ||= {}
           metadata[:default_headers][name] = value
         end
 
@@ -41,21 +36,11 @@ module HTTPSpec
       end
 
       def do_request(options = {})
-        request = example.metadata[:request]
-        request.body = options[:body]
-        request.headers = default_headers(options[:headers])
-        request.parameters = example.metadata[:parameters]
-        build_path(request)
-        @last_response = client.dispatch(request)
-      end
-
-      def params
-        return {} unless example.metadata[:parameters]
-        params = {}
-        example.metadata[:parameters].each_key do |name|
-          params[name] = send(name) if respond_to?(name)
-        end
-        params
+        request = example.metadata[:request].dup
+        request.body = options.delete(:body)
+        request.headers = default_headers(options.delete(:headers))
+        build_path(request, options)
+        @last_response = HTTPSpec.dispatch(request)
       end
 
       def status
@@ -73,9 +58,11 @@ module HTTPSpec
 
       private
 
-      def build_path(request)
+      def build_path(request, options)
         request.path.gsub!(/:(\w+)/) do |match|
-          if respond_to?($1)
+          if options.key?($1.to_sym)
+            options[$1.to_sym]
+          elsif respond_to?($1)
             send($1)
           else
             match

data/lib/http_spec/types.rb

@@ -1,4 +1,9 @@
 module HTTPSpec
-  Request = Struct.new(:method, :path, :body, :headers, :parameters)
+  Request = Struct.new(:method, :path, :body, :headers) do
+    def dup
+      Request.new(method, path.dup, body, headers)
+    end
+  end
+
   Response = Struct.new(:status, :body, :headers)
 end

data/lib/http_spec.rb

@@ -0,0 +1,9 @@
+module HTTPSpec
+  class << self
+    attr_accessor :client
+
+    def dispatch(request)
+      client.dispatch(request)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http_spec
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-24 00:00:00.000000000 Z
+date: 2012-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -91,6 +91,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: raddocs
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +155,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: 
 executables: []
@@ -132,10 +196,13 @@ files:
 - lib/http_spec/clients/faraday.rb
 - lib/http_spec/clients/fdoc_proxy.rb
 - lib/http_spec/clients/rack.rb
+- lib/http_spec/clients/raddocs_proxy.rb
 - lib/http_spec/clients/webmachine.rb
 - lib/http_spec/dsl/methods.rb
+- lib/http_spec/dsl/parameters.rb
 - lib/http_spec/dsl/resource.rb
 - lib/http_spec/types.rb
+- lib/http_spec.rb
 homepage: https://github.com/smartlogic/http_spec
 licenses: []
 post_install_message: