api_me 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92daadad80db70e8aef932f76f51c4588438af3f
-  data.tar.gz: 7a206ff30375d224b053b2c522fe224d130be1f1
+  metadata.gz: 80f808a1b1be8921cfa450b223aff0973bd6871b
+  data.tar.gz: 8bb0c02b197eafbe2d523182b3261a2193d4ee09
 SHA512:
-  metadata.gz: 900a7acabcbbc6fe0ca576c7f94cb1be4e2acfc4a63d85209dacd78603dae7273aca01e6b8ae8acccdc5a95db43ef057aaef714b651013fc9347c7df864e5a5b
-  data.tar.gz: 09053b626b1c8120569ba25202356db997985e1f79bedc01ae770af1b78d3e5dcc7caca4f9fac2279d14ff9a6406f92e7a5fd48330906d689e7d478bd7d23d0a
+  metadata.gz: 10f743c5668ce8030571c14d0a5b38cb98ab4208f7c6bd2e63834538390ba29d2e541e6764d949a7c963a5293fd94c6490b49530cc6ce1c179297af285ac7feb
+  data.tar.gz: e19dcdb213864572ff53710f83b36aa69d7c3f48590a08b71e44305f3c6d7a2228a0dcc0a360cfe49933d52e19045a74547708e4e66f81c0cb168129b63de784

data/.rubocop.yml

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

data/.ruby-version

@@ -1 +1 @@
-2.1.3
+2.1.4

data/README.md

@@ -10,10 +10,19 @@ ApiMe provides a set of generators and base classes to assist with building Rest
 ### 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 through the separating concerns and 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.
+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.
+
+### 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 g api_me:resource user organization:belongs_to name:string ...`
+`rails generate api_me:resource user organization:belongs_to name:string ...`
 
 this generates the following:
 
@@ -22,7 +31,7 @@ this generates the following:
 * app/serializers/user_serializer.rb
 
 and also essentially calls:
-* `rails g model user organization:belongs_to name:string ...`
+* `rails generate model user organization:belongs_to name:string ...`
 Which generates the model et al as specified.
 
 users_controller.rb:

data/lib/api_me.rb

@@ -14,11 +14,11 @@ module ApiMe
   end
 
   module ClassMethods
-    def model(klass)
+    def model(klass) # rubocop:disable TrivialAccessors
       @model_klass = klass
     end
 
-    def serializer(klass)
+    def serializer(klass) # rubocop:disable TrivialAccessors
       @serializer_klass = klass
     end
 
@@ -62,12 +62,12 @@ module ApiMe
   # the top level ids array param. Would eventually like
   # to move to support the jsonapi.org standard closer.
   def index
-    ids_filter_hash = params[:ids] ? {ids: params[:ids]} : {}
+    ids_filter_hash = params[:ids] ? { ids: params[:ids] } : {}
     @scoped_objects = policy_scope(model_klass.all)
-    @filter_objects = filter_klass.new({
+    @filter_objects = filter_klass.new(
         scope: @scoped_objects,
         filters: (filter_params || {}).merge(ids_filter_hash)
-    })
+    )
 
     render json: @filter_objects.results, each_serializer: serializer_klass
   end

data/lib/api_me/base_filter.rb

@@ -2,6 +2,6 @@ module ApiMe
   class BaseFilter
     include SearchObject.module
 
-    option(:ids) { |scope, value| scope.where("id" => value) }
+    option(:ids) { |scope, value| scope.where('id' => value) }
   end
 end

data/lib/api_me/version.rb

@@ -1,3 +1,3 @@
 module ApiMe
-  VERSION = '0.3.2'
+  VERSION = '0.3.3'
 end

data/lib/generators/api_me/controller/controller_generator.rb

@@ -26,7 +26,9 @@ module ApiMe
       end
 
       def controller_class_name
-        "#{controllers_namespace.capitalize}::#{controllers_api_version.capitalize}::#{plural_name.camelize}Controller"
+        "#{controllers_namespace.capitalize}::"\
+        "#{controllers_api_version.capitalize}::"\
+        "#{plural_name.camelize}Controller"
       end
 
       def attributes_names
@@ -39,14 +41,14 @@ module ApiMe
 
       def nonpolymorphic_attribute_names
         associations.select { |attr| attr.type.in?([:belongs_to, :references]) }
-                    .reject { |attr| attr.attr_options.fetch(:polymorphic, false) }
-                    .map { |attr| "#{attr.name}_id".to_sym }
+          .reject { |attr| attr.attr_options.fetch(:polymorphic, false) }
+          .map { |attr| "#{attr.name}_id".to_sym }
       end
 
       def polymorphic_attribute_names
         associations.select { |attr| attr.type.in?([:belongs_to, :references]) }
