ocean-rails 7.2.2 → 7.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d703c1b9eeb742809031eb05de80b67d9d1095605741b5846f1dfe3ec35ccdf
-  data.tar.gz: 38ec1bbd1abe2ca487ac2beae2de3e28e65560d9489b8a892fd212bddeec59f6
+  metadata.gz: 5b60d92cbf6714865555d363a2f998bc41dcadf121749c522020c9def0b06cc9
+  data.tar.gz: 06c7bf20258981bc6b0614fbe795dad279a75be510478c00318ad1790eab198a
 SHA512:
-  metadata.gz: d2dbfc032c6b1774136e3a86e8bd073a6a5c820f8808dd3ee3eee561e68d0b7f0e8db439e16906d0a5f02a6da7645911afb20ff6c7eff259503d1502dbd5bb70
-  data.tar.gz: 9fbd5f15038821e33c3c2545a9738281cccaeb28b666616661212f75799ca54874722128adcb1c42c4657805f1e5ef2343e63a9f12efe2ed8508fa4eba6ef278
+  metadata.gz: 3ffb4b655ddcfac4444d1fe93515b616ad6865180d6a7605c570b4831321f361071670c362255b49afc952023483d2f2c664c3e170d34676a4b2e84cf0808921
+  data.tar.gz: 36f770a9f7fa754662e669e5cdda7aba1e42e0f60e31b5e49867f02dda5d22d563d0d78274a6fad6440f78498bfb5e54b4f95677edfe010e66631571c1856801

data/config/initializers/_api_constants.rb

@@ -1,49 +1,36 @@
-# The is the example file
-ef = File.join(Rails.root, "config/config.yml.example")
+f = File.join(Rails.root, "config/config.yml")
 
-# Only load config data if there is an example file
-if File.exists?(ef)
-
-  # This is the tailored file, not under source control.
-  f = File.join(Rails.root, "config/config.yml")
-
-  # If the tailored file doesn't exist, and we're running under TeamCity, 
-  # use the example file as-is.
-  unless File.exists?(f)
-    f = ENV['OCEAN_API_HOST'] ? ef : false
-  end
+# If the tailored file doesn't exist, and we're running under TeamCity,
+# use the example file as-is.
+unless File.exists?(f)
+  f = ENV['OCEAN_API_HOST'] ? ef : false
+end
 
-  # If there is a file to process, do so
-  if f
-    cfg = YAML.load(ERB.new(File.read(f)).result)
-    cfg.merge! cfg.fetch(Rails.env, {}) if cfg.fetch(Rails.env, {})
-    cfg.each do |k, v|
-      next if k =~ /[a-z]/
-      override = ENV["OVERRIDE_#{k}"]
-      if override && override != ""
-        master, staging = override.split(',')
-        if staging.present? && k == "API_PASSWORD"
-          pw = (ENV['GIT_BRANCH'] == 'staging' ? staging : master)
-          eval "#{k} = #{pw.inspect}"
-        else
-          eval "#{k} = #{override.inspect}"
-        end
+# If there is a file to process, do so
+if f
+  cfg = YAML.load(ERB.new(File.read(f)).result)
+  cfg.merge! cfg.fetch(Rails.env, {}) if cfg.fetch(Rails.env, {})
+  cfg.each do |k, v|
+    next if k =~ /[a-z]/
+    override = ENV["OVERRIDE_#{k}"]
+    if override && override != ""
+      master, staging = override.split(',')
+      if staging.present? && k == "API_PASSWORD"
+        pw = (ENV['GIT_BRANCH'] == 'staging' ? staging : master)
+        eval "#{k} = #{pw.inspect}"
       else
-        eval "#{k} = #{v.inspect}"
+        eval "#{k} = #{override.inspect}"
       end
+    else
+      eval "#{k} = #{v.inspect}"
     end
-  else
-    # Otherwise print an error message and abort.
-    puts
-    puts "-----------------------------------------------------------------------"
-    puts "Constant definition file missing. Please copy config/config.yml.example"
-    puts "to config/config.yml and tailor its contents to suit your dev setup."
-    puts
-    puts "NB: config.yml is excluded from git version control as it will contain"
-    puts "    data private to your Ocean system."
-    puts "-----------------------------------------------------------------------"
-    puts
-    abort
   end
