coney_island 0.11.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7cd453ef44683112b719619cb03fa5b998e1467c
-  data.tar.gz: 78093b8c5e994216d65cdbc9c47c31b3643a8fea
+  metadata.gz: 9a2c8ec4f4899725ab76ece82b50bb13c9bfc1cb
+  data.tar.gz: 4f2dc9c0ce8897c03f05f880f507d794fa87208c
 SHA512:
-  metadata.gz: 0144d626a9db36ff167fa8ddba08669138f4edbdf9e6f9cc42686d09626a2b2a303e7480579e88a379c72381a19de00d67db72404d95a999465a9fa34760de75
-  data.tar.gz: 87ad04598f5b5eaf43a2c885ea8e062c77a98c76159a677ea7560e890f9cbc2a454b91b88c9828aa921f723643dbafb36d90ffa3b4c6b97ecef9ed55b09cd49a
+  metadata.gz: 0ef8d2beed8302ee04a4be2d0affacfb6e2803ff2eaaae1fd9802235daf6125ffc5f77271c42434b195afe09f10d362cf3a12e839e182863b0522d9f270e6dc3
+  data.tar.gz: e9526c3ccf4ce3aa5e178d606db9d5679ddced9d21c35b55557435935614d3071b4bbcc1119ae1ec2dfa746d4ab2e2d4e7f5d62e3197f84a4bbb81f0ee653108

data/lib/coney_island.rb

@@ -2,8 +2,6 @@ module ConeyIsland
 
   ### BEGIN configuration
 
-  BG_TIMEOUT_SECONDS = 30
-
   def self.amqp_connection
     @connection
   end
@@ -120,6 +118,10 @@ module ConeyIsland
     end
   end
 
+  def self.default_settings
+    { work_queue: 'default', timeout: 30, delay: 0 }
+  end
+
 end
 
 require 'coney_island/notifiers/honeybadger_notifier'
@@ -128,4 +130,4 @@ require 'coney_island/job'
 require 'coney_island/submitter'
 require 'coney_island/job_argument_error'
 require 'coney_island/railtie' if defined?(Rails)
-require 'coney_island/performer'
+require 'coney_island/performer'

data/lib/coney_island/job.rb

@@ -22,11 +22,14 @@ module ConeyIsland
       @retry_on_exception = args['retry_on_exception']
 
       @metadata = metadata
-      if @klass.respond_to? :coney_island_settings
-        @delay ||= @klass.coney_island_settings[:delay]
-        @timeout ||= @klass.coney_island_settings[:timeout]
+
+      if @klass.included_modules.include?(Performer)
+        @delay   ||= @klass.get_coney_settings[:delay]
+        @timeout ||= @klass.get_coney_settings[:timeout]
       end
-      @timeout ||= BG_TIMEOUT_SECONDS
+
+      @timeout ||= ConeyIsland.default_settings[:timeout]
+
       if @instance_id.present?
         @object = @klass.find(@instance_id)
       elsif @singleton
@@ -107,4 +110,4 @@ module ConeyIsland
     end
 
   end
-end
+end

data/lib/coney_island/performer.rb

@@ -3,6 +3,8 @@ module ConeyIsland
 
     def self.included(base)
       base.extend ClassMethods
+      # http://apidock.com/rails/Class/class_attribute
+      base.class_attribute :coney_island_settings
     end
 
     def method_missing(method_name, *args)
@@ -21,16 +23,25 @@ module ConeyIsland
 
     module ClassMethods
 
-      def set_background_defaults(work_queue: nil, delay: nil, timeout: nil)
-        self.coney_island_settings[:work_queue] = work_queue
-        self.coney_island_settings[:delay] = delay
-        self.coney_island_settings[:timeout] = timeout
+      # Sets inheritable class defaults for ConeyIsland.
+      # Valid options:
+      #   :work_queue - use a named queue for this class.
+      #   :delay - Delay execution of the job on the worker. The delay value is
+      #     a number of seconds.
+      #   :timeout - Timeout the job with retry. The timeout value is a number
+      #     of seconds. By default ConeyIsland will retry 3 times before bailing
+      #     out.
+      def set_background_defaults(options = {})
+        options = options.dup.symbolize_keys.slice(:work_queue, :delay, :timeout)
+        self.coney_island_settings = get_coney_settings.merge(options)
       end
 
-      def coney_island_settings
-        @coney_island_settings ||= {}
+      def get_coney_settings
+        self.coney_island_settings ||= ConeyIsland.default_settings
       end
 
