mollie-sms 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Eloy Duran, Fingertips <eloy@fngtps.com>
+
+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

@@ -0,0 +1,7 @@
+A Ruby client that allows you to send SMS messages via http://mollie.nl.
+
+It does only what we need, for our app, at this point in time. Which means that
+connects to the webservice via SSL, and only sends a message to one recipient
+at a time.
+
+Patches are accepted.

data/lib/mollie/sms.rb

@@ -0,0 +1,139 @@
+require "digest/md5"
+require "uri"
+require "net/https"
+
+begin
+  require "rubygems"
+rescue LoadError
+end
+require "active_support"
+
+module Mollie
+  class SMS
+    GATEWAY_URI = URI.parse("https://secure.mollie.nl/xml/sms")
+
+    GATEWAYS = {
+      'basic'     => '2',
+      'business'  => '4',
+      'business+' => '1',
+      'landline'  => '8'
+    }
+
+    class StandardError        < ::StandardError; end
+    class ValidationError      < StandardError; end
+    class MissingRequiredParam < StandardError; end
+
+    REQUIRED_PARAMS = %w{ username md5_password originator gateway charset type recipients message }
+
+    class << self
+      attr_accessor :username, :password, :originator, :charset, :type, :gateway
+
+      def password=(password)
+        @password = Digest::MD5.hexdigest(password)
+      end
+
+      def default_params
+        {
+          'username'     => @username,
+          'md5_password' => @password,
+          'originator'   => @originator,
+          'gateway'      => @gateway,
+          'charset'      => @charset,
+          'type'         => @type
+        }
+      end
+    end
+
+    self.charset = 'UTF-8'
+    self.type    = 'normal'
+    self.gateway = GATEWAYS['basic']
+
+    attr_reader :params
+
+    def initialize(telephone_number = nil, body = nil, extra_params = {})
+      @params = self.class.default_params.merge(extra_params)
+      self.telephone_number = telephone_number if telephone_number
+      self.body = body if body
+    end
+
+    def telephone_number
+      @params['recipients']
+    end
+
+    def telephone_number=(telephone_number)
+      @params['recipients'] = telephone_number
+    end
+
+    def body
+      @params['message']
+    end
+
+    def body=(body)
+      @params['message'] = body
+    end
+
+    def inspect
+      "#<#{self.class.name} from: <#{@params['originator']}> to: <#{telephone_number}> body: \"#{body}\" >"
+    end
+
+    def deliver
+      validate_params!
+
+      post = Net::HTTP::Post.new(GATEWAY_URI.path)
+      post.form_data = params
+      request = Net::HTTP.new(GATEWAY_URI.host, GATEWAY_URI.port)
+      request.use_ssl = true
+      request.start do |http|
+        response = http.request(post)
+        Response.new(response)
+      end
+    end
+
+    def validate_params!
+      params.slice(*REQUIRED_PARAMS).each do |key, value|
+        raise MissingRequiredParam, "The required parameter `#{key}' is missing." if value.blank?
+      end
+
+      originator = params['originator']
+      if originator =~ /^\d+$/
+        if originator.size > 14
+          raise ValidationError, "Originator may have a maximimun of 14 numerical characters."
+        end
+      elsif originator.size > 11
+        raise ValidationError, "Originator may have a maximimun of 11 alphanumerical characters."
+      end
+    end
+
+    class Response
+      attr_reader :http_response
+
+      def initialize(http_response)
+        @http_response = http_response
+      end
+
+      def params
+        @params ||= http_failure? ? {} : Hash.from_xml(@http_response.read_body)['response']['item']
+      end
+
+      def result_code
+        (http_failure? ? @http_response.code : params['resultcode']).to_i
+      end
+
+      def message
+        http_failure? ? "[HTTP: #{@http_response.code}] #{@http_response.message}" : params['resultmessage']
+      end
+
+      def success?
+        !http_failure? && params['success'] == 'true'
+      end
+
+      def http_failure?
+        !@http_response.is_a?(Net::HTTPSuccess)
+      end
+
+      def inspect
+        "#<#{self.class.name} #{ success? ? 'succeeded' : 'failed' } (#{result_code}) `#{message}'>"
+      end
+    end
+  end
+end

data/spec/sms_spec.rb

