messagebird 0.1.1

data/lib/messagebird/http/sender.rb

@@ -0,0 +1,50 @@
+module MessageBird::HTTP
+  class Sender
+    class << self
+
+      attr_writer :response_factory
+
+      def deliver(sms, &block)
+        ensure_valid_sms!(sms)
+        send_sms(sms, &block)
+      end
+
+    private
+
+      def send_sms(sms, &block)
+        connection = create_connection(sms.uri)
+        request    = create_request(sms.request_uri)
+
+        response = send_request(connection, request)
+
+        if block_given?
+          yield response
+        end
+      end
+
+      def send_request(connection, request)
+        response_factory.call( connection.request(request) )
+      end
+
+      def create_connection(uri)
+        Net::HTTP.new(uri.host, uri.port).tap do |http|
+          http.use_ssl = true
+          # http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+      end
+
+      def create_request(request_uri)
+        Net::HTTP::Get.new(request_uri)
+      end
+
+      def ensure_valid_sms!(obj)
+        raise ArgumentError unless obj.is_a? MessageBird::HTTP::SMS
+      end
+
+      def response_factory
+        @response_factory ||= Response.public_method(:new)
+      end
+
+    end
+  end
+end

data/lib/messagebird/http/sms.rb

@@ -0,0 +1,77 @@
+module MessageBird::HTTP
+  class SMS < MessageBird::Deliverable
+    include MessageBird::Helpers
+
+    attr_reader :originator, :recipients, :message
+    attr_writer :username, :api_url
+
+    def initialize(originator, recipients, message, options = {}, &block)
+      @originator = originator
+      @recipients = format_recipients(recipients)
+      @message    = URI.escape(message)
+      @callback   = block
+
+      set_optional_variables(options)
+    end
+
+    def deliver
+      Sender.deliver(self, &@callback)
+    end
+
+    def uri
+      @uri ||= URI.parse(url)
+    end
+
+    def request_uri
+      uri.request_uri
+    end
+
+    def url
+      @url ||= "#{api_url}?username=#{username}&password=#{password}&sender=#{originator}&test=#{test_mode}&destination=#{recipients}&body=#{message}"
+    end
+
+    def username
+      @username ||= escape MessageBird::Config.username
+    end
+
+    def password
+      @password ||= escape MessageBird::Config.password
+    end
+
+    def test_mode
+      # If test = 1, then the message is not actually sent or scheduled, and there will be no credits deducted
+      @test_mode ||= MessageBird::Config.fetch(:test_mode, true) ? 1 : 0
+    end
+
+    def api_url
+      @api_url ||= MessageBird::Config.api_url
+    end
+
+  private
+
+    def format_recipients(recipients)
+      # API accepts multiple phone numbers by seperating them with a comma ','
+      if recipients.is_a? Enumerable
+        recipients.join(',')
+      else
+        "#{recipients}"
+      end
+    end
+
+    def set_optional_variables(options = {})
+      options.each do |k,v|
+        send("#{k}=".to_sym, v)
+      end
+    end
+
+    def password=(str)
+      @password = escape(str)
+    end
+
+    def test_mode=(bool)
+      raise ArgumentError unless !!bool == bool
+      @test_mode = bool ? 1 : 0
+    end
+
+  end
+end

data/lib/messagebird/sms.rb

@@ -0,0 +1,23 @@
+module MessageBird
+  class SMS
+    class << self
+      include Helpers
+
+      def deliver(originator, recipients, message, options={}, &block)
+        new(originator, recipients, message, options, &block).deliver
+      end
+
+      def new(originator, recipients, message, options={}, &block)
+        module_name = options.delete(:module) || config.module
+        klass_for(module_name).new(originator, recipients, message, options, &block)
+      end
+
+    private
+
+      def klass_for(module_name)
+        constantize("MessageBird::#{module_name.to_s.upcase}::SMS")
+      end
+
+    end
+  end
+end

data/messagebird.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: messagebird 0.1.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "messagebird"
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Bram de Vries"]
+  s.date = "2014-01-22"
+  s.description = "Implementation of the MessageBird text (sms) service API"
+  s.email = "bram.devries@nedap.com"
+  s.executables = ["messagebird_test_connection"]
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".travis.yml",
+    "Gemfile",
+    "LICENCE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bin/messagebird_test_connection",
+    "lib/messagebird.rb",
+    "lib/messagebird/config.rb",
+    "lib/messagebird/deliverable.rb",
+    "lib/messagebird/helpers.rb",
+    "lib/messagebird/http/response.rb",
+    "lib/messagebird/http/response_code.rb",
+    "lib/messagebird/http/sender.rb",
+    "lib/messagebird/http/sms.rb",
+    "lib/messagebird/sms.rb",
+    "messagebird.gemspec",
+    "test/helper.rb",
+    "test/messagebird/config_test.rb",
+    "test/messagebird/deliverable_test.rb",
+    "test/messagebird/helpers_test.rb",
+    "test/messagebird/http/response_code_test.rb",
+    "test/messagebird/http/response_test.rb",
+    "test/messagebird/http/sender_test.rb",
+    "test/messagebird/http/sms_test.rb",
+    "test/messagebird/sms_test.rb",
+    "test/messagebird_test.rb"
+  ]
+  s.homepage = "http://github.com/nedap/messagebird-sms-api-ruby"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.1.11"
+  s.summary = "MessageBird API for Ruby"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<jeweler>, ["~> 2.0.0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<jeweler>, ["~> 2.0.0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'bundler'
+
+# Use SimpleCov when available
+begin
+  require 'simplecov'
+  SimpleCov.start
+rescue LoadError
+end
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'minitest/autorun'
+require 'rr'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'messagebird'
+
+class MiniTest::Unit::TestCase
+end
+
+MiniTest.autorun

data/test/messagebird/config_test.rb

@@ -0,0 +1,99 @@
+# Based on https://github.com/jwkoelewijn/batsir/blob/master/spec/batsir/config_spec.rb
+require 'helper'
+
+describe MessageBird::Config do
+  let(:api_url_string){ 'https://api.messagebird.com/api/sms' }
+
+  describe "with respect to retrieving variables" do
+    it "can check if a key exists" do
+      MessageBird::Config.key?(:api_url).must_equal true
+      MessageBird::Config.key?(:non_existent).must_equal false
+    end
+
+    it "can use brackets" do
+      MessageBird::Config[:api_url].must_equal api_url_string
+    end
+
+    it "can use fetch method" do
+      MessageBird::Config.fetch(:api_url, nil).must_equal api_url_string
+    end
+
+    it "returns the default value when variable does not exist" do
+      MessageBird::Config.fetch(:non_existing_key, 'default').must_equal 'default'
+    end
+
+    it "can use a method with the variable's name" do
+      MessageBird::Config.test_mode.must_equal true
+    end
+
+    it "can use return the settings in a hash" do
+      MessageBird::Config[:dbase] = :test
+      hash = MessageBird::Config.to_hash
+      hash.keys.include?(:api_url).must_equal true
+      hash.keys.include?(:dbase).must_equal true
+      hash.values.include?(:test).must_equal true
+    end
+  end
+
+  describe "with respect to setting variables" do
+    it "can set a variable using brackets" do
+      MessageBird::Config[:testtest] = "testtest"
+      MessageBird::Config.testtest.must_equal "testtest"
+    end
+
+    it "can set a variable using a method with the variable's name" do
+      MessageBird::Config.testtest = "test1"
+      MessageBird::Config[:testtest].must_equal "test1"
+    end
+
+    describe "setting multiple variables at once" do
+      it "can use setup method" do
+        MessageBird::Config.setup({:test_var => "test1", :test_var2 => "test2"})
+        MessageBird::Config.test_var.must_equal "test1"
+        MessageBird::Config.test_var2.must_equal "test2"
+      end
+
+      it "merges given settings with default settings when using setup method" do
+        MessageBird::Config.setup({:test_var => "test1", :test_var2 => "test2"})
+        MessageBird::Config.api_url.must_equal api_url_string
+      end
+
+      describe "with block notation" do
+        it "uses yielding" do
+          MessageBird::Config.use do |config|
+            config[:tester1] = "test1"
+            config[:tester2] = "test2"
+          end
+          MessageBird::Config.api_url.must_equal api_url_string
+          MessageBird::Config.tester1.must_equal "test1"
+          MessageBird::Config.tester2.must_equal "test2"
+        end
+
+        it "uses a block" do
+          MessageBird::Config.configure do
+            tester3 "test3"
+            tester4 "test4"
+          end
+          MessageBird::Config.api_url.must_equal api_url_string
+          MessageBird::Config.tester3.must_equal "test3"
+          MessageBird::Config.tester4.must_equal "test4"
+        end
+      end
+    end
+  end
+
+  describe "with respect to deleting variables" do
+    it "deletes the given key" do
+      MessageBird::Config.api_url.nil?.must_equal false
+      MessageBird::Config.delete(:api_url)
+      MessageBird::Config.api_url.must_equal nil
+    end
+  end
+end
+
+describe MessageBird::Config, "with respect to resetting the configuration" do
+  it "resets properly" do
+    MessageBird::Config.reset
+    MessageBird::Config.to_hash.must_equal MessageBird::Config.defaults
+  end
+end

data/test/messagebird/deliverable_test.rb

@@ -0,0 +1,11 @@
+require 'helper'
+
+describe MessageBird::Deliverable do
+  subject{ MessageBird::Deliverable.new }
+
+  describe '#deliver' do
+    it 'raises an error' do
+      assert_raises( RuntimeError ){ subject.deliver }
+    end
+  end
+end

data/test/messagebird/helpers_test.rb

@@ -0,0 +1,39 @@
+require 'helper'
+
+class MockObject
+  include MessageBird::Helpers
+end
+
+describe MessageBird::Helpers do
+
+  subject{ MockObject.new }
+
+  describe '#config' do
+    it 'returns the appropriate config object' do
+      subject.config.must_equal MessageBird::Config
+    end
+  end
+
+  describe '#contantize' do
+    it 'converts a string into its corresponding constant' do
+      subject.constantize('String').must_equal String
+      subject.constantize('Integer').must_equal Integer
+      subject.constantize('MessageBird::Helpers').must_equal MessageBird::Helpers
+    end
+
+    it 'raises a NameError when class is not found' do
+      assert_raises(NameError) { subject.constantize('NonExistentClass') }
+    end
+
+    it 'raises a NameError when string not a valid class name' do
+      assert_raises(NameError) { subject.constantize(':::String') }
+    end
+  end
+
+  describe '#escape' do
+    it 'URI escapes the given string' do
+      mock(URI).escape("teststring")
+      subject.escape "teststring"
+    end
+  end
+end

data/test/messagebird/http/response_code_test.rb

@@ -0,0 +1,49 @@
+require 'helper'
+
+describe MessageBird::HTTP::ResponseCode do
+
+  let(:klass){ MessageBird::HTTP::ResponseCode}
+
+  subject{ klass.new(:foo, 'bar') }
+
+  describe '#to_sym' do
+    it 'returns its symbol value' do
+      subject.to_sym.must_equal :foo
+    end
+  end
+
+  describe '#to_s' do
+    it 'returns its string value' do
+      subject.to_s.must_equal 'bar'
+    end
+  end
+
+  describe '#==' do
+    it 'compares Symbols with its symbol value' do
+      mock.proxy(subject).to_sym.times(2)
+      assert subject == :foo
+      refute subject == :bar
+    end
+
+    it 'compares other objects with its string value' do
+      mock.proxy(subject).to_s.times(2)
+      assert subject == 'bar'
+      refute subject == 'foo'
+    end
+  end
+
+  describe '#self.decode' do
+    it 'returns the matching ResponseCode' do
+      result = klass.decode("01")
+      assert result.is_a?(klass)
+      assert result == :success
+    end
+
+    it 'raises an error when not found' do
+      assert_raises(MessageBird::HTTP::ResponseCode::ResponseCodeNotFound){
+        klass.decode("We are the Borg")
+      }
+    end
+  end
+
+end