api_canon 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d498b5e331019ba5f31d82115085133721d4f36
-  data.tar.gz: 6c1c378ae8a3f3cdeaafa03cd8d5c373b5616021
+  metadata.gz: 5ae973a42fab02db3f846d289447747a5cb35460
+  data.tar.gz: 963a6ebde8bd3d854afbb64ff694e43fd20c4343
 SHA512:
-  metadata.gz: 1e9a3b40c35abee15e7cf22c876e71c2c95c9e790663701fb5bcaefcfa3355b73162d2c21b18ea6f79cb0e4b976a0bffff63931089f7e1f59a5580a78a3a188f
-  data.tar.gz: bb08a61bb7518a3e2790677eb63056e1a015a6219163892da508d975ee7d609be143add968997b8126f530c06abf016e54d028ad8b81a176526ee21e95131970
+  metadata.gz: f2b597c23d3dfaa4daca2351c242123008ac3985488ab97abfd27adda7d9b2a93cce84ba3964613f9f3a0ffcc68022a49ee6a0306bfdfd9804e4e12825d8b846
+  data.tar.gz: f302da8afcc840853dabee58982860f19c9dac85571275f113cb37212435eb76274ce1fefffad43a7ddf0db7fa91aaa34444e0efd10d090ee8c7056b5640940b

data/README.md

@@ -119,7 +119,7 @@ class FunkyCategoriesController < ApplicationController
   document_method :show do
     describe %Q{This action returns a tree of categories starting at the 
       requested root node.}
-    param :id, :type => :string,:default => 'mens-fashion-accessories',
+    param :id, :type => :string, :default => 'mens-fashion-accessories',
       :example_values => Category.limit(5).pluck(:code),
       :description => "Category code to show, the root node for the entire tree."
   end
@@ -137,9 +137,9 @@ Right now, api_canon is changing a lot.  I plan to support the following feature
 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)
+* [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/documented_param.rb

@@ -1,8 +1,9 @@
 module ApiCanon
   class DocumentedParam
     include ActiveModel::Serialization
-    attr_accessor :name, :values, :type, :default, :description, :example_values, :required, :description, :documented_action
+    attr_accessor :name, :values, :type, :param_type, :default, :description, :example_values, :required, :description, :documented_action
     attr_writer :multiple
+    delegate :http_method, :to => :documented_action
     include ActionView::Helpers
     def values_for_example
       example_values || values || ""

data/lib/api_canon/swagger/api_declaration.rb

@@ -17,9 +17,7 @@ module ApiCanon
 
           # 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.split('?').first
         end
 
         def url_params
@@ -30,7 +28,7 @@ module ApiCanon
           }
 
           object.params.keys.each do |name|
-            url_params[name] = "{#{name}}" unless name == :format
+            url_params[name] = "{#{name}}"
           end
 
           url_params
@@ -84,16 +82,18 @@ module ApiCanon
             self.root = false
             attributes :param_type => :paramType,
               :data_type => :dataType,
+              :default => :defaultValue,
               :allowable_values => :allowableValues,
               :allow_multiple => :allowMultiple
 
             attributes :name, :description, :required
 
             def param_type
-              # TODO: Tighten this up.
-              if object.name.to_s == 'id'
+              if object.param_type.present?
+                object.param_type
+              elsif object.name.to_s == 'id'
                 "path"
-              elsif %(POST PUT).include?(object.documented_action.http_method)
+              elsif %(POST PUT).include?(object.http_method)
                 "form"
               else
                 "query"

data/lib/api_canon/version.rb

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

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

@@ -5,7 +5,7 @@ describe ApiCanon::Swagger::ApiDeclaration do
     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.param 'name', :description => 'description', :type => 'string', :default => 'test', :values => (1..10)
     documented_action
   }
   let(:data) {
@@ -25,7 +25,7 @@ describe ApiCanon::Swagger::ApiDeclaration do
       "swaggerVersion" => 1.1,
       "apis" => [
         {
-          "path" => "url_for.{format}",
+          "path" => "url_for",
           "description" => 'description',
           "operations" => [
             {
@@ -36,7 +36,8 @@ describe ApiCanon::Swagger::ApiDeclaration do
                 {
                   "paramType" => "query",
                   "dataType" => "string",
-                  "allowableValues" => {"max"=>10, "min"=>1, "valueType"=>"RANGE"},
+                  "defaultValue" => "test",
+                  "allowableValues" => {"max" => 10, "min" => 1, "valueType" => "RANGE"},
                   "allowMultiple" => false,
                   "name" => "name",
                   "description" => 'description',
@@ -51,7 +52,7 @@ describe ApiCanon::Swagger::ApiDeclaration do
     }.to_json)
   end
 
-  describe ApiCanon::Swagger::ApiDeclaration::Api do
+  describe '::Api' do
     subject { ApiCanon::Swagger::ApiDeclaration::Api.new(documented_action) }
 
     describe '#url_params' do
@@ -60,5 +61,44 @@ describe ApiCanon::Swagger::ApiDeclaration do
         subject.url_params['id'].should eql("{id}")
       end
     end
+
+    describe '::Parameter' do
+      subject { ApiCanon::Swagger::ApiDeclaration::Api::Operation::Parameter.new(param) }
+
+      describe '#param_type' do
+
+        describe 'with param_type path' do
+          let(:param) { double :param_type => 'path' }
+
+          it 'should return path' do
+            subject.param_type.should eql('path')
+          end
+        end
+
+        describe 'with name id' do
+          let(:param) { double :param_type => nil, :name => 'id' }
+
+          it 'should return path' do
+            subject.param_type.should eql('path')
+          end
+        end
+
+        describe 'with POST http_method' do
+          let(:param) { double :param_type => nil, :name => 'name', :http_method => 'POST' }
+
+          it 'should return path' do
+            subject.param_type.should eql('form')
+          end
+        end
+
+        describe 'with GET http_method' do
+          let(:param) { double :param_type => nil, :name => 'name', :http_method => 'GET' }
+
+          it 'should return query' do
+            subject.param_type.should eql('query')
+          end
+        end
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_canon
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - Cameron Walsh
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-19 00:00:00.000000000 Z
+date: 2013-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails