clockworksms 1.0.0

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'nokogiri'
+gem 'faraday'
+
+group :development do
+  gem 'rake'
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    faraday (0.8.0)
+      multipart-post (~> 1.1)
+    multipart-post (1.1.5)
+    nokogiri (1.5.2)
+    rake (0.9.2.2)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.0)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faraday
+  nokogiri
+  rake
+  rspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (C) 2012, Mediaburst Limited <hello@mediaburst.co.uk>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE

data/README.md

@@ -0,0 +1,119 @@
+# Clockwork SMS API Ruby Gem
+
+## Install
+
+Just add the following to your Gemfile:
+
+    gem 'clockworksms'
+
+## Documentation
+
+Full documentation is at [http://rubydoc.info/github/mediaburst/clockwork-ruby/master/frames][1]. Alternatively, run `yard doc` and open doc/index.html.
+
+## Usage
+
+For more information on the available optional parameters for the API (Clockwork::API), see [here][4].
+
+For more information on the available optional parameters for each SMS (Clockwork::SMS), see [here][5]. For more information on the response object returned from each SMS (Clockwork::SMS::Response), see [here][6].
+
+### Send a single SMS message
+
+    require 'clockwork'
+    api = Clockwork::API.new( 'API_KEY_GOES_HERE' )
+    message = api.messages.build( :to => '441234123456', :content => 'This is a test message.' )
+    response = message.deliver
+    
+    if response.success
+        puts response.message_id
+    else
+        puts response.error_code
+        puts response.error_description
+    end
+    
+### Alternative usage for sending an SMS message
+
+    require 'clockwork'
+    api = Clockwork::API.new( 'API_KEY_GOES_HERE' )
+    
+    message = api.messages.build
+    message.to = '441234123456'
+    message.content = 'This is a test message.'
+    response = message.deliver
+    
+    if response.success
+        puts response.message_id
+    else
+        puts response.error_code
+        puts response.error_description
+    end
+    
+### Send multiple SMS messages (with an optional client ID)
+
+You should not use the `Clockwork::Message#deliver` method for each message, but instead use the `Clockwork::API#deliver` method to send multiple messages in the same API request. This will decrease load on the API and ensure your requests are processed significantly faster.
+
+    messages = [
+        { :to => '441234123456', :content => 'This is a test message.', :client_id => '1' },
+        { :to => '441234123456', :content => 'This is a test message 2.', :client_id => '2' },
+        { :to => '441234123456', :content => 'This is a test message 3.', :client_id => '3' },
+        { :to => '441234123456', :content => 'This is a test message 4.', :client_id => '4' },
+        { :to => '441234123456', :content => 'This is a test message 5.', :client_id => '5' },
+        { :to => '441234123456', :content => 'This is a test message 6.', :client_id => '6' }
+    ]
+    
+    require 'clockwork'
+    api = Clockwork::API.new( 'API_KEY_GOES_HERE' )
+    messages.each do |m|
+        api.messages.build(m)
+    end
+    
+    responses = api.deliver_messages
+    responses.each do |response|
+        puts response.client_id
+        if response.success
+            puts response.message_id
+        else
+            puts response.error_code
+            puts response.error_description
+        end
+    end
+    
+### Check credit
+    
+    require 'clockwork'
+    api = Clockwork::API.new( 'API_KEY_GOES_HERE' )
+    remaining_messages = Clockwork::API.credit
+    puts remaining messages # => 240
+
+## License
+
+This project is licensed under the ISC open-source license.
+
+A copy of this license can be found in LICENSE.
+
+## Contributing
+
+If you have any feedback on this wrapper drop us an email to [hello@clockworksms.com][2].
+
+The project is hosted on GitHub at [http://www.github.com/mediaburst/clockwork-ruby][3].
+
+If you would like to contribute a bug fix or improvement please fork the project 
+and submit a pull request. Please add RSpec tests for your use case.
+
+### Test Setup
+
+First, create a file at spec/spec_authentication_details containing the following:
+
+    34023ada3ec0d99213f91a12a2329ba932665ed7
+    MyLegacyAPIUsername@mydomain.com
+    MyPassword
+    
+Substitute your own API key, username and password on lines 1, 2, and 3 of the file.
+
+Then, run `rspec`. 
+
+[1]: http://rubydoc.info/github/mediaburst/clockwork-ruby/master/frames
+[2]: mailto:hello@clockworksms.com
+[3]: http://www.github.com/mediaburst/clockwork-ruby
+[4]: http://rubydoc.info/github/mediaburst/clockwork-ruby/master/Clockwork/API
+[5]: http://rubydoc.info/github/mediaburst/clockwork-ruby/master/Clockwork/SMS
+[6]: http://rubydoc.info/github/mediaburst/clockwork-ruby/master/Clockwork/SMS/Response

data/lib/clockwork.rb

@@ -0,0 +1,14 @@
+lib_dir = File.expand_path(File.dirname(__FILE__))
+$LOAD_PATH.unshift lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+require 'net/http'
+require 'nokogiri'
+
+require 'clockwork/error'
+require 'clockwork/http'
+require 'clockwork/xml/xml'
+
+require 'clockwork/message_collection'
+require 'clockwork/api'
+require 'clockwork/sms'
+require 'clockwork/sms/response'

data/lib/clockwork/api.rb

@@ -0,0 +1,133 @@
+# A wrapper around the Clockwork API.
+module Clockwork
+    
+  # Current API wrapper version
+  VERSION = '1.0.0'
+  
+  # @author James Inman <james@mediaburst.co.uk>
+  # You must create an instance of Clockwork::API to begin using the API.
+  class API
+    
+    # URL of the SMS API send action
+    SMS_URL = "api.clockworksms.com/xml/send"
+    # URL of the SMS API check credit action
+    CREDIT_URL = "api.clockworksms.com/xml/credit"    
+    
+    # API key provided in Clockwork::API#initialize.
+    # @return [string] 
+    attr_reader :api_key
+    
+    # This is the number of messages to concatenate (join together). 
+    # @raise ArgumentError - if a value less than 2 or more than 3 is passed
+    # @return [symbol] One of +error+, +:replace+, +:remove+ 
+    # @note Defaults to 3 if not set and Clockwork::API#long is set to +true+.
+    attr_reader :concat
+        
+    # @!attribute from
+    # The from address displayed on a phone when the SMS is received. This can be either a 12 digit number or 11 characters long.
+    # @return [string] 
+    # @note This can be overriden for specific Clockwork::SMS objects; if it is not set your account default will be used.
+    attr_accessor :from
+        
+    # What to do with any invalid characters in the message content. +:error+ will raise a Clockwork::InvalidCharacterException, +:replace+ will replace a small number of common invalid characters, such as the smart quotes used by Microsoft Office with a similar match, +:remove+ will remove invalid characters.
+    # @raise ArgumentError - if value is not one of +:error+, +:replace+, +:remove+
+    # @return [symbol] One of +error+, +:replace+, +:remove+ 
+    # @note This can be overriden for specific Clockwork::SMS objects; if it is not set your account default will be used.
+    attr_reader :invalid_char_action
+        
+    # @!attribute long
+    # Set to +true+ to enable long SMS. A standard text can contain 160 characters, a long SMS supports up to 459. Each recipient will cost up to 3 message credits.
+    # @return [boolean]
+    # @note This can be overriden for specific Clockwork::SMS objects; if it is not set your account default will be used.
+    attr_accessor :long
+    
+    # @!attribute messages
+    # Returns a Clockwork::MessageCollection containing all built SMS messages.
+    # @return [Clockwork::MessageCollection]
+    attr_reader :messages
+    
+    # Password provided in Clockwork::API#initialize.
+    # @return [string]
+    # @deprecated Use api_key instead.
+    attr_reader :password
+    
+    # @!attribute truncate
+    # Set to +true+ to trim the message content to the maximum length if it is too long.
+    # @return [boolean] 
+    # @note This can be overriden for specific Clockwork::SMS objects; if it is not set your account default will be used.
+    attr_accessor :truncate
+    
+    # Whether to use SSL when connecting to the API.
+    # Defaults to +true+
+    # @return [boolean] 
+    attr_accessor :use_ssl
+    
+    # Username provided in Clockwork::API#initialize.
+    # @return [string]
+    # @deprecated Use api_key instead.
+    attr_reader :username
+        
+    # Alias for Clockwork::API#credit to preserve backwards compatibility with original Mediaburst API.
+    # @deprecated Use Clockwork::API#credit. Support for Clockwork::API#get_credit will be removed in a future version of this wrapper.
+    def get_credit
+      credit
+    end
+      
+    def invalid_char_action= symbol
+      raise( ArgumentError, "#{symbol} must be one of :error, :replace, :remove" ) unless [:error, :replace, :remove].include?(symbol.to_sym)
+    end
+    
+    def concat= number
+      raise( ArgumentError, "#{number} must be either 2 or 3" ) unless [2, 3].include?(number.to_i)
+    end
+    
+    # @overload initalize(api_key)
+    #   @param [string] api_key API key, 40-character hexadecimal string
+    #   @param [hash] options Optional hash of attributes on API 
+    # @overload initalize(username, password)
+    #   @param [string] username Your API username
+    #   @param [string] password Your API password
+    #   @param [hash] options Optional hash of attributes on API
+    #   @deprecated Use an API key instead. Support for usernames and passwords will be removed in a future version of this wrapper.
+    # @raise ArgumentError - if more than 3 parameters are passed
+    # @raise Clockwork::Error::InvalidAPIKey - if API key is invalid
+    # Clockwork::API is initialized with an API key, available from http://www.mediaburst.co.uk/api.
+    def initialize *args
+      if args.size == 1 || ( args.size == 2 && args[1].kind_of?(Hash) ) 
+        raise Clockwork::Error::InvalidAPIKey unless args[0][/^[A-Fa-f0-9]{40}$/]
+        @api_key = args[0]
+      elsif args.size == 2 || ( args.size == 3 && args[2].kind_of?(Hash) ) 
+        raise ArgumentError, "You must pass both a username and password." if args[0].empty? || args[1].empty?
+        @username = args[0]
+        @password = args[1]
+      else
+        raise ArgumentError, "You must pass either an API key OR a username and password."
+      end
+      
+      args.last.each { |k, v| instance_variable_set "@#{k}", v } if args.last.kind_of?(Hash)
+      
+      @use_ssl = true if @use_ssl.nil?
+      @concat = 3 if @concat.nil? && @long
+      @messages ||= Clockwork::MessageCollection.new( :api => self )
+    end
+    
+    # Check the remaining credit for this account.
+    # @raise Clockwork::Error::Authentication - if API login details are incorrect
+    # @return [integer] Number of messages remaining    
+    def credit
+      xml = Clockwork::XML::Credit.build( self )
+      response = Clockwork::HTTP.post( Clockwork::API::CREDIT_URL, xml, @use_ssl )
+      credit = Clockwork::XML::Credit.parse( response )
+    end
+    
+    # Deliver multiple messages created using Clockwork::API#messages.build.
+    # @return [array] Array of Clockwork::SMS::Response objects for messages.    
+    def deliver
+      xml = Clockwork::XML::SMS.build_multiple( self.messages )
+      http_response = Clockwork::HTTP.post( Clockwork::API::SMS_URL, xml, @use_ssl )
+      responses = Clockwork::XML::SMS.parse_multiple( self.messages, http_response )
+    end
+    
+  end
+  
+end

data/lib/clockwork/error.rb

@@ -0,0 +1,28 @@
+module Clockwork
+  
+  # Module containing Clockwork::Error classes, all of which extend StandardError.
+  module Error
+
+    # @author James Inman <james@mediaburst.co.uk>
+    # Raised if the entered authentication details (API key or username and password) are incorrect. (Error code: 2)
+    class Authentication < StandardError
+    end
+  
+    # @author James Inman <james@mediaburst.co.uk>
+    # Raised for all error codes not otherwise specified.
+    class Generic < StandardError
+    end
+  
+    # @author James Inman <james@mediaburst.co.uk>
+    # Raised if a HTTP connection to the API fails.
+    class HTTP < StandardError
+    end
+  
+    # @author James Inman <james@mediaburst.co.uk>
+    # Raised if the API key is in an invalid format.
+    class InvalidAPIKey < StandardError
+    end
+    
+  end
+  
+end

data/lib/clockwork/http.rb

@@ -0,0 +1,40 @@
+module Clockwork
+  
+  # @author James Inman <james@mediaburst.co.uk>
+  # Wrapper around NET/HTTP
+  class HTTP
+    
+    # Build a HTTP POST request.
+    # @param [string] url URL to POST to
+    # @param [string] data Body of the POST request.
+    # @param [boolean] use_ssl Whether to use SSL when making the request.
+    # @return [string] XML data
+    def self.post url, data = '', use_ssl = true
+      if use_ssl
+        uri = URI.parse "https://#{url}"
+        req = Net::HTTP::Post.new( uri.path )
+    
+        socket = Net::HTTP.new( uri.host, uri.port )
+        socket.use_ssl = true
+        socket.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      else
+        uri = URI.parse "http://#{url}"
+        req = Net::HTTP::Post.new( uri.path )
+    
+        socket = Net::HTTP.new( uri.host, uri.port ) 
+      end
+      
+      req.content_type = "text/xml"
+      req.body = data
+      req.add_field "User-Agent", "Clockwork Ruby Wrapper/#{Clockwork::VERSION}"
+      
+      response = socket.start do |http|
+        http.request( req )
+      end
+      
+      response
+    end
+
+  end
+  
+end

data/lib/clockwork/message_collection.rb

@@ -0,0 +1,39 @@
+module Clockwork
+  
+  # @author James Inman <james@mediaburst.co.uk>
+  # Use an instance of Clockwork::API#messages.build to create SMS messages.
+  class MessageCollection
+    
+    # @!attribute api
+    # An instance of Clockwork::API.
+    # @return [Clockwork::API]
+    attr_accessor :api
+    
+    # @!attribute messages
+    # An array of Clockwork::SMS messages.
+    # @return [array]    
+    attr_accessor :messages
+    
+    # @param [hash] options Hash of attributes which must include an instance of Clockwork::API
+    # @raise ArgumentError - if a valid instance of API is not passed as :api in options 
+    # Create a new instance of Clockwork::MessageCollection.
+    def initialize options
+      @api = options[:api]
+      raise ArgumentError, "Clockwork::MessageCollection#new must include an instance of Clockwork::API as :api" unless @api.kind_of?(Clockwork::API)
+      
+      @messages = []
+    end
+    
+    # @param [hash] params Hash of parameters as attributes on Clockwork::SMS
+    # @see Clockwork::SMS 
+    # Create a new instance of Clockwork::SMS in this MessageCollection.
+    def build params = {}
+      sms = Clockwork::SMS.new({ api: @api }.merge(params))
+      sms.wrapper_id = @messages.count
+      @messages << sms
+      sms
+    end
+    
+  end
+  
+end

data/lib/clockwork/sms.rb

@@ -0,0 +1,95 @@
+module Clockwork
+  
+  # @author James Inman <james@mediaburst.co.uk>
+  # Create an instance of Clockwork::SMS for each SMS message you want to send.
+  class SMS
+    
+    # @!attribute api
+    # An instance of Clockwork::API.
+    # @return [Clockwork::API]
+    attr_accessor :api
+    
+    # @!attribute content
+    # *REQUIRED:* The message content to send.
+    # @return [string]
+    attr_accessor :content
+            
+    # @!attribute client_id
+    # An unique message ID specified by the connecting application, for example your database record ID. Maximum length: 50 characters.
+    # @return [string]
+    attr_accessor :client_id
+        
+    # @!attribute from
+    # The from address displayed on a phone when the SMS is received. This can be either a 12 digit number or 11 characters long.
+    # @return [string] 
+    # @note If this option is set it overrides the global option specified in Clockwork::API for this SMS, if neither option is set your account default will be used.
+    attr_accessor :from
+    
+    # @!attribute long
+    # Set to +true+ to enable long SMS. A standard text can contain 160 characters, a long SMS supports up to 459. Each recipient will cost up to 3 message credits.
+    # @return [boolean]
+    # @note If this option is set it overrides the global option specified in Clockwork::API for this SMS, if neither option is set your account default will be used.
+    attr_accessor :long
+    
+    # @!attribute truncate
+    # Set to +true+ to trim the message content to the maximum length if it is too long.
+    # @return [boolean] 
+    # @note If this option is set it overrides the global option specified in Clockwork::API for this SMS, if neither option is set your account default will be used.
+    attr_accessor :truncate
+        
+    # What to do with any invalid characters in the message content. +:error+ will raise a Clockwork::InvalidCharacterException, +:replace+ will replace a small number of common invalid characters, such as the smart quotes used by Microsoft Office with a similar match, +:remove+ will remove invalid characters.
+    # @raise ArgumentError - if value is not one of +:error+, +:replace+, +:remove+
+    # @return [symbol] One of +error+, +:replace+, +:remove+ 
+    # @note If this option is set it overrides the global option specified in Clockwork::API for this SMS, if neither option is set your account default will be used.
+    attr_reader :invalid_char_action
+    
+    # @!attribute to
+    # *REQUIRED:* The phone number to send the SMS to in international number format (without a leading + or international dialling prefix such as 00, e.g. 441234567890).
+    # @return [string]
+    attr_accessor :to
+    
+    attr_writer :wrapper_id
+    
+    def invalid_char_action= symbol
+      raise( ArgumentError, "#{symbol} must be one of :error, :replace, :remove" ) unless [:error, :replace, :remove].include?(symbol.to_sym)
+    end    
+    
+    # @param [hash] options Optional hash of attributes on Clockwork::SMS
+    # Create a new SMS message.
+    def initialize options = {}      
+      options.each { |k, v| instance_variable_set "@#{k}", v } if options.kind_of?(Hash)
+    end
+    
+    # Deliver the SMS message.
+    # @return [Clockwork::SMS::Response] An instance of Clockwork::SMS::Response
+    def deliver
+      xml = Clockwork::XML::SMS.build_single( self )
+      http_response = Clockwork::HTTP.post( Clockwork::API::SMS_URL, xml, @api.use_ssl )
+      response = Clockwork::XML::SMS.parse_single( self, http_response )      
+    end
+    
+    # Translate standard variable names to those needed to make an XML request. First, checks if global variables are set in Clockwork::API then overwrites with variables set in Clockwork::SMS instance.
+    # @return [hash] Hash of XML keys and values
+    def translated_attributes
+      attributes = {}
+      translations = []
+      translations << { :var => 'client_id', :xml_var => 'ClientID' }
+      translations << { :var => 'concat', :xml_var => 'Concat' }
+      translations << { :var => 'from', :xml_var => 'From' }
+      translations << { :var => 'invalid_char_action', :xml_var => 'InvalidCharAction' }
+      translations << { :var => 'content', :xml_var => 'Content' }
+      translations << { :var => 'to', :xml_var => 'To' }
+      translations << { :var => 'truncate', :xml_var => 'Truncate' }
+      translations << { :var => 'wrapper_id', :xml_var => 'WrapperID' }
+      
+      translations.each do |t|
+        self.instance_variable_set( "@#{t[:var]}", @api.instance_variable_get( "@#{t[:var]}" ) ) if self.instance_variable_get( "@#{t[:var]}" ).nil?
+        attributes[ t[:xml_var] ] = self.instance_variable_get( "@#{t[:var]}" ) unless self.instance_variable_get( "@#{t[:var]}" ).nil?
+      end
+
+      attributes
+    end 
+    
+  end
+  
+end

data/lib/clockwork/sms/response.rb

@@ -0,0 +1,39 @@
+module Clockwork
+  class SMS
+    
+    # @author James Inman <james@mediaburst.co.uk>
+    # A Clockwork::SMS::Response is returned for each SMS sent by Clockwork::SMS#deliver.
+    class Response
+        
+      # @!attribute error_code
+      # The error code returned if the SMS fails.
+      # @return [string] 
+      attr_accessor :error_code
+      
+      # @!attribute error_description
+      # The error description returned if the SMS fails.
+      # @return [string] 
+      attr_accessor :error_description
+        
+      # @!attribute message_id
+      # The message ID returned if the SMS is sent successfully.
+      # @return [string] 
+      attr_accessor :message_id
+        
+      # @!attribute message
+      # The instance of Clockwork::SMS relating to this response.
+      # @return [Clockwork::SMS] 
+      attr_accessor :message
+        
+      # @!attribute success
+      # +true+ if the SMS is sent successfully, +false+ otherwise.
+      # @return [boolean] 
+      attr_accessor :success
+      
+      def error_code
+        @error_code.to_i unless @error_code.nil?
+      end
+      
+    end    
+  end  
+end

data/lib/clockwork/xml/credit.rb

@@ -0,0 +1,49 @@
+module Clockwork
+  module XML
+    
+    # @author James Inman <james@mediaburst.co.uk>
+    # XML building and parsing for checking credit.
+    class Credit
+      
+      # Build the XML data to check the credit from the XML API.
+      # @param [Clockwork::API] api Instance of Clockwork::API
+      # @return [string] XML data
+      def self.build api
+        builder = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+          xml.Credit {
+            if api.api_key
+              xml.Key api.api_key
+            else
+              xml.Username api.username
+              xml.Password api.password
+            end
+          }
+        end
+        builder.to_xml
+      end
+    
+      # Parse the XML response.
+      # @param [Net::HTTPResponse] response Instance of Net::HTTPResponse
+      # @raise Clockwork:HTTPError - if a connection to the Clockwork API cannot be made
+      # @raise Clockwork::Error::Generic - if the API returns an error code other than 2
+      # @raise Clockwork::Error::Authentication - if API login details are incorrect 
+      # @return [string] Number of remaining credits    
+      def self.parse response
+        if response.code.to_i == 200
+          doc = Nokogiri.parse( response.body )
+          if doc.css('ErrDesc').empty?
+            doc.css('Credit').inner_html.to_i
+          elsif doc.css('ErrNo').inner_html.to_i == 2
+            raise Clockwork::Error::Authentication, doc.css('ErrDesc').inner_html
+          else
+            raise Clockwork::Error::Generic, doc.css('ErrDesc').inner_html
+          end
+        else
+          raise Clockwork::Error::HTTP, "Could not connect to the Clockwork API to check credit."
+        end
+      end
+      
+    end
+    
+  end
+end

data/lib/clockwork/xml/sms.rb

@@ -0,0 +1,114 @@
+module Clockwork
+  module XML
+    
+    # @author James Inman <james@mediaburst.co.uk>
+    # XML building and parsing for sending SMS messages.
+    class SMS
+      
+      # Build the XML data to send a single SMS using the XML API.
+      # @param [Clockwork::SMS] sms Instance of Clockwork::SMS
+      # @return [string] XML data
+      def self.build_single sms
+        builder = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+          xml.Message {
+            if sms.api.api_key
+              xml.Key sms.api.api_key
+            else
+              xml.Username sms.api.username
+              xml.Password sms.api.password                
+            end
+            xml.SMS {
+              sms.translated_attributes.each do |k, v|
+                xml.send "#{k}", v
+              end
+            }
+          }
+        end
+        builder.to_xml
+      end
+      
+      # Build the XML data to send multiple SMS messages using the XML API.
+      # @param [Clockwork::MessageCollection] collection Instance of Clockwork::SMS
+      # @return [string] XML data
+      def self.build_multiple collection
+        builder = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+          xml.Message {
+            if collection.api.api_key
+              xml.Key collection.api.api_key
+            else
+              xml.Username collection.api.username
+              xml.Password collection.api.password                
+            end
+            collection.messages.each do |sms|
+              xml.SMS {
+                sms.translated_attributes.each do |k, v|
+                  xml.send "#{k}", v
+                end
+              }
+            end
+          }
+        end
+        builder.to_xml
+      end
+      
+      # Parse the XML data from a single SMS response from the XML API.
+      # @param [Clockwork::SMS] sms Instance of Clockwork::SMS
+      # @param [Net::HTTPResponse] http_response Instance of Net:HTTPResponse
+      # @raise Clockwork:HTTPError - if a connection to the Clockwork API cannot be made
+      # @return [Clockwork::SMS::Response] Instance of Clockwork::SMS::Response for the message
+      def self.parse_single sms, http_response
+        response = Clockwork::SMS::Response.new
+        response.message = sms
+        
+        if http_response.code.to_i == 200
+          doc = Nokogiri.parse( http_response.body )
+          if doc.css('ErrDesc').empty?
+            response.success = true
+            response.message_id = doc.css('MessageID').inner_html
+          else
+            response.success = false
+            response.error_code = doc.css('ErrNo').inner_html.to_i
+            response.error_description = doc.css('ErrDesc').inner_html
+          end
+        else
+          raise Clockwork::Error::HTTP, "Could not connect to the Clockwork API to send SMS."
+        end
+        
+        response        
+      end
+
+      # Parse the XML data from a multiple SMS response from the XML API.
+      # @param [Clockwork::MessageCollection] collection Instance of Clockwork::SMS
+      # @param [Net::HTTPResponse] http_response Instance of Net:HTTPResponse
+      # @raise Clockwork:HTTPError - if a connection to the Clockwork API cannot be made
+      # @return [array] Array of Clockwork::SMS::Response objects relating to the messages
+      def self.parse_multiple collection, http_response
+        responses = []
+        
+        if http_response.code.to_i == 200
+          doc = Nokogiri.parse( http_response.body )
+        else
+          raise Clockwork::Error::HTTP, "Could not connect to the Clockwork API to send SMS."
+        end
+        
+        doc.css('SMS_Resp').each_with_index do |sms_response, i|
+          response = Clockwork::SMS::Response.new
+          response.message = collection.messages[i]
+          if sms_response.css('ErrDesc').empty?
+            response.success = true
+            response.message_id = sms_response.css('MessageID').inner_html
+          else
+            response.success = false
+            response.error_code = sms_response.css('ErrNo').inner_html.to_i
+            response.error_description = sms_response.css('ErrDesc').inner_html
+          end
+          responses[sms_response.css('WrapperID').inner_html.to_i] = response
+        end
+        
+        responses
+      end
+      
+    end
+    
+  end
+end

data/lib/clockwork/xml/xml.rb

@@ -0,0 +1,17 @@
+require 'nokogiri'
+
+module Clockwork
+
+  # @author James Inman <james@mediaburst.co.uk>
+  # Wrapper for the XML builder/parser
+  module XML        
+  end
+  
+end
+
+# Require everything in this directory
+dir_path = File.dirname(__FILE__)
+Dir["#{dir_path}/*.rb"].each do |file|
+  next if file =~ /xml.rb$/
+  require file
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: clockworksms
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Mediaburst
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby Gem for the Clockwork API. Send text messages with the easy to use
+  SMS API from Mediaburst.
+email: hello@mediaburst.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/clockwork/api.rb
+- lib/clockwork/error.rb
+- lib/clockwork/http.rb
+- lib/clockwork/message_collection.rb
+- lib/clockwork/sms/response.rb
+- lib/clockwork/sms.rb
+- lib/clockwork/xml/credit.rb
+- lib/clockwork/xml/sms.rb
+- lib/clockwork/xml/xml.rb
+- lib/clockwork.rb
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+homepage: http://www.clockworksms.com/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby Gem for the Clockwork API.
+test_files: []