action_texter 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.idea
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,7 @@
+# encoding: UTF-8
+# Copyright © 2012, 2013, Watu
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in action_texter.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Watu
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# ActionTexter
+
+Generic interface to send SMSs with Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'action_texter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install action_texter
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+#!/usr/bin/env rake
+
+require "bundler/gem_tasks"

data/action_texter.gemspec

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+# Copyright © 2013, Watu
+
+require File.expand_path('../lib/action_texter/version', __FILE__)
+
+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.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
+end

data/lib/action_texter.rb

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+# Copyright © 2012, 2013, Watu
+
+require "action_texter/version"
+require "action_texter/client"
+require "action_texter/message"
+require "action_texter/response"
+require "action_texter/response"
+require "action_texter/test"
+require "action_texter/nexmo"
+

data/lib/action_texter/client.rb

@@ -0,0 +1,37 @@
+# encoding: UTF-8
+# Copyright © 2012, 2013, Watu
+
+# Parent class for all SMS clients.
+#
+# @abstract
+class ActionTexter::Client
+  def self.default
+    @default
+  end
+
+  def self.default=(client)
+    @default = client
+  end
+
+  def self.setup(provider, *attrs)
+    provider_client =
+        begin
+          ActionTexter.const_get(provider + "Client")
+        rescue NameError
+          raise "Provider #{provider} doesn't exist."
+        end
+    self.default = provider_client.new(*attrs)
+  end
+
+  # Deliver a message
+  # @param [Message] message message to be delivered
+  # @returns [Response] a response
+  def deliver(message)
+    raise NotImplementedError.new("should be implemented by subclasses")
+  end
+
+  # @private
+  def to_s
+    "#<#{self.class.name}:#{object_id}>"
+  end
+end

data/lib/action_texter/message.rb

@@ -0,0 +1,38 @@
+# encoding: UTF-8
+# Copyright © 2012, 2013, Watu
+
+# Representation of a message
+#
+# TODO: Implement these fields that Nexmo can use: :status_report_req, :network_code, :vcard, :vcal, :ttl
+#
+# @!attribute from
+#   @return [String] name or phone number of the author of the message.
+# @!attribute to
+#   @return [String] phone number of the author of the message.
+# @!attribute text
+#   @return [String] actual message to send.
+# @!attribute reference
+#   @return [String] a reference that can be used later on to track responses. Implemented for: Nexmo.
+class ActionTexter::Message
+  attr_accessor :from, :to, :text, :reference
+
+  def initialize(message = {})
+    self.from = message[:from] || raise("A message must contain from")
+    self.to = message[:to] || raise("A message must contain to")
+    self.text = message[:text] || raise("A message must contain text")
+    self.reference = message[:reference]
+  end
+
+  def deliver(client = nil)
+    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)
+  end
+
+  # @private
+  def to_s
+    "#<#{self.class.name}:#{from}:#{to}:#{text}>"
+  end
+end

data/lib/action_texter/nexmo.rb

@@ -0,0 +1,89 @@
+# encoding: UTF-8
+# Copyright © 2012, 2013, Watu
+
+require "bigdecimal"
+require "net/http"
+require "net/https"
+require "json"
+require "uri"
+
+# Nexmo response
+class ActionTexter::NexmoResponse < ActionTexter::Response
+  SUCCESS_RESPONSE_CODE = "0"
+
+  # TODO: Some of these should be moved to Response if they are common enough.
+  attr_reader :original, :parts_count, :parts, :cost, :remaining_balance, :reference
+
+  private
+
+  def process_response(raw)
+    @success = true
+    @original = JSON.parse(raw)
+    @parts_count = @original["message-count"].to_i
+    @cost = BigDecimal.new("0")
+    @reference = @original["messages"].first["client-ref"] # They should all be the same, we only record it the first time.
+    @remaining_balance = @original["messages"].last["remaining-balance"] # I hope the last one is the lowest one, the cost of a single message shouldn't make that big of a difference anyway.
+    @parts = []
+    error_messages = []
+    @original["messages"].each do |raw_part|
+      if @success # Update the contents of success to status of this part unless @succes is already failed.
+        @success = raw_part["status"] == SUCCESS_RESPONSE_CODE
+      end
+      part = {:id => raw_part["message-id"],
+              :to => raw_part["to"],
+              :success => raw_part["status"] == SUCCESS_RESPONSE_CODE}
+      part[:reference] = raw_part["client-ref"] if raw_part.has_key? "client-ref"
+      if raw_part.has_key? "message-price"
+        part[:cost] = raw_part["message-price"]
+        @cost += BigDecimal.new(raw_part["message-price"])
+      end
+      if raw_part.has_key? "remaining-balance"
+        part[:remaining_balance] = BigDecimal.new(raw_part["remaining-balance"])
+      end
+      if raw_part.has_key? "error-text"
+        part[:error_message] = raw_part["error-text"]
+        error_messages << part[:error_message]
+      end
+      @parts << part
+    end
+    if error_messages.any?
+      @error_message = error_messages.uniq.join(", ")
+    end
+  end
+end
+
+# Implementation of client for Nexmo: http://nexmo.com
+class ActionTexter::NexmoClient < ActionTexter::Client
+  attr_accessor :key, :secret
+
+  # Create a new Nexmo client with key and secret.
+  #
+  # @param [String] key key as specified by Nexmo for authenticating.
+  # @param [String] secret secret as specified by Nexmo for authenticating.
+  def initialize(key, secret)
+    super()
+    self.key = key
+    self.secret = secret
+  end
+
+  def deliver(message)
+    client = Net::HTTP.new("rest.nexmo.com", 443)
+    client.use_ssl = true
+    response = client.post(
+        "/sms/json",
+        URI.encode_www_form("username" => @key,
+                            "password" => @secret,
+                            "from" => message.from,
+                            "to" => message.to,
+                            "text" => message.text,
+                            "client-ref" => message.reference),
+        {"Content-Type" => "application/x-www-form-urlencoded"})
+
+    return ActionTexter::NexmoResponse.new(response.body)
+  end
+
+  # @private
+  def to_s
+    "#<#{self.class.name}:#{key}>"
+  end
+end

data/lib/action_texter/response.rb

@@ -0,0 +1,41 @@
+# encoding: UTF-8
+# Copyright © 2012, 2013, Watu
+
+# A response as sent from the provider.
+#
+# @abstract
+# @!attribute [r] raw
+#   @return [String] the raw response as returned by the provider
+# @!attribute success
+#   @return [Boolean] weather sending the message succeeded or not. See #success? and #failed?
+# @!attribute error_message
+#   @return [String] a descriptive message of the error when an error happened.
+class ActionTexter::Response
+  attr_reader :raw, :success, :error_message
+
+  def initialize(raw)
+    @raw = raw
+    process_response(raw)
+  end
+
+  # @return [Boolean] true when sending the message succeeded, false otherwise.
+  def success?
+    !!@success
+  end
+
+  # @return [Boolean] false when sending the message failed, true otherwise.
+  def failed?
+    !@success
+  end
+
+  # @private
+  def to_s
+    "#<#{self.class.name}:#{object_id}:#{@success ? "success" : "fail"}>"
+  end
+
+  private
+
+  def process_response(raw)
+    raise NotImplementedError.new("should be implemented by subclasses")
+  end
+end

data/lib/action_texter/test.rb

@@ -0,0 +1,52 @@
+# encoding: UTF-8
+# Copyright © 2012, 2013, Watu
+
+require "bigdecimal"
+
+# Responses sent by #TestClient
+class ActionTexter::TestResponse < ActionTexter::Response
+  attr_reader :parts_count, :parts, :cost, :remaining_balance, :reference, :error
+
+  private
+
+  def process_response(raw)
+    cost_per_message = BigDecimal("0.058")
+    @success = true
+    @original = raw
+    @reference = @original.reference if !@original.reference.nil?
+    @remaining_balance = BigDecimal.new("15.10")
+    @cost = BigDecimal.new("0")
+    @parts = []
+    (@original.text.length.to_f / 140).ceil.times do
+      @remaining_balance = @remaining_balance - cost_per_message
+      part = {:id => "test-response-#{Time.now.to_i}",
+              :to => @original.to,
+              :remaining_balance => @remaining_balance,
+              :cost => cost_per_message,
+              :success => true}
+      part[:reference] = @original.reference if !@original.reference.nil?
+      @cost += part[:cost]
+      @parts << part
+    end
+    @parts_count = @parts.count
+  end
+end
+
+# A client that doesn't send any message but instead stores them on an array.
+class ActionTexter::TestClient < ActionTexter::Client
+  def initialize
+    @@deliveries = []
+  end
+
+  def deliver(message)
+    @@deliveries << message
+    ActionTexter::TestResponse.new(message)
+  end
+
+  # All the delivered messages so far.
+  #
+  # @return [Array<Message>] delivered messages.
+  def deliveries
+    @@deliveries
+  end
+end

data/lib/action_texter/version.rb

@@ -0,0 +1,6 @@
+# encoding: UTF-8
+# Copyright © 2012, 2013, Watu
+
+module ActionTexter
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: action_texter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- J. Pablo Fernández
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-05 00:00:00.000000000 Z
+dependencies: []
+description: Generic interface to send SMS with Ruby
+email:
+- info@watuhq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- action_texter.gemspec
+- lib/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/version.rb
+homepage: ''
+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: Generic interface to send SMS with Ruby
+test_files: []