reactor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1ed56da3f6b079d59b295ce74da1cf587ebf593
+  data.tar.gz: 41a58ff5ed78311cbf680b64732be8b4e6ea252d
+SHA512:
+  metadata.gz: d8fa857f03b7205b53f8931355c90ec261a43c45f20c5726709f3afa9197a4598c54262724da35cd26004c9da49bd9395ae3563201e2a9080078daf1e73ee4f4
+  data.tar.gz: 50c9fd5ebdb5aa978966ea0f6418b086dd0607dd5c8304c31fc0528198e56a70e1b60947d69af6698dcf909f3804f152f6d34880bff3cdd1cd535e703270780a

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in reactor.gemspec
+gemspec
+
+
+gem 'sidekiq'
+gem 'activerecord', '3.2.13' 
+
+group :test do
+  gem 'pry'
+  gem 'rspec'
+  gem 'sqlite3'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 winfred
+
+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 @@
+# Reactor
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'reactor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install reactor
+
+## 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/reactor/event.rb

@@ -0,0 +1,49 @@
+class Reactor::Event
+  include Reactor::OptionallySubclassable
+
+  def self.publish(name, data = {})
+    message = Reactor::Message.new(data.merge(event: name))
+    if (message.at)
+      delay_until(message.at).process name, message.data
+    else
+      delay.process name, message.data
+    end
+  end
+
+  def self.reschedule(name, data = {})
+    job = scheduled_jobs.detect do |job|
+      job['class'] == name.to_s.camelize && job['at'].to_i == data[:was].to_i
+    end
+    remove_scheduled_job job if job
+    delay.publish(name, data.except(:was)) if data[:at].future?
+  end
+
+  def to_s
+    name
+  end
+
+  def self.process(name, data)
+    Reactor::Subscriber.where(event: name.to_s).each do |subscriber|
+      Reactor::Subscriber.delay.fire subscriber.id, data
+    end
+
+    #TODO: support more matching?
+    Reactor::Subscriber.where(event: '*').each do |s|
+      Reactor::Subscriber.delay.fire s.id, data
+    end
+  end
+
+  private
+
+  def self.scheduled_jobs(options = {})
+    Sidekiq.redis do |r|
+      from = options[:from] ? options[:from].to_f.to_s : '-inf'
+      to = options[:to] ? options[:to].to_f.to_s : '+inf'
+      r.zrangebyscore('schedule', from, to).map{|job| MultiJson.decode(job)}
+    end
+  end
+
+  def self.remove_scheduled_job(job)
+    Sidekiq.redis { |r| r.zrem 'schedule', MultiJson.encode(job) }
+  end
+end

data/lib/reactor/message.rb

@@ -0,0 +1,46 @@
+class Reactor::Message
+  attr_accessor :data
+
+  def initialize(data = {})
+    self.data = {}.with_indifferent_access
+    data.each do |key, value|
+      self.send("#{key}=", value)
+    end
+  end
+
+  def method_missing(method, *args)
+    if method.to_s.include?('=')
+      try_setter(method, *args)
+    else
+      try_getter(method)
+    end
+  end
+
+  private
+
+  def try_setter(method, object, *args)
+    if object.is_a? ActiveRecord::Base
+      send("#{method}_id", object.id)
+      send("#{method}_type", object.class.to_s)
+    else
+      data[method.to_s.gsub('=','')] = object
+    end
+  end
+
+  def try_getter(method)
+    if polymorphic_association? method
+      initialize_polymorphic_association method
+    elsif data.has_key?(method)
+      data[method]
+    end
+  end
+
+  def polymorphic_association?(method)
+    data.has_key?("#{method}_type")
+  end
+
+  def initialize_polymorphic_association(method)
+    data["#{method}_type"].constantize.find(data["#{method}_id"])
+  end
+
+end

data/lib/reactor/models/concerns/eventable.rb

