openmarket 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 313f1285d8dfc0d1a615e4d0e34b8d833df72e35
+  data.tar.gz: 54bf9d7d27719f8883faf50abc03ccba6619e6a5
+SHA512:
+  metadata.gz: 4b97d23e3d060dae73ae4489b75e2291ff8b8f491ab05be1d5dd76e6512a9584fc5234580e353b9a8848ea7fc1f262dc7215cbea5ad3757675def646e8662ede
+  data.tar.gz: f9e13cf97a53740a26f755e7d201cf92048c521cc78ccbaac75452462de1bb023e74e884d9787092ce42b4b875d66d0c3a8b2f9e2d6ece78c1947ef1a647484e

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+secrets.yml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in open_market.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Isaac Betesh
+
+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,129 @@
+# OpenMarket
+
+We use HTTParty to send SMS messages using the OpenMarket API.  See USAGE below for details.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'openmarket'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install openmarket
+
+## Usage
+
+### Configuratiion
+
+The openmarket gem requires you to provide an id, password, program_id and short_code.  Configure them before attempting any API calls.
+
+```ruby
+OpenMarket.configure do |config|
+  config.id = "000-000-000-00000"
+  config.password = "Re@llyL0ngR&om$tr1ng"
+  config.program_id = "ABC"
+  config.short_code = 99999 # You can override this on an individual message if necessary
+end
+```
+
+Since the openmarket gem depends on sms_validation (https://github.com/betesh/sms_validation/), it is also recommended that you configure sms_validation.
+openmarket uses sms_validation's logger.  In a Rails environment, you will probably want to rely on the default configuration,
+but outside of Rails, you will need to configure it if you want any logging:
+
+```ruby
+SmsValidation.configure do |config|
+  config.logger = ::Logger.new(STDOUT)
+end
+```
+
+### API calls
+
+`OpenMarket::API` supports 3 API calls: `carrier_lookup`, `send_sms`, and `status`.
+
+#### carrier_lookup
+
+```ruby
+require  'openmarket'
+phone = 2125551212
+result = OpenMarket::API.carrier_lookup(phone)
+
+# First, make sure the call succeeded
+puts result.code # should be 0
+puts result.description # should be 'No Error'
+
+# If the call succeeded, you can check the carrier_id:
+puts result.carrier_id # You are probably most interested in the carrier_id
+puts result.inspect # But there are a lot of other attributes returned by this API call as well
+```
+
+#### send_sms
+
+```ruby
+require  'openmarket'
+phone = 2125551212
+message = "Hello, this is a test of the OpenMarket API"
+result = OpenMarket::API.send_sms(phone, message)
+
+# First, make sure the call succeeded
+puts result.code # should be 2
+puts result.description # should be 'Message received.'
+
+# Save the ticket ID for later.  We'll use this to query the status of the ticket.
+ticket_id = result.ticket_id
+
+# Save the carrier ID for later.  We'll use this next time we send an SMS to this number.
+carrier_id = result.carrier_id
+
+# There are some options you can pass along as well:
+result = OpenMarket::API.send_sms(
+  phone,
+  message,
+
+  # If you want to receive DR's, you must pass a dr_url option.  If you don't pass a URL, no DR will be sent to the default URL.
+  dr_url: "http://www.example.com/drs",
+
+  # It is highly recommended to pass a carrier_id.  If you don't, the openmarket gem will make an extra API call to look up the carrier before sending the message.
+  carrier_id: carrier_id, # Remember the carrier ID we saved from the previous SMS?
+
+  # If you don't want to the short_code you configured above, provide another short_code to send to:
+  short_code: 33333,
+
+  # By default, OpenMarket re-attempts delivery for 3 days.  To make OpenMarket give up and report it as a failure sooner, pass a number of minutes you would like to retry for:
+  minutes_to_retry: 120, # 2 hours
+
+  note: "Information that will be passed on to the DR",
+
+  ticket_id_for_retry: ticket_id # If this is a re-try of a failed ticket.
+)
+
+```
+#### status
+
+```ruby
+require  'openmarket'
+result = OpenMarket::API.status(ticket_id) # Remember the ticket ID we saved from #send_sms?
+
+# First, make sure the call succeeded
+puts result.code # should be 0
+puts result.description # should be 'No Error'
+
+# Check the result of the SMS message
+puts result.status_code
+puts result.status_description
+
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/betesh/open_market/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/open_market.rb

@@ -0,0 +1,4 @@
+require "open_market/api"
+
+module OpenMarket
+end

data/lib/open_market/api.rb

@@ -0,0 +1,83 @@
+require "open_market/configuration"
+require "open_market/response"
+require "open_market/version"
+
+require "builder"
+require "httparty"
+require "sms_validation"
+
+module OpenMarket
+  class Api
+    class Http
+      include HTTParty
+      base_uri "https://smsc.openmarket.com"
+    end
+
+    ALLOWED_OPTIONS = [:dr_url, :ticket_id_for_retry, :carrier_id, :note, :minutes_to_retry, :short_code]
+    class InvalidOptions < ::StandardError; end
+
+    def carrier_lookup(phone)
+      CarrierLookupResponse.new(post(:preview) do |b|
+        b.destination(ton: 1, address: "1#{phone.to_s[-10..-1]}")
+      end)
+    end
+
+    def send_sms(phone, message, options = {})
+      phone = SmsValidation::Sms.new(phone, message).phone
+      options = options.inject({}) { |hash, (k,v)| hash[k.to_sym] = v; hash }
+      unrecognized_keys = options.keys - ALLOWED_OPTIONS
+      raise InvalidOptions, "#{unrecognized_keys.join(", ")} #{1 == unrecognized_keys.size ? "is not a" : "are not"} valid option#{:s if unrecognized_keys.size > 1}" unless unrecognized_keys.empty?
+      request_options = options.select{ |k,v| k.to_sym == :ticket_id_for_retry }
+      carrier_id = options[:carrier_id] || carrier_lookup(phone).carrier_id
+      SendSmsResponse.new(post(:submit, request_options) do |b|
+        b.delivery(receipt_requested: true, url: options[:dr_url]) if options[:dr_url]
+        b.option((options[:note] ? { note: options[:note] } : {}).merge(charge_type: 0, program_id: configuration.program_id, mlc: message_length_control))
+        b.source(ton: 3, address: options[:short_code] || configuration.short_code)
+        b.destination(ton: 1, address: phone, carrier: carrier_id)
+        b.message((options[:minutes_to_retry] ? { validity_period: (options[:minutes_to_retry].to_f * 60).round } : {}).merge(text: message))
+      end, carrier_id)
+    end
+
+    def status(ticket_id)
+      StatusResponse.new(post(:query) do |b|
+        b.ticket(id: ticket_id)
+      end)
+    end
+
+    private
+    def configuration
+      @configuration ||= Module.nesting.last.configuration
+    end
+
+    def filtered(value)
+      [:account, :user].inject(value) { |v, k| v.gsub(/<#{k}.*?\/>/, "") }
+    end
+
+    def post(type, options = {})
+      builder = Builder::XmlMarkup.new
+      builder.instruct!(:xml, version: 1.0)
+      body = builder.request(options.merge(version: 3.0, protocol: :wmp, type: type)) do |r|
+        r.user(agent: "openmarket_rubygem/SMS/#{OpenMarket::VERSION}")
+        r.account(id: configuration.id, password: configuration.password)
+        yield r
+      end
+      SmsValidation.log { "OpenMarket API: POST #{filtered(body)}" }
+      Http.post("/wmp", body: body.to_s).tap do |result|
+        SmsValidation.log { "OpenMarket API Result: #{result.respond_to?(:body) ? result.body : result}" }
+      end
+    end
+
+    def message_length_control
+      case SmsValidation.configuration.on_message_too_long
+        when :truncate
+          1
+        when :raise_error
+          0
+        when :split
+          2
+      end
+    end
+  end
+
+  API ||= Api.new
+end

data/lib/open_market/configuration.rb

@@ -0,0 +1,38 @@
+module OpenMarket
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+  end
+
+  class Configuration
+    class Error < ::StandardError; end
+    CONFIGURATION_OPTIONS = [:id, :password, :program_id, :short_code]
+
+    (CONFIGURATION_OPTIONS - [:short_code]).each do |accessor|
+      define_method(:"#{accessor}=") do |arg|
+        raise Error, "#{accessor} must be a String" unless arg.nil? || arg.is_a?(String)
+        raise Error, "#{accessor} cannot be blank" if arg.nil? || arg.empty?
+        instance_variable_set("@#{accessor}", arg)
+      end
+    end
+
+    def short_code=(arg)
+      raise Error, "short_code cannot be blank" if arg.nil?
+      raise Error, "short_code must be a 5-digit number" unless arg.to_s.scan(/\A[0-9]{5}\z/)
+      @short_code = arg
+    end
+
+    CONFIGURATION_OPTIONS.each do |accessor|
+      define_method(accessor) do
+        instance_variable_get("@#{accessor}").tap do |result|
+          raise Error, "#{accessor} has not been set.  Set it with `#{Module.nesting.last}.configuration.#{accessor} = ...`" if result.nil?
+        end
+      end
+    end
+  end
+end

data/lib/open_market/dr.rb

@@ -0,0 +1,27 @@
+require "rexml/document"
+
+module OpenMarket
+  class DR
+    attr_reader :code, :description, :note, :parent_ticket_id, :segment_number, :state_description, :state_id, :ticket_id, :timestamp
+    def initialize(data)
+      (class << self; self; end).class_eval do
+        # Defining a member variable for xml would pollute #inspect
+        # This solution is inspired by https://github.com/jordansissel/software-patterns/tree/master/dont-log-secrets/ruby
+        define_method(:xml) { REXML::Document.new(data).root }
+        private :xml
+      end
+      @ticket_id = xml.attributes["ticketId"]
+      @parent_ticket_id = xml.attributes["parentTicketId"]
+      @note = xml.attributes["note"]
+      response = xml.elements["response"]
+      @description = response.attributes["description"]
+      @code = response.attributes["code"].to_i
+      message = xml.elements["message"]
+      @segment_number = message.attributes["segmentNumber"]
+      @timestamp = DateTime.strptime(message.attributes["deliveryDate"] + "+0000", '%FT%T.%LZ%z').utc
+      state = message.elements["state"]
+      @state_id = state.attributes["id"].to_i
+      @state_description = state.attributes["description"]
+    end
+  end
+end

data/lib/open_market/mo.rb

@@ -0,0 +1,37 @@
+require "rexml/document"
+
+module OpenMarket
+  class MO
+    attr_reader :account_id, :carrier_id, :data, :data_coding, :destination_address, :destination_ton, :source_address, :source_ton, :ticket_id, :udhi
+    def initialize(data)
+      (class << self; self; end).class_eval do
+        # Defining a member variable for xml would pollute #inspect
+        # This solution is inspired by https://github.com/jordansissel/software-patterns/tree/master/dont-log-secrets/ruby
+        define_method(:xml) { REXML::Document.new(data).root }
+        private :xml
+      end
+      if ticket = xml.elements["ticket"]
+        @ticket_id = ticket.attributes["id"]
+      end
+      if account = xml.elements["account"]
+        @account_id = account.attributes["id"]
+      end
+      if source = xml.elements["source"]
+        @carrier_id = source.elements["carrier"]
+        @source_ton = source.elements["ton"]
+        @source_address = source.elements["address"]
+      end
+      if destination = xml.elements["destination"]
+        @destination_ton = destination.elements["ton"]
+        @destination_address = destination.elements["address"]
+      end
+      if option = xml.elements["option"]
+        @data_coding = option.attributes["datacoding"]
+      end
+      if message = xml.elements["message"]
+        @udhi = message.attributes["udhi"] == true
+        @data = message.attributes["data"]
+      end
+    end
+  end
+end

data/lib/open_market/response.rb

@@ -0,0 +1,98 @@
+require "rexml/document"
+
+module OpenMarket
+  class Response
+    attr_reader :code, :description
+    def initialize(http_response)
+      (class << self; self; end).class_eval do
+        # Defining a member variable for xml would pollute #inspect
+        # This solution is inspired by https://github.com/jordansissel/software-patterns/tree/master/dont-log-secrets/ruby
+        define_method(:xml) do
+          if http_response.respond_to?(:body)
+            REXML::Document.new(http_response.body).root
+          else
+            REXML::Document.new(http_response.to_xml).root.elements["response"]
+          end
+        end
+        private :xml
+      end
+      error = xml.elements["error"]
+      @code = (error.attributes["code"] || error.elements["code"].text).to_i
+      @description = error.attributes["description"] || error.elements["description"].text
+    end
+  end
+
+  class CarrierLookupResponse < Response
+    attr_reader :country_code, :national_number, :intl_notation, :area_code, :area_code_length, :num_min_length, :num_max_length, :na_nxx, :na_line, :local_notation, :local_format, :digits_all, :digits_local, :ported, :ported_from
+    attr_reader :city, :country, :country_name, :estimated_latitude, :estimated_longitude, :region, :region_name, :timezone_min, :timezone_max, :zone, :zone_name
+    attr_reader :carrier_id, :name, :binary_length, :text_length, :unicode_length, :binary, :ems, :smart_messaging, :unicode, :wap_push
+
+    def initialize(http_response)
+      super
+      if destination = xml.elements["destination"]
+        @country_code = destination.attributes["country_code"].to_i
+        @national_number = destination.attributes["national_number"]
+        @intl_notation = destination.attributes["intl_notation"]
+        @area_code = destination.attributes["area_code"]
+        @area_code_length = destination.attributes["area_code_length"].to_i
+        @num_min_length = destination.attributes["num_min_length"].to_i
+        @num_max_length = destination.attributes["num_max_length"].to_i
+        @na_nxx = destination.attributes["na_nxx"]
+        @na_line = destination.attributes["na_line"]
+        @local_notation = destination.attributes["local_notation"]
+        @local_format = destination.attributes["local_format"]
+        @digits_all = destination.attributes["digits_all"].to_i
+        @digits_local = destination.attributes["digits_local"].to_i
+        @ported = destination.attributes["ported"] == "true"
+        @ported_from = destination.attributes["ported_from"]
+      end
+      if location = xml.elements["location"]
+        @city = location.attributes["city"]
+        @country = location.attributes["country"]
+        @country_name = location.attributes["country_name"]
+        @estimated_latitude = location.attributes["estimated_latitude"].to_f
+        @estimated_longitude = location.attributes["estimated_longitude"].to_f
+        @region = location.attributes["region"]
+        @region_name = location.attributes["region_name"]
+        @timezone_min = location.attributes["timezone_min"].to_i
+        @timezone_max= location.attributes["timezone_max"].to_i
+        @zone = location.attributes["zone"].to_i
+        @zone_name = location.attributes["zone_name"]
+      end
+      if operator = xml.elements["operator"]
+        @carrier_id = operator.attributes["id"].to_i
+        @name = operator.attributes["name"]
+        @binary_length = operator.attributes["binary_length"].to_i
+        @text_length = operator.attributes["text_length"].to_i
+        @unicode_length = operator.attributes["unicode_length"].to_i
+        @binary = operator.attributes["binary"] == "true"
+        @ems = operator.attributes["ems"] == "true"
+        @smart_messaging = operator.attributes["smart_messaging"] == "true"
+        @unicode = operator.attributes["unicode"] == "true"
+        @wap_push = operator.attributes["wap_push"] == "true"
+      end
+    end
+  end
+
+  class SendSmsResponse < Response
+    attr_reader :ticket_id, :carrier_id
+    def initialize(http_response, carrier_id)
+      super(http_response)
+      @carrier_id = carrier_id
+      if ticket = xml.elements["ticket"]
+        @ticket_id = ticket.attributes["id"]
+      end
+    end
+  end
+
+  class StatusResponse < Response
+    attr_reader :status_code, :status_description
+    def initialize(http_response)
+      super
+      if status = xml.elements["status"]
+        @status_code = status.attributes["code"].to_i
+        @status_description = status.attributes["description"]
+      end
+    end
+  end
+end

data/lib/open_market/version.rb

@@ -0,0 +1,3 @@
+module OpenMarket
+  VERSION = "0.0.1"
+end

data/lib/openmarket.rb

@@ -0,0 +1 @@
+require "open_market"

data/open_market.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'open_market/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "openmarket"
+  spec.version       = OpenMarket::VERSION
+  spec.authors       = ["Isaac Betesh"]
+  spec.email         = ["iybetesh@gmail.com"]
+  spec.summary       = "Send SMS messages using the OpenMarket API"
+  spec.description   = `cat README.md`
+  spec.homepage      = "https://github.com/betesh/open_market"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3"
+
+  spec.add_dependency "sms_validation", "~> 0.0.2"
+  spec.add_dependency "httparty"
+  spec.add_dependency "builder"
+end

data/spec/api_spec.rb

@@ -0,0 +1,220 @@
+require "open_market/api"
+require "support/configuration_from_yaml"
+
+describe OpenMarket::Api do
+  subject { OpenMarket::API }
+
+  describe "#carrier_lookup" do
+    it "should succeed without a 1 preceding the phone number" do
+      result = subject.carrier_lookup(phone)
+      expect(result).to be_a(OpenMarket::CarrierLookupResponse)
+      expect(result.code).to eq(0)
+      expect(result.description).to eq("No Error")
+      expect(result.carrier_id).to eq(carrier_id)
+    end
+
+    it "should succeed with a 1 preceding the phone number" do
+      result = subject.carrier_lookup("1#{phone}")
+      expect(result).to be_a(OpenMarket::CarrierLookupResponse)
+      expect(result.code).to eq(0)
+      expect(result.description).to eq("No Error")
+      expect(result.carrier_id).to eq(carrier_id)
+    end
+  end
+
+  describe "#send_sms" do
+    it "should send an SMS" do
+      result = subject.send_sms(phone, "Test of OpenMarket API", carrier_id: carrier_id)
+      expect(result.code).to eq(2)
+      expect(result.description).to eq("Message received.")
+      expect(result.ticket_id).not_to be_nil
+    end
+
+    it "looks up the carrier_id if it is not passed as an option and returns it" do
+      expect(OpenMarket::Api::Http).to receive(:post).and_wrap_original do |original, *args, &block|
+        expect(args[0]).to eq("/wmp")
+        puts args[1][:body].inspect
+        expect(args[1][:body]).to match /\A<\?xml version=\"1.0\" encoding=\"UTF-8\"\?><request version=\"3.0\" protocol=\"wmp\" type=\"preview\"><user agent=\"openmarket_rubygem\/SMS\/0\.0\.1\"\/><account id=\"#{id}\" password=\"#{password}\"\/><destination ton=\"1\" address=\"1#{phone}\"\/><\/request>\z/
+        original.call(*args, &block)
+      end
+      expect(OpenMarket::Api::Http).to receive(:post).and_wrap_original do |original, *args, &block|
+        expect(args[0]).to eq("/wmp")
+        expect(args[1][:body]).to match /\A<\?xml version=\"1.0\" encoding=\"UTF-8\"\?><request version=\"3.0\" protocol=\"wmp\" type=\"submit\"><user agent=\"openmarket_rubygem\/SMS\/0\.0\.1\"\/><account id=\"#{id}\" password=\"#{password}\"\/><option charge_type=\"0\" program_id=\"#{program_id}\" mlc=\"0\"\/><source ton=\"3\" address=\"#{short_code}\"\/><destination ton=\"1\" address=\"1#{phone}\" carrier=\"#{carrier_id}\"\/><message text=\"Test of OpenMarket API\"\/><\/request>\z/
+        original.call(*args, &block)
+      end
+      result = subject.send_sms(phone, "Test of OpenMarket API")
+      expect(result.carrier_id).to eq(carrier_id)
+    end
+
+    describe "message_length_control" do
+      describe "when SmsValidation.configuration.on_message_too_long is truncate" do
+        it "should be 1" do
+          SmsValidation.configuration.on_message_too_long = :truncate
+          expect(OpenMarket::Api::Http).to receive(:post).and_wrap_original do |original, *args, &block|
+            expect(args[0]).to eq("/wmp")
+            expect(args[1][:body]).to match /\A<\?xml version=\"1.0\" encoding=\"UTF-8\"\?><request version=\"3.0\" protocol=\"wmp\" type=\"submit\"><user agent=\"openmarket_rubygem\/SMS\/0\.0\.1\"\/><account id=\"#{id}\" password=\"#{password}\"\/><option charge_type=\"0\" program_id=\"#{program_id}\" mlc=\"1\"\/><source ton=\"3\" address=\"#{short_code}\"\/><destination ton=\"1\" address=\"1#{phone}\" carrier=\"#{carrier_id}\"\/><message text=\"Test of OpenMarket API\"\/><\/request>\z/
+            original.call(*args, &block)
+          end
+          subject.send_sms(phone, "Test of OpenMarket API", carrier_id: carrier_id)
+        end
+      end
+
+      describe "when SmsValidation.configuration.on_message_too_long is split" do
+        it "should be 2" do
+          SmsValidation.configuration.on_message_too_long = :split
+          expect(OpenMarket::Api::Http).to receive(:post).and_wrap_original do |original, *args, &block|
+            expect(args[0]).to eq("/wmp")
+            expect(args[1][:body]).to match /\A<\?xml version=\"1.0\" encoding=\"UTF-8\"\?><request version=\"3.0\" protocol=\"wmp\" type=\"submit\"><user agent=\"openmarket_rubygem\/SMS\/0\.0\.1\"\/><account id=\"#{id}\" password=\"#{password}\"\/><option charge_type=\"0\" program_id=\"#{program_id}\" mlc=\"2\"\/><source ton=\"3\" address=\"#{short_code}\"\/><destination ton=\"1\" address=\"1#{phone}\" carrier=\"#{carrier_id}\"\/><message text=\"Test of OpenMarket API\"\/><\/request>\z/
+            original.call(*args, &block)
+          end
+          subject.send_sms(phone, "Test of OpenMarket API", carrier_id: carrier_id)
+        end
+      end
+
+      describe "when SmsValidation.configuration.on_message_too_long is raise_error" do
+        it "should be 0" do
+          SmsValidation.configuration.on_message_too_long = :raise_error
+          expect(OpenMarket::Api::Http).to receive(:post).and_wrap_original do |original, *args, &block|
+            expect(args[0]).to eq("/wmp")
+            expect(args[1][:body]).to match /\A<\?xml version=\"1.0\" encoding=\"UTF-8\"\?><request version=\"3.0\" protocol=\"wmp\" type=\"submit\"><user agent=\"openmarket_rubygem\/SMS\/0\.0\.1\"\/><account id=\"#{id}\" password=\"#{password}\"\/><option charge_type=\"0\" program_id=\"#{program_id}\" mlc=\"0\"\/><source ton=\"3\" address=\"#{short_code}\"\/><destination ton=\"1\" address=\"1#{phone}\" carrier=\"#{carrier_id}\"\/><message text=\"Test of OpenMarket API\"\/><\/request>\z/
+            original.call(*args, &block)
+          end
+          subject.send_sms(phone, "Test of OpenMarket API", carrier_id: carrier_id)
+        end
+      end
+    end
+
+    describe "invalid keys" do
+      it "should raise a gramatically correct error with 1 unknown option" do
+        expect{subject.send_sms(phone, "Test of OpenMarket API", carrier_id: carrier_id, unknown_option: true)}.to raise_error(OpenMarket::Api::InvalidOptions, "unknown_option is not a valid option")
+      end
+
+      it "should raise a gramatically correct error with 2 unknown options" do
+        expect{subject.send_sms(phone, "Test of OpenMarket API", carrier_id: carrier_id, unknown_option: true, other_unknown: false)}.to raise_error(OpenMarket::Api::InvalidOptions, "unknown_option, other_unknown are not valid options")
+      end
+
+      it "automatically converts String keys to Symbol" do
+        expect{subject.send_sms(phone, "Test of OpenMarket API", "carrier_id" => carrier_id, "ticket_id_for_retry" => "ABC", "dr_url" => dr_url, "note" => "ABCDEFFF", "minutes_to_retry" => 10, "short_code" => 99998)}.not_to raise_error
+      end
+    end
+
+    describe "valid keys" do
+      describe "carrier_id" do
+        let(:carrier_id) { 1000000 }
+        it "should be in the XML" do
+          expect(OpenMarket::Api::Http).to receive(:post).and_wrap_original do |original, *args, &block|
+            expect(args[0]).to eq("/wmp")
+            expect(args[1][:body]).to match /\A<\?xml version=\"1.0\" encoding=\"UTF-8\"\?><request version=\"3.0\" protocol=\"wmp\" type=\"submit\"><user agent=\"openmarket_rubygem\/SMS\/0\.0\.1\"\/><account id=\"#{id}\" password=\"#{password}\"\/><option charge_type=\"0\" program_id=\"#{program_id}\" mlc=\"0\"\/><source ton=\"3\" address=\"#{short_code}\"\/><destination ton=\"1\" address=\"1#{phone}\" carrier=\"#{carrier_id}\"\/><message text=\"Test of OpenMarket API\"\/><\/request>\z/
+            original.call(*args, &block)
+          end
+          subject.send_sms(phone, "Test of OpenMarket API", carrier_id: carrier_id)
+        end
+      end
+
+      describe "note" do
+        let(:note) { "The quick brown fox jumps over the lazy dog" }
+        it "should be in the XML" do
+          expect(OpenMarket::Api::Http).to receive(:post).and_wrap_original do |original, *args, &block|
+            expect(args[0]).to eq("/wmp")
+            expect(args[1][:body]).to match /\A<\?xml version=\"1.0\" encoding=\"UTF-8\"\?><request version=\"3.0\" protocol=\"wmp\" type=\"submit\"><user agent=\"openmarket_rubygem\/SMS\/0\.0\.1\"\/><account id=\"#{id}\" password=\"#{password}\"\/><option note=\"#{note}\" charge_type=\"0\" program_id=\"#{program_id}\" mlc=\"0\"\/><source ton=\"3\" address=\"#{short_code}\"\/><destination ton=\"1\" address=\"1#{phone}\" carrier=\"#{carrier_id}\"\/><message text=\"Test of OpenMarket API\"\/><\/request>\z/
+            original.call(*args, &block)
+          end
+          subject.send_sms(phone, "Test of OpenMarket API", carrier_id: carrier_id, note: note)
+        end
+      end
+
+      describe "ticket_id_for_retry" do
+        let(:ticket_id_for_retry) { 1999998888 }
+        it "should be in the XML" do
+          expect(OpenMarket::Api::Http).to receive(:post).and_wrap_original do |original, *args, &block|
+            expect(args[0]).to eq("/wmp")
+            expect(args[1][:body]).to match /\A<\?xml version=\"1.0\" encoding=\"UTF-8\"\?><request ticket_id_for_retry=\"#{ticket_id_for_retry}\" version=\"3.0\" protocol=\"wmp\" type=\"submit\"><user agent=\"openmarket_rubygem\/SMS\/0\.0\.1\"\/><account id=\"#{id}\" password=\"#{password}\"\/><option charge_type=\"0\" program_id=\"#{program_id}\" mlc=\"0\"\/><source ton=\"3\" address=\"#{short_code}\"\/><destination ton=\"1\" address=\"1#{phone}\" carrier=\"#{carrier_id}\"\/><message text=\"Test of OpenMarket API\"\/><\/request>\z/
+            original.call(*args, &block)
+          end
+          subject.send_sms(phone, "Test of OpenMarket API", carrier_id: carrier_id, ticket_id_for_retry: ticket_id_for_retry)
+        end
+      end
+
+      describe "dr_url" do
+        let(:dr_url) { "example.com" }
+        it "should be in the XML" do
+          expect(OpenMarket::Api::Http).to receive(:post).and_wrap_original do |original, *args, &block|
+            expect(args[0]).to eq("/wmp")
+            expect(args[1][:body]).to match /\A<\?xml version=\"1.0\" encoding=\"UTF-8\"\?><request version=\"3.0\" protocol=\"wmp\" type=\"submit\"><user agent=\"openmarket_rubygem\/SMS\/0\.0\.1\"\/><account id=\"#{id}\" password=\"#{password}\"\/><delivery receipt_requested=\"true\" url=\"#{dr_url}\"\/><option charge_type=\"0\" program_id=\"#{program_id}\" mlc=\"0\"\/><source ton=\"3\" address=\"#{short_code}\"\/><destination ton=\"1\" address=\"1#{phone}\" carrier=\"#{carrier_id}\"\/><message text=\"Test of OpenMarket API\"\/><\/request>\z/
+            original.call(*args, &block)
+          end
+          subject.send_sms(phone, "Test of OpenMarket API", dr_url: dr_url, carrier_id: carrier_id)
+        end
+      end
+
+      describe "minutes_to_retry" do
+        it "should be in the XML" do
+          expect(OpenMarket::Api::Http).to receive(:post).and_wrap_original do |original, *args, &block|
+            expect(args[0]).to eq("/wmp")
+            expect(args[1][:body]).to match /\A<\?xml version=\"1.0\" encoding=\"UTF-8\"\?><request version=\"3.0\" protocol=\"wmp\" type=\"submit\"><user agent=\"openmarket_rubygem\/SMS\/0\.0\.1\"\/><account id=\"#{id}\" password=\"#{password}\"\/><delivery receipt_requested=\"true\" url=\"#{dr_url}\"\/><option charge_type=\"0\" program_id=\"#{program_id}\" mlc=\"0\"\/><source ton=\"3\" address=\"#{short_code}\"\/><destination ton=\"1\" address=\"1#{phone}\" carrier=\"#{carrier_id}\"\/><message validity_period=\"1080\" text=\"Test of OpenMarket API\"\/><\/request>\z/
+            original.call(*args, &block)
+          end
+          subject.send_sms(phone, "Test of OpenMarket API", dr_url: dr_url, carrier_id: carrier_id, minutes_to_retry: 18)
+        end
+
+        describe "can be a fraction of a number and is rounded to the nearest integer number of seconds" do
+          [19, 20, 21].each do |divisor|
+            describe do
+              it "should be in the XML" do
+                expect(OpenMarket::Api::Http).to receive(:post).and_wrap_original do |original, *args, &block|
+                  expect(args[0]).to eq("/wmp")
+                  expect(args[1][:body]).to match /\A<\?xml version=\"1.0\" encoding=\"UTF-8\"\?><request version=\"3.0\" protocol=\"wmp\" type=\"submit\"><user agent=\"openmarket_rubygem\/SMS\/0\.0\.1\"\/><account id=\"#{id}\" password=\"#{password}\"\/><delivery receipt_requested=\"true\" url=\"#{dr_url}\"\/><option charge_type=\"0\" program_id=\"#{program_id}\" mlc=\"0\"\/><source ton=\"3\" address=\"#{short_code}\"\/><destination ton=\"1\" address=\"1#{phone}\" carrier=\"#{carrier_id}\"\/><message validity_period=\"3\" text=\"Test of OpenMarket API\"\/><\/request>\z/
+                  original.call(*args, &block)
+                end
+                subject.send_sms(phone, "Test of OpenMarket API", dr_url: dr_url, carrier_id: carrier_id, minutes_to_retry: 1.0/divisor )
+              end
+            end
+          end
+        end
+      end
+
+      describe "short_code" do
+        let(:short_code) { 66666 }
+        it "should be in the XML" do
+          expect(OpenMarket::Api::Http).to receive(:post).and_wrap_original do |original, *args, &block|
+            expect(args[0]).to eq("/wmp")
+            expect(args[1][:body]).to match /\A<\?xml version=\"1.0\" encoding=\"UTF-8\"\?><request version=\"3.0\" protocol=\"wmp\" type=\"submit\"><user agent=\"openmarket_rubygem\/SMS\/0\.0\.1\"\/><account id=\"#{id}\" password=\"#{password}\"\/><option charge_type=\"0\" program_id=\"#{program_id}\" mlc=\"0\"\/><source ton=\"3\" address=\"#{short_code}\"\/><destination ton=\"1\" address=\"1#{phone}\" carrier=\"#{carrier_id}\"\/><message text=\"Test of OpenMarket API\"\/><\/request>\z/
+            original.call(*args, &block)
+          end
+          subject.send_sms(phone, "Test of OpenMarket API", carrier_id: carrier_id, short_code: short_code)
+        end
+      end
+    end
+  end
+
+  describe "#status" do
+    let(:sms) { subject.send_sms(phone, "Test of OpenMarket API") }
+    let(:ticket_id) { sms.ticket_id }
+
+    def get_status
+      subject.status(ticket_id)
+    end
+
+    it "should look up the status of a ticket" do
+      status = get_status
+      expect(status.code).to eq(0)
+      expect(status.description).to eq("No Error")
+      expect(status.status_code).to eq(3)
+      expect(status.status_description).to eq("Message buffered with carrier and waiting for delivery response.")
+      print "Waiting for the message to be delivered..."
+      i = 0
+      SmsValidation.configuration.logger = nil
+      begin
+        sleep 1
+        print "."
+        status = get_status
+        break if 4 == status.status_code
+        i += 1
+      end while i < 5
+      expect(status.code).to eq(0)
+      expect(status.description).to eq("No Error")
+      expect(status.status_code).to eq(4)
+      expect(status.status_description).to eq("Message successfully delivered.")
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,35 @@
+require "support/configuration_from_yaml"
+require "open_market/configuration"
+
+describe OpenMarket::Configuration do
+  subject { OpenMarket.configuration }
+  let(:skip_open_market_configuration) { true }
+
+  [:id, :password, :program_id].each do |configuration_option|
+    describe "##{configuration_option}" do
+      it "cannot be nil" do
+        expect{subject.public_send("#{configuration_option}=", nil)}.to raise_error(OpenMarket::Configuration::Error, "#{configuration_option} cannot be blank")
+      end
+
+      it "cannot be an empty String" do
+        expect{subject.public_send("#{configuration_option}=", "")}.to raise_error(OpenMarket::Configuration::Error, "#{configuration_option} cannot be blank")
+      end
+
+      it "cannot be a Hash" do
+        expect{subject.public_send("#{configuration_option}=", {})}.to raise_error(OpenMarket::Configuration::Error, "#{configuration_option} must be a String")
+      end
+
+      it "must be set before accessing it" do
+        expect{subject.public_send(configuration_option)}.to raise_error(OpenMarket::Configuration::Error, "#{configuration_option} has not been set.  Set it with `OpenMarket.configuration.#{configuration_option} = ...`")
+      end
+
+      describe "when configured" do
+        let(:skip_open_market_configuration) { false }
+
+        it "is accessible" do
+          expect(subject.public_send(configuration_option)).to eq(public_send(configuration_option))
+        end
+      end
+    end
+  end
+end

data/spec/support/configuration_from_yaml.rb

@@ -0,0 +1,33 @@
+require "yaml"
+require "logger"
+require "rspec/core/shared_context"
+require "sms_validation"
+
+module ConfigurationFromYaml
+  extend RSpec::Core::SharedContext
+  SECRETS = YAML::load(File.open(File.expand_path("#{__FILE__}/../secrets.yml")))
+
+  SECRETS.keys.each do |key|
+    let(key) { SECRETS[key] }
+  end
+
+  let(:skip_open_market_configuration) { false }
+
+  before(:each) do
+    SmsValidation.configure do |config|
+      config.logger = ::Logger.new(STDOUT)
+    end
+    OpenMarket.configure do |config|
+      config.id, config.password, config.short_code, config.program_id = id, password, short_code, program_id
+    end unless skip_open_market_configuration
+  end
+
+  after(:each) do
+    OpenMarket.instance_variable_set("@configuration", nil)
+    SmsValidation.instance_variable_set("@configuration", nil)
+  end
+end
+
+RSpec.configure do |config|
+  config.include ConfigurationFromYaml
+end

data/spec/support/secrets.yml.example

@@ -0,0 +1,7 @@
+id: 000-000-000-00000
+password: Re@llyL0ngR&om$tr1ng
+short_code: 99999
+program_id: ABC
+phone: 2125551212
+carrier_id: 788
+dr_url: http://www.example.com/drs

metadata

@@ -0,0 +1,280 @@
+--- !ruby/object:Gem::Specification
+name: openmarket
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Isaac Betesh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: sms_validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  # OpenMarket
+
+  We use HTTParty to send SMS messages using the OpenMarket API.  See USAGE below for details.
+
+  ## Installation
+
+  Add this line to your application's Gemfile:
+
+  ```ruby
+  gem 'openmarket'
+  ```
+
+  And then execute:
+
+      $ bundle
+
+  Or install it yourself as:
+
+      $ gem install openmarket
+
+  ## Usage
+
+  ### Configuratiion
+
+  The openmarket gem requires you to provide an id, password, program_id and short_code.  Configure them before attempting any API calls.
+
+  ```ruby
+  OpenMarket.configure do |config|
+    config.id = "000-000-000-00000"
+    config.password = "Re@llyL0ngR&om$tr1ng"
+    config.program_id = "ABC"
+    config.short_code = 99999 # You can override this on an individual message if necessary
+  end
+  ```
+
+  Since the openmarket gem depends on sms_validation (https://github.com/betesh/sms_validation/), it is also recommended that you configure sms_validation.
+  openmarket uses sms_validation's logger.  In a Rails environment, you will probably want to rely on the default configuration,
+  but outside of Rails, you will need to configure it if you want any logging:
+
+  ```ruby
+  SmsValidation.configure do |config|
+    config.logger = ::Logger.new(STDOUT)
+  end
+  ```
+
+  ### API calls
+
+  `OpenMarket::API` supports 3 API calls: `carrier_lookup`, `send_sms`, and `status`.
+
+  #### carrier_lookup
+
+  ```ruby
+  require  'openmarket'
+  phone = 2125551212
+  result = OpenMarket::API.carrier_lookup(phone)
+
+  # First, make sure the call succeeded
+  puts result.code # should be 0
+  puts result.description # should be 'No Error'
+
+  # If the call succeeded, you can check the carrier_id:
+  puts result.carrier_id # You are probably most interested in the carrier_id
+  puts result.inspect # But there are a lot of other attributes returned by this API call as well
+  ```
+
+  #### send_sms
+
+  ```ruby
+  require  'openmarket'
+  phone = 2125551212
+  message = "Hello, this is a test of the OpenMarket API"
+  result = OpenMarket::API.send_sms(phone, message)
+
+  # First, make sure the call succeeded
+  puts result.code # should be 2
+  puts result.description # should be 'Message received.'
+
+  # Save the ticket ID for later.  We'll use this to query the status of the ticket.
+  ticket_id = result.ticket_id
+
+  # Save the carrier ID for later.  We'll use this next time we send an SMS to this number.
+  carrier_id = result.carrier_id
+
+  # There are some options you can pass along as well:
+  result = OpenMarket::API.send_sms(
+    phone,
+    message,
+
+    # If you want to receive DR's, you must pass a dr_url option.  If you don't pass a URL, no DR will be sent to the default URL.
+    dr_url: "http://www.example.com/drs",
+
+    # It is highly recommended to pass a carrier_id.  If you don't, the openmarket gem will make an extra API call to look up the carrier before sending the message.
+    carrier_id: carrier_id, # Remember the carrier ID we saved from the previous SMS?
+
+    # If you don't want to the short_code you configured above, provide another short_code to send to:
+    short_code: 33333,
+
+    # By default, OpenMarket re-attempts delivery for 3 days.  To make OpenMarket give up and report it as a failure sooner, pass a number of minutes you would like to retry for:
+    minutes_to_retry: 120, # 2 hours
+
+    note: "Information that will be passed on to the DR",
+
+    ticket_id_for_retry: ticket_id # If this is a re-try of a failed ticket.
+  )
+
+  ```
+  #### status
+
+  ```ruby
+  require  'openmarket'
+  result = OpenMarket::API.status(ticket_id) # Remember the ticket ID we saved from #send_sms?
+
+  # First, make sure the call succeeded
+  puts result.code # should be 0
+  puts result.description # should be 'No Error'
+
+  # Check the result of the SMS message
+  puts result.status_code
+  puts result.status_description
+
+  ```
+
+  ## Contributing
+
+  1. Fork it ( https://github.com/betesh/open_market/fork )
+  2. Create your feature branch (`git checkout -b my-new-feature`)
+  3. Commit your changes (`git commit -am 'Add some feature'`)
+  4. Push to the branch (`git push origin my-new-feature`)
+  5. Create a new Pull Request
+email:
+- iybetesh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/open_market.rb
+- lib/open_market/api.rb
+- lib/open_market/configuration.rb
+- lib/open_market/dr.rb
+- lib/open_market/mo.rb
+- lib/open_market/response.rb
+- lib/open_market/version.rb
+- lib/openmarket.rb
+- open_market.gemspec
+- spec/api_spec.rb
+- spec/configuration_spec.rb
+- spec/support/configuration_from_yaml.rb
+- spec/support/secrets.yml.example
+homepage: https://github.com/betesh/open_market
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Send SMS messages using the OpenMarket API
+test_files:
+- spec/api_spec.rb
+- spec/configuration_spec.rb
+- spec/support/configuration_from_yaml.rb
+- spec/support/secrets.yml.example