introspective_grape 0.0.4 → 0.1.9

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/.travis.yml

@@ -1,14 +1,16 @@
 language: ruby
+before_install:
+  - gem install bundler
 install: bundle install --jobs=1 --retry=1
 script:
   - bundle install
   - bundle exec rspec
 
 rvm:
+  - 2.3.0
   - 2.2
   - 2.1
   - 2.0.0
-  - rbx-2.5.8
   - jruby-9.0.4.0
   - ruby-head
   - jruby-head
@@ -22,7 +24,7 @@ env:
   matrix:
     - RAILS=3.2.22
     - RAILS=4.1.13
-    - RAILS=4.2.4
+    - RAILS=4.2.5.1
     - RAILS=master
   global:
     - JRUBY_OPTS="-J-Xmx1024m --debug"

data/CHANGELOG.md

@@ -0,0 +1,58 @@
+
+0.1.9 9/27/2016
+==============
+### Features
+
+Allow identifier filters for foreign and primary keys to accept comma separated lists.
+
+0.1.8 9/25/2016
+==============
+
+### Features
+
+Add date range filters for the index page.
+
+0.1.6 9/10/2016
+==============
+
+### Bug Fix
+
+The before hook snake casing parameters in the API was preventing the assignment of default values, this was moved to an after_validation hook.
+
+### Features
+
+Grape::Kaminari pagination was added to the index actions if configured in the parent class.
+
+0.1.5 6/26/2016
+==============
+
+### Bug Fix
+
+Reload the model from the database before presenting it to the user after create/update, as
+some deeply nested association changes will not be properly loaded by active record.
+
+0.1.4 5/11/2016
+==============
+
+### Features
+
+Added an include_actions declaration as the inverse of exclude_actions.
+
+0.1.1 5/11/2016
+==============
+
+### Features
+
+Stop monkey patching Grape's json formatter and instead use Grape's "formatter" 
+with our own CamelJson module.
+
+0.1.0 5/8/2016
+==============
+
+### Features
+
+Add simple filter for index endpoints.
+
+### Fixes
+
+Refactor API generation to reduce the code complexity.

data/Gemfile

@@ -5,11 +5,13 @@ source 'https://rubygems.org'
 # development dependencies will be added by default to the :development group.
 gemspec
 
+gem 'coveralls', require: false
+
 # Declare any dependencies that are still in development here instead of in
 # your gemspec. These might include edge Rails or gems from your path or
 # Git. Remember to move these dependencies to your gemspec before releasing
 # your gem to rubygems.org.
 
-# To use a debugger
-# gem 'byebug', group: [:development, :test]
-
+group :development do
+#  gem 'byebug'
+end

data/README.md

@@ -18,20 +18,22 @@
 
 
 IntrospectiveGrape is a Rails Plugin for DRYing up Grape APIs by laying out simple
-defaults and including deeply nested relations according to the models'
-accepts_nested_attributes_for :relation declarations. 
+RESTful defaults based on the model definitions. If you use a schema validator
+like [SchemaPlus](https://github.com/SchemaPlus/schema_plus) it will, by
+extension, define your endpoints according to your database schema.
 
-IntrospectiveGrape supports file uploads via Paperclip and hypothetically supports CarrierWave.
+It provides handling for deeply nested relations according to the models'
+`accepts_nested_attributes_for` declarations, generating all the necessary
+boilerplate for flexible and consistent bulk endpoints on plural associations,
+and building nested routes for the same.
 
-Presently it is tightly coupled with two behaviors that I like but should be abstracted out:
+It also snake cases everything coming in and camelizes parameters in your swagger docs
+by default if you `require 'introspective_grape/camel_snake'` in your API.
+This behavior can be disabled.
 
-1. It is dependent on Pundit for authorization and permissions.
-
-2. Parameters in the front end of the API will be accepted in camel case and passed to the backend in snake case, following javascript conventions on the one and rails conventions in the other.
-
-Libraries for Grape and Swagger docs are rather invasively duck typed to support this behavior. It modifies Grape's JSON Formatter module and Grape Swagger's documentation classes to camelize parameter keys, and then converts the keys back to snake case for handling in the API.
-
-To include this behavior in your test coverage you need to either access the API's params hash or you can `include IntrospectiveGrape::CamelSnake` in your test helper and `snake_keys(JSON.parse(response.body))` to format the params in a helper method.
+In addition it provides a `IntrospectiveGrape::Formatter::CamelJson` json formatter to
+recursively camelize the keys of all your outputs, so ruby and javascript developers
+can speak in their own idioms.
 
 ## Documentation
 
@@ -41,16 +43,49 @@ In your Gemfile:
 gem 'introspective_grape'
 ```
 
-And bundle install.  In app/api/v1/my_model_api.rb:
+And bundle install.
+
+
+## Grape Configuration
+
+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:
+
+```
+formatter :json, IntrospectiveGrape::Formatter::CamelJson
+```
+
+It also defaults to monkey patching Grape::Swagger to camelize the API's parameters in the swagger docs and, vice-versa, snake casing the parameters that are sent to your API.
+
+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.
+
+## 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:
+
+```
+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).
+
+
+## Generate End Points for Models
+
+In app/api/v1/my_model_api.rb:
 
 ```
 class MyModelAPI < IntrospectiveGrape::API
+  skip_presence_validations :attribute
   exclude_actions Model, <:index,:show,:create,:update,:destroy>
   default_includes Model, <associations for eager loading>
 
-  exclude_actions NestedModel, <:index,:show,:create,:update,:destroy>
+  include_actions NestedModel, <:index,:show,:create,:update,:destroy>
   default_includes NestedModel, <associations for eager loading>
 
+  paginate per_page 25, offset: 0, max_per_page: false
+
   restful MyModel, [:strong, :param, :fields, :and, { nested_attributes: [:nested,:fields, :_destroy] }] do
     # Add additional end points to the model's namespace
   end
@@ -66,10 +101,10 @@ class MyModelAPI < IntrospectiveGrape::API
 end
 ```
 
-A Pundit policy will need to be defined for :index?,:show?,:update?,:create?, and
-:destroy? as well as a policy scope for the index action. IntrospectiveGrape
-automatically enforces Pundit's authorize! before all actions.
- 
+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.
+
 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
 types for the attributes specified in a hash, e.g.:
@@ -85,6 +120,24 @@ 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.
 
+## 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.
+
+## 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 on the model. You can also include or exclude :all or :none as shorthand.
+
+## Grape Hooks
+
+Grape only applies hooks in the order they were declared, so to hook into the default
+RESTful actions defined by IntrospectiveGrape you need to declare any hooks before the
+`restful` declaration, rather than inside its block, where the hook will only apply to
+subsequently declared endpoints.
+
 
 ## Dependencies
 

data/introspective_grape.gemspec

@@ -20,13 +20,14 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '~> 2.0'
 
-  s.add_dependency "rails"
-  s.add_dependency "activerecord"
+  s.add_dependency "rails", '>= 3.0.0', '< 5.0.0'
 
-  s.add_dependency 'grape'
-  s.add_dependency 'grape-entity'
-  s.add_dependency 'grape-swagger', '~> 0.10.4'
+  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 'grape-kaminari', '~>0.1.9'
   s.add_dependency 'pundit'
+  s.add_dependency 'camel_snake_keys', '~>0.0.2'
 
   if RUBY_PLATFORM == 'java'
     #s.add_development_dependency "jdbc-sqlite3"
@@ -35,15 +36,14 @@ Gem::Specification.new do |s|
     s.add_development_dependency "sqlite3"
   end
 
+  #s.add_development_dependency "byebug"
   s.add_development_dependency "rspec-rails", '>= 3.0'
   s.add_development_dependency 'devise'
   s.add_development_dependency 'devise-async'
-  s.add_development_dependency 'paperclip'
+  s.add_development_dependency 'paperclip', '< 5.0'
   s.add_development_dependency 'machinist'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'rufus-mnemo'
-  #s.add_development_dependency "schema_plus", "2.0.0.pre12" # For compatibility of schema_validations with AR 4.2.1+
-  #s.add_development_dependency "schema_validations"
   s.add_development_dependency "activerecord-tableless", "~> 1.0"
 
 end