action_messager 0.0.1

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2008 James Golick, GiraffeSoft Inc.
+
+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 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

@@ -0,0 +1,37 @@
+= ActionMessager
+
+ActionMessager is dead simple IM notifications for your app.
+
+== Get It
+  
+    $ sudo gem install action_messager
+    
+    ... or get the source ...
+    
+    $ git clone git@github.com:giraffesoft/action_messager.git
+    
+== Usage
+
+ActionMessager works just like ActionMailer. All you have to do start sending IM notifications to your users is subclass ActionMessager::Base; then, create a method that sets an array of recipients, and returns the message you'd like to send:
+
+  class JabberNotifier < ActionMessager::Base
+    def friendship_request(friendship_request)
+      @recipients = friendship_request.receiver.jabber_contact
+      
+      "You have received a friendship request from #{friendship_request.sender.name}! Click here to accept or decline: #{friendship_request.url}"
+    end
+  end
+  
+Then, wherever you'd like to send the notification:
+
+  JabberNotifier.deliver_friendship_request(friendship_request)
+  
+That's it!
+
+== Credits
+
+ActionMessager was created, and is maintained by {James Golick}[http://jamesgolick.com].
+
+== License
+
+ActionMessager is Copyright (c) 2008 James Golick, GiraffeSoft, Inc. It is released under the {MIT License}[http://en.wikipedia.org/wiki/MIT_License]

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/clean'
+require 'lib/action_messager'
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/lib/action_messager/base.rb

@@ -0,0 +1,31 @@
+module ActionMessager
+  class Base
+    include ActionController::UrlWriter if Object.const_defined?(:ActionController)
+
+    class_inheritable_accessor :jabber_settings
+    
+    class << self
+      def connection
+        raise ArgumentError.new('You must supply jabber credentials to use ActionMessager') unless [jabber_settings[:username], jabber_settings[:password]].select(&:blank?).empty?
+        @connection ||= Jabber::Simple.new(jabber_settings[:username], jabber_settings[:password])
+      end
+      
+      def method_missing(method, *args)
+        method.to_s =~ /deliver_.+?/ ? deliver(method.to_s.gsub(/deliver_/, '').intern, *args) : super
+      end
+      
+      def deliver(method, *args)
+        messager = new
+        msg      = messager.send(method, *args)
+        
+        messager.recipients.each do |recipient|
+          connection.deliver recipient, msg
+        end
+      end
+
+      private :new
+    end
+    
+    attr_accessor :recipients
+  end
+end

data/lib/action_messager/version.rb

@@ -0,0 +1,11 @@
+module ActionMessager
+  module Version
+    MAJOR    = 0
+    MINOR    = 0
+    TINY     = 1
+
+    STRING   = [MAJOR, MINOR, TINY].join('.')
+    
+    CODENAME = 'None'
+  end
+end

data/lib/action_messager.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require "rubygems"
+require "json"
+require "xmpp4r-simple"
+require "activesupport"
+require "action_messager/version"
+require "action_messager/base"
+
+module ActionMessager
+  NAME = 'action_messager'
+end

data/tasks/gem.rake

@@ -0,0 +1,59 @@
+require 'rake/gempackagetask'
+
+task :clean => :clobber_package
+
+spec = Gem::Specification.new do |s|
+  s.name                  = ActionMessager::NAME
+  s.version               = ActionMessager::Version::STRING
+  s.platform              = Gem::Platform::RUBY
+  s.summary               = 
+  s.description           = "Really simple jabber IM notifications."
+  s.author                = "James Golick"
+  s.email                 = 'james@giraffesoft.ca'
+  s.homepage              = 'http://jamesgolick.com/action_messager/'
+  
+  s.required_ruby_version = '>= 1.8.6'
+  
+  s.add_dependency        'activesupport',      '>= 2.0.2'
+  s.add_dependency        'xmpp4r-simple',      '>= 0.8.7'
+  s.add_dependency        'json_pure',          '>= 0.8.7'
+
+  s.files                 = %w(LICENSE README Rakefile) +
+                            Dir.glob("{lib,test,tasks}/**/*")
+                              
+  s.require_path          = "lib"
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+end
+
+task :tag_warn do
+  puts "*" * 40
+  puts "Don't forget to tag the release:"
+  puts "  git tag -a v#{ActionMessager::Version::STRING}"
+  puts "*" * 40
+end
+task :gem => :tag_warn
+
+task :compile do
+end
+
+namespace :gem do
+  namespace :upload do
+    desc 'Upload gems to rubyforge.org'
+    task :rubyforge => :gem do
+      sh 'rubyforge login'
+      sh "rubyforge add_release giraffesoft action_messager #{ActionMessager::Version::STRING} pkg/#{spec.full_name}.gem"
+      sh "rubyforge add_file giraffesoft action_messager #{ActionMessager::Version::STRING} pkg/#{spec.full_name}.gem"
+    end
+  end
+end
+
+task :install => [:clobber, :compile, :package] do
+  sh "sudo gem install pkg/#{spec.full_name}.gem"
+end
+
+task :uninstall => :clobber do
+  sh "sudo gem uninstall #{spec.name}"
+end

data/tasks/test.rake

@@ -0,0 +1,8 @@
+task :default => [:test]
+
+desc "Run basic tests"
+Rake::TestTask.new("test") { |t|
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+  t.warning = true
+}

data/test/base_test.rb

@@ -0,0 +1,53 @@
+require File.dirname(__FILE__)+'/test_helper'
+
+ActionMessager::Base.jabber_settings = {
+  :username => 'james',
+  :password => 'swordfish'
+}
+
+class MockNotifier < ActionMessager::Base
+end
+
+class ActionMessagerTest < Test::Unit::TestCase
+  context "connection" do
+    should "establish connection to Jabber::Simple using settings credentials" do
+      Jabber::Simple.expects(:new).with('james', 'swordfish')
+      ActionMessager::Base.connection
+    end
+    
+    should "raise ArgumentError if there are no credentials" do
+      ActionMessager::Base.jabber_settings = {
+        :username => '',
+        :password => ''
+      }
+      
+      assert_raise(ArgumentError) do
+        ActionMessager::Base.connection
+      end
+    end
+  end
+  
+  context "delivering messages" do
+    should "instantiate a new messager object" do
+      MockNotifier.expects(:new).returns(stub(:changeset => '', :recipients => []))
+      MockNotifier.deliver_changeset
+    end
+    
+    should "call the changeset method on the new messager" do
+      notifier_instance = mock(:changeset => '', :recipients => [])
+      MockNotifier.stubs(:new).returns(notifier_instance)
+      MockNotifier.deliver_changeset
+    end
+    
+    should "deliver the return value of the method to each of the recipients" do
+      @message = 'some message'
+      connection = mock
+      connection.expects(:deliver).with('james@giraffesoft.ca', 'some message')
+      connection.expects(:deliver).with('tony@arktyp.ca', 'some message')
+      MockNotifier.stubs(:connection).returns(connection)
+      MockNotifier.any_instance.stubs(:changeset).returns(@message)
+      MockNotifier.any_instance.stubs(:recipients).returns(%w(james@giraffesoft.ca tony@arktyp.ca))
+      MockNotifier.deliver_changeset
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.reject! { |p| p.include? 'TextMate' }
+require "test/unit"
+require "rubygems"
+require "mocha"
+require "shoulda"
+require File.dirname(__FILE__)+'/../lib/action_messager'

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: action_messager
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- James Golick
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-04-06 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: xmpp4r-simple
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.7
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json_pure
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.7
+    version: 
+description: Really simple jabber IM notifications.
+email: james@giraffesoft.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README
+- Rakefile
+- lib/action_messager
+- lib/action_messager/base.rb
+- lib/action_messager/version.rb
+- lib/action_messager.rb
+- test/base_test.rb
+- test/test_helper.rb
+- tasks/gem.rake
+- tasks/test.rake
+has_rdoc: false
+homepage: http://jamesgolick.com/action_messager/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.6
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 0.9.5
+signing_key: 
+specification_version: 2
+summary: Really simple jabber IM notifications.
+test_files: []
+