smsinabox 0.2.0

data/spec/sent_message_spec.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Smsinabox::SentMessage do
+  before(:each) do
+    xml = <<-EOF
+    <api_result>
+    <data>
+    <changeid>26053853</changeid>
+    <sentid>339611089</sentid>
+    <eventid>33369735</eventid>
+    <smstype>SMS</smstype>
+    <numto>27123456789</numto>
+    <data>Foo</data>
+    <flash>false</flash>
+    <customerid/>
+    <status>DELIVRD</status>
+    <statusdate>07/Aug/2009 14:13:44</statusdate>
+    </data>
+    </api_result>
+    EOF
+
+    @xml_response = Nokogiri::XML( xml )
+  end
+
+  it "should parse the sent message from the response" do
+    sent = Smsinabox::SentMessage.from_response( @xml_response.xpath('/api_result/data').first )
+
+    sent.id.should == 339611089
+    sent.change_id.should == 26053853
+    sent.event_id.should == 33369735
+    sent.type.should == 'SMS'
+    sent.to.should == '27123456789'
+    sent.message.should == 'Foo'
+    sent.flash.should be_false
+    sent.customer_id.should == ''
+    sent.status.should == 'DELIVRD'
+    sent.should be_delivered
+    sent.status_date.should == '07/Aug/2009 14:13:44'
+  end
+end

data/spec/smsinabox_spec.rb

@@ -0,0 +1,80 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Smsinabox, "configuration" do
+
+  it "should have a default base URI" do
+    Smsinabox.uri.to_s.should == "http://www.mymobileapi.com/api5/http5.aspx"
+  end
+
+  it "should accept a username" do
+    Smsinabox.username = 'test'
+    Smsinabox.username.should eql('test')
+  end
+
+  it "should accept a password" do
+    Smsinabox.password = 'test'
+    Smsinabox.password.should eql('test')
+  end
+
+end
+
+describe Smsinabox do
+  before do
+    Smsinabox.username = 'test'
+    Smsinabox.password = 'test'
+  end
+
+  it "should know how much credit is available" do
+    #response = Object.new
+    #response.expects(:body).returns("<api_result><data><credits>0</credits></data><call_result><result>True</result><error /></call_result></api_result>")
+    #Net::HTTP.expects(:post_form).with( Smsinabox.uri, { :Type => 'credits', :Username => 'test', :Password => 'test'} ).returns( response )
+    mock_request(
+      {'Type' => 'credits', 'Username' => 'test', 'Password' => 'test'},
+      "<api_result><data><credits>0</credits></data><call_result><result>True</result><error /></call_result></api_result>"
+    )
+
+    Smsinabox.credit_remaining.should be(0)
+  end
+
+  it "should be able to deliver SMS-type messages" do
+    mock_request(
+      has_entries({ 'Type' => 'sendparam', 'Username' => 'test', 'Password' => 'test', 'numto' => '0123456789', 'data1' => 'Foo' }),
+      "<api_result><send_info><eventid>1</eventid><credits>1</credits><msgs_success>1</msgs_success></send_info><entries_success><numto>0123456789</numto></entries_success></api_result>"
+    )
+
+    sms = Smsinabox::SMS.new( :recipient => '0123456789', :body => 'Foo')
+    res = Smsinabox.deliver( sms )
+
+    res.should be_a( Smsinabox::DeliveryReport )
+    res.success_count.should be(1)
+  end
+
+  it "should be able to retrieve replies" do
+    mock_request(
+      has_entries({'Type' => 'replies', 'Username' => 'test', 'Password' => 'test', 'XMLData' => "<reply><settings><id>0</id><max_recs>100</max_recs><cols_returned>eventid,numfrom,receiveddata,received,sentid,sentdata,sentdatetime,sentcustomerid</cols_returned></settings></reply>"}),
+      "<api_result><data><replyid></replyid><eventid></eventid><numfrom>0123456789</numfrom><receiveddata>Bar</receiveddata><sentid></sentid><sentdata>Foo</sentdata><sentcustomerid/><received></received><senddatetime></senddatetime></data></api_result>"
+    )
+
+    Smsinabox.replies do |reply|
+      reply.should be_a( Smsinabox::Reply )
+      reply.from.should == '0123456789'
+      reply.message.should == 'Bar'
+      reply.original.should == 'Foo'
+    end
+  end
+
+  it "should be able to retrieve sent data" do
+    mock_request(
+      has_entries({'Type' => 'sent', 'Username' => 'test', 'Password' => 'test', 'XMLData' => "<sent><settings><id>0</id><max_recs>100</max_recs><cols_returned>sentid,eventid,smstype,numto,data,flash,customerid,status,statusdate</cols_returned></settings></sent>"}),
+      "<api_result><data><changeid></changeid><sentid></sentid><eventid></eventid><smstype>SMS</smstype><numto>0123456789</numto><data>Foo</data><flash>false</flash><customerid/><status>DELIVRD</status><statusdate></statusdate></data></api_result>"
+    )
+
+    results = Smsinabox.sent
+    results.size.should == 1
+
+    item = results.first
+    item.to.should == '0123456789'
+    item.message.should == 'Foo'
+    item.type.should == 'SMS'
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'smsinabox'
+
+Spec::Runner.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+end
+
+# Horrible tactics to mock Net::HTTP
+def mock_request( params, response_body )
+  mock_post = {}
+  mock_post.expects(:set_form_data).with(params)
+  #mock.expects(:[]=).with('user-agent', anything)
+
+  url = Smsinabox.uri
+  Net::HTTP::Post.expects(:new).with( url.path ).returns(mock_post)
+
+  response = Net::HTTPSuccess.new('1.1', 200, 'OK')
+  response.instance_variable_set :@body, response_body
+  response.instance_variable_set :@read, true
+
+  mock_http = Object.new
+  mock_http.expects(:start).returns(response)
+
+  Net::HTTP.expects(:new).with( url.host, url.port ).returns(mock_http)
+end

data/tasks/deployment.rake

@@ -0,0 +1,34 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

data/tasks/website.rake

@@ -0,0 +1,9 @@
+# stubs for the website generation
+# To install the website framework:
+#   script/generate website
+
+task :website_generate
+
+task :website_upload
+
+task :website => :publish_docs

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification 
+name: smsinabox
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- kenneth.kalmer@gmail.com
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-18 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Ruby API for sending text messages via http://www.smsinabox.co.za
+email: kenneth.kalmer@gmail.com
+executables: 
+- sms-credit
+- sms-send
+- sms-setup
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- PostInstall.txt
+- README.rdoc
+- TODO.txt
+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
+has_rdoc: true
+homepage: http://github.com/kennethkalmer/smsinabox
+licenses: []
+
+post_install_message: |
+  
+  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
+
+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: Ruby API for sending text messages via http://www.smsinabox.co.za
+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