apipie-rails 0.0.17 → 0.0.18

data/spec/dummy/app/controllers/api/v1/architectures_controller.rb

@@ -10,10 +10,20 @@ module Api
       def show
       end
 
-      api :POST, "/architectures/", "Create an architecture."
-      param :architecture, Hash, :required => true do
-        param :name, String, :required => true
+      def_param_group :timestamps do
+        param :created_at, String
+        param :updated_at, String
+      end
+
+      def_param_group :arch do
+        param :architecture, Hash, :required => true do
+          param :name, String, :required => true
+          param_group :timestamps
+        end
       end
+
+      api :POST, "/architectures/", "Create an architecture."
+      param_group :arch
       def create
       end
 

data/spec/dummy/app/controllers/api/v2/architectures_controller.rb

@@ -11,9 +11,7 @@ module Api
       end
 
       api :POST, "/architectures/", "Create an architecture."
-      param :architecture, Hash, :required => true do
-        param :name, String, :required => true
-      end
+      param_group :arch, Api::V1::ArchitecturesController
       def create
       end
 

data/spec/dummy/app/controllers/users_controller.rb

@@ -190,17 +190,40 @@ class UsersController < ApplicationController
     render :text => "OK"
   end
 
-  api :POST, "/users", "Create user"
-  param :user, Hash, :desc => "User info", :required => true do
+  def_param_group :credentials do
     param :name, String, :desc => "Username for login", :required => true
     param :pass, String, :desc => "Password for login", :required => true
-    param :membership, ["standard","premium"], :desc => "User membership"
+  end
+
+  def_param_group :user do
+    param :user, Hash, :desc => "User info", :required => true, :action_aware => true do
+      param_group :credentials
+      param :membership, ["standard","premium"], :desc => "User membership", :allow_nil => false
+    end
+  end
+
+  api :POST, "/users", "Create user"
+  param_group :user
+  param :user, Hash do
+    param :permalink, String
   end
   param :facts, Hash, :desc => "Additional optional facts about the user", :allow_nil => true
   def create
     render :text => "OK #{params.inspect}"
   end
 
+  api :PUT, "/users/:id", "Create user"
+  param_group :user
+  def update
+    render :text => "OK #{params.inspect}"
+  end
+
+  api :POST, "/users/admin", "Create admin user"
+  param_group :user, :as => :create
+  def admin_create
+    render :text => "OK #{params.inspect}"
+  end
+
   api :GET, "/users", "List users"
   error :code => 401, :desc => "Unauthorized"
   error :code => 404, :desc => "Not Found"

data/spec/lib/method_description_spec.rb

@@ -2,15 +2,16 @@ require "spec_helper"
 
 describe Apipie::MethodDescription do
 
+  let(:dsl_data) { ActionController::Base.send(:_apipie_dsl_data_init) }
+
   describe "params descriptions" do
 
     before(:each) do
-      Apipie.clear_last
       @resource = Apipie::ResourceDescription.new(ApplicationController, "dummy")
-      Apipie.last_dsl_data[:params] << Apipie::ParamDescription.new(:a, String)
-      Apipie.last_dsl_data[:params] << Apipie::ParamDescription.new(:b, String)
-      Apipie.last_dsl_data[:params] << Apipie::ParamDescription.new(:c, String)
-      @method = Apipie::MethodDescription.new(:a, @resource, Apipie.app)
+      dsl_data[:params] = [[:a, String, nil, {}, nil],
+                           [:b, String, nil, {}, nil],
+                           [:c, String, nil, {}, nil]]
+      @method = Apipie::MethodDescription.new(:a, @resource, dsl_data)
       @resource.add_method_description @method
     end
 

data/spec/lib/param_description_spec.rb

@@ -2,19 +2,29 @@ require "spec_helper"
 
 describe Apipie::ParamDescription do
 
-  describe "required_by_default config option" do
+  let(:dsl_data) { ActionController::Base.send(:_apipie_dsl_data_init) }
+
+  let(:resource_desc) do
+    Apipie::ResourceDescription.new(UsersController, "users")
+  end
+
+  let(:method_desc) do
+    Apipie::MethodDescription.new(:show, resource_desc, dsl_data)
+  end
 
+
+  describe "required_by_default config option" do
     context "parameters required by default" do
 
       before { Apipie.configuration.required_by_default = true }
 
       it "should set param as required by default" do
-        param = Apipie::ParamDescription.new(:required_by_default, String)
+        param = Apipie::ParamDescription.new(method_desc, :required_by_default, String)
         param.required.should be_true
       end
 
       it "should be possible to set param as optional" do
-        param = Apipie::ParamDescription.new(:optional, String, :required => false)
+        param = Apipie::ParamDescription.new(method_desc, :optional, String, :required => false)
         param.required.should be_false
       end
 
@@ -25,12 +35,12 @@ describe Apipie::ParamDescription do
       before { Apipie.configuration.required_by_default = false }
 
       it "should set param as optional by default" do