+      protected
+
       def method_missing(method_name, *args)
         method_str = method_name.to_s
         if method_str =~ /.*_async$/

data/lib/coney_island/submitter.rb

@@ -115,19 +115,22 @@ module ConeyIsland
         job_args['klass'] = klass_name
         job_args['method_name'] = method_name
         job_args.stringify_keys!
+        # Extract non job args
+        delay      = job_args.delete 'delay'
+        work_queue = job_args.delete 'work_queue'
+        # Set class defaults if they exist
+        if klass.included_modules.include?(Performer)
+          delay      ||= klass.get_coney_settings[:delay]
+          work_queue ||= klass.get_coney_settings[:work_queue]
+        end
+        # Set our own defaults if we still don't have any
+        work_queue ||= ConeyIsland.default_settings[:work_queue]
+        delay      ||= ConeyIsland.default_settings[:delay]
+
         if @run_inline
           job = ConeyIsland::Job.new(nil, job_args)
           job.handle_job
         else
-          work_queue = job_args.delete 'work_queue'
-          if klass.respond_to? :coney_island_settings
-            work_queue ||= klass.coney_island_settings[:work_queue]
-          end
-          work_queue ||= 'default'
-          delay = job_args['delay']
-          if klass.respond_to? :coney_island_settings
-            delay ||= klass.coney_island_settings[:delay]
-          end
           if delay && delay.to_i > 0
             @delay_queue[work_queue] ||= {}
             unless @delay_queue[work_queue][delay].present?

data/lib/coney_island/version.rb

@@ -1,3 +1,3 @@
 module ConeyIsland
-  VERSION = "0.11.0"
+  VERSION = "0.11.1"
 end

data/test/dummy/log/test.log

@@ -1,32 +1,64 @@
+undefined method `pry' for #<Binding:0x007f08a9ff6dc0>
+undefined method `pry' for #<Binding:0x007f08a9fd5120>
+undefined method `pry' for #<Binding:0x007f08a9fb4bf0>
 ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
 Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...
 ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
 Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...
+Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...
+ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
+Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...
+ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
+ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
+Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...
+Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...
+ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
+ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
+Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...
+Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...
+ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
+Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...
 ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
+ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
+Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...
 Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...
 ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
+ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
 Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...
+ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
 Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...
+Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...
+ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
 ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
 Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...
 ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
-undefined method `[]' for nil:NilClass
-undefined method `[]' for nil:NilClass
+Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...
+Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...
+ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
 ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
 Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...
-undefined method `[]' for nil:NilClass
-undefined method `[]' for nil:NilClass
-undefined method `[]' for nil:NilClass
+ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
 Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...
 ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
