api_me 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1d24dedc46539788df2d2b959d96ecf93a5e5a4
-  data.tar.gz: c6b2aaddefc12f77cd35ee91935b833f6f743b0b
+  metadata.gz: 47cb01169b34ee2781c7a1780659b99605797343
+  data.tar.gz: 8a19a3832d2cf1cdc9e663f52949d58e00aa3dc3
 SHA512:
-  metadata.gz: 2de62f19830a20723cfd7b213867f9788b16dedecc2e6489d46c72557c98bea25f7abf82a57d59971ff698bdec49f46386d0db0b64a6fc75a3c81555410b567e
-  data.tar.gz: 2c29e465df95037dc21e724c343811deecc351602bcc4424029aac296debcb7280785bae9bd86cd224d43868f7f8e926ce52266ef51541ff8974d6055c2cb75f
+  metadata.gz: 6aae861edb9a28dee94fbdc56eac28a0a79efa2c765071d87ad7c90e5517ea05925489851a5979fceb5129c3eec7dc231b0af8d85c4769e6452f03ecd82a1b4d
+  data.tar.gz: ac8a6dbcbaf4472be7216ffabca39bbbc7bbc85fe8ed0987cbeb6e6ff2079b35dfb5550e5d062a9bda20050cb9ba8c1d8dda04996d4e74cc1332049aa3276aeb

data/README.md

