eivo-rails-api 0.1.4 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6eb8fb502dfece3bbee217a7ad9b0cc1ec3addf89006a76cf5b0dc95cd4512b2
-  data.tar.gz: 2708e0777b8c6ff61c316c204a5008c2640d7a98f43b99427af2a22dcc728216
+  metadata.gz: d26122daa50eea4591dfb5e59b7f03bb58b32c02b6dd3c770e4197bf74058ac1
+  data.tar.gz: 37c9a1bcaaf83ccdf406a8fbd6fcac62396805597081f36d378c8327a273fac5
 SHA512:
-  metadata.gz: 707f5dc1d2a49d3b82ad1a35788275302cad5da6295200dbe3d8e06bfae37acd5586db50fbb371b085d8d701a9831a91217e9f6cafee02dc1e1b11ab0c6cb308
-  data.tar.gz: 193ed57465548b16a7876ac1bdc5f34dbf816d26fb5c41c0b0ac63329cf212246a1ae9d13a0e75e0f7853cb9e7df410b6c2baaa52301e1ff3c0ff13f2fd858bb
+  metadata.gz: 6561c1ccabc788339a7b27032375dee85e4ccd2d4c2e27dc9fd50e4e43b4af76284e9c03d25dfdee32b09a95774e14f378d6675e3e50262d8539289b69f58c10
+  data.tar.gz: 64db5e1ecd54e0eb03a84ede95df803eae130ccfc3fa8d15cbe28d10fd8222bd9e0c76ee9c5c6853dd6708b617b7608b568912d89a3a7876121bb33b0eb37047

data/.rubocop.yml

@@ -44,9 +44,6 @@ Naming/PredicateName:
 Naming/VariableNumber:
   EnforcedStyle: snake_case
 
-Style/BracesAroundHashParameters:
-  EnforcedStyle: context_dependent
-
 Style/Documentation:
   Enabled: false
 

data/README.md

@@ -37,10 +37,6 @@ sentry:
   dsn: ""
 ```
 
-### Warning
-
-`force_ssl` option is not enabled, for performance reasons SSL / TLS should be managed by the web server (nginx, Apache).
-
 ## License
 
 This project is released under the MIT license. See the LICENSE file for more info.

data/config/initializers/logger.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'lograge'
+
+if Rails.env.staging? || Rails.env.production?
+  Rails.application.configure do
+    config.colorize_logging = false
+
+    config.lograge.enabled = true
+    config.lograge.formatter = ::Lograge::Formatters::Raw.new
+    config.lograge.base_controller_class = [
+      'ActionController::API',
+      'ActionController::Base'
+    ]
+
+    config.lograge.ignore_actions = ['EIVO::StatusController#index']
+
+    config.lograge.custom_options = ->(event) do
+      result = {
+        params: event.payload[:params].except('controller', 'action', 'format'),
+        request_id: event.payload[:request_id]
+      }
+
+      result[:user_id] = event.payload[:user_id] if event.payload[:user_id]
+      result[:organization_id] = event.payload[:organization_id] if event.payload[:organization_id]
+
+      # https://github.com/roidrage/lograge/pull/307
+      if event.respond_to?(:allocations)
+        result[:allocations] = event.allocations
+      end
+
+      result
+    end
+  end
+end

data/eivo-rails-api.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.push File.expand_path('lib', __dir__)
 
 Gem::Specification.new do |spec|
   spec.name          = 'eivo-rails-api'
-  spec.version       = '0.1.4'
+  spec.version       = '0.1.9'
   spec.authors       = ['Jonathan VUKOVICH-TRIBOUHARET']
   spec.email         = ['jonathan@eivo.co']
 
@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'kaminari'
 
+  spec.add_dependency 'lograge'
   spec.add_dependency 'sentry-raven'
 
   spec.add_development_dependency 'bundler'

data/lib/eivo-rails-api.rb

@@ -9,6 +9,7 @@ require 'fast_jsonapi'
 require 'kaminari'
 
 require_relative 'eivo-rails-api/engine'
+require_relative 'eivo-rails-api/formatter'
 
 module EIVO
   class << self

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

@@ -39,7 +39,7 @@ module EIVO
         # Highlight code that triggered database queries in logs.
         config.active_record.verbose_query_logs = true
 
-        # Raises error for missing translations
+        # Raises error for missing translations.
         # config.action_view.raise_on_missing_translations = true
 
         # Use an evented file watcher to asynchronously detect changes in source code,

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

@@ -16,7 +16,7 @@ module EIVO
         config.eager_load = true
 
         # Full error reports are disabled and caching is turned on.
-        config.consider_all_requests_local       = false
+        config.consider_all_requests_local = false
 
         # Ensures that a master key has been made available in either ENV["RAILS_MASTER_KEY"]
         # or in config/master.key. This key is used to decrypt credentials (and other encrypted files).
@@ -31,10 +31,11 @@ module EIVO
 
         # Specifies the header that your server uses for sending files.
         # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
-        config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+        # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
 
         # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
-        # config.force_ssl = true
+        config.force_ssl = true
+        config.ssl_options = { redirect: { exclude: ->(request) { request.path == '/status' } } }
 
         # Use the lowest log level to ensure availability of diagnostic information
         # when problems arise.
@@ -46,7 +47,7 @@ module EIVO
         # Use a different cache store in production.
         # config.cache_store = :mem_cache_store
 
-        # Use a real queuing backend for Active Job (and separate queues per environment)
+        # Use a real queuing backend for Active Job (and separate queues per environment).
         # config.active_job.queue_adapter     = :resque
         # config.active_job.queue_name_prefix = "example_#{Rails.env}"
 
@@ -65,9 +66,15 @@ module EIVO
         # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new 'app-name')
 
         if ENV['RAILS_LOG_TO_STDOUT'].present?
-          logger           = ActiveSupport::Logger.new(STDOUT)
+          # logger           = ActiveSupport::Logger.new(STDOUT)
+          # logger.formatter = config.log_formatter
+          # config.logger    = ActiveSupport::TaggedLogging.new(logger)
+
+          config.log_formatter = ::EIVO::Formatter.new
+          logger = ActiveSupport::Logger.new(STDOUT)
           logger.formatter = config.log_formatter
-          config.logger    = ActiveSupport::TaggedLogging.new(logger)
+          config.log_level = :info
+          config.logger    = logger
         end
 
         # Do not dump schema after migrations.

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

@@ -3,6 +3,10 @@
 module EIVO
   class Environment
     def self.test
+      # The test environment is used exclusively to run your application's
+      # test suite. You never need to work with it otherwise. Remember that
+      # your test database is "scratch space" for the test suite and is wiped
+      # and recreated between test runs. Don't rely on the data there!
       Rails.application.configure do
         # Settings specified here will take precedence over those in config/application.rb.
 
@@ -33,7 +37,7 @@ module EIVO
         # Print deprecation notices to the stderr.
         config.active_support.deprecation = :stderr
 
-        # Raises error for missing translations
+        # Raises error for missing translations.
         # config.action_view.raise_on_missing_translations = true
       end
     end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'multi_json'
+
+module EIVO
+  class Formatter < ::Logger::Formatter
+    def call(severity, timestamp, progname, message)
+      json = {
+        pid: $PROCESS_ID,
+        level: severity,
+        timestamp: timestamp.utc.iso8601(3),
+        message: message
+      }
+
+      if progname
+        json[:tag] = progname
+      end
+
+      if defined?(::Sidekiq)
+        context = ::Sidekiq::Context.current
+
+        if !context.empty?
+          json[:context] = context
+        end
+      end
+
+      MultiJson.dump(json) << "\n"
+    end
+  end
+end

data/lib/generators/eivo/templates/Gemfile

@@ -3,9 +3,9 @@
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby '2.6.3'
+ruby '2.7.1'
 
-gem 'rails', '~> 6.0.2', '>= 6.0.2.1'
+gem 'rails', '~> 6.0.3', '>= 6.0.3.1'
 gem 'pg', '>= 0.18', '< 2.0'
 gem 'puma', '~> 4.1'
 
@@ -14,7 +14,7 @@ group :development, :test do
 end
 
 group :development do
-  gem 'listen', '>= 3.0.5', '< 3.2'
+  gem 'listen', '~> 3.2'
 end
 
 gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]

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

@@ -9,7 +9,7 @@ environment ENV.fetch('RAILS_ENV') { 'development' }
 if %w[production staging].include?(ENV['RAILS_ENV'])
   pidfile 'tmp/pids/puma.pid'
   state_path 'tmp/pids/puma.state'
-  daemonize !ENV['RAILS_DAEMONIZE'].nil?
+  daemonize ENV.fetch('RAILS_DAEMONIZE') { false }
 
   if ENV['PORT']
     bind "tcp://0.0.0.0:#{ENV['PORT']}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eivo-rails-api
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.9
 platform: ruby
 authors:
 - Jonathan VUKOVICH-TRIBOUHARET
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-21 00:00:00.000000000 Z
+date: 2020-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: lograge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sentry-raven
   requirement: !ruby/object:Gem::Requirement
@@ -172,6 +186,7 @@ files:
 - app/controllers/eivo/concerns/resources.rb
 - app/controllers/eivo/status_controller.rb
 - bin/eivo
+- config/initializers/logger.rb
 - config/initializers/sentry.rb
 - config/routes.rb
 - eivo-rails-api.gemspec
@@ -182,6 +197,7 @@ files:
 - lib/eivo-rails-api/environments/production.rb
 - lib/eivo-rails-api/environments/staging.rb
 - lib/eivo-rails-api/environments/test.rb
+- lib/eivo-rails-api/formatter.rb
 - lib/generators/eivo/USAGE
 - lib/generators/eivo/install_generator.rb
 - lib/generators/eivo/templates/.env.example
@@ -217,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: EIVO Rails API