api_canon 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c187459fb3312f6a298e12416a51499ce9f5c60a
-  data.tar.gz: 88a9d06fddf3b3f413dce2e93c93ce5922927fe8
+  metadata.gz: 7d498b5e331019ba5f31d82115085133721d4f36
+  data.tar.gz: 6c1c378ae8a3f3cdeaafa03cd8d5c373b5616021
 SHA512:
-  metadata.gz: 1347370f6ee8ae03530a0c343100b3ea2cc5a92e6cd9b3ba2016744f735db4b6069c247ae254213051bb2e5559c7e44b08be4f1ff8ba16ea099009bd0e80874a
-  data.tar.gz: de9d214e7053256806977ca2e73a4b3a89263fb59baf030b35cccf0a959e8d77078f66df2e3ca5af7f76155472a457312b23769bb2d30453c225aaa8ce6aa71f
+  metadata.gz: 1e9a3b40c35abee15e7cf22c876e71c2c95c9e790663701fb5bcaefcfa3355b73162d2c21b18ea6f79cb0e4b976a0bffff63931089f7e1f59a5580a78a3a188f
+  data.tar.gz: bb08a61bb7518a3e2790677eb63056e1a015a6219163892da508d975ee7d609be143add968997b8126f530c06abf016e54d028ad8b81a176526ee21e95131970

data/README.md

@@ -134,12 +134,12 @@ Right now, api_canon is changing a lot.  I plan to support the following feature
 
 1. Response codes - describe what you mean when you send back a 200, a 201, 403 etc.
 2. Support API tokens or other authentication to allow users to edit data live, with non-GET requests.
