elocal_api_support 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cdeb546097909b97e80efce4c8312735a3b17ea1
-  data.tar.gz: eda8b70eecc679af927b2bf35f9e0f78344dc008
+  metadata.gz: f99ce80a0db1de44c82bb82b0f063b38515541e6
+  data.tar.gz: 9061e4c0dc4c8ae7f1feeb4690b383b17375c4ea
 SHA512:
-  metadata.gz: fb7e49521e3468b881e9b63891571641c6e2facd1abc9dcd1dd5ca06c18403ecb760f97783d7a0d2e4c0939ea0728fa572deccce927ca635a52ad67c67d9d474
-  data.tar.gz: e9fb097ea3ae497a5f5dcc373119aa2fef05d3237555024b9e30759276c7f897a6849ad888576fd1871ca87e812ebafed4f05e8b3debf5259cb6983cd9d4eff1
+  metadata.gz: ebd164dfe1a0da8f6bd404e404a6e6a1bc72db089061d8e1d192a1643d6468f1a0b7af7a59df39cbd471847a42a3482f7ca50e7a2ce7cf25aee12ef59397ed29
+  data.tar.gz: 94bb8f5b60b36f97e494de02bbe88f45ff93e28326d342d475e85a9d54ae971a39cd2475d3bb009a2fabf4479ca41b3558fd2eb59b5a5c264d09fd31de60aa3c

data/.rubocop.yml

@@ -0,0 +1,27 @@
+AllCops:
+  Include:
+    - Rakefile
+  Exclude:
+    - db/**/*
+    - config/**/*
+    - script/**/*
+    - bin/**/*
+LineLength:
+  Enabled: true
+  Max: 150
+Documentation:
+  Enabled: false
+AlignParameters:
+  Enabled: false
+MethodLength:
+  Max: 30
+AndOr:
+  Enabled: false
+ClassLength:
+  Max: 200
+ClassAndModuleChildren:
+  Enabled: false
+MultilineOperationIndentation:
+  Enabled: false
+Metrics/AbcSize:
+  Max: 20

data/Rakefile

@@ -1,4 +1,4 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|

data/lib/elocal_api_support/actions.rb

@@ -18,13 +18,11 @@ module ElocalApiSupport
     end
 
     module Common
-
       protected
 
       def filtered_objects_for_json
-
         if associated_model_serializer
-          filtered_objects.map{|r| associated_model_serializer.new(r)}
+          filtered_objects.map { |r| associated_model_serializer.new(r) }
         else
           filtered_objects
         end
@@ -33,13 +31,14 @@ module ElocalApiSupport
       def associated_model_serializer
         unless @associated_model_serializer_lookup_complete
           c = "#{associated_model}Serializer"
-          @associated_model_serializer = if Object.const_defined?(c)
-            Rails.logger.debug("Using #{c}")
-            c.constantize
-          else
-            Rails.logger.debug("No serializer #{c}")
-            nil
-          end
+          @associated_model_serializer =
+            if Object.const_defined?(c)
+              Rails.logger.debug("Using #{c}")
+              c.constantize
+            else
+              Rails.logger.debug("No serializer #{c}")
+              nil
+            end
           @associated_model_serializer_lookup_complete = true
         end
         @associated_model_serializer
@@ -49,6 +48,5 @@ module ElocalApiSupport
         @model_name ||= controller_name.singularize
       end
     end
-
   end
-end
+end

data/lib/elocal_api_support/actions/create.rb

@@ -8,9 +8,9 @@ module ElocalApiSupport
         if obj.save
           render json: obj
         else
-          render json: {errors: obj.errors}, status: 422
+          render json: { errors: obj.errors }, status: 422
         end
       end
     end
   end
-end
+end

data/lib/elocal_api_support/actions/destroy.rb

@@ -5,11 +5,11 @@ module ElocalApiSupport
         if lookup_object.destroy
           render json: lookup_object
         else
-          render json: {errors: "Failed to destroy #{lookup_object}"}, status: 500
+          render json: { errors: "Failed to destroy #{lookup_object}" }, status: 500
         end
       rescue ActiveRecord::RecordNotFound
         render json: {} # record not found is ok for destroy
       end
     end
   end
-end
+end

data/lib/elocal_api_support/actions/index.rb

@@ -2,15 +2,56 @@ module ElocalApiSupport
   module Actions
     module Index
       def index
+        add_pagination_headers \
+          if paginated_request? && paginate_with_headers?
+
+        render_filtered_objects_as_json
+      end
+
+      protected
+
+      # Her library likes to paginate with headers,
+      # ActiveResource cannot handle headers.
+      # So awesomely, two implementations. To use the "Her" implementation with headers
+      # this method should be overridend to return true
+      def paginate_with_headers?
+        false
+      end
+
+      private
+
+      def render_paginated_results_without_headers
         render json: {
-            current_page:  current_page,
-            per_page:      (params[:page].present? || params[:per_page].present?) ? per_page : filtered_objects.total_count,
-            total_entries: filtered_objects.total_count,
-            total_pages:   (params[:page].present? || params[:per_page].present?) ? filtered_objects.total_pages : 1,
-            records:       filtered_objects_for_json
-          }
+          current_page:  current_page,
+          per_page:      paginated_request? ? per_page : filtered_objects.total_count,
+          total_entries: filtered_objects.total_count,
+          total_pages:   paginated_request? ? filtered_objects.total_pages : 1,
+          records:       filtered_objects_for_json
+        }
+      end
+
+      def render_paginated_results_with_headers
+        render json: filtered_objects_for_json
+      end
+
+      def render_filtered_objects_as_json
+        if paginate_with_headers?
+          render_paginated_results_with_headers
+        else
+          render_paginated_results_without_headers
+        end
+      end
+
+      def add_pagination_headers
+        logger.debug { format 'Adding pagination headers for filtered_objects collection of size %d', filtered_objects.total_count }
+        response.headers['x-total'] = filtered_objects.total_count
+        response.headers['x-per-page'] = per_page
+        response.headers['x-page'] = current_page
+      end
+
+      def paginated_request?
+        params[:page].present? || params[:per_page].present?
       end
     end
   end
 end
-

data/lib/elocal_api_support/actions/show.rb

@@ -6,4 +6,4 @@ module ElocalApiSupport
       end
     end
   end
-end
+end

data/lib/elocal_api_support/actions/update.rb

@@ -6,7 +6,7 @@ module ElocalApiSupport
         if lookup_object.update_attributes(params[associated_model_name])
           render json: lookup_object
         else
-          render json:  {errors: lookup_object.errors}, status: 422
+          render json:  { errors: lookup_object.errors }, status: 422
         end
       end
     end

data/lib/elocal_api_support/authorization.rb

@@ -24,13 +24,20 @@ module ElocalApiSupport::Authorization
   end
 
   def authorize!
-    unless authorized?
-      Rails.logger.warn("Somebody else tried to access our internal API!  Value: #{authorize_request_token} Params: #{params}, Headers: #{request.headers.map{ |k, _v| k }}")
-      render json: error_response_hash, status: 401
-    end
+    return if authorized?
+
+    Rails.logger.warn(
+      format(
+        'Somebody else tried to access our internal API!  Value: %s Params: %s, Headers: %s',
+        authorize_request_token,
+        params,
+        request.headers.map { |k, _v| k }
+      )
+    )
+    render json: error_response_hash, status: 401
   end
 
   def authorize_request_token
-    [params[:request_token], request.headers["HTTP_X_REQUEST_TOKEN"]].detect(&:present?)
+    [params[:request_token], request.headers['HTTP_X_REQUEST_TOKEN']].detect(&:present?)
   end
 end

data/lib/elocal_api_support/enable_cors.rb

@@ -8,9 +8,9 @@ module ElocalApiSupport::EnableCors
   module ClassMethods
     attr_accessor :cors_allow_origin, :cors_allow_methods, :cors_allow_headers
     def cors_allow_all
-      self.cors_allow_origin  = "*"
-      self.cors_allow_methods = %w{GET POST PUT DELETE}.join(",")
-      self.cors_allow_headers = %w{Origin Accept Content-Type X-Requested-With X-XSRF-Token}.join(",")
+      self.cors_allow_origin  = '*'
+      self.cors_allow_methods = %w(GET POST PUT DELETE).join(',')
+      self.cors_allow_headers = %w(Origin Accept Content-Type X-Requested-With X-XSRF-Token).join(',')
     end
   end
 
@@ -18,6 +18,6 @@ module ElocalApiSupport::EnableCors
     response.headers['Access-Control-Allow-Origin']  = self.class.cors_allow_origin
     response.headers['Access-Control-Allow-Methods'] = self.class.cors_allow_methods
     response.headers['Access-Control-Allow-Headers'] = self.class.cors_allow_headers
-    head(:ok) if request.request_method == "OPTIONS"
+    head(:ok) if request.request_method == 'OPTIONS'
   end
 end

data/lib/elocal_api_support/model_from_params.rb

@@ -4,6 +4,7 @@ module ElocalApiSupport::ModelFromParams
   #  - params
   #  - associated_model_name
   #
+
   protected
 
   def lookup_object
@@ -30,7 +31,7 @@ module ElocalApiSupport::ModelFromParams
         elsif associated_model.respond_to?(:"with_#{param_name}", true)
           rel = rel.send(:"with_#{param_name}", params[param_name])
         else
-          rel = rel.where({param_name.to_sym => params[param_name]})
+          rel = rel.where(param_name.to_sym => params[param_name])
         end
       end
     end
@@ -80,15 +81,12 @@ module ElocalApiSupport::ModelFromParams
   end
 
   def filter_sort_col
-    if params[:sort] && params[:sort][:key] && allowed_sort_columns.include?(params[:sort][:key])
-      params[:sort][:key]
-    else
-      nil
-    end
+    params[:sort][:key] \
+      if params[:sort] && params[:sort][:key] && allowed_sort_columns.include?(params[:sort][:key])
   end
 
   def filter_sort_direction
