sently-sms 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Moonshado, 2012 Jerome Lacoste
+
+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.rdoc

@@ -0,0 +1,24 @@
+= sently-sms
+
+Sent.ly SMS Gem
+
+Heavily inspired by the Moonshado SMS Gem (http://rubygems.org/gems/moonshado-sms) in order to keep a relatively compatible API.
+
+== Usage
+
+Put this in Development and Test environment so no real SMS are sent out:
+  Sently::Sms.config = {
+    :test_env => true,
+    :username => nil,
+    :password => nil
+  }
+
+Production environment config:
+  Sently::Sms.config = {
+    :username => ENV['SENTLY_USER'],
+    :password => ENV['SENTLY_PASS']
+  }
+
+== Copyright
+
+Copyright (c) 2010 Moonshado, 2012 Jerome Lacoste, Inc. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  gem.name = "sently-sms"
+  gem.summary = "Sent.ly SMS gem"
+  gem.description ="Allow to send SMSes using the sent.ly service"
+  #gem.rubyforce_project ="N/A"
+  gem.email = "jerome.lacoste@gmail.com"
+  gem.homepage = "http://github.com/lacostej/sently-sms"
+  gem.authors = ["Jerome Lacoste"]
+  gem.add_development_dependency "shoulda", ">= 0"
+  gem.add_development_dependency "mocha", ">= 0"
+  gem.add_runtime_dependency "rest-client", ">= 1.6.0"
+  # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+end
+Jeweler::GemcutterTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "sently-sms #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:build: 
+:patch: 0
+:major: 0
+:minor: 1

data/bin/sently

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+#
+# a small program to send SMS from the command line using sently
+#
+
+if ARGV.length != 2
+	puts "USAGE: sently.rb \"1(555)1233\" \"the message\""
+	exit
+end
+
+require 'rubygems'
+require 'sently-sms'
+require 'parseconfig'
+
+email_config = ParseConfig.new(ENV['HOME']+'/.sently').params
+username = email_config['username']
+password = email_config['password']
+
+Sently::Sms.configure do |config|
+	config.username = username
+    config.password = password
+end
+
+p Sently::Sms.new(ARGV[0], ARGV[1]).deliver_sms

data/lib/sently-sms.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'rest_client'
+require 'sently/configuration'
+require 'sently/sms'
+require 'sently/sender'
+
+module Sently
+  
+end

data/lib/sently/configuration.rb

@@ -0,0 +1,66 @@
+module Sently
+  class Configuration
+
+    OPTIONS = [:username, :password,
+               :http_open_timeout, :http_read_timeout,
+               :protocol, :host, :port, :secure,
+               :production_environment].freeze
+
+    attr_accessor :username
+    attr_accessor :password
+    attr_accessor :sms_uri
+    attr_accessor :secure
+    attr_accessor :http_open_timeout
+    attr_accessor :http_read_timeout
+    attr_accessor :host
+    attr_accessor :port
+    attr_accessor :production_environment
+
+    alias_method :secure?, :secure
+
+    def initialize
+      @secure                   = false
+      @host                     = 'sent.ly'
+      @http_open_timeout        = 10
+      @http_read_timeout        = 10
+      @production_environment   = true
+      @sms_uri                  = '/command/sendsms'
+      @port                     = default_port
+    end
+
+    def [](option)
+      send(option)
+    end
+
+    def to_hash
+      OPTIONS.inject({}) do |hash, option|
+        hash.merge(option.to_sym => send(option))
+      end
+    end
+
+    def merge(hash)
+      to_hash.merge(hash)
+    end
+
+    def port
+      @port || default_port
+    end
+
+    def protocol
+      if secure?
+        'https'
+      else
+        'http'
+      end
+    end
+
+    private
+      def default_port
+        if secure?
+          443
+        else
+          80
+        end
+      end
+  end
+end

data/lib/sently/sender.rb

@@ -0,0 +1,48 @@
+module Sently
+  class Sender
+    attr_reader :host, :port, :secure, :http_open_timeout, :http_read_timeout, :protocol, :username, :password
+
+    def initialize(options = {})
+      [:protocol, :host, :port, :secure, :http_open_timeout, :http_read_timeout, :username, :password].each do |option|
+        instance_variable_set("@#{option}", options[option])
+      end
+    end
+
+    #def post(data, uri)
+    #  http  = RestClient::Resource.new(
+    #            url(uri),
+    #            :username => username,
+    #            :timeout => http_read_timeout,
+    #            :open_timeout => http_open_timeout
+    #          )
+
+    #  response = http.post(data)
+    #end
+
+    def get(uri, additional_headers = {})
+      http  = RestClient::Resource.new(
+                url(uri),
+                :timeout => http_read_timeout,
+                :open_timeout => http_open_timeout
+              )
+      headers = { :username => username, :password => password }
+
+      p = { :params => headers.merge(additional_headers) }
+
+      response = http.get p
+    end
+
+    private
+      def url(uri = "")
+        URI.parse("#{protocol}://#{host}:#{port}").merge(uri).to_s
+      end
+
+      def configuration
+        Sently::Sms.configuration
+      end
+
+      def production_environment?
+        configuration.production_environment
+      end
+  end
+end

data/lib/sently/sms.rb

@@ -0,0 +1,98 @@
+module Sently
+  class Sms
+    attr_accessor :number, :message, :hid
+
+    class << self
+      attr_accessor :configuration
+      attr_accessor :sender
+
+      def configure
+        self.configuration ||= Configuration.new
+        yield(configuration)
+        self.sender = Sender.new(configuration)
+      end
+
+      #def find(id)
+      #  response = sender.get(configuration.sms_uri + "/#{id}")
+
+      #  JSON.parse(response.to_s)
+      #end
+    end
+
+    def initialize(number = "", message = "", hid = "")
+      @number = number
+      @message = message
+      @hid = hid
+    end
+
+    def deliver_sms
+      #raise SentlySMSException.new("Invalid message") unless is_message_valid?(@message)
+
+      params = { :text => @message.to_s, :to => format_number(@number), :hid => @hid }
+
+      if production_environment?
+        begin
+          response = sender.get(configuration.sms_uri, params)
+        rescue Exception => e
+          response = RestClient::Response.create("Error:#{e.message}", "", {})
+        end
+      else
+        response = RestClient::Response.create('Id:12345', "", {})
+      end
+
+      parse(response.to_s)
+    rescue SentlySMSException => exception
+      raise exception
+    end
+
+    def format_number(number)
+      formatted = number.scan(/\d+/i).join
+      return is_number_valid?(formatted) ? formatted : (raise SentlySMSException.new("Phone number (#{number}) is not formatted correctly"))
+    end
+
+    def is_number_valid?(number)
+      number.length >= 4 && number[/^.\d+$/]
+    end
+
+    #def is_message_valid?(message)
+    #  if message_length_check?
+    #    message_length_range.include?(message.to_s.size)
+    #  else
+    #    true
+    #  end
+    #end
+
+    class SentlySMSException < StandardError; end
+
+    private
+      def sender
+        Sently::Sms.sender
+      end
+
+      def configuration
+        Sently::Sms.configuration
+      end
+
+      def production_environment?
+        configuration.production_environment
+      end
+
+      def parse(str)
+        r = {'id' => -1, 'error' => ''}
+        begin
+          a = str.split(':')
+          case a[0]
+          when 'Id'
+            r['id'] = a[1].to_i
+          when 'Error'
+            r['error'] = a[1]
+          else
+            r['error'] = "Error parsing: '#{str}'"
+          end
+          r
+        rescue Exception => e
+          {"id"=>-1, "error"=>"json parser error", "response"=>json.to_s}
+        end
+      end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+# require 'webmock/test_unit'
+begin require 'redgreen'; rescue LoadError; end
+begin require 'turn'; rescue LoadError; end
+
+require 'sently-sms'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+class Test::Unit::TestCase
+  # include WebMock
+end

data/test/sms_test.rb

@@ -0,0 +1,82 @@
+require 'helper'
+
+class Sently::SmsTest < Test::Unit::TestCase
+  context Sently::Sms do
+    setup do
+      Sently::Sms.configuration = nil
+      Sently::Sms.configure do |config|
+        config.username = 'test@sent.ly'
+        config.password = '$ecret'
+        config.production_environment = false
+      end
+    end
+
+    should "format number with dashs" do
+      sms = Sently::Sms.new("1-555-5556471", "test")
+      assert_equal(sms.format_number("1-555-5556471"), "15555556471")
+    end
+
+    should "format number with brackets" do
+      sms = Sently::Sms.new("1(555)5556471", "test")
+      assert_equal(sms.format_number("1-555-5556471"), "15555556471")
+    end
+
+    should "format number with brackets and dashs" do
+      sms = Sently::Sms.new("1(555)555-6471", "test")
+      assert_equal(sms.format_number("1-555-5556471"), "15555556471")
+    end
+
+    should "accept recipient with at least 4 characters" do
+      sms = Sently::Sms.new("0123", "test")
+      assert_equal(sms.format_number("0123"), "0123")
+    end
+
+    should "reject recipient with less than 4 characters" do
+      sms = Sently::Sms.new("123", "test")
+      assert_raise(Sently::Sms::SentlySMSException) do
+        sms.format_number("123")
+      end
+    end
+
+    should "raise on invalidate message length" do
+      sms = Sently::Sms.new("123", "Well, if you like burgers give 'em a try sometime. I can't usually get 'em myself because my girlfriend's a vegitarian which pretty much makes me a vegitarian. But I do love the taste of a good burger. Mm-mm-mm. You know what they call a Quarter Pounder with cheese in France?")
+
+      assert_raise(Sently::Sms::SentlySMSException) do
+        sms.deliver_sms
+      end
+    end
+
+    should "not production submit sms" do
+      sms = Sently::Sms.new("40867729", "test")
+      assert_equal(sms.deliver_sms, {"id"=>12345, "error" => ""})
+    end
+
+    should "handle bad response" do
+      sms = Sently::Sms.new
+      r = sms.send(:parse, "x")
+      assert_equal(r, {'id' => -1, 'error' => 'Error parsing: \'x\''})
+    end
+
+    #should "process find" do
+    #  Sently::Sender.any_instance.stubs(:get).returns('{"credit":5000,"id":"123456","reports":"[]","stat":"ok"}')
+
+    #  assert_equal(Sently::Sms.find('123456'), {"id"=>"123456", "credit"=>5000, "stat"=>"ok", "reports"=>"[]"})
+    #end
+  end
+
+  context Sently::Sms do
+    setup do
+      Sently::Sms.configuration = nil
+      Sently::Sms.configure do |config|
+        config.username = 'test@sent.ly'
+        config.password = '$ecret'
+        config.host = 'notrealxxx1234sently.com'
+      end
+    end
+
+    should "return DNS error" do
+      assert_equal(Sently::Sms.new("1(555)555-6471", "test").deliver_sms["error"], "getaddrinfo")
+    end
+  end
+
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: sently-sms
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jerome Lacoste
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-15 00:00:00 +02:00
+default_executable: sently
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  type: :runtime
+  version_requirements: *id003
+description: Allow to send SMSes using the sent.ly service
+email: jerome.lacoste@gmail.com
+executables: 
+- sently
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- bin/sently
+- lib/sently-sms.rb
+- lib/sently/configuration.rb
+- lib/sently/sender.rb
+- lib/sently/sms.rb
+- test/helper.rb
+- test/sms_test.rb
+has_rdoc: true
+homepage: http://github.com/lacostej/sently-sms
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Sent.ly SMS gem
+test_files: []
+