-3. Swagger API output (optional)
 4. You will need to route the index action for each documented controller until such point as I provide an alternative means of getting at this documentation.
 
 ## Contributors
 [Cameron Walsh](http://github.com/cwalsh)
 [Leon Dewey](http://github.com/leondewey)
+[Ben Tillman](http://github.com/warp)
 
 ## Contributions
 1. Fork project

data/lib/api_canon/swagger/api_declaration.rb

@@ -13,6 +13,16 @@ module ApiCanon
         attributes :operations
 
         def path
+          url = URI.unescape url_for(url_params)
+
+          # This is required because we dont know if the params are
+          # path params or query params, this way we dont care.
+          url = url.split('?').first
+
+          "#{url}.{format}"
+        end
+
+        def url_params
           url_params = {
             :controller => object.controller_name,
             :action => object.action_name,
@@ -20,16 +30,10 @@ module ApiCanon
           }
 
           object.params.keys.each do |name|
-            url_params[name] = '{name}' unless name == :format
+            url_params[name] = "{#{name}}" unless name == :format
           end
 
-          url = URI.unescape url_for(url_params)
-
-          # This is required because we dont know if the params are
-          # path params or query params, this way we dont care.
-          url = url.split('?').first
-
-          "#{url}.{format}"
+          url_params
         end
 
         def operations
@@ -87,7 +91,7 @@ module ApiCanon
 
             def param_type
               # TODO: Tighten this up.
-              if object.name == 'id'
+              if object.name.to_s == 'id'
                 "path"
               elsif %(POST PUT).include?(object.documented_action.http_method)
                 "form"
@@ -130,4 +134,4 @@ module ApiCanon
 
     end
   end
-end
+end

data/lib/api_canon/version.rb

@@ -1,3 +1,3 @@
 module ApiCanon
-  VERSION = '0.4.3'
+  VERSION = '0.4.4'
 end

data/spec/lib/api_canon/documented_param_spec.rb

@@ -4,7 +4,7 @@ describe ApiCanon::DocumentedParam do
   let(:doc_opts) do
     {:type => 'string', :default => :json, :example_values => example_values}
   end
-  let(:fake_form) { mock :form }
+  let(:fake_form) { double :form }
   let(:doco_prefix) { 'foo' }
   let(:documented_param) {ApiCanon::DocumentedParam.new :format, self, doc_opts}
   subject { documented_param }

data/spec/lib/api_canon/swagger_spec/api_declaration_spec.rb

@@ -1,23 +1,25 @@
 require 'spec_helper'
 describe ApiCanon::Swagger::ApiDeclaration do
 
+  let(:documented_action) {
+    documented_action = ApiCanon::DocumentedAction.new('action_name', 'controller_name')
+    documented_action.describe 'description'
+    documented_action.response_code '404', 'reason'
+    documented_action.param 'name', :description => 'description', :type => 'string', :values => (1..10)
+    documented_action
+  }
   let(:data) {
-    documented_actions = ApiCanon::DocumentedAction.new('action_name', 'controller_name')
-    documented_actions.describe 'description'
-    documented_actions.response_code '404', 'reason'
-    documented_actions.param 'name', :description => 'description', :type => 'string', :values => (1..10)
-    mock :documented_actions => [ documented_actions ], :version => 'master'
+    double :documented_actions => [ documented_action ], :version => 'master'
   }
-  subject { ApiCanon::Swagger::ApiDeclaration }
-
+  subject { described_class.new(data) }
 
   it 'should render the swagger api declaration' do
-    subject.any_instance.stub :api_canon_test_url => 'http://example.com/api_canon/test'
-    subject.any_instance.stub :api_canon_test_path => '/api_canon/test'
-    subject.any_instance.stub :swagger_path => 'swagger_path'
+    described_class.any_instance.stub :api_canon_test_url => 'http://example.com/api_canon/test'
+    described_class.any_instance.stub :api_canon_test_path => '/api_canon/test'
+    described_class.any_instance.stub :swagger_path => 'swagger_path'
     ApiCanon::Swagger::ApiDeclaration::Api.any_instance.stub :url_for => 'url_for'
 
-    JSON.parse(subject.new(data).to_json).should eql({
+    subject.to_json.should be_json_eql({
       "apiVersion" => "master",
       "basePath" => 'http://example.com/',
       "swaggerVersion" => 1.1,
@@ -34,7 +36,7 @@ describe ApiCanon::Swagger::ApiDeclaration do
                 {
                   "paramType" => "query",
                   "dataType" => "string",
-                  "allowableValues"=>{"max"=>10, "min"=>1, "valueType"=>"RANGE"},
+                  "allowableValues" => {"max"=>10, "min"=>1, "valueType"=>"RANGE"},
                   "allowMultiple" => false,
                   "name" => "name",
                   "description" => 'description',
@@ -46,7 +48,17 @@ describe ApiCanon::Swagger::ApiDeclaration do
           ]
         }
       ]
-    })
+    }.to_json)
   end
 
+  describe ApiCanon::Swagger::ApiDeclaration::Api do
+    subject { ApiCanon::Swagger::ApiDeclaration::Api.new(documented_action) }
+
+    describe '#url_params' do
+      it 'should return params with placeholder values' do
+        documented_action.param 'id', :type => 'string'
+        subject.url_params['id'].should eql("{id}")
+      end
+    end
+  end
 end

data/spec/lib/api_canon/swagger_spec/resource_listing_spec.rb

@@ -3,7 +3,7 @@ describe ApiCanon::Swagger::ResourceListing do
 
   let(:data) {
     {
-      :controller => mock(
+      :controller => double(
         :version => 'master',
         :description => 'description'
       )

data/spec/lib/api_canon_spec.rb

@@ -17,7 +17,7 @@ describe ApiCanon do
   end
 
   describe "document_method" do
-    let(:api_document) { mock :api_document }
+    let(:api_document) { double :api_document }
     context "without a current controller doc" do
       it "creates and stores a new ApiCanon::Document and adds the documented action" do
         ApiCanon::Document.should_receive(:new).with('fake', 'fake').and_return(api_document)

data/spec/spec_helper.rb

@@ -8,4 +8,10 @@ require 'combustion'
 require 'rspec'
 require 'rspec/rails'
 require 'api_canon'
-Combustion.initialize!
+
+require 'json_spec'
+RSpec.configure do |config|
+  config.include JsonSpec::Helpers
+end
+
+Combustion.initialize!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_canon
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Cameron Walsh
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-12 00:00:00.000000000 Z
+date: 2013-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -67,6 +67,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json_spec
+  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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement