transporter 0.1

data/.gitignore

@@ -0,0 +1,3 @@
+doc/*
+dist/*
+tmp/*

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2008-2009 Nicolas Sanguinetti
+
+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.rdoc

@@ -0,0 +1,65 @@
+= Transporter
+
+Deliver packages in multiple ways simultaneously (email, jabber, campfire, irc,
+etc.)
+
+== API
+
+    require "transporter"
+
+    module Transporter
+      class Email < Service
+        validate_config do |config|
+          config.has_keys      :from, :to, :host, :user, :password, :port, :auth
+          config.key_is_one_of :auth, %w(plain auth some other)
+          [:to, :from].each do |key|
+            config.key_matches key,   /--some complicated email regexp--/
+          end
+        end
+
+        def deliver(message)
+          # Send your email
+          #
+          # In this method you have available `message.short` (usable for short
+          # messages such as twitter, or email subjects) and `message.full`
+          # usable for longer chunks of text, as an email body.
+          #
+          # And you have access to `config`, where all your pre-validated config
+          # values live (including default values set on the class, this hash is
+          # a merged representations of te two.
+        end
+      end
+
+      register :email, Email
+    end
+
+== How to use
+
+You probably want one of the child projects of this one, where the different
+implementations provide you with specific implementations. However, the way to
+use this is as follows:
+
+    Transporter.deliver(
+      :message => {
+        :short => "cuack!",
+        :full => "double cuack" 
+      },
+      :using => {
+        :email => {
+          :to => "...", :from => "...", ...
+        },
+        :jabber => {
+          :to => "...", :from => "...", ...
+        }
+      }
+
+Where each key of the `:using` hash depends on what implementations you loaded.
+(`Transporter::Email`, `Transporter::Jabber`, etc). Refer to their specific
+documentations for the full list of configuration values in each.
+
+The `:short` message is used in messages like twitter, IM, or as an email
+subject. The `:full` message is used 
+
+== List of implementations
+
+* Example

data/Rakefile

@@ -0,0 +1,25 @@
+require "rake/testtask"
+
+begin
+  require "hanna/rdoctask"
+rescue LoadError
+  require "rake/rdoctask"
+end
+
+Rake::RDocTask.new do |rd|
+  rd.main = "README"
+  rd.title = "API Documentation for Transporter"
+  rd.rdoc_files.include("README.rdoc", "LICENSE", "lib/**/*.rb")
+  rd.rdoc_dir = "doc"
+end
+
+begin
+  require "mg"
+  MG.new("transporter.gemspec")
+rescue LoadError
+end
+
+Rake::TestTask.new
+
+desc "Default: run tests"
+task :default => :test

data/lib/transporter.rb

@@ -0,0 +1,23 @@
+$LOAD_PATH << File.expand_path(File.dirname(__FILE__))
+
+require "ninja"
+require "transporter/package"
+require "transporter/service"
+
+module Transporter
+  def self.deliver(package)
+    Package.new(package).deliver
+  end
+
+  def self.register(name, service)
+    services[name] = service
+  end
+
+  def self.load_service(service)
+    services.fetch(service)
+  end
+
+  def self.services
+    @services ||= {}
+  end
+end

data/lib/transporter/package.rb

@@ -0,0 +1,28 @@
+module Transporter
+  class Package
+    include Ninja
+
+    attr_reader :short, :full
+
+    def initialize(package)
+      message = package.fetch(:message)
+      @short = message.fetch(:short)
+      @full = message.fetch(:full)
+      @services = package.fetch(:using)
+    end
+
+    def deliver
+      delivery_services.each do |service|
+        in_background { service.deliver(self) }
+      end
+    end
+
+    private
+
+    def delivery_services
+      @services.map do |service, config|
+        Transporter.load_service(service).new(config)
+      end
+    end
+  end
+end

data/lib/transporter/service.rb

@@ -0,0 +1,24 @@
+require "transporter/service/validations"
+
+module Transporter
+  class Service
+    include Validations
+
+    class << self
+      attr_accessor :default_config
+    end
+
+    self.default_config = {}
+
+    attr_reader :config
+
+    def initialize(config)
+      @config = (self.class.default_config || {}).merge(config)
+      raise TypeError, config_errors unless valid_config?(config)
+    end
+
+    def deliver(message)
+      raise NotImplementedError, "Please implement this method on your service"
+    end
+  end
+end

data/lib/transporter/service/validations.rb

@@ -0,0 +1,70 @@
+module Transporter
+  class Service
+    module Validations
+      def self.included(service)
+        service.extend ClassMethods
+      end
+
+      def config_errors
+        self.class.validator.errors
+      end
+
+      def valid_config?(config)
+        self.class.validator.valid?(config)
+      end
+
+      module ClassMethods
+        def validator(&block)
+          @validator ||= Validator.new(&block)
+        end
+        alias_method :validate_config, :validator
+      end
+
+      class Validator
+        attr_reader :errors
+
+        def initialize(&block)
+          @validations = Hash.new {|h,k| h[k] = [] }
+          @errors = Hash.new {|h,k| h[k] = [] }
+          block.call(self) if block
+        end
+
+        def has_keys(*keys)
+          keys.each do |key|
+            @validations[key] << lambda do |config|
+              config.has_key?(key) or raise TypeError, "config must include '#{key}', but does not"
+            end
+          end
+        end
+
+        def key_matches(key, format)
+          @validations[key] << lambda do |config|
+            config[key] =~ format or raise TypeError, "config '#{key}' must match '#{format}'"
+          end
+        end
+
+        def key_is_one_of(key, values)
+          @validations[key] << lambda do |config|
+            values.include? config[key] or raise TypeError, "config '#{key}' must be one of '#{values.join(", ")}'"
+          end
+        end
+
+        def valid?(config)
+          errors.clear
+
+          @validations.each do |key, validation_list|
+            validation_list.each do |validation|
+              begin
+                validation.call(config)
+              rescue TypeError => e
+                errors[key] << e.message
+              end
+            end
+          end
+
+          errors.empty?
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,58 @@
+require "test/unit"
+require "contest"
+require File.expand_path(File.dirname(__FILE__) + "/../lib/transporter")
+
+begin
+  require "redgreen"
+rescue LoadError
+end
+
+if ENV["DEBUG"]
+  require "ruby-debug"
+else
+  def debugger
+    puts "Run your tests with DEBUG=1 to use the debugger"
+  end
+end
+
+module Transporter
+  def self.test_message_log
+    @test_message_log ||= []
+  end
+
+  class TestService < Service
+    validate_config do |config|
+      config.has_keys      :foo, :bar
+      config.key_matches   :foo, /^\d+$/
+      config.key_is_one_of :baz, ["one", "two", "three"]
+    end
+
+    def deliver(message)
+      Transporter.test_message_log << {
+        :short => message.short,
+        :full => message.full
+      }
+    end
+  end
+  register :test, TestService
+
+  class TestCase < Test::Unit::TestCase
+    setup { Transporter.test_message_log.clear }
+
+    def assert_has_short_message(message)
+      if Transporter.test_message_log.detect {|m| message == m[:short] }
+        assert true
+      else
+        flunk
+      end
+    end
+
+    def assert_has_full_message(message)
+      if Transporter.test_message_log.detect {|m| message == m[:full] }
+        assert true
+      else
+        flunk
+      end
+    end
+  end
+end

data/test/test_transporter.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class TestTransporter < Transporter::TestCase
+  def valid_message
+    {
+      :message => {
+        :short => "short message",
+        :full => "full message"
+      },
+      :using => {
+        :test => {
+          :foo => "1234",
+          :bar => "cuack",
+          :baz => "two"
+        }
+      }
+    }
+  end
+
+  test "delivers messages to the specified recipients" do
+    Transporter.deliver(valid_message)
+
+    assert_has_short_message "short message"
+    assert_has_full_message "full message"
+  end
+
+  test "raises TypeError when passing an invalid config for the Service" do
+    message = valid_message
+    message[:using][:test][:foo] = nil
+
+    assert_raises TypeError do
+      Transporter.deliver(message)
+    end
+  end
+end

data/transporter.gemspec

@@ -0,0 +1,39 @@
+Gem::Specification.new do |s|
+  s.name    = "transporter"
+  s.version = "0.1"
+  s.date    = "2009-08-10"
+
+  s.description = "Deliver packages in multiple ways simultaneously (email, jabber, campfire, irc, etc.)"
+  s.summary     = "Easily send messages using multiple communication channels"
+  s.homepage    = "http://github.com/foca/Transporter"
+
+  s.authors = ["Nicolás Sanguinetti"]
+  s.email   = "contacto@nicolassanguinetti.info"
+
+  s.require_paths     = ["lib"]
+  s.rubyforge_project = "transporter"
+  s.has_rdoc          = true
+  s.rubygems_version  = "1.3.1"
+
+  s.add_dependency "ninja"
+
+  if s.respond_to?(:add_development_dependency)
+    s.add_development_dependency "sr-mg"
+    s.add_development_dependency "contest"
+    s.add_development_dependency "redgreen"
+  end
+
+  s.files = %w[
+.gitignore
+LICENSE
+README.rdoc
+Rakefile
+transporter.gemspec
+lib/transporter.rb
+lib/transporter/package.rb
+lib/transporter/service.rb
+lib/transporter/service/validations.rb
+test/test_helper.rb
+test/test_transporter.rb
+]
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: transporter
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- "Nicol\xC3\xA1s Sanguinetti"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-10 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ninja
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sr-mg
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: contest
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: redgreen
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Deliver packages in multiple ways simultaneously (email, jabber, campfire, irc, etc.)
+email: contacto@nicolassanguinetti.info
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- transporter.gemspec
+- lib/transporter.rb
+- lib/transporter/package.rb
+- lib/transporter/service.rb
+- lib/transporter/service/validations.rb
+- test/test_helper.rb
+- test/test_transporter.rb
+has_rdoc: true
+homepage: http://github.com/foca/Transporter
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: transporter
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Easily send messages using multiple communication channels
+test_files: []
+