hoodoo 1.19.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 686b88cd1d3e169957a22f9bbd1b2e0680143344
-  data.tar.gz: bbb4fe6fdfd02d447ca76c9972ede50aec481ba7
+  metadata.gz: dc0db0a009b321df89a2eb2e8a879c76bc875bb9
+  data.tar.gz: 29c85538f05080287181a67d3292b72f950f1872
 SHA512:
-  metadata.gz: 02bde4ca9622f8b7ce1524341c4e997d54717cc8282addfb86d44ad87333942a6caa6d97bf8d28cd860e40cf50f34cb8c97a90d7015249625dd711e950375658
-  data.tar.gz: c16e8ea17f27fb117816c6e1416ba65248e6d9e3b0b113e05f88f04499afb949d3a00c37412e5073385f1b6b5e3fd5b883173a110d5c9cf874ef717a2f442ea1
+  metadata.gz: 8519c31178c7439fc57888851eac50409e71c8225dfc0fd5421da540e370ab01ef92423f3a5753195efea9ca01f4954ee68d33d09fc083470a6ac5eade962f70
+  data.tar.gz: 45d7b58441e42e224624123c74f15f812880a074ea07648628f49741a3a3ba918456632b456a6b617b73d65935884ec16ad30e92176e19cc939af93fcc3437c0

data/lib/hoodoo/active/active_model/uuid_validator.rb

@@ -26,7 +26,6 @@ module Hoodoo
         # Example:
         #
         #     class SomeModel < ActiveRecord::Base
-        #
         #       validates :somefield, uuid: true
         #     end
         #

data/lib/hoodoo/active/active_record/dated.rb

@@ -243,7 +243,7 @@ module Hoodoo
           # Rationalise and convert the date time to UTC.
 
           date_time      = Hoodoo::Utilities.rationalise_datetime( date_time ).utc
-          safe_date_time = self.sanitize( date_time ) # ActiveRecord provides #sanitize
+          safe_date_time = self.connection.quoted_date( date_time )
 
           # Create strings that specify the required attributes escaped and
           # joined by commas for use in a SQL query, for both main and history
@@ -269,7 +269,7 @@ module Hoodoo
                 SELECT #{ safe_history_name_string },"effective_start","effective_end"
                 FROM #{ dating_table_name }
               ) AS u
-              WHERE "effective_start" <= #{ safe_date_time } AND ("effective_end" > #{ safe_date_time } OR "effective_end" IS NULL)
+              WHERE "effective_start" <= '#{ safe_date_time }' AND ("effective_end" > '#{ safe_date_time }' OR "effective_end" IS NULL)
             ) AS #{ self.table_name }
           }
 

data/lib/hoodoo/active/active_record/support.rb

@@ -70,7 +70,8 @@ module Hoodoo
         #
         mapping = {
           'created_after'  => Hoodoo::ActiveRecord::Finder::SearchHelper.cs_gt( :created_at ),
-          'created_before' => Hoodoo::ActiveRecord::Finder::SearchHelper.cs_lt( :created_at )
+          'created_before' => Hoodoo::ActiveRecord::Finder::SearchHelper.cs_lt( :created_at ),
+          'created_by'     => Hoodoo::ActiveRecord::Finder::SearchHelper.cs_match( :created_by )
         }
 
         if mapping.keys.length != ( mapping.keys | Hoodoo::Services::Middleware::FRAMEWORK_QUERY_DATA.keys ).length

data/lib/hoodoo/active/active_record/uuid.rb

@@ -38,7 +38,7 @@ module Hoodoo
       #       # ...
       #     end
       #
-      # +model+:: The ActiveRecord::Base descendant class that is including
+      # +model+:: The ActiveRecord::Base descendant that is including
       #           this module.
       #
       def self.included( model )
@@ -62,7 +62,7 @@ module Hoodoo
       #
       #     change_column :model_table_name, :id, :string, :limit => 32
       #
