api_me 0.9.4 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aed5d142524f6fbf74249ad247e7570f6043bf46fab0d142025333464c95b615
-  data.tar.gz: 5533d6ed2788081506b6ab79f448ae58e91bc4cdada605e9e086d2875ffe3ed6
+  metadata.gz: c865a6d591537309fab8c8666c2658139342f734a310156a2bd8fd81d6a20af1
+  data.tar.gz: f2e237e7d61c826fff1c3aca80823d832afacb0b13f05718cf42ccdac28bfd90
 SHA512:
-  metadata.gz: 18c8ffeed181d5346baddf0e705e4a5507222fc65248f90d12ff845bde6d3b223a54ec740c99a29e53f151d29c0a26acbacb498f0fafd896b718b6185a35633b
-  data.tar.gz: 2041df09681bb28d2c87b31993ad6917a5c6c778657fa28330ea629e1f3ef4ea9b87886212e0a049267127cde0b1aec4efb5a9dd3e5dfc7ba0e86a1e511ea655
+  metadata.gz: 2a9c0877833ec920f12236d8f9b6e930410a61424b66b63861db34a583b94c6506b65db699ed16491b93b33ea440610a687da28c50a95bf06176f0e309def9c0
+  data.tar.gz: 39084c49436008008519afe2b2e11a734577019849f96e5849c0dc5c4bc150b210d4312b3e65f09d31fa071d6e433919cd00ca780df59bcee04d7a9edc6b4b62

data/Rakefile

@@ -1,44 +1,21 @@
-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
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-task default: 'reports:all'
+require 'rdoc/task'
 
-namespace :reports do
-  task all: %i[fixme_notes rubocop spec]
-
-  task :rubocop do
-    system 'bundle exec rubocop --rails --display-cop-names'
-  end
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ApiMe'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+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
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
 
-  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
+Bundler::GemHelper.install_tasks

data/lib/api_me.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 require 'pundit'
 require 'search_object'
@@ -71,7 +73,7 @@ module ApiMe
     @sorted_scope = sort_scope(@filter_scope)
     @pagination_object = paginate_scope(@sorted_scope, page_params)
 
-    render json: @pagination_object.results, root: collection_root_key, each_serializer: serializer_klass, meta: { page: @pagination_object.page_meta }
+    render json: @pagination_object.results, root: collection_root_key, each_serializer: serializer_klass, meta: { page: @pagination_object.page_meta } # rubocop:disable Metrics/LineLength
   end
 
   def show
@@ -95,7 +97,7 @@ module ApiMe
 
     render status: 201, json: @object, root: singular_root_key, serializer: serializer_klass
   rescue ActiveRecord::RecordInvalid => e
-    handle_errors(e)
+    handle_active_record_errors(e)
   end
 
   def edit
@@ -112,7 +114,7 @@ module ApiMe
 
     head 204
   rescue ActiveRecord::RecordInvalid => e
-    handle_errors(e)
+    handle_active_record_errors(e)
   end
 
   def destroy
@@ -122,7 +124,7 @@ module ApiMe
 
     head 204
   rescue ActiveRecord::RecordInvalid => e
-    handle_errors(e)
+    handle_active_record_errors(e)
   end
 
   protected
@@ -151,9 +153,9 @@ module ApiMe
     render(json: { errors: errors }, status: status)
   end
 
-  def handle_errors(e)
-    Rails.logger.debug "ERROR: #{e}"
-    render_errors(e.record.errors.messages)
+  def handle_active_record_errors(active_record_error)
+    Rails.logger.debug "ERROR: #{active_record_error}"
+    render_errors(active_record_error.record.errors.messages)
   end
 
   def user_not_authorized
@@ -192,10 +194,10 @@ module ApiMe
     ).results
   end
 
-  def sort_scope(scope, sortable_params=sort_params)
+  def sort_scope(scope, sortable_params = sort_params)
     sort_klass.new(
-        scope: scope,
-        sort_params: sortable_params
+      scope: scope,
+      sort_params: sortable_params
     ).results
   end
 

data/lib/api_me/base_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApiMe
   class BaseFilter
     include SearchObject.module

data/lib/api_me/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'active_model_serializers'
 rescue LoadError
@@ -7,5 +9,8 @@ end
 
 module ApiMe
   class Engine < ::Rails::Engine
+    config.generators do |g|
+      g.test_framework :rspec
+    end
   end
 end

data/lib/api_me/model.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_model_serializers/model'
 
 module ApiMe

data/lib/api_me/pagination.rb

@@ -1,39 +1,56 @@
+# frozen_string_literal: true
+
 module ApiMe
   class Pagination
     attr_accessor :page_size, :page_offset, :scope
 
     def initialize(scope:, page_params:)
       self.scope = scope
-
-      if page_params
-        self.page_size = page_params[:size]
-        self.page_offset = page_params[:offset]
-      end
+      return unless page_params
+      self.page_size = page_params[:size]
+      self.page_offset = page_params[:offset]
     end
 
     def results
       paging? ? page.per.scope : scope
     end
 
-    def page_meta
+    def page_meta # rubocop:disable Metrics/MethodLength
       return {} unless paging?
-      iteration_count_start = (page_size.to_i * (page_offset.to_i - 1)) + 1
-      iteration_count_end = page_size.to_i * page_offset.to_i
-      iteration_count_offset = scope.total_count < iteration_count_end ? scope.total_count : iteration_count_end
       {
-        size: page_size.nil? ? default_page_size : page_size,
+        size: page_meta_size,
         offset: page_offset,
         record_count: scope.size,
         total_records: scope.total_count,
         total_pages: scope.total_pages,
         iteration_count_start: iteration_count_start,
         iteration_count_end: iteration_count_end,
-        current_iteration_count: iteration_count_start - iteration_count_offset
+        current_iteration_count: current_iteration_count
       }
     end
 
     protected
 
+    def iteration_count_start
+      (page_size.to_i * (page_offset.to_i - 1)) + 1
+    end
+
+    def iteration_count_end
+      page_size.to_i * page_offset.to_i
+    end
+
+    def iteration_count_offset
+      scope.total_count < iteration_count_end ? scope.total_count : iteration_count_end
+    end
+
+    def current_iteration_count
+      iteration_count_start - iteration_count_offset
+    end
+
+    def page_meta_size
+      page_size.nil? ? default_page_size : page_size
+    end
+
     def page
       self.scope = scope.page(page_offset ? page_offset : 1)
       self

data/lib/api_me/sorting.rb

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
+
 module ApiMe
   class Sorting
     attr_accessor :sort_criteria, :sort_reverse, :scope
 
     def initialize(scope:, sort_params:)
       self.scope = scope
-      if sort_params
-        self.sort_criteria = sort_params[:criteria] || default_sort_criteria
-        self.sort_reverse = sort_params[:reverse]
-      end
+      return unless sort_params
+      self.sort_criteria = sort_params[:criteria] || default_sort_criteria
+      self.sort_reverse = sort_params[:reverse]
     end
 
     def results
@@ -17,7 +18,7 @@ module ApiMe
     def sort_meta
       return {} unless sorting?
       {
-        criteria: sort_criteria.is_blank? || sort_criteria === '' ? default_sort_criteria : sort_criteria,
+        criteria: sort_meta_criteria,
         reverse: sort_reverse,
         record_count: scope.size,
         total_records: scope.total_count
@@ -26,19 +27,31 @@ module ApiMe
 
     protected
 
+    def sort_meta_criteria
+      if sort_criteria.blank?
+        default_sort_criteria
+      else
+        sort_criteria
+      end
+    end
+
     def sort(criteria = default_sort_criteria)
-      self.scope = if sort_reverse === 'true'
-                     scope.order(criteria => :desc)
-                   else
-                     scope.order(criteria => :asc)
-                   end
+      self.scope = sorted_scope(criteria)
       self
     end
 
+    def sorted_scope(criteria)
+      if sort_reverse === 'true'
+        scope.order(criteria => :desc)
+      else
+        scope.order(criteria => :asc)
+      end
+    end
+
     private
 
     def default_sort_criteria
-      sort_criteria = 'id'
+      'id'
     end
 
     def sorting?

data/lib/api_me/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApiMe
-  VERSION = '0.9.4'.freeze
+  VERSION = '0.10.0'
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApiMe
   module Generators
     class ControllerGenerator < ::Rails::Generators::NamedBase
@@ -76,7 +78,7 @@ module ApiMe
         in_root do
           insert_into_file(
             'config/routes.rb',
-            "      resources :#{resource_name}, only: [:show, :index, :create, :update, :destroy]\n",
+            "      resources :#{resource_name}, only: [:show, :index, :create, :update, :destroy]\n", # rubocop:disable Metrics/LineLength
             after: "namespace :#{controllers_api_version} do\n"
           )
         end
@@ -85,11 +87,11 @@ module ApiMe
       def maybe_create_api_v1_namespace
         in_root do
           unless File.readlines('config/routes.rb').grep("namespace #{controllers_namespace} do")
-            route <<-ROUTE
-namespace :#{controllers_namespace} do
-    namespace :#{controllers_api_version} do
-    end
-  end
+            route <<~ROUTE
+              namespace :#{controllers_namespace} do
+                  namespace :#{controllers_api_version} do
+                  end
+                end
 ROUTE
           end
         end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApiMe
   module Generators
     class FilterGenerator < ::Rails::Generators::NamedBase

data/lib/generators/api_me/install_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApiMe
   module Generators
     class InstallGenerator < Rails::Generators::Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApiMe
   module Generators
     class PolicyGenerator < ::Rails::Generators::NamedBase

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApiMe
   module Generators
     class ResourceGenerator < Rails::Generators::Base

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_me
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.10.0
 platform: ruby
 authors:
 - Sam Clopton
@@ -9,64 +9,50 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-27 00:00:00.000000000 Z
+date: 2018-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.1.16
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.1.16
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.16
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.16
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: pundit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.10.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.10.6
 - !ruby/object:Gem::Dependency
   name: search_object
   requirement: !ruby/object:Gem::Requirement
@@ -87,84 +73,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.3
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.3
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
-  name: combustion
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 3.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 3.6.1
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: factory_girl_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: 4.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: 4.8.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.7
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.7
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.49'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.49'
-- !ruby/object:Gem::Dependency
-  name: rake-notes
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.27.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.27.0
 description: This friendly library gives you helpers and generators to assist building
   RESTful API's in your Rails app.
 email:
@@ -173,18 +145,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".gitignore"
-- ".rubocop.yml"
-- ".ruby-version"
-- ".travis.yml"
-- Gemfile
-- Gemfile.lock
-- LICENSE
-- README.md
 - Rakefile
-- api_me.gemspec
-- config.ru
 - lib/api_me.rb
 - lib/api_me/base_filter.rb
 - lib/api_me/engine.rb
@@ -204,33 +165,6 @@ files:
 - lib/generators/api_me/policy/templates/policy.rb
 - lib/generators/api_me/resource/USAGE
 - lib/generators/api_me/resource/resource_generator.rb
-- spec/acceptance/api/v1/fails_spec.rb
-- spec/acceptance/api/v1/posts_spec.rb
-- spec/acceptance/api/v1/users_spec.rb
-- spec/acceptance/multi_word_resource_spec.rb
-- spec/internal/app/controllers/api/v1/fails_controller.rb
-- spec/internal/app/controllers/api/v1/multi_word_resources_controller.rb
-- spec/internal/app/controllers/api/v1/posts_controller.rb
-- spec/internal/app/controllers/api/v1/users_controller.rb
-- spec/internal/app/controllers/application_controller.rb
-- spec/internal/app/filters/user_filter.rb
-- spec/internal/app/models/post.rb
-- spec/internal/app/models/test_model.rb
-- spec/internal/app/models/user.rb
-- spec/internal/app/policies/application_policy.rb
-- spec/internal/app/policies/post_policy.rb
-- spec/internal/app/policies/test_model_policy.rb
-- spec/internal/app/policies/user_policy.rb
-- spec/internal/app/serializers/post_serializer.rb
-- spec/internal/app/serializers/test_model_serializer.rb
-- spec/internal/app/serializers/user_serializer.rb
-- spec/internal/config/database.yml
-- spec/internal/config/initializers/active_model_serializers.rb
-- spec/internal/config/routes.rb
-- spec/internal/db/schema.rb
-- spec/internal/log/.gitignore
-- spec/internal/public/favicon.ico
-- spec/spec_helper.rb
 homepage: https://github.com/wildland/api_me
 licenses:
 - MIT
@@ -239,7 +173,6 @@ post_install_message:
 rdoc_options: []
 require_paths:
 - lib
-- app
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="