simple_publisher 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Dirk Breuer/Galaxy Cats
+
+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.mdown

@@ -0,0 +1,91 @@
+# simple_publisher
+
+Defines a simple pub/sub layer for interaction with the Starling message queue.
+
+## The Idea
+
+More often than not you don't need a full fledged message queue like ActiveMQ
+or RabbitMQ with a full size message format. For simple asynchronous
+distribution tasks a very light weight persistent message queue like starling
+will be fine. Nevertheless you want a more sophisticated interface to interact
+with than a memcache interface. Simple Publisher tries to achieve exactly
+this: While using Starling as the queuing system in the background we provide
+a messaging terminology well know and understood. The terminology is strongly
+inspired by JMS which is kind a defacto standard for messaging on the
+API-level.
+
+## Example
+
+The Simple Publisher gem only helps you on the publisher site of message based
+connection (as the name already suggests). For the other side, the subscriber
+you need to roll your own solution. But fortunately there are aleady a lot of
+options you could use. I would strongly recommend to have a look at the
+[Workling](http://github.com/purzelrakete/workling "purzelrakete's workling at
+master - GitHub") plugin. Originally designed to realize easy background
+process integration into any Rails app, we could simply facilitate it to
+receive messages published by a different app. The following examples shows
+what you have to do on both the publisher and subscriber site.
+
+First the publisher:
+
+    # Let's assume we build a distributed mailing service which will read abstract
+    # email-instances from a queue and deliver them asynchronously
+
+    # First: Define your Connection and Topic instances ...
+    topic      = SimplePublisher::Topic.new(:name => "mail_service_subscribers__deliver_mail") # As you will see, this maps to Worklings naming scheme
+    connection = SimplePublisher::StarlingConnection.new(:host => "127.0.0.1", :port => "22122") # this Starlings default port
+
+    # ... and now get a Publisher instance
+    publisher = SimplePublisher::Publisher.new(
+      :topic      => topic,
+      :connection => connection
+    )
+
+    # Now lets create our email object we want to deliver asynchronously
+    email = Email.new # this could be any kind of object, usually a simple type.
+                      # If you want to send complex objects over a message queue,
+                      # make sure the other side nows about those objects.
+    publisher.publish(email) # ... and publish it to starling
+    
+And here comes the subscriber, which is just another Rails-App:
+
+    # Inside our receiving Rails-App with the Workling plugin enabled we create a
+    # Workling class
+    class MailServiceSubscriber < Workling::Base
+
+      def deliver_mail(email)
+        begin
+          Notifier.send("deliver_#{email[:name_of_mail]}", email)
+          # Here we just call anything that will actually send the email out. The
+          # email object is the same we published on the other side.
+        rescue Exception => e
+          # it is usually a good idea to log any errors ...
+          Rails.logger.error "An Error occured: #{e.message} --- BACKTRACE:\n\t#{e.backtrace.join("\n\t")}"
+        end
+      end
+
+    end
+    
+Due to the fact, that Workling will listen on a topic that is dynamically
+created out of the Worklings class name and the single method inside it, we end
+up with a topic name like `mail_service_subscribers__deliver_mail` which refers
+to the Workling class `MailServiceSubscriber` and the method `deliver_mail`.
+You cannot configure the name of the topic using Workling but it is not a major
+drawback. You just have to now the convention.
+
+Of course you have to start both the Starling system process and the Workling-Client
+instances. They are located in the `scripts` folder of your Rails-App.
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Dirk Breuer. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "simple_publisher"
+    gem.summary = %Q{Defines a simple pub/sub layer for interaction with the Starling message queue.}
+    gem.description = <<-DESC
+More often than not you don't need a full fledged message queue like ActiveMQ
+or RabbitMQ with a full size message format. For simple asynchronous distribution
+tasks a very light weight persistent message queue like starling will be fine.
+Nevertheless you want a more sophisticated interface to interact with than a
+memcache interface. Simple Publisher tries to achieve exactly this: While using
+Starling as the queuing system in the background we provide a messaging terminology 
+well know and understood. The terminology is strongly inspired by JMS which is
+kind a defacto standard for messaging on the API-level.
+    DESC
+    gem.email = "dirk@galaxycats.com"
+    gem.homepage = "http://github.com/galaxycats/simple_publisher"
+    gem.authors = ["Dirk Breuer"]
+    
+    gem.add_dependency "starling"
+    gem.add_dependency "system_timer"
+    
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "simple_publisher #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/simple_publisher.rb

@@ -0,0 +1,4 @@
+require 'simple_publisher/starling_connection'
+require 'simple_publisher/publisher'
+require 'simple_publisher/message'
+require 'simple_publisher/topic'

data/lib/simple_publisher/message.rb

@@ -0,0 +1,20 @@
+require 'digest/sha1'
+
+module SimplePublisher
+  class Message
+    attr_reader :body, :uid
+    
+    def initialize(message_body)
+      @body = message_body
+      generate_uid!
+    end
+    
+    private
+    
+      def generate_uid!
+        # This is taken from the workling gem
+        @uid = ::Digest::SHA1.hexdigest("#{self}:#{@body}:#{ rand(1 << 64) }:#{ Time.now }")
+      end
+    
+  end
+end

data/lib/simple_publisher/publisher.rb

@@ -0,0 +1,25 @@
+module SimplePublisher
+  class Publisher
+    attr_reader :topic, :connection
+
+    def initialize(attributes = {})
+      unless attributes.keys.include?(:topic) and attributes.keys.include?(:connection)
+        raise ArgumentError, "You must specify a connection and a topic"
+      end
+      
+      attributes.each do |attr, value|
+        send("#{attr}=", value)
+      end
+    end
+    
+    def publish(raw_message)
+      message = Message.new(raw_message)
+      connection.write(:message => message, :to => topic)
+    end
+    
+    private
+
+      attr_writer :topic, :connection
+    
+  end
+end

data/lib/simple_publisher/starling_connection.rb

@@ -0,0 +1,23 @@
+require 'starling'
+
+module SimplePublisher
+  class StarlingConnection
+    
+    attr_reader :starling_url
+    
+    def initialize(attributes = {})
+      @starling_url = "#{attributes[:host]}:#{attributes[:port]}"
+    end
+    
+    def write(options)
+      starling.set(options[:to].name, options[:message].body)
+    end
+    
+    private
+    
+      def starling
+        @starling ||= Starling.new(starling_url)
+      end
+    
+  end
+end

data/lib/simple_publisher/topic.rb

@@ -0,0 +1,20 @@
+module SimplePublisher
+  class Topic
+    attr_accessor :name
+    
+    def initialize(attributes = {})
+      attributes.each do |attr, value|
+        send("#{attr}=", value)
+      end
+    end
+    
+    def ==(other)
+      case other
+      when Topic
+        other.name == self.name
+      else
+        false
+      end
+    end
+  end
+end

data/spec/message_spec.rb

@@ -0,0 +1,14 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+module SimplePublisher
+  describe "Message" do
+    
+    it "should encapsulate any raw message in the class and generate a UID for itself" do
+      raw_message_content = "some raw message content"
+      message = Message.new(raw_message_content)
+      message.uid.should_not be(nil)
+      message.body.should == raw_message_content
+    end
+
+  end
+end

data/spec/publisher_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+module SimplePublisher
+  
+  describe "Publisher" do
+    
+    before :each do
+      @topic = Topic.new(:name => "some_topic")
+      @connection = mock("ConnectionMock")
+    end
+    
+    it "should initialize with topic and a connection" do
+      publisher = Publisher.new(:topic => @topic, :connection => @connection)
+      publisher.topic.should == @topic
+      publisher.connection.should == @connection
+    end
+    
+    it "should require a topic and a connection on creation" do
+      lambda { Publisher.new(:topic => @topic) }.should raise_error(ArgumentError)
+      lambda { Publisher.new(:connection => @connection) }.should raise_error(ArgumentError)
+    end
+    
+    it "should not allow to change the connection later on" do
+      publisher = Publisher.new(:topic => @topic, :connection => @connection)
+      lambda { publisher.connection = mock("AnotherConnection") }.should raise_error(NoMethodError)
+    end
+    
+    it "should not allow to change the topic later on" do
+      publisher = Publisher.new(:topic => @topic, :connection => @connection)
+      lambda { publisher.topic = mock("another_topic") }.should raise_error(NoMethodError)
+    end
+    
+    it "should publish a message via the connection" do
+      publisher = Publisher.new(:topic => @topic, :connection => @connection)
+      
+      Message.should_receive(:new).with("message").and_return(message = mock("Message"))
+      @connection.should_receive(:write).with(:message => message, :to => @topic)
+      
+      publisher.publish("message")
+    end
+    
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'simple_publisher'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/starling_connection_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+module SimplePublisher
+  describe "StarlingAdapter" do
+
+    it "should take a message and topic information and write them to a starling queue" do
+      starling_connection = StarlingConnection.new(:host => "127.0.0.1", :port => "22122")
+
+      message = Message.new("some message content")
+      topic = Topic.new(:name => "my_topic")
+
+      Starling.should_receive(:new).with("127.0.0.1:22122").and_return(starling_instance = mock("Starling"))
+      starling_instance.should_receive(:set).with("my_topic", "some message content")
+
+      starling_connection.write(:message => message, :to => topic)
+    end
+
+  end
+end

data/spec/topic_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+module SimplePublisher
+  describe "Topic" do
+
+    it "should have a name" do
+      topic = Topic.new(:name => "my_topic")
+      topic.name.should == "my_topic"
+    end
+
+    it "should fail if wrong attributes are a assigned through constructor" do
+      lambda { Topic.new(:bad_attribute => true) }.should raise_error(NoMethodError)
+    end
+    
+    it "should check object equality based on the topic name" do
+      topic_a = Topic.new(:name => "my_topic")
+      topic_b = Topic.new(:name => "my_topic")
+      topic_a.should == topic_b
+      
+      topic_a = Topic.new(:name => "my_topic")
+      topic_b = Topic.new(:name => "your_topic")
+      topic_a.should_not == topic_b
+    end
+
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: simple_publisher
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dirk Breuer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-26 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: starling
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: system_timer
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id003
+description: |
+  More often than not you don't need a full fledged message queue like ActiveMQ
+  or RabbitMQ with a full size message format. For simple asynchronous distribution
+  tasks a very light weight persistent message queue like starling will be fine.
+  Nevertheless you want a more sophisticated interface to interact with than a
+  memcache interface. Simple Publisher tries to achieve exactly this: While using
+  Starling as the queuing system in the background we provide a messaging terminology 
+  well know and understood. The terminology is strongly inspired by JMS which is
+  kind a defacto standard for messaging on the API-level.
+
+email: dirk@galaxycats.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.mdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.mdown
+- Rakefile
+- VERSION
+- lib/simple_publisher.rb
+- lib/simple_publisher/message.rb
+- lib/simple_publisher/publisher.rb
+- lib/simple_publisher/starling_connection.rb
+- lib/simple_publisher/topic.rb
+- spec/message_spec.rb
+- spec/publisher_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/starling_connection_spec.rb
+- spec/topic_spec.rb
+has_rdoc: true
+homepage: http://github.com/galaxycats/simple_publisher
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Defines a simple pub/sub layer for interaction with the Starling message queue.
+test_files: 
+- spec/message_spec.rb
+- spec/publisher_spec.rb
+- spec/spec_helper.rb
+- spec/starling_connection_spec.rb
+- spec/topic_spec.rb