rumor 0.1.0

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/Gemfile

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

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'minitest' do
+  watch(%r|^spec/(.*)_spec\.rb|)
+  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mattias Putman
+
+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,61 @@
+# Rumor
+
+All event processing is done asynchronously. Different adapters can be used to handle the processing (currently only Resque, default).
+
+## Usage
+
+### Let those controllers rumor
+
+**First**
+
+Add rumor capabilities to your controller by adding `include Rumor::Source`.
+
+**Then**
+
+Add rumor instructions in your controller methods.
+
+```ruby
+# Rumor about an event.
+rumor(:upgrade).on('john').mention(plan: plan.id).tag(:important).spread
+# Rumor only to certain channels.
+# Rumor whatever you want.
+rumor(:profit).tag(:finally).spread only: [:mixpanel]
+```
+
+**Where does the rumor come from?**
+
+The `rumor` method is a regular method defined in your controller (defined by including `Source`). You can use it to add default values to your rumors.
+
+```ruby
+class AccountController
+  include Rumor::Source
+
+  def rumor event
+    super(event).on(current_user.id).tag(:accounts)
+  end
+end
+```
+
+### Adding Rumor Channels
+
+```ruby
+class MixpanelChannel < Rumor::Channel
+
+  # This is just a regular class.
+  def initialize tracker
+    @tracker = tracker
+  end
+
+  # Matches only upgrade events with the important tag.
+  on(:upgrade) do |rumor|
+    rumor.subject # => 'john'
+    rumor.tag # => [:important]
+    plan = Plan.find rumor.mentions[:plan]
+    @tracker.track 'Upgraded Account', to: plan.name
+  end
+end
+
+# Register the channel.
+tracker = Mixpanel::Tracker.new Environment::MIXPANEL_TOKEN,
+Rumor.register :mixpanel, MixpanelChannel.new tracker
+```

data/Rakefile

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

data/lib/rumor.rb

@@ -0,0 +1,30 @@
+require "rumor/version"
+require 'rumor/channel'
+require 'rumor/rumor'
+require 'rumor/source'
+
+module Rumor
+  class << self
+    attr_accessor :channels
+    attr_accessor :async_handler
+  end
+
+  @channels = {}
+
+  # Internal: Register a new channel.
+  def self.register name, channel
+    self.channels[name] = channel
+  end
+
+  # Internal: Spread a rumor to required channels.
+  def self.spread rumor
+    self.channels.each do |name, channel|
+      channel.send rumor if rumor.to?(name)
+    end
+  end
+
+  # Internal: Spread a rumor asynchronously.
+  def self.spread_async rumor
+    self.async_handler.spread_async rumor
+  end
+end

data/lib/rumor/async/resque.rb

@@ -0,0 +1,38 @@
+require 'resque'
+
+module Rumor
+  module Async
+
+    class Resque
+
+      def self.spread_async rumor
+        ::Resque.enqueue Job, rumor.to_h
+      end
+
+      class Job
+        @queue = :rumor
+
+        def self.perform rumor_hash
+          hash = hash_to_symbols rumor_hash
+          hash[:mentions] = hash_to_symbols hash[:mentions]
+          hash[:tags].map! &:to_sym
+          hash[:time] = Time.new hash[:time]
+          # Deserialize the rumor.
+          rumor = Rumor.from_h hash
+          # Spread again.
+          ::Rumor.spread rumor
+        end
+
+        def self.hash_to_symbols hash
+          symbol_hash = {}
+          hash.each do |k,v|
+            symbol_hash[k.to_sym] = v
+          end
+          symbol_hash
+        end
+      end
+    end
+  end
+end
+
+Rumor.async_handler = Rumor::Async::Resque

data/lib/rumor/channel.rb

@@ -0,0 +1,27 @@
+module Rumor
+
+  # Public: A Channel is a module that can be included in any class.
+  #
+  # It provides an 'on' method for matching rumors by event.
+  class Channel
+    class << self
+      attr_accessor :handlers
+    end
+
+    def self.inherited klass
+      klass.handlers = {}
+    end
+
+    # Internal: Send a Rumor to this channel.
+    def send rumor
+      handle = self.class.handlers[rumor.event.to_sym]
+      raise "No handler for event #{rumor.event}" unless handle
+      self.instance_exec rumor, &handle
+    end
+
+    # Public: Catch all events with specified name.
+    def self.on event, &handle
+      self.handlers[event] = handle
+    end
+  end
+end

data/lib/rumor/rumor.rb

@@ -0,0 +1,119 @@
+module Rumor
+
+  # Public: A Rumor represents some knowledge about
+  # something that can be spread.
+  #
+  # Examples
+  #
+  #   Rumor.new(:upgraded).on('user1').mention(plan: :tasty).tag(:business).spread
+  #
+  class Rumor
+
+    # Public: A rumor has an event name.
+    # this is required for every rumor.
+    attr_accessor :event
+
+    # Public: Wo the rumor is about
+    # This is mostly the user that executed the event.
+    attr_accessor :subject
+
+    # Public: The mentions of the rumor.
+    # All the information a rumor mentions.
+    attr_accessor :mentions
+
+    # Public: Every rumor has some tags.
+    # A Rumor can be categorized in multiple optional tags.
+    attr_accessor :tags
+
+    # Public: Create Rumor from hash.
+    def self.from_h hash
+      self.new(hash[:event], hash[:time]).
+        mention(hash[:mentions]).
+        on(hash[:subject]).
+        tag(*hash[:tags])
+    end
+
+    # Public: Creates a new rumor.
+    #
+    # event - event of the rumor.
+    def initialize event, time = nil
+      @event = event
+      @tags = []
+      @mentions = {}
+      @time = time
+    end
+
+    # Public: Tell who/what the rumor is concerning.
+    def on subject
+      @subject = subject
+      self
+    end
+
+    # Public: Mention some things in the rumor.
+    # Merges with already mentioned information.
+    def mention mentions = {}
+      @mentions.merge!(mentions) do |key, old_val, new_val|
+        if old.kind_of?(Array)
+          old_val + new_val
+        elsif old.kind_of?(Hash)
+          old_val.merge new_val
+        else
+          new_val
+        end
+      end
+      self
+    end
+
+    # Public: Add some tags to the rumor.
+    def tag *tags
+      @tags += tags
+      self
+    end
+
+    # Public: Copy a rumor while altering information.
+    def copy &alter
+      Rumor.new(hash).tap &alter
+    end
+
+    # Spread the rumor to all applicable channels.
+    #
+    # conditions - some conditions on the spreading (Hash).
+    #             :only - The channels to spread to (and none other).
+    #             :except - The channels not to spread to.
+    #
+    # Returns nothing.
+    def spread conditions = {}
+      @time = Time.now.utc
+      @only = conditions[:only]
+      @except = conditions[:except]
+      ::Rumor.spread_async self
+    end
+
+    # Public: The time the rumor was spread.
+    def time
+      @time
+    end
+
+    # Public: Whether to send this rumor to the given channel.
+    #
+    # channel - Name of the channel.
+    def to? channel
+      (!@only && !@except) ||
+        (@only && @only.include?(channel)) ||
+        (@except && !@except.include?(channel))
+    end
+
+    # Public: Rumor in hash form.
+    #
+    # Returns the rumor converted to a Hash.
+    def to_h
+      {
+        event: event,
+        subject: subject,
+        mentions: mentions,
+        tags: tags,
+        time: time
+      }
+    end
+  end
+end

data/lib/rumor/source.rb

@@ -0,0 +1,31 @@
+module Rumor
+
+  # Public: Include this module everywhere you want to be
+  # able to rumor. This gives you the benefit that the rumor
+  # method can easily be overrided.
+  #
+  # Exampe:
+  #
+  #   class Controller
+  #     include Rumor::Rumoring
+  #
+  #     def rumor subject
+  #       super.on(current_user)
+  #     end
+  #
+  #     def upgrade
+  #       # some code
+  #       rumor(:upgraded).mention(plan: :basic).spread only: :kissmetrics
+  #     end
+  #   end
+  #
+  module Source
+
+    # Public: Acts as a specialized factory for rumors.
+    #
+    # Returns a new Rumor.
+    def rumor event
+      Rumor.new(event)
+    end
+  end
+end

data/lib/rumor/version.rb

@@ -0,0 +1,3 @@
+module Rumor
+  VERSION = "0.1.0"
+end

data/rumor.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rumor/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rumor"
+  gem.version       = Rumor::VERSION
+  gem.authors       = ["Mattias Putman"]
+  gem.email         = ["mattias.putman@gmail.com"]
+  gem.description   = %q{Rumor}
+  gem.summary       = %q{Rumor}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'resque'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-minitest'
+  gem.add_development_dependency 'mocha'
+  gem.add_development_dependency 'rb-fsevent', '~> 0.9'
+end

data/spec/rumor/channel_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+class TestChannel < MiniTest::Unit::TestCase
+
+  class ExampleChannel < Rumor::Channel
+    def helper
+      "helper"
+    end
+  end
+
+  def setup
+    @channel = ExampleChannel.new
+  end
+
+  def test_define_handler
+    assert_equal ExampleChannel.handlers, {}
+    handle = proc {}
+    ExampleChannel.on(:upgrade, &handle)
+    assert_equal ExampleChannel.handlers[:upgrade], handle
+  end
+
+  def test_send_rumor
+    upgrade = proc {}
+    install = proc { |rumor| @rumor = rumor }
+    ExampleChannel.on(:upgrade, &upgrade)
+    ExampleChannel.on(:install, &install)
+
+    @channel.send Rumor::Rumor.new(:install).
+      tag(:business).
+      on(:cool_user).
+      mention(plan: :enterprise)
+
+    rumor = @channel.instance_variable_get :@rumor
+    assert rumor.event == :install && rumor.tags == [:business] &&
+        rumor.mentions == { plan: :enterprise } && rumor.subject == :cool_user
+  end
+
+  def test_use_methods
+    ExampleChannel.on(:method_test) do |rumor|
+      helper
+    end
+    @channel.expects(:helper).once
+    @channel.send Rumor::Rumor.new(:method_test)
+  end
+
+  def teardown
+    ExampleChannel.handlers = {}
+  end
+end

data/spec/rumor_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+class TestRumor < MiniTest::Unit::TestCase
+  include Rumor::Source
+
+  class ExampleChannel < Rumor::Channel
+  end
+
+  class IntegrationChannel < Rumor::Channel
+    def initialize delegate
+      @delegate = delegate
+    end
+
+    on(:upgrade) do |rumor|
+      @delegate.upgrade
+    end
+
+    on(:install) do |rumor|
+      @delegate.install
+    end
+  end
+
+  def setup
+    @channel = ExampleChannel.new
+    @rumor = Rumor::Rumor.new(:upgrade).mention price: 8
+  end
+
+  def test_channels_initialized
+    assert_equal Rumor.channels, {}
+  end
+
+  def test_add_channel
+    Rumor.register :example, @channel
+    assert_equal Rumor.channels[:example], @channel
+  end
+
+  def test_spread_both
+    left, right = ExampleChannel.new, ExampleChannel.new
+    Rumor.register :left, left
+    Rumor.register :right, right
+    left.expects(:send).with(@rumor).once
+    right.expects(:send).with(@rumor).once
+    Rumor.spread @rumor
+  end
+
+  def test_spread_filter
+    left, right = ExampleChannel.new, ExampleChannel.new
+    @rumor.stubs(:to?).with(:left).returns true
+    @rumor.stubs(:to?).with(:right).returns false
+    Rumor.register :left, left
+    Rumor.register :right, right
+    left.expects(:send).with(@rumor).once
+    right.expects(:send).with(@rumor).never
+    Rumor.spread @rumor
+  end
+
+  def test_spread_async
+    Rumor::Async::Resque.expects(:spread_async).with(@rumor).once
+    Rumor.spread_async @rumor
+  end
+
+  def test_integration
+    channel1 = mock
+    Rumor.register :channel1, IntegrationChannel.new(channel1)
+    channel1.expects(:upgrade)
+    rumor(:upgrade).mention(plan: :enterprise).spread
+  end
+
+  def teardown
+    Rumor.channels = {}
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'minitest/autorun'
+require 'mocha/setup'
+
+require 'rumor'
+require 'rumor/async/resque'
+
+Resque.inline = true

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: rumor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Mattias Putman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Rumor
+email:
+- mattias.putman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rumor.rb
+- lib/rumor/async/resque.rb
+- lib/rumor/channel.rb
+- lib/rumor/rumor.rb
+- lib/rumor/source.rb
+- lib/rumor/version.rb
+- rumor.gemspec
+- spec/rumor/channel_spec.rb
+- spec/rumor_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.19
+signing_key: 
+specification_version: 3
+summary: Rumor
+test_files:
+- spec/rumor/channel_spec.rb
+- spec/rumor_spec.rb
+- spec/spec_helper.rb
+has_rdoc: