introspective_grape 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57d3bb5f544d03ed3ac7db371114203c93d9b2a8
-  data.tar.gz: 919fa9c7f054138822c4344ece5c7e22c332725c
+  metadata.gz: de6a41c1400168ecda38b06734cdd3678071328a
+  data.tar.gz: ce20e1fc247df07463068dade8bc7e6ccfeb4e7c
 SHA512:
-  metadata.gz: 8066cb3b5cb96688504e947c0d3e283a328a319604dc26c8ae437b53e9181ea9e73e24a9226d4a8c0ed7e3acb8234943fd9a3b41c4f9f66d1e7cd02579c7fa00
-  data.tar.gz: 5e00569a882143326e36dc1dd1e2794fa520dc47280a888200476dedf4b4d2428b8b6891cd5381dbc6cdc1e0ac596feb453f4116e37475c780e2a18ac6ada5eb
+  metadata.gz: 6cd190fef2c67c05f7e6f472458686d347f1e70d64960f3909439203b032627e899ecdce9966a81046e08eb164007b91cf13a35b62555cf144c43e3d3b9f2c0e
+  data.tar.gz: 256ae7c47d140a34431bdb400b24ae703d25a48ded09e8639c54a4ca5cacf7f3f5ea50602226b8bb2510f15013df90763a9d56e141f9fcef1683d944b30e99be

data/.rubocop.yml

@@ -23,7 +23,7 @@ Lint/AssignmentInCondition:
   Enabled: true
   Exclude:
     - 'bin/spring'
-    
+
 Lint/BlockAlignment:
   Description: 'Align block ends correctly.'
   Enabled: true

data/.travis.yml

@@ -12,11 +12,12 @@ rvm:
   - 2.2.0
   - 2.2.6
   - 2.3.0
+  - 2.4.0
   - ruby-head
   - jruby-head
 gemfile:
-#  - gemfiles/Gemfile.rails.3.2.22 
-  #- gemfiles/Gemfile.rails.4.1.13 
+#  - 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
@@ -50,6 +51,10 @@ matrix:
       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
@@ -58,6 +63,14 @@ matrix:
       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
@@ -67,7 +80,7 @@ env:
     - JRUBY_OPTS="-J-Xmx1024m --debug"
 
 notifications:
-  email: 
+  email:
     recipients:
     - buermann@gmail.com
     on_success: change

data/CHANGELOG.md

@@ -1,17 +1,25 @@
 
+0.2.9 04/06/2017
+================
+
+Update to camel_snake_json >=0.0.5, which switches from monkey patching everything that includes Enumerable to using refinements, like a good neighbor. Use the class methods instead so we can continue to ostensibly support JRuby, like a good neighbor.
+
+Simplify the logic in the CamelJson formatter for determining whether to parse the json representation of the object before camelizing it.
+
+
 0.2.8 01/22/2017
-==============
+================
 
 Nested endpoints for creating new associations will now return only the newly created records.
 
 0.2.7 01/18/2017
-==============
+================
 
 Add support for Swagger 2+, we can now support the latest versions of grape and other dependencies.
 
 
 0.2.6 11/01/2016
-==============
+================
 
 Change the Model.attribute_param_types class method lookup (for specifying custom param types attributes on a model) to "grape_param_types" to make it clearer that the method is used in the API.
 
@@ -23,14 +31,14 @@ Add custom validators to verify that JSON strings parse as a JSON object, an arr
 
 
 0.2.5 10/28/2016
-==============
+================
 
 ### Bug Fix
 
 Include the nested model IDs in the swagger doc.
 
 0.2.4 10/26/2016
-==============
+================
 
 ### Bug Fix
 
@@ -85,11 +93,11 @@ class MyModel
     def my_filter(filter=false)
       filter ? my_scope : where(nil)
     end
-    
+
     def my_field=(parameters)
       # parse the passed parameters in some fancy way and return a query scope
     end
-  end 
+  end
 end
 
 0.1.9 9/27/2016
@@ -136,7 +144,7 @@ Added an include_actions declaration as the inverse of exclude_actions.
 
 ### Features
 
-Stop monkey patching Grape's json formatter and instead use Grape's "formatter" 
+Stop monkey patching Grape's json formatter and instead use Grape's "formatter"
 with our own CamelJson module.
 
 0.1.0 5/8/2016

data/README.md

@@ -58,7 +58,7 @@ It also defaults to monkey patching Grape::Swagger to camelize the API's paramet
 
 You can disable this behavior by setting `IntrospectiveGrape.config.camelize_parameters = false`.
 
