action_texter 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3098b20b629f56af9f732f0579ff97f8ff9339a6
+  data.tar.gz: 1e15e8b067a5891ff348a75387e4d74ff44e788d
+SHA512:
+  metadata.gz: 8f041a3e6a040a488122a937a7adb8a89627332163a117db88d0ac3999cdef6731903255524fb5a52b01825d6a369f2761e9cf92d4b429e97e14da17b0f9994a
+  data.tar.gz: a8d3c4e9228565d8c9a9046bb3032b2bfec1f7c5f6dc0e230f67f872ec317488689f7bae6834c6806aff7ea85d089bbf50e00f1532cbc2206aa79d8578485ec7

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+Authoritative changelog in README.md.
+
+## Version next
+- Interceptors and observers
+- Support for Twilio
+- Fixed Nexmo number formatting
+
+## Version 0.1.0 (Apr 5, 2013)
+- Initial version
+- Support for Nexmo
+- Support for testing

data/Gemfile

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-# Copyright © 2012, 2013, Watu
+# Copyright © 2012, 2013, 2014, 2015, Carousel Apps
 
 source "https://rubygems.org"
 

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Watu
+Copyright (c) 2012, 2013, 2014, 2015, Carousel Apps
 
 MIT License
 

data/README.md

@@ -6,7 +6,7 @@ Generic interface to send SMSs with Ruby.
 
 Add this line to your application's Gemfile:
 
-    gem 'action_texter'
+    gem "action_texter"
 
 And then execute:
 
@@ -18,7 +18,67 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+TODO: Write better usage instructions here
+
+1. Configure which client to use in your initializers
+
+```
+if Rails.env.test? # || Rails.env.development?
+  ActionTexter::Client.setup("Test")
+else
+  ActionTexter::Client.setup("Nexmo", "key", "secret")
+end
+```
+
+1. Instantiate an ActionTexter::Message
+
+```
+message = ActionTexter::Message.new(from: "phone number",
+                                    to: "phone number",
+                                    text: "message contents",
+                                    reference: "optional reference")
+```
+
+1. Deliver the message
+
+```
+message.deliver
+```
+
+1. **DO NOT** Instantiate the client and call deliver passing in the message. This breaks the beautiful abstraction
+     of the client selector, and it also means observers and interceptors don't work
+
+1. Set observers or interceptors
+
+```
+class MyInterceptor
+    def delivering_sms(message)
+        # Do something with the message. Modify its contents and return the modified object.
+        # Or return nil / false to cancel the sending
+    end
+end
+
+class MyObserver
+    def delivered_sms(message, response)
+        # Log, or do whatever you want with the fact that an SMS has been sent, and that's the response you got
+    end
+end
+
+ActionTexter.register_interceptor(MyInterceptor.new)
+ActionTexter.register_observer(MyObserver.new)
+```
+
+## Changelog
+
+### Version next
+- Interceptors and observers
+- Support for Twilio
+- Fixed Nexmo number formatting
+
+### Version 0.1.0 (Apr 5, 2013)
+- Initial version
+- Support for Nexmo
+- Support for testing
 
 ## Contributing
 

data/action_texter.gemspec

@@ -1,19 +1,24 @@
 # encoding: UTF-8
-# Copyright © 2013, Watu
+# Copyright © 2013, 2014, 2015, Carousel Apps
 
-require File.expand_path('../lib/action_texter/version', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "action_texter/version"
 
-Gem::Specification.new do |gem|
-  gem.authors       = ["J. Pablo Fernández"]
-  gem.email         = ["info@watuhq.com"]
-  gem.description   = %q{Generic interface to send SMS with Ruby}
-  gem.summary       = %q{Generic interface to send SMS with Ruby}
-  gem.homepage      = ""
+Gem::Specification.new do |spec|
+  spec.name          = "action_texter"
+  spec.version       = ActionTexter::VERSION
+  spec.authors       = ["J. Pablo Fernández", "Daniel Magliola"]
+  spec.email         = ["info@carouselapps.com"]
+  spec.homepage      = "http://carouselapps.com/action_texter"
+  spec.description   = %q{Generic interface to send SMS with Ruby}
+  spec.summary       = %q{Generic interface to send SMS with Ruby}
+  spec.license       = "MIT"
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "action_texter"
-  gem.require_paths = ["lib"]
-  gem.version       = ActionTexter::VERSION
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 1.9.3"
 end

data/lib/action_texter.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
-# Copyright © 2012, 2013, Watu
+# Copyright © 2012, 2013, 2014, 2015, Carousel Apps
 
+require "action_texter/action_texter"
 require "action_texter/version"
 require "action_texter/client"
 require "action_texter/message"
@@ -8,4 +9,5 @@ require "action_texter/response"
 require "action_texter/response"
 require "action_texter/test"
 require "action_texter/nexmo"
+require "action_texter/twilio"
 

data/lib/action_texter/action_texter.rb

@@ -0,0 +1,75 @@
+# encoding: UTF-8
+# Copyright © 2014, 2015, Carousel Apps
+
+module ActionTexter
+  @@delivery_observers = []
+  @@delivery_interceptors = []
+
+  # You can register an object to be informed of every SMS that is sent, after it is sent
+  # Your object needs to respond to a single method #delivered_sms(message, response)
+  #    message will be of type ActionTexter::Message
+  #    response will be of type ActionTexter::Response
+  #
+  # @param observer [Object] with a #delivered_sms method that will be called passing in the ActionTexter::Message
+  #   and ActionTexter::Response
+  # @returns the observer added
+  def self.register_observer(observer)
+    unless @@delivery_observers.include?(observer)
+      @@delivery_observers << observer
+    end
+    observer
+  end
+
+  # Unregister the given observer
+  #
+  # @param observer [Object] to unregister
+  # @returns deleted observer
+  def self.unregister_observer(observer)
+    @@delivery_observers.delete(observer)
+  end
+
+  # You can register an object to be given every Message object that will be sent, before it is sent.
+  # This allows you to modify the contents of the message, or even stop it by returning false or nil.
+  #
+  # Your object needs to respond to a single method #delivering_sms(message)
+  # It must return the modified object to be sent instead, or nil
+  #
+  # @param interceptor [Object] with a #delivering_sms method that will be called passing in the ActionTexter::Message
+  # @returns the interceptor added
+  def self.register_interceptor(interceptor)
+    unless @@delivery_interceptors.include?(interceptor)
+      @@delivery_interceptors << interceptor
+    end
+    interceptor
+  end
+
+  # Unregister the given interceptor
+  #
+  # @param interceptor [Object] to unregister
+  # @returns deleted interceptor
+  def self.unregister_interceptor(interceptor)
+    @@delivery_interceptors.delete(interceptor)
+  end
+
+  # Inform all the observers about the SMS being sent
+  #
+  # @param message [ActionTexter::Message] that is being sent
+  # @returns the list of observers
+  def self.inform_observers(message, response)
+    @@delivery_observers.each { |observer| observer.delivered_sms(message, response) }
+  end
+
+
+  # Inform all the interceptors about the SMS being sent. Any interceptor can modify the message or cancel it
+  #
+  # @param message [ActionTexter::Message] that is being sent
+  # @returns the message that must be sent, returned by the last interceptor. This may be nil or false
+  def self.inform_interceptors(message)
+    @@delivery_interceptors.each do |interceptor|
+      message = interceptor.delivering_sms(message)
+      break if message.blank?
+    end
+    message
+  end
+
+end

data/lib/action_texter/client.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-# Copyright © 2012, 2013, Watu
+# Copyright © 2012, 2013, 2014, 2015, Carousel Apps
 
 # Parent class for all SMS clients.
 #

data/lib/action_texter/message.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-# Copyright © 2012, 2013, Watu
+# Copyright © 2012, 2013, 2014, 2015, Carousel Apps
 
 # Representation of a message
 #
@@ -24,11 +24,17 @@ class ActionTexter::Message
   end
 
   def deliver(client = nil)
+    message = ActionTexter.inform_interceptors(self)
+    return nil if message.blank? # Do not send if one of the interceptors cancelled
+
     client ||= ActionTexter::Client.default
     if client.nil?
       raise "To deliver a message you need to specify a client by parameter to deliver or by ActionTexter::Client.dafault="
     end
-    client.deliver(self)
+
+    response = client.deliver(message)
+    ActionTexter.inform_observers(message, response)
+    response
   end
 
   # @private

data/lib/action_texter/nexmo.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-# Copyright © 2012, 2013, Watu
+# Copyright © 2012, 2013, 2014, 2015, Carousel Apps
 
 require "bigdecimal"
 require "net/http"
@@ -69,12 +69,19 @@ class ActionTexter::NexmoClient < ActionTexter::Client
   def deliver(message)
     client = Net::HTTP.new("rest.nexmo.com", 443)
     client.use_ssl = true
+
+    # Nexmo doesn't like phone numbers starting with a +
+    # Pattern only matches phones that are pristine phone numbers starting with a +, and leaves everything else alone
+    pattern = /^\+(\d+)$/
+    from = (message.from =~ pattern ? message.from.gsub(pattern, '\1')  : message.from )
+    to = (message.to =~ pattern ? message.to.gsub(pattern, '\1')  : message.to )
+
     response = client.post(
         "/sms/json",
         URI.encode_www_form("username" => @key,
                             "password" => @secret,
-                            "from" => message.from,
-                            "to" => message.to,
+                            "from" => from,
+                            "to" => to,
                             "text" => message.text,
                             "client-ref" => message.reference),
         {"Content-Type" => "application/x-www-form-urlencoded"})

data/lib/action_texter/response.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-# Copyright © 2012, 2013, Watu
+# Copyright © 2012, 2013, 2014, 2015, Carousel Apps
 
 # A response as sent from the provider.
 #

data/lib/action_texter/test.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-# Copyright © 2012, 2013, Watu
+# Copyright © 2012, 2013, 2014, 2015, Carousel Apps
 
 require "bigdecimal"
 

data/lib/action_texter/twilio.rb

@@ -0,0 +1,72 @@
+# encoding: UTF-8
+# Copyright © 2014, 2015, Carousel Apps
+
+require "bigdecimal"
+require "net/http"
+require "net/https"
+require "json"
+require "uri"
+
+# Twilio response
+class ActionTexter::TwilioResponse < ActionTexter::Response
+  # TODO: Some of these should be moved to Response if they are common enough.
+  attr_reader :original, :parts_count, :cost, :reference
+
+  private
+
+  def process_response(raw)
+    @original = JSON.parse(raw)
+
+    if @original["error_code"].blank? && @original["code"].blank?
+      @success = true
+      @reference = @original["sid"]
+      @parts_count = @original["num_segments"]
+
+      # The cost is nil because the message is, as of now, queued. To get the cost we need to GET @original["uri"]
+      # for message details, but that assumes that the message is sent by that time.
+      # The proper way, a callback, is way out of the scope of this gem.
+      @cost = nil
+    else
+      @success = false
+
+      # Responses take two shapes. Either they have a status like "queued", and they have an "error_code" field
+      #    (which I've never seen filled), or they return a status like "400", with a "code" and a "message"
+      if @original.has_key?("code")
+        @error_message = @original["message"]
+      elsif @original.has_key?("error_message")
+        @error_message = @original["error_message"]
+      end
+    end
+  end
+end
+
+# Implementation of client for Twilio: http://twilio.com
+class ActionTexter::TwilioClient < ActionTexter::Client
+  attr_accessor :account_sid, :auth_token
+
+  # Create a new Twilio client with account sid and auth token
+  #
+  # @param [String] account_sid as specified by Twilio for authenticating.
+  # @param [String] auth_token as specified by Twilio for authenticating.
+  def initialize(account_sid, auth_token)
+    super()
+    self.account_sid = account_sid
+    self.auth_token = auth_token
+  end
+
+  def deliver(message)
+    http = Net::HTTP.new("api.twilio.com", 443)
+    http.use_ssl = true
+    request = Net::HTTP::Post.new("/2010-04-01/Accounts/#{@account_sid}/Messages.json")
+    request.basic_auth(@account_sid, @auth_token)
+    request.set_form_data({"From" => message.from, "To" => message.to, "Body" => message.text})
+    response = http.request(request)
+
+    return ActionTexter::TwilioResponse.new(response.body)
+  end
+
+  # @private
+  def to_s
+    "#<#{self.class.name}:#{key}>"
+  end
+end

data/lib/action_texter/version.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
-# Copyright © 2012, 2013, Watu
+# Copyright © 2012, 2013, 2014, 2015, Carousel Apps
 
 module ActionTexter
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,58 +1,61 @@
 --- !ruby/object:Gem::Specification
 name: action_texter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - J. Pablo Fernández
+- Daniel Magliola
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-05 00:00:00.000000000 Z
+date: 2015-01-28 00:00:00.000000000 Z
 dependencies: []
 description: Generic interface to send SMS with Ruby
 email:
-- info@watuhq.com
+- info@carouselapps.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - action_texter.gemspec
 - lib/action_texter.rb
+- lib/action_texter/action_texter.rb
 - lib/action_texter/client.rb
 - lib/action_texter/message.rb
 - lib/action_texter/nexmo.rb
 - lib/action_texter/response.rb
 - lib/action_texter/test.rb
+- lib/action_texter/twilio.rb
 - lib/action_texter/version.rb
-homepage: ''
-licenses: []
+homepage: http://carouselapps.com/action_texter
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.4.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Generic interface to send SMS with Ruby
 test_files: []