dispatch-rider 1.1.7 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cea57fa6cd7651b6a8efa077062611f5b37f4e9
-  data.tar.gz: 27f2f2e08bab6dd3bf30a8a5fe446a8e575fe266
+  metadata.gz: 1a1ca3958470feda02b927f94698654ef9f9e803
+  data.tar.gz: 27e28265cf7227e992c0f35f1eb0ff3d8fb79a4d
 SHA512:
-  metadata.gz: 0b0dda80035b75758d5a9c2525ae8d5192ec12f94679e3751df194788d665dcabc9fc7c3136388f61e3e741cd8312da99559baf580b22003ba30bc041978f5c2
-  data.tar.gz: 8571ffb00c7ffbb78959c37fca5f6ff802d766ac74e52450b85b6789a1ec8a8f66d2d9fcaa85c441230a509bec36a782a8ab34b3111cb46a9849bbbc5cd2301c
+  metadata.gz: 997865accff6ed5df9b8ae28804be792c0cb30e679024d13b6e59624a705aa17285dc3ed566a251d17c18e57b21124f1594ee6045dd882983e11f13112943623
+  data.tar.gz: 811ca64e0a2d53a7172428e956605057d3d02b8674d5dc2b8bf78829e1c426db1673058ab68179c498cdfc9e9e8142392dcb75f4363d5654e789addd7e620c15

data/lib/dispatch-rider.rb

@@ -36,3 +36,5 @@ require "dispatch-rider/demultiplexer"
 require "dispatch-rider/runner"
 require "dispatch-rider/publisher"
 require "dispatch-rider/subscriber"
+
+require "dispatch-rider/integrations/appsignal"

data/lib/dispatch-rider/integrations/appsignal.rb

@@ -0,0 +1,44 @@
+if defined? Appsignal
+  Appsignal.logger.info('Loading Dispatch Rider integration')
+
+  module DispatchRider
+    module Integrations
+      module Appsignal
+
+        def self.wrap_message(job, message)
+          begin
+            Appsignal::Transaction.create(SecureRandom.uuid, ENV.to_hash)
+
+            ActiveSupport::Notifications.instrument(
+              'perform_job.dispatch-rider',
+              :class => message.subject,
+              :method => 'handle',
+              :attempts => message.receive_count,
+              :queue => message.queue_name,
+              :queue_time => (Time.now.to_f - message.sent_at.to_f) * 1000
+            ) do
+              job.call
+            end
+          rescue Exception => exception
+            unless Appsignal.is_ignored_exception?(exception)
+              Appsignal::Transaction.current.add_exception(exception)
+            end
+            raise exception
+          ensure
+            Appsignal::Transaction.current.complete!
+          end
+        end
+
+      end
+    end
+  end
+
+  DispatchRider.config do |config|
+
+    config.around(:dispatch_message) do |job, message|
+      DispatchRider::Appsignal.wrap_message(job, message)
+    end
+
+  end
+
+end

data/lib/dispatch-rider/queue_services/aws_sqs/sqs_received_message.rb

@@ -27,7 +27,19 @@ module DispatchRider
         def return_to_queue
           extend_timeout(0)
         end
-        
+
+        def receive_count
+          @item.approximate_receive_count
+        end
+
+        def sent_at
+          @item.sent_timestamp
+        end
+
+        def queue_name
+          queue.arn.split(':').last
+        end
+
       end
     end
   end

data/lib/dispatch-rider/queue_services/file_system/fs_received_message.rb

@@ -16,7 +16,19 @@ module DispatchRider
         def return_to_queue
           queue.put_back(item)
         end
-        
+
+        def receive_count
+          1 # can't really check that in this service
+        end
+
+        def sent_at
+          @item.ctime
+        end
+
+        def queue_name
+          File.basename(File.dirname(@item.path))
+        end
+
       end
     end
   end

data/lib/dispatch-rider/queue_services/received_message.rb

@@ -20,6 +20,19 @@ module DispatchRider
       def return_to_queue
         raise NotImplementedError
       end
+
+      def receive_count
+        raise NotImplementedError
+      end
+
+      def sent_at
+        raise NotImplementedError
+      end
+
+      def queue_name
+        raise NotImplementedError
+      end
+
     end
   end
 end

data/lib/dispatch-rider/version.rb

@@ -1,4 +1,4 @@
 # This file specifies the current version of the gem.
 module DispatchRider
-  VERSION = "1.1.7"
+  VERSION = "1.2.0"
 end

data/lib/generators/dispatch_rider/job/USAGE

@@ -0,0 +1,13 @@
+Description:
+    Generates a Publisher/Handler pair
+
+Example:
+    rails generate dispatch_rider:job some_job
+
+    This will create:
+        app/publishers/some_job_publisher.rb
+        app/handlers/some_job.rb
+
+    As well as its tests (currently only supporting rspec):
+        spec/publishers/some_job_publisher_spec.rb
+        spec/handlers/some_job_spec.rb

data/lib/generators/dispatch_rider/job/dispatch_job_generator.rb