-undefined method `[]' for nil:NilClass
+Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...
+undefined method `publish' for nil:NilClass
+undefined method `publish' for nil:NilClass
 ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
 Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...
+undefined method `publish' for nil:NilClass
+undefined method `publish' for nil:NilClass
+undefined method `publish' for nil:NilClass
+undefined method `publish' for nil:NilClass
 Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...
 ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
+undefined method `publish' for nil:NilClass
+undefined method `publish' for nil:NilClass
 Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...
 ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
+mocked method :publish called with unexpected arguments ["{\"args\":[[]],\"klass\":\"TestModel\",\"method_name\":\"add_to_list\"}", {:routing_key=>"carousels.default"}]
+ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
 Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...
 ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
+Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...
 ConeyIsland::Submitter.submit! about to iterate over this many jobs: 1
 Failed to connecto to RabbitMQ Attempt #1 time(s), trying again in 0 seconds...

data/test/performer_test.rb

@@ -50,6 +50,34 @@ class PerformerTest < MiniTest::Test
       @exchange.verify
       ::PerformerTest.messages[:publish_hash][:routing_key].must_equal "carousels.boardwalk"
     end
+
+    it "inherits settings from a base class" do
+      @exchange = Minitest::Mock.new
+      def @exchange.publish(payload,options,&blk)
+        ::PerformerTest.messages[:publish_hash] = options
+      end
+      ConeyIsland::Submitter.stub(:handle_connection, nil) do
+        ConeyIsland::Submitter.stub(:exchange, @exchange) do
+          ConeyIsland::Submitter.stop_running_inline
+          ConeyIsland::Submitter.submit(MyInheritedPerformer, :perform, args: [], delay: 0)
+        end
+      end
+      @exchange.verify
+      ::PerformerTest.messages[:publish_hash][:routing_key].must_equal "carousels.this-other-queue"
+    end
+  end
+
+  describe "#get_coney_settings" do
+    it "inherits from the defaults" do
+      MySingleton.get_coney_settings.must_equal ConeyIsland.default_settings
+    end
+
+    it "is inheritable by subclasses" do
+      MyInheritedPerformer.get_coney_settings[:work_queue].must_equal 'this-other-queue'
+      # These come from the base class
+      MyInheritedPerformer.get_coney_settings[:timeout].must_equal 5
+      MyInheritedPerformer.get_coney_settings[:delay].must_equal 1
+    end
   end
 
   describe 'async methods' do
@@ -122,3 +150,6 @@ class MyPerformer
   end
 end
 
+class MyInheritedPerformer < MyPerformer
+  set_background_defaults work_queue: "this-other-queue"
+end

data/test/submitter_test.rb

@@ -33,5 +33,52 @@ class SubmitterTest < MiniTest::Test
         end
       end
     end
+
+    def setup_mock(klass, method, args, expected_work_queue, work_queue=nil)
+      exchange = Minitest::Mock.new
+      options = { args: args }
+      options.merge! work_queue: work_queue if work_queue
+      exchange.expect :publish, nil, [String,{routing_key: "carousels.#{expected_work_queue}"}]
+      ConeyIsland::Submitter.stub(:handle_connection, nil) do
+        ConeyIsland::Submitter.stub(:exchange, exchange) do
+          ConeyIsland::Submitter.stop_running_inline
+          ConeyIsland::Submitter.submit(klass, method, options)
+        end
+      end
+      exchange
+    end
+
+    describe '.submit' do
+
+      it "is aware of default_settings" do
+        @exchange = setup_mock TestModel, :add_to_list, [[]], ConeyIsland.default_settings[:work_queue]
+        @exchange.verify
+      end
+
+      it "overrides defaults if passed in the args" do
+        @exchange = setup_mock TestModel, :add_to_list, [[]], 'my-queue', 'my-queue'
+        @exchange.verify
+      end
+    end
+
+    describe "when submitting a performer" do
+      it "inherits the settings from the performer set_background_defaults" do
+        @exchange = setup_mock DummyPerformer, :perform, nil, 'foo'
+        @exchange.verify
+      end
+
+      it "still allows overriding the set_background_defaults" do
+        @exchange = setup_mock DummyPerformer, :perform, nil, 'bar', 'bar'
+        @exchange.verify
+      end
+    end
+
   end
-end
+end
+
+class DummyPerformer
+  include ConeyIsland::Performer
+  set_background_defaults work_queue: 'foo'
+
+  def perform; end
+end

data/test/test_helper.rb

@@ -34,7 +34,6 @@ class MiniTest::Test
 end
 
 class TestModel
-
   def self.add_to_list(array)
     array.push "Added one!"
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coney_island
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Eric Draut
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-04 00:00:00.000000000 Z
+date: 2015-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -180,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Want guaranteed delivery between your queue and your workers using ACKs?
@@ -188,44 +188,44 @@ summary: Want guaranteed delivery between your queue and your workers using ACKs
   features other background worker systems offer and you must have a ticket to ride
   at Coney Island.
 test_files:
-- test/coney_island_test.rb
-- test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/views/layouts/application.html.erb
-- test/dummy/bin/bundle
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
 - test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/assets.rb
+- test/dummy/config/routes.rb
+- test/dummy/config/secrets.yml
 - test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
 - test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/initializers/assets.rb
 - test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/cookies_serializer.rb
 - test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/initializers/filter_parameter_logging.rb
+- test/dummy/config/application.rb
 - test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/config/secrets.yml
-- test/dummy/config.ru
-- test/dummy/db/test.sqlite3
-- test/dummy/log/test.log
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/boot.rb
 - test/dummy/public/404.html
 - test/dummy/public/422.html
-- test/dummy/public/500.html
 - test/dummy/public/favicon.ico
-- test/dummy/Rakefile
+- test/dummy/public/500.html
+- test/dummy/db/test.sqlite3
 - test/dummy/README.rdoc
-- test/job_test.rb
-- test/performer_test.rb
+- test/dummy/bin/rails
+- test/dummy/bin/rake
+- test/dummy/bin/bundle
+- test/dummy/config.ru
+- test/dummy/log/test.log
+- test/dummy/Rakefile
 - test/submitter_test.rb
+- test/job_test.rb
 - test/test_helper.rb
 - test/worker_test.rb
+- test/performer_test.rb
+- test/coney_island_test.rb