smsinabox 0.2.0

data/lib/smsinabox/delivery_report.rb

@@ -0,0 +1,49 @@
+module Smsinabox
+  class DeliveryReport
+
+    class << self
+
+      # Generate a delivery report from a nokogiri response
+      def from_response( nokogiri_xml )
+        response = new
+
+        # basic send_info stuff
+        response.event_id = nokogiri_xml.xpath('/api_result/send_info/eventid/text()').to_s.to_i
+        response.credits = nokogiri_xml.xpath('/api_result/send_info/credits/text()').to_s.to_i
+        response.fail_count = nokogiri_xml.xpath('/api_result/send_info/msgs_failed/text()').to_s.to_i
+        response.success_count = nokogiri_xml.xpath('/api_result/send_info/msgs_success/text()').to_s.to_i
+
+        # failures
+        nokogiri_xml.xpath('/api_result/entries_failed').each do |node|
+          response.failures << {
+            :numto => node.xpath('./numto/text()').to_s,
+            :customerid => node.xpath('./customerid/text()').to_s,
+            :reason => node.xpath('./reason/text()').to_s
+          }
+        end
+
+        # successes
+        nokogiri_xml.xpath('/api_result/entries_success').each do |node|
+          response.successes << {
+            :numto => node.xpath('./numto/text()').to_s,
+            :customerid => node.xpath('./customerid/text()').to_s
+          }
+        end
+
+        response
+      end
+
+    end
+
+    attr_accessor :event_id, :credits, :fail_count, :success_count, :failures, :successes
+
+    def initialize
+      @fail_count = 0
+      @success_count = 0
+
+      @failures = []
+      @successes = []
+    end
+
+  end
+end

data/lib/smsinabox/exceptions.rb

@@ -0,0 +1,9 @@
+module Smsinabox
+  
+  class MissingCredentialException < Exception
+  end
+  
+  class MessageInvalid < Exception
+  end
+  
+end

data/lib/smsinabox/message.rb

@@ -0,0 +1,21 @@
+module Smsinabox
+
+  class Message
+
+    attr_accessor :recipient
+    attr_accessor :body
+
+    def initialize( options = {} )
+      @recipient = options.delete(:recipient)
+      @body      = options.delete(:body)
+    end
+
+    def valid?
+      !( @recipient.nil? || @body.nil? )
+    end
+
+    def body
+      @body.gsub( /\n/, '|' )
+    end
+  end
+end

data/lib/smsinabox/reply.rb

@@ -0,0 +1,27 @@
+module Smsinabox
+  class Reply
+
+    class << self
+
+      # Generate a reply from the nokogiri response fragment
+      def from_response( nokogiri_xml )
+        reply = new
+
+        reply.id = nokogiri_xml.xpath('./replyid/text()').to_s.to_i
+        reply.event_id = nokogiri_xml.xpath('./eventid/text()').to_s.to_i
+        reply.from = nokogiri_xml.xpath('./numfrom/text()').to_s
+        reply.message = nokogiri_xml.xpath('./receiveddata/text()').to_s
+        reply.sent_id = nokogiri_xml.xpath('./sentid/text()').to_s.to_i
+        reply.original = nokogiri_xml.xpath('./sentdata/text()').to_s
+        reply.sent_customer_id = nokogiri_xml.xpath('./sentcustomerid/text()').to_s
+        reply.received = nokogiri_xml.xpath('./received/text()').to_s
+        reply.sent = nokogiri_xml.xpath('./sentdatetime/text()').to_s
+
+        reply
+      end
+    end
+
+    attr_accessor :id, :event_id, :from, :message, :sent_id, :original,
+      :sent_customer_id, :received, :sent
+  end
+end

data/lib/smsinabox/sent_message.rb