-                    .select { |attr| attr.attr_options.fetch(:polymorphic, false) }
-                    .map { |attr| ["#{attr.name}_id".to_sym, "#{attr.name}_type".to_sym] }.flatten
+          .select { |attr| attr.attr_options.fetch(:polymorphic, false) }
+          .map { |attr| ["#{attr.name}_id".to_sym, "#{attr.name}_type".to_sym] }.flatten
       end
 
       def association_attribute_names
@@ -58,7 +60,6 @@ module ApiMe
       end
 
       def parent_class_name
-        base_controller_name = "#{controllers_namespace.capitalize}::BaseController"
         if options[:parent]
           options[:parent]
         else

data/lib/generators/api_me/filter/filter_generator.rb

@@ -26,14 +26,14 @@ module ApiMe
 
       def nonpolymorphic_attribute_names
         associations.select { |attr| attr.type.in?([:belongs_to, :references]) }
-                    .reject { |attr| attr.attr_options.fetch(:polymorphic, false) }
-                    .map { |attr| "#{attr.name}_id".to_sym }
+          .reject { |attr| attr.attr_options.fetch(:polymorphic, false) }
+          .map { |attr| "#{attr.name}_id".to_sym }
       end
 
       def polymorphic_attribute_names
         associations.select { |attr| attr.type.in?([:belongs_to, :references]) }
-                    .select { |attr| attr.attr_options.fetch(:polymorphic, false) }
-                    .map { |attr| ["#{attr.name}_id".to_sym, "#{attr.name}_type".to_sym] }.flatten
+          .select { |attr| attr.attr_options.fetch(:polymorphic, false) }
+          .map { |attr| ["#{attr.name}_id".to_sym, "#{attr.name}_type".to_sym] }.flatten
       end
 
       def association_attribute_names

data/lib/generators/api_me/install_generator.rb

@@ -0,0 +1,9 @@
+module ApiMe
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      def run_generators
+        run 'rails g pundit:install'
+      end
+    end
+  end
+end

data/lib/generators/api_me/policy/policy_generator.rb

@@ -26,14 +26,14 @@ module ApiMe
 
       def nonpolymorphic_attribute_names
         associations.select { |attr| attr.type.in?([:belongs_to, :references]) }
-                    .reject { |attr| attr.attr_options.fetch(:polymorphic, false) }
-                    .map { |attr| "#{attr.name}_id".to_sym }
+          .reject { |attr| attr.attr_options.fetch(:polymorphic, false) }
+          .map { |attr| "#{attr.name}_id".to_sym }
       end
 
       def polymorphic_attribute_names
         associations.select { |attr| attr.type.in?([:belongs_to, :references]) }
-                    .select { |attr| attr.attr_options.fetch(:polymorphic, false) }
-                    .map { |attr| ["#{attr.name}_id".to_sym, "#{attr.name}_type".to_sym] }.flatten
+          .select { |attr| attr.attr_options.fetch(:polymorphic, false) }
+          .map { |attr| ["#{attr.name}_id".to_sym, "#{attr.name}_type".to_sym] }.flatten
       end
 
       def association_attribute_names

data/spec/acceptance/api/v1/posts_spec.rb

@@ -3,8 +3,8 @@ require 'spec_helper'
 describe 'Users API' do
   it 'sends the list of posts using the default filter' do
     posts = [
-      Post.create(name: "test"),
-      Post.create(name: "test 2")
+      Post.create(name: 'test'),
+      Post.create(name: 'test 2')
     ]
 
     get '/api/v1/posts'
@@ -12,22 +12,24 @@ describe 'Users API' do
     expect(last_response.status).to eq(200)
     json = JSON.parse(last_response.body)
 
-    expect(json['posts'].length).to eq(2)
+    expect(json['posts'].length).to eq(posts.count)
   end
 
   it 'sends posts filtered by ids' do