@@ -0,0 +1,43 @@
+module Reactor::Eventable
+  extend ActiveSupport::Concern
+
+  included do
+    after_create :schedule_events
+    after_update :reschedule_events
+  end
+
+  def publish(name, data = {})
+    Reactor::Event.publish(name, data.merge(actor: self) )
+  end
+
+  module ClassMethods
+    def publishes(name, data = {})
+      events[name] = data
+    end
+
+    def events
+      @events ||= {}
+    end
+  end
+
+  private
+
+  def schedule_events
+    self.class.events.each do |name, data|
+      Reactor::Event.delay.publish name, data.merge(
+        at: send(data[:at]), actor: self
+      ).except(:watch)
+    end
+  end
+
+  def reschedule_events
+    self.class.events.each do |name, data|
+      if send("#{data[:watch] || data[:at]}_changed?")
+        Reactor::Event.delay.reschedule name,
+          at: send(data[:at]),
+          actor: self,
+          was: send("#{data[:at]}_was")
+      end
+    end
+  end
+end

data/lib/reactor/models/concerns/optionally_subclassable.rb

@@ -0,0 +1,13 @@
+module Reactor::OptionallySubclassable
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def find_sti_class(type_name)
+      begin
+        ActiveSupport::Dependencies.constantize(type_name)
+      rescue NameError
+        self
+      end
+    end
+  end
+end

data/lib/reactor/models/subscriber.rb

@@ -0,0 +1,42 @@
+class Reactor::Subscriber < ActiveRecord::Base
+  attr_accessible :event
+  attr_accessor :message
+
+  def event=(event)
+    write_attribute :event, event.to_s
+  end
+
+  def fire(data)
+    self.message = Reactor::Message.new(data)
+    instance_exec &self.class.on_fire
+    self
+  end
+
+  def delay_amount
+    self.class.delay_amount
+  end
+
+  class << self
+    def on_fire(&block)
+      if block
+        @fire_block = block
+      end
+      @fire_block
+    end
+
+    def fire(subscriber_id, data)
+      Reactor::Subscriber.find(subscriber_id).fire data
+    end
+
+    def subscribes_to(name = nil, delay: nil)
+      @delay_amount = delay
+      #subscribers << name
+      #TODO: REMEMBER SUBSCRIBERS so we can define them in code as well as with a row in the DB
+    end
+
+    def delay_amount
+      @delay_amount
+    end
+
+  end
+end

data/lib/reactor/testing/matchers.rb

@@ -0,0 +1,13 @@
+RSpec::Matchers.define :publish_event do |name, data = {}|
+
+  match do |block|
+    if data.empty?
+      Reactor::Event.should_receive(:publish).with do |*args|
+        args.first.should == name
+      end
+    else
+      Reactor::Event.should_receive(:publish).with(name, data)
+    end
+    block.call
+  end
+end

data/lib/reactor/version.rb

@@ -0,0 +1,3 @@
+module Reactor
+  VERSION = "0.0.1"
+end

data/lib/reactor.rb

@@ -0,0 +1,12 @@
+require "reactor/version"
+require "reactor/models/concerns/eventable"
+require "reactor/models/concerns/optionally_subclassable"
+require "reactor/models/subscriber"
+require "reactor/event"
+require "reactor/message"
+
+module Reactor
+
+end
+
+ActiveRecord::Base.send(:include, Reactor::Eventable)

data/reactor.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'reactor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "reactor"
+  spec.version       = Reactor::VERSION
+  spec.authors       = ["winfred", "walt"]
+  spec.email         = ["winfred@developerauction.com", "walt@developerauction.com", "curtis@developerauction.com", "nate@developerauction.com"]
+  spec.description   = %q{ rails chrono reactor }
+  spec.summary       = %q{ Sidekiq/ActiveRecord pubsub lib }
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/event_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Reactor::Event do
+
+  let(:event_name) { :user_did_this }
+
+  describe 'publish' do
+    it 'fires the first process and sets message event_id' do
+      Reactor::Event.should_receive(:process).with(event_name, 'actor_id' => '1', 'event' => :user_did_this)
+      Reactor::Event.publish(:user_did_this, actor_id: '1')
+    end
+  end
+
+  describe 'process' do
+    it 'fires all subscribers' do
+      Reactor::Subscriber.create(event: :user_did_this)
+      Reactor::Subscriber.any_instance.should_receive(:fire).with(actor_id: '1')
+      Reactor::Event.process(event_name, actor_id: '1')
+    end
+  end
+end

