introspective_grape 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 169097ef08e0a724df757dd60c0b47341999bd59
-  data.tar.gz: 6be10a74972810ca030c0a518893656b599369be
+  metadata.gz: 57d3bb5f544d03ed3ac7db371114203c93d9b2a8
+  data.tar.gz: 919fa9c7f054138822c4344ece5c7e22c332725c
 SHA512:
-  metadata.gz: 6cdc1e63fa9169dfbb90eb275f8dbeac342bdecab7bc324733b8194d47d720a4ffbc68693499a94652f865dd267817cdb769c8a663b09534a635c135321bbc10
-  data.tar.gz: c5be58cfc13ee4be45df0a349d6712b585cb9919f64a925c60b97d3a1a97cbceeaf6690f9faddd6572b82c76bf3f51b728cdb17af8e0ea94f257c335229ca4c2
+  metadata.gz: 8066cb3b5cb96688504e947c0d3e283a328a319604dc26c8ae437b53e9181ea9e73e24a9226d4a8c0ed7e3acb8234943fd9a3b41c4f9f66d1e7cd02579c7fa00
+  data.tar.gz: 5e00569a882143326e36dc1dd1e2794fa520dc47280a888200476dedf4b4d2428b8b6891cd5381dbc6cdc1e0ac596feb453f4116e37475c780e2a18ac6ada5eb

data/.travis.yml

@@ -10,8 +10,8 @@ rvm:
   - 2.0.0
   - 2.1.0
   - 2.2.0
-  - 2.3.0
   - 2.2.6
+  - 2.3.0
   - ruby-head
   - jruby-head
 gemfile:
@@ -19,6 +19,7 @@ gemfile:
   #- 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.master
 
@@ -27,24 +28,32 @@ matrix:
     # 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: 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
@@ -54,12 +63,6 @@ matrix:
     - rvm: jruby-head
 
 env:
-  #matrix:
-  #  - RAILS=3.2.22
-  #  - RAILS=4.1.13
-  #  - RAILS=4.2.5.1
-  #  - RAILS=5.0.1
-  #  - RAILS=master
   global:
     - JRUBY_OPTS="-J-Xmx1024m --debug"
 

data/Gemfile

@@ -14,4 +14,5 @@ gem 'coveralls', require: false
 
 group :development do
   gem 'byebug'
+  gem 'rb-readline'
 end

data/README.md

@@ -85,11 +85,39 @@ The joke goes that you may find you need to allow an unauthenticated user to att
 
 ## Generate End Points for Models
 
-In app/api/v1/my_model_api.rb:
+The simplest app/api/v1/my_model_api.rb with the broadest functionality would look like:
+
+```
+class MyModelAPI < IntrospectiveGrape::API
+  filter_on :all
+
+  restful MyModel, [:strong, :param, :fields, :and, { nested_model_attributes: [:nested,:fields, :_destroy] }]
+
+  class <NestedModel>Entity < Grape::Entity
+    expose :id, :attribute
+  end
+
+  class MyModelEntity < Grape::Entity
+    expose :id, :attribute1, :attribute2
+    expose :nested, using: <NestedModel>Entity>
+  end
+end
+```
+
+This would set up all the basic RESTFUL actions with nested routes for the associated model and its association, providing a good deal of flexibility for API consumers out of the box.
+
+IntrospectiveGrape looks in the MyModelAPI class for grape-entity definitions. If you prefer to define your entities elsewhere you could inherit them here instead.
+
+Note that nested entities must be defined before their parents.
+
+## Customizing End Points
+
+Many simple customizations are available to carve out from the default behaviors:
 
 ```
 class MyModelAPI < IntrospectiveGrape::API
   skip_presence_validations :attribute_with_generated_default_value
+
   exclude_actions Model, <:index,:show,:create,:update,:destroy>
   default_includes Model, <associations for eager loading>
 
@@ -98,27 +126,49 @@ class MyModelAPI < IntrospectiveGrape::API
 
   paginate per_page 25, offset: 0, max_per_page: false
 
+  filter_on :param
+
   restful MyModel, [:strong, :param, :fields, :and, { nested_model_attributes: [:nested,:fields, :_destroy] }] do
     # Add additional end points to the model's namespace
   end
  
-  class <MyModel>Entity < Grape::Entity
+  class <NestedModel>Entity < Grape::Entity
     expose :id, :attribute
-    expose :nested, using: <NestedModel>Entity>
   end
 
-  class <NestedModel>Entity < Grape::Entity
+  class <MyModel>Entity < Grape::Entity
     expose :id, :attribute
+    expose :nested, using: <NestedModel>Entity>
   end
 end
 ```
 
+
+## Skipping a Presence Validation for a Required Field
+
 If a model has, say, a procedurally generated default for a not-null field
 `skip_presence_validations` will make IntrospectiveGrape declare the parameter
 optional rather than required.
 