-    posts = [
-      Post.create(name: "test"),
-      Post.create(name: "test 2"),
-      Post.create(name: "test 3")
+    all_posts = [
+      Post.create(name: 'test'),
+      Post.create(name: 'test 2'),
+      Post.create(name: 'test 3')
     ]
 
-    get '/api/v1/posts?ids%5B%5D=' + posts[0].id.to_s +
-        '&ids%5B%5D=' + posts[2].id.to_s
+    filtered_posts = [all_posts[0], all_posts[2]]
+
+    get '/api/v1/posts?ids%5B%5D=' + filtered_posts[0].id.to_s +
+      '&ids%5B%5D=' + filtered_posts[1].id.to_s
 
     expect(last_response.status).to eq(200)
     json = JSON.parse(last_response.body)
 
-    expect(json['posts'].length).to eq(2)
+    expect(json['posts'].length).to eq(filtered_posts.count)
   end
 end

data/spec/acceptance/api/v1/users_spec.rb

@@ -12,7 +12,7 @@ describe 'Users API' do
     expect(last_response.status).to eq(200)
     json = JSON.parse(last_response.body)
 
-    expect(json['users'].length).to eq(2)
+    expect(json['users'].length).to eq(users.count)
   end
 
   it 'sends an individual user' do
@@ -64,17 +64,19 @@ describe 'Users API' do
   end
 
   it 'sends a filtered list of users' do
-    users = [
+    all_users = [
       User.create(username: 'Test'),
       User.create(username: 'Demo'),
       User.create(username: 'Test 2')
     ]
 
+    filtered_users = [all_users[0], all_users[2]]
+
     get '/api/v1/users?filters%5Bsearch%5D=Test'
 
     expect(last_response.status).to eq(200)
     json = JSON.parse(last_response.body)
 
-    expect(json['users'].length).to eq(2)
+    expect(json['users'].length).to eq(filtered_users.count)
   end
 end

data/spec/acceptance/multi_word_resource_spec.rb

@@ -2,11 +2,11 @@ require 'spec_helper'
 
 describe 'multi-word API resource' do
   it 'succeeds creating a new object using a resource that consists of multiple words' do
-    post '/api/v1/multi_word_resources', {test_model: {test: true}}
+    post '/api/v1/multi_word_resources', test_model: { test: true }
 
     expect(last_response.status).to eq(201)
     json = JSON.parse(last_response.body)
 
-    expect(json['test_model']["created"]).to eq(true)
+    expect(json['test_model']['created']).to eq(true)
   end
 end

data/spec/internal/app/controllers/api/v1/fails_controller.rb

@@ -1,4 +1,4 @@
-class Api::V1::FailsController < ApplicationController
+class Api::V1::FailsController < ApplicationController # rubocop:disable ClassAndModuleChildren
   include ApiMe
 
   before_action :fail

data/spec/internal/app/controllers/api/v1/multi_word_resources_controller.rb

@@ -1,4 +1,4 @@
-class Api::V1::MultiWordResourcesController < ApplicationController
+class Api::V1::MultiWordResourcesController < ApplicationController # rubocop:disable ClassAndModuleChildren, LineLength
   include ApiMe
 
   model TestModel

data/spec/internal/app/controllers/api/v1/posts_controller.rb

@@ -1,3 +1,3 @@
-class Api::V1::PostsController < ApplicationController
+class Api::V1::PostsController < ApplicationController # rubocop:disable ClassAndModuleChildren
   include ApiMe
 end

data/spec/internal/app/controllers/api/v1/users_controller.rb

@@ -1,3 +1,3 @@
-class Api::V1::UsersController < ApplicationController
+class Api::V1::UsersController < ApplicationController # rubocop:disable ClassAndModuleChildren
   include ApiMe
 end

data/spec/internal/app/filters/user_filter.rb

@@ -3,5 +3,5 @@ require 'search_object'
 class UserFilter < ApiMe::BaseFilter
   include ::SearchObject.module
 
-  option(:search) { |scope, value| scope.where("username LIKE ?", "%#{value}%") }
+  option(:search) { |scope, value| scope.where('username LIKE ?', "%#{value}%") }
 end

data/spec/internal/app/models/test_model.rb

@@ -7,10 +7,10 @@ class TestModel
     @created ||= false
   end
 
-  def initialize(*args)
+  def initialize(*_args)
   end
 
-  def save!(*args)
+  def save!(*_args)
     TestModel.create
   end
 

data/spec/internal/app/serializers/test_model_serializer.rb

@@ -1,7 +1,5 @@
 class TestModelSerializer < ActiveModel::Serializer
   attributes :created
-  
-  def created
-    object.created
-  end
+
+  delegate :created, to: :object
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_me
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Sam Clopton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-10 00:00:00.000000000 Z
+date: 2014-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -159,6 +159,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
 - Gemfile
@@ -176,6 +177,7 @@ files:
 - lib/generators/api_me/filter/USAGE
 - lib/generators/api_me/filter/filter_generator.rb
 - lib/generators/api_me/filter/templates/filter.rb
+- lib/generators/api_me/install_generator.rb
 - lib/generators/api_me/policy/USAGE
 - lib/generators/api_me/policy/policy_generator.rb
 - lib/generators/api_me/policy/templates/policy.rb