@@ -0,0 +1,241 @@
+require File.expand_path("../spec_helper", __FILE__)
+require "mollie/sms"
+
+Mollie::SMS.username = 'AstroRadio'
+Mollie::SMS.password = 'secret'
+Mollie::SMS.originator = 'Astro INC'
+
+describe "Mollie::SMS" do
+  it "holds the gateway uri" do
+    Mollie::SMS::GATEWAY_URI.should == URI.parse("https://secure.mollie.nl/xml/sms")
+  end
+
+  it "holds the service username" do
+    Mollie::SMS.username.should == 'AstroRadio'
+  end
+
+  it "holds the service password as a MD5 hashed version" do
+    Mollie::SMS.password.should == Digest::MD5.hexdigest('secret')
+  end
+
+  it "holds the originator" do
+    Mollie::SMS.originator.should == 'Astro INC'
+  end
+
+  it "returns the default charset" do
+    Mollie::SMS.charset.should == 'UTF-8'
+  end
+
+  it "returns the default message type" do
+    Mollie::SMS.type.should == 'normal'
+  end
+
+  it "holds a list of available gateways" do
+    Mollie::SMS::GATEWAYS['basic'].should == '2'
+    Mollie::SMS::GATEWAYS['business'].should == '4'
+    Mollie::SMS::GATEWAYS['business+'].should == '1'
+    Mollie::SMS::GATEWAYS['landline'].should == '8'
+  end
+
+  it "returns the default gateway to use" do
+    Mollie::SMS.gateway.should == Mollie::SMS::GATEWAYS['basic']
+  end
+
+  it "returns a hash of default params for a request" do
+    Mollie::SMS.default_params.should == {
+      'username'     => 'AstroRadio',
+      'md5_password' => Digest::MD5.hexdigest('secret'),
+      'originator'   => 'Astro INC',
+      'gateway'      => '2',
+      'charset'      => 'UTF-8',
+      'type'         => 'normal'
+    }
+  end
+
+  it "initializes, optionally, with a telephone number, body, and params" do
+    sms1 = Mollie::SMS.new
+    sms1.telephone_number = '+31612345678'
+    sms1.body = "The stars tell me you will have chicken noodle soup for breakfast."
+
+    sms2 = Mollie::SMS.new('+31612345678', "The stars tell me you will have chicken noodle soup for breakfast.", 'originator' => 'Eloy')
+    sms2.params['originator'].should == 'Eloy'
+
+    [sms1, sms2].each do |sms|
+      sms.telephone_number.should == '+31612345678'
+      sms.body.should == "The stars tell me you will have chicken noodle soup for breakfast."
+    end
+  end
+end
+
+describe "A Mollie::SMS instance" do
+  before do
+    @sms = Mollie::SMS.new
+    @sms.telephone_number = '+31612345678'
+    @sms.body = "The stars tell me you will have chicken noodle soup for breakfast."
+  end
+
+  it "returns the phone number" do
+    @sms.telephone_number.should == '+31612345678'
+  end
+
+  it "returns the message body" do
+    @sms.body.should == "The stars tell me you will have chicken noodle soup for breakfast."
+  end
+
+  it "returns the request params with all string keys and values" do
+    params = Mollie::SMS.default_params.merge(
+      'recipients' => '+31612345678',
+      'message'    => "The stars tell me you will have chicken noodle soup for breakfast."
+    )
+    @sms.params.should == params
+  end
+end
+
+describe "When sending a Mollie::SMS message" do
+  before do
+    @sms = Mollie::SMS.new
+    @sms.telephone_number = '+31612345678'
+    @sms.body = "The stars tell me you will have chicken noodle soup for breakfast."
+  end
+
+  after do
+    Net::HTTP.reset!
+  end
+
+  it "posts the post body to the gateway" do
+    @sms.stubs(:params).returns('a key' => 'a value')
+    @sms.stubs(:validate_params!)
+    @sms.deliver
+
+    request, post = Net::HTTP.posted
+    request.should.use_ssl
+    request.host.should == Mollie::SMS::GATEWAY_URI.host
+    request.port.should == Mollie::SMS::GATEWAY_URI.port
+    post.path.should == Mollie::SMS::GATEWAY_URI.path
+    post.body.should == "a%20key=a%20value"
+  end
+
+  it "returns a Mollie::SMS::Response object, with the Net::HTTP response" do
+    Net::HTTP.stubbed_response = Net::HTTPOK.new('1.1', '200', 'OK')
+    Net::HTTP.stubbed_response.stubs(:read_body).returns(SUCCESS_BODY)
+    response = @sms.deliver
+    response.should.be.instance_of Mollie::SMS::Response
+    response.http_response.should == Net::HTTP.stubbed_response
+  end
+end
+
+describe "A Mollie::SMS::Response instance, for a succeeded request" do
+  before do
+    @http_response = Net::HTTPOK.new('1.1', '200', 'OK')
+    @http_response.stubs(:read_body).returns(SUCCESS_BODY)
+    @http_response.add_field('Content-type', 'application/xml')
+    @response = Mollie::SMS::Response.new(@http_response)
+  end
+
+  it "returns the Net::HTTP response object" do
+    @response.http_response.should == @http_response
+  end
+
+  it "returns the response body as a hash" do
+    @response.params.should == Hash.from_xml(SUCCESS_BODY)['response']['item']
+  end
+
+  it "returns whether or not it was a success" do
+    @response.should.be.success
+
+    @response.stubs(:params).returns('success' => 'false')
+    @response.should.not.be.success
+  end
+
+  it "returns the result code" do
+    @response.result_code.should == 10
+  end
+
+  it "returns the message corresponding to the result code" do
+    @response.message.should == "Message successfully sent."
+  end
+end
+
+describe "A Mollie::SMS::Response instance, for a request that failed at the gateway" do
+  before do
+    @http_response = Net::HTTPOK.new('1.1', '200', 'OK')
+    @http_response.stubs(:read_body).returns(FAILURE_BODY)
+    @http_response.add_field('Content-type', 'application/xml')
+    @response = Mollie::SMS::Response.new(@http_response)
+  end
+
+  it "returns that the request was not a success" do
+    @response.should.not.be.success
+  end
+
+  it "returns that this is a *not* HTTP failure" do
+    @response.should.not.be.http_failure
+  end
+
+  it "returns the result_code" do
+    @response.result_code.should == 20
+  end
+
+  it "returns the message corresponding to the result code" do
+    @response.message.should == "No username given."
+  end
+end
+
+describe "A Mollie::SMS::Response instance, for a failed HTTP request" do
+  before do
+    @http_response = Net::HTTPBadRequest.new('1.1', '400', 'Bad request')
+    @response = Mollie::SMS::Response.new(@http_response)
+  end
+
+  it "returns an empty hash as the params" do
+    @response.params.should == {}
+  end
+
+  it "returns that the request was not a success" do
+    @response.should.not.be.success
+  end
+
+  it "returns that this is a HTTP failure" do
+    @response.should.be.http_failure
+  end
+
+  it "returns the HTTP response code as the result_code" do
+    @response.result_code.should == 400
+  end
+
+  it "returns the HTTP error message as the message" do
+    @response.message.should == "[HTTP: 400] Bad request"
+  end
+end
+
+describe "Mollie::SMS, concerning validation" do
+  before do
+    @sms = Mollie::SMS.new
+    @sms.telephone_number = '+31612345678'
+    @sms.body = "The stars tell me you will have chicken noodle soup for breakfast."
+  end
+
+  it "accepts an originator of upto 14 numbers" do
+    @sms.params['originator'] = "00000000001111"
+    lambda { @sms.deliver }.should.not.raise
+  end
+
+  it "does not accept an originator string with more than 14 numbers" do
+    @sms.params['originator'] = "000000000011112"
+    lambda do
+      @sms.deliver
+    end.should.raise(Mollie::SMS::ValidationError, "Originator may have a maximimun of 14 numerical characters.")
+  end
+
+  it "accepts an originator of upto 11 alphanumerical characters" do
+    @sms.params['originator'] = "0123456789A"
+    lambda { @sms.deliver }.should.not.raise
+  end
+
+  it "does not accept an originator string with more than 11 alphanumerical characters" do
+    @sms.params['originator'] = "0123456789AB"
+    lambda do
+      @sms.deliver
+    end.should.raise(Mollie::SMS::ValidationError, "Originator may have a maximimun of 11 alphanumerical characters.")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,58 @@
+require "rubygems"
+require "bacon"
+require "mocha"
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+Bacon.summary_on_exit
+
+module Net
+  class HTTP
+    class << self
+      attr_accessor :posted, :stubbed_response
+
+      def reset!
+        @posted = nil
+        @stubbed_response = nil
+      end
+    end
+
+    def host
+      @address
+    end
+
+    def start
+      yield self
+    end
+
+    def request(request)
+      self.class.posted = [self, request]
+      self.class.stubbed_response
+    end
+  end
+end
+
+class ResponseStub
+end
+
+SUCCESS_BODY = %{
+<?xml version="1.0" ?>
+<response>
+    <item type="sms">
+        <recipients>1</recipients>
+        <success>true</success>
+        <resultcode>10</resultcode>
+        <resultmessage>Message successfully sent.</resultmessage>
+    </item>
+</response>}
+
+FAILURE_BODY = %{
+<?xml version="1.0"?>
+<response>
+  <item type="sms">
+    <recipients>1</recipients>
+    <success>false</success>
+    <resultcode>20</resultcode>
+    <resultmessage>No username given.</resultmessage>
+  </item>
+</response>}

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: mollie-sms
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Eloy Duran
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-02 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 3
+        - 8
+        version: 2.3.8
+  type: :runtime
+  version_requirements: *id001
+description: Send SMS text messages via the Mollie.nl SMS gateway.
+email: 
+- eloy@fngtps.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+files: 
+- LICENSE
+- README
+- lib/mollie/sms.rb
+- spec/sms_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/Fingertips/Mollie-SMS
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Send SMS text messages via the Mollie.nl SMS gateway.
+test_files: 
+- spec/sms_spec.rb
+- spec/spec_helper.rb