pling-mobilant 0.1.0

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+.rspec
+.rvmrc
+.yardoc/
+doc/
+Gemfile.lock
+pkg/*

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - ruby-head
+  - 1.9.2
+  - 1.8.7
+  - ree
+  - jruby
+  - rbx
+  - rbx-2.0.0pre

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in pling-mobilant.gemspec
+gemspec
+
+gem "pling", :git => "git://github.com/flinc/pling.git"
+gem "growl_notify" if RUBY_PLATFORM =~ /darwin/
+gem "guard"
+gem "guard-rspec"

data/Guardfile

@@ -0,0 +1,10 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})           { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^spec/support/(.+)\.rb$})  { "spec" }
+  watch('spec/spec_helper.rb')        { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2011 by Firstname Lastname
+
+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,33 @@
+# Pling Gateway to Mobilant
+
+## Requirements
+
+* [Pling](https://github.com/flinc/pling)
+
+## Install
+
+    gem 'pling-mobilant', :require => 'pling/mobilant'
+
+## Build Status
+
+pling-mobilant is on [Travis](http://travis-ci.org/flinc/pling-mobilant) running the specs on Ruby 1.8.7, Ruby Enterprise Edition, Ruby 1.9.2, Ruby HEAD, JRuby, Rubinius and Rubinius 2.
+
+
+## Known issues
+
+See [the issue tracker on GitHub](https://github.com/flinc/pling-mobilant/issues).
+
+
+## Repository
+
+See [the repository on GitHub](https://github.com/flinc/pling-mobilant) and feel free to fork it!
+
+
+## Contributors
+
+See a list of all contributors on [GitHub](https://github.com/flinc/pling-mobilant/contributors). Thanks a lot everyone!
+
+
+## Copyright
+
+Copyright (c) 2011 [flinc AG](https://flinc.org/). See LICENSE for details.

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+
+YARD::Rake::YardocTask.new(:doc)
+
+task :default => :spec
+
+desc "Open an irb session"
+task :console do
+  sh "bundle exec irb -rubygems -I lib -r pling/mobilant"
+end

data/lib/pling/gateway/mobilant.rb

@@ -0,0 +1 @@
+require 'pling/mobilant'

data/lib/pling/mobilant.rb

@@ -0,0 +1,47 @@
+require 'pling'
+require 'pling/mobilant/gateway'
+
+module Pling
+  module Mobilant
+    
+    class InvalidRecipient           < Error; end
+
+    class InvalidSender              < Error; end
+
+    class InvalidRoute               < Error; end
+
+    class InvalidMessageText         < Error; end
+
+    class InvalidMessageType         < Error; end
+
+    class InvalidRoute               < Error; end
+
+    class InsufficientCredits        < Error; end
+
+    class NetworkNotSupportedByRoute < Error; end
+
+    class FeatureNotSupportedByRoute < Error; end
+    
+    def self.error_by_response_code(code)
+      case code.to_s.to_i
+      when 10 then InvalidRecipient
+      when 20 then InvalidSender
+      when 30 then InvalidMessageText
+      when 31 then InvalidMessageType
+      when 40 then InvalidRoute
+      when 50 then AuthenticationFailed
+      when 60 then InsufficientCredits
+      when 70 then NetworkNotSupportedByRoute
+      when 71 then FeatureNotSupportedByRoute
+      when 80 then DeliveryFailed
+      else
+        nil
+      end
+    end
+
+  end
+  
+  module Gateway
+    Mobilant = ::Pling::Mobilant::Gateway
+  end
+end

data/lib/pling/mobilant/gateway.rb

@@ -0,0 +1,80 @@
+require 'faraday'
+
+require 'pling/mobilant'
+
+module Pling
+  module Mobilant
+    class Gateway < ::Pling::Gateway::Base
+
+      handles :sms, :mobilant, :mobile
+
+      def initialize(configuration)
+        setup_configuration(configuration, :require => [:key])
+      end
+
+      def deliver!(message, device)
+        params = {}
+
+        # require url parameter
+        params[:message] = message.body
+        params[:to]      = sanitize_identifier(device.identifier)
+        params[:route]   = route
+        params[:key]     = configuration[:key]
+
+        # optional url parameter
+        params[:from]    = source if source
+        params[:debug]   = debug  if debug
+
+        response = connection.get do |request|
+          request.url(configuration[:delivery_url], params)
+        end
+
+        response_code = response.body.lines.first
+
+        if error = ::Pling::Mobilant.error_by_response_code(response_code)
+          raise error
+        else
+          nil
+        end
+      end
+
+      private
+
+        def default_configuration
+          super.merge({
+            :delivery_url => 'https://gw.mobilant.net/',
+            :adapter => :net_http,
+            :connection => {},
+            :route => :lowcost
+          })
+        end
+
+        def connection
+          @connection ||= Faraday.new(configuration[:connection]) do |builder|
+            builder.use Faraday::Request::UrlEncoded
+            builder.use Faraday::Response::Logger if configuration[:debug]
+            builder.adapter(configuration[:adapter])
+          end
+        end
+
+        def route
+          route = (configuration[:route] || :lowcost)
+          [:lowcost, :lowcostplus, :direct, :directplus].include?(route) ? route : raise(::Pling::Mobilant::InvalidRoute, "Invalid route")
+        end
+
+        def debug
+          configuration[:debug] ? 1 : nil
+        end
+
+        def source
+          return nil unless configuration[:source]
+          configuration[:source].to_s.strip
+        end
+
+        def sanitize_identifier(identifier)
+          identifier.gsub(/^\+/, "00").gsub(/\D/, '')
+        end
+
+    end
+  end
+end

data/pling-mobilant.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "pling-mobilant"
+  s.version     = "0.1.0"
+  s.authors     = ["benedikt", "t6d", "fabrik42"]
+  s.email       = ["benedikt@synatic.net", "me@t6d.de", "fabrik42@gmail.com"]
+  s.homepage    = "http://flinc.github.com/pling-mobilant"
+  s.summary     = "Pling Gateway to Mobilant"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec", "~> 2.7"
+  s.add_development_dependency "yard", ">= 0.7"
+  s.add_development_dependency "rake", ">= 0.9"
+
+  s.add_runtime_dependency "pling"
+end

data/spec/pling/mobilant/gateway_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+require 'pling/mobilant'
+
+module Pling
+  module Mobilant
+    describe Gateway do
+
+      context 'when created with no key' do
+
+        it "should raise an error" do
+          expect { Pling::Mobilant::Gateway.new({}) }.to raise_error(ArgumentError, /key is missing/)
+        end
+
+      end
+
+      context "when delivering a message to a device" do
+
+        let(:message) { Message.new(:body => "Hello World") }
+
+        let(:device) { Device.new(:identifier => "+49 170 1234567")  }
+
+        let(:key) { 'X' * 23 }
+
+        let(:request) do
+          mock('Faraday request').tap do |mock|
+            mock.stub(:url).with(an_instance_of(String), an_instance_of(Hash))
+          end
+        end
+
+        let(:response) do
+          mock('Faraday response').tap do |mock|
+            mock.stub(:status).and_return(200)
+            mock.stub(:body).and_return('100')
+          end
+        end
+
+        let(:connection) do
+          mock('Fraday connection').tap do |mock|
+            mock.stub(:get).and_yield(request).and_return(response)
+          end
+        end
+
+        before do
+          Faraday.stub(:new).and_return(connection)
+        end 
+
+        subject do
+          Pling::Mobilant::Gateway.new(:key => key)
+        end
+
+        it "should deliver the message if both, message and device, are valid and the gateway is configured properly" do
+          request.should_receive(:url).with("https://gw.mobilant.net/", {
+                                              :message => 'Hello World',
+                                              :to => "00491701234567",
+                                              :route => :lowcost,
+                                              :key => key
+          })
+
+          subject.deliver(message, device)
+        end
+
+        it "should raise an exception when the provider reports an invalid recipient" do
+          response.should_receive(:body).and_return("10")
+          expect { subject.deliver(message, device) }.
+            to raise_error(::Pling::Mobilant::InvalidRecipient)
+        end
+
+        it "should raise an exception when the provider reports an invalid sender" do
+          response.should_receive(:body).and_return("20")
+          expect { subject.deliver(message, device) }.
+            to raise_error(::Pling::Mobilant::InvalidSender)
+        end
+
+        it "should raise an exception when the provider reports an message text" do
+          response.should_receive(:body).and_return("30")
+          expect { subject.deliver(message, device) }.
+            to raise_error(::Pling::Mobilant::InvalidMessageText)
+        end
+
+        it "should raise an exception when the provider reports an message type" do
+          response.should_receive(:body).and_return("31")
+          expect { subject.deliver(message, device) }.
+            to raise_error(::Pling::Mobilant::InvalidMessageType)
+        end
+
+        it "should raise an exception when the provider reports an invalid route" do
+          response.should_receive(:body).and_return("40")
+          expect { subject.deliver(message, device) }.
+            to raise_error(::Pling::Mobilant::InvalidRoute)
+        end
+
+        it "should raise an exception when the provider reports that the authentication failed" do
+          response.should_receive(:body).and_return("50")
+          expect { subject.deliver(message, device) }.
+            to raise_error(::Pling::AuthenticationFailed)
+        end
+
+        it "should raise an exception when the provider reports insufficient credits" do
+          response.should_receive(:body).and_return("60")
+          expect { subject.deliver(message, device) }.
+            to raise_error(::Pling::Mobilant::InsufficientCredits)
+        end
+
+        it "should raise an exception when the provider reports an invalid recipient" do
+          response.should_receive(:body).and_return("70")
+          expect { subject.deliver(message, device) }.
+            to raise_error(::Pling::Mobilant::NetworkNotSupportedByRoute)
+        end
+
+        it "should raise an exception when the provider reports an invalid recipient" do
+          response.should_receive(:body).and_return("71")
+          expect { subject.deliver(message, device) }.
+            to raise_error(::Pling::Mobilant::FeatureNotSupportedByRoute)
+        end
+
+        it "should raise an exception when the provider reports an invalid recipient" do
+          response.should_receive(:body).and_return("80")
+          expect { subject.deliver(message, device) }.
+            to raise_error(::Pling::DeliveryFailed)
+        end
+
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler'
+Bundler.require
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: pling-mobilant
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- benedikt
+- t6d
+- fabrik42
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-28 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70304756887460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: *70304756887460
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70304756886600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: *70304756886600
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70304756884820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: *70304756884820
+- !ruby/object:Gem::Dependency
+  name: pling
+  requirement: &70304756883300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70304756883300
+description: 
+email:
+- benedikt@synatic.net
+- me@t6d.de
+- fabrik42@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/pling/gateway/mobilant.rb
+- lib/pling/mobilant.rb
+- lib/pling/mobilant/gateway.rb
+- pling-mobilant.gemspec
+- spec/pling/mobilant/gateway_spec.rb
+- spec/spec_helper.rb
+homepage: http://flinc.github.com/pling-mobilant
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Pling Gateway to Mobilant
+test_files:
+- spec/pling/mobilant/gateway_spec.rb
+- spec/spec_helper.rb
+has_rdoc: