esendex 0.1.1 → 0.2.0

data/lib/esendex.rb

@@ -1,9 +1,46 @@
 module Esendex
-  require 'esendex/account'
-  require 'esendex/message'
-  require 'esendex/exceptions'
-  require 'esendex/message_batch_submission'
-  require 'esendex/version'
+  require_relative 'esendex/version'
+  require_relative 'esendex/api_connection'
+  require_relative 'esendex/account'
+  require_relative 'esendex/message'
+  require_relative 'esendex/exceptions'
+  require_relative 'esendex/message_batch_submission'
   
+  require_relative 'esendex/railtie' if defined?(Rails)
+
   API_NAMESPACE = 'http://api.esendex.com/ns/'
+  API_HOST = 'https://api.esendex.com'
+  API_VERSION = 'v1.0'
+
+  def self.configure
+    yield self if block_given?
+
+    unless Esendex.username
+      raise StandardError.new("username required. Either set Esendex.username or set environment variable ESENDEX_USERNAME")
+    end
+
+    unless Esendex.password
+      raise StandardError.new("password required. Either set Esendex.password or set environment variable ESENDEX_PASSWORD")
+    end
+  end
+
+  class << self
+    attr_writer :account_reference, :username, :password
+
+    def account_reference
+      @account_reference ||= ENV['ESENDEX_ACCOUNT']
+    end
+
+    def username
+      @username ||= ENV['ESENDEX_USERNAME']
+    end
+
+    def password
+      @password ||= ENV['ESENDEX_PASSWORD']
+    end
+  end
+
+  def self.user_agent
+    "EsendexRubyGem/#{Esendex::VERSION}"
+  end
 end

data/lib/esendex/account.rb

@@ -3,47 +3,34 @@ require 'nokogiri'
 
 module Esendex
   class Account
-    attr_accessor :account_reference, :username, :password
-    attr_reader :messages_remaining
+    attr_accessor :reference
     
-    def initialize(account_reference, username, password, connection = Nestful::Connection.new('http://api.esendex.com'))
-      @account_reference = account_reference
-      @username = username
-      @password = password
-
-      @connection = connection
-      @connection.user = @username
-      @connection.password = @password
-      @connection.auth_type = :basic
-      
-      begin
-        response = @connection.get "/v0.1/accounts/#{@account_reference}", default_headers
-        doc = Nokogiri::XML(response.body)
-        @messages_remaining = doc.at_xpath('//api:accounts/api:account/api:messagesremaining', 'api' => Esendex::API_NAMESPACE).content.to_i
-      rescue Exception => exception
-        raise ApiErrorFactory.new.get_api_error(exception)
-      end
+    def initialize(account_reference = Esendex.account_reference)
+      @reference = account_reference
     end
     
-    def default_headers
-      {"User-Agent" => "Esendex Gem #{Esendex::Version::STRING}"}
+    def api_connection
+      @api_connection ||= ApiConnection.new
     end
-    
-    def send_message(message)
-      self.send_messages([message])
+
+    def messages_remaining
+      response = api_connection.get "/v1.0/accounts/#{@reference}"
+      doc = Nokogiri::XML(response.body)
+      doc.at_xpath('//api:accounts/api:account/api:messagesremaining', 'api' => Esendex::API_NAMESPACE).content.to_i
+    end
+
+    def send_message(args={})
+      raise ArgumentError.new(":to required") unless args[:to]
+      raise ArgumentError.new(":body required") unless args[:body]
+
+      send_messages([Message.new(args[:to], args[:body], args[:from])])
     end
     
     def send_messages(messages)
-      
-      batch_submission = MessageBatchSubmission.new(@account_reference, messages)
-      
-      begin
-        response = @connection.post "/v1.0/messagedispatcher", batch_submission.to_s, default_headers
-        doc = Nokogiri::XML(response.body)
-        doc.at_xpath('//api:messageheaders', 'api' => Esendex::API_NAMESPACE)['batchid']
-      rescue Exception => exception
-        raise ApiErrorFactory.new.get_api_error(exception)
-      end
+      batch_submission = MessageBatchSubmission.new(@reference, messages)
+      response = api_connection.post "/v1.0/messagedispatcher", batch_submission.to_s
+      doc = Nokogiri::XML(response.body)
+      doc.at_xpath('//api:messageheaders', 'api' => Esendex::API_NAMESPACE)['batchid']
     end
 
   end

data/lib/esendex/api_connection.rb

@@ -0,0 +1,28 @@
+require 'nestful'
+
+class ApiConnection
+
+  def initialize
+    @connection = Nestful::Connection.new(Esendex::API_HOST)
+    @connection.user = Esendex.username
+    @connection.password = Esendex.password
+    @connection.auth_type = :basic
+  end
+
+  def default_headers
+    { 'User-Agent' => Esendex.user_agent }
+  end
+
+  def get(url)
+    @connection.get url, default_headers
+  rescue => e
+    raise ApiErrorFactory.new.get_api_error(e)
+  end
+
+  def post(url, body)
+    @connection.post url, body, default_headers
+  rescue => e
+    raise ApiErrorFactory.new.get_api_error(e)
+  end
+
+end

data/lib/esendex/message.rb

@@ -11,25 +11,25 @@ module Esendex
   class Message
     attr_accessor :to, :body, :from
     
-    def initialize(to, body)
-      self.to = to
-      self.body = body
+    def initialize(to, body, from=nil)
+      @to = to
+      @body = body
     end
     
     def xml_node
       doc = Nokogiri::XML('<message/>')
                   
       to = Nokogiri::XML::Node.new 'to', doc
-      to.content = self.to
+      to.content = @to
       doc.root.add_child(to)
       
       body = Nokogiri::XML::Node.new 'body', doc
-      body.content = self.body
+      body.content = @body
       doc.root.add_child(body)
 
-      if self.from
+      if @from
         from = Nokogiri::XML::Node.new 'from', doc
-        from.content = self.from
+        from.content = @from
         doc.root.add_child(from)
       end
       

data/lib/esendex/railtie.rb

@@ -0,0 +1,12 @@
+require 'esendex'
+require 'rails'
+
+module MyPlugin
+  class Railtie < Rails::Railtie
+    railtie_name :esendex
+
+    rake_tasks do
+      load "tasks/esendex.rake"
+    end
+  end
+end

data/lib/esendex/version.rb

@@ -1,9 +1,3 @@
 module Esendex
-  class Version
-    MAJOR = 0
-    MINOR = 1
-    PATCH = 1
-
-    STRING = [MAJOR, MINOR, PATCH].compact.join('.')    
-  end
+  VERSION = "0.2.0"
 end

data/readme.md

@@ -0,0 +1,83 @@
+# Esendex
+
+Ruby Gem for interacting with the Esendex API
+
+This is in very early stages of development but supports sending one or multiple messages using your account details
+
+## Usage
+
+### Setting up
+
+From the command line
+
+    gem install esendex
+
+or in your project's Gemfile.
+
+    gem 'esendex'
+
+Before sending messages you need to configure the gem with your credentials. In a Rails app this would typically go into a file called `esendex.rb` in the *config/initializers*.
+
+```ruby
+Esendex.configure do |config|
+  config.username = "<username>"
+  config.password = "<password>"
+  config.account_reference = "<account_reference>"
+end
+```
+
+You can omit account reference and specify it when you instantiate an account object if you're using multiple accounts.
+
+You can also specify these using the environment variables `ESENDEX_USERNAME`, `ESENDEX_PASSWORD` and `ESENDEX_ACCOUNT`.
+
+### Sending Messages
+
+First instantiate an Account with the reference. You can omit the reference if you've already configured one to use in the *Esendex.configure* step.
+
+```ruby
+account = Account.new("EX123456")
+```
+	
+then, call the send method on the account object with a hash describing the message. The return value is a *batch_id* you can use to obtain the status of the messages you have sent.
+
+```ruby
+batch_id = account.send_message( to: "07777111222", body: "Saying hello to the world with the help of Esendex")
+```
+
+Multiple messages are sent by passing an array of `Messages` to the send_messages method
+	
+```ruby
+batch_id = account.send_messages([Message.new("07777111222", "Hello"), Message.new("07777111333", "Hi")])
+```
+
+### Testing Configuration
+
+The Esendex Gem ships with a couple of rake tasks that allow you to simply validate that all is well.
+
+    rake esendex:validate['<username>,'<password>','<account_reference>']
+
+This will confirm that the credentials passed can access the account.
+
+You can also send a message
+
+    rake esendex:send_message["<mobile_number>","<message_body>"]
+
+You will need to set the credentials as enviroment variables which can also be done inline
+
+    rake esendex:send_message["<mobile_number>","<message_body>"] ESENDEX_USERNAME=<username> ESENDEX_PASSWORD=<password> ESENDEX_ACCOUNT=<account_reference>
+
+
+### Testing
+
+		bundle exec rspec
+	
+will run specs, ie those in the root of the test folder
+
+## Contributing
+
+Please fork as you see fit and let us know when you have something that should be part of the gem.
+
+## Copyright
+
+Copyright (c) 2011-13 Esendex Ltd. See LICENSE.txt for further details.
+

data/spec/account_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Account do
+  let(:account_reference) { random_string }
+  let(:account) { Account.new(account_reference) }
+  let(:messages_remaining) { random_integer }
+  let(:account_xml) {
+    "<?xml version=\"1.0\" encoding=\"utf-8\"?>
+      <accounts xmlns=\"http://api.esendex.com/ns/\">
+        <account id=\"2b4a326c-41de-4a57-a577-c7d742dc145c\" uri=\"http://api.esendex.com/v1.0/accounts/2b4a326c-41de-4a57-a577-c7d742dc145c\">
+          <balanceremaining domesticmessages=\"100\" internationalmessages=\"100\">$0.00</balanceremaining>
+          <reference>#{account_reference}</reference>
+          <address>447786204254</address>
+          <type>Professional</type>
+          <messagesremaining>#{messages_remaining}</messagesremaining>
+          <expireson>2015-12-31T00:00:00</expireson>
+          <role>PowerUser</role>
+          <defaultdialcode>44</defaultdialcode>
+          <settings uri=\"http://api.esendex.com/v1.0/accounts/2b4a326c-41de-4a57-a577-c7d742dc145c/settings\" />
+        </account>
+      </accounts>"
+  }
+  let(:api_connection) { mock("Connection", :get => mock('Response', :body => account_xml), :post => true )}
+
+  before(:each) do
+    account.stub(:api_connection) { api_connection}
+  end
+
+  describe "#messages_remaining" do
+
+    subject { account.messages_remaining }
+
+    it "should get the account resource" do
+      api_connection.should_receive(:get).with("/v1.0/accounts/#{account_reference}")
+      subject
+    end
+    it "should get the messages remaining from the documeny" do
+      subject.should eq(messages_remaining)
+    end
+  end
+
+  describe "#send_message" do
+    let(:batch_id) { random_string }
+    let(:send_response_xml) {
+      "<?xml version=\"1.0\" encoding=\"utf-8\"?> 
+      <messageheaders batchid=\"#{batch_id}\" xmlns=\"http://api.esendex.com/ns/\">
+        <messageheader\ uri=\"http://api.esendex.com/v1.0/MessageHeaders/00000000-0000-0000-0000-000000000000\" id=\"00000000-0000-0000-0000-000000000000\" />
+      </messageheaders>"
+    }
+
+    before(:each) do
+      api_connection.stub(:post) { mock('Response', :body => send_response_xml) }
+    end
+
+    subject { account.send_message(to: "447815777555", body: "Hello from the Esendex Ruby Gem") }
+
+    it "posts to the message dispatcher resource" do
+      api_connection.should_receive(:post).with("/v1.0/messagedispatcher", anything)
+      subject
+    end
+    it "should return the batch_id in the result" do
+      subject.should eq(batch_id)
+    end
+  end  
+end

data/spec/api_connection_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe ApiConnection do
+  let(:api_connection) { ApiConnection.new }
+
+  before(:each) do
+    @connection = Nestful::Connection.new Esendex::API_HOST
+    Nestful::Connection.stub(:new) { @connection }
+    @connection.stub(:get) {}
+    @connection.stub(:post) {}
+    Esendex.configure do |config|
+      config.username = random_string
+      config.password = random_string
+    end
+  end
+
+  describe "#initialise" do
+
+    subject { ApiConnection.new }
+
+    it "should set the username" do
+      subject
+      @connection.user.should eq(Esendex.username)
+    end
+    it "should set the password" do
+      subject
+      @connection.password.should eq(Esendex.password)
+    end
+    it "should set the auth to basic" do
+      subject
+      @connection.auth_type.should eq(:basic)
+    end
+
+  end
+
+
+  describe "#get" do
+    let(:url) { random_string }
+
+    subject { api_connection.get url }
+    
+    it "should call get with headers" do
+      @connection.should_receive(:get).with(url, api_connection.default_headers)
+      subject
+    end
+
+    context "when 403 raised" do
+      before(:each) do
+        @connection.stub(:get) { raise Nestful::ForbiddenAccess.new(nil) }
+      end
+      it "raises an Esendex::ForbiddenError" do
+        expect { subject }.to raise_error(Esendex::ForbiddenError)
+      end
+    end
+
+  end
+
+  describe "#post" do
+    let(:url) { random_string }
+    let(:body) { random_string }
+
+    subject { api_connection.post url, body }
+    
+    it "should call post with headers" do
+      @connection.should_receive(:post).with(url, body, api_connection.default_headers)
+      subject
+    end
+
+    context "when 403 raised" do
+      before(:each) do
+        @connection.stub(:post) { raise Nestful::ForbiddenAccess.new(nil) }
+      end
+      it "raises an Esendex::ForbiddenError" do
+        expect { subject }.to raise_error(Esendex::ForbiddenError)
+      end
+    end
+
+  end
+end

data/spec/message_batch_submission_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe MessageBatchSubmission do
+  let(:account) { "EX1234556" }
+
+  describe "#xml_node" do
+    let(:messages) { [ Message.new(random_mobile, random_string), Message.new(random_mobile, random_string)] }
+    let(:message_batch) { MessageBatchSubmission.new(account, messages) }
+
+    subject { message_batch.xml_node }
+
+    it "should create message nodes" do
+      subject.xpath('//messages/message').count.should eq(messages.count)
+    end
+    it "should set the message to" do
+      (0..1).each do |i|
+        subject.xpath('//messages/message/to')[i].content.should eq(messages[i].to)
+      end
+    end
+    it "should set the message body" do
+      (0..1).each do |i|
+        subject.xpath('//messages/message/body')[i].content.should eq(messages[i].body)
+      end
+    end
+    context "when send_at set" do
+      let(:target_time) { Time.local(2011, 4, 7, 15, 0, 0) }
+  
+      before(:each) do
+        message_batch.send_at = target_time
+      end
+
+      it "should create a properly formatted sendat node" do
+        subject.at_xpath('//messages/sendat').content.should eq("2011-04-07T15:00:00")
+      end
+    end
+  end
+end

data/spec/message_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Message do
+  describe "#xml_node" do
+    let(:to) { random_mobile }
+    let(:body) { random_string }
+    let(:message) { Esendex::Message.new(to, body) }
+
+    subject { message.xml_node }
+
+    it "contains a to node" do
+      subject.at_xpath('//message/to').content.should eq(to)
+    end
+    it "contains a body node" do
+      subject.at_xpath('//message/body').content.should eq(body)
+    end
+
+    context "when from set" do
+      let(:from) { random_string }
+
+      before(:each) do
+        message.from = from
+      end
+
+      it "contains a from node" do
+        subject.at_xpath('//message/from').content.should eq(from)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'rake'
+require 'rspec'
+
+require "#{Rake.application.original_dir}/lib/esendex"
+
+RSpec.configure do |config|
+  config.color = true
+end
+
+include Esendex
+
+def random_string
+  (0...24).map{ ('a'..'z').to_a[rand(26)] }.join
+end
+
+def random_email
+  "#{random_string}@#{random_string}.com"
+end
+
+def random_integer
+  rand(9999)
+end
+
+def random_mobile
+  "447#{"%09d" % rand(999999999)}"
+end

metadata

@@ -1,259 +1,68 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: esendex
-version: !ruby/object:Gem::Version 
-  hash: 25
+version: !ruby/object:Gem::Version
+  version: 0.2.0
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 1
-  version: 0.1.1
 platform: ruby
-authors: 
+authors:
 - Adam Bird
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-05 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 0
-        - 0
-        - 6
-        version: 0.0.6
-  name: nestful
-  version_requirements: *id001
-  prerelease: false
-  type: :runtime
-- !ruby/object:Gem::Dependency 
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  name: i18n
-  version_requirements: *id002
-  prerelease: false
-  type: :runtime
-- !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 4
-        - 4
-        version: 1.4.4
-  name: nokogiri
-  version_requirements: *id003
-  prerelease: false
-  type: :runtime
-- !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  name: shoulda
-  version_requirements: *id004
-  prerelease: false
-  type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
-  name: bundler
-  version_requirements: *id005
-  prerelease: false
-  type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 1
-        - 5
-        - 2
-        version: 1.5.2
-  name: jeweler
-  version_requirements: *id006
-  prerelease: false
-  type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  name: rcov
-  version_requirements: *id007
-  prerelease: false
-  type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 35
-        segments: 
-        - 0
-        - 9
-        - 12
-        version: 0.9.12
-  name: mocha
-  version_requirements: *id008
-  prerelease: false
-  type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 4
-        - 4
-        version: 1.4.4
-  name: nokogiri
-  version_requirements: *id009
-  prerelease: false
-  type: :runtime
-- !ruby/object:Gem::Dependency 
-  requirement: &id010 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  name: i18n
-  version_requirements: *id010
-  prerelease: false
-  type: :runtime
-- !ruby/object:Gem::Dependency 
-  requirement: &id011 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 0
-        - 0
-        - 6
-        version: 0.0.6
-  name: nestful
-  version_requirements: *id011
-  prerelease: false
-  type: :runtime
-description: ""
-email: support@esendex.com
+date: 2013-02-19 00:00:00.000000000 Z
+dependencies: []
+description: Gem for interacting with the Esendex API
+email:
+- support@esendex.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
-files: 
-- .document
-- Gemfile
-- Gemfile.lock
-- LICENSE.txt
-- README.rdoc
-- Rakefile
-- VERSION
-- esendex.gemspec
-- lib/esendex.rb
+- readme.md
+files:
 - lib/esendex/account.rb
+- lib/esendex/api_connection.rb
 - lib/esendex/exceptions.rb
 - lib/esendex/message.rb
 - lib/esendex/message_batch_submission.rb
+- lib/esendex/railtie.rb
 - lib/esendex/version.rb
-- test/helper.rb
-- test/integration/test_account.rb
-- test/test_account.rb
-- test/test_message.rb
-- test/test_message_batch.rb
-- test/test_nokogiri.rb
-has_rdoc: true
-homepage: http://github.com/esendex/esendex.gem
-licenses: 
-- MIT
+- lib/esendex.rb
+- LICENSE.txt
+- readme.md
+- spec/account_spec.rb
+- spec/api_connection_spec.rb
+- spec/message_batch_submission_spec.rb
+- spec/message_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.esendex.com
+licenses: []
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: for interacting with the Esendex API
-test_files: 
-- test/helper.rb
-- test/integration/test_account.rb
-- test/test_account.rb
-- test/test_message.rb
-- test/test_message_batch.rb
-- test/test_nokogiri.rb
+summary: Gem for interacting with the Esendex API
+test_files:
+- spec/account_spec.rb
+- spec/api_connection_spec.rb
+- spec/message_batch_submission_spec.rb
+- spec/message_spec.rb
+- spec/spec_helper.rb
+has_rdoc: 

data/.document

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

data/Gemfile

@@ -1,17 +0,0 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
-gem "nestful", ">= 0.0.6"
-gem "i18n"
-gem "nokogiri", ">=1.4.4"
-
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "shoulda", ">= 0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.2"
-  gem "rcov", ">= 0"
-  gem "mocha", ">=0.9.12"
-end

data/Gemfile.lock

@@ -1,30 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activesupport (3.0.5)
-    git (1.2.5)
-    i18n (0.5.0)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-    mocha (0.9.12)
-    nestful (0.0.6)
-      activesupport (>= 3.0.0.beta)
-    nokogiri (1.4.4)
-    rake (0.8.7)
-    rcov (0.9.9)
-    shoulda (2.11.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.0.0)
-  i18n
-  jeweler (~> 1.5.2)
-  mocha (>= 0.9.12)
-  nestful (>= 0.0.6)
-  nokogiri (>= 1.4.4)
-  rcov
-  shoulda

data/README.rdoc

@@ -1,49 +0,0 @@
-= esendex.gem
-
-Gem for interacting with the Esendex API
-
-This is in very early stages of development but supports sending one
-
-== Usage
-
-=== Setting up
-
-	gem install esendex
-
-=== Sending Messages
-
-First instantiate an Account with your credentials
-	
-	account = Account.new("EX123456", "user@company.com", "yourpassword")
-	
-then, call the send method on the account object with a message. The return value is a batch_id you can use to obtain the status of the messages you have sent.
-
-	batch_id = account.send_message(Message.new("07777111222", "Saying hello to the world with the help of Esendex"))
-
-Multiple messages are sent by passing an array of Messages to the send_messages method
-	
-	batch_id = account.send_messages([Message.new("07777111222", "Hello"), Message.new("07777111333", "Hi")])
-	
-== Building
-
-The plan is to publish this so you can perform gem install but if you can't wait then feel free to download 
-
-=== Testing
-
-	rake test
-	
-will run unit tests, ie those in the root of the test folder
-
-	rake integration_test
-
-will run integration tests, ie only those in the /test/integration folder
-
-== Contributing
-
-Please fork as you see fit and let us know when you have something that should be part of the gem.
-
-== Copyright
-
-Copyright (c) 2011 Esendex Ltd. See LICENSE.txt for
-further details.
-

data/Rakefile

@@ -1,62 +0,0 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-require './lib/esendex/version'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "esendex"
-  gem.homepage = "http://github.com/esendex/esendex.gem"
-  gem.license = "MIT"
-  gem.summary = "for interacting with the Esendex API"
-  gem.description = ""
-  gem.email = "support@esendex.com"
-  gem.authors = ["Adam Bird"]
-  gem.version = Esendex::Version::STRING
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  gem.add_dependency 'nokogiri', '>=1.4.4'
-  gem.add_dependency 'i18n'
-  gem.add_dependency 'nestful', '>= 0.0.6'
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/test_*.rb'
-  test.verbose = true
-end
-
-Rake::TestTask.new(:integration_test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/integration/test_*.rb'
-  test.verbose = true
-end
-
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "esendex #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +0,0 @@
-0.1.0

data/esendex.gemspec

@@ -1,97 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{esendex}
-  s.version = "0.1.1"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Adam Bird"]
-  s.date = %q{2011-05-05}
-  s.description = %q{}
-  s.email = %q{support@esendex.com}
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "esendex.gemspec",
-    "lib/esendex.rb",
-    "lib/esendex/account.rb",
-    "lib/esendex/exceptions.rb",
-    "lib/esendex/message.rb",
-    "lib/esendex/message_batch_submission.rb",
-    "lib/esendex/version.rb",
-    "test/helper.rb",
-    "test/integration/test_account.rb",
-    "test/test_account.rb",
-    "test/test_message.rb",
-    "test/test_message_batch.rb",
-    "test/test_nokogiri.rb"
-  ]
-  s.homepage = %q{http://github.com/esendex/esendex.gem}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
-  s.summary = %q{for interacting with the Esendex API}
-  s.test_files = [
-    "test/helper.rb",
-    "test/integration/test_account.rb",
-    "test/test_account.rb",
-    "test/test_message.rb",
-    "test/test_message_batch.rb",
-    "test/test_nokogiri.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<nestful>, [">= 0.0.6"])
-      s.add_runtime_dependency(%q<i18n>, [">= 0"])
-      s.add_runtime_dependency(%q<nokogiri>, [">= 1.4.4"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_development_dependency(%q<mocha>, [">= 0.9.12"])
-      s.add_runtime_dependency(%q<nokogiri>, [">= 1.4.4"])
-      s.add_runtime_dependency(%q<i18n>, [">= 0"])
-      s.add_runtime_dependency(%q<nestful>, [">= 0.0.6"])
-    else
-      s.add_dependency(%q<nestful>, [">= 0.0.6"])
-      s.add_dependency(%q<i18n>, [">= 0"])
-      s.add_dependency(%q<nokogiri>, [">= 1.4.4"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<mocha>, [">= 0.9.12"])
-      s.add_dependency(%q<nokogiri>, [">= 1.4.4"])
-      s.add_dependency(%q<i18n>, [">= 0"])
-      s.add_dependency(%q<nestful>, [">= 0.0.6"])
-    end
-  else
-    s.add_dependency(%q<nestful>, [">= 0.0.6"])
-    s.add_dependency(%q<i18n>, [">= 0"])
-    s.add_dependency(%q<nokogiri>, [">= 1.4.4"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<mocha>, [">= 0.9.12"])
-    s.add_dependency(%q<nokogiri>, [">= 1.4.4"])
-    s.add_dependency(%q<i18n>, [">= 0"])
-    s.add_dependency(%q<nestful>, [">= 0.0.6"])
-  end
-end
-

data/test/helper.rb

@@ -1,21 +0,0 @@
-require 'rubygems'
-require 'bundler'
-
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'test/unit'
-require 'shoulda'
-require 'mocha'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-
-require 'esendex'
-
-class Test::Unit::TestCase
-end

data/test/integration/test_account.rb

@@ -1,26 +0,0 @@
-require 'helper'
-include Esendex
-
-class TestAccount < Test::Unit::TestCase
-  should "validate account when a new one is created" do
-    code_challenge_account = Account.new("EX0068832", "codechallenge@esendex.com", "c0d3cha113ng3")
-    
-    assert code_challenge_account.messages_remaining > 0
-  end
-  
-  should "fail authorisation" do
-    begin
-      code_challenge_account = Account.new("EX0068832", "bilge", "bilge")
-    rescue Esendex::ForbiddenError
-    end
-    
-  end
-  
-  should "send a message" do
-    code_challenge_account = Account.new("EX0068832", "codechallenge@esendex.com", "c0d3cha113ng3")
-    
-    batch_id = code_challenge_account.send_message(Message.new("447700900000", "Hello from the Esendex Ruby Gem"))
-    
-    assert batch_id
-  end
-end

data/test/test_account.rb

@@ -1,63 +0,0 @@
-require 'helper'
-require 'nestful'
-include Esendex
-
-class TestAccount < Test::Unit::TestCase
-
-  def raw_mock_connection   
-    @user = "codechallenge@esendex.com"
-    @password = "c0d3cha113ng3"
-    @account_reference = "EX0068832"    
-    connection = mock()
-    connection.expects(:user=).with(@user)
-    connection.expects(:password=).with(@password)
-    connection.expects(:auth_type=).with(:basic)
-    connection
-  end
-  
-  def mock_connection
-    connection = raw_mock_connection
-    account_initialisation_response = mock()
-    account_initialisation_response.expects(:body).returns("<?xml version=\"1.0\" encoding=\"utf-8\"?><accounts xmlns=\"http://api.esendex.com/ns/\"><account id=\"2b4a326c-41de-4a57-a577-c7d742dc145c\" uri=\"http://api.esendex.com/v1.0/accounts/2b4a326c-41de-4a57-a577-c7d742dc145c\"><balanceremaining domesticmessages=\"100\" internationalmessages=\"100\">$0.00</balanceremaining><reference>EX0068832</reference><address>447786204254</address><type>Professional</type><messagesremaining>100</messagesremaining><expireson>2015-12-31T00:00:00</expireson><role>PowerUser</role><defaultdialcode>44</defaultdialcode><settings uri=\"http://api.esendex.com/v1.0/accounts/2b4a326c-41de-4a57-a577-c7d742dc145c/settings\" /></account></accounts>")
-    
-    connection.expects(:get).with("/v0.1/accounts/#{@account_reference}", anything).returns(account_initialisation_response)
-    connection
-  end
-  
-  should "validate account when a new one is created" do
-    connection = mock_connection
-    
-    code_challenge_account = Account.new(@account_reference, @user, @password, connection)
-    
-    assert_equal 100, code_challenge_account.messages_remaining
-  end
-  
-  should "raise an ForbiddenError when a 403 is returned from API" do
-    connection = raw_mock_connection
-    connection.stubs(:get).raises(Nestful::ForbiddenAccess.new nil)
-    
-    begin
-      account = Account.new(@account_reference, @user, @password, connection)
-    rescue Esendex::ForbiddenError
-    end
-  end
-  
-  should "send a message" do
-    connection = mock_connection
-    batch_id = "2b4a326c-41de-4a57-a577-c7d742dc145c"
-    
-    message_send_response = mock()
-    message_send_response.expects(:body).returns("<?xml version=\"1.0\" encoding=\"utf-8\"?> <messageheaders batchid=\"#{batch_id}\" xmlns=\"http://api.esendex.com/ns/\"> <messageheader\ uri=\"http://api.esendex.com/v1.0/MessageHeaders/00000000-0000-0000-0000-000000000000\" id=\"00000000-0000-0000-0000-000000000000\" /></messageheaders>")
-    connection.expects(:post).with("/v1.0/messagedispatcher", anything, anything).returns(message_send_response)
-    
-    code_challenge_account = Account.new(@account_reference, @user, @password, connection)
-    
-    result = code_challenge_account.send_message(Message.new("447815777555", "Hello from the Esendex Ruby Gem"))
-    
-    assert_equal batch_id, result
-  end
-  
-  should "return populated inbox" do
-    
-  end
-end

data/test/test_message.rb

@@ -1,24 +0,0 @@
-require 'helper'
-
-class TestMessage < Test::Unit::TestCase
-  should "create a valid xml representation of a message" do
-    target = Esendex::Message.new("07777111333", "Hello World")
-    
-    actual = target.xml_node
-    
-    assert_equal "07777111333", actual.at_xpath('//message/to').content
-    assert_equal "Hello World", actual.at_xpath('//message/body').content
-  end
-  
-  should "create a valid xml representation if from specified" do
-    target = Esendex::Message.new("07777111333", "Hello World")
-    target.from = "BilgeInc"
-    
-    actual = target.xml_node
-    
-    assert_equal "07777111333", actual.at_xpath('//message/to').content
-    assert_equal "Hello World", actual.at_xpath('//message/body').content
-    assert_equal "BilgeInc", actual.at_xpath('//message/from').content
-    
-  end
-end

data/test/test_message_batch.rb

@@ -1,22 +0,0 @@
-require 'helper'
-
-class TestMessageBatchSubmission < Test::Unit::TestCase
-  should "format scheduled date time correctly" do
-    # yyyy-MM-ddThh:mm:ss
-    
-    target_time = Time.local(2011, 4, 7, 15, 0, 0)
-    
-    submission = MessageBatchSubmission.new("EX1234556", [Message.new("0777111222", "I'm sending this in the future")])
-    submission.send_at = target_time
-    
-    assert_equal "2011-04-07T15:00:00", submission.xml_node.at_xpath('//messages/sendat').content
-  end
-  
-  should "contain multiple messages" do   
-    submission = MessageBatchSubmission.new("EX1234556", [Message.new("0777111222", "I'm sending this in the future"), Message.new("0777111333", "I'm sending this in the future")])
-    
-    message_elements = submission.xml_node.xpath('//messages/message')
-    
-    assert_equal 2, message_elements.count
-  end
-end

data/test/test_nokogiri.rb

@@ -1,19 +0,0 @@
-require 'helper'
-require 'Nokogiri'
-
-class TestNokogiri < Test::Unit::TestCase
-  should "get same from Nokogiri using XPath or CSS syntax" do
-    
-    xml_source = "<?xml version=\"1.0\" encoding=\"utf-8\"?><accounts xmlns=\"http://api.esendex.com/ns/\"><account id=\"2b4a326c-41de-4a57-a577-c7d742dc145c\" uri=\"http://api.esendex.com/v1.0/accounts/2b4a326c-41de-4a57-a577-c7d742dc145c\"><messagesremaining>100</messagesremaining></account></accounts>"
-    
-    ndoc = Nokogiri::XML(xml_source)
-    
-    node_value = ndoc.css("accounts account messagesremaining").count
-    assert_equal 1, node_value
-
-    node_value = ndoc.xpath('//api:accounts/api:account/api:messagesremaining', 'api' => 'http://api.esendex.com/ns/').count
-    assert_equal 1, node_value
-    
-  end
-end
-