standardapi 5.2.0.5 → 5.2.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e091251cb3cfdcaaca2c8779fe6104dbd64e184004e98c8185574103c7fb4ebf
-  data.tar.gz: 7f256e0dc1c67018b147ad3b0b3784ed07edd8cea49f2c26d8f9958eb3c0e9db
+  metadata.gz: e4b7a8c23e3996a005396e58c1586e921276a66d9c7bb69a2c3679d72eb4e56a
+  data.tar.gz: 840ae632d429e954b66edbba5f4cba69c5c0ab17ec6bda8b2e18e34c10040880
 SHA512:
-  metadata.gz: d92f6d09f3559bde47d8d30750e60359c527e6bdbebafaf036971720dfca80be6315a4b64f0c17675bd7bc00b6de45cb59c9f57740e6c38ae269b437df1a226f
-  data.tar.gz: 04e267511914cbd3e3bb047ad8287fe43d10587b0e3b08a6579bcdca785dcd45336f9e7497c940ff7ff9b63efdeed8d7a0c6389dcd87b891ea7f55f718f6dae4
+  metadata.gz: c395e361f79fce96f322ab5311a812300c416b05a28e46ae070164da15f8df23a2754663843ecf7969b736f0d7188142586d8c7b18a1d3d5d300a255cefc63bb
+  data.tar.gz: 863685a1c335afc5315545f0c511472a58cc588eccbe2a3273cac6a43d11cb86118eab40bdf6043ab3165a107fbddcca7381114dbdf3cb38fb6ed41ea51fd6b3

data/lib/standard_api/controller.rb

@@ -2,7 +2,7 @@ module StandardAPI
   module Controller
 
     def self.included(klass)
-      klass.helper_method :includes, :orders, :model, :resource_limit
+      klass.helper_method :includes, :orders, :model, :resource_limit, :default_limit
       klass.before_action :set_standardapi_headers
       klass.append_view_path(File.join(File.dirname(__FILE__), 'views'))
       klass.extend(ClassMethods)
@@ -208,11 +208,20 @@ module StandardAPI
       1000
     end
 
+    # The default limit if params[:limit] is no specified in a request.
+    # If this value should be less than the `resource_limit`. Return `nil` if
+    # you want the limit param to be required.
+    def default_limit
+      nil
+    end
+
     def limit
       if resource_limit
-        limit = params.require(:limit).to_i
+        limit = params.permit(:limit)[:limit]&.to_i || default_limit
 
-        if limit > resource_limit
+        if !limit
+          raise ActionController::ParameterMissing.new(:limit)
+        elsif limit > resource_limit
           raise ActionController::UnpermittedParameters.new([:limit, limit])
         end
 

data/lib/standard_api/test_case.rb

@@ -69,6 +69,10 @@ module StandardAPI::TestCase
     controller_class.new.send(:resource_limit)
   end
 
+  def default_limit
+    controller_class.new.send(:default_limit)
+  end
+
   def model
     self.class.model
   end

data/lib/standard_api/test_case/index_tests.rb

@@ -13,6 +13,7 @@ module StandardAPI
 
       test '#index.json requires limit' do
         return if !resource_limit || resource_limit == Float::INFINITY
+        return if default_limit
 
         begin
           get resource_path(:index, format: :json)
@@ -21,6 +22,13 @@ module StandardAPI
         end
       end
 
+      test '#index.json uses default_limit' do
+        return if !default_limit
+
+        get resource_path(:index, format: :json)
+        assert_response :ok
+      end
+
       test '#index.json params[:limit]' do
         get resource_path(:index, format: :json), params: { limit: 1 }
         models = @controller.instance_variable_get("@#{plural_name}")

data/lib/standard_api/version.rb

@@ -1,3 +1,3 @@
 module StandardAPI
-  VERSION = '5.2.0.5'
+  VERSION = '5.2.0.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standardapi
 version: !ruby/object:Gem::Version
-  version: 5.2.0.5
+  version: 5.2.0.6
 platform: ruby
 authors:
 - James Bracy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-06 00:00:00.000000000 Z
+date: 2018-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -324,7 +324,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: StandardAPI makes it easy to expose a query interface for your Rails models