introspective_grape 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: de6a41c1400168ecda38b06734cdd3678071328a
-  data.tar.gz: ce20e1fc247df07463068dade8bc7e6ccfeb4e7c
+SHA256:
+  metadata.gz: d1070be152294dd627fb6f0e98038ae626412ddd716dd1ae97137de93b1b0d70
+  data.tar.gz: 12fe0f44356159f58a8482b297a4e2268b9a4da3281be1e8cd1599bd1d2f0bc0
 SHA512:
-  metadata.gz: 6cd190fef2c67c05f7e6f472458686d347f1e70d64960f3909439203b032627e899ecdce9966a81046e08eb164007b91cf13a35b62555cf144c43e3d3b9f2c0e
-  data.tar.gz: 256ae7c47d140a34431bdb400b24ae703d25a48ded09e8639c54a4ca5cacf7f3f5ea50602226b8bb2510f15013df90763a9d56e141f9fcef1683d944b30e99be
+  metadata.gz: 7d3086df6face4380f6596be5b9dea2dc61a72e3672c2e74a175e9236cd0a18fcac749e2eeef1a8df8724e232ac816c0ca9cdec425da7a3912c997a3f91b1037
+  data.tar.gz: eee38bbee623810f27dd48d925cc456abd3a6ccbcb8773cfb4945afea29aa5da92bc6f61cbd57601f0c5ed613b4f9c4a839621bc91f33e727282d66d96e4e9ff

data/.travis.yml

@@ -1,76 +1,29 @@
 language: ruby
 before_install:
-  - gem install bundler
+  - gem install bundler -v 1.17.3
 install: bundle install --jobs=1 --retry=1
 script:
   - bundle install
   - bundle exec rspec
 
 rvm:
-  - 2.0.0
-  - 2.1.0
-  - 2.2.0
-  - 2.2.6
-  - 2.3.0
+  - 2.3.1
   - 2.4.0
+  - 2.5.0
   - ruby-head
   - jruby-head
 gemfile:
-#  - gemfiles/Gemfile.rails.3.2.22
-#  - gemfiles/Gemfile.rails.4.1.13
-  - gemfiles/Gemfile.rails.4.2.7.1
-  - gemfiles/Gemfile.rails.4.2.7.1.new.swagger
-  - gemfiles/Gemfile.rails.4.2.8
   - gemfiles/Gemfile.rails.5.0.1
+  - gemfiles/Gemfile.rails.5.1.0
+  - gemfiles/Gemfile.rails.5.2.0
   - gemfiles/Gemfile.rails.master
 
 matrix:
   exclude:
-    # We'll have to back up to grape-swagger 0.11 for earlier rubies.
-    - rvm: 2.0.0
-      gemfile: gemfiles/Gemfile.rails.4.2.7.1.new.swagger
-    - rvm: 2.0.0
-      gemfile: gemfiles/Gemfile.rails.4.2.8
-    - rvm: 2.0.0
-      gemfile: gemfiles/Gemfile.rails.5.0.1
-    - rvm: 2.0.0
-      gemfile: gemfiles/Gemfile.rails.master
-    - rvm: 2.1.0
-      gemfile: gemfiles/Gemfile.rails.4.2.7.1.new.swagger
-    - rvm: 2.1.0
-      gemfile: gemfiles/Gemfile.rails.4.2.8
-    - rvm: 2.1.0
-      gemfile: gemfiles/Gemfile.rails.5.0.1
-    - rvm: 2.1.0
-      gemfile: gemfiles/Gemfile.rails.master
-    - rvm: 2.2.0
-      gemfile: gemfiles/Gemfile.rails.4.2.7.1.new.swagger
-    - rvm: 2.2.0
-      gemfile: gemfiles/Gemfile.rails.4.2.8
-    - rvm: 2.2.0
-      gemfile: gemfiles/Gemfile.rails.5.0.1
-    - rvm: 2.2.0
-      gemfile: gemfiles/Gemfile.rails.master
-    - rvm: 2.4.0
-      gemfile: gemfiles/Gemfile.rails.4.2.7.1
-    - rvm: 2.4.0
-      gemfile: gemfiles/Gemfile.rails.4.2.7.1.new.swagger
-    - rvm: jruby-9.0.4.0
-      gemfile: gemfiles/Gemfile.rails.4.2.7.1.new.swagger
-    - rvm: jruby-9.0.4.0
-      gemfile: gemfiles/Gemfile.rails.4.2.8
     - rvm: jruby-9.0.4.0
       gemfile: gemfiles/Gemfile.rails.5.0.1
     - rvm: jruby-9.0.4.0
       gemfile: gemfiles/Gemfile.rails.master
