jabber_delivery 0.0.1

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+0.0.1
+-----
+Initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+gemspec
+
+gem "rake"

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Sergey 'Tangerine Cat' Kluchkowsky
+
+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,44 @@
+Jabber Delivery
+---------------
+
+This gem adds a method to ActionMailer which enables sending messages right to jabber.
+
+Rails Setup
+-----------
+
+First add the gem to your `Gemfile` and run the `bundle` command to install it.
+
+```ruby
+gem "jabber_delivery"
+```
+
+Then, create file `config/jabber_delivery.yml` and put there jabber credentials you're going to use:
+
+```yaml
+jid: foobar@somejabber.com
+password: here_goes_your_password
+```
+
+Now I can do in [devise](https://github.com/plataformatec/devise) resource:
+
+```ruby
+  def headers_for(action)
+    { :to => address,                       # Got address from email field with format {email|jabber}:(address here)
+      :delivery_method => delivery_method   # Depending on prefix, use :smtp or :jabber_delivery (just for example)
+    }
+  end
+```
+
+Hope it will help.
+
+Project Status
+--------------
+
+Most of project's structure is *imported* from `letter_opener` gem and for now it's not so serious.
+
+
+Development & Feedback
+----------------------
+
+Special thanks to the [letter_opener](https://github.com/ryanb/letter_opener) gem for inspiring this project.
+

data/lib/jabber_delivery.rb

@@ -0,0 +1,4 @@
+#
+#
+require "jabber_delivery/delivery_method"
+require "jabber_delivery/railtie" if defined? Rails

data/lib/jabber_delivery/delivery_method.rb

@@ -0,0 +1,33 @@
+require 'jabber_delivery/jabber_client'
+
+#
+module JabberDelivery
+  class DeliveryMethod
+    def initialize(options = {})
+      @options = options
+
+      raise "JID should be specified for jabber delivery" unless jid
+      raise "password should be specified for jabber delivery" unless password
+    end
+
+    def deliver!(mail)
+      jabber_client.deliver(mail.to.first, mail.body.to_s)
+    end
+
+  private
+    #
+    def jid
+      @jid ||= (@options[:jid] || @options["jid"])
+    end
+
+    #
+    def password
+      @password ||= (@options[:password] || @options["password"])
+    end
+
+    #
+    def jabber_client
+      @jabber_client ||= JabberClient.new(jid, password)
+    end
+  end
+end

data/lib/jabber_delivery/jabber_client.rb

@@ -0,0 +1,33 @@
+#
+require 'xmpp4r'
+
+module JabberDelivery
+  class JabberClient
+
+    include Jabber
+
+    def initialize(jid, password)
+      @jid, @password = jid, password
+    end
+
+    def deliver(target_jid, message)
+      client.send(chat_message(target_jid, message))
+    end
+
+  private
+    #
+    def client
+      @client ||= Client.new(JID.new(@jid)).tap do |client|
+        client.connect
+        client.auth(@password)
+      end
+    end
+
+    #
+    def chat_message(target_jid, message)
+      Message.new(target_jid, message).tap do |m|
+        m.set_type(:chat)
+      end
+    end
+  end
+end

data/lib/jabber_delivery/railtie.rb

@@ -0,0 +1,7 @@
+module JabberDelivery
+  class Railtie < Rails::Railtie
+    initializer "jabber_delivery.add_delivery_method" do
+      ActionMailer::Base.add_delivery_method :jabber_delivery, JabberDelivery::DeliveryMethod, YAML.load_file(Rails.root.join("config/jabber_delivery.yml"))
+    end
+  end
+end

data/spec/jabber_delivery/delivery_method_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+describe JabberDelivery::DeliveryMethod do
+  JABBER_UID = "foo@bar.bz"
+  JABBER_PASSWORD = "asdfpoiuqwer"
+
+  TARGET_UID = "bazz@bar.bz"
+  MESSAGE = "Send more chunky bacon"
+
+  context "#deliver!" do
+    before(:each) do
+      jabber_uid = JABBER_UID
+      jabber_password = JABBER_PASSWORD
+
+      method = nil
+
+      Mail.defaults do
+        method = delivery_method JabberDelivery::DeliveryMethod, :jid => jabber_uid, :password => jabber_password
+      end
+
+      @method = method
+
+      ### Rather hack, 'cause I'm not too good in rspec yet
+      @method.stub(:dup).and_return(@method)
+
+      @jabber_client = mock("jabber_client")
+      @jabber_client.stub(:deliver)
+
+      @method.stub(:jabber_client).and_return(@jabber_client)
+    end
+
+    after(:each) do
+      mail = Mail.deliver do
+        to      TARGET_UID
+        body    MESSAGE
+      end
+    end
+
+    it "should reach for jabber client" do
+      @method.should_receive(:jabber_client)
+    end
+
+    it "should call jabber client's deliver method with parameters from `email'" do
+      @jabber_client.should_receive(:deliver).with(TARGET_UID, MESSAGE)
+    end
+  end
+end

data/spec/jabber_delivery/jabber_client_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe JabberDelivery::JabberClient do
+  TARGET_JID = "target@jid.co"
+  MESSAGE    = "Send me more chunky bacon"
+
+  before(:each) do
+    @jabber_client = JabberDelivery::JabberClient.new("foo@bar.bz", "123123")
+    @client_mock = mock("client")
+    @client_mock.stub!(:send)
+
+    @message_mock = mock("message")
+
+    @jabber_client.stub!(:client).and_return(@client_mock)
+    @jabber_client.stub!(:chat_message).and_return(@message_mock)
+  end
+
+  context "#deliver" do
+    after(:each) do
+     	@jabber_client.deliver(TARGET_JID, MESSAGE)
+    end
+
+    it "should get client" do
+      @jabber_client.should_receive(:client)
+    end
+
+    it "should get chat_message" do
+      @jabber_client.should_receive(:chat_message)
+    end
+
+    it "should call client#send with chat message" do
+      @client_mock.should_receive(:send).with(@message_mock)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require(:default)
+
+require "mail"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: jabber_delivery
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tangerine Cat
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xmpp4r
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: ZenTest
+  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: pry
+  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'
+description: When mail is sent from your application, Jabber Delivery will send it
+  to jabber uid instead of email.
+email: kaineer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jabber_delivery/jabber_client.rb
+- lib/jabber_delivery/delivery_method.rb
+- lib/jabber_delivery/railtie.rb
+- lib/jabber_delivery.rb
+- spec/spec_helper.rb
+- spec/jabber_delivery/jabber_client_spec.rb
+- spec/jabber_delivery/delivery_method_spec.rb
+- CHANGELOG.md
+- LICENSE
+- Gemfile
+- README.md
+homepage: http://github.com/kaineer/jabber_delivery
+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: 1.3.4
+requirements: []
+rubyforge_project: jabber_delivery
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Send messages to jabber uid instead of email.
+test_files: []