messagepub 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2009-03-06
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,19 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+Rakefile
+README.rdoc
+lib/messagepub.rb
+lib/messagepub/reply.rb
+lib/messagepub/recipient.rb
+lib/messagepub/notification.rb
+lib/messagepub/client.rb
+script/
+script/console
+script/destroy
+script/generate
+tasks/
+test/
+test/test_helper.rb
+test/test_messagepub.rb
+

data/PostInstall.txt

@@ -0,0 +1,4 @@
+
+For more information on messagepub, go to http://messagepub.com
+
+

data/README.rdoc

@@ -0,0 +1,97 @@
+= messagepub
+
+* Website: http://messagepub.com
+
+== DESCRIPTION:
+
+* MessagePub is a dead-simple messaging API that you can start using for your applications in less than 5 minutes.
+
+
+* Register for an API Key at http://messagepub.com
+
+
+* Support for the following platforms: Twitter, Google Chat, AIM, Email, Phone, and SMS.
+
+
+* Reach out to one person in multiple ways.
+
+
+* Helper libraries in multiple languages.
+
+
+* Schedule a message to be delivered in the future.
+
+
+* Set up an escalation schedule.
+
+
+* For more documentation on MessagePub, go to http://messagepub.com/documentation
+
+
+== FEATURES:
+
+You can currently do the following with the MessagePub gem:
+* List notifications on your account.
+* Get a notification from your account.
+* Create a new notification.
+* Get all replies from your account.
+
+== SYNOPSIS:
+
+# Get latest notifications from your account
+
+client = MessagePub::Client.new('YOURAPIKEY')
+
+notifications = client.notifications
+
+# Get the notification with id = 1
+
+notification = client.notification(1)
+
+# Get all the replies from your account
+
+replies = notification.replies
+
+# Create a new notification
+
+n = MessagePub::Notification.new(:body => 'your message goes here', :escalation => 20)
+
+n.add_recipient(MessagePub::Recipient.new(:position => 1, :channel => 'twitter', :address => 'sharememeinc'))
+
+n.add_recipient(MessagePub::Recipient.new(:position => 2, :channel => 'sms', :address => '9998887777'))
+
+client.create!(n)
+
+
+== REQUIREMENTS:
+
+* Only one dependency: httparty
+
+== INSTALL:
+
+* sudo gem install messagepub
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Luc Castera
+
+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/Rakefile

@@ -0,0 +1,28 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/messagepub'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('messagepub', Messagepub::VERSION) do |p|
+  p.developer('Luc Castera', 'luc.castera@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt'
+  p.rubyforge_name       = p.name # TODO this is default value
+  p.extra_deps         = [
+     ['httparty','>= 0.3.1'],
+   ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/lib/messagepub/client.rb

@@ -0,0 +1,111 @@
+# This module encapsulates functionality to interface with the MessagePub Rest API.
+module MessagePub
+
+  # Implements a client object to communicate with the MessagePub Rest API.
+  class Client
+    include HTTParty
+    base_uri 'messagepub.com'
+    format :xml
+    headers 'Content-Type' => 'text/xml', 'Accept' => 'text/xml'
+    
+    # To create a new MessagePub::Client, you need to pass in your MessagePub API Key.
+    # 
+    # <tt>client = MessagePub::Client.new('YOURAPIKEYGOESHERE')</tt>
+    #
+    # You can also set it in your environment by putting the following line in your .bashrc file.
+    #
+    # <tt>export MESSAGEPUB_API_KEY=YOURKEY</tt>
+    #
+    # In that case, you can initialize a new client by simply saying:
+    #
+    # <tt>client = MessagePub::Client.new</tt>
+    def initialize(api_key=nil)
+      @api_key = api_key || ENV['MESSAGEPUB_API_KEY']
+      self.class.basic_auth @api_key, 'password'
+    end
+    
+    
+    # Gets a list of the last notifications sent
+    # Returns an array of MessagePub::Notification objects.
+    #
+    # <tt>client = MessagePub::Client.new('YOURAPIKEYGOESHERE')</tt>
+    #
+    # <tt>n = client.notifications</tt>    
+    def notifications
+      response = self.class.get('/notifications.xml')
+      notifications_array = []
+      response['notifications'].each do |note|
+        new_note = Notification.new(:body => note["body"],
+                                    :send_at => note["send_at"],
+                                    :id => note["id"],
+                                    :escalation => note["escalation"])
+        note["recipients"].each do |rcpt|
+          new_note.add_recipient(Recipient.new(:id => rcpt["id"],
+                                               :channel => rcpt["channel"],
+                                               :address => rcpt["address"],
+                                               :status  => rcpt["status"],
+                                               :send_at => rcpt["send_at"]))
+        end
+        notifications_array << new_note        
+      end
+      notifications_array
+    end
+    
+    # Gets the notification for the unique id specified.
+    # Returns a MessagePub::Notification object.
+    # <tt>my_notification = client.notification(4)</tt>
+    def notification(id)
+      response = self.class.get("/notifications/" + id.to_s + ".xml")
+      note = response["notification"]
+      new_note = Notification.new( :body => note["body"],
+                                   :id => note["id"],
+                                   :send_at => note["send_at"],
+                                   :escalation => note["escalation"])
+      note["recipients"].each do |rcpt|
+        new_note.add_recipient(Recipient.new(:id => rcpt["id"],
+                                             :channel => rcpt["channel"],
+                                             :address => rcpt["address"],
+                                             :status  => rcpt["status"],
+                                             :send_at => rcpt["send_at"]))
+      end
+      new_note       
+    end
+    
+    # Creates a new notification.
+    #
+    # <tt>note = MessagePub::Notification.new</tt>
+    #
+    # <tt>note.body = 'The servers are down.'</tt>
+    #
+    # <tt>note.escalation = 15</tt>
+    #
+    # <tt>note.save</tt>
+    #
+    # <tt>note.add_recipient(MessagePub::Recipient.new(:position => 1, :channel => 'aim', :address => 'username'))</tt>
+    #
+    # <tt>note.add_recipient(MessagePub::Recipient.new(:position => 1, :channel => 'email', :address => 'joe@example.com'))</tt>
+    #
+    # <tt>client.create!(note)</tt>
+    def create!(note)
+      self.class.post('/notifications.xml', :body => note.to_xml)
+    end
+    
+    # Gets a list of the latest replies to your notifications.
+    # Returns an array of MessagePub::Reply objects
+    #
+    # <tt>my_replies = client.replies</tt>
+    def replies
+      response = self.class.get("/replies.xml")
+      replies_array = []
+      response['replies'].each do |reply|
+        new_reply = Reply.new(:id => reply['id'], :body => reply['body'],
+                              :channel => reply['channel'], :address => reply['address'],
+                              :notification_id => reply['notification_id'])
+        replies_array << new_reply
+      end
+      replies_array
+    end
+  
+  end
+
+end

data/lib/messagepub/notification.rb

@@ -0,0 +1,57 @@
+module MessagePub
+
+  # Represents a MessagePub notification.
+  # For more info, visit http://messagepub.com/documentation
+  class Notification  
+    
+    # The body of the message to send.
+    attr_accessor :body
+    
+    # The amount of time (in minutes) to wait before sending to the next recipient in the list.
+    attr_accessor :escalation
+    
+    # If postback_url is set in your account settings, this is the URL where MessagePub will post
+    # any replies it gets for this notification. 
+    # For more info, visit http://messagepub.com/documentation/replies.
+    attr_accessor :postback_url
+    
+    # The time in UTC at which the notification will be sent.
+    attr_accessor :send_at
+    
+    # The unique id for the notification.
+    attr_accessor :id
+    
+    # The array of recipients to which this notification will go to.
+    attr_reader :recipients
+  
+    def initialize(options={})
+      @body = options[:body]
+      @escalation = options[:escalation]
+      @postback_url = options[:postback_url]
+      @send_at = options[:send_at]
+      @recipients = []
+      @id = nil
+    end
+    
+    def add_recipient(rcpt)
+      @recipients << rcpt if rcpt.class == Recipient        
+    end
+    
+    # Returns an XML representation of the notification that can be POSTed to the REST API.    
+    def to_xml
+      value = '<notification>'
+      value += '<body>' + self.body + '</body>'
+      value += '<escalation>' + self.escalation.to_s + '</escalation>' if self.escalation
+      value += '<postback_url>' + self.postback_url + '</postback_url>' if self.postback_url
+      value += '<send_at>' + self.send_at + '</send_at>' if self.send_at
+      value += '<recipients>'
+      self.recipients.each do |rcpt|
+        value += rcpt.to_xml
+      end
+      value += '</recipients></notification>'
+      value            
+    end
+  
+  end
+
+end

data/lib/messagepub/recipient.rb

@@ -0,0 +1,43 @@
+module MessagePub
+
+  # Represents a MessagePub recipient.
+  # For more info, visit http://messagepub.com/documentation
+  class Recipient
+  
+    # The position of this recipient in the list of recipients for the notification.
+    attr_accessor :position
+    
+    # The communication channel for the recipient.
+    # It can be one of: sms, phone, email, twitter, aim, gchat
+    attr_accessor :channel
+    
+    # The address for recipient.
+    # Depending on the channel, this can be a phone number, an email, a username, etc...
+    attr_accessor :address
+    
+    # The unique id for this recipient for that particular notification.
+    attr_accessor :id
+    
+    # The status of this recipient. Can be one of: sending, scheduled, sent, received, or failed
+    attr_accessor :status
+  
+    def initialize(options={})
+      @position = options[:position]
+      @channel = options[:channel]
+      @address = options[:address]
+      @id = options[:id]
+      @status = options[:status]
+    end
+    
+    # Returns an XML representation of the recipient.
+    def to_xml
+		  value = '<recipient>'
+		  value += '<position>' + self.position.to_s + '</position>'
+		  value += '<channel>' + self.channel + '</channel>'
+		  value += '<address>' + self.address + '</address>'                
+		  value += '</recipient>'
+		  value
+    end
+    
+  end
+end

data/lib/messagepub/reply.rb

@@ -0,0 +1,33 @@
+module MessagePub
+
+  # Represents a MessagePub reply..
+  # For more info, visit http://messagepub.com/documentation/replies
+  class Reply
+    
+    # The ID of the notification associated with this reply.
+    attr_accessor :notification_id
+    
+    # The communication channel where this reply was done.
+    # Must be one of the following: sms, phone, email, twitter, gchat, aim.
+    attr_accessor :channel
+    
+    # The address for the person that replies.
+    # Depending on the channel, this can be a phone number, an email, a username, etc...
+    attr_accessor  :address
+    
+    # The content of the reply.
+    attr_accessor :body
+    
+    # The unique id for this reply.
+    attr_accessor :id
+  
+    def initialize(options={})
+      @notification_id = options[:notification_id]
+      @channel = options[:channel]
+      @address = options[:address]
+      @body = options[:body]
+      @id = nil
+    end
+  end
+
+end

data/lib/messagepub.rb

@@ -0,0 +1,15 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Messagepub
+  VERSION = '0.0.1'
+end
+
+require 'rubygems'
+require 'httparty'
+
+require 'messagepub/recipient'
+require 'messagepub/notification'
+require 'messagepub/reply'
+require 'messagepub/client'
+

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/messagepub.rb'}"
+puts "Loading messagepub gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/messagepub'

data/test/test_messagepub.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestMessagepub < Test::Unit::TestCase
+
+  def setup
+    @recipient = MessagePub::Recipient.new(:position => 1, 
+                       :channel => 'twitter', 
+                       :address => 'luccastera')
+
+    @notification = MessagePub::Notification.new(:body => 'This is a test',
+                       :escalation => 20,
+                       :postback_url => 'http://messagepub.com/documentation/postback_test')
+    
+    @reply = MessagePub::Reply.new(:body => 'Test reply', :channel => 'twitter', :address => 'ab')
+  end
+  
+  def test_create_recipient
+    assert_equal 1, @recipient.position
+    assert_equal 'twitter', @recipient.channel
+    assert_equal 'luccastera', @recipient.address
+  end
+  
+  def test_create_notification
+    assert_equal 'This is a test', @notification.body
+    assert_equal 20, @notification.escalation
+    assert_equal 'http://messagepub.com/documentation/postback_test',@notification.postback_url
+  end
+  
+  def test_add_recipient_to_notification
+    assert_equal 0, @notification.recipients.size
+    @notification.add_recipient(@recipient)
+    assert_equal 1, @notification.recipients.size
+  end
+  
+  def test_create_reply
+    assert_equal 'Test reply', @reply.body
+    assert_equal 'twitter', @reply.channel
+    assert_equal 'ab', @reply.address
+  end
+  
+  
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: messagepub
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Luc Castera
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-09 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: "* MessagePub is a dead-simple messaging API that you can start using for your applications in less than 5 minutes.   * Register for an API Key at http://messagepub.com   * Support for the following platforms: Twitter, Google Chat, AIM, Email, Phone, and SMS.   * Reach out to one person in multiple ways.   * Helper libraries in multiple languages.   * Schedule a message to be delivered in the future.   * Set up an escalation schedule.   * For more documentation on MessagePub, go to http://messagepub.com/documentation"
+email: 
+- luc.castera@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- Rakefile
+- README.rdoc
+- lib/messagepub.rb
+- lib/messagepub/reply.rb
+- lib/messagepub/recipient.rb
+- lib/messagepub/notification.rb
+- lib/messagepub/client.rb
+- script/
+- script/console
+- script/destroy
+- script/generate
+- tasks/
+- test/
+- test/test_helper.rb
+- test/test_messagepub.rb
+has_rdoc: true
+homepage: "Website: http://messagepub.com"
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+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: messagepub
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: "* MessagePub is a dead-simple messaging API that you can start using for your applications in less than 5 minutes"
+test_files: 
+- test/test_messagepub.rb
+- test/test_helper.rb