-        param = Apipie::ParamDescription.new(:optional_by_default, String)
+        param = Apipie::ParamDescription.new(method_desc, :optional_by_default, String)
         param.required.should be_false
       end
 
       it "should be possible to set param as required" do
-        param = Apipie::ParamDescription.new(:required, String, 'description','required' => true)
+        param = Apipie::ParamDescription.new(method_desc, :required, String, 'description','required' => true)
         param.required.should be_true
       end
 
@@ -38,4 +48,70 @@ describe Apipie::ParamDescription do
 
   end
 
-end
+  describe "required params in action aware validator" do
+
+    subject { method_description.params[:user].validator.hash_params_ordered }
+
+    let(:required) do
+      subject.find_all(&:required).map(&:name)
+    end
+
+    let(:allowed_nil) do
+      subject.find_all(&:allow_nil).map(&:name)
+    end
+
+    context "with resource creation" do
+
+      let(:method_description) do
+        Apipie.get_method_description(UsersController, :create)
+      end
+
+      it "makes the param required" do
+        required.should include :name
+        required.should include :pass
+      end
+
+      it "doesn't allow nil" do
+        allowed_nil.should_not include :name
+        allowed_nil.should_not include :pass
+      end
+    end
+
+    context "with resource update" do
+
+      let(:method_description) do
+        Apipie.get_method_description(UsersController, :update)
+      end
+
+      it "doesn't make the param required" do
+        required.should_not include :name
+        required.should_not include :pass
+      end
+
+      it "doesn't allow nil" do
+        allowed_nil.should_not include :name
+        allowed_nil.should_not include :pass
+      end
+
+      it "doesn't touch params with explicitly set allow_nil" do
+        allowed_nil.should_not include :membership
+      end
+    end
+
+    context "with explicitly setting action type in param group" do
+      let(:method_description) do
+        Apipie.get_method_description(UsersController, :admin_create)
+      end
+
+      it "makes the param required" do
+        required.should include :name
+        required.should include :pass
+      end
+
+      it "doesn't allow nil" do
+        allowed_nil.should_not include :name
+        allowed_nil.should_not include :pass
+      end
+    end
+  end
+end

data/spec/lib/param_group_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+describe "param groups" do
+
+  it "lets reuse the params description in more actions" do
+    user_create_desc = Apipie["users#create"].params[:user]
+    user_create_params = user_create_desc.validator.hash_params_ordered.map(&:name)
+
+    user_update_desc = Apipie["users#update"].params[:user]
+    user_update_params = user_update_desc.validator.hash_params_ordered.map(&:name)
+
+    common = user_update_params & user_create_params
+    common.sort_by(&:to_s).should == user_update_params.sort_by(&:to_s)
+  end
+
+  it "allows using groups is nested param descriptions" do
+    user_create_desc = Apipie["users#update"].params[:user]
+    user_create_params = user_create_desc.validator.hash_params_ordered.map(&:name)
+    user_create_params.map(&:to_s).sort.should == %w[membership name pass]
+  end
+
+  it "should allow adding additional params to group" do
+    user_create_desc = Apipie["users#create"].params[:user]
+    user_create_params = user_create_desc.validator.hash_params_ordered.map(&:name)
+    user_create_params.map(&:to_s).sort.should == %w[membership name pass permalink]
+  end
+
+  context "hash param" do
+    it "influences only its childs" do
+      Apipie["users#create"].params[:user].required.should be true
+      Apipie["users#update"].params[:user].required.should be true
+    end
+  end
+
+  it "lets you reuse a group definition from different controller" do
+    arch_v1_desc = Apipie["1.0#architectures#create"].params[:architecture]
+    arch_v1_params = arch_v1_desc.validator.hash_params_ordered.map(&:name)
+
+    arch_v2_desc = Apipie["2.0#architectures#create"].params[:architecture]
+    arch_v2_params = arch_v2_desc.validator.hash_params_ordered.map(&:name)
+
+    arch_v1_params.sort_by(&:to_s).should == arch_v2_params.sort_by(&:to_s)
+  end
+end
+

data/spec/lib/resource_description_spec.rb

@@ -2,16 +2,18 @@ require "spec_helper"
 
 describe Apipie::ResourceDescription do
 
+  let(:dsl_data) { ActionController::Base.send(:_apipie_dsl_data_init) }
+
   describe "methods descriptions" do
 
     before(:each) do
       @resource = Apipie::ResourceDescription.new(ApplicationController, "dummy")
-      a = Apipie::MethodDescription.new(:a, @resource, Apipie.app)
-      b = Apipie::MethodDescription.new(:b, @resource, Apipie.app)
-      c = Apipie::MethodDescription.new(:c, @resource, Apipie.app)
-      @resource.add_method_description a
-      @resource.add_method_description b
-      @resource.add_method_description c
+      a = Apipie::MethodDescription.new(:a, @resource, dsl_data)
+      b = Apipie::MethodDescription.new(:b, @resource, dsl_data)
+      c = Apipie::MethodDescription.new(:c, @resource, dsl_data)
+      @resource.add_method_description(a)
+      @resource.add_method_description(b)
+      @resource.add_method_description(c)
     end
 
     it "should be ordered" do