data/spec/message_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require 'support/active_record'
+
+module MyModule
+  class Pet < ActiveRecord::Base
+  end
+
+  class Cat < Pet
+  end
+end
+
+
+class ArbitraryModel < ActiveRecord::Base
+end
+
+describe Reactor::Message do
+  let(:cat) { MyModule::Cat.create }
+  let(:arbitrary_model) { ArbitraryModel.create }
+  let(:message_data) { {random: 'data', pet_id: cat.id, pet_type: cat.class.to_s, arbitrary_model: arbitrary_model } }
+  let(:message) { Reactor::Message.new(message_data) }
+
+  describe 'data key fallthrough' do
+    subject { message }
+
+    describe 'getters' do
+      context 'basic key value' do
+        its(:random) { should == 'data' }
+      end
+
+      context 'foreign key and foreign type' do
+        its(:pet) { should be_a MyModule::Cat }
+        its('pet.id') { should == MyModule::Cat.last.id }
+      end
+    end
+
+    describe 'setters' do
+      it 'sets simple keys' do
+        message.simple = 'key'
+        message.data[:simple].should == 'key'
+      end
+
+      it 'sets active_record polymorphic keys' do
+        message.complex = cat = MyModule::Cat.create
+        message.complex_id = cat.id
+        message.complex_type = cat.class.to_s
+      end
+    end
+  end
+
+  describe 'data' do
+    let(:serialized_message) { message.data }
+    specify { serialized_message.should be_a Hash }
+    specify { serialized_message[:random].should == 'data' }
+  end
+
+  describe 'new' do
+    specify { message.should be_a Reactor::Message }
+    specify { message.pet_id.should == cat.id }
+    specify { message.arbitrary_model_id.should == arbitrary_model.id }
+  end
+end

data/spec/models/concerns/eventable_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+class Auction < ActiveRecord::Base
+  def ring_timeout(was: false)
+    created_at + (was ? 10.seconds : 30.seconds)
+  end
+
+  publishes :ring, at: :ring_timeout, watch: :name
+end
+
+describe Reactor::Eventable do
+  describe 'publish' do
+    let(:auction) { Auction.create }
+
+    it 'publishes an event with actor_id and actor_type set as self' do
+      Reactor::Event.should_receive(:publish).with(:an_event, {what: 'the', actor: auction}).twice
+      auction.publish(:an_event, {what: 'the'})
+    end
+  end
+end

