superbolt-future 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 676eb05c0e3b2a66b6fca1cc5689a6d92dd25828
+  data.tar.gz: ed89000383e1cdfcc2885231cd7d49925a44cb88
+SHA512:
+  metadata.gz: 79dc225081883ab2a13070ee81b1e11a858f161a8b2f7142798b9365ba2b20c5772d254981e288d982e31c78eb87a6a8a2cacf9281865419a5d45fa3c1b1e05e
+  data.tar.gz: c5ddcf9bba3a1f5f95a14ba18c680e8ff7b113e5cd62cab8d8b616214c3bcc4f8eecc25cf52311cdd34aa2b95ae80ed5a3261fc149ce89ed6da10666da2c4f9d

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1,6 @@
+rvm_install_on_use_flag=1
+rvm_trust_rvmrcs_flag=1
+rvm_gemset_create_on_use_flag=1
+
+rvm use 2.0.0@superbolt-future --create
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in superbolt-future.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 socialchorus
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Superbolt::Future
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'superbolt-future'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install superbolt-future
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/superbolt/future/app.rb

@@ -0,0 +1,14 @@
+module Superbolt
+  module Future
+    class App < ::Superbolt::App
+      def name
+        worker_name = super
+        worker_name + ".future"
+      end
+
+      def runner_class
+        Superbolt::Future::Runner::Requeue
+      end
+    end
+  end
+end

data/lib/superbolt/future/facade.rb

@@ -0,0 +1,5 @@
+module Superbolt
+  def self.message(args={})
+    Superbolt::Future::Messenger.new(args)
+  end
+end

data/lib/superbolt/future/messenger.rb

@@ -0,0 +1,31 @@
+# This is an extension of the existing Superbolt Messenger class
+module Superbolt
+  module Future
+    class Messenger < ::Superbolt::Messenger
+      attr_accessor :in_future
+
+      def future!(time, opts=nil)
+        future(time)
+        data(opts)
+        queue.push(message)
+      end
+
+      def future(time)
+        attr_chainer(:in_future, time)
+      end
+
+      def destination_name
+        "#{super}#{future_suffix}"
+      end
+
+      def future_suffix
+        in_future ? '.future' : ''
+      end
+
+      def message 
+        hash = super
+        hash.merge({future: in_future})
+      end
+    end
+  end
+end

data/lib/superbolt/future/runner/requeue.rb

@@ -0,0 +1,54 @@
+module Superbolt
+  module Future
+    module Runner
+      class Requeue < ::Superbolt::Runner::AckOne
+        def subscribe
+          queue.subscribe(ack: true) do |delivery_info, metadata, payload|
+            message = Superbolt::IncomingMessage.new(delivery_info, payload, channel)
+            process(message)
+          end
+        end
+
+        def process(message)
+          parsed_message = message.parse
+          requeue(parsed_message)
+
+          message.ack
+
+          block.call(parsed_message, logger) if block
+          sleep sleep_time
+        rescue Exception => e
+          on_error(message.parse, e)
+        end
+
+        def sleep_time
+          0.5 # should this be dynamic?
+        end
+
+        def requeue(parsed_message)
+          time = parsed_message["future"]
+          q = if Time.parse(time) > Time.now
+            logger.info("Requeueing message to #{time}")
+            future_queue 
+          else
+            logger.info("Sending message #{parsed_message} to worker queue")
+            worker_queue
+          end
+          q.push(parsed_message)
+        end
+
+        def future_queue
+          Superbolt::Queue.new(queue.name)
+        end
+
+        def worker_queue
+          Superbolt::Queue.new(worker_queue_name)
+        end
+
+        def worker_queue_name
+          queue.name.sub(/\.future$/, '')
+        end
+      end
+    end
+  end
+end

data/lib/superbolt/future/tasks.rb

@@ -0,0 +1,3 @@
+require 'superbolt-future'
+
+load "#{File.dirname(__FILE__)}/../tasks/superbolt_future.rake"

data/lib/superbolt/future/version.rb

@@ -0,0 +1,5 @@
+module Superbolt
+  module Future
+    VERSION = "0.1.0"
+  end
+end

data/lib/superbolt/future.rb

@@ -0,0 +1,8 @@
+require 'superbolt'
+
+require "superbolt/future/version"
+require "superbolt/future/messenger"
+require "superbolt/future/facade"
+require "superbolt/future/app"
+require "superbolt/future/runner/requeue"
+

data/lib/tasks/superbolt_future.rake

@@ -0,0 +1,7 @@
+# assumes an environment task that sets up your app environment
+desc "spins up process that looks at future queue and moves to the right queue at the right time"
+task :superbolt_future => :environment do
+  Superbolt::Future::App.new(Superbolt.app_name).run do |message, logger|
+    logger.info('.')
+  end
+end

