clockworksms 1.0.0 → 1.1.0

data/README.md

@@ -77,12 +77,12 @@ You should not use the `Clockwork::Message#deliver` method for each message, but
         end
     end
     
-### Check credit
+### Check balance
     
     require 'clockwork'
     api = Clockwork::API.new( 'API_KEY_GOES_HERE' )
-    remaining_messages = Clockwork::API.credit
-    puts remaining messages # => 240
+    balance = Clockwork::API.balance
+    puts balance # => { :account_type => "PAYG", :balance => 575.23, :currency => { :code => "GBP", :symbol => "£" } }
 
 ## License
 
@@ -103,11 +103,9 @@ and submit a pull request. Please add RSpec tests for your use case.
 
 First, create a file at spec/spec_authentication_details containing the following:
 
-    34023ada3ec0d99213f91a12a2329ba932665ed7
-    MyLegacyAPIUsername@mydomain.com
-    MyPassword
+    YOUR_API_KEY_HERE
     
-Substitute your own API key, username and password on lines 1, 2, and 3 of the file.
+Substitute your own API key on line 1 of the file and replace the telephone numbers in the spec files with your own.
 
 Then, run `rspec`. 
 
@@ -116,4 +114,14 @@ Then, run `rspec`.
 [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
+[6]: http://rubydoc.info/github/mediaburst/clockwork-ruby/master/Clockwork/SMS/Response
+
+## Changelog
+
+### 1.0.0 (18th July, 2012)
+
+* Initial release of wrapper [JI]
+
+### 1.1.0 (10th September, 2012)
+
+* API#credit is now deprecated: use API#balance instead.

data/lib/clockwork/api.rb

@@ -2,7 +2,7 @@
 module Clockwork
     
   # Current API wrapper version
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
   
   # @author James Inman <james@mediaburst.co.uk>
   # You must create an instance of Clockwork::API to begin using the API.
@@ -11,7 +11,9 @@ module Clockwork
     # 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"    
+    CREDIT_URL = "api.clockworksms.com/xml/credit"   
+    # URL of the SMS API check balance action
+    BALANCE_URL = "api.clockworksms.com/xml/balance"    
     
     # API key provided in Clockwork::API#initialize.
     # @return [string] 
@@ -120,6 +122,15 @@ module Clockwork
       credit = Clockwork::XML::Credit.parse( response )
     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 balance
+      xml = Clockwork::XML::Balance.build( self )
+      response = Clockwork::HTTP.post( Clockwork::API::BALANCE_URL, xml, @use_ssl )
+      balance = Clockwork::XML::Balance.parse( response )
+    end
+    
     # Deliver multiple messages created using Clockwork::API#messages.build.
     # @return [array] Array of Clockwork::SMS::Response objects for messages.    
     def deliver

data/lib/clockwork/xml/balance.rb

@@ -0,0 +1,53 @@
+module Clockwork
+  module XML
+    
+    # @author James Inman <james@mediaburst.co.uk>
+    # XML building and parsing for checking balance.
+    class Balance
+      
+      # Build the XML data to check the balance 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.Balance {
+            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?
+            hsh = {}
+            hsh[:account_type] = doc.css('Balance_Resp').css('AccountType').inner_html
+            hsh[:balance] = doc.css('Balance_Resp').css('Balance').inner_html.to_f
+            hsh[:currency] = { :code  => doc.css('Balance_Resp').css('Currency').css('Code').inner_html, :symbol => doc.css('Balance_Resp').css('Currency').css('Symbol').inner_html }
+            hsh
+          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 balance."
+        end
+      end
+      
+    end
+    
+  end
+end

metadata

@@ -1,91 +1,92 @@
 --- !ruby/object:Gem::Specification
 name: clockworksms
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  prerelease:
+  version: 1.1.0
 platform: ruby
 authors:
 - Mediaburst
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-07-18 00:00:00.000000000 Z
+date: 2012-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
     none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
     none: false
+  requirement: !ruby/object:Gem::Requirement
     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.
+    none: false
+  prerelease: false
+  type: :development
+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.rb
 - 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/sms/response.rb
+- lib/clockwork/xml/balance.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: 
+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
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+  none: false
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 1.8.24
-signing_key: 
+signing_key:
 specification_version: 3
 summary: Ruby Gem for the Clockwork API.
 test_files: []
+...