data/spec/models/subscriber_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+class MySubscriber < Reactor::Subscriber
+  attr_accessor :was_called
+
+  on_fire do
+    self.was_called = true
+  end
+end
+
+describe Reactor::Subscriber do
+
+  describe 'fire' do
+    subject { MySubscriber.create(event: :you_name_it).fire some: 'random', event: 'data' }
+
+    its(:message) { should be_a Reactor::Message }
+    its('message.some') { should == 'random' }
+
+    it 'executes block given' do
+      subject.was_called.should be_true
+    end
+  end
+
+  describe '.subscribes_to class helper' do
+    #describe 'ensuring subscriber exists and is tied to event' do
+    #  it 'binds 1-1 when name given' do
+    #    expect {
+    #      MySubscriber.class_eval do
+    #        subscribes_to :event_times
+    #      end
+    #    }.to change { Reactor::Subscriber.count }.by(1)
+    #  end
+    #
+    #  context 'binds to all when star is given' do
+    #    after { MySubscriber.destroy_all }
+    #
+    #    it 'creates new subscriber' do
+    #      expect {
+    #        MySubscriber.class_eval do
+    #          subscribes_to '*'
+    #        end
+    #      }.to change { Reactor::Subscriber.count }.by(1)
+    #    end
+    #
+    #    it 'doesnt create' do
+    #      MySubscriber.where(event: '*').first_or_create!
+    #      expect {
+    #        MySubscriber.class_eval do
+    #          subscribes_to '*'
+    #        end
+    #      }.to change { Reactor::Subscriber.count }.by(0)
+    #    end
+    #  end
+    #end
+  end
+
+  describe 'matcher' do
+    it 'can be set to star to bind to all events' do
+      MySubscriber.create!(event: '*')
+      MySubscriber.any_instance.should_receive(:fire).with({'random' => 'data', 'event' => :this_event})
+      Reactor::Event.publish(:this_event, {random: 'data'})
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'pry'
+
+require 'support/active_record'
+require 'sidekiq'
+require 'sidekiq/testing/inline'
+require 'reactor'
+
+Sidekiq.configure_server do |config|
+  config.redis = { url: ENV["REDISTOGO_URL"] }
+
+  database_url = ENV['DATABASE_URL']
+  if database_url
+    ENV['DATABASE_URL'] = "#{database_url}?pool=25"
+    ActiveRecord::Base.establish_connection
+  end
+end
+
+Sidekiq.configure_client do |config|
+  config.redis = { url: ENV["REDISTOGO_URL"] }
+end
+
+
+RSpec.configure do |config|
+  # some (optional) config here
+
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+
+  # Runs Sidekiq jobs inline by default unless the RSpec metadata :sidekiq is specified,
+  # in which case it will use the real Redis-backed Sidekiq queue
+  config.before(:each, :sidekiq) do
+    Sidekiq.redis{|r| r.flushall }
+    Sidekiq::Client.class_eval do
+      singleton_class.class_eval do
+        alias_method :raw_push, :raw_push_old
+      end
+    end
+  end
+
+
+  config.after(:each, :sidekiq) do
+    load "sidekiq/testing/inline.rb"
+  end
+
+end

data/spec/support/active_record.rb

@@ -0,0 +1,34 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+ActiveRecord::Migrator.up "db/migrate"
+
+ActiveRecord::Migration.create_table :auctions do |t|
+  t.string :name
+  t.datetime :start_at
+  t.datetime :close_at
+
+  t.timestamps
+end
+
+ActiveRecord::Migration.create_table :subscribers do |t|
+  t.string :event
+  t.string :type
+
+  t.timestamps
+end
+
+ActiveRecord::Migration.create_table :pets do |t|
+  t.integer :awesomeness
+  t.string :type
+
+
+  t.timestamps
+end
+
+ActiveRecord::Migration.create_table :arbitrary_models do |t|
+  t.integer :awesomeness
+
+  t.timestamps
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: reactor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- winfred
+- walt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-01 00:00:00.000000000 Z
+dependencies:
+- !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: ' rails chrono reactor '
+email:
+- winfred@developerauction.com
+- walt@developerauction.com
+- curtis@developerauction.com
+- nate@developerauction.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/reactor.rb
+- lib/reactor/event.rb
+- lib/reactor/message.rb
+- lib/reactor/models/concerns/eventable.rb
+- lib/reactor/models/concerns/optionally_subclassable.rb
+- lib/reactor/models/subscriber.rb
+- lib/reactor/testing/matchers.rb
+- lib/reactor/version.rb
+- reactor.gemspec
+- spec/event_spec.rb
+- spec/message_spec.rb
+- spec/models/concerns/eventable_spec.rb
+- spec/models/subscriber_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+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.0
+signing_key: 
+specification_version: 4
+summary: Sidekiq/ActiveRecord pubsub lib
+test_files:
+- spec/event_spec.rb
+- spec/message_spec.rb
+- spec/models/concerns/eventable_spec.rb
+- spec/models/subscriber_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb