rjab 0.2.2

data/.gitignore

@@ -0,0 +1,2 @@
+coverage/*
+pkg/*

data/README.markdown

@@ -0,0 +1,93 @@
+RJab: a Ruby library for Jabbify
+================================
+
+[Jabbify][jabbify] is a simple messaging service that one can plug into their website with a few lines of Javascript. At the heart of Jabbify is a centralized, ready-to-use Comet server. 
+
+You can [utilize their Comet service][jabbify_comet] via the Javascript API, or by creating a simple GET or POST request along with the necessary parameters. This library attempts to simplify creation of that request.
+
+Installing the Gem
+------------------
+
+    $ sudo gem install rjab
+		
+Utilizing the Library
+---------------------
+
+    require 'rubygems'
+    require 'jabbify'
+	
+If you only make one message delivery in your app, you might find it easiest to use the class method:
+
+    Jabbify::Comet.deliver(
+      :api_key => 'YourApiKeyGoesHere',
+      :type    => :type_of_delivery,
+      :action  => :action_of_delivery,
+      :name    => 'John Doe',
+      :message => 'This is the message!',
+      :to      => 'Jane Doe',
+    )
+
+More commonly, you will instantiate an instance of `Jabbify::Comet` with a few customized attributes. Keep in mind that there a few **default attributes** set for you; they are denoted below. Then you can just call `#deliver` whenever you're ready, passing in a couple more attributes which will *only be used during the delivery*:
+
+    custom_attributes = {
+      :api_key => 'YourApiKeyGoesHere',
+      :name    => 'The Server'
+    }
+    
+    @comet = Jabbify::Comet.new(custom_attributes)
+    
+    if @comet.deliver(:message => "A special message at #{ Time.now.to_s }")
+      # do something
+    else
+      # do something else
+    end
+
+Default Attributes on the `Jabbify::Comet` Class
+------------------------------------------------
+
+<table id="rjab_default_attributes">
+  <thead>
+    <tr>
+      <th>Attribute</th>
+      <th>Default Value</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><code>:action</code></td>
+      <td><code>:create</code></td>
+      <td>The action you are performing against the type, as a <strong>symbol</strong>. Commonly a RESTful action.</td>
+    </tr>
+    <tr>
+      <td><code>:api_key</code></td>
+      <td><code>nil</code></td>
+      <td><em>Required.</em> The API key provided to you when you sign up with Jabbify.</td>
+    </tr>
+    <tr>
+      <td><code>:message</code></td> 
+      <td><code>nil</code></td>
+      <td><em>Required.</em> The message to deliver to the Comet server.</td>
+    </tr>
+    <tr>
+      <td><code>:name</code></td>
+      <td><code>'Server'</code></td>
+      <td><em>Required.</em> The sender of the message.</td>
+    </tr>
+    <tr>
+      <td><code>:to</code></td>
+      <td><code>nil</code></td>
+      <td>The recipient of the message. Not usually specified, as most messages are sent to all users.</td>
+    </tr>
+    <tr>
+      <td><code>:type</code></td>
+      <td><code>:message</code></td>
+      <td>The type of resource you are working with, as a <strong>symbol</strong>.</td>
+    </tr>
+  </tbody>
+</table>
+
+
+
+[jabbify]: 			            http://jabbify.com
+[jabbify_comet]:            https://jabbify.com/home/comet_service

data/Rakefile

@@ -0,0 +1,13 @@
+require 'jeweler'
+
+Jeweler::Tasks.new do |gemspec|
+  gemspec.name        = 'rjab'
+  gemspec.summary     = %Q{A Ruby library for interacting with Jabbify.}
+  gemspec.description = %Q{A Ruby library for interacting with Jabbify. Simplifies the process of delivering messages to Jabbify's Comet server.}
+  gemspec.email       = 'matt+rjab@puchlerz.com'
+  gemspec.homepage    = 'http://github.com/mattpuchlerz/rjab'
+  gemspec.authors     = [ 'Matt Puchlerz' ]
+  gemspec.add_dependency 'rest-client', '>= 0.9.2'
+end
+
+Jeweler::GemcutterTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.2.2

data/lib/jabbify.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH << File.join( File.dirname(__FILE__), 'jabbify' )
+
+require 'comet'

data/lib/jabbify/comet.rb

@@ -0,0 +1,81 @@
+require 'rubygems'
+require 'restclient' # http://github.com/adamwiggins/rest-client
+
+module Jabbify
+  class Comet
+    
+    DEFAULT_ATTRIBUTES = {
+      :action  => :create,
+      :api_key => nil,
+      :message => nil,
+      :name    => 'Server',
+      :to      => nil,
+      :type    => :message,
+    }
+        
+    def initialize(custom_attributes = {})
+      @customized_attributes = DEFAULT_ATTRIBUTES.merge custom_attributes
+    end
+    
+    def attributes
+      @customized_attributes
+    end
+    
+    def deliver(overridden_attributes = {})
+      customized_attributes = @customized_attributes.dup
+      @customized_attributes.merge! overridden_attributes
+      return_value = false
+      
+      if valid?
+        begin
+          RestClient.post jabbify_uri, uri_params
+          return_value = true
+        rescue
+        end
+      end
+      
+      @customized_attributes = customized_attributes
+      return_value
+    end
+    
+    def self.deliver(options)
+      new(options).deliver
+    end
+    
+    def jabbify_uri
+      'https://jabbify.com:8443/message_push'
+    end
+    
+    def uri_params
+      { 
+        :action  => @customized_attributes[:action],
+        :key     => @customized_attributes[:api_key],
+        :message => @customized_attributes[:message],
+        :name    => @customized_attributes[:name],
+        :to      => @customized_attributes[:to],
+        :type    => @customized_attributes[:type],
+      }.reject { |key, value| value.nil? }
+    end
+    
+    def valid?
+      [ :api_key, :name, :message ].each do |attribute|
+        return false if @customized_attributes[attribute].nil? or @customized_attributes[attribute].strip.length == 0
+      end
+      true
+    end
+    
+    DEFAULT_ATTRIBUTES.keys.each do |attribute|
+      
+      define_method attribute do
+        attributes[attribute]
+      end
+      
+      define_method "#{attribute}=" do |value|
+        value = value.to_sym if [ :action, :type ].include? attribute
+        @customized_attributes[attribute] = value
+      end
+      
+    end
+    
+  end
+end

data/rjab.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rjab}
+  s.version = "0.2.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Matt Puchlerz"]
+  s.date = %q{2009-11-02}
+  s.description = %q{A Ruby library for interacting with Jabbify. Simplifies the process of delivering messages to Jabbify's Comet server.}
+  s.email = %q{matt+rjab@puchlerz.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/jabbify.rb",
+     "lib/jabbify/comet.rb",
+     "rjab.gemspec",
+     "spec/jabbify/comet_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mattpuchlerz/rjab}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A Ruby library for interacting with Jabbify.}
+  s.test_files = [
+    "spec/jabbify/comet_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rest-client>, [">= 0.9.2"])
+    else
+      s.add_dependency(%q<rest-client>, [">= 0.9.2"])
+    end
+  else
+    s.add_dependency(%q<rest-client>, [">= 0.9.2"])
+  end
+end
+

data/spec/jabbify/comet_spec.rb

@@ -0,0 +1,186 @@
+require File.join( File.dirname(__FILE__), *%w[ .. spec_helper ] )
+
+def common_attributes(attribute_overrides = {})
+  { 
+    :action  => :i_am_the_action,
+    :api_key => 'qwer1234qwer1234',
+    :message => 'This is the message!',
+    :name    => 'John Doe',
+    :to      => 'Jane Doe',
+    :type    => :i_am_the_type,
+  }.merge(attribute_overrides)
+end
+
+describe Jabbify::Comet do
+  
+  context "reading and writing attributes" do
+    
+    before(:each) do
+      @comet = Jabbify::Comet.new
+    end
+    
+    it "should be able to get a hash of all default attributes" do
+      Jabbify::Comet::DEFAULT_ATTRIBUTES.should == 
+        {
+          :action  => :create,
+          :api_key => nil,
+          :message => nil,
+          :name    => 'Server',
+          :to      => nil,
+          :type    => :message,
+        }
+    end
+    
+    it "should be able to get a hash of all the current attributes (customs merged into defaults)" do
+      @comet = Jabbify::Comet.new common_attributes
+      @comet.attributes.should == common_attributes
+    end
+    
+    it "should be able to read/write an 'api_key' attribute" do
+      @comet.api_key = 'qwer1234qwer1234'
+      @comet.api_key.should == 'qwer1234qwer1234'
+    end
+    
+    it "should be able to read/write a 'type' attribute as a symbol" do
+      @comet.type = 'i_am_the_type'
+      @comet.type.should == :i_am_the_type
+      @comet.type = :i_am_the_type
+      @comet.type.should == :i_am_the_type
+    end
+    
+    it "should be able to read/write an 'action' attribute as a symbol" do
+      @comet.action = 'i_am_the_action'
+      @comet.action.should == :i_am_the_action
+      @comet.action = :i_am_the_action
+      @comet.action.should == :i_am_the_action
+    end
+    
+    it "should be able to read/write a 'name' attribute" do
+      @comet.name = 'John Doe'
+      @comet.name.should == 'John Doe'
+    end
+    
+    it "should be able to read/write a 'message' attribute" do
+      @comet.message = 'This is the message!'
+      @comet.message.should == 'This is the message!'
+    end
+    
+    it "should be able to read/write a 'to' attribute" do
+      @comet.to = 'Jane Doe'
+      @comet.to.should == 'Jane Doe'
+    end
+    
+  end
+  
+  context "determining the validity of the attributes" do
+    
+    it "should be able to check the validity of the attributes" do
+      @comet = Jabbify::Comet.new
+      @comet.should respond_to(:valid?)
+    end
+
+    it "should not be valid if the 'api_key' attribute is blank" do
+      @comet = Jabbify::Comet.new common_attributes(:api_key => nil)
+      @comet.should_not be_valid
+      @comet = Jabbify::Comet.new common_attributes(:api_key => ' ')
+      @comet.should_not be_valid
+    end
+    
+    it "should not be valid if the 'name' attribute is blank" do
+      @comet = Jabbify::Comet.new common_attributes(:name => nil)
+      @comet.should_not be_valid
+      @comet = Jabbify::Comet.new common_attributes(:name => ' ')
+      @comet.should_not be_valid
+    end
+  
+    it "should not be valid if the 'message' attribute is blank" do
+      @comet = Jabbify::Comet.new common_attributes(:message => nil)
+      @comet.should_not be_valid
+      @comet = Jabbify::Comet.new common_attributes(:message => ' ')
+      @comet.should_not be_valid
+    end
+    
+    it "should be valid if all attributes are provided" do
+      @comet = Jabbify::Comet.new common_attributes
+      @comet.should be_valid
+    end
+    
+  end
+    
+  context "constructing the Jabbify URI" do
+    
+    it "should be able to get the Jabbify URI" do
+      @comet = Jabbify::Comet.new
+      URI.parse(@comet.jabbify_uri).should_not raise_error(URI::InvalidURIError)
+    end
+    
+    it "should be able to get a hash of all the needed URI parameters" do
+      @comet = Jabbify::Comet.new common_attributes
+      @comet.uri_params.should == 
+        { 
+          :action  => :i_am_the_action,
+          :key     => 'qwer1234qwer1234',
+          :message => 'This is the message!',
+          :name    => 'John Doe',
+          :to      => 'Jane Doe',
+          :type    => :i_am_the_type,
+        }
+    end
+    
+    it "should not include any URI parameters that are blank" do
+      @comet = Jabbify::Comet.new common_attributes(:to => nil)
+      @comet.uri_params.should == 
+        { 
+          :action  => :i_am_the_action,
+          :key     => 'qwer1234qwer1234',
+          :message => 'This is the message!',
+          :name    => 'John Doe',
+          :type    => :i_am_the_type,
+        }
+    end
+    
+  end
+  
+  context "delivering messages" do
+    
+    it "should be able to deliver messages" do
+      @comet = Jabbify::Comet.new
+      @comet.should respond_to(:deliver)
+    end
+    
+    it "should be able to override any attribute via a hash passed in during delivery" do
+      RestClient.should_receive(:post).and_return('body of response')
+      overridden_attributes = { :message => 'Different message', :name => 'Mr. Doe' }
+      
+      @comet = Jabbify::Comet.new common_attributes
+      @comet.deliver(overridden_attributes).should == true
+      @comet.attributes.should == common_attributes
+    end
+    
+    it "should not deliver if any attributes are invalid" do
+      @comet = Jabbify::Comet.new common_attributes(:api_key => nil)
+      @comet.deliver.should == false
+    end
+    
+    it "should not deliver if the request fails" do
+      RestClient.should_receive(:post).and_raise(RuntimeError)
+      @comet = Jabbify::Comet.new common_attributes
+      @comet.deliver.should == false
+    end
+    
+    it "should deliver if the request succeeds" do
+      RestClient.should_receive(:post).and_return('body of response')
+      @comet = Jabbify::Comet.new common_attributes
+      @comet.deliver.should == true
+    end
+    
+    it "should be able to handle one-off deliveries via a class method" do
+      comet = mock('Jabbify::Comet')
+      comet.should_receive(:deliver).and_return(true)
+      Jabbify::Comet.should_receive(:new).with(common_attributes).and_return(comet)
+      Jabbify::Comet.deliver(common_attributes).should == true
+    end
+  
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--colour
+--format progress
+--loadby mtime

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'spec'
+
+require File.join( File.dirname(__FILE__), *%w[ .. lib jabbify ]  )

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: rjab
+version: !ruby/object:Gem::Version 
+  version: 0.2.2
+platform: ruby
+authors: 
+- Matt Puchlerz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-02 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.2
+    version: 
+description: A Ruby library for interacting with Jabbify. Simplifies the process of delivering messages to Jabbify's Comet server.
+email: matt+rjab@puchlerz.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- README.markdown
+- Rakefile
+- VERSION
+- lib/jabbify.rb
+- lib/jabbify/comet.rb
+- rjab.gemspec
+- spec/jabbify/comet_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mattpuchlerz/rjab
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Ruby library for interacting with Jabbify.
+test_files: 
+- spec/jabbify/comet_spec.rb
+- spec/spec_helper.rb