fdoc 0.2.5 → 0.2.6

data/lib/fdoc/service.rb

@@ -31,6 +31,15 @@ class Fdoc::Service
     end
   end
 
+  def self.verify!(verb, path, request_params, response_params,
+                   response_status, successful)
+    service = Fdoc::Service.new(Fdoc.service_path)
+    endpoint = service.open(verb, path)
+    endpoint.consume_request(request_params, successful)
+    endpoint.consume_response(response_params, response_status, successful)
+    endpoint.persist! if endpoint.respond_to?(:persist!)
+  end
+
   # Returns an Endpoint described by (verb, path)
   # In scaffold_mode, it will return an EndpointScaffold an of existing file
   #   or create an empty EndpointScaffold

data/lib/fdoc/spec_watcher.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module Fdoc
   module SpecWatcher
     VERBS = [:get, :post, :put, :delete]
@@ -6,7 +8,7 @@ module Fdoc
       define_method(verb) do |*params|
         action, request_params = params
 
-        request_params = if request_params.kind_of(Hash)
+        request_params = if request_params.kind_of?(Hash)
           request_params
         else
           begin
@@ -36,23 +38,12 @@ module Fdoc
             {}
           end
           successful = Fdoc.decide_success(response_params, response.status)
-          verify!(verb, path, request_params, response_params, response.status,
-            successful)
+          Service.verify!(verb, path, request_params, response_params,
+            response.status, successful)
         end
 
         result
       end
     end
-
-    private
-
-    def verify!(verb, path, request_params, response_params, response_status,
-          successful)
-      service = Service.new(Fdoc.service_path)
-      endpoint = service.open(verb, path)
-      endpoint.consume_request(request_params, successful)
-      endpoint.consume_response(response_params, response_status, successful)
-      endpoint.persist! if endpoint.respond_to?(:persist!)
-    end
   end
 end

data/spec/fdoc/spec_watcher_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+require 'fdoc/spec_watcher'
+
+describe Fdoc::SpecWatcher do
+  before do
+    # This should be an integration test, but for now a smoke test suffices to
+    # surface obvious bugs and verify some behaviours.
+    @klass = Class.new do
+      def example
+        Struct.new(:metadata).new(:fdoc => 'index')
+      end
+
+      def response
+        Struct.new(:body, :status).new("{}", 200)
+      end
+
+      def get(action, params)
+        params
+      end
+    end.new
+    @klass.extend(Fdoc::SpecWatcher)
+  end
+
+  it 'should verify when params are a hash' do
+    Fdoc::Service.should_receive(:verify!).with do |*args|
+      args[2] == {:id => 1}
+    end
+    @klass.get(:index, {:id => 1})
+  end
+
+  it 'should verify when params are JSON' do
+    Fdoc::Service.should_receive(:verify!).with do |*args|
+      args[2] == {'id' => 1}
+    end
+    @klass.get(:index, {:id => 1}.to_json)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fdoc
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
   prerelease: 
 platform: ruby
 authors:
@@ -15,7 +15,7 @@ date: 2011-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70189854315380 !ruby/object:Gem::Requirement
+  requirement: &70196446801520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70189854315380
+  version_requirements: *70196446801520
 - !ruby/object:Gem::Dependency
   name: json-schema
-  requirement: &70189854314620 !ruby/object:Gem::Requirement
+  requirement: &70196446800760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: 1.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *70189854314620
+  version_requirements: *70196446800760
 - !ruby/object:Gem::Dependency
   name: kramdown
-  requirement: &70189854313940 !ruby/object:Gem::Requirement
+  requirement: &70196446800080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70189854313940
+  version_requirements: *70196446800080
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70189854313440 !ruby/object:Gem::Requirement
+  requirement: &70196446799580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70189854313440
+  version_requirements: *70196446799580
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70189854312900 !ruby/object:Gem::Requirement
+  requirement: &70196446799040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -67,10 +67,10 @@ dependencies:
         version: '2.5'
   type: :development
   prerelease: false
-  version_requirements: *70189854312900
+  version_requirements: *70196446799040
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70189854312420 !ruby/object:Gem::Requirement
+  requirement: &70196446798560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70189854312420
+  version_requirements: *70196446798560
 - !ruby/object:Gem::Dependency
   name: cane
-  requirement: &70189854311940 !ruby/object:Gem::Requirement
+  requirement: &70196446798060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,7 +89,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70189854311940
+  version_requirements: *70196446798060
 description: A tool for documenting API endpoints.
 email: support@squareup.com
 executables:
@@ -120,6 +120,7 @@ files:
 - spec/fdoc/presenters/endpoint_presenter_spec.rb
 - spec/fdoc/presenters/service_presenter_spec.rb
 - spec/fdoc/service_spec.rb
+- spec/fdoc/spec_watcher_spec.rb
 - spec/fixtures/members/add-PUT.fdoc
 - spec/fixtures/members/draft-POST.fdoc
 - spec/fixtures/members/list/complex-params-GET.fdoc
@@ -164,6 +165,7 @@ test_files:
 - spec/fdoc/presenters/endpoint_presenter_spec.rb
 - spec/fdoc/presenters/service_presenter_spec.rb
 - spec/fdoc/service_spec.rb
+- spec/fdoc/spec_watcher_spec.rb
 - spec/fixtures/members/add-PUT.fdoc
 - spec/fixtures/members/draft-POST.fdoc
 - spec/fixtures/members/list/complex-params-GET.fdoc