hoodoo 1.0.2

data/lib/hoodoo/communicators/slow.rb

@@ -0,0 +1,84 @@
+########################################################################
+# File::    s;pw.rb
+# (C)::     Loyalty New Zealand 2014
+#
+# Purpose:: A slow communication-orientated object intended to be called
+#           asynchronously via Hoodoo::Communicators::Pool.
+# ----------------------------------------------------------------------
+#           15-Dec-2014 (ADH): Created.
+########################################################################
+
+module Hoodoo
+  module Communicators
+
+    # See Hoodoo::Communicators::Pool for details.
+    #
+    # A "slow communicator". Subclass this to create a class where instances
+    # are invoked via Hoodoo::Communicators::Slow#communicate with some
+    # parameter and, in response, they talk to some other piece of software to
+    # communicate information related to that parameter. The communication is
+    # expected to be slow and might involve blocking I/O network calls. An
+    # instance of the class is called from a Thread with this in mind.
+    #
+    # If you expect your communicator subclass to always perform very quickly,
+    # the Thread will introduce overhead that may actually slow down overall
+    # system performance. Avoid this by creating a subclass of
+    # Hoodoo::Communicators::Fast instead.
+    #
+    # Example: A communicator might be part of a logging scheme which talks to
+    # a network-based third party logging service. The parameter it expects
+    # would be a log message string.
+    #
+    # *IMPORTANT*: If you use ActiveRecord in a slow communicator class, beware
+    # that your writer runs in a ruby Thread. Unless you take steps to prevent
+    # it, ActiveRecord will implicitly check out a connection which stays with
+    # your Thread forever. This steals a connection from the pool. To prevent
+    # this issue, you must use the following pattern:
+    #
+    #     def communicate( object )
+    #       ActiveRecord::Base.connection_pool.with_connection do
+    #         # ...Any AciveRecord code goes here...
+    #       end
+    #     end
+    #
+    # Code within the +with_connection+ block uses a temporary connection from
+    # the pool which is returned once the block has finished processing. Even
+    # if exceptions occur within your ActiveRecord code, the connection is
+    # still correctly returned to the pool using the above approach.
+    #
+    class Slow
+
+      # Communicate (possibly slowly) with the piece of external software for
+      # which your subclass is designed. Subclasses _must_ implement this
+      # method. There is no need to call +super+ in your implementation.
+      #
+      # If a slow communicator can't keep up with the incoming message rate,
+      # messages may be dropped. Implement #dropped if you want to detect this
+      # condition.
+      #
+      # +object+:: Parameter sent by the communication pool, in response to
+      #            someone calling Hoodoo::Communicators::Pool#communicate
+      #            with that value.
+      #
+      def communicate( object )
+        raise( 'Subclasses must implement #communicate' )
+      end
+
+      # This method is called _before_ #communicate if messages have been
+      # dropped prior to the one which #communicate is about to report. Should
+      # you care, your subclass can implement this method and take whatever
+      # action it wants (e.g. log that messages were discarded).
+      #
+      # The default implementation does nothing; there is no need to call
+      # +super+ in custom implementations.
+      #
+      # +count+:: Number of messages dropped between the previous call to
+      #           #communicate and the call which is about to be made.
+      #
+      def dropped( count )
+        # This Implementation Intentionally Left Blank
+      end
+
+    end
+  end
+end

data/lib/hoodoo/data.rb

@@ -0,0 +1,51 @@
+########################################################################
+# File::    data.rb
+# (C)::     Loyalty New Zealand 2014
+#
+# Purpose:: Include common Type and Resource definitions.
+# ----------------------------------------------------------------------
+#           26-Jan-2015 (ADH): Split from top-level inclusion file.
+########################################################################
+
+module Hoodoo
+
+  # This module provides a namespace for definitions of data types and
+  # formal resources which an API uses and implements through its various
+  # supporting services.
+  #
+  module Data
+
+    # Module used as a namespace to collect classes that represent
+    # Resources documented by the your platform's API. Each is an
+    # Hoodoo::Presenters::Base subclass, so can be used to render
+    # and validate JSON data.
+    #
+    module Resources
+    end
+
+    # Module used as a namespace to collect classes that represent
+    # Types documented by your platform's API. Each is an
+    # Hoodoo::Presenters::Base subclass, so can be used to render
+    # and validate JSON data.
+    #
+    module Types
+    end
+  end
+end
+
+# Dependencies
+
+require 'hoodoo/presenters'
+
+# Ordering matters, due to dependencies where one type references another
+
+require 'hoodoo/data/types/error_primitive'
+require 'hoodoo/data/types/permissions'
+require 'hoodoo/data/types/permissions_defaults'
+require 'hoodoo/data/types/permissions_resources'
+require 'hoodoo/data/types/permissions_full'
+
+require 'hoodoo/data/resources/caller'
+require 'hoodoo/data/resources/errors'
+require 'hoodoo/data/resources/log'
+require 'hoodoo/data/resources/session'