@@ -0,0 +1,32 @@
+module Smsinabox
+  class SentMessage
+
+    class << self
+
+      # Generate a #SentMessage from a response xml fragment
+      def from_response( nokogiri_xml )
+        msg = new
+
+        msg.id = nokogiri_xml.xpath('./sentid/text()').to_s.to_i
+        msg.change_id = nokogiri_xml.xpath('./changeid/text()').to_s.to_i
+        msg.event_id = nokogiri_xml.xpath('./eventid/text()').to_s.to_i
+        msg.type = nokogiri_xml.xpath('./smstype/text()').to_s
+        msg.to = nokogiri_xml.xpath('./numto/text()').to_s
+        msg.message = nokogiri_xml.xpath('./data/text()').to_s
+        msg.flash = nokogiri_xml.xpath('./flash/text()').to_s == 'true'
+        msg.customer_id = nokogiri_xml.xpath('./customerid/text()').to_s
+        msg.status = nokogiri_xml.xpath('./status/text()').to_s
+        msg.status_date = nokogiri_xml.xpath('./statusdate/text()').to_s
+
+        msg
+      end
+    end
+
+    attr_accessor :id, :change_id, :event_id, :type, :to, :message, :flash,
+      :customer_id, :status, :status_date
+
+    def delivered?
+      @status == 'DELIVRD'
+    end
+  end
+end

data/lib/smsinabox/sms.rb

@@ -0,0 +1,4 @@
+module Smsinabox
+  class SMS < Message
+  end
+end

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/smsinabox.rb'}"
+puts "Loading smsinabox 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/smsinabox.gemspec

@@ -0,0 +1,101 @@
+# 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{smsinabox}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["kenneth.kalmer@gmail.com"]
+  s.date = %q{2010-06-18}
+  s.description = %q{Ruby API for sending text messages via http://www.smsinabox.co.za}
+  s.email = %q{kenneth.kalmer@gmail.com}
+  s.executables = ["sms-credit", "sms-send", "sms-setup"]
+  s.extra_rdoc_files = [
+    "History.txt",
+     "PostInstall.txt",
+     "README.rdoc",
+     "TODO.txt"
+  ]
+  s.files = [
+    ".gitignore",
+     "History.txt",
+     "PostInstall.txt",
+     "README.rdoc",
+     "Rakefile",
+     "TODO.txt",
+     "bin/sms-credit",
+     "bin/sms-send",
+     "bin/sms-setup",
+     "lib/smsinabox.rb",
+     "lib/smsinabox/configuration.rb",
+     "lib/smsinabox/delivery_report.rb",
+     "lib/smsinabox/exceptions.rb",
+     "lib/smsinabox/message.rb",
+     "lib/smsinabox/reply.rb",
+     "lib/smsinabox/sent_message.rb",
+     "lib/smsinabox/sms.rb",
+     "script/console",
+     "script/destroy",
+     "script/generate",
+     "smsinabox.gemspec",
+     "spec/delivery_report_spec.rb",
+     "spec/fixtures/sendparam_response.xml",
+     "spec/message_spec.rb",
+     "spec/reply_spec.rb",
+     "spec/sent_message_spec.rb",
+     "spec/smsinabox_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "tasks/deployment.rake",
+     "tasks/environment.rake",
+     "tasks/rspec.rake",
+     "tasks/website.rake"
+  ]
+  s.homepage = %q{http://github.com/kennethkalmer/smsinabox}
+  s.post_install_message = %q{
+For more information on smsinabox, see http://www.opensourcery.co.za/smsinabox
+
+Setup your account by running sms-setup now. You can then use the following
+commands to interact with SMS in a Box:
+
+sms-send: Send SMS messages
+sms-credit: Quick overview of the credit available
+sms-replies: Quick access to your replies
+sms-setup: To change the account details
+}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Ruby API for sending text messages via http://www.smsinabox.co.za}
+  s.test_files = [
+    "spec/delivery_report_spec.rb",
+     "spec/message_spec.rb",
+     "spec/reply_spec.rb",
+     "spec/sent_message_spec.rb",
+     "spec/smsinabox_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<nokogiri>, [">= 1.3.3"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+    else
+      s.add_dependency(%q<nokogiri>, [">= 1.3.3"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, [">= 1.3.3"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+  end
+end
+

data/spec/delivery_report_spec.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Smsinabox::DeliveryReport do
+  before(:each) do
+    f = File.open( File.dirname(__FILE__) + '/fixtures/sendparam_response.xml' )
+    sample_response = Nokogiri::XML( f )
+
+    @report = Smsinabox::DeliveryReport.from_response( sample_response )
+  end
+
+  it "should have an event id" do
+    @report.event_id.should be(27105067)
+  end
+
+  it "should have credits" do
+    @report.credits.should be(39763)
+  end
+
+  it "should know how many failed" do
+    @report.fail_count.should be(1)
+  end
+
+  it "should know how many succeeded" do
+    @report.success_count.should be(3)
+  end
+
+  it "should have a list of failures" do
+    @report.failures.should_not be_empty
+
+    f = @report.failures.first
+    f.should == { :numto => '', :customerid => '', :reason => 'numto invalid' }
+  end
+
+  it "should have a list of successes" do
+    @report.successes.should_not be_empty
+
+    s = @report.successes.first
+    s.should == { :numto => '27832297941', :customerid => 'UnqiueValue1' }
+  end
+end

data/spec/fixtures/sendparam_response.xml

@@ -0,0 +1,29 @@
+<api_result>
+  <entries_failed>
+    <numto />
+    <customerid />
+    <reason>numto invalid</reason>
+  </entries_failed>
+  <entries_success>
+    <numto>27832297941</numto>
+    <customerid>UnqiueValue1</customerid>
+  </entries_success>
+  <entries_success>
+    <numto>27832297941</numto>
+    <customerid>UnqiueValue1</customerid>
+  </entries_success>
+  <entries_success>
+    <numto>27832297941</numto>
+    <customerid>d47e1efd-5e4f-4832-ba7f-07f35d8c10f9</customerid>
+  </entries_success>
+  <send_info>
+    <eventid>27105067</eventid>
+    <credits>39763</credits>
+    <msgs_success>3</msgs_success>
+    <msgs_failed>1</msgs_failed>
+  </send_info>
+  <call_result>
+    <result>True</result>
+    <error />
+  </call_result>
+</api_result>

data/spec/message_spec.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Smsinabox::Message do
+  
+  it "should accept a recipient" do
+    message = Smsinabox::Message.new( :recipient => '5555555555' )
+    message.recipient.should eql('5555555555')
+    
+    message = Smsinabox::Message.new
+    message.recipient = '5555555555'
+    message.recipient.should eql('5555555555')
+  end
+  
+  it "should accept a body" do
+    message = Smsinabox::Message.new( :body => 'text' )
+    message.body.should eql('text')
+    
+    message = Smsinabox::Message.new
+    message.body = 'text'
+    message.body.should eql('text')
+  end
+  
+  it "should only be valid if both the recipient and body is set" do
+    message = Smsinabox::Message.new
+    message.should_not be_valid
+    
+    message.recipient = '5555555555'
+    message.should_not be_valid
+    
+    message.body = 'text'
+    message.should be_valid
+    
+    message.recipient = nil
+    message.should_not be_valid
+  end
+  
+  it "should replace newlines with pipe (|) characters" do
+    message = Smsinabox::Message.new
+    message.body = <<-EOF
+    This
+    needs
+    pipes
+    EOF
+
+    message.body.should match( /This|\s+needs|\s+pipes/ )
+  end
+end

data/spec/reply_spec.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Smsinabox::Reply do
+  before(:each) do
+    xml = <<-EOF
+    <api_result>
+    <data>
+    <replyid>3903103</replyid>
+    <eventid>33368123</eventid>
+    <numfrom>27123456789</numfrom>
+    <receiveddata>Bar</receiveddata>
+    <sentid>339548269</sentid>
+    <sentdata>Foo</sentdata>
+    <sentcustomerid/>
+    <received>10/Aug/2009 00:09:46</received>
+    <sentdatetime>07/Aug/2009 13:51:48</sentdatetime>
+    </data>
+    </api_result>
+    EOF
+    @xml_reply = Nokogiri::XML( xml )
+  end
+
+  it "should parse from response data" do
+    reply = Smsinabox::Reply.from_response( @xml_reply.xpath('/api_result/data').first )
+
+    reply.id.should == 3903103
+    reply.event_id.should == 33368123
+    reply.from.should == '27123456789'
+    reply.message.should == 'Bar'
+    reply.sent_id.should == 339548269
+    reply.original.should == 'Foo'
+    reply.sent_customer_id.should == ''
+    reply.received.should == '10/Aug/2009 00:09:46'
+    reply.sent.should == '07/Aug/2009 13:51:48'
+  end
+end