mattpuchlerz-rjab 0.1.1

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Matt Puchlerz
+
+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.markdown

@@ -0,0 +1,51 @@
+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 mattpuchlerz-rjab -s http://gems.github.com
+		
+Utilizing the Library
+---------------------
+
+    require 'rubygems'
+    require 'jabbify'
+	
+For one-off message deliveries, you might find it easiest to use the class method:
+
+    Jabbify::Comet.deliver(
+      :api_key => 'YourApiKeyGoesHere',
+      :type    => :message,
+      :action  => :create,
+      :name    => 'John Doe',
+      :message => 'This is the message!',
+      :to      => 'Jane Doe',
+    )
+
+Or you could always instantiate an instance, and deliver when you're ready:
+
+    defaults = {
+      :api_key => 'YourApiKeyGoesHere',
+      :type    => :message,
+      :action  => :create,
+      :name    => 'The Server'
+    }
+    
+    @comet = Jabbify::Comet.new defaults
+    @comet.message = "The time is now #{ Time.now }"
+    
+    if @comet.deliver
+      # do something
+    else
+      # do something else
+    end
+
+
+
+[jabbify]: 			 http://jabbify.com
+[jabbify_comet]: https://jabbify.com/home/comet_service

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+require 'spec/rake/spectask'
+require 'jeweler'
+
+
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+
+  gem.name        = 'rjab'
+  gem.summary     = %Q{A Ruby library for interacting with Jabbify.}
+  gem.description = %Q{A Ruby library for interacting with Jabbify. Simplifies the process of delivering messages to Jabbify's Comet server.}
+  gem.email       = 'matt@puchlerz.com'
+  gem.homepage    = 'http://github.com/mattpuchlerz/rjab'
+  gem.authors     = [ 'Matt Puchlerz' ]
+  gem.add_dependency 'adamwiggins-rest-client', '>= 0.9.2'  
+end
+
+
+
+spec_files = FileList['spec/**/*_spec.rb']
+
+desc 'Run all specs'
+Spec::Rake::SpecTask.new(:spec) do |task|
+  task.spec_opts  = ['--colour --format progress --loadby mtime --reverse']
+  task.spec_files = spec_files
+end
+task :default => :spec
+
+desc 'Run all examples with RCov'
+Spec::Rake::SpecTask.new(:rcov) do |task|
+	task.rcov       = true
+  task.spec_opts  = ['--colour --format progress --loadby mtime --reverse']
+	task.spec_files = spec_files
+end
+
+
+
+# require 'rake/rdoctask'
+# Rake::RDocTask.new do |rdoc|
+#   if File.exist?('VERSION.yml')
+#     config = YAML.load(File.read('VERSION.yml'))
+#     version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+#   else
+#     version = ""
+#   end
+# 
+#   rdoc.rdoc_dir = 'rdoc'
+#   rdoc.title = "rjab #{version}"
+#   rdoc.rdoc_files.include('README*')
+#   rdoc.rdoc_files.include('lib/**/*.rb')
+# end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/jabbify/comet.rb

@@ -0,0 +1,58 @@
+require 'rubygems'
+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) }
+    end
+    
+    def action=(action)
+      @action = action.to_sym
+    end
+    
+    def deliver
+      return false unless valid?
+      begin
+        RestClient.post jabbify_uri, uri_params
+        true
+      rescue
+        false
+      end
+    end
+    
+    def jabbify_uri
+      'https://jabbify.com:8443/message_push'
+    end
+    
+    def type=(type)
+      @type = type.to_sym
+    end
+    
+    def uri_params
+      { 
+        :action  => action,
+        :key     => api_key,
+        :message => message,
+        :name    => name,
+        :to      => to,
+        :type    => type 
+      }.reject { |key, val| val.nil? }
+    end
+    
+    def valid?
+      %w[ api_key name message ].each do |attribute|
+        return false if send(attribute).nil? 
+      end
+      true
+    end
+    
+    def self.deliver(options)
+      new(options).deliver
+    end
+    
+  end
+end

data/lib/jabbify.rb

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

data/rjab.gemspec

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rjab}
+  s.version = "0.1.1"
+
+  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.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 = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/jabbify.rb",
+     "lib/jabbify/comet.rb",
+     "rjab.gemspec",
+     "spec/jabbify/comet_spec.rb",
+     "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.3}
+  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<adamwiggins-rest-client>, [">= 0.9.2"])
+    else
+      s.add_dependency(%q<adamwiggins-rest-client>, [">= 0.9.2"])
+    end
+  else
+    s.add_dependency(%q<adamwiggins-rest-client>, [">= 0.9.2"])
+  end
+end

data/spec/jabbify/comet_spec.rb

@@ -0,0 +1,164 @@
+require File.join( File.dirname(__FILE__), *%w[ .. spec_helper ] )
+
+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 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
+    
+    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
+    
+    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 defaults(:api_key => nil)
+      @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.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.should_not be_valid
+    end
+    
+    it "should be valid if all attributes are provided" do
+      @comet = Jabbify::Comet.new defaults
+      @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 defaults
+      @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 defaults(: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 not deliver if any attributes are invalid" do
+      @comet = Jabbify::Comet.new defaults(: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.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.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
+    end
+  
+  end
+  
+end

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,73 @@
+--- !ruby/object:Gem::Specification 
+name: mattpuchlerz-rjab
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Matt Puchlerz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-22 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: adamwiggins-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@puchlerz.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/jabbify.rb
+- lib/jabbify/comet.rb
+- rjab.gemspec
+- spec/jabbify/comet_spec.rb
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/mattpuchlerz/rjab
+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.2.0
+signing_key: 
+specification_version: 3
+summary: A Ruby library for interacting with Jabbify.
+test_files: 
+- spec/jabbify/comet_spec.rb
+- spec/spec_helper.rb