bobes-textmagic 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Vladimir Bobes Tuzinsky
+
+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.rdoc

@@ -0,0 +1,7 @@
+= textmagic
+
+Documentation will come soon.
+
+== Copyright
+
+Copyright (c) 2009 Vladimir Bobes Tuzinsky. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "textmagic"
+    gem.summary = %Q{Ruby interface to the TextMagic's SMS gateway}
+    gem.email = "vladimir.tuzinsky@gmail.com"
+    gem.homepage = "http://github.com/bobes/textmagic"
+    gem.authors = ["Vladimir Bobes Tuzinsky"]
+    gem.rubyforge_project = "textmagic"
+  end
+
+  Jeweler::RubyforgeTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+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 = "textmagic #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 0

data/lib/api.rb

@@ -0,0 +1,34 @@
+module TextMagic
+
+  class API
+
+    def initialize(username, password)
+      @username = username
+      @password = password
+    end
+
+    def account
+      response = Executor.execute('account', @username, @password)
+      response['balance'] = response['balance'].to_f
+      response
+    end
+
+    def send(text, *args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      phones = args.flatten.join(',')
+      Executor.execute('send', @username, @password, options.merge(:text => text, :phone => phones))
+    end
+
+    def message_status(*ids)
+      Executor.execute('message_status', @username, @password, :ids => ids.flatten.join(','))
+    end
+
+    def receive
+      Executor.execute('receive', @username, @password)
+    end
+
+    def delete_reply(*ids)
+      Executor.execute('delete_reply', @username, @password, :ids => ids.flatten.join(','))
+    end
+  end
+end

data/lib/error.rb

@@ -0,0 +1,18 @@
+module TextMagic
+
+  class API
+
+    class Error < StandardError
+
+      attr_reader :code, :message
+
+      def initialize(response)
+        @code, @message = response[:error_code], response[:error_message]
+      end
+
+      def to_s
+        "#{@message} (#{@code})"
+      end
+    end
+  end
+end

data/lib/executor.rb

@@ -0,0 +1,18 @@
+module TextMagic
+
+  class API
+
+    class Executor
+
+      include HTTParty
+      base_uri "https://www.textmagic.com/app"
+
+      def self.execute(command, username, password, options = {})
+        options.merge!(:username => username, :password => password, :cmd => command)
+        response = self.get('/api', :query => options, :format => :json)
+        raise Error.new(response) if response['error_code']
+        response
+      end
+    end
+  end
+end

data/lib/textmagic.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+gem 'httparty'
+require 'httparty'
+require 'api'
+require 'executor'
+require 'error'
+
+module TextMagic
+end

data/test/test_api.rb

@@ -0,0 +1,192 @@
+require 'test_helper'
+
+class APITest < Test::Unit::TestCase
+
+  def prepare_api(command, raw_response, options = {})
+    FakeWeb.allow_net_connect = false
+
+    @username, @password = random_string, random_string
+    uri = build_uri(command, @username, @password, options)
+    FakeWeb.register_uri(:get, uri, :string => raw_response)
+    TextMagic::API.new(@username, @password)
+  end
+
+  context 'Initialization' do
+
+    should 'require username and password' do
+      lambda { TextMagic::API.new }.should raise_error
+      TextMagic::API.new(random_string, random_string)
+    end
+  end
+
+  context 'Account command' do
+
+    setup do
+      @username, @password = random_string, random_string
+      @api = TextMagic::API.new(@username, @password)
+    end
+
+    should 'call Executor execute with correct arguments' do
+      TextMagic::API::Executor.expects(:execute).with('account', @username, @password).returns({})
+      @api.account
+    end
+
+    should 'return a hash with numeric balance value' do
+      TextMagic::API::Executor.expects(:execute).returns({ 'balance' => '3.14' })
+      response = @api.account
+      response.class.should == Hash
+      response['balance'].should == 3.14
+    end
+  end
+
+  context 'Send command' do
+
+    setup do
+      @username, @password = random_string, random_string
+      @text, @phone = random_string, random_phone
+      @api = TextMagic::API.new(@username, @password)
+    end
+
+    should 'call Executor execute with correct arguments' do
+      TextMagic::API::Executor.expects(:execute).with('send', @username, @password, :text => @text, :phone => @phone)
+      @api.send(@text, @phone)
+    end
+
+    should 'join multiple phone numbers supplied as an array' do
+      phones = Array.new(3) { random_phone }
+      TextMagic::API::Executor.expects(:execute).with('send', @username, @password, :text => @text, :phone => phones.join(','))
+      @api.send(@text, phones)
+    end
+
+    should 'join multiple phone numbers supplied as arguments' do
+      phones = Array.new(3) { random_phone }
+      TextMagic::API::Executor.expects(:execute).with('send', @username, @password, :text => @text, :phone => phones.join(','))
+      @api.send(@text, *phones)
+    end
+
+    should 'return a hash with message_id, sent_text and parts_count' do
+      message_id = random_string
+      TextMagic::API::Executor.expects(:execute).returns({ 'message_id' => { message_id => @phone }, 'sent_text' => @text, 'parts_count' => 1 })
+      response = @api.send(@text, @phone)
+      response['message_id'].should == { message_id => @phone }
+      response['sent_text'].should == @text
+      response['parts_count'].should == 1
+    end
+  end
+
+  context 'Message status command' do
+
+    setup do
+      @username, @password = random_string, random_string
+      @api = TextMagic::API.new(@username, @password)
+    end
+
+    should 'call Executor execute with correct arguments' do
+      id = random_string
+      TextMagic::API::Executor.expects(:execute).with('message_status', @username, @password, :ids => id)
+      @api.message_status(id)
+    end
+
+    should 'join ids supplied as array' do
+      ids = Array.new(3) { random_string }
+      TextMagic::API::Executor.expects(:execute).with('message_status', @username, @password, :ids => ids.join(','))
+      @api.message_status(ids)
+    end
+
+    should 'join ids supplied as arguments' do
+      ids = Array.new(3) { random_string }
+      TextMagic::API::Executor.expects(:execute).with('message_status', @username, @password, :ids => ids.join(','))
+      @api.message_status(*ids)
+    end
+
+    should 'return a hash with message ids as keys' do
+      TextMagic::API::Executor.expects(:execute).returns({ '8659912' => {} })
+      response = @api.message_status
+      response['8659912'].should == {}
+    end
+  end
+
+  context 'Receive command' do
+
+    setup do
+      @username, @password = random_string, random_string
+      @api = TextMagic::API.new(@username, @password)
+    end
+
+    should 'call Executor execute with correct arguments' do
+      TextMagic::API::Executor.expects(:execute).with('receive', @username, @password)
+      @api.receive
+    end
+
+    should 'return a hash with messages and number of unread messages' do
+      TextMagic::API::Executor.expects(:execute).returns({ 'messages' => [], 'unread' => 0 })
+      response = @api.receive
+      response['unread'].should == 0
+      response['messages'].should == []
+    end
+  end
+
+  context 'Delete reply command' do
+
+    setup do
+      @username, @password = random_string, random_string
+      @api = TextMagic::API.new(@username, @password)
+    end
+
+    should 'call Executor execute with correct arguments' do
+      id = random_string
+      TextMagic::API::Executor.expects(:execute).with('delete_reply', @username, @password, :ids => id)
+      @api.delete_reply(id)
+    end
+
+    should 'join ids supplied as array' do
+      ids = Array.new(3) { random_string }
+      TextMagic::API::Executor.expects(:execute).with('delete_reply', @username, @password, :ids => ids.join(','))
+      @api.delete_reply(ids)
+    end
+
+    should 'join ids supplied as arguments' do
+      ids = Array.new(3) { random_string }
+      TextMagic::API::Executor.expects(:execute).with('delete_reply', @username, @password, :ids => ids.join(','))
+      @api.delete_reply(*ids)
+    end
+
+    should 'return a hash with deleted ids' do
+      ids = Array.new(3) { random_string }
+      TextMagic::API::Executor.expects(:execute).returns({ 'deleted' => ids })
+      response = @api.receive
+      response['deleted'].should == ids
+    end
+  end
+end
+
+__END__
+
+Example responses
+
+account:
+{"balance":"100"}
+
+send:
+{"message_id":{"1234567":"444444123456"},"sent_text":"test","parts_count":1}
+
+message_status:
+{"8659912":{"text":"test","status":"d","created_time":"1242979818","reply_number":"447624800500","completed_time":null,"credits_cost":"0.5"},"8659914":{"text":"test","status":"d","created_time":"1242979839","reply_number":"447624800500","completed_time":null,"credits_cost":"0.5"}}
+
+receive (empty):
+{"messages":[],"unread":0}
+
+empty message:
+{"error_code":1,"error_message":"Messages text is empty"}
+
+insufficient parameters:
+{"error_code":4,"error_message":"Insufficient parameters"}
+
+invalid credentials:
+{"error_code":5,"error_message":"Invalid username & password combination"}
+
+invalid phone number format:
+{"error_code":9,"error_message":"Wrong phone number format"}
+
+invalid message_id:
+{"error_code":14,"error_message":"Message with id 8659913 does not exist"}

data/test/test_executor.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+require 'json'
+
+class ExecutorTest < Test::Unit::TestCase
+
+  context "execute method" do
+
+    setup do
+      FakeWeb.allow_net_connect = false
+
+      @username, @password = random_string, random_string
+      @command, @options = random_string, random_hash
+      @uri = build_uri(@command, @username, @password, @options)
+    end
+
+    should 'send a GET request to proper uri' do
+      response = random_string
+      FakeWeb.register_uri(:get, @uri, :string => response)
+      TextMagic::API::Executor.execute(@command, @username, @password, @options)
+    end
+
+    should 'raise an error if the response contains error_code' do
+      response = "{error_code:#{1 + rand(10)}}"
+      FakeWeb.register_uri(:get, @uri, :string => response)
+      lambda {
+        TextMagic::API::Executor.execute(@command, @username, @password, @options)
+      }.should raise_error(TextMagic::API::Error)
+    end
+
+    should 'return a hash with values in the response' do
+      hash = random_hash
+      FakeWeb.register_uri(:get, @uri, :string => hash.to_json)
+      response = TextMagic::API::Executor.execute(@command, @username, @password, @options)
+      response.should == hash
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+require 'matchy'
+require 'fakeweb'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'textmagic'
+
+class Test::Unit::TestCase
+end
+
+def random_string(legth = 5)
+  rand(36 ** legth).to_s(36)
+end
+
+def random_phone
+  rand(10 ** 12).to_s
+end
+
+def random_hash
+  hash = {}
+  3.times { hash[random_string] = random_string }
+  hash
+end
+
+def build_uri(command, username, password, options = {})
+  options.merge!(:cmd => command, :username => username, :password => password)
+  uri = "https://www.textmagic.com:443/app/api?"
+  uri << options.collect { |key, value| "#{key}=#{value}"}.join('&')
+end
+
+def load_response(filename)
+  File.read(File.join(File.dirname(__FILE__), 'fixtures', filename) + '.json')
+end

data/test/test_textmagic.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+# class TextmagicTest < Test::Unit::TestCase
+# end

data/textmagic.gemspec

@@ -0,0 +1,55 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{textmagic}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Vladimir Bobes Tuzinsky"]
+  s.date = %q{2009-05-22}
+  s.email = %q{vladimir.tuzinsky@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "lib/api.rb",
+     "lib/error.rb",
+     "lib/executor.rb",
+     "lib/textmagic.rb",
+     "test/test_api.rb",
+     "test/test_executor.rb",
+     "test/test_helper.rb",
+     "test/test_textmagic.rb",
+     "textmagic.gemspec"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/bobes/textmagic}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{textmagic}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Ruby interface to the TextMagic's SMS gateway}
+  s.test_files = [
+    "test/test_api.rb",
+     "test/test_executor.rb",
+     "test/test_helper.rb",
+     "test/test_textmagic.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: bobes-textmagic
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Vladimir Bobes Tuzinsky
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-22 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: vladimir.tuzinsky@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/api.rb
+- lib/error.rb
+- lib/executor.rb
+- lib/textmagic.rb
+- test/test_api.rb
+- test/test_executor.rb
+- test/test_helper.rb
+- test/test_textmagic.rb
+- textmagic.gemspec
+has_rdoc: true
+homepage: http://github.com/bobes/textmagic
+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: textmagic
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby interface to the TextMagic's SMS gateway
+test_files: 
+- test/test_api.rb
+- test/test_executor.rb
+- test/test_helper.rb
+- test/test_textmagic.rb