api_canon 0.4.6 → 0.4.7

data/lib/api_canon.rb

@@ -84,7 +84,7 @@ module ApiCanon
     # @see ApiCanon::DocumentedAction#response_code
     def document_method(method_name, &block)
       document do |document|
-        documented_action = ApiCanon::DocumentedAction.new method_name, controller_name
+        documented_action = ApiCanon::DocumentedAction.new method_name, controller_path, controller_name
         documented_action.instance_eval &block if block_given?
         document.add_action documented_action
       end

data/lib/api_canon/documented_action.rb

@@ -2,9 +2,10 @@ module ApiCanon
   class DocumentedAction
     include ActiveModel::Serialization
     attr_reader :params, :response_codes, :response_model_name, :description, :action_name,
-      :controller_name, :http_method
-    def initialize(action_name, controller_name)
+      :controller_name, :controller_path, :http_method
+    def initialize(action_name, controller_path, controller_name)
       @action_name = action_name
+      @controller_path = controller_path
       @controller_name = controller_name
       @params={}
       # TODO: This should check routes to see if params[:format] is expected

data/lib/api_canon/documented_param.rb

@@ -22,6 +22,9 @@ module ApiCanon
     def to_field(f, doco_prefix)
       # TODO: This doco_prefix thing sucks. Get rid of it.
       if type == :array
+        if form_values.nil?
+          raise ArgumentError.new(':values or :example_values must be supplied for :array type params')
+        end
         f.select name, form_values, {:selected => default, :include_blank => true}, {:multiple => multiple?, :class => 'input-block-level', :id => "#{doco_prefix}_#{name}"}
       elsif type == :boolean
         f.select name, [true,false], {:selected => default, :include_blank => true}, :class => 'input-block-level', :id => "#{doco_prefix}_#{name}"

data/lib/api_canon/routes.rb

@@ -11,7 +11,11 @@ module ApiCanon
       end
 
       # TODO: make :path => 'swagger-doc' customisable
-      map.resources :path => 'swagger-doc', :controller => 'api_canon/swagger', :only => [:index, :show], :as => :api_canon_swagger_doc
+      map.resources :path => 'swagger-doc',
+        :controller => 'api_canon/swagger',
+        :only => [:index, :show],
+        :constraints => { :id => /.+/ },
+        :as => :api_canon_swagger_doc
     end
   end
-end
+end

data/lib/api_canon/swagger/api_declaration.rb

@@ -28,7 +28,7 @@ module ApiCanon
 
         def url_params
           url_params = {
-            :controller => object.controller_name,
+            :controller => object.controller_path,
             :action => object.action_name,
             :only_path => true
           }

data/lib/api_canon/version.rb

@@ -1,3 +1,3 @@
 module ApiCanon
-  VERSION = '0.4.6'
+  VERSION = '0.4.7'
 end

data/spec/lib/api_canon/documented_action_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 describe ApiCanon::DocumentedAction do
 
-  let(:document) {ApiCanon::DocumentedAction.new :index, 'controller_name'}
+  let(:document) {ApiCanon::DocumentedAction.new :index, 'controller_path', 'controller_name'}
   let(:description) {'ID is the unique identifier of the object'}
   subject { document }
   its(:action_name) { should == :index }

data/spec/lib/api_canon/documented_param_spec.rb

@@ -26,6 +26,12 @@ describe ApiCanon::DocumentedParam do
         fake_form.should_receive(:select).with :format, [:json, :xml], hash_including({:include_blank => true}), hash_including({:id => 'foo_format'})
         documented_param.to_field fake_form, doco_prefix
       end
+      context 'when form_values returns nil' do
+        it 'raises an ArgumentError' do
+          subject.stub(:form_values => nil)
+          expect { documented_param.to_field fake_form, doco_prefix }.to raise_exception(ArgumentError)
+        end
+      end
     end
     context "boolean-type params" do
       before(:each) {documented_param.type = :boolean}

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

@@ -2,7 +2,7 @@ require 'spec_helper'
 describe ApiCanon::Swagger::ApiDeclaration do
 
   let(:documented_action) {
-    documented_action = ApiCanon::DocumentedAction.new('action_name', 'controller_name')
+    documented_action = ApiCanon::DocumentedAction.new('action_name', 'controller_path', 'controller_name')
     documented_action.describe 'description'
     documented_action.response_class 'Thing'
     documented_action.response_code '404', 'reason'

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: api_canon
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.7
+  prerelease: 
 platform: ruby
 authors:
 - Cameron Walsh
@@ -10,39 +11,44 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-21 00:00:00.000000000 Z
+date: 2013-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.3.17
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.3.17
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -50,6 +56,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -57,173 +64,186 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   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: json_spec
   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: yard
   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: pry
   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: combustion
   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: |-
-  api_canon is a declarative documentation generator
-                         for APIs. Declare the parameters and response codes,
-                         describe them, and give some example values. api_canon
-                         handles the rest for you.
+description: ! "api_canon is a declarative documentation generator\n                       for
+  APIs. Declare the parameters and response codes,\n                       describe
+  them, and give some example values. api_canon\n                       handles the
+  rest for you."
 email:
 - cameron.walsh@gmail.com
 - leon@leondewey.com
 - ben.tillman@gmail.com
+- doperations@au.westfield.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- app/views/api_canon/api_canon.html.erb
-- app/views/api_canon/_form.html.erb
+- app/controllers/api_canon_controller.rb
+- app/controllers/swagger_controller.rb
+- app/helpers/api_canon/api_canon_view_helper.rb
 - app/views/api_canon/_api_canon.html.erb
+- app/views/api_canon/_form.html.erb
 - app/views/api_canon/_rails_2_form.html.erb
+- app/views/api_canon/api_canon.html.erb
 - app/views/application/index.html.erb
 - app/views/layouts/api_canon.html.erb
-- app/controllers/swagger_controller.rb
-- app/controllers/api_canon_controller.rb
-- app/helpers/api_canon/api_canon_view_helper.rb
-- lib/api_canon/documented_param.rb
-- lib/api_canon/documented_model.rb
-- lib/api_canon/version.rb
-- lib/api_canon/documented_action.rb
-- lib/api_canon/documentation_store.rb
 - lib/api_canon/app.rb
-- lib/api_canon/swagger/base.rb
-- lib/api_canon/swagger/api_declaration.rb
-- lib/api_canon/swagger/resource_listing.rb
 - lib/api_canon/document.rb
+- lib/api_canon/documentation_store.rb
+- lib/api_canon/documented_action.rb
+- lib/api_canon/documented_model.rb
+- lib/api_canon/documented_param.rb
 - lib/api_canon/routes.rb
-- lib/tasks/api_canon_tasks.rake
+- lib/api_canon/swagger/api_declaration.rb
+- lib/api_canon/swagger/base.rb
+- lib/api_canon/swagger/resource_listing.rb
+- lib/api_canon/version.rb
 - lib/api_canon.rb
+- lib/tasks/api_canon_tasks.rake
 - MIT-LICENSE
 - Rakefile
 - README.md
-- spec/spec_helper.rb
-- spec/lib/api_canon/documented_param_spec.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/test.log
+- spec/internal/public/favicon.ico
+- spec/lib/api_canon/documented_action_spec.rb
 - spec/lib/api_canon/documented_model_spec.rb
+- spec/lib/api_canon/documented_param_spec.rb
 - spec/lib/api_canon/swagger_spec/api_declaration_spec.rb
 - spec/lib/api_canon/swagger_spec/resource_listing_spec.rb
-- spec/lib/api_canon/documented_action_spec.rb
 - spec/lib/api_canon_spec.rb
-- spec/internal/public/favicon.ico
-- spec/internal/db/schema.rb
-- spec/internal/config/database.yml
-- spec/internal/config/routes.rb
-- spec/internal/log/test.log
+- spec/spec_helper.rb
 homepage: http://github.com/westfield/api_canon
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - app
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Declarative documentation generator for APIs.
 test_files:
-- spec/spec_helper.rb
-- spec/lib/api_canon/documented_param_spec.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/test.log
+- spec/internal/public/favicon.ico
+- spec/lib/api_canon/documented_action_spec.rb
 - spec/lib/api_canon/documented_model_spec.rb
+- spec/lib/api_canon/documented_param_spec.rb
 - spec/lib/api_canon/swagger_spec/api_declaration_spec.rb
 - spec/lib/api_canon/swagger_spec/resource_listing_spec.rb
-- spec/lib/api_canon/documented_action_spec.rb
 - spec/lib/api_canon_spec.rb
-- spec/internal/public/favicon.ico
-- spec/internal/db/schema.rb
-- spec/internal/config/database.yml
-- spec/internal/config/routes.rb
-- spec/internal/log/test.log
+- spec/spec_helper.rb
 has_rdoc: 

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 47daa06eee0e9801cdd6d0476a52006585b96e87
-  data.tar.gz: d424093588fe923332278cbd7d8f2515abdcf704
-SHA512:
-  metadata.gz: 0826027c44ce02123906d4f9c42cf1fade9c6908043ae9fe428bd562eae832202b515932035882fe9017844721d9808bf07036cd03d1dc119d02952a31e64dfd
-  data.tar.gz: 54c41a3748d0443521fea10d78c9b11545fcb9899510c0022b9df100f8062d37971a0f7de4f62a7222bcdfbe4a5ec463c0b646f6c0449c94055999b5f450ddda