-      # +model+:: The ActiveRecord::Base descendant class that is including
+      # +model+:: The ActiveRecord::Base descendant that is including
       #           this module.
       #
       def self.instantiate( model )

data/lib/hoodoo/active/active_record/writer.rb

@@ -41,7 +41,7 @@ module Hoodoo
       #       # ...
       #     end
       #
-      # +model+:: The ActiveRecord::Base descendant class that is including
+      # +model+:: The ActiveRecord::Base descendant that is including
       #           this module.
       #
       def self.included( model )

data/lib/hoodoo/generator.rb

@@ -10,6 +10,7 @@
 
 require 'singleton'
 require 'fileutils'
+require 'pathname'
 
 module Hoodoo
 
@@ -45,25 +46,33 @@ module Hoodoo
 
       name = args.first
 
-      return show_usage if name == '-h' || name == '--help'
+      return show_usage   if name == '-h' || name == '--help' || name.nil? || name.empty?
+      return show_version if name == '-v' || name == '--version'
 
       return usage_and_warning( "SERVICE_NAME must match #{ NAME_REGEX.inspect }" ) if naughty_name?( name )
       return usage_and_warning( "'#{ name }' already exists" ) if File.exist?( "./#{ name }" )
 
-      git = args[ 2 ] if args[ 1 ] == '--from'
+      path  = args[ 2 ] if args[ 1 ] == '--path'
+      git   = args[ 2 ] if args[ 1 ] == '--from'
       git ||= 'git@github.com:LoyaltyNZ/service_shell.git'
 
-      return create_service( name, git )
+      return create_service( name, git, path )
     end
 
   private
 
-    def create_service( name, git )
-      if create_dir( name )               &&
-         clone_service_shell( name, git ) &&
-         remove_dot_git( name, git )      &&
-         replace_strings( name )
-
+    # Name of new service, mandatory GitHub repo path of the shell to start
+    # with, or override local filesystem path to copy from (pass "nil" to
+    # not do that).
+    #
+    def create_service( name, git, path )
+      ok = create_dir( name )
+      ok = clone_service_shell( name, git ) if ok &&   path.nil?
+      ok = copy_service_shell( name, path ) if ok && ! path.nil?
+      ok = remove_dot_git( name, git )      if ok
+      ok = replace_strings( name )          if ok
+
+      if ok
         puts "Success! ./#{name} created."
         Kernel::exit( KERNEL_EXIT_SUCCESS )
       else
@@ -81,6 +90,14 @@ module Hoodoo
       $?.to_i == 0
     end
 
+    def copy_service_shell( name, path )
+      source_path = Pathname.new( path ).to_s << '/.'
+      dest_path   = File.join( '.', name )
+
+      FileUtils.cp_r( source_path, dest_path, verbose: true )
+      $?.to_i == 0
+    end
+
     def remove_dot_git( name, git )
       git_folder = "./#{ name }/.git"
       git_config = "#{ git_folder }/config"
@@ -123,9 +140,32 @@ module Hoodoo
     end
 
     def show_usage
-      puts "Usage: hoodoo SERVICE_NAME [--from <git-repository>]"
-      puts "  e.g. hoodoo service_cron"
-      puts "       hoodoo service_person --from git@github.com:YOURNAME/service_shell_fork.git"
+      puts
+      puts "Creates a service shell at the PWD, customised with the given service name."
+      puts
+      puts "  hoodoo <service-name> [--from <git-repository> | --path <full-pathname>]"
+      puts
+      puts "For example:"
+      puts
+      puts "  hoodoo service_cron"
+      puts "  hoodoo service_person  --from git@github.com:YOURNAME/service_shell_fork.git"
+      puts "  hoodoo service_product --path /path/to/local/service/shell/container"
+      puts
+      puts "See also:"
+      puts
+      puts "  hoodoo --help    shows this help"
+      puts "  hoodoo --version shows the require-able gem version"
+      puts
+
+      Kernel::exit( KERNEL_EXIT_FAILURE )
+    end
+
+    def show_version
+      require 'hoodoo/version'
+
+      puts
+      puts "Accessible Hoodoo gem is #{ Hoodoo::VERSION } (#{ Hoodoo::DATE })"
+      puts
 
       Kernel::exit( KERNEL_EXIT_FAILURE )
     end

