introspective_grape 0.2.9 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66a8d39d065336f27862ed3f129510931bfc2d25
-  data.tar.gz: 667b52d722d3ea2b348cfcb3c5ca2a901ea8362d
+  metadata.gz: cb071dc16f5b81676e9c1f8472729d13d6ac51b5
+  data.tar.gz: ff807faad54a81270717f30e7c46320f56147bbb
 SHA512:
-  metadata.gz: 5287b37289410314b6d3993f80f852db914291eac20b10d3c322c65a1307fe27457a2b00fdd0844323d7d625765d35a04606dfbe38ad379f4e5cb721d15e97e3
-  data.tar.gz: bb415d186d385970deae105c58b9685d56f646c5b0bc69d0bcc5b1e2973d5a9c1433a883c897d51abd7895469709b764f3d5ad64ebc3b3e6cbb2b6819609bfc9
+  metadata.gz: fcb4c96419246d601ebcc8c96ea5b1bad2ca4cdb44ec5e3fc2c89ce72a59b53778b21258160cde463c23bf7cb468fbec833cb2337c24e8b754a6530a7049ca21
+  data.tar.gz: fa6897a8637f5e58b2ace975324f4c186257046bb340774d11851268b0bd78cd1bc432b8b92eff4fcf6065cb74f1bec7e310085d4a33dec7731079fbc4f2327b

data/README.md

@@ -70,6 +70,18 @@ IntrospectiveGrape::API.authentication_method = "whatever!"
 
 Pundit authorization is invoked against index?, show?, update?, create?, and destroy? methods with the model instance in question (or a new instance in the case of index).
 
+The joke goes that you may find you need to allow an unauthenticated user to attempt a log in, which can be handled with something like:
+
+```
+ def authorize!
+    unauthorized! unless current_user || login_request?
+  end
+
+  def login_request?
+    # is it the session login endpoint?
+    self.method_name.start_with?('POST') && self.namespace == '/login'
+  end
+```
 
 ## Generate End Points for Models
 
@@ -152,11 +164,14 @@ class MyModelAPI < IntrospectiveGrape::API
 end
 ```
 
-Multiple values can be specified at once for Integer attributes that end in "id" (i.e. conventional primary and foreign keys) by passing a comma separated list of IDs.
+Multiple values can be specified at once for Integer attributes that end in "id" (i.e.
+conventional primary and foreign keys) by passing a comma separated list of IDs.
 
-For timestamp attributes it will generate `<name_of_timestamp>_start` and `<name_of_timestamp>_end` constraints.
+For timestamp attributes it will generate `<name_of_timestamp>_start` and
+`<name_of_timestamp>_end` range constraints.
 
-There is also a special "filter" filter, that allows a JSON hash to be passed of attributes and values: this allows more complex filtering if one is familiar with ActiveRecord's query conventions.
+There is also a special "filter" filter that accepts a JSON hash of attributes and values:
+this allows more complex filtering if one is familiar with ActiveRecord's query conventions.
 
 ### Overriding Filter Queries
 
@@ -199,7 +214,8 @@ end
 
 ## Documenting Endpoints
 
-If you wish to provide additional documentation for end points you can define `<action>_documentation` methods in the API class.
+If you wish to provide additional documentation for end points you can define
+`<action>_documentation` methods in the API class.
 
 ## Pagination
 
@@ -210,7 +226,7 @@ The index action by default will not be paginated, simply declared `paginate` be
 By default any association included in the strong params argument will have all
 RESTful (`:index,:show,:create,:update, :destroy`) endpoints defined. These can
 be excluded (or conversely included) with the `exclude_actions` or `include_actions`
-declarations on the model. You can also include or exclude :all or :none as shorthand.
+declarations in the API class. You can also include or exclude :all or :none as shorthand.
 
 ## Grape Hooks
 

data/lib/introspective_grape.rb

@@ -5,6 +5,7 @@ module IntrospectiveGrape
   autoload :Doc,            'introspective_grape/doc'
   autoload :Filters,        'introspective_grape/filters'
   autoload :Helpers,        'introspective_grape/helpers'
+  autoload :SnakeParams,    'introspective_grape/snake_params'
   autoload :Traversal,      'introspective_grape/traversal'
 
   module Formatter

data/lib/introspective_grape/api.rb

@@ -12,6 +12,7 @@ module IntrospectiveGrape
     extend IntrospectiveGrape::Filters
     extend IntrospectiveGrape::Traversal
     extend IntrospectiveGrape::Doc
+    extend IntrospectiveGrape::SnakeParams
 
     # Allow files to be uploaded through ActionController:
     ActionController::Parameters::PERMITTED_SCALAR_TYPES.push Rack::Multipart::UploadedFile, ActionController::Parameters
@@ -57,18 +58,7 @@ module IntrospectiveGrape
           self.send(IntrospectiveGrape::API.authentication_method(self))
         end
 
-        if IntrospectiveGrape.config.camelize_parameters
-          child.before_validation do
-            # We have to snake case the Rack params then re-assign @params to the
-            # request.params, because of the I-think-very-goofy-and-inexplicable
-            # way Grape interacts with both independently of each other
-            (params.try(:with_snake_keys)||{}).each do |k,v|
-              request.delete_param(k.camelize(:lower))
-              request.update_param(k, v)
-            end
-            @params = request.params 
-          end
-        end
+        child.snake_params_before_validation if IntrospectiveGrape.config.camelize_parameters
       end
 
       # We will probably need before and after hooks eventually, but haven't yet...

data/lib/introspective_grape/snake_params.rb

@@ -0,0 +1,16 @@
+module IntrospectiveGrape
+  module SnakeParams
+    def snake_params_before_validation
+      before_validation do
+        # We have to snake case the Rack params then re-assign @params to the
+        # request.params, because of the I-think-very-goofy-and-inexplicable
+        # way Grape interacts with both independently of each other
+        (params.try(:with_snake_keys)||{}).each do |k,v|
+          request.delete_param(k.camelize(:lower))
+          request.update_param(k, v)
+        end
+        @params = request.params
+      end
+    end
+  end
+end

data/lib/introspective_grape/version.rb

@@ -1,3 +1,3 @@
 module IntrospectiveGrape
-  VERSION = "0.2.9".freeze
+  VERSION = "0.3.0".freeze
 end

data/spec/dummy/app/api/api_helpers.rb

@@ -1,14 +1,14 @@
 module ApiHelpers
-  def warden
-    env['warden']
-  end
-
   def current_user
-    warden.user || params[:api_key].present? && @user = User.find_by_authentication_token(params[:api_key])
+    params[:api_key].present? && @user = User.find_by_authentication_token(params[:api_key])
   end
 
   def authenticate!
-    unauthenticated! unless current_user 
+    unauthenticated! unless login_request? || current_user
+  end
+
+  def login_request?
+    self.method_name.start_with?('POST') && self.namespace == '/sessions'
   end
 
   # returns an 'unauthenticated' response

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: introspective_grape
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.3.0
 platform: ruby
 authors:
 - Josh Buermann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-20 00:00:00.000000000 Z
+date: 2017-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -264,6 +264,7 @@ files:
 - lib/introspective_grape/filters.rb
 - lib/introspective_grape/formatter/camel_json.rb
 - lib/introspective_grape/helpers.rb
+- lib/introspective_grape/snake_params.rb
 - lib/introspective_grape/traversal.rb
 - lib/introspective_grape/validators.rb
 - lib/introspective_grape/version.rb