messagebird 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60591298cdf44f6e11fcdf5028a36d63cc933e80
+  data.tar.gz: 3341e9e7f6b5187b2d427795b64b21cefb57d196
+SHA512:
+  metadata.gz: d79edff49e03728c97aa256fa623452d9ebeaed368a74cc11c0e28dc7de3fef9eceacd6e05cd9ca01b2d1cde34f9ac70d07c3ecd669c482d4b4643eda9ed6088
+  data.tar.gz: 8e9c3b9ca20e78a155480c756ce872ffdf8cc0c8071486c821ed892d6a25d35e6ae0d8df009aa0f9d7c81d80648b9904aacfa43cb982e08b3bb9cb0f20ec3b33

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+cache: bundler
+bundler_args: --without development
+
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: 2.1.0

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'bundler', '~> 1.0'
+  gem 'rake'
+  gem 'minitest', :require => false
+  gem 'rr',       :require => false
+end
+
+group :development do
+  gem 'jeweler', '~> 2.0.0',  :require => false
+  gem 'simplecov',            :require => false
+end

data/LICENCE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Nedap N.V., Bram de Vries
+
+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,25 @@
+[![Code Climate](https://codeclimate.com/github/nedap/messagebird.png)](https://codeclimate.com/github/nedap/messagebird)
+[![Build Status](https://travis-ci.org/nedap/messagebird.png?branch=master)](https://travis-ci.org/nedap/messagebird)
+
+# MessageBird API gem
+Implementation of the MessageBird text (sms) service API
+
+## Compatibility
+Development is focussed on MRI 1.9.3 and 2.0.0.
+
+Legacy support for MRI 1.8.7, and experimental support for MRI 2.1.0 and JRuby 1.7.x.
+
+## Contributing
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Credits
+Based on the API example on https://www.messagebird.com/nl/sms-api#ruby
+
+## Licence
+See the LICENCE file for licensing information.

data/Rakefile

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+
+# Bundler setup
+begin
+  Bundler.setup(:default, :test, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+# Optional Jeweler setup
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+    gem.name = "messagebird"
+    gem.homepage = "http://github.com/nedap/messagebird-sms-api-ruby"
+    gem.license = "MIT"
+    gem.summary = %Q{MessageBird API for Ruby}
+    gem.description = %Q{Implementation of the MessageBird text (sms) service API}
+    gem.email = "bram.devries@nedap.com"
+    gem.authors = ["Bram de Vries"]
+    # dependencies defined in Gemfile
+  end
+  Jeweler::RubygemsDotOrgTasks.new
+rescue LoadError
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/bin/messagebird_test_connection

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+# $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'pp'
+require 'messagebird'
+
+MessageBird.configure do
+  username    'nedappep'
+  password    'testpass'
+  sender_name 'NedapPep'
+end
+
+MessageBird.deliver("NedapPep", "31648951497", "test message") do |response|
+  pp response
+end

data/lib/messagebird.rb

@@ -0,0 +1,28 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'net/http'
+require 'net/https'
+require 'uri'
+
+require 'messagebird/config'
+require 'messagebird/deliverable'
+require 'messagebird/helpers'
+require 'messagebird/sms'
+require 'messagebird/http/sender'
+require 'messagebird/http/sms'
+require 'messagebird/http/response_code'
+require 'messagebird/http/response'
+
+module MessageBird
+  class << self
+
+    def deliver(originator, recipients, message, options={}, &block)
+      MessageBird::SMS.deliver(originator, recipients, message, options, &block)
+    end
+
+    def configure(&block)
+      MessageBird::Config.configure(&block)
+    end
+
+  end
+end

data/lib/messagebird/config.rb

@@ -0,0 +1,211 @@
+# Based on https://github.com/jwkoelewijn/batsir/blob/master/lib/batsir/config.rb
+
+module MessageBird
+  class Config
+    class << self
+
+      attr_accessor :config
+
+      def defaults
+        @defaults ||= {
+          :module =>      :http,
+          :api_url =>     "https://api.messagebird.com/api/sms",
+          :username =>    'replace_me',
+          :password =>    'replace_me',
+          :sender_name => 'replace_me',
+          :test_mode =>   true
+        }
+      end
+
+      # Returns the current configuration or sets it up
+      def configuration
+        @config ||= setup
+      end
+
+      # Yields the configuration.
+      #
+      # ==== Block parameters
+      # c<Hash>:: The configuration parameters.
+      #
+      # ==== Examples
+      #   MessageBird::Config.use do |config|
+      #     config[:exception_details] = false
+      #     config[:log_stream]        = STDOUT
+      #   end
+      #
+      # ==== Returns
+      # nil
+      #
+      # :api: public
+      def use
+        yield configuration
+        nil
+      end
+
+      # Detects whether the provided key is in the config.
+      #
+      # ==== Parameters
+      # key<Object>:: The key to check.
+      #
+      # ==== Returns
+      # Boolean:: True if the key exists in the config.
+      #
+      # :api: public
+      def key?(key)
+        configuration.key?(key)
+      end
+
+      # Retrieve the value of a config entry.
+      #
+      # ==== Parameters
+      # key<Object>:: The key to retrieve the parameter for.
+      #
+      # ==== Returns
+      # Object:: The value of the configuration parameter.
+      #
+      # :api: public
+      def [](key)
+        configuration[key]
+      end
+
+      # Set the value of a config entry.
+      #
+      # ==== Parameters
+      # key<Object>:: The key to set the parameter for.
+      # val<Object>:: The value of the parameter.
+      #
+      # :api: public
+      def []=(key, val)
+        configuration[key] = val
+      end
+
+      # Remove the value of a config entry.
+      #
+      # ==== Parameters
+      # key<Object>:: The key of the parameter to delete.
+      #
+      # ==== Returns
+      # Object:: The value of the removed entry.
+      #
+      # :api: public
+      def delete(key)
+        configuration.delete(key)
+      end
+
+      # Resets the configuration to its default state
+      #
+      def reset
+        setup
+      end
+
+      # Retrieve the value of a config entry, returning the provided default if the key is not present
+      #
+      # ==== Parameters
+      # key<Object>:: The key to retrieve the parameter for.
+      # default<Object>::
+      #   The default value to return if the parameter is not set.
+      #
+      # ==== Returns
+      # Object:: The value of the configuration parameter or the default.
+      #
+      # :api: public
+      def fetch(key, default = nil)
+        configuration.fetch(key, default)
+      end
+
+      # Returns the configuration as a hash.
+      #
+      # ==== Returns
+      # Hash:: The config as a hash.
+      #
+      # :api: public
+      def to_hash
+        configuration
+      end
+
+      # Sets up the configuration by storing the given settings.
+      #
+      # ==== Parameters
+      # settings<Hash>::
+      #   Configuration settings to use. These are merged with the defaults.
+      #
+      # ==== Returns
+      # The configuration as a hash.
+      #
+      # :api: private
+      def setup(settings = {})
+        @config = defaults.merge(settings)
+      end
+
+      # Set configuration parameters from a code block, where each method
+      # evaluates to a config parameter.
+      #
+      # ==== Parameters
+      # &block:: Configuration parameter block.
+      #
+      # ==== Examples
+      #   # Set environment and log level.
+      #   MessageBird::Config.configure do
+      #     environment "development"
+      #     log_level   "debug"
+      #   end
+      #
+      # ==== Returns
+      # nil
+      #
+      # :api: public
+      def configure(&block)
+        ConfigBlock.new(self, &block) if block_given?
+        nil
+      end
+
+      # Allows retrieval of single key config values via MessageBird::Config.<key>
+      # Allows single key assignment via Merb.config.<key> = ...
+      #
+      # ==== Parameters
+      # method<~to_s>:: Method name as hash key value.
+      # *args:: Value to set the configuration parameter to.
+      #
+      # ==== Returns
+      # The value of the entry fetched or assigned to.
+      #
+      # :api: public
+      def method_missing(method, *args)
+        if method.to_s[-1,1] == '='
+          self[method.to_s.tr('=','').to_sym] = args.first
+        else
+          self[method]
+        end
+      end
+
+    end # class << self
+
+    class ConfigBlock
+
+      # Evaluates the provided block, where any call to a method causes
+      # #[]= to be called on klass with the method name as the key and the arguments
+      # as the value.
+      #
+      # ==== Parameters
+      # klass<Object~[]=>:: The object on which to assign values.
+      # &block:: The block which specifies the config values to set.
+      #
+      # ==== Returns
+      # nil
+      #
+      # :api: private
+      def initialize(klass, &block)
+        @klass = klass
+        instance_eval(&block)
+      end
+
+      # Assign args as the value of the entry keyed by method.
+      #
+      # :api: private
+      def method_missing(method, *args)
+        @klass[method] = args.first
+      end
+
+    end # ConfigBlock
+  end # Config
+end

data/lib/messagebird/deliverable.rb

@@ -0,0 +1,7 @@
+module MessageBird
+  class Deliverable
+    def deliver
+      raise '#deliver method must be implemented!'
+    end
+  end
+end

data/lib/messagebird/helpers.rb

@@ -0,0 +1,20 @@
+module MessageBird
+  module Helpers
+
+    def config
+      MessageBird::Config
+    end
+
+    def constantize(class_name)
+      unless /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/ =~ class_name
+        raise NameError, "#{class_name.inspect} is not a valid constant name!"
+      end
+      Object.module_eval("::#{$1}", __FILE__, __LINE__)
+    end
+
+    def escape(str)
+      URI.escape(str)
+    end
+
+  end
+end

data/lib/messagebird/http/response.rb

@@ -0,0 +1,12 @@
+module MessageBird::HTTP
+  class Response
+
+    attr_reader :response_code
+
+    def initialize( http_response )
+      raise ArgumentError unless http_response.respond_to?(:body)
+      @response_code = ResponseCode.decode(http_response.body)
+    end
+
+  end
+end

data/lib/messagebird/http/response_code.rb

@@ -0,0 +1,47 @@
+module MessageBird::HTTP
+  class ResponseCode
+
+    def initialize(symbol, description)
+      @symbol      = symbol
+      @description = description
+    end
+
+    def to_sym
+      @symbol
+    end
+
+    def to_s
+      @description
+    end
+
+    def ==(other)
+      if other.is_a? Symbol
+        self.to_sym == other
+      else
+        self.to_s == other
+      end
+    end
+
+    def self.decode(string)
+      RESPONSE_CODES[string] || raise(ResponseCodeNotFound.new(string))
+    end
+
+    RESPONSE_CODES = {
+      "01" => ResponseCode.new(:success,                          "Request processed successfully"),
+      "69" => ResponseCode.new(:message_cannot_schedule_on_date,  "Message cannot be scheduled on this date"),
+      "70" => ResponseCode.new(:timestamp_incorrect,              "Timestamp notation invalid"),
+      "71" => ResponseCode.new(:timestamp_in_past,                "Timestamp is in the past"),
+      "72" => ResponseCode.new(:message_too_long,                 "Message is too long"),
+      "89" => ResponseCode.new(:sender_invalid,                   "Sender invalid"),
+      "93" => ResponseCode.new(:receivers_invalid,                "One or several receivers invalid"),
+      "95" => ResponseCode.new(:message_not_selected,             "No message selected"),
+      "96" => ResponseCode.new(:credits_insufficient,             "Insufficient credits"),
+      "97" => ResponseCode.new(:login_invalid,                    "Invalid username and/or password"),
+      "98" => ResponseCode.new(:ip_address_not_authorized,        "IP address is not authorized for this account"),
+      "99" => ResponseCode.new(:connection_failed,                "Cannot connect to server")
+    }
+    # PREMIUM CODES NOT IMPLEMENTED YET
+
+    class ResponseCodeNotFound < ArgumentError; end
+  end
+end