data/lib/hoodoo/monkey/patch/datadog_traced_amqp.rb

@@ -37,22 +37,27 @@ module Hoodoo
             # the response. It calls the original implementation via +super+.
             #
             # +http_message+:: Hash describing the message to send.
-            #
             # +full_uri+::     URI being sent to. This is somewhat meaningless
-            #                  when using AMQP but NewRelic requires it.
+            #                  when using AMQP but useful for analytics data.
             #
             def monkey_send_request( http_message, full_uri )
               amqp_response = nil
 
               Datadog.tracer.trace( 'alchemy.request' ) do |span|
-                span.service = 'alchemy'
+                span.service   = 'alchemy'
                 span.span_type = 'alchemy'
-                span.resource = http_message[ 'verb' ]
+                span.resource  = http_message[ 'verb' ]
                 span.set_tag( 'target.path', http_message[ 'path'] )
 
-                # Add Datadog trace IDs to the HTTP message
+                # Add Datadog trace IDs to the HTTP message. For compatibility
+                # with Hoodoo V1 services using a fork of DDTrace, we send both
+                # old headers ("X-DDTrace...") and new ("X-DataDog-...")
+
+                http_message[ 'headers' ][ 'X_DATADOG_TRACE_ID'        ] = span.trace_id.to_s
+                http_message[ 'headers' ][ 'X_DATADOG_PARENT_ID'       ] = span.span_id.to_s
+
                 http_message[ 'headers' ][ 'X_DDTRACE_PARENT_TRACE_ID' ] = span.trace_id.to_s
-                http_message[ 'headers' ][ 'X_DDTRACE_PARENT_SPAN_ID' ] = span.span_id.to_s
+                http_message[ 'headers' ][ 'X_DDTRACE_PARENT_SPAN_ID'  ] = span.span_id.to_s
 
                 amqp_response = super( http_message, full_uri )
               end

data/lib/hoodoo/monkey/patch/newrelic_middleware_analytics.rb

@@ -13,7 +13,10 @@
 ########################################################################
 
 begin
+
   # Raises LoadError if NewRelic is absent
+  #
+  require 'newrelic_rpm'
   require 'new_relic/agent/method_tracer'
 
   # Add a method tracer on the dispatch method so that the time spent
@@ -29,6 +32,7 @@ begin
       end
     end
   end
+
 rescue LoadError; end
 
 module Hoodoo
@@ -55,18 +59,19 @@ module Hoodoo
             # Add custom attributes to the NewRelic transaction. The original
             # implementation is called via +super+.
             #
-            # +interaction+:: Hoodoo::Services::Interaction describing the
-            #                 inbound request. The +interaction_id+,
-            #                 +rack_request+ and +session+ data is used (the
-            #                 latter being optional). If +target_interface+ and
-            #                 +requested_action+ are available, body data
-            #                 _might_ be logged according to secure log settings
-            #                 in the interface; if these values are unset, body
-            #                 data is _not_ logged.
+            # +interaction+:: Hoodoo::Services::Middleware::Interaction
+            #                 instance describing the inbound request. The
+            #                 +interaction_id+, +rack_request+ and +session+
+            #                 data is used (the latter being optional). If
+            #                 +target_interface+ and +requested_action+ are
+            #                 available, body data _might_ be logged according
+            #                 to secure log settings in the interface; if these
+            #                 values are unset, body data is _not_ logged.
             #
             def monkey_log_inbound_request( interaction )
 
               # Add custom attributes to the NewRelic transaction.
