api_me 0.9.4 → 0.10.0

data/.editorconfig

@@ -1,41 +0,0 @@
-# EditorConfig helps developers define and maintain consistent
-# coding styles between different editors and IDEs
-# editorconfig.org
-
-root = true
-
-
-[*]
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-indent_style = space
-indent_size = 2
-
-[*.rb]
-indent_style = space
-indent_size = 2
-
-[*.yml]
-indent_style = space
-indent_size = 2
-
-[*.js]
-indent_style = space
-indent_size = 2
-
-[*.hbs]
-indent_style = space
-indent_size = 2
-
-[*.css]
-indent_style = space
-indent_size = 2
-
-[*.html]
-indent_style = space
-indent_size = 2
-
-[*.md]
-trim_trailing_whitespace = false

data/.gitignore

@@ -1,3 +0,0 @@
-spec/internal/db/*sqlite
-pkg/
-*.swp

data/.rubocop.yml

@@ -1,8 +0,0 @@
-AllCops:
-  Exclude:
-    - '**/templates/*'
-    - '*.gemspec'
-LineLength:
-  Max: 100
-Documentation:
-  Enabled: false

data/.ruby-version

@@ -1 +0,0 @@
-2.5.1

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-script: bundle exec rspec spec
-rvm:
-  - 2.2.2

data/Gemfile

@@ -1,11 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-group :test do
-  gem 'actionpack'
-  gem 'active_model_serializers', '~> 0.10.0'
-  gem 'combustion', '~> 0.5.2'
-  gem 'pry'
-  gem 'rack-test', '~> 0.6.2'
-end

data/Gemfile.lock

@@ -1,153 +0,0 @@
-PATH
-  remote: .
-  specs:
-    api_me (0.9.4)
-      active_model_serializers (~> 0.10.0)
-      activerecord (>= 4.1.16)
-      activesupport (>= 4.1.16)
-      kaminari (~> 0.16.3)
-      pundit (~> 1.1.0)
-      search_object (~> 1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionpack (4.2.10)
-      actionview (= 4.2.10)
-      activesupport (= 4.2.10)
-      rack (~> 1.6)
-      rack-test (~> 0.6.2)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (4.2.10)
-      activesupport (= 4.2.10)
-      builder (~> 3.1)
-      erubis (~> 2.7.0)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    active_model_serializers (0.10.7)
-      actionpack (>= 4.1, < 6)
-      activemodel (>= 4.1, < 6)
-      case_transform (>= 0.2)
-      jsonapi-renderer (>= 0.1.1.beta1, < 0.3)
-    activemodel (4.2.10)
-      activesupport (= 4.2.10)
-      builder (~> 3.1)
-    activerecord (4.2.10)
-      activemodel (= 4.2.10)
-      activesupport (= 4.2.10)
-      arel (~> 6.0)
-    activesupport (4.2.10)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
-    arel (6.0.4)
-    ast (2.4.0)
-    builder (3.2.3)
-    case_transform (0.2)
-      activesupport
-    coderay (1.1.2)
-    colored (1.2)
-    combustion (0.5.5)
-      activesupport (>= 3.0.0)
-      railties (>= 3.0.0)
-      thor (>= 0.14.6)
-    concurrent-ruby (1.0.5)
-    crass (1.0.4)
-    diff-lcs (1.3)
-    erubis (2.7.0)
-    i18n (0.9.5)
-      concurrent-ruby (~> 1.0)
-    jsonapi-renderer (0.2.0)
-    kaminari (0.16.3)
-      actionpack (>= 3.0.0)
-      activesupport (>= 3.0.0)
-    loofah (2.2.2)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    method_source (0.9.0)
-    mini_portile2 (2.3.0)
-    minitest (5.11.3)
-    nokogiri (1.8.2)
-      mini_portile2 (~> 2.3.0)
-    parallel (1.12.1)
-    parser (2.5.1.0)
-      ast (~> 2.4.0)
-    powerpack (0.1.1)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pundit (1.1.0)
-      activesupport (>= 3.0.0)
-    rack (1.6.9)
-    rack-test (0.6.3)
-      rack (>= 1.0)
-    rails-deprecated_sanitizer (1.0.3)
-      activesupport (>= 4.2.0.alpha)
-    rails-dom-testing (1.0.9)
-      activesupport (>= 4.2.0, < 5.0)
-      nokogiri (~> 1.6)
-      rails-deprecated_sanitizer (>= 1.0.1)
-    rails-html-sanitizer (1.0.4)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (4.2.10)
-      actionpack (= 4.2.10)
-      activesupport (= 4.2.10)
-      rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
-    rainbow (3.0.0)
-    rake (12.3.1)
-    rake-notes (0.2.0)
-      colored
-      rake
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-rails (3.7.2)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    rubocop (0.54.0)
-      parallel (~> 1.10)
-      parser (>= 2.5)
-      powerpack (~> 0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
-    search_object (1.2.1)
-    sqlite3 (1.3.13)
-    thor (0.20.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.3.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  actionpack
-  active_model_serializers (~> 0.10.0)
-  api_me!
-  combustion (~> 0.5.2)
-  pry
-  rack-test (~> 0.6.2)
-  rake-notes (>= 0.2.0)
-  rspec-rails (~> 3)
-  rubocop (~> 0.49)
-  sqlite3 (~> 1.3.7)
-
-BUNDLED WITH
-   1.16.3

data/LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2018 Wildland Labs Inc.
-
-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

@@ -1,194 +0,0 @@
-[![Gem Version](https://badge.fury.io/rb/api_me.png)](http://badge.fury.io/rb/api_me) [![Build Status](https://travis-ci.org/wildland/api_me.svg?branch=master)](https://travis-ci.org/inigo-llc/api_me) [![Code Climate](https://codeclimate.com/github/inigo-llc/api_me/badges/gpa.svg)](https://codeclimate.com/github/inigo-llc/api_me) [![Dependency Status](https://gemnasium.com/inigo-llc/api_me.svg)](https://gemnasium.com/inigo-llc/api_me)
-ApiMe
-=========
-
-## This gem is currently a work in progress, follows semver, and may change significantly until version 1.0
-
-### A gem for building RESTful Api resources in Rails
-ApiMe provides a set of generators and base classes to assist with building Restful API's in Ruby on Rails.
-
-### Details
-Api controllers use the fantastic [Pundit](https://github.com/elabs/pundit) gem for authorization and parameter whitelisting, [Active Model Serializers ver 0.8](https://github.com/rails-api/active_model_serializers/tree/0-8-stable) for resource serialization, and [SearchObject](https://github.com/RStankov/SearchObject) for list filtering. The model, filter, serializer, and policy that the controller uses by default can all be overriden, along with other optional parameters.
-
-The primary goal of this gem was to keep things simple so that customization is fairly straight forward by separating concerns and providing overrides. Reusing existing libraries was a primary goal during the design, hence the overall simplicity of this gem. We currently use this gem internally at [Inigo](inigo.io) and are committed to its ongoing maintenance.
-
-### Upgrade from 0.7.X to 0.8.X
-- Upgrade to the latest version of 0.7.X. Run the app/tests and check/fix all deprecations
-- Upgrade to the latest version of 0.8.X, update active_model_serializers to 0.10.X.
-- Add the following initializer:
-  `config/initializers/active_model_serializer.rb`
-  ```rb
-  ActiveModelSerializers.config.adapter = :json
-  ```
-- Remove all `embed ...` methods from the serializers
-- Update all belongs-to relationships to have FKs, serialize the FK id in all active model serializers instead of embeding the relationship (I.E. `has_one :foo` becomes `attributes :foo_id`)
-- Update all has-many relationships to serialize the ids instead of embeding the relationship. (I.E. `has_many :foos` becomes `attributes :foo_ids`)
-- Remove all has-one relationships and manually build a method to serialize the id. Ex:
-  ```rb
-  attributes :foo_id
-
-  def foo_id
-    object.foo ? object.foo.id : nil
-  end
-  ```
-- Embeded has-one and belongs-to relationships look the same on the serializer, so look at the model to identify the differences.
-
-### Installation
-Add the gem to your Gemfile: `gem api_me`.
-
-Run `bundle install` to install it.
-
-Run `rails generate api_me:install` to install api_me.
-
-You are now setup!
-
-### Usage
-`rails generate api_me:resource user organization:belongs_to name:string ...`
-
-this generates the following:
-
-* app/controllers/api/v1/users_controller.rb
-* app/policies/user_policy.rb
-* app/serializers/user_serializer.rb
-
-and also essentially calls:
-* `rails generate model user organization:belongs_to name:string ...`
-Which generates the model et al as specified.
-
-users_controller.rb:
-````rb
-class UsersController < ApplicationController
-  include ApiMe
-
-end
-````
-POST (create) and PUT (update) requests are expected to post parameters to the singular underscored name of the model by default (I.E. `{"user": {"name": "Test"}}` for a user model), but this can be overriden by overriding `def params_klass_symbol`, or more in-depth by overriding `def object_params`. If `def object_params` is overriden, parameters are also expected be whitelisted inside of this method.
-
-models/user.rb:
-````rb
-# Standard Rails generator used
-class User < ActiveRecord::Base
-  belongs_to :organization
-end
-````
-
-policies/user_policy.rb (See [Pundit](https://github.com/elabs/pundit) for details):
-````rb
-class UserPolicy < ApplicationPolicy
-  # Authorizes what parameters will be whitelisted, see [Pundit](https://github.com/elabs/pundit) for details
-  def permitted_attributes
-    [:id, :organization_id, :name]
-  end
-
-end
-````
-
-serializers/user_serializer.rb (See [Active Model Serializers ver 0.8](https://github.com/rails-api/active_model_serializers/tree/0-8-stable) for details):
-````rb
-class UserSerializer < ActiveModel::Serializer
-  attributes :id, :name, :organization_id
-end
-````
-
-filters/user_filter.rb (See [SearchObject](https://github.com/RStankov/SearchObject) for details):
-````rb
-require 'search_object'
-
-class UserFilter < ApiMe::BaseFilter
-  include ::SearchObject.module #required
-
-  # Add custom filter logic here
-  # Ex:
-  #   option(:search) { |scope, value| scope.where("username LIKE ?", "%#{value}%") }
-end
-````
-The ApiMe::BaseFilter is called if no filter exists for the resource, by default the base filter provides filtering by ids for convenience. I.E a GET to `/api/v1/users?ids%5B%5D=1&ids%5B%5D=3` would return users filtered by ids of 1 and 3. All other filters are expected by default to be located at `params[:filters]` and not at the base level.
-
-### Sorting
-
-To enable sorting just pass `sort` in your request with `sortCiteria` and `sortReverse`.
-
-Ember Example
-````js
-return this.store.query('some-model', {
-  filters: {
-    cool_models_only: true
-  },
-  sort:  {
-    criteria: 'createdAt', // Property to sort on.
-    reverse: false, // True reverses the sort.
-  }
-});
-````
-
-### Pagination
-
-To enable pagination just pass `page` in your request with `size` and `offset`.
-
-Also see [ember-bootstrap-controls](http://wildland.github.io/ember-bootstrap-controls/?s=Bootstrap%20Controls&ss=Pagination) for a handy control for easy pagination with ember.
-
-Ember Example
-````js
-return this.store.query('some-model', {
-  filters: {
-    cool_models_only: true
-  },
-  sort:  {
-    criteria: 'createdAt', // Property to sort on.
-    reverse: false, // True reverses the sort.
-  },
-  page:  {
-    size: 50, // Size of a page. Number of results per page.
-    offset: false, /* The page number you want to see.
-                      Imagine 103 records are available.
-                      If the size of 50 is given as a parameter
-                      then valid inputs to offset would be 1, 2, and 3. */
-  }
-});
-````
-
-
-Your response will contain a meta object with the following data:
-```js
-meta: {
-  size: n           // Size input above
-  offset: m         // Offset input above
-  record_count: i   /* The number of records in the page.
-                       In the `offset` example above pages 1 and 2
-                       would have a record_count of 50 while page 3
-                       would have a record count of 3. */
-  total_records: j // Total number of records accessible
-  total_pages: k   // Total number of pages accessible
-}
-```
-
-### Overrides
-Overriding the default model class, serializer class, filter class, and filter parameter can be done like so:
-
-users_controller.rb:
-````rb
-class UsersController < ApplicationController
-  include ApiMe
-
-  model FakeUser
-  serialzier RealUserSerialzier
-
-  def filter_klass
-    FancyUserFilter
-  end
-
-  def filter_params
-    params[:meta][:filters]
-  end
-end
-````
-
-#### Todo:
-- [ ]  Add the ability to specify the api controller path (I.E. app/controllers/api/v2)
-- [ ]  Add the ability to inject the resource route into the routes file in the resource generators
-
-## Code Of Conduct
-Wildland Open Source [Code Of Conduct](https://github.com/wildland/code-of-conduct)
-
-## License
-Copyright (c) 2014, Api Me is developed and maintained by Sam Clopton, and is released under the open MIT Licence.