mblox 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 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,60 @@
+# Mblox
+
+This gem is for subscribers to Mblox to send SMS messages.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mblox'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mblox
+
+## Usage
+
+Configuration
+
+    Mblox.configure do |config|
+      # Set all of these values, provided to you in your Mblox subscription
+      config.outbound_url = ...
+      config.profile_id = ...
+      config.sender_id = ...
+      config.password = ...
+      config.partner_name = ...
+      config.tariff = ...
+      config.service_id = ...
+      
+      # You can also configure some logging options
+      # In a Rails environment, config.logger will default to Rails.logger and config.log_at will default to :debug
+      # config.log_at means the level at which Mblox will log.
+      # If config.log_at == :debug and your logger's log level is :info, logging will be suppressed because it is below the log level of the logger.
+      config.logger = Logger.new(STDOUT)
+      config.log_at :info
+    end
+
+Once your application is configured, send messages:
+
+    phone_number = 2225555555 # The number you're sending to.  Must be a 10-digit number, including the area code.  Can be a String or Fixnum.
+    Mblox::Sms.new(phone_number, "your message").send
+
+## Testing
+
+Copy config.yml.example to config.yml and set all the values in that file.  Run:
+
+    rspec
+
+You should recieve 2 SMS messages to your phone within several seconds.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/STDOUT

@@ -0,0 +1 @@
+# Logfile created on 2013-05-01 15:05:03 -0400 by logger.rb/31641

data/config.yml.example

@@ -0,0 +1,8 @@
+outbound_url: http://xml2.us.mblox.com:8180/send
+profile_id: "A five digit number"
+sender_id: "A five digit number that SMS messages are sent from"
+password: "Your password"
+partner_name: "Abbreviation of your company name, assigned by Mblox"
+tariff: 0
+service_id: "A five digit number"
+test_number: "A phone number that you want to send SMS messages to when testing"

data/lib/mblox.rb

@@ -0,0 +1,12 @@
+require "mblox/configuration"
+require "mblox/sms"
+require "mblox/sms_error"
+require "mblox/version"
+
+module Mblox
+  class << self
+    def log *args
+      self.config.logger.__send__(self.config.log_level, *args) if self.config.logger
+    end
+  end
+end

data/lib/mblox/configuration.rb

@@ -0,0 +1,33 @@
+module Mblox
+  class << self
+    def config
+      @config ||= Configuration.new
+    end
+  end
+
+  def self.configure
+    yield self.config
+  end
+
+  class Configuration
+    attr_accessor :outbound_url, :profile_id, :sender_id, :password, :partner_name, :tariff, :service_id
+    attr_reader :logger, :log_level
+    def initialize
+      @logger = Rails.logger if defined?(::Rails)
+      @log_level = :debug
+    end
+
+    def log_at level
+      validate @logger, level
+      @log_level = level
+    end
+    def logger= logger
+      validate logger, @log_level
+      @logger = logger
+    end
+    private
+      def validate logger, level
+	raise ArgumentError, "Mblox log level must be set to :fatal, :error, :warn, :info or :debug" if (logger && !logger.respond_to?(level))
+      end
+  end
+end

data/lib/mblox/sms.rb

@@ -0,0 +1,65 @@
+require 'active_support/core_ext/hash'
+require 'addressable/uri'
+require 'builder'
+require "net/https"
+
+module Mblox
+  class Sms
+    attr_reader :phone, :message
+    def initialize(phone,message)
+      phone = phone.to_s
+      raise SmsError, "Phone number must be ten digits" unless /\A[0-9]{10}\z/.match(phone)
+      raise SmsError, "Phone number cannot begin with 0 or 1" if ['0','1'].include?(phone[0].to_s)
+      raise SmsError, "Message cannot be blank" if message.empty?
+      @phone = "1#{phone}"
+      @message = message.dup
+    end
+
+    def send
+      commit build
+    end
+    private
+      def commit(request_body)
+	Mblox.log "Sending SMS to Mblox:\n#{request_body}"
+	uri = URI.parse(Mblox.config.outbound_url)
+	http = Net::HTTP.new(uri.host, uri.port)
+	request = Net::HTTP::Post.new(uri.request_uri)
+	request.body = request_body
+	request.content_type = 'text/xml'
+	response = http.start {|http| http.request(request) }
+	response = response.body
+	Mblox.log "Mblox responds with:\n#{response}"
+	build_response(Hash.from_xml(response))
+      end
+
+      def build_response(result)
+	result = result['NotificationRequestResult']
+	result_header = result['NotificationResultHeader']
+	subscriber_result = result['NotificationResultList']['NotificationResult']['SubscriberResult']
+	"RequestResult: \"#{result_header['RequestResultCode']}:#{result_header['RequestResultText']}\" / SubscriberResult: \"#{subscriber_result['SubscriberResultCode']}:#{subscriber_result['SubscriberResultText']}\""
+      end
+
+      def build
+	builder = Builder::XmlMarkup.new
+	builder.instruct!(:xml, :encoding => "ISO-8859-1")
+	builder.NotificationRequest(:Version => "3.5") do |nr|
+	  nr.NotificationHeader do |nh|
+	    nh.PartnerName(Mblox.config.partner_name)
+	    nh.PartnerPassword(Mblox.config.password)
+	  end
+	  nr.NotificationList(:BatchID => "1") do |nl|
+	    nl.Notification(:SequenceNumber => "1", :MessageType => "SMS") do |n|
+	      n.Message(@message)
+	      n.Profile(Mblox.config.profile_id)
+	      n.SenderID(Mblox.config.sender_id, :Type => 'Shortcode')
+	      n.Tariff(Mblox.config.tariff)
+	      n.Subscriber do |s|
+		s.SubscriberNumber(@phone)
+	      end
+	      n.ServiceId(Mblox.config.service_id)
+	    end
+	  end
+	end
+      end
+  end
+end

data/lib/mblox/sms_error.rb

@@ -0,0 +1,4 @@
+module Mblox
+  class SmsError < ArgumentError
+  end
+end

data/lib/mblox/version.rb

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

data/mblox.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mblox/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mblox"
+  spec.version       = Mblox::VERSION
+  spec.authors       = ["Isaac Betesh"]
+  spec.email         = ["iybetesh@gmail.com"]
+  spec.description   = "Send SMS messages"
+  spec.summary       = `cat README.md`
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  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.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'addressable'
+  spec.add_runtime_dependency 'builder'
+end

data/spec/log_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+require "logger"
+
+module Mblox
+  class << self
+    def reset_configuration
+      @config = Configuration.new
+    end
+  end
+end
+
+describe "logger" do
+  before(:each) do
+    Mblox.reset_configuration
+  end
+
+  after(:all) do
+    set_configuration
+  end
+
+  it "should allow log level info" do
+    Mblox.config.log_at :info
+    Mblox.config.logger = ::Logger.new('/dev/null')
+    expect { Mblox.log "Some info" }.to_not raise_error
+  end
+
+  it "should default to log level debug" do
+    expect(Mblox.config.log_level).to eq(:debug)
+    expect { Mblox.log "Some debug info" }.to_not raise_error
+  end
+
+  it "should not allow log level news when the logger is created after log level is set" do
+    Mblox.config.log_at :news
+    expect { Mblox.config.logger = ::Logger.new("STDOUT")}.to raise_error(ArgumentError, "Mblox log level must be set to :fatal, :error, :warn, :info or :debug")
+    expect { Mblox.log "Some news" }.to_not raise_error
+  end
+
+  it "should not allow log level news when the logger is created before log level is set and should remain in a valid state" do
+    Mblox.config.logger = ::Logger.new("/dev/null")
+    expect { Mblox.config.log_at :news }.to raise_error(ArgumentError, "Mblox log level must be set to :fatal, :error, :warn, :info or :debug")
+    expect { Mblox.log "Some news" }.to_not raise_error
+  end
+end

data/spec/sms_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+describe "phone number" do
+  it "should be 10 digits" do
+    expect { Mblox::Sms.new("2"*9, the_message) }.to raise_error(Mblox::SmsError, "Phone number must be ten digits")
+    expect { Mblox::Sms.new("2"*10, the_message) }.to_not raise_error
+    expect { Mblox::Sms.new("2"*11, the_message) }.to raise_error(Mblox::SmsError, "Phone number must be ten digits")
+  end
+
+  it "should not start with 0 or 1" do
+    expect { Mblox::Sms.new("1"+"2"*9, the_message) }.to raise_error(Mblox::SmsError, "Phone number cannot begin with 0 or 1")
+    expect { Mblox::Sms.new("0"+"2"*9, the_message) }.to raise_error(Mblox::SmsError, "Phone number cannot begin with 0 or 1")
+  end
+
+  it "should be safe from changing" do
+    number = TEST_NUMBER.to_s
+    mblox = Mblox::Sms.new(number,the_message)
+    number[1..3] = ''
+    expect(mblox.phone).to eq("1#{TEST_NUMBER}")
+  end
+end
+
+describe "message" do
+  it "cannot be blank" do
+    expect { Mblox::Sms.new("2"*10, "") }.to raise_error(Mblox::SmsError, "Message cannot be blank")
+  end
+
+  it "should be safe from changing" do
+    msg = the_message
+    mblox = Mblox::Sms.new(TEST_NUMBER,msg)
+    msg[1..3] = ''
+    expect(mblox.message).to eq(the_message)
+  end
+end
+
+describe "SMS messages" do
+  it "should be sent when the phone number is a Fixnum" do
+    expect(Mblox::Sms.new(TEST_NUMBER.to_i,the_message).send).to eq(result_ok)
+  end
+
+  it "should be sent when the phone number is a String" do
+    expect(Mblox::Sms.new(TEST_NUMBER.to_s,the_message).send).to eq(result_ok)
+  end
+
+  it "should fail when sent to a landline" do
+    expect(Mblox::Sms.new("6176354500",the_message).send).to eq(result_unroutable)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require "mblox"
+require "yaml"
+
+CONFIG = YAML::load(File.open('config.yml'))
+
+def set_configuration
+  Mblox.configure do |config|
+    config.outbound_url = CONFIG['outbound_url']
+    config.profile_id = CONFIG['profile_id']
+    config.sender_id = CONFIG['sender_id']
+    config.password = CONFIG['password']
+    config.partner_name = CONFIG['partner_name']
+    config.tariff = CONFIG['tariff']
+    config.service_id = CONFIG['service_id']
+  end
+end
+
+set_configuration
+
+TEST_NUMBER = CONFIG['test_number']
+
+def the_message
+  "Mblox gem test sent at #{Time.now}"
+end
+
+def result_ok
+  "RequestResult: \"0:OK\" / SubscriberResult: \"0:OK\""
+end
+
+def result_unroutable
+  "RequestResult: \"0:OK\" / SubscriberResult: \"10:MsipRejectCode=29 Number unroutable:2e Do not retry:2e\""
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: mblox
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Isaac Betesh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Send SMS messages
+email:
+- iybetesh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- STDOUT
+- config.yml.example
+- lib/mblox.rb
+- lib/mblox/configuration.rb
+- lib/mblox/sms.rb
+- lib/mblox/sms_error.rb
+- lib/mblox/version.rb
+- mblox.gemspec
+- spec/log_spec.rb
+- spec/sms_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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: ! '# Mblox  This gem is for subscribers to Mblox to send SMS messages.  ##
+  Installation  Add this line to your application''s Gemfile:  gem ''mblox''  And
+  then execute:  $ bundle  Or install it yourself as:  $ gem install mblox  ## Usage  Configuration  Mblox.configure
+  do |config| # Set all of these values, provided to you in your Mblox subscription
+  config.outbound_url = ... config.profile_id = ... config.sender_id = ... config.password
+  = ... config.partner_name = ... config.tariff = ... config.service_id = ...  # You
+  can also configure some logging options # In a Rails environment, config.logger
+  will default to Rails.logger and config.log_at will default to :debug # config.log_at
+  means the level at which Mblox will log. # If config.log_at == :debug and your logger''s
+  log level is :info, logging will be suppressed because it is below the log level
+  of the logger. config.logger = Logger.new(STDOUT) config.log_at :info end  Once
+  your application is configured, send messages:  phone_number = 2225555555 # The
+  number you''re sending to.  Must be a 10-digit number, including the area code.  Can
+  be a String or Fixnum. Mblox::Sms.new(phone_number, "your message").send  ## Testing  Copy
+  config.yml.example to config.yml and set all the values in that file.  Run:  rspec  You
+  should recieve 2 SMS messages to your phone within several seconds.  ## Contributing  1.
+  Fork it 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 new Pull Request'
+test_files:
+- spec/log_spec.rb
+- spec/sms_spec.rb
+- spec/spec_helper.rb