apipie-rails 1.4.0 → 1.4.1

data/spec/controllers/users_controller_spec.rb

@@ -28,7 +28,7 @@ describe UsersController do
       Apipie.get_resource_description(UsersController, Apipie.configuration.default_version)
     end
 
-    it "should contain all resource methods" do
+    it "contains all resource methods" do
       methods = subject._methods
       expect(methods.keys).to include(:show)
       expect(methods.keys).to include(:create_route)
@@ -40,7 +40,7 @@ describe UsersController do
       expect(methods.keys).to include(:multiple_required_params)
     end
 
-    it "should contain info about resource" do
+    it "contains info about resource" do
       expect(subject._short_description).to eq('Site members')
       expect(subject._id).to eq('users')
       expect(subject._path).to eq('/users')
@@ -49,7 +49,7 @@ describe UsersController do
       expect(subject._formats).to eq(['json'])
     end
 
-    it "should contain params defined on resource level" do
+    it "contains params defined on resource level" do
       expect(subject._params_args.count).to eq(2)
       name, type, options = subject._params_args.first
       expect(name).to eq(:id)
@@ -67,12 +67,12 @@ describe UsersController do
         Apipie.configuration.validate_presence = true
       end
 
-      it "should reply to valid request" do
+      it "replies to valid request" do
         get :show, :params => { :id => '5', :session => "secret_hash" }
         assert_response :success
       end
 
-      it "should pass if required parameter is missing" do
+      it "passes if required parameter is missing" do
         expect { get :show, :params => { :id => 5 } }.not_to raise_error
       end
 
@@ -93,20 +93,20 @@ describe UsersController do
             Apipie.configuration.validate_key = false
           end
 
-          it "should reply to valid request" do
+          it "replies to valid request" do
             expect { get :show, :params => { :id => 5, :session => "secret_hash" }}.not_to raise_error
             assert_response :success
           end
 
-          it "should fail if required parameter is missing" do
+          it "fails if required parameter is missing" do
             expect { get :show, :params => { :id => 5 }}.to raise_error(Apipie::ParamMissing, /session_parameter_is_required/)
           end
 
-          it "should fail if multiple required parameters are missing" do
+          it "fails if multiple required parameters are missing" do
             expect { get :multiple_required_params }.to raise_error(Apipie::ParamMultipleMissing, /required_param1.*\n.*required_param2|required_param2.*\n.*required_parameter1/)
           end
 
-          it "should pass if required parameter has wrong type" do
+          it "passes if required parameter has wrong type" do
             expect { get :show, :params => { :id => 5 , :session => "secret_hash" }}.not_to raise_error
             expect { get :show, :params => { :id => "ten" , :session => "secret_hash" }}.not_to raise_error
           end
@@ -120,12 +120,12 @@ describe UsersController do
             Apipie.configuration.validate_key = true
           end
 
-          it "should reply to valid request" do
+          it "replies to valid request" do
             expect { get :show, :params => { :id => 5, :session => 'secret_hash' }}.not_to raise_error
             assert_response :success
           end
 
-          it "should fail if extra parameter is passed in" do
+          it "fails if extra parameter is passed in" do
             expect { get :show, :params => { :id => 5 , :badparam => 'badfoo', :session => "secret_hash" }}.to raise_error(Apipie::UnknownParam, /\bbadparam\b/)
           end
         end
@@ -138,12 +138,12 @@ describe UsersController do
             Apipie.configuration.action_on_non_validated_keys = :skip
           end
 
-          it "should reply to valid request" do
+          it "replies to valid request" do
             expect { get :show, :params => { :id => 5, :session => 'secret_hash' }}.not_to raise_error
             assert_response :success
           end
 
-          it "should delete the param and not fail if an extra parameter is passed." do
+          it "deletes the param and not fail if an extra parameter is passed." do
             expect { get :show, :params => { :id => 5 , :badparam => 'badfoo', :session => "secret_hash" }}.not_to raise_error
             expect(controller.params.as_json).to eq({"session"=>"secret_hash", "id"=>"5", "controller"=>"users", "action"=>"show"})
           end