-    - rvm: ruby-head
-      gemfile: gemfiles/Gemfile.rails.4.2.7.1
-    - rvm: ruby-head
-      gemfile: gemfiles/Gemfile.rails.4.2.7.1.new.swagger
-    - rvm: jruby-head
-      gemfile: gemfiles/Gemfile.rails.4.2.7.1
-    - rvm: jruby-head
-      gemfile: gemfiles/Gemfile.rails.4.2.7.1.new.swagger
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head

data/CHANGELOG.md

@@ -1,4 +1,50 @@
 
+0.4.0 10/20/2020
+================
+
+Add an `IntrospectiveGrape.config.skip_object_reload = true` option.
+
+0.3.9 04/01/2019
+================
+
+Add a note to the README that pagination will have to be supported via alexey-klimuk's fork of grape-kaminari from years ago because the middleware support gems have stopped being maintained, and rubygems doesn't support targeting github branches when adding dependencies.
+
+gem 'grape-kaminari', :github => 'alexey-klimuk/grape-kaminari'
+
+Probably we'll just fork it if nobody else can be bothered.
+
+0.3.8 03/27/2019
+================
+
+Support the latest Grape.
+
+0.3.7 03/26/2019
+================
+
+Updated to support Grape ~> 1.2.0. Ruby 2.2 no longer supported.
+
+
+0.3.7 03/25/2019
+================
+
+Updated to support Grape <~ 1.1.0.
+
+0.3.6 03/23/2019
+================
+
+Updated to support Rails 5+.
+
+
+0.3.5 09/14/2018
+================
+
+Restrict IntrospectiveGrape to Rails <5.0 and Pundit <2.0. We aren't Rails 5 compat until either schema_plus is or we find an alternative. Pundit 2.0 very strangely makes 'authorize' a protected method and we haven't made time to investigate.
+
+The big update in 0.3 is that the PUT/POST actions used to reload the model on presentation (hooks elsewhere may leave a model that's been updated out of sync with the database, so the overhead seems to be necessary) without using the default_includes for eager loading, causing some N+1 problems that could be alleviated.
+
+The general strategy of passing the params of a nested endpoint to the root model and then reloading it and burrowing down to the leaf for presentation, while simpler to implement, was really not optimal and creates a lot of unnecessary overhead like that.
+
+
 0.2.9 04/06/2017
 ================
 

data/Gemfile

@@ -5,6 +5,8 @@ source 'https://rubygems.org'
 # development dependencies will be added by default to the :development group.
 gemspec
 
+gem 'grape-kaminari', :github => 'alexey-klimuk/grape-kaminari'
+
 gem 'coveralls', require: false
 
 # Declare any dependencies that are still in development here instead of in

data/README.md

@@ -40,6 +40,7 @@ can speak in their own idioms.
 In your Gemfile:
 
 ```
+gem 'grape-kaminari', :github => 'alexey-klimuk/grape-kaminari' # some middleware has fallen into deep disrepair
 gem 'introspective_grape'
 ```
 
@@ -48,6 +49,8 @@ And bundle install.
 
 ## Grape Configuration
 
+### Camelization
+
 IntrospectiveGrape's default behavior is to camelize all outputs and snake case all inputs. To camel case all your json output you'll need to use its formatter in your API:
 
 ```
@@ -60,6 +63,18 @@ You can disable this behavior by setting `IntrospectiveGrape.config.camelize_par
 
 To include this behavior in your test coverage you need to either access the API's params hash or you can format the response body to `JSON.parse(response.body).with_snake_keys` in a helper method with the `using CamelSnakeKeys` refinement.
 
+### Reloading an object after an update request
+
+By default the gem reloads the object instance before presenting the updated model, a lazy but
+effective workaround to updates that may not propagate in the working instance due to actions
+a user may take in hooks, or some updates to has_many :through associations. We want to put up
+APIs with haste rather than digging our way out of tricky minutae that can be handled later as
+technical debt.
+
+This behavior can be disabled by setting `IntrospectiveGrape.config.skip_object_reload = true`,
+when you have time for technical debt you can toggle it and work on fixing broken tests (you
+did take the time to write comprehensive test coverage, didn't you?).
+
 ## Authentication and authorization
 
 Authentication and authorization are presently enforced on every endpoint. If you have named the authentication helper method in Grape something other than "authenticate!" or "authorize!" you can set it with:

data/gemfiles/{Gemfile.rails.4.2.7.1 → Gemfile.rails.5.0.0}

@@ -2,10 +2,11 @@ source 'https://rubygems.org'
 
 gemspec :path => '../'
 
-gem 'rails', '4.2.7.1'
-gem 'grape', '< 0.17'
-gem 'grape-swagger', '< 0.12.0'
-gem 'nokogiri', '< 1.6.9'
+gem 'rails', '5.0.0'
+gem 'grape'
+gem 'grape-kaminari', :github => 'alexey-klimuk/grape-kaminari'
+gem 'grape-swagger'
+gem 'nokogiri'
 gem 'coveralls', require: false
 
 group :development,:test do

data/gemfiles/Gemfile.rails.5.0.1

@@ -4,6 +4,7 @@ gemspec :path => '../'
 
 gem 'rails', '5.0.1'
 gem 'grape'
+gem 'grape-kaminari', :github => 'alexey-klimuk/grape-kaminari'
 gem 'grape-swagger'
 gem 'nokogiri'
 gem 'coveralls', require: false

data/gemfiles/{Gemfile.rails.4.2.7.1.new.swagger → Gemfile.rails.5.1.0}

@@ -2,9 +2,11 @@ source 'https://rubygems.org'
 
 gemspec :path => '../'
 
-gem 'rails', '4.2.7.1'
-gem 'grape', '> 0.17'
-gem 'grape-swagger', '> 0.12.0'
+gem 'rails', '5.1.0'
+gem 'grape'
+gem 'grape-kaminari', :github => 'alexey-klimuk/grape-kaminari'
+gem 'grape-swagger'
+gem 'nokogiri'
 gem 'coveralls', require: false
 
 group :development,:test do

data/gemfiles/{Gemfile.rails.3.2.22 → Gemfile.rails.5.2.0}

@@ -2,10 +2,11 @@ source 'https://rubygems.org'
 
 gemspec :path => '../'
 
-gem 'rails', '3.2.22'
-gem 'grape', '< 0.17'
-gem 'grape-swagger', '< 0.12.0'
-gem 'nokogiri', '< 1.6.9'
+gem 'rails', '5.2.0'
+gem 'grape'
+gem 'grape-kaminari', :github => 'alexey-klimuk/grape-kaminari'
+gem 'grape-swagger'
+gem 'nokogiri'
 gem 'coveralls', require: false
 
 group :development,:test do

data/gemfiles/Gemfile.rails.master

@@ -4,6 +4,7 @@ gemspec :path => '../'
 
 gem 'rails'
 gem 'grape'
+gem 'grape-kaminari', :github => 'alexey-klimuk/grape-kaminari'
 gem 'grape-swagger'
 gem 'nokogiri'
 gem 'coveralls', require: false

data/introspective_grape.gemspec

@@ -18,23 +18,25 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split("\n").sort
   s.test_files    = `git ls-files -- spec/*`.split("\n")
 
-  s.required_ruby_version = '~> 2.0'
-
-  s.add_dependency "rails", '>= 3.0.0'
-
-  s.add_dependency 'grape'          #, '~> 0.16.2'
-  s.add_dependency 'grape-entity'   #, '< 0.5.0'
-  s.add_dependency 'grape-swagger'  #, '~>0.11.0'
-  s.add_dependency 'kaminari', '< 1.0' # There's a version 1.0.0 out there that breaks everything
-  s.add_dependency 'grape-kaminari'
-  s.add_dependency 'pundit'
+  s.required_ruby_version = '>= 2.3'
+
+  s.add_dependency "rails", '> 5.0.0'
+
+  # grape 1.0.0 breaks the pagination solution
+  s.add_dependency 'grape', ['~> 1.2.0', '< 1.2.5']
+  s.add_dependency 'grape-entity'
+  s.add_dependency 'grape-swagger'
+  s.add_dependency 'kaminari' #, '< 1.0' # version 1.0.0 breaks
+  #s.add_dependency 'grape-kaminari', :github => 'alexey-klimuk/grape-kaminari'
+  # Pundit 2.0 mysteriously made authorize a protected method...
+  s.add_dependency 'pundit' #, '<2.0'
   s.add_dependency 'camel_snake_keys', '>0.0.4'
 
   if RUBY_PLATFORM == 'java'
     #s.add_development_dependency "jdbc-sqlite3"
     s.add_development_dependency "activerecord-jdbcsqlite3-adapter"
   else
-    s.add_development_dependency "sqlite3"
+    s.add_development_dependency "sqlite3", '<1.4.0' #'< 1.3.14'
   end
 
   #s.add_development_dependency "byebug"
@@ -42,8 +44,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rspec-rails", '>= 3.0'
   s.add_development_dependency 'devise'
   #s.add_development_dependency 'devise-async'
-  s.add_development_dependency 'paperclip', '< 5.0'
-  s.add_development_dependency 'machinist'
+  s.add_development_dependency 'paperclip', ">= 5.2.0" #'< 5.0'
+  s.add_development_dependency 'machinist_redux'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'rufus-mnemo'
 

data/lib/introspective_grape.rb

@@ -13,6 +13,6 @@ module IntrospectiveGrape
   end
 
   def self.config
-    @config = OpenStruct.new(camelize_parameters: true)
+    @config = OpenStruct.new(camelize_parameters: true, skip_object_reload: false)
   end
 end

data/lib/introspective_grape/api.rb

@@ -1,4 +1,5 @@
 require 'action_controller'
+require 'kaminari'
 require 'grape-kaminari'
 require 'introspective_grape/validators'
 
@@ -6,7 +7,7 @@ class IntrospectiveGrapeError < StandardError
 end
 
 module IntrospectiveGrape
-  class API < Grape::API
+  class API < Grape::API::Instance
     extend IntrospectiveGrape::Helpers
     extend IntrospectiveGrape::CreateHelpers
     extend IntrospectiveGrape::Filters
@@ -125,6 +126,34 @@ module IntrospectiveGrape
         end
       end
 
+      def convert_nested_params_hash(dsl, routes)
+        root  = routes.first
+        klass = root.klass
+        dsl.after_validation do
+          # After Grape validates its parameters:
+          # 1) Find the root model instance for the API if its passed (implicitly either
+          #    an update/destroy on the root node or it's a nested route
+          # 2) For nested endpoints convert the params hash into Rails-compliant nested
+          #    attributes, to be passed to the root instance for update. This keeps
+          #    behavior consistent between bulk and single record updates.
+
+          if params[root.key]
+            @model = root.model.includes( klass.default_includes(root.model) ).find(params[root.key])
+          end
+
+          if routes.size > 1
+            nested_attributes = klass.build_nested_attributes(routes[1..-1], params.except(root.key,:api_key) )
+            @params.merge!( nested_attributes ) if nested_attributes.kind_of?(Hash)
+          end
+        end
+      end
+
+      def define_restful_api(dsl, routes, model, api_params)
+        # declare index, show, update, create, and destroy methods:
+        API_ACTIONS.each do |action|
+          send("define_#{action}", dsl, routes, model, api_params) unless exclude_actions(model).include?(action)
+        end
+      end
 
       def define_endpoints(routes,api_params)
         # De-reference these as local variables from their class scope, or when we make
@@ -145,13 +174,6 @@ module IntrospectiveGrape
         end
       end
 
-      def define_restful_api(dsl, routes, model, api_params)
-        # declare index, show, update, create, and destroy methods:
-        API_ACTIONS.each do |action|
-          send("define_#{action}", dsl, routes, model, api_params) unless exclude_actions(model).include?(action)
-        end
-      end
-
       def define_index(dsl, routes, model, api_params)
         include Grape::Kaminari
         root  = routes.first
@@ -225,8 +247,15 @@ module IntrospectiveGrape
           authorize @model, :update?
 
           @model.update_attributes!( safe_params(params).permit(klass.whitelist) )
+         
+          default_includes = routes.first.klass.default_includes(routes.first.model)
 
-          present klass.find_leaf(routes, @model.reload, params), with: "#{klass}::#{model}Entity".constantize
+          if IntrospectiveGrape.config.skip_object_reload
+            present klass.find_leaf(routes, @model, params), with: "#{klass}::#{model}Entity".constantize
+          else
+            default_includes = routes.first.klass.default_includes(routes.first.model)
+            present klass.find_leaf(routes, @model.class.includes(default_includes).find(@model.id), params), with: "#{klass}::#{model}Entity".constantize
+          end
         end
       end
 
@@ -242,28 +271,6 @@ module IntrospectiveGrape
         end
       end
 
-      def convert_nested_params_hash(dsl, routes)
-        root  = routes.first
-        klass = root.klass
-        dsl.after_validation do
-          # After Grape validates its parameters:
-          # 1) Find the root model instance for the API if its passed (implicitly either
-          #    an update/destroy on the root node or it's a nested route
-          # 2) For nested endpoints convert the params hash into Rails-compliant nested
-          #    attributes, to be passed to the root instance for update. This keeps
-          #    behavior consistent between bulk and single record updates.
-          if params[root.key]
-            default_includes = routes.size > 1 ? [] : klass.default_includes(root.model)
-            @model = root.model.includes( default_includes ).find(params[root.key])
-          end
-
-          if routes.size > 1
-            nested_attributes = klass.build_nested_attributes(routes[1..-1], params.except(root.key,:api_key) )
-            @params.merge!( nested_attributes ) if nested_attributes.kind_of?(Hash)
-          end
-        end
-      end
-
 
       def build_routes(routes, model, reflection_name=nil)
         routes = routes.clone

data/lib/introspective_grape/camel_snake.rb

@@ -5,49 +5,48 @@ require 'active_support/inflector/methods'
 if IntrospectiveGrape.config.camelize_parameters
   # Camelize the parameters in the swagger documentation.
   if Gem::Version.new( GrapeSwagger::VERSION ) <= Gem::Version.new('0.11.0')
-    Grape::API.class_eval do
-      class << self
-        private
-        def create_documentation_class_with_camelized
-          doc = create_documentation_class_without_camelized
-          doc.class_eval do
-            class << self
-              def parse_params_with_camelized(params, path, method, _options = {})
-                parsed_params = parse_params_without_camelized(params, path, method)
-                parsed_params.each_with_index do |param|
-                  param[:name] = param[:name]
-                                 .camelize(:lower)
-                                 .gsub(/Destroy/,'_destroy')
-                end
-                parsed_params
-              end
+    module ParseParamsWithCamelized
+      def parse_params(params, path, method, _options = {})
+        parsed_params = parse_params_without_camelized(params, path, method)
+        parsed_params.each_with_index do |param|
+          param[:name] = param[:name]
+            .camelize(:lower)
+            .gsub(/Destroy/,'_destroy')
+        end
+        super(params, path, method, _options = {})
+      end
+    end
 
-              alias_method_chain :parse_params, :camelized
-            end
-          end
-          doc
+    module CreateCamelizedDocumentationClass
+      private
+      def create_documentation_class
+        doc = super
+        doc.class_eval do
+          doc.singleton_class.send(:prepend, ParseParamsWithCamelized)
         end
-        alias_method_chain :create_documentation_class, :camelized
+        doc
       end
     end
+
+    Grape::API::Instance.singleton_class.send(:prepend, CreateCamelizedDocumentationClass)
   else
+    module CallWithCamelized
+      def call(*args)
+        param = super(*args)
+        param[:name] = param[:name].camelize(:lower).gsub(/Destroy/, '_destroy')
+        param
+      end
+    end
+
+    GrapeSwagger::DocMethods::ParseParams.singleton_class.send(:prepend, CallWithCamelized)
     module GrapeSwagger
       module DocMethods
         def self.extended(mod)
           # Do not camelize the grape-swagger documentation endpoints.
           mod.formatter :json, Grape::Formatter::Json
         end
-        class ParseParams
-          class << self
-            def call_with_camelized(*args)
-              param = call_without_camelized(*args)
-              param[:name] = param[:name].camelize(:lower).gsub(/Destroy/, '_destroy')
-              param
-            end
-            alias_method_chain :call, :camelized
-          end
-        end
       end
     end
   end
+
 end