data/lib/hoodoo/data/resources/caller.rb

@@ -0,0 +1,39 @@
+########################################################################
+# File::    caller.rb
+# (C)::     Loyalty New Zealand 2015
+#
+# Purpose:: Define documented Platform API Resource 'Caller'.
+# ----------------------------------------------------------------------
+#           30-Jan-2015 (RJS): Created.
+########################################################################
+
+module Hoodoo
+  module Data
+    module Resources
+
+      # Documented Platform API Resource 'Caller'.
+      #
+      class Caller < Hoodoo::Presenters::Base
+
+        schema do
+          internationalised
+
+          text :authentication_secret
+          text :name
+
+          hash :identity, :required => true do
+          end
+
+          object :permissions, :required => true do
+            type :PermissionsResources, :required => true
+          end
+
+          hash :scoping, :required => true do
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/hoodoo/data/resources/errors.rb

@@ -0,0 +1,28 @@
+########################################################################
+# File::    errors.rb
+# (C)::     Loyalty New Zealand 2014
+#
+# Purpose:: Define documented Platform API Resource 'Errors'.
+# ----------------------------------------------------------------------
+#           23-Sep-2014 (ADH): Created.
+########################################################################
+
+module Hoodoo
+  module Data
+    module Resources
+
+      # Documented Platform API Resource 'Errors'.
+      #
+      class Errors < Hoodoo::Presenters::Base
+
+        schema do
+          uuid :interaction_id
+          array :errors, :required => true do
+            type :ErrorPrimitive
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/hoodoo/data/resources/log.rb

@@ -0,0 +1,31 @@
+########################################################################
+# File::    log.rb
+# (C)::     Loyalty New Zealand 2014
+#
+# Purpose:: Define documented Platform API Resource 'Log'.
+# ----------------------------------------------------------------------
+#           25-Nov-2014 (ADH): Created.
+#           01-Dec-2014 (ADH): Renamed resource from LogEntry to Log.
+########################################################################
+
+module Hoodoo
+  module Data
+    module Resources
+
+      # Documented Platform API Resource 'Log'.
+      #
+      class Log < Hoodoo::Presenters::Base
+
+        schema do
+          text :level,     :required => true
+          text :component, :required => true
+          text :code,      :required => true
+
+          uuid :interaction_id
+          hash :data
+        end
+
+      end
+    end
+  end
+end

data/lib/hoodoo/data/resources/session.rb

@@ -0,0 +1,26 @@
+########################################################################
+# File::    session.rb
+# (C)::     Loyalty New Zealand 2015
+#
+# Purpose:: Define documented Platform API Resource 'Session'.
+# ----------------------------------------------------------------------
+#           30-Jan-2015 (RJS): Created.
+########################################################################
+
+module Hoodoo
+  module Data
+    module Resources
+
+      # Documented Platform API Resource 'Session'.
+      #
+      class Session < Hoodoo::Presenters::Base
+
+        schema do
+          uuid     :caller_id,  :required => true, :resource => :Caller
+          datetime :expires_at, :required => true
+        end
+
+      end
+    end
+  end
+end

data/lib/hoodoo/data/types/error_primitive.rb

@@ -0,0 +1,27 @@
+########################################################################
+# File::    error_primitive.rb
+# (C)::     Loyalty New Zealand 2014
+#
+# Purpose:: Define documented Platform API Type 'ErrorPrimitive'.
+# ----------------------------------------------------------------------
+#           22-Sep-2014 (ADH): Created.
+########################################################################
+
+module Hoodoo
+  module Data
+    module Types
+
+      # Documented Platform API Type 'ErrorPrimitive'.
+      #
+      class ErrorPrimitive < Hoodoo::Presenters::Base
+
+        schema do
+          text :code,     :required => true
+          text :message,  :required => true
+          text :reference
+        end
+
+      end
+    end
+  end
+end

data/lib/hoodoo/data/types/permissions.rb

@@ -0,0 +1,40 @@
+########################################################################
+# File::    permissions.rb
+# (C)::     Loyalty New Zealand 2015
+#
+# Purpose:: Define documented Platform API Type 'Permissions'.
+# ----------------------------------------------------------------------
+#           02-Feb-2015 (RJS): Created.
+########################################################################
+
+require 'hoodoo/services/middleware/middleware'
+require 'hoodoo/services/services/permissions'
+
+module Hoodoo
+  module Data
+    module Types
+
+      # Documented Platform API Type 'Permissions'.
+      #
+      class Permissions < Hoodoo::Presenters::Base
+
+        schema do
+
+          object :actions do
+            Hoodoo::Services::Middleware::ALLOWED_ACTIONS.each do | action |
+              enum action,
+                   :from     => Hoodoo::Services::Permissions::ALLOWED_POLICIES,
+                   :required => false
+            end
+          end
+
+          enum :else,
+               :from     => Hoodoo::Services::Permissions::ALLOWED_POLICIES,
+               :required => false
+
+        end
+
+      end
+    end
+  end
+end

data/lib/hoodoo/data/types/permissions_defaults.rb

@@ -0,0 +1,32 @@
+########################################################################
+# File::    permissions_defaults.rb
+# (C)::     Loyalty New Zealand 2015
+#
+# Purpose:: Define utility Type 'PermissionsDefaults'.
+# ----------------------------------------------------------------------
+#           02-Feb-2015 (RJS): Created.
+########################################################################
+
+require 'hoodoo/services/services/permissions'
+
+module Hoodoo
+  module Data
+    module Types
+
+      # Documented Platform API Type 'PermissionsDefaults'.
+      #
+      class PermissionsDefaults < Hoodoo::Presenters::Base
+
+        schema do
+
+          object :default,
+                 :default => { 'else' => Hoodoo::Services::Permissions::DENY } do
+            type :Permissions
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/hoodoo/data/types/permissions_full.rb

@@ -0,0 +1,28 @@
+########################################################################
+# File::    permissions_full.rb
+# (C)::     Loyalty New Zealand 2015
+#
+# Purpose:: Define utility Type 'PermissionsFull'.
+# ----------------------------------------------------------------------
+#           02-Feb-2015 (RJS): Created.
+########################################################################
+
+module Hoodoo
+  module Data
+    module Types
+
+      # Documented Platform API Type 'PermissionsFull'.
+      #
+      class PermissionsFull < Hoodoo::Presenters::Base
+
+        schema do
+
+          type :PermissionsResources
+          type :PermissionsDefaults
+
+        end
+
+      end
+    end
+  end
+end

data/lib/hoodoo/data/types/permissions_resources.rb

@@ -0,0 +1,31 @@
+########################################################################
+# File::    permissions_resources.rb
+# (C)::     Loyalty New Zealand 2015
+#
+# Purpose:: Define documented Platform API Type 'PermissionsResources'.
+# ----------------------------------------------------------------------
+#           30-Jan-2015 (RJS): Created.
+########################################################################
+
+module Hoodoo
+  module Data
+    module Types
+
+      # Documented Platform API Type 'PermissionsResources'.
+      #
+      class PermissionsResources < Hoodoo::Presenters::Base
+
+        schema do
+
+          hash :resources, :required => true do
+            keys do
+              type :Permissions
+            end
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/hoodoo/discovery.rb

@@ -0,0 +1,20 @@
+########################################################################
+# File::    discovery.rb
+# (C)::     Loyalty New Zealand 2014
+#
+# Purpose:: Include code that helps with finding resource endpoints.
+# ----------------------------------------------------------------------
+#           02-Mar-2015 (ADH): Created
+########################################################################
+
+require 'hoodoo/services/discovery/discovery'
+
+require 'hoodoo/services/discovery/results/for_http'
+require 'hoodoo/services/discovery/results/for_amqp'
+require 'hoodoo/services/discovery/results/for_local'
+require 'hoodoo/services/discovery/results/for_remote'
+
+require 'hoodoo/services/discovery/discoverers/by_convention'
+require 'hoodoo/services/discovery/discoverers/by_consul'
+require 'hoodoo/services/discovery/discoverers/by_drb/drb_server'
+require 'hoodoo/services/discovery/discoverers/by_drb/by_drb'