@@ -0,0 +1,60 @@
+class DispatchJob < Rails::Generators::Base
+
+  class Publisher < Rails::Generators::Base
+    source_root File.expand_path('../templates/publisher', __FILE__)
+    argument :handler_name, type: :string, required: true
+    argument :publisher_name, type: :string, required: true
+
+    class Rspec < Rails::Generators::Base
+      source_root File.expand_path('../templates/publisher', __FILE__)
+      argument :handler_name, type: :string, required: true
+      argument :publisher_name, type: :string, required: true
+
+      def generate_publisher_spec
+        template "publisher_spec.rb.erb", "spec/publishers/#{publisher_name}_spec.rb"
+      end
+    end
+
+    def generate_publisher
+      template "publisher.rb.erb", "app/publishers/#{publisher_name}.rb"
+    end
+
+    hook_for :test_framework, in: "dispatch_job:publisher"
+  end
+
+  class Handler < Rails::Generators::Base
+    source_root File.expand_path('../templates/handler', __FILE__)
+    argument :handler_name, type: :string, required: true
+
+    class Rspec < Rails::Generators::Base
+      source_root File.expand_path('../templates/handler', __FILE__)
+      argument :handler_name, type: :string, required: true
+
+      def generate_handler_spec
+        template "handler_spec.rb.erb", "spec/handlers/#{handler_name}_spec.rb"
+      end
+    end
+
+    def generate_handler
+      template "handler.rb.erb", "app/handlers/#{handler_name}.rb"
+    end
+
+    hook_for :test_framework, in: "dispatch_job:handler"
+  end
+
+  # source_root File.expand_path('../templates', __FILE__)
+
+  class_option :publisher, default: :publisher, hide: true
+  class_option :handler, default: :handler, hide: true
+
+  argument :handler_name, type: :string
+
+  hook_for :publisher do |publisher|
+    invoke publisher, [handler_name, handler_name.underscore + "_publisher"]
+  end
+
+  hook_for :handler do |handler|
+    invoke handler, [handler_name]
+  end
+
+end

data/lib/generators/dispatch_rider/job/templates/handler/handler.rb.erb

@@ -0,0 +1,9 @@
+class <%= handler_name.classify %> < DispatchRider::Handlers::Base
+
+  # @param [Hash] attributes
+  def process(attributes)
+    #TODO: do something useful with this message
+    raise NotImplementedError
+  end
+
+end

data/lib/generators/dispatch_rider/job/templates/handler/handler_spec.rb.erb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe <%= handler_name.classify %> do
+
+  subject(:handler) { described_class.new }
+
+  # TODO: set some attributes
+  let(:attributes) { {} }
+
+  describe "#process" do
+    it "does something useful" do
+      handler.process attributes
+      # TODO: assert something
+      fail "not implemented"
+    end
+  end
+
+end

data/lib/generators/dispatch_rider/job/templates/publisher/publisher.rb.erb

@@ -0,0 +1,14 @@
+class <%= publisher_name.classify %> < DispatchRider::Publisher::Base
+
+  # TODO: set the correct destination
+  destinations [:some_destination]
+  subject "<%= handler_name.underscore %>"
+
+  # TODO: accept some custom arguments here
+  # @return [<%= handler_name.classify %>]
+  def self.publish
+    # TODO: pass them to the message as hash arguments
+    new.publish({})
+  end
+
+end

data/lib/generators/dispatch_rider/job/templates/publisher/publisher_spec.rb.erb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe <%= publisher_name.classify %> do
+
+  describe '.process' do
+
+    # TODO: set up whatever needs to be set up
+
+    it "publishes the task" do
+      # TODO: assert the correct arguments
+      described_class.any_instance.should_receive(:publish).with()
+      # TODO: pass the right arguments
+      described_class.publish()
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dispatch-rider
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 1.2.0
 platform: ruby
 authors:
 - Suman Mukherjee
@@ -11,132 +11,132 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-06 00:00:00.000000000 Z
+date: 2014-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   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: activemodel
   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: daemons
   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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: travis-lint
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: debugger
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Messaging system that is customizable based on which queueing system
@@ -152,6 +152,8 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
+- LICENSE.txt
+- README.md
 - lib/dispatch-rider.rb
 - lib/dispatch-rider/callbacks.rb
 - lib/dispatch-rider/callbacks/access.rb
@@ -166,6 +168,7 @@ files:
 - lib/dispatch-rider/handlers/base.rb
 - lib/dispatch-rider/handlers/inheritance_tracking.rb
 - lib/dispatch-rider/handlers/named_process.rb
+- lib/dispatch-rider/integrations/appsignal.rb
 - lib/dispatch-rider/message.rb
 - lib/dispatch-rider/notification_services.rb
 - lib/dispatch-rider/notification_services/aws_sns.rb
@@ -204,8 +207,12 @@ files:
 - lib/generators/dispatch_rider/install/USAGE
 - lib/generators/dispatch_rider/install/install_generator.rb
 - lib/generators/dispatch_rider/install/templates/script/dispatch_rider
-- LICENSE.txt
-- README.md
+- lib/generators/dispatch_rider/job/USAGE
+- lib/generators/dispatch_rider/job/dispatch_job_generator.rb
+- lib/generators/dispatch_rider/job/templates/handler/handler.rb.erb
+- lib/generators/dispatch_rider/job/templates/handler/handler_spec.rb.erb
+- lib/generators/dispatch_rider/job/templates/publisher/publisher.rb.erb
+- lib/generators/dispatch_rider/job/templates/publisher/publisher_spec.rb.erb
 homepage: https://github.com/payrollhero/dispatch-rider
 licenses:
 - MIT
@@ -216,17 +223,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: Messaging system based on the reactor patter. You can publish messages to