+              #
               ::NewRelic::Agent.add_custom_attributes(
                 {
                   :target_action => interaction.requested_action,
@@ -75,6 +80,7 @@ module Hoodoo
               )
 
               # Call the original logging method.
+              #
               super( interaction )
 
             end
@@ -85,16 +91,17 @@ module Hoodoo
         if defined?( Hoodoo::Services ) &&
            defined?( Hoodoo::Services::Middleware )
 
-          ::Hoodoo::Monkey.register(
+          Hoodoo::Monkey.register(
             target_unit:      Hoodoo::Services::Middleware,
             extension_module: Hoodoo::Monkey::Patch::NewRelicMiddlewareAnalytics
           )
 
-          ::Hoodoo::Monkey.enable( extension_module: Hoodoo::Monkey::Patch::NewRelicMiddlewareAnalytics )
+          Hoodoo::Monkey.enable( extension_module: Hoodoo::Monkey::Patch::NewRelicMiddlewareAnalytics )
         end
 
       rescue LoadError
         # No NewRelic => do nothing
+
       end
 
     end # module Patch

data/lib/hoodoo/monkey/patch/newrelic_traced_amqp.rb

@@ -16,7 +16,11 @@ module Hoodoo
     module Patch
 
       begin
-        require 'newrelic_rpm' # Raises LoadError if NewRelic is absent
+
+        # Raises LoadError if NewRelic is absent
+        #
+        require 'newrelic_rpm'
+        require 'new_relic/agent/transaction'
 
         # Wrap Hoodoo::Client::Endpoint::AMQP using NewRelic transaction
         # tracing so that over-queue inter-resource calls get connected
@@ -36,36 +40,47 @@ module Hoodoo
             # This adds headers to the request and extracts header data from
             # the response. It calls the original implementation via +super+.
             #
-            # +http_message+:: Hash describing the message to send.
+            # +http_message+:: Hash describing the message to send. See e.g.
+            #                  Hoodoo::Client::Endpoint::AMQP#do_amqp. Note
+            #                  that the header names inside this Hash are the
+            #                  mixed case, HTTP specification style ones like
+            #                  <tt>X-Interaction-ID</tt> and _not_ the Rack
+            #                  names like <tt>HTTP_X_INTERACTION_ID</tt>.
             #
             # +full_uri+::     URI being sent to. This is somewhat meaningless
             #                  when using AMQP but NewRelic requires it.
             #
             def monkey_send_request( http_message, full_uri )
-              amqp_response    = nil
-              newrelic_request = ::Hoodoo::Monkey::Patch::NewRelicTracedAMQP::AMQPNewRelicRequestWrapper.new(
+              amqp_response   = nil
+              wrapped_request = AlchemyFluxHTTPRequestWrapper.new(
                 http_message,
                 full_uri
               )
 
-              ::NewRelic::Agent::CrossAppTracing.tl_trace_http_request( newrelic_request ) do
+              segment = ::NewRelic::Agent::Transaction.start_external_request_segment(
+                wrapped_request.type,
+                wrapped_request.uri,
+                wrapped_request.method
+              )
+
+              begin
+                segment.add_request_headers( wrapped_request )
+
+                amqp_response = super( http_message, full_uri )
 
-                # Disable further tracing in request to avoid double counting
-                # if connection wasn't started (which calls request again).
+                # The outer block extracts required information from the
+                # object returned by this block. Need to wrap it match the
+                # expected interface.
                 #
-                ::NewRelic::Agent.disable_all_tracing do
+                wrapped_response = AlchemyFluxHTTPResponseWrapper.new(
+                  amqp_response
+                )
 
-                  amqp_response = super( http_message, full_uri )
+                segment.read_response_headers( wrapped_response )
 
-                  # The outer block extracts required information from the
-                  # object returned by this block. Need to wrap it match the
-                  # expected interface.
-                  #
-                  ::Hoodoo::Monkey::Patch::NewRelicTracedAMQP::AMQPNewRelicResponseWrapper.new(
-                    amqp_response
-                  )
+              ensure
+                segment.finish()
 
-                end
               end
 
               return amqp_response
@@ -75,12 +90,18 @@ module Hoodoo
           # Wrapper class for an AMQP request which conforms to the API that
           # NewRelic expects.
           #
-          class AMQPNewRelicRequestWrapper
+          class AlchemyFluxHTTPRequestWrapper
 
             # Wrap the Alchemy Flux +http_message+ aimed at the specified
             # +full_uri+.
             #
-            # +http_message+:: Hash describing the request for Alchemy Flux.
+            # +http_message+:: Hash describing the message to send. See e.g.
+            #                  Hoodoo::Client::Endpoint::AMQP#do_amqp. Note
+            #                  that the header names inside this Hash are the
+            #                  mixed case, HTTP specification style ones like
+            #                  <tt>X-Interaction-ID</tt> and _not_ the Rack
+            #                  names like <tt>HTTP_X_INTERACTION_ID</tt>.
+            #
             # +full_uri+::     Full target URI, as a String.
             #
             def initialize( http_message, full_uri )
@@ -91,13 +112,28 @@ module Hoodoo
             # String describing what kind of request this is.
             #
             def type
-              self.class.to_s()
+              'AlchemyFlux'
+            end
+
+            # String descrbing this request's intended host, according to the
+            # +Host+ header. May return +nil+ if none is found.
+            #
+            # See also: #host.
+            #
+            def host_from_header
+              begin
+                @http_message[ 'headers' ][ 'host' ] || @http_message[ 'headers' ][ 'Host' ]
+              rescue
+                nil
+              end
             end
 
             # String describing this request's intended host.
             #
+            # See also: #host_from_header.
+            #
             def host
-              @http_message[ 'host' ]
+              self.host_from_header() || @http_message[ 'host' ]
             end
 
             # String describing this request's HTTP verb (GET, POST and
@@ -127,10 +163,10 @@ module Hoodoo
               @http_message[ 'headers' ][ key ] = value
             end
 
-            # String describing the full request URI.
+            # URI object describing the full request URI.
             #
             def uri
-              @full_uri
+              URI.parse( @full_uri.to_s )
             end
 
           end
@@ -138,29 +174,30 @@ module Hoodoo
           # Wrapper class for an AMQP request which conforms to the API that
           # NewRelic expects.
           #
-          class AMQPNewRelicResponseWrapper
+          class AlchemyFluxHTTPResponseWrapper
 
             # The +response_hash+ to be wrapped.
             #
             # +response_hash+:: Hash describing the response returned from
-            #                   Alchemy Flux.
+            #                   Alchemy Flux. See that gem for details.
             #
             def initialize( response_hash )
               @response_hash = response_hash
             end
 
-            # If the NewRelic cross-app tracing header is the +key+, return the
-            # value of the header that matches that key. Otherwise look up the
-            # key like normal.
+            # Look up a key in the headers Hash first, but if absent try the
+            # top-level response Hash instead.
             #
             # +key+:: Hash key to look up.
             #
             def []( key )
-              if key == ::NewRelic::Agent::CrossAppTracing::NR_APPDATA_HEADER
-                @response_hash[ 'headers' ][ key ]
-              else
-                @response_hash[ key ]
-              end
+              @response_hash[ 'headers' ][ key ] || @response_hash[ key ]
+            end
+
+            # Return the HTTP headers for this response as a Hash.
+            #
+            def to_hash
+              @response_hash[ 'headers' ].dup()
             end
           end
         end
@@ -185,6 +222,7 @@ module Hoodoo
 
       rescue LoadError
         # No NewRelic => do nothing
+
       end
 
     end # module Patch