@@ -25,4 +27,4 @@ describe Apipie::ResourceDescription do
     end
 
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-13 00:00:00.000000000Z
+date: 2013-02-22 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &21190160 !ruby/object:Gem::Requirement
+  requirement: &10023700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 3.0.10
   type: :runtime
   prerelease: false
-  version_requirements: *21190160
+  version_requirements: *10023700
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &21189740 !ruby/object:Gem::Requirement
+  requirement: &10023280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21189740
+  version_requirements: *10023280
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &21189280 !ruby/object:Gem::Requirement
+  requirement: &10022820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21189280
+  version_requirements: *10022820
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &21188860 !ruby/object:Gem::Requirement
+  requirement: &10022400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21188860
+  version_requirements: *10022400
 - !ruby/object:Gem::Dependency
   name: maruku
-  requirement: &21215040 !ruby/object:Gem::Requirement
+  requirement: &10021980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21215040
+  version_requirements: *10021980
 - !ruby/object:Gem::Dependency
   name: RedCloth
-  requirement: &21214620 !ruby/object:Gem::Requirement
+  requirement: &10021560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21214620
+  version_requirements: *10021560
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &21214200 !ruby/object:Gem::Requirement
+  requirement: &10047700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,7 +88,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21214200
+  version_requirements: *10047700
 description: Maintain your API documentation up to date!
 email:
 - pajkycz@gmail.com
@@ -99,12 +99,10 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
-- .rvmrc
 - .travis.yml
 - APACHE-LICENSE-2.0
 - CHANGELOG
 - Gemfile
-- Gemfile.lock
 - MIT-LICENSE
 - NOTICE
 - README.rst
@@ -207,6 +205,7 @@ files:
 - spec/dummy/script/rails
 - spec/lib/method_description_spec.rb
 - spec/lib/param_description_spec.rb
+- spec/lib/param_group_spec.rb
 - spec/lib/resource_description_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/Pajk/apipie-rails
@@ -280,5 +279,6 @@ test_files:
 - spec/dummy/script/rails
 - spec/lib/method_description_spec.rb
 - spec/lib/param_description_spec.rb
+- spec/lib/param_group_spec.rb
 - spec/lib/resource_description_spec.rb
 - spec/spec_helper.rb

data/.rvmrc

@@ -1 +0,0 @@
-rvm use 1.8.7@apipie --create

data/Gemfile.lock

@@ -1,117 +0,0 @@
-PATH
-  remote: .
-  specs:
-    apipie-rails (0.0.16)
-      rails (>= 3.0.10)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    RedCloth (4.2.9)
-    actionmailer (3.2.6)
-      actionpack (= 3.2.6)
-      mail (~> 2.4.4)
-    actionpack (3.2.6)
-      activemodel (= 3.2.6)
-      activesupport (= 3.2.6)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      journey (~> 1.0.1)
-      rack (~> 1.4.0)
-      rack-cache (~> 1.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.1.3)
-    activemodel (3.2.6)
-      activesupport (= 3.2.6)
-      builder (~> 3.0.0)
-    activerecord (3.2.6)
-      activemodel (= 3.2.6)
-      activesupport (= 3.2.6)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activeresource (3.2.6)
-      activemodel (= 3.2.6)
-      activesupport (= 3.2.6)
-    activesupport (3.2.6)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    arel (3.0.2)
-    builder (3.0.0)
-    diff-lcs (1.1.3)
-    erubis (2.7.0)
-    hike (1.2.1)
-    i18n (0.6.0)
-    journey (1.0.4)
-    json (1.7.3)
-    mail (2.4.4)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    maruku (0.6.1)
-      syntax (>= 1.0.0)
-    mime-types (1.19)
-    minitest (3.2.0)
-    multi_json (1.3.6)
-    polyglot (0.3.3)
-    rack (1.4.1)
-    rack-cache (1.2)
-      rack (>= 0.4)
-    rack-ssl (1.3.2)
-      rack
-    rack-test (0.6.1)
-      rack (>= 1.0)
-    rails (3.2.6)
-      actionmailer (= 3.2.6)
-      actionpack (= 3.2.6)
-      activerecord (= 3.2.6)
-      activeresource (= 3.2.6)
-      activesupport (= 3.2.6)
-      bundler (~> 1.0)
-      railties (= 3.2.6)
-    railties (3.2.6)
-      actionpack (= 3.2.6)
-      activesupport (= 3.2.6)
-      rack-ssl (~> 1.3.2)
-      rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (>= 0.14.6, < 2.0)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.1)
-    rspec-rails (2.11.0)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec (~> 2.11.0)
-    sprockets (2.1.3)
-      hike (~> 1.2)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.6)
-    syntax (1.0.0)
-    thor (0.15.4)
-    tilt (1.3.3)
-    treetop (1.4.12)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.35)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  RedCloth
-  apipie-rails!
-  maruku
-  minitest
-  rake
-  rspec-rails
-  sqlite3