mattpuchlerz-rjab 0.1.1 → 0.2.0

data/README.markdown

@@ -16,35 +16,77 @@ Utilizing the Library
     require 'rubygems'
     require 'jabbify'
 	
-For one-off message deliveries, you might find it easiest to use the class method:
+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    => :message,
-      :action  => :create,
+      :type    => :type_of_delivery,
+      :action  => :action_of_delivery,
       :name    => 'John Doe',
       :message => 'This is the message!',
       :to      => 'Jane Doe',
     )
 
-Or you could always instantiate an instance, and deliver when you're ready:
+More commonly, you will instantiate an instance of `Jabbify::Comet` with a few customized attributes. Then you can just call `#deliver` whenever you're ready, passing in a couple more attributes which will *only be used during the delivery*:
 
-    defaults = {
+    custom_attributes = {
       :api_key => 'YourApiKeyGoesHere',
-      :type    => :message,
-      :action  => :create,
       :name    => 'The Server'
     }
     
-    @comet = Jabbify::Comet.new defaults
-    @comet.message = "The time is now #{ Time.now }"
+    @comet = Jabbify::Comet.new(custom_attributes)
     
-    if @comet.deliver
+    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>
+  <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>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>The message to deliver to the Comet server.</td>
+    </tr>
+    <tr>
+      <td><code>:name</code></td>
+      <td><code>'Server'</code></td>
+      <td>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

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/jabbify/comet.rb

@@ -4,54 +4,78 @@ require 'restclient' # http://github.com/adamwiggins/rest-client
 module Jabbify
   class Comet
     
-    attr_accessor :action, :api_key, :message, :name, :to, :type
-    
-    def initialize(options = {})
-      options.each_pair { |key, val| send("#{ key }=", val) }
+    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
+      @overridden_attributes = {}
     end
     
-    def action=(action)
-      @action = action.to_sym
+    def attributes
+      @customized_attributes
     end
     
-    def deliver
-      return false unless valid?
-      begin
-        RestClient.post jabbify_uri, uri_params
-        true
-      rescue
-        false
+    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 jabbify_uri
-      'https://jabbify.com:8443/message_push'
+    def self.deliver(options)
+      new(options).deliver
     end
     
-    def type=(type)
-      @type = type.to_sym
+    def jabbify_uri
+      'https://jabbify.com:8443/message_push'
     end
     
     def uri_params
       { 
-        :action  => action,
-        :key     => api_key,
-        :message => message,
-        :name    => name,
-        :to      => to,
-        :type    => type 
-      }.reject { |key, val| val.nil? }
+        :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?
-      %w[ api_key name message ].each do |attribute|
-        return false if send(attribute).nil? 
+      [ :api_key, :name, :message ].each do |attribute|
+        return false if @customized_attributes[attribute].nil? or @customized_attributes[attribute].strip.length == 0
       end
       true
     end
     
-    def self.deliver(options)
-      new(options).deliver
+    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

data/rjab.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rjab}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matt Puchlerz"]
-  s.date = %q{2009-05-22}
+  s.date = %q{2009-05-23}
   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@puchlerz.com}
   s.extra_rdoc_files = [

data/spec/jabbify/comet_spec.rb

@@ -1,41 +1,58 @@
 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
   
-  def defaults(options = {})
-    { 
-      :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(options)
-  end
-  
   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
+      @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
+      @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
@@ -53,16 +70,6 @@ describe Jabbify::Comet do
       @comet.to.should == 'Jane Doe'
     end
     
-    it "should be able to write any attribute via a hash passed in during initialization" do
-      @comet = Jabbify::Comet.new defaults
-      @comet.api_key.should == 'qwer1234qwer1234'
-      @comet.type.should    == :i_am_the_type
-      @comet.action.should  == :i_am_the_action
-      @comet.name.should    == 'John Doe'
-      @comet.message.should == 'This is the message!'
-      @comet.to.should      == 'Jane Doe'
-    end
-    
   end
   
   context "determining the validity of the attributes" do
@@ -73,22 +80,28 @@ describe Jabbify::Comet do
     end
 
     it "should not be valid if the 'api_key' attribute is blank" do
-      @comet = Jabbify::Comet.new defaults(:api_key => nil)
+      @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 defaults(:name => nil)
+      @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 defaults(:message => nil)
+      @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 defaults
+      @comet = Jabbify::Comet.new common_attributes
       @comet.should be_valid
     end
     
@@ -102,7 +115,7 @@ describe Jabbify::Comet do
     end
     
     it "should be able to get a hash of all the needed URI parameters" do
-      @comet = Jabbify::Comet.new defaults
+      @comet = Jabbify::Comet.new common_attributes
       @comet.uri_params.should == 
         { 
           :action  => :i_am_the_action,
@@ -115,7 +128,7 @@ describe Jabbify::Comet do
     end
     
     it "should not include any URI parameters that are blank" do
-      @comet = Jabbify::Comet.new defaults(:to => nil)
+      @comet = Jabbify::Comet.new common_attributes(:to => nil)
       @comet.uri_params.should == 
         { 
           :action  => :i_am_the_action,
@@ -135,28 +148,37 @@ describe Jabbify::Comet do
       @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 defaults(:api_key => nil)
+      @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 defaults
+      @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 defaults
+      @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(defaults).and_return(comet)
-      Jabbify::Comet.deliver(defaults).should == true
+      Jabbify::Comet.should_receive(:new).with(common_attributes).and_return(comet)
+      Jabbify::Comet.deliver(common_attributes).should == true
     end
   
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mattpuchlerz-rjab
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Matt Puchlerz
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-22 00:00:00 -07:00
+date: 2009-05-23 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency