clockworksms 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 450e85fc680bce613a59f96008cceead7f67c156
-  data.tar.gz: c36c1c47426c39f47adcbe707de3513efc01b777
+  metadata.gz: b320572710fdd15caaa287b035fb5986e1716e6a
+  data.tar.gz: 4f245423d51515acd428a39b4943e45c8c916160
 SHA512:
-  metadata.gz: 91f9d8fcedd15f1eeca4568aee53e9f3489bc1fba9955f1f513d8b91a4fdc3d5cde23680e35b92a3a8f0e02324612b46e85e7868a273d4924cede635b5538516
-  data.tar.gz: f672c7dab613a575879122867ae6e31d805c60d5d4d4091aba3e1eec41869d2f6b2a180fb5d4d05d426d8306cc4242984da20cdcf3cd63404eeb33d49bbd5c0e
+  metadata.gz: 5b73d28a88ab322b465c97617e4439019017910ac93a4471f7b7f8464c84945c7a9bc1428122a31b5c5149cd3c988be97b51720631256509e8727859ad3e2b26
+  data.tar.gz: 172feb809d68e8b4ba93251508f975be48a9ffc770b009d10afb6e9066ea52c9bca268a0ae6e2e52dd0076365e727b48c1b803fa8cdff543383e0253533c9155

data/Gemfile

@@ -1,8 +1,3 @@
 source 'https://rubygems.org'
 
-gem 'faraday'
-
-group :development do
-  gem 'rake'
-  gem 'rspec'
-end
+gemspec

data/README.md

@@ -1,5 +1,5 @@
 # Clockwork SMS API Ruby Gem
-
+[![Gem Version](https://badge.fury.io/rb/clockworksms.svg)](http://badge.fury.io/rb/clockworksms)
 ## Install
 
 Just add the following to your Gemfile:
@@ -18,71 +18,80 @@ For more information on the available optional parameters for each SMS (Clockwor
 
 ### 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
+```ruby
+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
+```ruby
+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.
+
+```ruby
+
+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
-    
-### 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
+end
+```
     
 ### Check balance
     
-    require 'clockwork'
-    api = Clockwork::API.new( 'API_KEY_GOES_HERE' )
-    balance = Clockwork::API.balance
-    puts balance # => { :account_type => "PAYG", :balance => 575.23, :currency => { :code => "GBP", :symbol => "£" } }
+```ruby
+require 'clockwork'
+api = Clockwork::API.new( 'API_KEY_GOES_HERE' )
+balance = Clockwork::API.balance
+puts balance # => { :account_type => "PAYG", :balance => 575.23, :currency => { :code => "GBP", :symbol => "£" } }
+```
 
 ## License
 
@@ -131,4 +140,11 @@ Then, run `rspec`.
 
 ### 1.2.0 (30th June, 2014)
 
-* Compatability fixes for Ruby 1.8, 2.0 and 2.1 (Tested with 1.8.7-p375, 1.9.3-p547, 2.0.0-p481 and 2.1.2)
+* Compatability fixes for Ruby 1.8, 2.0 and 2.1 (Tested with 1.8.7-p375, 1.9.3-p547, 2.0.0-p481 and 2.1.2).
+Thanks to [Paul Volpato](https://github.com/volpe), [Todd Bealmear](https://github.com/todd) and [Fawad](https://github.com/fawad) for the pull requests.
+
+### 1.2.1 (28th September, 2014)
+
+* Add some tests for the invalid_char_action and truncate parameters.
+* Fix invalid_char_action parameter as it was passing invalid values to the Clockwork API.
+Thanks to [Tom Pesman](https://github.com/tompesman) for the fix.

data/lib/clockwork/api.rb

@@ -2,7 +2,7 @@
 module Clockwork
     
   # Current API wrapper version
-  VERSION = '1.1.0'
+  VERSION = '1.2.1'
   
   # @author James Inman <james@mediaburst.co.uk>
   # You must create an instance of Clockwork::API to begin using the API.
@@ -58,7 +58,7 @@ module Clockwork
     # @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] 
@@ -76,7 +76,8 @@ module Clockwork
     end
       
     def invalid_char_action= symbol
-      raise( ArgumentError, "#{symbol} must be one of :error, :replace, :remove" ) unless [:error, :replace, :remove].include?(symbol.to_sym)
+      raise( ArgumentError, "#{symbol} must be one of :error, :replace, :remove" ) unless [:error, :remove, :replace].include?(symbol.to_sym)
+      @invalid_char_action = [nil, :error, :remove, :replace].index(symbol.to_sym)
     end
     
     def concat= number
@@ -111,6 +112,8 @@ module Clockwork
       @use_ssl = true if @use_ssl.nil?
       @concat = 3 if @concat.nil? && @long
       @messages ||= Clockwork::MessageCollection.new( :api => self )
+      @invalid_char_action = [nil, :error, :remove, :replace].index(@invalid_char_action) if @invalid_char_action
+      @truncate = @truncate ? true : false unless @truncate.nil?
     end
     
     # Check the remaining credit for this account.

data/lib/clockwork/sms.rb

@@ -36,7 +36,7 @@ module Clockwork
     # @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+ 
@@ -51,13 +51,15 @@ module Clockwork
     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)
+      raise( ArgumentError, "#{symbol} must be one of :error, :replace, :remove" ) unless [:error, :remove, :replace].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)
+      @invalid_char_action = [nil, :error, :remove, :replace].index(@invalid_char_action) if @invalid_char_action
+      @truncate = @truncate ? true : false unless @truncate.nil?
     end
     
     # Deliver the SMS message.

metadata

@@ -1,57 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: clockworksms
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Mediaburst
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-30 00:00:00.000000000 Z
+date: 2014-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
 description: Ruby Gem for the Clockwork API. Send text messages with the easy to use
   SMS API from Mediaburst.
 email: hello@mediaburst.co.uk
@@ -59,21 +73,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- 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:
 - MIT
@@ -84,17 +98,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby Gem for the Clockwork API.