@@ -160,41 +160,42 @@ describe UsersController do
             Apipie.configuration.validate_key = false
           end
 
-          it "should reply to valid request" do
+          it "replies to valid request" do
             get :show, :params => { :id => '5', :session => "secret_hash" }
             assert_response :success
           end
 
-          it "should work with nil value for a required hash param" do
-            expect {
+          it "works with nil value for a required hash param" do
+            expect do
               get :show, :params => { :id => '5', :session => "secret_hash", :hash_param => {:dummy_hash => nil} }
-            }.to raise_error(Apipie::ParamInvalid, /dummy_hash/)
+            end.to raise_error(Apipie::ParamInvalid, /dummy_hash/)
             assert_response :success
           end
 
-          it "should fail if required parameter is missing" do
+          it "fails if required parameter is missing" do
             expect { get :show, :params => { :id => 5 }}.to raise_error(Apipie::ParamMissing, /session_parameter_is_required/)
           end
 
-          it "should work with custom Type validator" do
-            expect {
+          # old-style error rather than ParamInvalid
+          it "works with custom Type validator" do
+            expect do
               get :show,
                   :params => { :id => "not a number", :session => "secret_hash" }
-            }.to raise_error(Apipie::ParamError, /id/) # old-style error rather than ParamInvalid
+            end.to raise_error(Apipie::ParamError, /id/)
           end
 
-          it "should work with Regexp validator" do
+          it "works with Regexp validator" do
             get :show, :params => { :id => 5, :session => "secret_hash", :regexp_param => "24 years" }
             assert_response :success
 
-            expect {
+            expect do
               get :show, :params => { :id => 5,
                                       :session => "secret_hash",
                                       :regexp_param => "ten years" }
-            }.to raise_error(Apipie::ParamInvalid, /regexp_param/)
+            end.to raise_error(Apipie::ParamInvalid, /regexp_param/)
           end
 
-          it "should work with Array validator" do
+          it "works with Array validator" do
             get :show, :params => { :id => 5, :session => "secret_hash", :array_param => "one" }
             assert_response :success
             get :show, :params => { :id => 5, :session => "secret_hash", :array_param => "two" }
@@ -202,28 +203,28 @@ describe UsersController do
             get :show, :params => { :id => 5, :session => "secret_hash", :array_param => '1' }
             assert_response :success
 
-            expect {
+            expect do
               get :show, :params => { :id => 5,
                                       :session => "secret_hash",
                                       :array_param => "blabla" }
-            }.to raise_error(Apipie::ParamInvalid, /array_param/)
+            end.to raise_error(Apipie::ParamInvalid, /array_param/)
 
-            expect {
+            expect do
               get :show, :params => {
                 :id => 5,
                 :session => "secret_hash",
                 :array_param => 3 }
-            }.to raise_error(Apipie::ParamInvalid, /array_param/)
+            end.to raise_error(Apipie::ParamInvalid, /array_param/)
           end
 
-          it "should work with Proc validator" do
-            expect {
+          it "works with Proc validator" do
+            expect do
               get :show,
                   :params => {
                     :id => 5,
                     :session => "secret_hash",
                     :proc_param => "asdgsag" }
-            }.to raise_error(Apipie::ParamInvalid, /proc_param/)
+            end.to raise_error(Apipie::ParamInvalid, /proc_param/)
 
             get :show,
                 :params => {
@@ -233,7 +234,7 @@ describe UsersController do
             assert_response :success
           end
 
-          it "should work with Hash validator" do
+          it "works with Hash validator" do
             post :create, params: { :user => { :name => "root", :pass => "12345", :membership => "standard" } }
             assert_response :success
 
@@ -247,28 +248,28 @@ describe UsersController do
             hash_params[1].name == :pass
             hash_params[2].name == :membership
 
-            expect {
+            expect do
               post :create, :params => { :user => { :name => "root", :pass => "12345", :membership => "____" } }
-            }.to raise_error(Apipie::ParamInvalid, /membership/)
+            end.to raise_error(Apipie::ParamInvalid, /membership/)
 
             # Should include both pass and name
-            expect {
+            expect do
               post :create, :params => { :user => { :membership => "standard" } }
-            }.to raise_error(Apipie::ParamMultipleMissing, /pass.*\n.*name|name.*\n.*pass/)
+            end.to raise_error(Apipie::ParamMultipleMissing, /pass.*\n.*name|name.*\n.*pass/)
 
-            expect {
+            expect do
               post :create, :params => { :user => { :name => "root" } }
-            }.to raise_error(Apipie::ParamMissing, /pass/)
+            end.to raise_error(Apipie::ParamMissing, /pass/)
 
-            expect {
+            expect do
               post :create, :params => { :user => "a string is not a hash" }
-            }.to raise_error(Apipie::ParamInvalid, /user/)
+            end.to raise_error(Apipie::ParamInvalid, /user/)
 
             post :create, :params => { :user => { :name => "root", :pass => "pwd" } }
             assert_response :success
           end
 
-          it "should support Hash validator without specifying keys" do
+          it "supports Hash validator without specifying keys" do
             params = Apipie[UsersController, :create].to_json[:params]
             expect(params).to include(:name => "facts",
                                   :full_name => "facts",
@@ -284,7 +285,7 @@ describe UsersController do
                                   :validations => [])
           end
 
-          it "should allow nil when allow_nil is set to true" do
+          it "allows nil when allow_nil is set to true" do
             post :create,
                  :params => {
                    :user => {
@@ -297,7 +298,7 @@ describe UsersController do
             assert_response :success
           end
 
-          it "should allow blank when allow_blank is set to true" do
+          it "allows blank when allow_blank is set to true" do
             post :create,
               :params => {
                 :user => {
@@ -313,7 +314,7 @@ describe UsersController do
           describe "nested elements"  do
 
             context "with valid input" do
-              it "should succeed" do
+              it "succeeds" do
                 put :update,
                     :params => {
                       :id => 5,
@@ -335,8 +336,8 @@ describe UsersController do
               end
             end
             context "with bad input" do
-              it "should raise an error" do
-                expect{
+              it "raises an error" do
+                expect do
                   put :update,
                       :params => {
                         :id => 5,
@@ -353,10 +354,10 @@ describe UsersController do
                           }
                         ]
                       }
-                }.to raise_error(Apipie::ParamInvalid)
+                end.to raise_error(Apipie::ParamInvalid)
               end
             end
-            it "should work with empty array" do
+            it "works with empty array" do
               put :update,
                   :params => {
                     :id => 5,
@@ -407,7 +408,7 @@ describe UsersController do
 
   describe "method description" do
 
-    it "should contain basic info about method" do
+    it "contains basic info about method" do
       a = Apipie[UsersController, :create]
       expect(a.apis.count).to eq(1)
       expect(a.formats).to eq(['json'])
@@ -431,7 +432,7 @@ describe UsersController do
     end
 
     context "Using routes.rb" do
-      it "should contain basic info about method" do
+      it "contains basic info about method" do
         a = Apipie[UsersController, :create_route]
         expect(a.apis.count).to eq(1)
         expect(a.formats).to eq(['json'])
@@ -446,7 +447,7 @@ describe UsersController do
     context "contain :see option" do
 
       context "the key is valid" do
-        it "should contain reference to another method" do
+        it "contains reference to another method" do
           api = Apipie[UsersController, :see_another]
           expect(api.show).to be false
           see = api.see.first
@@ -464,18 +465,18 @@ describe UsersController do
       end
 
       context "the key is not valid" do
-        it "should raise exception" do
+        it "raises exception" do
           api = Apipie[UsersController, :see_another]
           api.instance_variable_set :@see, [Apipie::SeeDescription.new(['doesnot#exist'])]
-          expect {
+          expect do
             api.see.first.see_url
-          }.to raise_error(ArgumentError, /does not exist/)
+          end.to raise_error(ArgumentError, /does not exist/)
           api.instance_variable_set :@see, []
         end
       end
     end
 
-    it "should contain possible errors description" do
+    it "contains possible errors description" do
       a = Apipie.get_method_description(UsersController, :show)
 
       expect(a.errors[0].code).to eq(500)
@@ -486,7 +487,7 @@ describe UsersController do
       expect(a.errors[2].description).to eq("Not Found")
     end
 
-    it 'should recognize Rack symbols as error codes' do
+    it 'recognizes Rack symbols as error codes' do
       a = Apipie.get_method_description(UsersController, :create)
 
       error = a.errors.find { |e| e.code == 422 }
@@ -494,7 +495,7 @@ describe UsersController do
       expect(error.description).to include("Unprocessable Entity")
     end
 
-    it "should contain all params description" do
+    it "contains all params description" do
       a = Apipie.get_method_description(UsersController, :show)
       expect(a.params.count).to eq(12)
       expect(a.instance_variable_get('@params_ordered').count).to eq(10)
@@ -564,7 +565,7 @@ describe UsersController do
       end
     end
 
-    it "should contain all api method description" do
+    it "contains all api method description" do
       method_description = Apipie[UsersController, :two_urls]
       expect(method_description.class).to be(Apipie::MethodDescription)
       expect(method_description.apis.count).to eq(2)
@@ -579,7 +580,7 @@ describe UsersController do
       expect(a2.http_method).to eq('GET')
     end
 
-    it "should be described by valid json" do
+    it "is described by valid json" do
       json = Apipie[UsersController, :two_urls].to_json
       expected_hash = {
         :errors => [{:code=>404, :description=>"Missing", :metadata => {:some => "metadata"}},
@@ -672,7 +673,7 @@ describe UsersController do
 
   describe "examples" do
 
-    it "should be able to load examples from yml file" do
+    it "is able to load examples from yml file" do
       expect(Apipie.get_method_description(UsersController, :show).examples).to eq [<<EOS1, <<EOS2].map(&:chomp)
 GET /users/14?verbose=true
 200
@@ -686,7 +687,7 @@ EOS2
     end
 
     describe "document" do
-      it "should be able to load document from markup file" do
+      it "is able to load document from markup file" do
         expect(Apipie.get_method_description(UsersController, :desc_from_file).full_description).to include("description from document")
       end
     end
@@ -694,7 +695,7 @@ EOS2
 
   describe "param description" do
 
-    it "should contain all specified information" do
+    it "contains all specified information" do
       a = Apipie.get_method_description(UsersController, :show)
 
       param = a.params[:session]

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

@@ -1,10 +1,10 @@
-  module ExtendingConcern
-    extend Apipie::DSL::Concern
+module ExtendingConcern
+  extend Apipie::DSL::Concern
 
-    update_api(:create) do
-      param :user, Hash do
-        param :from_concern, String, :desc => 'param from concern', :allow_nil => false
-      end
-      meta metadata: 'data'
+  update_api(:create) do
+    param :user, Hash do
+      param :from_concern, String, :desc => 'param from concern', :allow_nil => false
     end
+    meta metadata: 'data'
   end
+end

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

@@ -364,8 +364,8 @@ class PetsController < ApplicationController
     result =  {
         a_number: 3,
         array_of_objects: [
-            {number1: 1, number2: 2},
-            {number1: 10, number2: 20}
+          {number1: 1, number2: 2},
+          {number1: 10, number2: 20}
         ]
     }
     render :json => result
@@ -387,8 +387,8 @@ class PetsController < ApplicationController
     result =  {
         a_number: 3,
         array_of_objects: [
-            {number1: 1, number2: 2},
-            {number1: 10, number2: "this should have been a number"}
+          {number1: 1, number2: 2},
+          {number1: 10, number2: "this should have been a number"}
         ]
     }
     render :json => result

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

@@ -22,11 +22,11 @@ class SelfDocumentingView
   # self.describe_own_properties (a class method) generates the meta-data
   # (i.e., the type description) for the subclass.
   def self.describe_own_properties
-    (self.instance_methods - self.class.instance_methods).map{|m|
+    (self.instance_methods - self.class.instance_methods).map do |m|
       if matchdata = /^v_(\w+)__(\w+)$/.match(m)
         Apipie::prop(matchdata[1], matchdata[2])
       end
-    }.compact
+    end.compact
   end
 
   # to_json (an instance method) generates the actual view

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

@@ -13,9 +13,9 @@
 class Pet
   def self.describe_own_properties
     [
-        Apipie::prop(:pet_name, 'string', {:description => 'Name of pet', :required => false}),
-        Apipie::prop(:animal_type, 'string', {:description => 'Type of pet', :values => %w[dog cat iguana kangaroo]}),
-        Apipie::additional_properties(false)
+      Apipie::prop(:pet_name, 'string', {:description => 'Name of pet', :required => false}),
+      Apipie::prop(:animal_type, 'string', {:description => 'Type of pet', :values => %w[dog cat iguana kangaroo]}),
+      Apipie::additional_properties(false)
     ]
   end
 end
@@ -26,14 +26,14 @@ end
 class PetWithMeasurements
   def self.describe_own_properties
     [
-        Apipie::prop(:pet_name, 'string', {:description => 'Name of pet', :required => false}),
-        Apipie::prop('animal_type', 'string', {:description => 'Type of pet', :values => %w[dog cat iguana kangaroo]}),
-        Apipie::prop(:pet_measurements, 'object', {}, [
-            Apipie::prop(:weight, 'number', {:description => "Weight in pounds" }),
-            Apipie::prop(:height, 'number', {:description => "Height in inches" }),
-            Apipie::prop(:num_legs, 'number', {:description => "Number of legs", :required => false }),
-            Apipie::additional_properties(false)
-        ])
+      Apipie::prop(:pet_name, 'string', {:description => 'Name of pet', :required => false}),
+      Apipie::prop('animal_type', 'string', {:description => 'Type of pet', :values => %w[dog cat iguana kangaroo]}),
+      Apipie::prop(:pet_measurements, 'object', {}, [
+                     Apipie::prop(:weight, 'number', {:description => "Weight in pounds" }),
+                     Apipie::prop(:height, 'number', {:description => "Height in inches" }),
+                     Apipie::prop(:num_legs, 'number', {:description => "Number of legs", :required => false }),
+                     Apipie::additional_properties(false)
+                   ])
     ]
   end
 end
@@ -44,11 +44,11 @@ end
 class PetWithManyMeasurements
   def self.describe_own_properties
     [
-        Apipie::prop(:pet_name, 'string', {:description => 'Name of pet', :required => false}),
-        Apipie::prop(:many_pet_measurements, 'object', {is_array: true}, [
-            Apipie::prop(:weight, 'number', {:description => "Weight in pounds" }),
-            Apipie::prop(:height, 'number', {:description => "Height in inches" }),
-        ])
+      Apipie::prop(:pet_name, 'string', {:description => 'Name of pet', :required => false}),
+      Apipie::prop(:many_pet_measurements, 'object', {is_array: true}, [
+                     Apipie::prop(:weight, 'number', {:description => "Weight in pounds" }),
+                     Apipie::prop(:height, 'number', {:description => "Height in inches" }),
+                   ])
     ]
   end
 end

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

@@ -1,39 +1,39 @@
-  module SampleController
-    extend Apipie::DSL::Concern
+module SampleController
+  extend Apipie::DSL::Concern
 
-    api!
-    def index
-      render :plain => "OK #{params.inspect}"
-    end
+  api!
+  def index
+    render :plain => "OK #{params.inspect}"
+  end
 
-    api :GET, '/:resource_id/:id'
-    param :id, String
-    def show
-      render :plain => "OK #{params.inspect}"
-    end
+  api :GET, '/:resource_id/:id'
+  param :id, String
+  def show
+    render :plain => "OK #{params.inspect}"
+  end
 
-    def_param_group :concern do
-      param :concern, Hash, :required => true, :action_aware => true do
-        param :name, String, "Name of a :concern"
-        param :concern_type, String
-      end
+  def_param_group :concern do
+    param :concern, Hash, :required => true, :action_aware => true do
+      param :name, String, "Name of a :concern"
+      param :concern_type, String
     end
+  end
 
-    api :POST, '/:resource_id', "Create a :concern"
-    param_group :concern
-    def create
-      render :plain => "OK #{params.inspect}"
-    end
+  api :POST, '/:resource_id', "Create a :concern"
+  param_group :concern
+  def create
+    render :plain => "OK #{params.inspect}"
+  end
 
-    api :PUT, '/:resource_id/:id'
-    param :id, String
-    param_group :concern
-    def update
-      render :plain => "OK #{params.inspect}"
-    end
+  api :PUT, '/:resource_id/:id'
+  param :id, String
+  param_group :concern
+  def update
+    render :plain => "OK #{params.inspect}"
+  end
 
-    api :GET, '/:resource_id/:custom_subst'
-    def custom
-      render :plain => "OK #{params.inspect}"
-    end
+  api :GET, '/:resource_id/:custom_subst'
+  def custom
+    render :plain => "OK #{params.inspect}"
   end
+end

data/spec/lib/apipie/application_spec.rb

@@ -8,7 +8,7 @@ describe Apipie::Application do
                                                       File.join(Rails.root, "lib", "**","*.rb")]
     end
 
-    it "should support receiving array as parameter" do
+    it "supports receiving array as parameter" do
       expect { Apipie.api_controllers_paths}.
         not_to raise_error
     end
@@ -33,7 +33,7 @@ describe Apipie::Application do
       context "with an undefined base url" do
         let(:base_url) { nil }
 
-        it "should not raise an error" do
+        it "does not raise an error" do
           expect { method_call }.not_to raise_error
         end
       end

data/spec/lib/apipie/extractor/writer_spec.rb

@@ -6,7 +6,7 @@ describe Apipie::Extractor::Writer do
   let(:writer_class) { Apipie::Extractor::Writer }
   let(:writer) { writer_class.new(collector) }
   let(:test_examples_file) { File.join(Rails.root, "doc", "apipie_examples_test.json") }
-  let(:records) {
+  let(:records) do
     {
     "concern_resources#show" =>
       [{
@@ -31,8 +31,8 @@ describe Apipie::Extractor::Writer do
         :code=>"200"
       }]
     }
-  }
-  let(:loaded_records) {
+  end
+  let(:loaded_records) do
     {
     "concern_resources#show" =>
       [{
@@ -57,7 +57,7 @@ describe Apipie::Extractor::Writer do
         "recorded"=>true
       }]
     }
-  }
+  end
 
   context 'with doc_path overridden in configuration' do
     around(:each) do |example|
@@ -67,7 +67,7 @@ describe Apipie::Extractor::Writer do
       Apipie.configuration.doc_path = standard_path
     end
 
-    it 'should use the doc_path specified in configuration' do
+    it 'uses the doc_path specified in configuration' do
       expect(writer_class.examples_file).to eql(File.join(Rails.root, 'tmp', 'user_specified_doc_path', 'apipie_examples.json'))
     end
   end
@@ -80,13 +80,13 @@ describe Apipie::Extractor::Writer do
       Apipie.configuration.compress_examples = nil
     end
 
-    it 'should write to a compressed file' do
+    it 'writes to a compressed file' do
       expect(writer_class.examples_file).to match(/\.gz$/)
       writer_class.write_recorded_examples(records)
       expect(File.exist?(writer_class.examples_file))
     end
 
-    it 'should read from a compressed file' do
+    it 'reads from a compressed file' do
       writer_class.write_recorded_examples(records)
       expected_string = writer_class.send(:serialize_examples, records)
       expect(writer_class.load_recorded_examples)
@@ -100,7 +100,7 @@ describe Apipie::Extractor::Writer do
       expect(collector).to receive(:records).and_return(records)
     end
 
-    it "should read and write examples" do
+    it "reads and write examples" do
       writer.write_examples
       expect(writer.send(:load_recorded_examples)).to eql(loaded_records)
     end