+## Excluding Endpoints
+
+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 in the API class. You can also include or exclude :all or :none as shorthand.
+
+## Eager Loading
+
+Declaring `default_includes` on an activerecord class will tell IntrospectiveGrape which associations to eager load when fetching a collection or instance.
+
+## Pagination
+
+The index action by default will not be paginated, simply declared `paginate` before the `restful` declaration will enable [Kaminari](https://github.com/amatsuda/kaminari) pagination on the index results using a default 25 results per page with an offset of 0. You can pass Kaminari's options to the paginate declaration, `per_page`, `max_per_page`, etc.
+
+## Validating Virtual Attributes and Overriding Grape Validations
+
 To define a Grape param type for a virtual attribute or override the defaut param
-type from model introspection, define a class method in the model with the 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.:
  
 ```
@@ -140,7 +190,9 @@ class method ("grape_validations") that will be applied to that field's param de
   end
 ```
 
-IntrospectiveGrape provides the following custom grape validators:
+## Validating JSON Parameters
+
+IntrospectiveGrape provides the following custom grape validators for JSON string parameters:
 
 ```
 json: true       # validates that the JSON string parses
@@ -148,11 +200,6 @@ 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
 ```
 
-For nested models declared in Rails' strong params both the Grape params for the
-nested params as well as nested routes will be declared, allowing for
-a good deal of flexibility for API consumers out of the box, such as implicitly
-creating bulk update endpoints for nested models.
-
 
 ## Filtering and Searching
 
@@ -215,18 +262,7 @@ end
 ## Documenting Endpoints
 
 If you wish to provide additional documentation for end points you can define
-`<action>_documentation` methods in the API class.
-
-## Pagination
-
-The index action by default will not be paginated, simply declared `paginate` before the `restful` declaration will enable [Kaminari](https://github.com/amatsuda/kaminari) pagination on the index results using a default 25 results per page with an offset of 0. You can pass Kaminari's options to the paginate declaration, `per_page`, `max_per_page`, etc.
-
-## Excluding Endpoints
-
-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 in the API class. You can also include or exclude :all or :none as shorthand.
+`self.<action>_documentation` class methods in the API class (or extend them from a module).
 
 ## Grape Hooks
 

data/gemfiles/Gemfile.rails.4.2.8

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec :path => '../'
+
+gem 'rails', '4.2.8'
+gem 'grape', '> 0.17'
+gem 'grape-swagger', '> 0.12.0'
+gem 'coveralls', require: false
+
+group :development,:test do
+  gem 'rspec' 
+end

data/introspective_grape.gemspec

@@ -38,6 +38,7 @@ Gem::Specification.new do |s|
   end
 
   #s.add_development_dependency "byebug"
+  #s.add_development_dependency "rb-readline"
   s.add_development_dependency "rspec-rails", '>= 3.0'
   s.add_development_dependency 'devise'
   #s.add_development_dependency 'devise-async'

data/lib/introspective_grape/formatter/camel_json.rb

@@ -8,10 +8,14 @@ module IntrospectiveGrape
         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) 
         end
         object = object.with_camel_keys if object.respond_to?(:with_camel_keys)
+
         Grape::Formatter::Json.call(object, _env)
       end
     end
   end
-end
+end

data/lib/introspective_grape/version.rb

@@ -1,3 +1,3 @@
 module IntrospectiveGrape
-  VERSION = "0.3.1".freeze
+  VERSION = "0.3.2".freeze
 end

data/spec/requests/location_api_spec.rb

@@ -10,6 +10,17 @@ describe Dummy::LocationAPI, type: :request do
     Location.make!(name: "TEST2", kind: "airport") 
   end
 
+
+  it "should return an array of camelized location entities" do
+    get '/api/v1/locations'
+    response.should be_success
+    j = JSON.parse(response.body)
+    j.each {|l| l.key?('childLocations').should be_truthy }
+    j.each {|l| l.key?('parentLocationId').should be_truthy }
+    j.each {|l| l.key?('updatedAt').should be_truthy }
+    j.each {|l| l.key?('createdAt').should be_truthy }
+  end
+
   it "should return a list of top level locations and their children" do
     get '/api/v1/locations'
     response.should be_success
@@ -20,6 +31,7 @@ describe Dummy::LocationAPI, type: :request do
     json.first['child_locations'].map{|l| l['id'].to_i}.sort.should == location.child_locations.map(&:id).sort
   end
 
+
   it "should generate basic filters on the whitelisted model attributes" do 
     get '/api/v1/locations', { name: "TEST" }
     response.should be_success

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: introspective_grape
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Josh Buermann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-27 00:00:00.000000000 Z
+date: 2017-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -252,6 +252,7 @@ files:
 - 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.master
 - introspective_grape.gemspec