refried 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28d7c580a23420a626958fc23c26305ef78f116d
-  data.tar.gz: 40dddd36c986edd1e76b9dd40b3c5ea4d9798077
+  metadata.gz: 5614a3de2476ba8b564bb1cce35e2580d5be4af8
+  data.tar.gz: 2a6a85e530fcc4f15176d820cbbb8f74da616b5d
 SHA512:
-  metadata.gz: 14b379e31b5a890012f61434bf6e5c09d6d8db3216cdcb2517a06e5ea6e0f7229cc3ebc4703c7cec96d34377200701d5afca6a6fc9eb28156544b9b435ef4b38
-  data.tar.gz: 2c1d025bdcc3eef07acccd4d2130d1da830d9f517e57c26d1bc7f8b089b28da5efa3192b13732f3edef3dc9207020539247b650b22ec57a161af8d38889266f1
+  metadata.gz: fb38fe056924ad13c94d28418c2c5992509273f096dcb9e50a610ffc2d3f15d39e86128fec96eb0e1afe6d800c247d97884d16bf2bb6b79f91657cdb80ced3e9
+  data.tar.gz: 013058133907e862d01f91f16d24289839974b4f287df202af1c37c091fb4969a3adf639c0fbefeb978377dd8186052d21959d25d2edda145da005801c1beb10

data/lib/refried/configuration.rb

@@ -0,0 +1,31 @@
+module Refried
+  # The Refried Configuration class
+  #  based in general on the configuration approach in https://github.com/nesquena/backburner MIT license
+  class Configuration
+    PRIORITY_LABELS = { :high => 0, :medium => 100, :low => 200 }
+
+    attr_accessor :beanstalk_url      # beanstalk url connection
+    attr_accessor :tube_namespace     # namespace prefix for every queue
+    attr_accessor :default_priority   # default job priority
+    attr_accessor :respond_timeout    # default job timeout
+    attr_accessor :on_error           # error handler
+    attr_accessor :max_job_retries    # max job retries
+    attr_accessor :retry_delay        # retry delay in seconds
+    attr_accessor :logger             # logger
+    attr_accessor :priority_labels    # priority labels
+    attr_accessor :reserve_timeout    # duration to wait to reserve on a single server
+
+    def initialize
+      @beanstalk_url     = "beanstalk://localhost"
+      @tube_namespace    = "refried.queue"
+      @default_priority  = 65536
+      @respond_timeout   = 120
+      @on_error          = nil
+      @max_job_retries   = 0
+      @retry_delay       = 5
+      @logger            = nil
+      @priority_labels   = PRIORITY_LABELS
+      @reserve_timeout   = nil
+    end
+  end # Configuration
+end # Refried

data/lib/refried/puter.rb