@@ -1,4 +1,4 @@
-[![Gem Version](https://badge.fury.io/rb/api_me.png)](http://badge.fury.io/rb/api_me) [![Build Status](https://travis-ci.org/inigo-llc/api_me.png?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) [![Test Coverage](https://codeclimate.com/github/inigo-llc/api_me/badges/coverage.svg)](https://codeclimate.com/github/inigo-llc/api_me)
+[![Gem Version](https://badge.fury.io/rb/api_me.png)](http://badge.fury.io/rb/api_me) [![Build Status](https://travis-ci.org/inigo-llc/api_me.png?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
 =========
 
@@ -7,12 +7,32 @@ ApiMe
 ### 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.
 
+### Usage
+`rails g 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
+* app/models/user.rb
+
+Or
+
+users_controller.rb
+````rb
+class UsersController < ApplicationController
+  include ApiMe
+end
+````
+
 #### This gem uses the following libraries:
 * Pundit
 * Active Model Serializers (0.8)
 
 #### Todo:
-* Add the ability to specify resource filters
+- [ ]  Add the ability to specify resource filters
+- [ ]  Add the ability to specify the api controller path (I.E. app/controllers/api/v2)
 
 ## License
 Copyright (c) 2014, Api Me is developed and maintained by Sam Clopton, and is released under the open MIT Licence.

data/Rakefile

@@ -1,11 +1,44 @@
 require 'bundler'
+require 'rspec/core/rake_task'
+require 'rake/notes/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
 
 Bundler::GemHelper.install_tasks
 
 task :console do
-	require 'irb'
-	require 'irb/completion'
-	require 'api_me' # You know what to do.
-	ARGV.clear
-	IRB.start
+  require 'irb'
+  require 'irb/completion'
+  require 'api_me' # You know what to do.
+  ARGV.clear
+  IRB.start
+end
+
+task default: 'reports:all'
+
+namespace :reports do
+  task all: [:fixme_notes, :rubocop, :spec]
+
+  task :rubocop do
+    system 'bundle exec rubocop --rails --display-cop-names'
+  end
+
+  desc 'Create a report on all notes'
+  task :notes do
+    puts "\nCollecting all of the standard code notes..."
+    system 'bundle exec rake notes'
+    puts "\nCollecting all HACK code notes..."
+    system 'bundle exec rake notes:custom ANNOTATION=HACK'
+    puts "\nCollecting all spec code notes..."
+    system "grep -rnE 'OPTIMIZE:|OPTIMIZE|FIXME:|FIXME|TODO:|TODO|HACK:|HACK'"\
+           ' spec'
+  end
+
+  desc 'Print only FIXME notes'
+  task :fixme_notes do
+    puts "\nFIXME Notes (These should all be fixed before merging to master):"
+    system 'bundle exec rake notes:fixme'
+    system "grep -rnE 'FIXME:|FIXME'"\
+           ' spec'
+  end
 end

data/api_me.gemspec

@@ -5,25 +5,27 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'api_me/version'
 
 Gem::Specification.new do |s|
-	s.name        = 'api_me'
-	s.version     = ApiMe::VERSION
-	s.authors     = ['Sam Clopton']
-	s.email       = ['samsinite@gmail.com']
-	s.homepage    = 'https://github.com/inigo/api_me'
-	s.summary     = 'Api Me'
-	s.description = "This friendly library gives you helpers and generators to assist building RESTful API's in your Rails app."
-	s.license     = 'MIT'
+  s.name        = 'api_me'
+  s.version     = ApiMe::VERSION
+  s.authors     = ['Sam Clopton']
+  s.email       = ['samsinite@gmail.com']
+  s.homepage    = 'https://github.com/inigo/api_me'
+  s.summary     = 'Api Me'
+  s.description = "This friendly library gives you helpers and generators to assist building RESTful API's in your Rails app."
+  s.license     = 'MIT'
 
-	s.files         = `git ls-files`.split("\n")
-	s.test_files    = `git ls-files -- {spec}/*`.split("\n")
-	s.require_paths = ['lib', 'app']
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths = %w(lib app)
 
-	s.add_runtime_dependency     'activerecord',  					 '>= 3.2.0'
-	s.add_runtime_dependency     'activesupport', 					 '>= 3.2.0'
-	s.add_runtime_dependency     'pundit',     							 '~> 0.1'
-	s.add_runtime_dependency     'active_model_serializers', '~> 0.8.0'
+  s.add_runtime_dependency 'activerecord',             '>= 3.2.0'
+  s.add_runtime_dependency 'activesupport',            '>= 3.2.0'
+  s.add_runtime_dependency 'pundit',                   '~> 0.1'
+  s.add_runtime_dependency 'active_model_serializers', '~> 0.8.0'
 
-	s.add_development_dependency 'combustion',  '~> 0.5.1'
-	s.add_development_dependency 'rspec-rails', '~> 2.13'
-	s.add_development_dependency 'sqlite3',     '~> 1.3.7'
+  s.add_development_dependency 'combustion',  '~> 0.5.1'
+  s.add_development_dependency 'rspec-rails', '~> 3'
+  s.add_development_dependency 'sqlite3',     '~> 1.3.7'
+  s.add_development_dependency 'rubocop', '>= 0.27.0'
+  s.add_development_dependency 'rake-notes', '>= 0.2.0'
 end

data/lib/api_me.rb

@@ -7,13 +7,12 @@ module ApiMe
   extend ActiveSupport::Concern
   include ::Pundit
 
-	included do
+  included do
 
-    protect_from_forgery :with => :null_session
-    rescue_from Pundit::NotAuthorizedError, :with => :user_not_authorized
+    rescue_from Pundit::NotAuthorizedError, with: :user_not_authorized
 
-    after_action :verify_authorized, :except => :index
-    after_action :verify_policy_scoped, :only => :index
+    after_action :verify_authorized, except: :index
+    after_action :verify_policy_scoped, only: :index
   end
 
   module ClassMethods
@@ -44,60 +43,56 @@ module ApiMe
     end
 
     def model_klass_name
-      @model_klass_name ||= self.name.demodulize.sub(/Controller$/, '').singularize
+      @model_klass_name ||= name.demodulize.sub(/Controller$/, '').singularize
     end
 
     def serializer_klass_name
-      @serializer_klass_name ||= "#{self.name.demodulize.sub(/Controller$/, '').singularize}Serializer"
+      @serializer_klass_name ||= "#{name.demodulize.sub(/Controller$/, '').singularize}Serializer"
     end
 
     def params_klass_symbol
-      self.model_klass.name.downcase.to_sym
+      model_klass.name.downcase.to_sym
     end
   end
 
   def index
     @scoped_objects = policy_scope(model_klass.all)
-    render :json => @scoped_objects, :each_serializer => serializer_klass
+    render json: @scoped_objects, each_serializer: serializer_klass
   end
 
   def show
     @object = model_klass.find(params[:id])
     authorize @object
 
-    render :json => @object, :serializer => serializer_klass
+    render json: @object, serializer: serializer_klass
   end
 
   def create
-    begin
-      @object = model_klass.new(object_params)
-      authorize @object
-      @object.save!(object_params)
-
-      render :status => 201, :json => @object, :serializer => serializer_klass
-    rescue ActiveRecord::RecordInvalid => e
-      handle_errors(e)
-    end
+    @object = model_klass.new(object_params)
+    authorize @object
+    @object.save!(object_params)
+
+    render status: 201, json: @object, serializer: serializer_klass
+  rescue ActiveRecord::RecordInvalid => e
+    handle_errors(e)
   end
 
   def update
-    begin
-      @object = model_klass.find(params[:id])
-      authorize @object
-      @object.update!(object_params)
-
-      render :status => 204, :nothing => true
-    rescue ActiveRecord::RecordInvalid => e
-      handle_errors(e)
-    end
+    @object = model_klass.find(params[:id])
+    authorize @object
+    @object.update!(object_params)
+
+    render status: 204, nothing: true
+  rescue ActiveRecord::RecordInvalid => e
+    handle_errors(e)
   end
 
   def destroy
     @object = model_klass.find(params[:id])
     authorize @object
-    @object.destroy()
+    @object.destroy
 
-    render :status => 204, :nothing => true
+    render status: 204, nothing: true
   end
 
   private
@@ -107,7 +102,7 @@ module ApiMe
   end
 
   def render_errors(errors, status = 422)
-    render(:json => {errors: errors}, :status => status)
+    render(json: { errors: errors }, status: status)
   end
 
   def handle_errors(e)
@@ -115,8 +110,8 @@ module ApiMe
   end
 
   def user_not_authorized
-    payload = { :message => "User is not allowed to access #{params[:action]} on this resource"}
-    render :json => payload, :status => 403
+    payload = { message: "User is not allowed to access #{params[:action]} on this resource" }
+    render json: payload, status: 403
   end
 
   def params_klass_symbol

data/lib/api_me/version.rb

@@ -1,3 +1,3 @@
 module ApiMe
-	VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

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

@@ -2,26 +2,26 @@ module ApiMe
   module Generators
     class ControllerGenerator < ::Rails::Generators::NamedBase
       source_root File.expand_path('../templates', __FILE__)
-      check_class_collision :suffix => "Controller"
+      check_class_collision suffix: 'Controller'
 
-      argument :attributes, :type => :array, :default => [], :banner => "field field"
+      argument :attributes, type: :array, default: [], banner: 'field field'
 
-      class_option :parent, :type => :string, :desc => "The parent class for the generated controller"
+      class_option :parent, type: :string, desc: 'The parent class for the generated controller'
 
       def create_api_controller_file
         template 'controller.rb', File.join('app/controllers',
-                                                controllers_namespace,
-                                                controllers_api_version,
-                                                "#{plural_name}_controller.rb")
+                                            controllers_namespace,
+                                            controllers_api_version,
+                                            "#{plural_name}_controller.rb")
       end
 
       def controllers_namespace
-        "api"
+        'api'
         # @generators.options.fetch(:api, {}).fetch(:namespace, 'api')
       end
 
       def controllers_api_version
-        "v1"
+        'v1'
         # @generators.options.fetch(:api, {}).fetch(:version, 'v1')
       end
 
@@ -34,7 +34,7 @@ module ApiMe
       end
 
       def associations
-        attributes.select { |attr| attr.reference? }
+        attributes.select(&:reference?)
       end
 
       def nonpolymorphic_attribute_names
@@ -54,7 +54,7 @@ module ApiMe
       end
 
       def strong_parameters
-        (attributes_names + association_attribute_names).map(&:inspect).join(", ")
+        (attributes_names + association_attribute_names).map(&:inspect).join(', ')
       end
 
       def parent_class_name
@@ -62,7 +62,7 @@ module ApiMe
         if options[:parent]
           options[:parent]
         else
-          "ApplicationController"
+          'ApplicationController'
         end
       end
 

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

@@ -2,11 +2,11 @@ module ApiMe
   module Generators
     class PolicyGenerator < ::Rails::Generators::NamedBase
       source_root File.expand_path('../templates', __FILE__)
-      check_class_collision :suffix => "Policy"
+      check_class_collision suffix: 'Policy'
 
-      argument :attributes, :type => :array, :default => [], :banner => "field field"
+      argument :attributes, type: :array, default: [], banner: 'field field'
 
-      class_option :parent, :type => :string, :desc => "The parent class for the generated policy"
+      class_option :parent, type: :string, desc: 'The parent class for the generated policy'
 
       def create_api_policy_file
         template 'policy.rb', File.join('app/policies', "#{singular_name}_policy.rb")
@@ -21,7 +21,7 @@ module ApiMe
       end
 
       def associations
-        attributes.select { |attr| attr.reference? }
+        attributes.select(&:reference?)
       end
 
       def nonpolymorphic_attribute_names
@@ -41,14 +41,14 @@ module ApiMe
       end
 
       def strong_parameters
-        (attributes_names + association_attribute_names).map(&:inspect).join(", ")
+        (attributes_names + association_attribute_names).map(&:inspect).join(', ')
       end
 
       def parent_class_name
         if options[:parent]
           options[:parent]
         else
-          "ApplicationPolicy"
+          'ApplicationPolicy'
         end
       end
 

data/lib/generators/api_me/resource/resource_generator.rb

@@ -3,10 +3,10 @@ module ApiMe
     class ResourceGenerator < Rails::Generators::Base
       def run_generators
         params = @_initializer[0]
-        invoke "model", params
-        invoke "serializer", params + ["created_at", "updated_at"]
-        invoke "api_me:policy", params
-        invoke "api_me:controller", params
+        invoke 'model', params
+        invoke 'serializer', params + %w(created_at updated_at)
+        invoke 'api_me:policy', params
+        invoke 'api_me:controller', params
       end
     end
   end

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

@@ -7,6 +7,6 @@ describe 'fails API' do
     expect(last_response.status).to eq(404)
     json = JSON.parse(last_response.body)
 
-    expect(json['status']).to eq("failed")
+    expect(json['status']).to eq('failed')
   end
 end

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

@@ -3,8 +3,8 @@ require 'spec_helper'
 describe 'Users API' do
   it 'sends the list of users' do
     users = [
-      User.create(:username => "Test"),
-      User.create(:username => "Test 2")
+      User.create(username: 'Test'),
+      User.create(username: 'Test 2')
     ]
 
     get '/api/v1/users'
@@ -16,7 +16,7 @@ describe 'Users API' do
   end
 
   it 'sends an individual user' do
-    user = User.create(:username => "Test")
+    user = User.create(username: 'Test')
 
     get '/api/v1/users/' + user.id.to_s + '/'
 
@@ -28,10 +28,10 @@ describe 'Users API' do
 
   it 'creates a new user' do
     user_params = {
-      :username => "Test"
+      username: 'Test'
     }
 
-    post '/api/v1/users/', {:user => user_params}
+    post '/api/v1/users/', user: user_params
 
     expect(last_response.status).to eq(201)
     json = JSON.parse(last_response.body)
@@ -40,25 +40,25 @@ describe 'Users API' do
   end
 
   it 'updates an existing user' do
-    user = User.create(:username => "Foo")
+    user = User.create(username: 'Foo')
 
-    expect(user.username).to eq("Foo")
+    expect(user.username).to eq('Foo')
 
-    put '/api/v1/users/' + user.id.to_s + '/', {:user => {:username => "Bar"}}
+    put '/api/v1/users/' + user.id.to_s + '/', user: { username: 'Bar' }
 
     updated_user = User.find(user.id)
     expect(last_response.status).to eq(204)
-    expect(updated_user.username).to eq("Bar")
+    expect(updated_user.username).to eq('Bar')
   end
 
   it 'destroys an existing user' do
-    user = User.create(:username => "Foo")
+    user = User.create(username: 'Foo')
 
     expect(user.id).to_not eq(nil)
 
     delete '/api/v1/users/' + user.id.to_s + '/'
 
-    does_user_exist = User.where(:id => user.id).exists?
+    does_user_exist = User.where(id: user.id).exists?
     expect(last_response.status).to eq(204)
     expect(does_user_exist).to eq(false)
   end

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

@@ -6,6 +6,6 @@ class Api::V1::FailsController < ApplicationController
   private
 
   def fail
-    render json: {:status => "failed"}, status: 404
+    render json: { status: 'failed' }, status: 404
   end
 end

data/spec/internal/app/controllers/application_controller.rb

@@ -1,7 +1,7 @@
 class ApplicationController < ActionController::Base
   # Prevent CSRF attacks by raising an exception.
   # For APIs, you may want to use :null_session instead.
-  protect_from_forgery :with => :exception
+  protect_from_forgery with: :exception
 
   private
 

data/spec/internal/app/policies/application_policy.rb

@@ -11,7 +11,7 @@ class ApplicationPolicy
   end
 
   def show?
-    scope.where(:id => record.id).exists?
+    scope.where(id: record.id).exists?
   end
 
   def create?

data/spec/internal/db/schema.rb

@@ -1,6 +1,6 @@
 ActiveRecord::Schema.define do
-	create_table :users, :force => true do |t|
-		t.string :username
-		t.timestamps
-	end
+  create_table :users, force: true do |t|
+    t.string :username
+    t.timestamps
+  end
 end

data/spec/spec_helper.rb

@@ -18,8 +18,8 @@ module ApiHelper
 end
 
 RSpec.configure do |config|
-	config.use_transactional_fixtures = true
+  config.use_transactional_fixtures = true
 
-	config.include ApiHelper
+  config.include ApiHelper
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_me
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Sam Clopton
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.13'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.13'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.7
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.27.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.27.0
+- !ruby/object:Gem::Dependency
+  name: rake-notes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 description: This friendly library gives you helpers and generators to assist building
   RESTful API's in your Rails app.
 email: