ocean-rails 7.0.5 → 7.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0838aa1ceee275569e027e38341000b6ef6d052b
-  data.tar.gz: 7a215e48eb6d666f8611123ad34265118b78c9dc
+  metadata.gz: 5d602214f6705ec4f0af21ed3adcc1ce63de746e
+  data.tar.gz: e99a2a9a8d7484a8da4b3dc7e52bddb5e65838df
 SHA512:
-  metadata.gz: 65e6de0a1effb6a88b960c991ddfcea0baa36fade0969edc36490a87acfd8df16515f870a3f38b452eb945dc7fe8439d4198da9d5751e0d18e2c8f1a3ab7c87c
-  data.tar.gz: cc138ac59d2dd8e2de3e03b43ee5fe09bbcba3a9ab82cb25d64d96d0a9d9d3e54cd968841f0a740a0946fd00783bf0432a21c3f1e154b72dc0aad4ac35cdce92
+  metadata.gz: 67ca3ce19054513e77fb2697668bc659a8813ddc90955573802e9ffff443c6266554701e86fe7116b268c396e35dc157730525e8d10c2c896eeacb41f9be8c5f
+  data.tar.gz: c19110d878f51a4fd403734ea90fe680a79181ff4aecec25718cf8f7f65e1e19a16bc9762ebac8b38edbc015a57efdd04170721d1b3391f61f9bac836aaece9b

data/config/initializers/_aws_config.rb

@@ -13,7 +13,7 @@ else
 
     # This is the tailored file, not under source control.
     f = File.join(Rails.root, "config/aws.yml")
-    
+
     # If the tailored file doesn't exist, and we're running in test mode
     # (which is the case under TeamCity), use the example file as-is.
     unless File.exists?(f)

data/config/initializers/_ocean_constants.rb

@@ -3,16 +3,16 @@
 # YOU SHOULD NEVER CHANGE THE CONTENTS OF THIS FILE.
 #
 # Backend developers should never need to override the value here.
-# The reason for this is that when  developing services locally, 
-# their tests run in isolation with all external calls mocked away, 
-# and thus it doesn't matter what URLs a service generates when 
+# The reason for this is that when  developing services locally,
+# their tests run in isolation with all external calls mocked away,
+# and thus it doesn't matter what URLs a service generates when
 # running tests locally on a developer's machine.
 #
 # If you're a frontend developer, however, the point of your testing
-# is to exercise the entire SOA and thus you need access to a
+# is to exercise multiple services and thus you need access to a
 # complete and fully functional system (which might or might not
 # make calls to partners' systems, such as for hotel bookings).
-# 
+#
 # Thus, if you are a frontend developer, you override the string
 # constant here to reflect the Ocean environment (dev, staging)
 # you wish to run your local tests against by defining the environment
@@ -21,11 +21,11 @@
 
 BASE_DOMAIN = "example.com" unless defined?(BASE_DOMAIN)  # For the Rails template generator
 
-OCEAN_API_HOST = (ENV['OCEAN_API_HOST'] || 
-                  (Rails.env == 'test' && "forbidden.#{BASE_DOMAIN}") || 
+OCEAN_API_HOST = (ENV['OCEAN_API_HOST'] ||
+                  (Rails.env == 'test' && "forbidden.#{BASE_DOMAIN}") ||
                   "dev-api.#{BASE_DOMAIN}"
                  ).sub("<default>", "dev")
-                
+
 OCEAN_API_URL = "https://#{OCEAN_API_HOST}"
 
 INTERNAL_OCEAN_API_URL = OCEAN_API_URL.sub("https://", "http://")

data/config/initializers/{_zeromq_logger.rb → _ocean_logger.rb}

@@ -1,4 +1,4 @@
-if Rails.env == 'production' && ENV['NO_ZEROMQ_LOGGING'].blank?
+if false # Rails.env == 'production'
 
   def remove_existing_log_subscriptions
     ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
@@ -84,10 +84,10 @@ if Rails.env == 'production' && ENV['NO_ZEROMQ_LOGGING'].blank?
     data[:remote_ip] = request.remote_ip
     data[:path] = request.filtered_path
 
-    if (ac = request.env["action_controller.instance"]) && 
-       (response = ac.response) && 
+    if (ac = request.env["action_controller.instance"]) &&
+       (response = ac.response) &&
        (body = response.body) &&
-       body.present? && 
+       body.present? &&
        body =~ /\A\{"_api_error"/
       data[:_api_error] = JSON.parse(body)['_api_error']
     end
@@ -97,7 +97,7 @@ if Rails.env == 'production' && ENV['NO_ZEROMQ_LOGGING'].blank?
     end
 
     ex = request.env["action_dispatch.exception"]
-    if ex 
+    if ex
       if data[:status] == 404
         data[:path] = request.env["REQUEST_PATH"]
       else

data/lib/generators/ocean_setup/templates/config.yml.example

@@ -3,7 +3,7 @@
 # You can use this file as a template: simply copy it, rename it and tailor its
 # contents. All data in this file will be used to define constants in your application
 # namespace. Please note that both config.yml and config.yml.example must exist.
-# 
+#
 # Any constants declared here can be overridden by corresponding environment variables
 # starting with OVERRIDE_. Thus, BASE_DOMAIN can be overridden by the environment
 # variable OVERRIDE_BASE_DOMAIN, and so forth. The API_PASSWORD receives special
@@ -32,12 +32,6 @@ BASE_DOMAIN:  example.com
 API_VERSIONS:
   _default: v1
 
-# This is the list of IP numbers for the Varnish instances. (For PURGE and BAN.)
-LOAD_BALANCERS: []
-
-# This is the list of IP numbers for the ZeroMQ log hosts. (Only used in production.)
-LOG_HOSTS: []
-
 # The Ocean environment
 OCEAN_ENV: master
 
@@ -58,10 +52,3 @@ test:
 
 
 production:
-  LOAD_BALANCERS:
-    - 1.1.1.1
-    - 2.2.2.2
-
-  LOG_HOSTS:
-    - 3.3.3.3
-    - 4.4.4.4

data/lib/ocean-rails.rb

@@ -7,11 +7,9 @@ require "ocean/ocean_resource_model" if defined? ActiveRecord || defined? OceanD
 require "ocean/ocean_resource_controller" if defined? ActionController
 require "ocean/ocean_application_controller"
 
-if ENV['RAILS_ENV'] == "production" && ENV['NO_ZEROMQ_LOGGING'].blank?
-  require "ocean/zero_log" 
-  require "ocean/zeromq_logger"
-  require "ocean/selective_rack_logger"
-end
+#if ENV['RAILS_ENV'] == "production"
+#  require "ocean/selective_rack_logger"
+#end
 
 require "ocean/api_remote_resource"
 
@@ -26,16 +24,16 @@ UUID_REGEX = /([0-9a-f]+-){4}[0-9a-f]+/
 
 module Ocean
 
-  if ENV['RAILS_ENV'] == "production" && ENV['NO_ZEROMQ_LOGGING'].blank?
+  if ENV['RAILS_ENV'] == "production"
     class Railtie < Rails::Railtie
       # Silence the /alive action
-      initializer "ocean.swap_logging_middleware" do |app|
-        app.middleware.swap Rails::Rack::Logger, SelectiveRackLogger
-      end
+      #initializer "ocean.swap_logging_middleware" do |app|
+      #  app.middleware.swap Rails::Rack::Logger, SelectiveRackLogger
+      #end
       # Make sure the generators use the gem's templates first
       config.app_generators do |g|
         g.templates.unshift File::expand_path('../templates', __FILE__)
-      end 
+      end
     end
   end
 
@@ -44,15 +42,15 @@ end
 
 #
 # For stubbing successful authorisation calls. Makes <tt>Api.permitted?</tt> return
-# the status, and a body containing a partial authentication containing the +user_id+ 
+# the status, and a body containing a partial authentication containing the +user_id+
 # and +creator_uri+ given by the parameters. It also allows the value of 'right' to
 # be specified: this will restrict all SQL queries accordingly.
 #
 def permit_with(status, user_id: "1-2-3-4-5", creator_uri: "https://api.example.com/v1/api_users/#{user_id}",
                         right: nil, group_names: [])
   allow(Api).to receive(:permitted?).
-    and_return(double(:status => status, 
-                      :body => {'authentication' => 
+    and_return(double(:status => status,
+                      :body => {'authentication' =>
                                  {'right' => right,
                                   'group_names' => group_names,
                                   '_links' => { 'creator' => {'href' => creator_uri,
@@ -66,7 +64,7 @@ end
 #
 def deny_with(status, *error_messages)
   allow(Api).to receive(:permitted?).
-    and_return(double(:status => status, 
+    and_return(double(:status => status,
                       :body => {'_api_error' => error_messages}))
 end
 
@@ -113,8 +111,8 @@ def hyperlinks(links={})
   result = {}
   links.each do |qi, val|
     next unless val.present?
-    result[qi.to_s] = { 
-               "href" => val.kind_of?(String) ? val : val[:href], 
+    result[qi.to_s] = {
+               "href" => val.kind_of?(String) ? val : val[:href],
                "type" => val.kind_of?(String) ? "application/json" : val[:type]
             }
   end
@@ -142,11 +140,11 @@ end
 # authorisation belongs to one or more of a list of Groups.
 #
 def member_of_group?(*names)
-  @group_names && @group_names.intersect?(names.to_set) 
+  @group_names && @group_names.intersect?(names.to_set)
 end
 
 #
-# Returns true if the ApiUser behind the current authorisation belongs 
+# Returns true if the ApiUser behind the current authorisation belongs
 # to the Ocean Group "Superusers".
 #
 def superuser?

data/lib/ocean/ocean_logger.rb

@@ -0,0 +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
+
+  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

data/lib/ocean/selective_rack_logger.rb

@@ -2,6 +2,8 @@
 # This custom Rack middleware is used to turn off logging of requests made to
 # <code>/alive</code>.
 #
+# NB: This file is no longer loaded. It needs to be updated before it works again.
+#
 class SelectiveRackLogger < Rails::Rack::Logger
 
   #

data/lib/ocean/version.rb

@@ -1,3 +1,3 @@
 module Ocean
-  VERSION = "7.0.5"
+  VERSION = "7.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ocean-rails
 version: !ruby/object:Gem::Version
-  version: 7.0.5
+  version: 7.0.6
 platform: ruby
 authors:
 - Peter Bengtson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-28 00:00:00.000000000 Z
+date: 2017-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -24,34 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: ffi
-  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: ffi-rzmq
-  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: rack-attack
   requirement: !ruby/object:Gem::Requirement
@@ -192,23 +164,27 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-description: "== Ocean\n\nOcean is an architecture for creating server-oriented architectures
-  (SOAs) in the cloud. \nIt consists of two separate parts which can be used separately
-  or in conjunction: Ocean and OceanFront.\n\nOcean is a complete and very scalable
-  back end solution for RESTful JSON web services and web applications, \nfeaturing
-  aggressive caching and full HTTP client abstraction. Ocean fully implements HATEOAS
-  principles, \nallowing the programming object model to move fully out onto the net,
-  while maintaining a very high degree \nof decoupling.\n\nOcean is also a development,
-  staging and deployment pipeline featuring continuous integration and testing in
-  a \nTDD and/or BDD environment. Ocean can be used for continuous deployment or for
-  scheduled releases. Front end tests \nare run in parallel using a matrix of operating
-  systems and browser types. The pipeline can very easily be extended \nwith new development
-  branches and quality assurance environments with automatic testing and deployment.\n\nOceanFront
-  is a cross-platform Javascript front end browser client library supporting all major
-  browsers and \nplatforms. OceanFront is object oriented, widget-based and HTML-less.\n\nTogether,
-  Ocean and OceanFront allow you to write front end code completely independent of
-  browser type and client \nOS, and back end code completely agnostic of whether it
-  is called by a client browser or another server system."
+description: |-
+  == Ocean
+
+  Ocean is an architecture for creating server-oriented architectures (SOAs) in the cloud.
+  It consists of two separate parts which can be used separately or in conjunction: Ocean and OceanFront.
+
+  Ocean is a complete and very scalable back end solution for RESTful JSON web services and web applications,
+  featuring aggressive caching and full HTTP client abstraction. Ocean fully implements HATEOAS principles,
+  allowing the programming object model to move fully out onto the net, while maintaining a very high degree
+  of decoupling.
+
+  Ocean is also a development, staging and deployment pipeline featuring continuous integration and testing in a
+  TDD and/or BDD environment. Ocean can be used for continuous deployment or for scheduled releases. Front end tests
+  are run in parallel using a matrix of operating systems and browser types. The pipeline can very easily be extended
+  with new development branches and quality assurance environments with automatic testing and deployment.
+
+  OceanFront is a cross-platform Javascript front end browser client library supporting all major browsers and
+  platforms. OceanFront is object oriented, widget-based and HTML-less.
+
+  Together, Ocean and OceanFront allow you to write front end code completely independent of browser type and client
+  OS, and back end code completely agnostic of whether it is called by a client browser or another server system.
 email:
 - peter@peterbengtson.com
 executables: []
@@ -223,7 +199,7 @@ files:
 - config/initializers/_api_constants.rb
 - config/initializers/_aws_config.rb
 - config/initializers/_ocean_constants.rb
-- config/initializers/_zeromq_logger.rb
+- config/initializers/_ocean_logger.rb
 - config/routes.rb
 - lib/generators/ocean_scaffold/USAGE
 - lib/generators/ocean_scaffold/ocean_scaffold_generator.rb
@@ -265,6 +241,7 @@ files:
 - lib/ocean/api_resource.rb
 - lib/ocean/engine.rb
 - lib/ocean/ocean_application_controller.rb
+- lib/ocean/ocean_logger.rb
 - lib/ocean/ocean_resource_controller.rb
 - lib/ocean/ocean_resource_model.rb
 - lib/ocean/selective_rack_logger.rb