-
+else
+  # Otherwise print an error message and abort.
+  puts
+  puts "-----------------------------------------------------------------------"
+  puts "Constant definition file missing."
+  puts "-----------------------------------------------------------------------"
+  puts
+  abort
 end

data/config/initializers/_ocean_logger.rb

@@ -1,127 +1,127 @@
-if false # Rails.env == 'production'
-
-  def remove_existing_log_subscriptions
-    ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
-      case subscriber
-      when ActionView::LogSubscriber
-        unsubscribe(:action_view, subscriber)
-      when ActionController::LogSubscriber
-        unsubscribe(:action_controller, subscriber)
-      end
-    end
-  end
-
-  def unsubscribe(component, subscriber)
-    events = subscriber.public_methods(false).reject{ |method| method.to_s == 'call' }
-    events.each do |event|
-      ActiveSupport::Notifications.notifier.listeners_for("#{event}.#{component}").each do |listener|
-        if listener.instance_variable_get('@delegate') == subscriber
-          ActiveSupport::Notifications.unsubscribe listener
-        end
-      end
-    end
-  end
-
-  remove_existing_log_subscriptions
-
-
-  INTERNAL_PARAMS = %w(controller action format _method only_path)
-
-  ActiveSupport::Notifications.subscribe "process_action.action_controller" do |name, started, finished, unique_id, payload|
-    path = payload[:path]
-    if path  != '/alive'
-
-      runtime = finished - started
-      param_method = payload[:params]['_method']
-      method = param_method ? param_method.upcase : payload[:method]
-      status = compute_status(payload)
-      params = payload[:params].except(*INTERNAL_PARAMS)
-
-      data = {
-        timestamp:    (started.utc.to_f * 1000).to_i,
-        method:       method,
-        status:       status,
-        runtime:      (runtime * 1000).round(0),
-        view_runtime: (payload[:view_runtime] || 0).round(0),
-        db_runtime:   (payload[:db_runtime] || 0).round(0)
-      }
-      data[:params] = params if params.present?
-      data[:filter] = Thread.current[:filter] if Thread.current[:filter]
-      data[:token] = Thread.current[:x_api_token] if Thread.current[:x_api_token].present?
-      data[:username] = Thread.current[:username] if Thread.current[:username].present?
-      data[:metadata] = Thread.current[:metadata] if Thread.current[:metadata].present?
-
-      Thread.current[:logdata] = data
-      Thread.current[:filter] = nil
-      Thread.current[:x_api_token] = nil
-      Thread.current[:username] = nil
-      Thread.current[:cache_control] = nil
-      Thread.current[:metadata] = nil
-    end
-  end
-
-  def compute_status payload
-    status = payload[:status]
-    if status.nil? && payload[:exception].present?
-      exception_class_name = payload[:exception].first
-      status = ActionDispatch::ExceptionWrapper.status_code_for_exception(exception_class_name)
-    end
-    status
-  end
-
-
-  ActiveSupport::Notifications.subscribe "halted_callback.action_controller" do |*args|
-    data = args.extract_options!
-    Thread.current[:filter] = data[:filter]
-  end
-
-
-  ActiveSupport::Notifications.subscribe 'request.action_dispatch' do |*args|
-    x = args.extract_options!
-    request = x[:request]
-
-    data = Thread.current[:logdata] || {}
-    data[:remote_ip] = request.remote_ip
-    data[:path] = request.filtered_path
-
-    if (ac = request.env["action_controller.instance"]) &&
-       (response = ac.response) &&
-       (body = response.body) &&
-       body.present? &&
-       body =~ /\A\{"_api_error"/
-      data[:_api_error] = JSON.parse(body)['_api_error']
-    end
-
-    if response && response.headers['Cache-Control']
-      data[:cache_control] = response.headers['Cache-Control']
-    end
-
-    ex = request.env["action_dispatch.exception"]
-    if ex
-      if data[:status] == 404
-        data[:path] = request.env["REQUEST_PATH"]
-      else
-        # We might want to send an email here - exceptions in production
-        # should be taken seriously
-        data[:exception_message] = ex.message
-        data[:exception_backtrace] = ex.backtrace.to_json
-      end
-    end
-
-    if (data[:status] || 0) >= 500
-      Rails.logger.fatal data
-    elsif (data[:status] || 0) >= 400
-      Rails.logger.error data
-    else
-      Rails.logger.info data
-    end
-  end
-
-
-  # Announce us
-  Rails.logger.info "Initialising Rails process"
-
-  # Make sure we log our exit
-  at_exit { Rails.logger.info "Exiting Rails process" }
-
-end
+# if false # Rails.env == 'production'
+#
+#   def remove_existing_log_subscriptions
+#     ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
+#       case subscriber
+#       when ActionView::LogSubscriber
+#         unsubscribe(:action_view, subscriber)
+#       when ActionController::LogSubscriber
+#         unsubscribe(:action_controller, subscriber)
+#       end
+#     end
+#   end
+#
+#   def unsubscribe(component, subscriber)
+#     events = subscriber.public_methods(false).reject{ |method| method.to_s == 'call' }
+#     events.each do |event|
+#       ActiveSupport::Notifications.notifier.listeners_for("#{event}.#{component}").each do |listener|
+#         if listener.instance_variable_get('@delegate') == subscriber
+#           ActiveSupport::Notifications.unsubscribe listener
+#         end
+#       end
+#     end
+#   end
+#
+#   remove_existing_log_subscriptions
+#
+#
+#   INTERNAL_PARAMS = %w(controller action format _method only_path)
+#
+#   ActiveSupport::Notifications.subscribe "process_action.action_controller" do |name, started, finished, unique_id, payload|
+#     path = payload[:path]
+#     if path  != '/alive'
+#
+#       runtime = finished - started
+#       param_method = payload[:params]['_method']
+#       method = param_method ? param_method.upcase : payload[:method]
+#       status = compute_status(payload)
+#       params = payload[:params].except(*INTERNAL_PARAMS)
+#
+#       data = {
+#         timestamp:    (started.utc.to_f * 1000).to_i,
+#         method:       method,
+#         status:       status,
+#         runtime:      (runtime * 1000).round(0),
+#         view_runtime: (payload[:view_runtime] || 0).round(0),
+#         db_runtime:   (payload[:db_runtime] || 0).round(0)
+#       }
+#       data[:params] = params if params.present?
+#       data[:filter] = Thread.current[:filter] if Thread.current[:filter]
+#       data[:token] = Thread.current[:x_api_token] if Thread.current[:x_api_token].present?
+#       data[:username] = Thread.current[:username] if Thread.current[:username].present?
+#       data[:metadata] = Thread.current[:metadata] if Thread.current[:metadata].present?
+#
+#       Thread.current[:logdata] = data
+#       Thread.current[:filter] = nil
+#       Thread.current[:x_api_token] = nil
+#       Thread.current[:username] = nil
+#       Thread.current[:cache_control] = nil
+#       Thread.current[:metadata] = nil
+#     end
+#   end
+#
+#   def compute_status payload
+#     status = payload[:status]
+#     if status.nil? && payload[:exception].present?
+#       exception_class_name = payload[:exception].first
+#       status = ActionDispatch::ExceptionWrapper.status_code_for_exception(exception_class_name)
+#     end
+#     status
+#   end
+#
+#
+#   ActiveSupport::Notifications.subscribe "halted_callback.action_controller" do |*args|
+#     data = args.extract_options!
+#     Thread.current[:filter] = data[:filter]
+#   end
+#
+#
+#   ActiveSupport::Notifications.subscribe 'request.action_dispatch' do |*args|
+#     x = args.extract_options!
+#     request = x[:request]
+#
+#     data = Thread.current[:logdata] || {}
+#     data[:remote_ip] = request.remote_ip
+#     data[:path] = request.filtered_path
+#
+#     if (ac = request.env["action_controller.instance"]) &&
+#        (response = ac.response) &&
+#        (body = response.body) &&
+#        body.present? &&
+#        body =~ /\A\{"_api_error"/
+#       data[:_api_error] = JSON.parse(body)['_api_error']
+#     end
+#
+#     if response && response.headers['Cache-Control']
+#       data[:cache_control] = response.headers['Cache-Control']
+#     end
+#
+#     ex = request.env["action_dispatch.exception"]
+#     if ex
+#       if data[:status] == 404
+#         data[:path] = request.env["REQUEST_PATH"]
+#       else
+#         # We might want to send an email here - exceptions in production
+#         # should be taken seriously
+#         data[:exception_message] = ex.message
+#         data[:exception_backtrace] = ex.backtrace.to_json
+#       end
+#     end
+#
+#     if (data[:status] || 0) >= 500
+#       Rails.logger.fatal data
+#     elsif (data[:status] || 0) >= 400
+#       Rails.logger.error data
+#     else
+#       Rails.logger.info data
+#     end
+#   end
+#
+#
+#   # Announce us
+#   Rails.logger.info "Initialising Rails process"
+#
+#   # Make sure we log our exit
+#   at_exit { Rails.logger.info "Exiting Rails process" }
+#
+# end

data/lib/ocean/ocean_logger.rb

@@ -1,114 +1,114 @@
+# #
+# # This class is a drop-in replacement for the standard Rails logger. It
+# # implements enough of the Logger interface to allow it to override the
+# # standard logger.
+# #
+# class OceanLogger
 #
-# This class is a drop-in replacement for the standard Rails logger. It
-# implements enough of the Logger interface to allow it to override the
-# standard logger.
-#
-class OceanLogger
-
-  attr_accessor :level, :formatter
-
-  #
-  # Obtains the IP of the current process, initialises the @logger object
-  # by instantiating a ZeroLog object which then is used to set up the
-  # log data sender.
-  #
-  def initialize
-    super
-    # Get info about our environment
-    @ip = Socket.ip_address_list.detect{|intf| intf.ipv4_private?}.getnameinfo[0]
-    # Set up the logger
-    @logger = ZeroLog.new "/tmp/sub_push_#{Process.pid}", @log_hosts
-    @formatter = ::Logger::Formatter.new
-  end
-
-  #
-  # Utility function which returns true if the current log level is +DEBUG+ or lower.
-  #
-  def debug?() @level <= 0; end
-
-  #
-  # Utility function which returns true if the current log level is +INFO+ or lower.
-  #
-  def info?()  @level <= 1; end
-
-  #
-  # Utility function which returns true if the current log level is +WARN+ or lower.
-  #
-  def warn?()  @level <= 2; end
-
-  #
-  # Utility function which returns true if the current log level is +ERROR+ or lower.
-  #
-  def error?() @level <= 3; end
-
-  #
-  # Utility function which returns true if the current log level is +FATAL+ or lower.
-  #
-  def fatal?() @level <= 4; end
-
-
-  #
-  # This is the core method to add new log messages to the Rails log. It does nothing
-  # if the level of the message is lower than the current log level, or if the message
-  # is blank. Otherwise it creates a JSON log message as a hash, with data for the
-  # following keys:
-  #
-  # +timestamp+: The time in milliseconds since the start of the Unix epoch.
-  #
-  # +ip+:        The IP of the logging entity.
-  #
-  # +pid+:       The Process ID of the logging process.
-  #
-  # +service+:   The name of the service.
-  #
-  # +level+:     The log level of the message (0=debug, 1=info, 2=warn, etc).
-  #
-  # +msg+:       The log message itself.
-  #
-  def add(level, msg)
-    return true if level < @level
-    return true if msg.blank?
-    # Compensate for bug in Rails 4.2.x
-    return true if msg =~ /Couldn't find template for digesting/
-    data = { ip:        @ip,
-             pid:       Process.pid,
-             service:   APP_NAME,
-             level:     level
-           }
-    data[:token] = Thread.current[:x_api_token] if Thread.current[:x_api_token].present?
-    data[:username] = Thread.current[:username] if Thread.current[:username].present?
-    data[:msg] = msg if msg.is_a?(String)
-    data[:timestamp] = (Time.now.utc.to_f * 1000).to_i unless data[:timestamp]
-    data[:metadata] = Thread.current[:metadata] if Thread.current[:metadata].present?
-    data = data.merge msg if msg.is_a?(Hash)
-    @logger.log data
-    true
-  end
-
-
-  def debug(*args)
-    return if args.blank?
-    add 0, *args
-  end
-
-  def info(*args)
-    return if args.blank?
-    add 1, *args
-  end
-
-  def warn(*args)
-    return if args.blank?
-    add 2, *args
-  end
-
-  def error(*args)
-    return if args.blank?
-    add 3, *args
-  end
-
-  def fatal(*args)
-    return if args.blank?
-    add 4, *args
-  end
-
-end
+#   attr_accessor :level, :formatter
+#
+#   #
+#   # Obtains the IP of the current process, initialises the @logger object
+#   # by instantiating a ZeroLog object which then is used to set up the
+#   # log data sender.
+#   #
+#   def initialize
+#     super
+#     # Get info about our environment
+#     @ip = Socket.ip_address_list.detect{|intf| intf.ipv4_private?}.getnameinfo[0]
+#     # Set up the logger
+#     @logger = ZeroLog.new "/tmp/sub_push_#{Process.pid}", @log_hosts
+#     @formatter = ::Logger::Formatter.new
+#   end
+#
+#   #
+#   # Utility function which returns true if the current log level is +DEBUG+ or lower.
+#   #
+#   def debug?() @level <= 0; end
+#
+#   #
+#   # Utility function which returns true if the current log level is +INFO+ or lower.
+#   #
+#   def info?()  @level <= 1; end
+#
+#   #
+#   # Utility function which returns true if the current log level is +WARN+ or lower.
+#   #
+#   def warn?()  @level <= 2; end
+#
+#   #
+#   # Utility function which returns true if the current log level is +ERROR+ or lower.
+#   #
+#   def error?() @level <= 3; end
+#
+#   #
+#   # Utility function which returns true if the current log level is +FATAL+ or lower.
+#   #
+#   def fatal?() @level <= 4; end
+#
+#
+#   #
+#   # This is the core method to add new log messages to the Rails log. It does nothing
+#   # if the level of the message is lower than the current log level, or if the message
+#   # is blank. Otherwise it creates a JSON log message as a hash, with data for the
+#   # following keys:
+#   #
+#   # +timestamp+: The time in milliseconds since the start of the Unix epoch.
+#   #
+#   # +ip+:        The IP of the logging entity.
+#   #
+#   # +pid+:       The Process ID of the logging process.
+#   #
+#   # +service+:   The name of the service.
+#   #
+#   # +level+:     The log level of the message (0=debug, 1=info, 2=warn, etc).
+#   #
+#   # +msg+:       The log message itself.
+#   #
+#   def add(level, msg)
+#     return true if level < @level
+#     return true if msg.blank?
+#     # Compensate for bug in Rails 4.2.x
+#     return true if msg =~ /Couldn't find template for digesting/
+#     data = { ip:        @ip,
+#              pid:       Process.pid,
+#              service:   APP_NAME,
+#              level:     level
+#            }
+#     data[:token] = Thread.current[:x_api_token] if Thread.current[:x_api_token].present?
+#     data[:username] = Thread.current[:username] if Thread.current[:username].present?
+#     data[:msg] = msg if msg.is_a?(String)
+#     data[:timestamp] = (Time.now.utc.to_f * 1000).to_i unless data[:timestamp]
+#     data[:metadata] = Thread.current[:metadata] if Thread.current[:metadata].present?
+#     data = data.merge msg if msg.is_a?(Hash)
+#     @logger.log data
+#     true
+#   end
+#
+#
+#   def debug(*args)
+#     return if args.blank?
+#     add 0, *args
+#   end
+#
+#   def info(*args)
+#     return if args.blank?
+#     add 1, *args
+#   end
+#
+#   def warn(*args)
+#     return if args.blank?
+#     add 2, *args
+#   end
+#
+#   def error(*args)
+#     return if args.blank?
+#     add 3, *args
+#   end
+#
+#   def fatal(*args)
+#     return if args.blank?
+#     add 4, *args
+#   end
+#
+# end