-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.
+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.
 
 ## Authentication and authorization
 
@@ -131,7 +131,7 @@ class MyModelAPI < IntrospectiveGrape::API
   restful MyModel, [:strong, :param, :fields, :and, { nested_model_attributes: [:nested,:fields, :_destroy] }] do
     # Add additional end points to the model's namespace
   end
- 
+
   class <NestedModel>Entity < Grape::Entity
     expose :id, :attribute
   end
@@ -170,7 +170,7 @@ The index action by default will not be paginated, simply declared `paginate` be
 To define a Grape param type for a virtual attribute or override the defaut param
 type from database introspection, define a class method in the model with the param
 types for the attributes specified in a hash, e.g.:
- 
+
 ```
    def self.grape_param_types
     { "<attribute name 1>" => String,
@@ -185,8 +185,8 @@ class method ("grape_validations") that will be applied to that field's param de
 ```
   def self.grape_validations
     { field1: { values: %w(red blue green) },
-      field2: { json_array: true }, 
-      field3: { regexp: /\w+/ } 
+      field2: { json_array: true },
+      field3: { regexp: /\w+/ }
   end
 ```
 
@@ -196,7 +196,7 @@ IntrospectiveGrape provides the following custom grape validators for JSON strin
 
 ```
 json: true       # validates that the JSON string parses
-json_array: true # validates that the JSON string parses and returns an Array 
+json_array: true # validates that the JSON string parses and returns an Array
 json_hash: true  # validates that the JSON string parses and returns a Hash
 ```
 

data/gemfiles/2.0.0-Gemfile

@@ -17,6 +17,6 @@ gem 'coveralls', require: false
 # your gem to rubygems.org.
 
 group :development,:test do
-  gem 'rspec' 
+  gem 'rspec'
 #  gem 'byebug'
 end

data/gemfiles/Gemfile.rails.3.2.22

@@ -9,5 +9,5 @@ gem 'nokogiri', '< 1.6.9'
 gem 'coveralls', require: false
 
 group :development,:test do
-  gem 'rspec' 
+  gem 'rspec'
 end

data/gemfiles/Gemfile.rails.4.1.13

@@ -9,5 +9,5 @@ gem 'nokogiri', '< 1.6.9'
 gem 'coveralls', require: false
 
 group :development,:test do
-  gem 'rspec' 
+  gem 'rspec'
 end

data/gemfiles/Gemfile.rails.4.2.7.1

@@ -9,5 +9,5 @@ gem 'nokogiri', '< 1.6.9'
 gem 'coveralls', require: false
 
 group :development,:test do
-  gem 'rspec' 
+  gem 'rspec'
 end

data/gemfiles/Gemfile.rails.4.2.7.1.new.swagger

@@ -8,5 +8,5 @@ gem 'grape-swagger', '> 0.12.0'
 gem 'coveralls', require: false
 
 group :development,:test do
-  gem 'rspec' 
+  gem 'rspec'
 end

data/gemfiles/Gemfile.rails.4.2.8

@@ -8,5 +8,5 @@ gem 'grape-swagger', '> 0.12.0'
 gem 'coveralls', require: false
 
 group :development,:test do
-  gem 'rspec' 
+  gem 'rspec'
 end

data/gemfiles/Gemfile.rails.5.0.1

@@ -9,5 +9,5 @@ gem 'nokogiri'
 gem 'coveralls', require: false
 
 group :development,:test do
-  gem 'rspec' 
+  gem 'rspec'
 end

data/gemfiles/Gemfile.rails.master

@@ -9,5 +9,5 @@ gem 'nokogiri'
 gem 'coveralls', require: false
 
 group :development,:test do
-  gem 'rspec' 
+  gem 'rspec'
 end

data/introspective_grape.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '~> 2.0'
 
-  s.add_dependency "rails", '>= 3.0.0' 
+  s.add_dependency "rails", '>= 3.0.0'
 
   s.add_dependency 'grape'          #, '~> 0.16.2'
   s.add_dependency 'grape-entity'   #, '< 0.5.0'
@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
   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.add_dependency 'camel_snake_keys'
+  s.add_dependency 'camel_snake_keys', '>0.0.4'
 
   if RUBY_PLATFORM == 'java'
     #s.add_development_dependency "jdbc-sqlite3"

data/lib/introspective_grape/api.rb

@@ -76,7 +76,7 @@ module IntrospectiveGrape
         # model: the model class for the API
         # whitelist: a list of fields in Rail's strong params structure, also used to
         #            generate grape's permitted params.
-        # routes: An array of OpenStruct representations of a nested route's ancestors 
+        # routes: An array of OpenStruct representations of a nested route's ancestors
         #
 
         # Defining the api will break pending migrations during db:migrate, so bail:
@@ -91,7 +91,7 @@ module IntrospectiveGrape
         # when routes are nested
         whitelist = whitelist( strong_params )
 
-        # As routes are nested keep track of the routes, we are preventing siblings from 
+        # As routes are nested keep track of the routes, we are preventing siblings from
         # appending to the routes array here:
         routes = build_routes(routes, model)
         define_routes(routes, whitelist)
@@ -99,7 +99,7 @@ module IntrospectiveGrape
         # Top level declaration of the Grape::API namespace for the resource:
         resource routes.first.name.pluralize do
           # yield to append additional routes under the root namespace
-          yield if block_given? 
+          yield if block_given?
         end
       end
 
@@ -114,7 +114,7 @@ module IntrospectiveGrape
             # Look at model.reflections to find the association's class name:
             reflection_name = r.to_s.sub(/_attributes$/,'')
             begin
-              relation = model.reflections[reflection_name].class_name.constantize 
+              relation = model.reflections[reflection_name].class_name.constantize
             rescue
               Rails.logger.fatal "Can't find associated model for #{r} on #{model}"
             end
@@ -145,7 +145,7 @@ module IntrospectiveGrape
         end
       end
 
-      def define_restful_api(dsl, routes, model, api_params) 
+      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)
@@ -270,7 +270,7 @@ module IntrospectiveGrape
         # routes: the existing routes array passed from the parent
         # model:  the model being manipulated in this leaf
         # reflection_name: the association name from the original strong_params declaration
-        # 
+        #
         # Constructs an array representation of the route's models and their associations,
         # a /root/:rootId/branch/:branchId/leaf/:leafId path would have flat array like
         # [root,branch,leaf] representing the path structure and its models, used to
@@ -287,7 +287,7 @@ module IntrospectiveGrape
       end
 
 
-      def build_nested_attributes(routes,hash) 
+      def build_nested_attributes(routes,hash)
         # Recursively re-express the flat attributes hash from nested routes as nested
         # attributes that can be used to perform an update on the root model.
 
@@ -299,12 +299,12 @@ module IntrospectiveGrape
         id      = hash.delete route.key
         attributes = id ? { id: id } : {}
 
-        attributes.merge!( hash ) if routes.blank? # assign param values to the last reference 
+        attributes.merge!( hash ) if routes.blank? # assign param values to the last reference
 
         if route.many? # nest it in an array if it is a has_many association
-          { route.param => [attributes.merge( build_nested_attributes(routes, hash) )] } 
-        else 
-          { route.param => attributes.merge( build_nested_attributes(routes, hash) ) } 
+          { route.param => [attributes.merge( build_nested_attributes(routes, hash) )] }
+        else
+          { route.param => attributes.merge( build_nested_attributes(routes, hash) ) }
         end
       end
 
@@ -354,7 +354,7 @@ module IntrospectiveGrape
             # Handle Carrierwave file upload fields
             s = [:filename, :type, :name, :tempfile, :head]-v
             if s.present?
-              Rails.logger.warn "Missing required file upload parameters #{s} for uploader field #{r}" 
+              Rails.logger.warn "Missing required file upload parameters #{s} for uploader field #{r}"
             end
           elsif PLURAL_REFLECTIONS.include?( model.reflections[reflection].class )
             # In case you need a refresher on how these work:
@@ -377,8 +377,8 @@ module IntrospectiveGrape
       end
 
       def is_file_attachment?(model,field)
-        model.try(:uploaders) && model.uploaders[field.to_sym] || # carrierwave
-          (model.try(:attachment_definitions) && model.attachment_definitions[field.to_sym]) ||
+        model.respond_to?(:uploaders) && model.uploaders[field.to_sym] || # carrierwave
+          (model.respond_to?(:attachment_definitions) && model.attachment_definitions[field.to_sym]) ||
           defined?(Paperclip::Attachment) && model.send(:new).try(field).kind_of?(Paperclip::Attachment)
       end
 
@@ -389,8 +389,8 @@ module IntrospectiveGrape
 
         # Check if it's a file attachment, look for an override class from the model,
         # check Pg2Ruby, use the database type, or fail over to a String:
-        ( is_file_attachment?(model,f) && Rack::Multipart::UploadedFile ) || 
-          (model.try(:grape_param_types)||{}).with_indifferent_access[f]  || 
+        ( is_file_attachment?(model,f) && Rack::Multipart::UploadedFile ) ||
+          (model.try(:grape_param_types)||{}).with_indifferent_access[f]  ||
           Pg2Ruby[db_type]                                                ||
           begin db_type.to_s.camelize.constantize rescue nil end          ||
           String

data/lib/introspective_grape/camel_snake.rb

@@ -1,10 +1,11 @@
 require 'grape-swagger'
-require 'active_support' #/core_ext/module/aliasing'
-require 'camel_snake_keys'
-if IntrospectiveGrape.config.camelize_parameters 
+require 'active_support/core_ext/module/aliasing'
+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 
+    Grape::API.class_eval do
       class << self
         private
         def create_documentation_class_with_camelized

data/lib/introspective_grape/filters.rb

@@ -29,7 +29,7 @@ module IntrospectiveGrape::Filters
   end
 
   def simple_filters(klass, model, api_params)
-    @simple_filters ||= api_params.select {|p| p.is_a? Symbol }.select {|field| 
+    @simple_filters ||= api_params.select {|p| p.is_a? Symbol }.select {|field|
       filters.include?(:all) || filters.include?(field)
     }.map { |field|
       (klass.param_type(model,field) == DateTime ? ["#{field}_start", "#{field}_end"] : field.to_s)
@@ -58,7 +58,7 @@ module IntrospectiveGrape::Filters
     # timestamp, a Start and an End, to apply a date range.
     simple_filters(klass, model, api_params).each do |field|
       if timestamp_filter(klass,model,field)
-        terminal = field.ends_with?("_start") ? "initial" : "terminal" 
+        terminal = field.ends_with?("_start") ? "initial" : "terminal"
         dsl.optional field, type: klass.param_type(model,field), description: "Constrain #{field} by #{terminal} date."
       elsif identifier_filter(klass,model,field)
         dsl.optional field, type: Array[Integer], coerce_with: ->(val) { val.split(',') }, description: "Filter by a comma separated list of integers."

data/lib/introspective_grape/formatter/camel_json.rb

@@ -4,17 +4,20 @@ require 'grape/formatter/json'
 module IntrospectiveGrape
   module Formatter
     module CamelJson
-      def self.call(object, _env)
-        if object.respond_to?(:to_json) && !object.respond_to?(:with_camel_keys) &&
-          (parsed_object = JSON.parse(object.to_json)).respond_to?(:with_camel_keys)
-          object = parsed_object
-				elsif object.kind_of?(Array) && object.first.kind_of?(Grape::Entity)
-        	# Force arrays of Grape::Entities into their hash representations before camelizing
-        	object = JSON.parse(object.to_json) 
+      class << self
+        def transform_to_camel_keys(object)
+          # We only need to parse(object.to_json) like this if it isn't already
+          # a native hash (or array of them), i.e. we have to parse Grape::Entities
+          # and other formatter facades:
+          unless (object.is_a?(Array) && object.first.is_a?(Hash)) || object.is_a?(Hash)
+            object = JSON.parse(object.to_json) if object.respond_to?(:to_json)
+          end
+          CamelSnakeKeys.camel_keys(object)
         end
-        object = object.with_camel_keys if object.respond_to?(:with_camel_keys)
 
-        Grape::Formatter::Json.call(object, _env)
+        def call(object, env)
+          Grape::Formatter::Json.call(transform_to_camel_keys(object), env)
+        end
       end
     end
   end

data/lib/introspective_grape/helpers.rb

@@ -7,7 +7,7 @@ module IntrospectiveGrape::Helpers
 
   def authentication_method(context)
     # Default to "authenticate!" or as grape docs once suggested, "authorize!"
-    if @authentication_method 
+    if @authentication_method
       @authentication_method
     elsif context.respond_to?('authenticate!')
       'authenticate!'
@@ -27,7 +27,7 @@ module IntrospectiveGrape::Helpers
   def exclude_actions(model, *args)
     @exclude_actions ||= {}; @exclude_actions[model.name] ||= []
     args.flatten!
-    args = API_ACTIONS if args.include?(:all) 
+    args = API_ACTIONS if args.include?(:all)
     args = []          if args.include?(:none)
 
     undefined_actions = args.compact-API_ACTIONS
@@ -46,7 +46,7 @@ module IntrospectiveGrape::Helpers
     @default_includes ||= {}
     @default_includes[model.name] = args.present? ? args.flatten : @default_includes[model.name] || []
   end
-  
+
   def whitelist(whitelist=nil)
     return @whitelist if !whitelist
     @whitelist = whitelist