data/spec/app_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe Superbolt::App do 
+  let(:app) {
+    Superbolt::Future::App.new(name, {logger: logger})
+  } 
+
+  before do
+    future_queue.clear
+    worker_queue.clear
+    Superbolt.env = env
+  end
+
+  after do
+    future_queue.clear
+    worker_queue.clear
+  end
+
+  let(:env)         { 'test' }
+  let(:name)        { 'superbolt' }
+  let(:logger)      { Logger.new('/dev/null') }
+
+  let(:worker_queue) { Superbolt::Queue.new("#{name}_#{env}") }
+  let(:future_queue) { Superbolt::Queue.new("#{name}_#{env}.future") }
+  let(:quit_queue)   { Superbolt::Queue.new("#{name}_#{env}.future.quit") }
+
+  context 'when the future message key is in the past' do
+    let(:message) { 
+      {
+        origin: 'origin',
+        event: 'do_something',
+        arguments: {
+          hello: 'developers'
+        },
+        future: Time.now - 3600
+      }
+    }
+
+    it "moves the message from the future queue to the worker queue" do
+      future_queue.push(message)
+      
+      app.run do |arguments|
+        quit_queue.push({message: 'just because'})
+      end
+
+      worker_queue.size.should == 1
+      future_queue.size.should == 0
+    end
+  end
+
+  context 'when the time is in the future' do
+    let(:message) { 
+      {
+        origin: 'origin',
+        event: 'do_something',
+        arguments: {
+          hello: 'developers'
+        },
+        future: Time.now + 3600
+      }
+    }
+
+    it "puts the message back on the future queue" do
+      future_queue.push(message)
+      
+      app.run do |arguments|
+        quit_queue.push({message: 'just because'})
+      end
+
+      worker_queue.size.should == 0
+      future_queue.size.should > 1 # there is a race condition with the quit queue, everything async
+    end
+  end
+end

data/spec/facade_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Superbolt, '.message' do
+  it "should use our Future::Messenger" do
+    Superbolt::Future::Messenger.should_receive(:new).and_return(double)
+    Superbolt.message
+  end
+end

data/spec/messenger_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Superbolt::Future::Messenger, 'extensions' do
+  let(:messenger) {
+    Superbolt::Future::Messenger.new
+  }
+
+  let(:time) { Time.now + 20 }
+
+  before do
+    Superbolt.env = 'staging'
+  end
+
+  after do
+    Superbolt::Queue.new('advocato_staging.future').clear
+    Superbolt::Queue.new('advocato_staging').clear
+  end
+
+  context 'scheduling in future' do
+    describe '#future!' do
+      it "will send it to the future queue" do
+        messenger.to('advocato').future!(time)
+        Superbolt::Queue.new('advocato_staging.future').size.should == 1
+      end
+
+      it "will send along data if it gets any" do
+        messenger.to('advocato').future!(time, {hello: 'world'})
+        messenger.data.should == {hello: 'world'}
+      end
+
+      it "will not override data if it exists" do
+        messenger.to('advocato').data({what: 'is up?'}).future!(time)
+        messenger.data.should == { what: 'is up?'}
+      end
+
+      it "adds a key to the message about the desired future time" do
+        messenger.to('advocato').future!(time)
+        messenger.message[:future].should == time
+      end
+    end
+
+    describe '#future' do
+      it "won't send it immediately" do
+        messenger.to('advocato').future(time)
+        Superbolt::Queue.new('advocato_staging.future').size == 0
+        Superbolt::Queue.new('advocato_staging').size == 0
+      end
+
+      it "will send it to the right queue once used" do
+        messenger.to('advocato').future(time).send!({hello: 'Deepti!'})
+        Superbolt::Queue.new('advocato_staging.future').size == 1
+      end
+
+      it "adds a key to the message about the desired future time" do
+        messenger.to('advocato').future(time)
+        messenger.message[:future].should == time
+      end
+    end
+  end
+
+  describe 'normal usage' do
+    it "will send it to the normal queue" do
+      messenger.to('advocato').send!
+      Superbolt::Queue.new('advocato_staging').size.should == 1
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require_relative '../lib/superbolt/future'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/superbolt-future.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'superbolt/future/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "superbolt-future"
+  spec.version       = Superbolt::Future::VERSION
+  spec.authors       = ["Deepti Anand", "Kane Baccigalupi", "SocialCoder's at SocialChorus"]
+  spec.email         = ["developers@socialchorus.com"]
+  spec.description   = %q{Perform superbolt tasks at a later time; timed job queues for the cloud}
+  spec.summary       = %q{Perform superbolt tasks at a later time; timed job queues for the cloud}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'superbolt'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: superbolt-future
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Deepti Anand
+- Kane Baccigalupi
+- SocialCoder's at SocialChorus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: superbolt
+  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: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: rspec
+  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: Perform superbolt tasks at a later time; timed job queues for the cloud
+email:
+- developers@socialchorus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/superbolt/future.rb
+- lib/superbolt/future/app.rb
+- lib/superbolt/future/facade.rb
+- lib/superbolt/future/messenger.rb
+- lib/superbolt/future/runner/requeue.rb
+- lib/superbolt/future/tasks.rb
+- lib/superbolt/future/version.rb
+- lib/tasks/superbolt_future.rake
+- spec/app_spec.rb
+- spec/facade_spec.rb
+- spec/messenger_spec.rb
+- spec/spec_helper.rb
+- superbolt-future.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.3
+signing_key: 
+specification_version: 4
+summary: Perform superbolt tasks at a later time; timed job queues for the cloud
+test_files:
+- spec/app_spec.rb
+- spec/facade_spec.rb
+- spec/messenger_spec.rb
+- spec/spec_helper.rb