eivo-rails-api 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4b93f8aa8e0fe3d2189265c57125ed2974ec6c62
-  data.tar.gz: bb669e2d2c833a5bb88fb412153eef83759214e7
+SHA256:
+  metadata.gz: 22139f210ab1d9dc71dab873fb0ae140f557d3e589c0cc8dbd96ac02241ed016
+  data.tar.gz: 2c7da8bc3ee6e8b9bc568b8368cfbf5d1578b97747ca0c9dce3181123fb9fc8c
 SHA512:
-  metadata.gz: 0846f4061e04880efede8b0fa6eb820d186c2ebab02ecffc9694441620b9a6bebfe50cf04bc70fc678a2f40640fc3d6469a3fe5731e8528d2758bf51207d6ee4
-  data.tar.gz: 3f084ba81858becbafeadfb76ec9d1b8dd8778c1b3899398c3f16bdf14ba6778a8fcba002f847620831c948f454b872b78cf1a5c4af0a43a65d478b4a245832a
+  metadata.gz: b72b3037a4e6f5fd3695d3e279bccea74533558a84c6591dbbf066156dea23521453b8ea3abd7f632c402bdded77dba86dd70f6f277653a665053498268307a5
+  data.tar.gz: 60fb2d78fa67d8255639cdc84cd055de2cc572d6978b3e7fed90a767bf4acdef49fe85caa19f4ec288f1c5f4495d2a5620194346ff344cf18b012cc0efa1b85f

data/.gitignore

@@ -2,3 +2,5 @@
 /.bundle/
 /pkg/
 Gemfile.lock
+.ruby-version
+.ruby-gemset

data/.rubocop.yml

@@ -0,0 +1,83 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  Exclude:
+    - lib/generators/eivo/templates/config/application.rb
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Naming/PredicateName:
+  Enabled: false
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Style/Documentation:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/NegatedIf:
+  Enabled: false
+
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/RescueStandardError:
+  EnforcedStyle: implicit
+
+Style/RedundantBegin:
+  Enabled: false
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+# Performance
+
+Performance/ChainArrayAllocation:
+  Enabled: true

data/Gemfile

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gemspec

data/Rakefile

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'

data/app/controllers/eivo/application_controller.rb

@@ -2,7 +2,6 @@
 
 module EIVO
   class ApplicationController < ::ActionController::API
-
     include EIVO::Concerns::Exception
     include EIVO::Concerns::Rendering
 
@@ -24,9 +23,9 @@ module EIVO
         else
           ::Raven.capture_exception(e)
         end
+
         render_internal_server_error(e)
       end
     end
-
   end
 end

data/app/controllers/eivo/concerns/exception.rb

@@ -3,7 +3,6 @@
 module EIVO
   module Concerns
     module Exception
-
       extend ::ActiveSupport::Concern
 
       included do
@@ -17,7 +16,6 @@ module EIVO
           request_id: request.request_id
         )
       end
-
     end
   end
-end
+end

data/app/controllers/eivo/concerns/pagination.rb

@@ -27,22 +27,21 @@ module EIVO
             pages: collection.total_pages
           },
           links: {
-            self: url_for(params.to_unsafe_h.merge({ page: collection.current_page })),
-            first: url_for(params.to_unsafe_h.merge({ page: 1 })),
-            last: url_for(params.to_unsafe_h.merge({ page: collection.total_pages })),
+            self: url_for(params.to_unsafe_h.merge(page: collection.current_page)),
+            first: url_for(params.to_unsafe_h.merge(page: 1)),
+            last: url_for(params.to_unsafe_h.merge(page: collection.total_pages))
           }
         }
 
         if !collection.out_of_range? && !collection.first_page?
-          options[:links][:prev] = url_for(params.to_unsafe_h.merge({ page: collection.prev_page }))
+          options[:links][:prev] = url_for(params.to_unsafe_h.merge(page: collection.prev_page))
         end
         if !collection.out_of_range? && !collection.last_page?
-          options[:links][:next] = url_for(params.to_unsafe_h.merge({ page: collection.next_page }))
+          options[:links][:next] = url_for(params.to_unsafe_h.merge(page: collection.next_page))
         end
 
         options
       end
-
     end
   end
 end

data/app/controllers/eivo/concerns/rendering.rb

@@ -3,7 +3,6 @@
 module EIVO
   module Concerns
     module Rendering
-
       extend ::ActiveSupport::Concern
 
       def render_success(serializer = nil)
@@ -17,19 +16,19 @@ module EIVO
         end
       end
 
-      def render_unauthorized(exception = nil)
+      def render_unauthorized(_exception = nil)
         render_error 'unauthorized', status: :unauthorized
       end
 
-      def render_forbidden(exception = nil)
+      def render_forbidden(_exception = nil)
         render_error 'forbidden', status: :forbidden
       end
 
-      def render_not_found(exception = nil)
+      def render_not_found(_exception = nil)
         render_error 'not_found', status: :not_found
       end
 
-      def render_internal_server_error(exception)
+      def render_internal_server_error(_exception)
         render_error 'internal_server_error', status: :internal_server_error
       end
 
@@ -38,8 +37,8 @@ module EIVO
       end
 
       def render_model_errors(errors)
-        json_errors = errors.details.map do |attribute, errors|
-          errors.map do |error|
+        json_errors = errors.details.map do |attribute, attribute_errors|
+          attribute_errors.map do |error|
             {
               code: error[:error],
               source: {
@@ -67,7 +66,6 @@ module EIVO
         }
         render json: ::MultiJson.dump(data), status: status
       end
-
     end
   end
-end
+end

data/app/controllers/eivo/concerns/resource.rb

@@ -46,8 +46,8 @@ module EIVO
         end
       end
 
-    protected
-      
+      protected
+
       def collection
         raise NotImplementedError
       end
@@ -67,11 +67,10 @@ module EIVO
       def object_params_update
         object_params
       end
-    
+
       def set_default_serializer_options
         @serializer_options ||= {}
       end
-
     end
   end
 end

data/app/controllers/eivo/concerns/resources.rb

@@ -17,11 +17,11 @@ module EIVO
         @objects = paginate(@objects) unless options[:paginate] == false
 
         if options[:cache] && options[:cache] != false
-          if options[:cache].is_a?(Hash)
-            cache_options = options[:cache]
-          else
-            cache_options =  {}
-          end            
+          cache_options = if options[:cache].is_a?(Hash)
+                            options[:cache]
+                          else
+                            {}
+                          end
 
           if stale?(@objects, public: cache_options.fetch(:public, false))
             render_success serializer.new(@objects, @serializer_options)
@@ -68,8 +68,8 @@ module EIVO
         end
       end
 
-    protected
-      
+      protected
+
       def collection
         raise NotImplementedError
       end
@@ -97,7 +97,6 @@ module EIVO
       def set_default_serializer_options
         @serializer_options ||= {}
       end
-
     end
   end
 end

data/app/controllers/eivo/status_controller.rb

@@ -2,10 +2,8 @@
 
 module EIVO
   class StatusController < ApplicationController
-
     def index
       render_success
     end
-
   end
 end

data/bin/eivo

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'eivo-rails-api/cli'
 

data/config/initializers/sentry.rb

@@ -3,7 +3,7 @@
 require 'raven'
 
 Raven.configure do |config|
-  config.environments = %w[ staging production ]
+  config.environments = %w[staging production]
   config.dsn = Rails.application.credentials.dig(:sentry, :dsn)
   config.sanitize_fields = Rails.application.config.filter_parameters.map(&:to_s)
 

data/config/routes.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-EIVO::Engine.routes.draw do  
+EIVO::Engine.routes.draw do
   scope module: 'eivo' do
     get :status, to: 'status#index'
   end

data/eivo-rails-api.gemspec

@@ -1,8 +1,10 @@
-$:.push File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 
 Gem::Specification.new do |spec|
   spec.name          = 'eivo-rails-api'
-  spec.version       = '0.0.7'
+  spec.version       = '0.0.8'
   spec.authors       = ['Jonathan VUKOVICH-TRIBOUHARET']
   spec.email         = ['jonathan@eivo.co']
 
@@ -11,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://www.eivo.co'
   spec.license       = 'MIT'
 
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0")
   end
   spec.executables << 'eivo'
@@ -19,9 +21,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'thor'
 
-  spec.add_dependency 'oj'
-  spec.add_dependency 'multi_json'
   spec.add_dependency 'fast_jsonapi'
+  spec.add_dependency 'multi_json'
+  spec.add_dependency 'oj'
 
   spec.add_dependency 'kaminari'
 
@@ -29,4 +31,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
 end

data/lib/eivo-rails-api.rb

@@ -15,7 +15,7 @@ module EIVO
     def configure(application)
       application.config.load_defaults 5.2
       application.config.api_only = true
-      
+
       application.config.require_master_key = true
 
       application.config.generators do |g|

data/lib/eivo-rails-api/cli.rb

@@ -1,12 +1,12 @@
+# frozen_string_literal: true
+
 require 'thor'
 
 module EIVO
   class CLI < Thor
-
     desc 'install', 'Initialize default files'
     def install(args = nil)
       system("rails g eivo:install #{args}")
     end
-
   end
 end

data/lib/eivo-rails-api/environments/development.rb

@@ -41,7 +41,6 @@ module EIVO
         # Highlight code that triggered database queries in logs.
         config.active_record.verbose_query_logs = true
 
-
         # Raises error for missing translations
         # config.action_view.raise_on_missing_translations = true
 

data/lib/eivo-rails-api/environments/production.rb

@@ -42,7 +42,7 @@ module EIVO
         config.log_level = :debug
 
         # Prepend all log lines with the following tags.
-        config.log_tags = [ :request_id ]
+        config.log_tags = [:request_id]
 
         # Use a different cache store in production.
         # config.cache_store = :mem_cache_store
@@ -65,7 +65,7 @@ module EIVO
         # require 'syslog/logger'
         # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new 'app-name')
 
-        if ENV["RAILS_LOG_TO_STDOUT"].present?
+        if ENV['RAILS_LOG_TO_STDOUT'].present?
           logger           = ActiveSupport::Logger.new(STDOUT)
           logger.formatter = config.log_formatter
           config.logger    = ActiveSupport::TaggedLogging.new(logger)

data/lib/generators/eivo/install_generator.rb

@@ -6,7 +6,7 @@ module EIVO
   class InstallGenerator < Rails::Generators::Base
     include Rails::Generators::Migration
 
-    source_root File.expand_path('../templates', __FILE__)
+    source_root File.expand_path('templates', __dir__)
 
     def self.namespace(name = nil)
       @namespace ||= super.sub('e_i_v_o', 'eivo')
@@ -27,6 +27,7 @@ module EIVO
       copy_file 'Procfile'
       copy_file '.env.example'
       copy_file '.ruby-version'
+      copy_file '.rubocop.yml'
 
       create_restart_files
 
@@ -46,34 +47,35 @@ module EIVO
     end
 
     def create_restart_files
-      restart_code = <<-'EOF'
-### EIVO begin ###
+      restart_code = <<~'EIVO_COMMAND'
+        ### EIVO begin ###
 
-bundle exec pumactl -F config/puma.rb restart
+        bundle exec pumactl -F config/puma.rb restart
 
-### EIVO end ###
-EOF
+        ### EIVO end ###
+      EIVO_COMMAND
 
-      stop_code = <<-'EOF'
-### EIVO begin ###
+      stop_code = <<~'EIVO_COMMAND'
+        ### EIVO begin ###
 
-bundle exec pumactl -F config/puma.rb stop
+        bundle exec pumactl -F config/puma.rb stop
 
-### EIVO end ###
-EOF
+        ### EIVO end ###
+      EIVO_COMMAND
 
-      header_production = <<-'EOF'
-#!/usr/bin/env bash
-export RACK_ENV="production"
-export RAILS_ENV="production"
+      header_production = <<~'EIVO_COMMAND'
+        #!/usr/bin/env bash
+        export RACK_ENV="production"
+        export RAILS_ENV="production"
 
-EOF
-      header_staging = <<-'EOF'
-#!/usr/bin/env bash
-export RACK_ENV="staging"
-export RAILS_ENV="staging"
+      EIVO_COMMAND
 
-EOF
+      header_staging = <<~'EIVO_COMMAND'
+        #!/usr/bin/env bash
+        export RACK_ENV="staging"
+        export RAILS_ENV="staging"
+
+      EIVO_COMMAND
 
       create_file 'restart_production.sh', header_production, skip: true
       create_file 'stop_production.sh', header_production, skip: true
@@ -93,11 +95,10 @@ EOF
       inject_into_file 'restart_staging.sh', restart_code, after: header_staging
       inject_into_file 'stop_staging.sh', stop_code, after: header_staging
 
-      chmod 'restart_production.sh', 0755
-      chmod 'stop_production.sh', 0755
-      chmod 'restart_staging.sh', 0755
-      chmod 'stop_staging.sh', 0755
+      chmod 'restart_production.sh', 0o755
+      chmod 'stop_production.sh', 0o755
+      chmod 'restart_staging.sh', 0o755
+      chmod 'stop_staging.sh', 0o755
     end
-
   end
 end

data/lib/generators/eivo/templates/.rubocop.yml

@@ -0,0 +1,108 @@
+require:
+  - rubocop-performance
+  - rubocop-rails
+
+AllCops:
+  Exclude:
+    - bin/*
+    - db/schema.rb
+    - spec/rails_helper.rb
+    - spec/spec_helper.rb
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Naming/PredicateName:
+  Enabled: false
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Style/Documentation:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/NegatedIf:
+  Enabled: false
+
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/RescueStandardError:
+  EnforcedStyle: implicit
+
+Style/RedundantBegin:
+  Enabled: false
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+# Performance
+
+Performance/ChainArrayAllocation:
+  Enabled: true
+
+# Rails
+
+Rails/BulkChangeTable:
+  Enabled: false
+
+Rails/NotNullColumn:
+  Enabled: false
+
+Rails/ReversibleMigration:
+  Enabled: false
+
+Rails/SkipsModelValidations:
+  Enabled: false
+
+Rails/UnknownEnv:
+  Environments:
+    - development
+    - test
+    - staging
+    - production

data/lib/generators/eivo/templates/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
@@ -23,8 +25,10 @@ group :development, :test do
   gem 'faker'
   gem 'rspec-rails'
   gem 'brakeman'
-  gem 'rubocop'
-  gem 'rubocop-rspec'
+  gem 'rubocop', require: false
+  gem 'rubocop-rails', require: false
+  gem 'rubocop-performance', require: false
+  gem 'rubocop-rspec', require: false
   gem 'webmock'
 end
 

data/lib/generators/eivo/templates/app/controllers/application_controller.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class ApplicationController < EIVO::ApplicationController
 end

data/lib/generators/eivo/templates/config/puma.rb

@@ -4,9 +4,9 @@ workers ENV.fetch('WEB_CONCURRENCY') { 0 }
 threads_count = ENV.fetch('RAILS_MAX_THREADS') { 5 }
 threads threads_count, threads_count
 
-environment ENV.fetch('RAILS_ENV') { "development" }
+environment ENV.fetch('RAILS_ENV') { 'development' }
 
-if ['production', 'staging'].include?(ENV['RAILS_ENV'])
+if %w[production staging].include?(ENV['RAILS_ENV'])
   bind 'unix://tmp/sockets/puma.sock'
   pidfile 'tmp/pids/puma.pid'
   state_path 'tmp/pids/puma.state'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eivo-rails-api
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Jonathan VUKOVICH-TRIBOUHARET
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-13 00:00:00.000000000 Z
+date: 2019-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: oj
+  name: fast_jsonapi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fast_jsonapi
+  name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -122,6 +122,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: EIVO Rails API
 email:
 - jonathan@eivo.co
@@ -131,6 +159,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -156,6 +185,7 @@ files:
 - lib/generators/eivo/USAGE
 - lib/generators/eivo/install_generator.rb
 - lib/generators/eivo/templates/.env.example
+- lib/generators/eivo/templates/.rubocop.yml
 - lib/generators/eivo/templates/.ruby-version
 - lib/generators/eivo/templates/Gemfile
 - lib/generators/eivo/templates/Procfile
@@ -186,8 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: EIVO Rails API