mollie-sms 0.1.0 → 0.2.0

data/Rakefile

@@ -0,0 +1,24 @@
+desc "Run the specs"
+task :spec do
+  sh "ruby ./spec/sms_spec.rb"
+  sh "ruby ./spec/test_helper_spec.rb"
+  sh "ruby ./spec/functional_sms_deliver_spec.rb"
+end
+
+task :default => :spec
+
+begin
+  require 'rubygems'
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name     = "mollie-sms"
+    s.homepage = "http://github.com/Fingertips/Mollie-SMS"
+    s.email    = ["eloy@fngtps.com"]
+    s.authors  = ["Eloy Duran"]
+    s.summary  = s.description = "Send SMS text messages via the Mollie.nl SMS gateway."
+    s.files   -= %w{ .gitignore TODO }
+    s.extra_rdoc_files -= %w{ TODO }
+    s.add_dependency('activesupport', '>= 2.3.8')
+  end
+rescue LoadError
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/mollie/sms.rb

@@ -23,6 +23,18 @@ module Mollie
     class ValidationError      < StandardError; end
     class MissingRequiredParam < StandardError; end
 
+    class DeliveryFailure < StandardError
+      attr_reader :sms, :response
+
+      def initialize(sms, response)
+        @sms, @response = sms, response
+      end
+
+      def message
+        "(#{@response.message}) #{@sms.to_s}"
+      end
+    end
+
     REQUIRED_PARAMS = %w{ username md5_password originator gateway charset type recipients message }
 
     class << self
@@ -72,8 +84,16 @@ module Mollie
       @params['message'] = body
     end
 
+    def ==(other)
+      other.is_a?(SMS) && other.params == params
+    end
+
+    def to_s
+      %{from: <#{params['originator']}> to: <#{telephone_number}> body: "#{body}"}
+    end
+
     def inspect
-      "#<#{self.class.name} from: <#{@params['originator']}> to: <#{telephone_number}> body: \"#{body}\" >"
+      %{#<#{self.class.name} #{to_s}>}
     end
 
     def deliver
@@ -89,6 +109,12 @@ module Mollie
       end
     end
 
+    def deliver!
+      response = deliver
+      raise DeliveryFailure.new(self, response) unless response.success?
+      response
+    end
+
     def validate_params!
       params.slice(*REQUIRED_PARAMS).each do |key, value|
         raise MissingRequiredParam, "The required parameter `#{key}' is missing." if value.blank?

data/lib/mollie/sms/test_helper.rb

@@ -0,0 +1,76 @@
+module Mollie
+  class SMS
+    def self.deliveries
+      @deliveries ||= []
+    end
+
+    def self.reset!
+      @deliveries = []
+      success!
+    end
+
+    def self.success!
+      http_response = Net::HTTPOK.new('1.1', '200', 'OK')
+      http_response.add_field('Content-type', 'application/xml')
+      def http_response.read_body; TestHelper::SUCCESS_BODY; end
+      @stubbed_response = Mollie::SMS::Response.new(http_response)
+    end
+
+    def self.gateway_failure!
+      http_response = Net::HTTPOK.new('1.1', '200', 'OK')
+      http_response.add_field('Content-type', 'application/xml')
+      def http_response.read_body; TestHelper::FAILURE_BODY; end
+      @stubbed_response = Mollie::SMS::Response.new(http_response)
+    end
+
+    def self.http_failure!
+      @stubbed_response = Mollie::SMS::Response.new(Net::HTTPBadRequest.new('1.1', '400', 'Bad request'))
+    end
+
+    def self.stubbed_response
+      @stubbed_response || success!
+    end
+
+    def deliver
+      validate_params!
+      self.class.deliveries << self
+      self.class.stubbed_response
+    end
+
+    module TestHelper
+        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>}
+
+      def assert_sms_messages(number_of_messages)
+        before = Mollie::SMS.deliveries.length
+        yield
+        diff = Mollie::SMS.deliveries.length - before
+        assert(diff == number_of_messages, "expected `#{number_of_messages}' SMS messages to be sent, actually sent `#{diff}'")
+      end
+
+      def assert_no_sms_messages
+        assert_sms_messages(0) { yield }
+      end
+    end
+  end
+end
+

data/mollie-sms.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mollie-sms}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Eloy Duran"]
+  s.date = %q{2010-08-03}
+  s.description = %q{Send SMS text messages via the Mollie.nl SMS gateway.}
+  s.email = ["eloy@fngtps.com"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README"
+  ]
+  s.files = [
+    "LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "lib/mollie/sms.rb",
+     "lib/mollie/sms/test_helper.rb",
+     "mollie-sms.gemspec",
+     "spec/functional_sms_deliver_spec.rb",
+     "spec/sms_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/test_helper_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/Fingertips/Mollie-SMS}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Send SMS text messages via the Mollie.nl SMS gateway.}
+  s.test_files = [
+    "spec/functional_sms_deliver_spec.rb",
+     "spec/sms_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/test_helper_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.8"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 2.3.8"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 2.3.8"])
+  end
+end
+

data/spec/functional_sms_deliver_spec.rb

@@ -0,0 +1,71 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+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
+
+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>}
+
+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

data/spec/sms_spec.rb

@@ -1,9 +1,5 @@
 require File.expand_path("../spec_helper", __FILE__)
-require "mollie/sms"
-
-Mollie::SMS.username = 'AstroRadio'
-Mollie::SMS.password = 'secret'
-Mollie::SMS.originator = 'Astro INC'
+require "mollie/sms/test_helper"
 
 describe "Mollie::SMS" do
   it "holds the gateway uri" do
@@ -89,6 +85,16 @@ describe "A Mollie::SMS instance" do
     )
     @sms.params.should == params
   end
+
+  it "checks equality by comparing the params" do
+    @sms.should == Mollie::SMS.new('+31612345678', "The stars tell me you will have chicken noodle soup for breakfast.")
+    @sms.should.not == Mollie::SMS.new('+31612345678', "Different message")
+    @sms.should.not == Mollie::SMS.new('+31612345678', "The stars tell me you will have chicken noodle soup for breakfast.", 'originator' => 'Some being')
+  end
+
+  it "returns a string representation of itself" do
+    @sms.to_s.should == 'from: <Astro INC> to: <+31612345678> body: "The stars tell me you will have chicken noodle soup for breakfast."'
+  end
 end
 
 describe "When sending a Mollie::SMS message" do
@@ -98,46 +104,30 @@ describe "When sending a Mollie::SMS message" do
     @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
+  it "raises a Mollie::SMS::DeliveryFailure exception when sending, through the #deliver! method, fails" do
+    Mollie::SMS.gateway_failure!
 
-    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
+    exception = nil
+    begin
+      @sms.deliver!
+    rescue Mollie::SMS::DeliveryFailure => exception
+    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
+    exception.message.should == "(No username given.) #{@sms.to_s}"
   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)
+    @response = Mollie::SMS.success!
   end
 
   it "returns the Net::HTTP response object" do
-    @response.http_response.should == @http_response
+    @response.http_response.should.is_a?(Net::HTTPSuccess)
   end
 
   it "returns the response body as a hash" do
-    @response.params.should == Hash.from_xml(SUCCESS_BODY)['response']['item']
+    @response.params.should == Hash.from_xml(Mollie::SMS::TestHelper::SUCCESS_BODY)['response']['item']
   end
 
   it "returns whether or not it was a success" do
@@ -158,10 +148,7 @@ 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)
+    @response = Mollie::SMS.gateway_failure!
   end
 
   it "returns that the request was not a success" do
@@ -183,8 +170,7 @@ 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)
+    @response = Mollie::SMS.http_failure!
   end
 
   it "returns an empty hash as the params" do

data/spec/spec_helper.rb

@@ -2,57 +2,11 @@ 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>}
+$:.unshift File.expand_path("../../lib", __FILE__)
+require "mollie/sms"
 
-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>}
+Mollie::SMS.username = 'AstroRadio'
+Mollie::SMS.password = 'secret'
+Mollie::SMS.originator = 'Astro INC'

data/spec/test_helper_spec.rb

@@ -0,0 +1,81 @@
+require File.expand_path("../spec_helper", __FILE__)
+require "mollie/sms/test_helper"
+
+describe "Mollie::SMS ext" do
+  before do
+    Mollie::SMS.reset!
+    @sms = Mollie::SMS.new("+31612345678", "Future is coming.")
+  end
+
+  it "stubs any next delivery to be successful" do
+    Mollie::SMS.success!
+    @sms.deliver.should.be.success
+  end
+
+  it "stubs any next delivery to fail at the gateway" do
+    Mollie::SMS.gateway_failure!
+    response = @sms.deliver
+    response.should.not.be.success
+    response.should.not.be.http_failure
+  end
+
+  it "stubs any next delivery to fail at HTTP level" do
+    Mollie::SMS.http_failure!
+    response = @sms.deliver
+    response.should.not.be.success
+    response.should.be.http_failure
+  end
+
+  it "returns the stubbed response" do
+    @sms.deliver.should == Mollie::SMS.stubbed_response
+    @sms.deliver!.should == Mollie::SMS.stubbed_response
+  end
+
+  it "adds sms instance to a global array instead of actually delivering" do
+    @sms.deliver
+    @sms.deliver!
+    Mollie::SMS.deliveries.last(2).should == [@sms, @sms]
+  end
+
+  it "empties the deliveries array and stubs a succeeded response" do
+    @sms.deliver!
+    Mollie::SMS.reset!
+    Mollie::SMS.deliveries.should.be.empty
+  end
+end
+
+describe "Mollie::SMS::TestHelper" do
+  extend Mollie::SMS::TestHelper
+
+  before do
+    Mollie::SMS.reset!
+    @sms = Mollie::SMS.new("+31612345678", "Future is coming.")
+    @result = @message = nil
+  end
+
+  def assert(result, message)
+    @result, @message = result, message
+  end
+
+  it "asserts that an email is sent while executing the block" do
+    assert_sms_messages(2) { @sms.deliver; @sms.deliver }
+    @result.should == true
+  end
+
+  it "fails if not the given amount of messages are sent" do
+    assert_sms_messages(2) { @sms.deliver }
+    @result.should == false
+    @message.should == "expected `2' SMS messages to be sent, actually sent `1'"
+  end
+
+  it "asserts that no emails were sent while executing the block" do
+    assert_no_sms_messages { }
+    @result.should == true
+  end
+
+  it "fails if messages are actually sent" do
+    assert_no_sms_messages { @sms.deliver }
+    @result.should == false
+    @message.should == "expected `0' SMS messages to be sent, actually sent `1'"
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mollie-sms
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Eloy Duran
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-02 00:00:00 +02:00
+date: 2010-08-03 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,9 +47,15 @@ extra_rdoc_files:
 files: 
 - LICENSE
 - README
+- Rakefile
+- VERSION
 - lib/mollie/sms.rb
+- lib/mollie/sms/test_helper.rb
+- mollie-sms.gemspec
+- spec/functional_sms_deliver_spec.rb
 - spec/sms_spec.rb
 - spec/spec_helper.rb
+- spec/test_helper_spec.rb
 has_rdoc: true
 homepage: http://github.com/Fingertips/Mollie-SMS
 licenses: []
@@ -85,5 +91,7 @@ signing_key:
 specification_version: 3
 summary: Send SMS text messages via the Mollie.nl SMS gateway.
 test_files: 
+- spec/functional_sms_deliver_spec.rb
 - spec/sms_spec.rb
 - spec/spec_helper.rb
+- spec/test_helper_spec.rb