-    if params[:sort] && params[:sort][:direction] && ['asc','desc'].include?(params[:sort][:direction])
+    if params[:sort] && params[:sort][:direction] && %w(asc desc).include?(params[:sort][:direction])
       params[:sort][:direction]
     else
       ''

data/lib/elocal_api_support/version.rb

@@ -1,3 +1,3 @@
 module ElocalApiSupport
-  VERSION = "0.1.2"
+  VERSION = '0.1.3'
 end

data/spec/authorization_spec.rb

@@ -65,4 +65,4 @@ describe AuthController, type: :controller do
       expect(response).to have_http_status(200)
     end
   end
-end
+end

data/spec/fixtures/application.rb

@@ -3,12 +3,15 @@ require 'action_controller'
 require 'action_dispatch'
 
 module Rails
-
   class App
-    def env_config; {} end
+    def env_config
+      {}
+    end
+
     def config
       OpenStruct.new
     end
+
     def routes
       return @routes if defined?(@routes)
       @routes = ActionDispatch::Routing::RouteSet.new
@@ -17,16 +20,17 @@ module Rails
       end
       @routes
     end
+
     def logger
       @logger ||= begin
-        Dir.mkdir('log') unless Dir.exists?('log')
+        Dir.mkdir('log') unless Dir.exist?('log')
         Logger.new('log/test.log')
       end
     end
   end
 
   def self.logger
-    self.application.logger
+    application.logger
   end
 
   def self.application

data/spec/fixtures/controllers.rb

@@ -5,4 +5,4 @@ class FakesController < ActionController::Base
   def index
     render nothing: true
   end
-end
+end

data/spec/spec_helper.rb

@@ -23,65 +23,63 @@ require 'rspec/rails'
 
 require 'elocal_api_support'
 
-RSpec.configure do |config|
-# The settings below are suggested to provide a good initial experience
-# with RSpec, but feel free to customize to your heart's content.
-=begin
-  # These two settings work together to allow you to limit a spec run
-  # to individual examples or groups you care about by tagging them with
-  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
-  # get run.
-  config.filter_run :focus
-  config.run_all_when_everything_filtered = true
-
-  # Many RSpec users commonly either run the entire suite or an individual
-  # file, and it's useful to allow more verbose output when running an
-  # individual spec file.
-  if config.files_to_run.one?
-    # Use the documentation formatter for detailed output,
-    # unless a formatter has already been configured
-    # (e.g. via a command-line flag).
-    config.default_formatter = 'doc'
-  end
-
-  # Print the 10 slowest examples and example groups at the
-  # end of the spec run, to help surface which specs are running
-  # particularly slow.
-  config.profile_examples = 10
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = :random
-
-  # Seed global randomization in this process using the `--seed` CLI option.
-  # Setting this allows you to use `--seed` to deterministically reproduce
-  # test failures related to randomization by passing the same `--seed` value
-  # as the one that triggered the failure.
-  Kernel.srand config.seed
-
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
-  config.expect_with :rspec do |expectations|
-    # Enable only the newer, non-monkey-patching expect syntax.
-    # For more details, see:
-    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
-    expectations.syntax = :expect
-  end
-
-  # rspec-mocks config goes here. You can use an alternate test double
-  # library (such as bogus or mocha) by changing the `mock_with` option here.
-  config.mock_with :rspec do |mocks|
-    # Enable only the newer, non-monkey-patching expect syntax.
-    # For more details, see:
-    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-    mocks.syntax = :expect
-
-    # Prevents you from mocking or stubbing a method that does not exist on
-    # a real object. This is generally recommended.
-    mocks.verify_partial_doubles = true
-  end
-=end
+RSpec.configure do |_config|
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # These two settings work together to allow you to limit a spec run
+  #   # to individual examples or groups you care about by tagging them with
+  #   # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  #   # get run.
+  #   config.filter_run :focus
+  #   config.run_all_when_everything_filtered = true
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = 'doc'
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+  #
+  #   # rspec-expectations config goes here. You can use an alternate
+  #   # assertion/expectation library such as wrong or the stdlib/minitest
+  #   # assertions if you prefer.
+  #   config.expect_with :rspec do |expectations|
+  #     # Enable only the newer, non-monkey-patching expect syntax.
+  #     # For more details, see:
+  #     #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #     expectations.syntax = :expect
+  #   end
+  #
+  #   # rspec-mocks config goes here. You can use an alternate test double
+  #   # library (such as bogus or mocha) by changing the `mock_with` option here.
+  #   config.mock_with :rspec do |mocks|
+  #     # Enable only the newer, non-monkey-patching expect syntax.
+  #     # For more details, see:
+  #     #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #     mocks.syntax = :expect
+  #
+  #     # Prevents you from mocking or stubbing a method that does not exist on
+  #     # a real object. This is generally recommended.
+  #     mocks.verify_partial_doubles = true
+  #   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elocal_api_support
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Rob Di Marco
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-19 00:00:00.000000000 Z
+date: 2015-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -131,6 +131,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -172,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Utilities for controllers when creating a JSON API
@@ -181,3 +182,4 @@ test_files:
 - spec/fixtures/application.rb
 - spec/fixtures/controllers.rb
 - spec/spec_helper.rb
+has_rdoc: