mediaburst 1.0

data/ISC-LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2011, Matthew Hall <matt@codebeef.com>
+
+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,63 @@
+# Mediaburst API Gem
+
+The Mediaburst Gem is the fastest way of integrating the [Mediaburst API][2] into your own ruby applications.
+
+## Installation
+
+Install the gem as normal:
+
+    sudo gem install mediaburst
+
+The Mediaburst gem also relies on [Nokogiri][1] for XML parsing.
+
+## Usage
+
+Create an instance of the Mediaburst client:
+
+    client = Mediaburst::API.new('username', 'password')
+
+Send an SMS:
+
+    response = client.send_message('441234567890', 'My test message')
+
+Send a message to several numbers:
+
+    response = client.send_message(['441234567890', '441234567891', '441234567892'], 'My test message')
+
+Send a long message to several numbers using the [concat option][8]:
+
+    options = {
+      :concat => 3
+    }
+    
+    response = client.send_message(['441234567890', '441234567891', '441234567892', '44'], SOME_LONG_MESSAGE, options)
+
+Check the response for errors:
+
+    y response
+    => ---
+       "441234567890": true
+       "441234567891": true
+       "441234567892": true
+       "44": 10
+
+On error, the value of the key referenced by the number will equal the [error code][5] returned from Mediaburst.
+
+
+## Development
+
+The source for the gem is [hosted on GitHub][3] for you to peruse, fork and contribute to.
+
+To enable us to easily manage your contributions, please submit your pull requests as single commits that include tests to show your changes working as normal. Please do not change the version number - we'll take care of that as we merge your changes.
+
+## License
+
+Copyright © 2011 [Matthew Hall][4], released under the ISC license. All trademarks and IP remain the property of their respective owners.
+
+
+[1]:http://nokogiri.org/
+[2]:http://www.mediaburst.co.uk/api
+[3]:https://github.com/mediaburst/ruby-mediaburst-sms
+[4]:http://codebeef.com/portfolio/mediaburst
+[5]:http://www.mediaburst.co.uk/api/reference/error-codes/
+[8]:http://www.mediaburst.co.uk/api/sending-a-message/parameters/#param-concat

data/lib/mediaburst/api.rb

@@ -0,0 +1,99 @@
+require 'nokogiri'
+require 'net/http'
+
+module Mediaburst
+  ENDPOINT = 'http://sms.message-platform.com/xml/send.aspx'
+  
+  # Thrown when an invalid request is made, 
+  # e.g invalid credentials were used
+  class InvalidRequest < Exception
+  end
+
+  # Thrown when we don't get a succesful response 
+  # from the mediaburst server
+  class ServerError < Exception
+  end
+  
+  class API
+    def initialize(u, p)
+      @auth = {:username => u, :password => p}
+    end
+  
+    # Takes a number or array of numbers and a content string
+    # and sends to the mediaburst SMS API endpoint.
+    #
+    # numbers - a string or array of strings 
+    # content - the string to send
+    # options - a hash of options to send to the API
+    #
+    # Returns a hash in the format:
+    # "phone number" => true on success or an error number on failure
+    def send_message(numbers, content, options ={})
+      numbers = [numbers] unless numbers.class == Array
+      self.process_response(self.send_request(self.create_xml(numbers, content, options)))
+    end
+  
+    # Get the xml for the request
+    def create_xml(numbers, content, options)
+      # Note that the username and password should be the first elements passed
+      builder = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+        xml.message {
+          xml.Username @auth[:username]
+          xml.Password @auth[:password]
+          
+          options.each do |k, v|
+            xml.send(k.to_s, v)
+          end
+          
+          numbers.each do |number|
+            xml.SMS {
+              xml.To number
+              xml.Content content
+            }
+          end
+        }
+      end
+      
+      builder.to_xml
+    end
+    
+    # Send a request to the endpoint
+    def send_request(request_body)
+      # Create and send the request
+      uri = URI.parse(ENDPOINT)
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.body = request_body
+      request["Content-Type"] = "text/xml"
+
+      http.request(request)
+    end
+    
+    # Process the received response
+    def process_response(response)
+      # Make sure we get a successful response
+      case response
+      when Net::HTTPSuccess
+        # Parse the response
+        response_xml = Nokogiri::XML(response.body)
+      
+        if response_xml.xpath('//SMS_Resp').empty?
+          raise Mediaburst::InvalidRequest, "ERROR: #{response_xml.xpath('//ErrDesc').inner_text}"
+        else
+          responses = {}
+          response_xml.xpath('//SMS_Resp').each do |sms_resp|
+            if sms_resp.xpath('ErrDesc').empty?
+              responses[sms_resp.xpath('To').inner_text] = true
+            else
+              responses[sms_resp.xpath('To').inner_text] = sms_resp.xpath('ErrNo').inner_text.to_i
+            end
+          end
+        end
+      else
+        raise Mediaburst::ServerError, "Request failed: #{response}"
+      end
+    
+      responses
+    end
+  end
+end

data/lib/mediaburst/version.rb

@@ -0,0 +1,3 @@
+module Mediaburst
+  VERSION = '1.0'
+end

data/lib/mediaburst.rb

@@ -0,0 +1,8 @@
+module Mediaburst end
+
+%w( 
+    mediaburst/version 
+    mediaburst/api
+).each do |lib|
+    require File.join(File.dirname(__FILE__), lib)
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: mediaburst
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- Matt Hall
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-16 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Wrapper for the Mediaburst SMS sending API
+email: 
+- matt@codebeef.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/mediaburst/api.rb
+- lib/mediaburst/version.rb
+- lib/mediaburst.rb
+- ISC-LICENSE
+- README.md
+has_rdoc: true
+homepage: http://www.mediaburst.co.uk/api
+licenses: 
+- ISC
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the Mediaburst SMS API
+test_files: []
+