introspective_grape 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 761abffe58bfde3182b6f5c645b6bc624b8a502a
+  data.tar.gz: 65def46d2cef2344127a76aeb3948036f6a1f588
+SHA512:
+  metadata.gz: 8ca4f68396021cb1f41f9d29e34cee999063c45a4051f24ce20d8a35adcf41c2a3a54cc6f0fa1d48140aa8900b49ea3794688ff00c6a571ead3c17d616acbcc1
+  data.tar.gz: 8ff42a11228aebac3c8d9f3835bef5cff2c5950cd9ab85f23919205b0295d1a3ebc75e6806c87aca14410a39f9294be70327f97b1eff1b3405959f362a4c883c

data/.gitignore

@@ -0,0 +1,10 @@
+.bundle/
+log/*.log
+Gemfile.lock
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/public/system/
+spec/dummy/.sass-cache

data/.travis.yml

@@ -0,0 +1,35 @@
+language: ruby
+install: bundle install --jobs=1 --retry=1
+script:
+  - bundle install
+  - bundle exec rspec
+
+rvm:
+  - 2.2
+  - 2.1
+  - 2.0.0
+  - rbx-2.5.8
+  - jruby-9.0.4.0
+  - ruby-head
+  - jruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+
+env:
+  matrix:
+    - RAILS=3.2.22
+    - RAILS=4.1.13
+    - RAILS=4.2.4
+    - RAILS=master
+  global:
+    - JRUBY_OPTS="-J-Xmx1024m --debug"
+
+notifications:
+  email: 
+    recipients:
+    - buermann@gmail.com
+    on_success: change
+    on_failure: always

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in introspective_grape.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# 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]
+

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 jbuermann
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,103 @@
+# IntrospectiveGrape
+
+[![Gem Version][GV img]][Gem Version]
+[![Build Status][BS img]][Build Status]
+[![Dependency Status][DS img]][Dependency Status]
+[![Coverage Status][CS img]][Coverage Status]
+
+[Gem Version]: https://rubygems.org/gems/introspective_grape
+[Build Status]: https://travis-ci.org/buermann/introspective_grape
+[travis pull requests]: https://travis-ci.org/buermann/introspective_grape/pull_requests
+[Dependency Status]: https://gemnasium.com/buermann/introspective_grape
+[Coverage Status]: https://coveralls.io/r/buermann/introspective_grape
+
+[GV img]: https://badge.fury.io/rb/introspective_grape.png
+[BS img]: https://travis-ci.org/buermann/introspective_grape.png
+[DS img]: https://gemnasium.com/buermann/introspective_grape.png
+[CS img]: https://coveralls.io/repos/buermann/introspective_grape/badge.png?branch=master
+
+
+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. 
+
+IntrospectiveGrape supports file uploads via Paperclip and hypothetically supports CarrierWave.
+
+Presently it is tightly coupled with two behaviors that I like but should be abstracted out:
+
+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.
+
+## Documentation
+
+In your Gemfile:
+
+```
+gem 'introspective_grape'
+```
+
+And bundle install.  In app/api/v1/my_model_api.rb:
+
+```
+class MyModelAPI < IntrospectiveGrape::API
+  exclude_actions Model, <:index,:show,:create,:update,:destroy>
+  default_includes Model, <associations for eager loading>
+
+  exclude_actions NestedModel, <:index,:show,:create,:update,:destroy>
+  default_includes NestedModel, <associations for eager loading>
+
+  restful MyModel, [:strong, :param, :fields, :and, { nested_attributes: [:nested,:fields, :_destroy] }] do
+    # Add additional end points to the model's namespace
+  end
+ 
+  class <MyModel>Entity < Grape::Entity
+    expose :id, :attribute
+    expose :nested, using: <NestedModel>Entity>
+  end
+
+  class <NestedModel>Entity < Grape::Entity
+    expose :id, :attribute
+  end
+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.
+ 
+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.:
+ 
+```
+   def self.attribute_param_types
+    { "<attribute name>" => Virtus::Attribute::Boolean }
+   end
+```
+
+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.
+
+
+## Dependencies
+
+Tool                  | Description
+--------------------- | -----------
+[Grape]               | An opinionated micro-framework for creating REST-like APIs in Ruby
+[GrapeEntity]         | Adds Entity support to API frameworks, such as Grape.
+[GrapeSwagger]        | Swagger docs.
+[Pundit]              | Minimal authorization through OO design and pure Ruby classes
+
+[Grape]:        https://github.com/ruby-grape/grape
+[GrapeEntity]:  https://github.com/ruby-grape/grape-entity
+[GrapeSwagger]: https://github.com/ruby-grape/grape-swagger
+[Pundit]:       https://github.com/elabs/pundit
+
+

data/Rakefile

@@ -0,0 +1,26 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'IntrospectiveGrape'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/bin/rails

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/introspective_grape/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/introspective_grape.gemspec

@@ -0,0 +1,49 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "introspective_grape/version"
+#require "introspective_grape/api"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "introspective_grape"
+  s.version     = IntrospectiveGrape::VERSION
+  s.authors     = ["Josh Buermann"]
+  s.email       = ["buermann@gmail.com"]
+  s.homepage    = "https://github.com/buermann/introspective_grape"
+  s.summary     = "Introspectively configure deeply nested RESTful Grape APIs for ActiveRecord models."
+  s.description = "Introspectively configure deeply nested RESTful Grape APIs for ActiveRecord models."
+  s.license     = "MIT"
+
+  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"
+  s.add_dependency "activerecord"
+
+  s.add_dependency 'grape'
+  s.add_dependency 'grape-entity'
+  s.add_dependency 'grape-swagger', '<= 0.10.2'
+  s.add_dependency 'pundit'
+
+  if RUBY_PLATFORM == 'java'
+    #s.add_development_dependency "jdbc-sqlite3"
+    s.add_development_dependency "activerecord-jdbcsqlite3-adapter"
+  else
+    s.add_development_dependency "sqlite3"
+  end
+
+  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 '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