@@ -0,0 +1,132 @@
+require 'beaneater'
+
+module Refried
+  module Puter
+    module ActsAsPuter
+      def acts_as_puter
+        send :include, InstanceMethods
+        send :extend, ClassMethods
+      end
+    end
+
+    module ClassMethods
+      SUPPORTED_MODES = [:simple, :type_map, :alias_map]
+
+      # Set the mode of function that the Puter should follow
+      #
+      # @param mode [Symbol] which mapping mode the puter uses, `:simple`, `:type_map` or `:alias_map`
+      def puter_mode=(mode)
+        unless SUPPORTED_MODES.include? mode
+          raise ArgumentError, "Unsupported mode for acts as puter."
+        end
+        @puter_mode = mode
+      end
+
+      # Get the current mapping mode of the Puter
+      #
+      # @return [Symbol] the current mapping mode of the Puter
+      def puter_mode
+        @puter_mode ||= :simple
+      end
+    end
+
+    module InstanceMethods
+
+      def puter_tube_alias_map
+        @puter_tube_alias_map ||= Hash.new
+      end
+      alias_method :alias_map, :puter_tube_alias_map
+
+      def puter_tube_alias_map=(alias_map)
+        @puter_tube_alias_map = alias_map
+      end
+
+      # I want to support a number of types of mappings
+      # 1. in the simple case the tube name should be associated with the Puter's class
+      # 2. a map of item types to tube names
+      # 3. a map of tube aliases to tube names (this corresponds to how ESIndexer & funding override workers will use the gem)
+      def put (item, tube_alias = nil)
+        self.attempt_to_log "Puter#put message received. #{item} and tube_alias #{tube_alias}"
+        puts tube_alias
+        tube = self.tube(alias: tube_alias)
+        payload = self.generate_message item
+        r = tube.put payload
+        self.attempt_to_log "Puter#put message queued containing #{item}, result = #{r}"
+        r
+      end
+
+      # Get the Beaneater Tube object for the current class, the item, and the alias
+
+      # If the puter mode is :type_map the :type key should contain the class of the item being put as a symbol, which should be a key in the puter_tube_type_map
+      # If the puter mode is :alias_map the value for the :alias key is the tube_alias,
+      #   the tube_alias is used as the key in the puter_tube_alias_map whose value is the tube's name
+
+      def tube (selectors = {})
+        unless self.locatable? selectors
+          raise ArgumentError, 'Selectors to #tube were unexpected for current puter_mode'
+        end
+        case self.class.puter_mode
+          when :simple
+            tube_name = self.class.to_s.downcase
+          when :alias_map
+            tube_alias = selectors[:alias]
+            tube_name = self.alias_map[tube_alias]
+          else
+            raise ArgumentError, 'Invalid puter mode detected in the #tube method.'
+        end
+        tube_name ||= nil
+        tube ||= Refried.tubes.find tube_name
+      end
+
+      # This method converts the payload object into a format for injection
+      #  into the queue
+      #
+      # @param payload the object that should be converted into a message (it must respond to the to_json method)
+      # @return [String] the appropriately serialized representation of the payload
+      def generate_message(payload)
+        if payload.is_a? Fixnum
+          payload.to_json
+        else
+          if payload.nil?
+            nil
+          elsif payload.respond_to?(:empty?) && payload.empty?
+            nil
+          elsif payload.respond_to? :to_edible
+            payload.to_edible
+          else
+            # Not sure that this is the appropriate implementation, perhaps to_s is better
+            payload.to_json
+          end
+        end
+      end
+
+    protected
+      def locatable? (selectors = {})
+        case self.class.puter_mode
+          when :simple
+            selectors.nil? || selectors.is_a?(Hash) && selectors.count == 0
+          when :alias_map
+            if selectors.is_a? Hash
+              l = selectors.has_key?(:alias) && selectors[:alias].is_a?(Symbol) && self.alias_map.has_key?(selectors[:alias])
+            end
+            l ||= false
+          else
+            false
+        end
+      end
+
+      def attempt_to_log (message)
+        begin
+          logger.info message
+        rescue => e
+          puts "Failed to access logger, message that should have been logged = #{message}"
+        end
+      end
+    end
+
+    def self.included(base)
+      base.extend(ActsAsPuter)
+    end
+  end
+  Object.instance_eval { include Puter }
+end

data/lib/refried/tubes.rb

@@ -0,0 +1,14 @@
+module Refried
+  class Tubes
+    # TODO: connect to configuration
+    def initialize
+      @pool ||= Beaneater::Pool.new(['localhost:11300 '])
+      @tubes = @pool.tubes
+    end
+
+    def find(canonical_tube_name)
+      @tubes.find canonical_tube_name
+    end
+
+  end
+end

data/lib/refried.rb

@@ -1,5 +1,35 @@
-class Refried
-  def self.beans
-    puts "BAKING BEANS!"
+require 'beaneater'
+require 'refried/configuration'
+require 'refried/tubes'
+require 'refried/puter'
+
+# Refried core API methods
+#  based in part on the design of backburner (https://github.com/nesquena/backburner MIT license)
+module Refried
+  class << self
+
+    # Allows the user to set configuration options
+    #  by yielding the configuration block
+    #
+    # @param block [Block]
+    # @return [Configuration] the current configuration object
+    def configure(&block)
+      yield(configuration)
+      configuration
+    end
+
+    # Returns the singleton class's configuration object
+    #
+    # @return [Configuration] the current configuration object
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Returns the Beaneater::Tubes object, which is the collection of all the Beaneater Tube objects
+    #
+    # @return [Beaneater::Tubes] the collection of Beaneater Tubes
+    def tubes
+      @tubes ||= Tubes.new
+    end
   end
 end

metadata

@@ -1,15 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: refried
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - caldwecr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-30 00:00:00.000000000 Z
-dependencies: []
+date: 2014-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: beaneater
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: An enhancement
 email: caldwecr@gmail.com
 executables: []
@@ -17,6 +51,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/refried.rb
+- lib/refried/configuration.rb
+- lib/refried/puter.rb
+- lib/refried/tubes.rb
 homepage: http://rubygems.org/gems/refried
 licenses: []
 metadata: {}