multiinfo 0.0.7

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

data/History.txt

@@ -0,0 +1,9 @@
+2012-05-24 Version 0.0.7 Piotr Barczuk
+  - added support for trusted certificates signing
+
+2009-07-29 Version 0.0.1 Łukasz Łuczak
+  - sending sms message
+  - receiving smsm message status
+  - cancel sending sms
+  - config enabled with yml file
+  - HTTPclient used for HTTPS with client cert comunication

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Łukasz Łuczak
+
+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.rdoc

@@ -0,0 +1,53 @@
+= Polkomtel MultiInfo HTTPS API wrapped into Ruby library
+
+This gem is Ruby interface to the Polkomtel's MultiInfo SMS gateway service, based on Luke Redpath's clickatel library
+To use this gem, you will need an access to Polkomtel's MultiInfo service. You need user, password, sercvice_id and certificate for ssl connection.
+Contact Polkomtel sales reps for info how to obtain acces to MultiInfo service.
+
+== Basic Usage
+
+You will need your Mutliinfo credentials and SSL certificate to use this library.
+
+  require 'rubygems'
+  require 'multiinfo'
+  
+  api = MultiInfo::API.new
+
+  # Example api calls
+  api.send_message('48661351024', 'Hello') # sends sms 'Hello' to 48 661 351 024 and returns message id
+  api.message_info('22') # gets info about message with id 22
+  
+
+== Conifguration options
+
+Default path for config file and certificate files is $HOME/multiinfo. You should place following files in that directory:
+  multiinfo.yml # config file
+  multiinfo.crt # certificate
+  multiinfo.pem # RSA key
+
+    
+In multiinfo.yml you should specify at least:
+  login
+  password
+  service_id
+
+If you want to use different names for certificate files speciify them with FULL PATH in config file under:
+  
+  client_cert
+  client_key
+
+You will probably also need to add Multiinfo Root Certificate to your trusted certificates chain.
+To mark a certificate as trusted, specify it in your multiinfo.yml file (you can provide either a filename or a directory). You can also use 'default' to let the application use the default certificates path.
+
+See example in config_example.yml
+
+
+To load your custom config file use following code
+  require 'rubygems'
+  require 'multiinfo'
+  
+  config = MultiInfo::API.load_auth_options(CONFIG_FILE_FULL_PATH)
+  api = MultiInfo::API.new(config)
+
+
+

data/VERSION

@@ -0,0 +1 @@
+0.0.7

data/config_example.yml

@@ -0,0 +1,9 @@
+# example config file for authentication MultiInfo HTTPS API
+login: luka
+password: test
+service_id: 1
+
+# Optionally you can specify full path to certificate files
+client_cert: /home/luka/weblify.cert
+client_key: /home/luka/weblify.key
+ca_path: /etc/ssl/certs #or just user default

data/lib/core-ext/hash.rb

@@ -0,0 +1,23 @@
+class Hash
+  # Returns a new hash containing only the keys specified
+  # that exist in the current hash.
+  #
+  #  {:a => '1', :b => '2', :c => '3'}.only(:a, :c)
+  #  # => {:a => '1', :c => '3'}
+  #
+  # Keys that do not exist in the original hash are ignored.
+  def only(*keys)
+    inject( {} ) do |new_hash, (key, value)|
+      new_hash[key] = value if keys.include?(key)
+      new_hash
+    end
+  end
+  
+  def symbolize_keys
+    inject({}) do |options, (key, value)|
+      options[(key.to_sym rescue key) || key] = value
+      options
+    end
+  end
+  
+end

data/lib/core-ext/string.rb

@@ -0,0 +1,9 @@
+class String
+  def camelize(first_letter_in_uppercase = true)
+    if first_letter_in_uppercase
+      self.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+    else
+      self[0].chr.downcase + camelize[1..-1]
+    end
+  end
+end

data/lib/multiinfo.rb

@@ -0,0 +1,8 @@
+module MultiInfo end
+
+%w( core-ext/hash
+    core-ext/string
+    multiinfo/api     
+).each do |lib|
+    require File.join(File.dirname(__FILE__), lib)
+end

data/lib/multiinfo/api.rb

@@ -0,0 +1,122 @@
+module MultiInfo
+  # This module provides the core implementation of the Clickatell
+  # HTTP service.
+  class API
+    # Defaults for config file location
+    DEFAULT_CONFIG_PATH = File.join(ENV['HOME'], 'multiinfo')
+    DEFAULT_CONFIG_FILE = 'multiinfo.yml'
+    
+    attr_accessor :auth_options
+    
+    class << self      
+      # Set to true to enable debugging (off by default)
+      attr_accessor :debug_mode
+      
+      # Set to true to test message sending; this will not actually send 
+      # messages but will collect sent messages in a testable collection. 
+      # (off by default)
+      attr_accessor :test_mode
+      
+      # Load credentials from config file 
+      def load_auth_options(config_location = nil)                    
+        config_file = File.open(config_location || File.join(DEFAULT_CONFIG_PATH, DEFAULT_CONFIG_FILE))
+        auth_options = YAML.load(config_file).symbolize_keys
+        raise MultiInfo::API::Error.new(-9999, 'Missing config params') if auth_options.only(:login, :password, :service_id).size != 3
+        auth_options
+      end
+      
+    end
+    self.debug_mode = false
+    self.test_mode = false
+    
+    # Creates a new API instance using the specified +auth_options+.
+    # +auth_options+ is a hash containing :username, :password, :service_id and
+    # optionally :client_cert, :client_key
+    #
+    def initialize(auth_options = nil)
+      @auth_options = auth_options || self.class.load_auth_options       
+    end
+            
+    # Sends a message +message_text+ to +recipient+. Recipient
+    # number should have an international dialing prefix 
+    def send_message(recipient, message_text, opts={})
+      valid_options = opts.only(:valid_to, :deliv_notif_request).merge(service_id)
+      response = execute_command( 'sendsms', {:text => message_text, :dest => recipient}.merge(valid_options) ) 
+      parse_response(response)
+    end
+
+
+    # Sends a package of messages. Recipient
+    # number should have an international dialing prefix 
+    def send_package
+      # todo
+    end
+      
+    
+    # Returns the status of a message. Use sms ID returned
+    # from original send_message call.
+    def message_info(sms_id)
+      response = execute_command('infosms',  :sms_id => sms_id)
+      parse_response(response)
+    end
+
+    # Returns the status of a package of messages. Use package id returned
+    # from original send_package call.
+    def package_info(package_id)
+      response = execute_command('packageinfo',  :package_id => package_id)
+      parse_response(response)      
+    end
+
+    # Returns the status of a message. Use sms ID returned
+    # from original send_message call.
+    def cancel_message(sms_id)
+      response = execute_command('cancelsms',  :sms_id => sms_id)
+      parse_response(response)
+    end
+    
+    def get_message(opts={})
+      valid_options = opts.only(:timeout).merge(service_id)
+      response = execute_command('getsms', valid_options)
+      parse_response(response)
+    end
+    
+    def sms_requests #:nodoc:
+      @sms_requests ||= []
+    end
+
+    protected      
+      def execute_command(command_name, parameters={}) #:nodoc:
+        executor = Executor.new(credentials, certificate, self.class.debug_mode, self.class.test_mode)
+        result = executor.execute(command_name, parameters)
+        
+        (sms_requests << executor.sms_requests).flatten! if self.class.test_mode
+        
+        result
+      end
+
+      def parse_response(raw_response) #:nodoc:
+        Response.parse(raw_response)
+      end
+      
+      def credentials #:nodoc:
+        @credenitals ||= @auth_options.only(:login, :password)
+      end
+    
+      def certificate #:nodoc:
+        @certificate ||= @auth_options.only(:client_cert, :client_key, :ca_path)
+      end
+    
+      def service_id #:nodoc:
+        @service_id ||= @auth_options.only(:service_id)
+      end
+    
+  end
+end
+
+%w( api/command
+    api/error
+    api/executor
+    api/response
+).each do |lib|
+  require File.join(File.dirname(__FILE__), lib)
+end

data/lib/multiinfo/api/command.rb

@@ -0,0 +1,22 @@
+require "cgi"
+module MultiInfo
+  class API
+    API_SERVICE_HOST = 'https://www.multiinfo.plus.pl/'
+    API_NAME = 'smsapi4'
+    API_SCRIPT_TYPE = 'aspx'
+    
+    class Command
+
+      def initialize(command_name)
+        @command_name = command_name
+      end
+  
+      def with_params(param_hash)
+        param_string = '?' + param_hash.map { |key, value| "#{::CGI.escape(key.to_s.camelize(false))}=#{::CGI.escape(value.to_s)}" }.sort.join('&')
+        URI.parse(File.join("#{API_SERVICE_HOST}#{API_NAME}/", "#{@command_name}.#{API_SCRIPT_TYPE}" + param_string))
+      end
+      
+    end
+    
+  end
+end

data/lib/multiinfo/api/error.rb

@@ -0,0 +1,20 @@
+module MultiInfo
+  class API
+  
+    # MultiInfo API Error exception.
+    class Error < StandardError
+      attr_reader :code, :message
+      
+      def initialize(code, message)
+        @code, @message = code, message
+      end
+      
+      # Creates a new Error from a MultiInfo HTTP response string
+      def self.parse(error_arr)
+        code, message = error_arr
+        self.new(code, message)
+      end
+    end
+  
+  end
+end

data/lib/multiinfo/api/executor.rb

@@ -0,0 +1,73 @@
+require "rubygems"
+require 'httpclient'
+
+
+module MultiInfo
+  class API
+    DEFAULT_CERT_FILE = 'multiinfo.crt'
+    DEFAULT_KEY_FILE = 'multiinfo.pem'
+   
+    class FakeHttpResponse
+       "test mode"
+    end
+   
+    class Executor
+      def initialize(authentication_hash, certificate_hash, debug=false, test_mode=false)
+        @authentication_hash = authentication_hash
+        @client_cert_file = { 
+          :cert => certificate_hash[:client_cert] || File.join(DEFAULT_CONFIG_PATH, DEFAULT_CERT_FILE),
+          :rsa_key  => certificate_hash[:client_key] || File.join(DEFAULT_CONFIG_PATH, DEFAULT_KEY_FILE)
+        }
+        @client_cert_file[:ca_path] = certificate_hash[:ca_path] unless certificate_hash[:ca_path].blank?
+        @debug = debug
+        @test_mode = test_mode
+      
+        allow_request_recording if @test_mode
+      end
+    
+      def execute(command_name, parameters={})
+        request_uri = command(command_name, parameters)
+        puts "[debug] Executing command '#{command_name}': #{request_uri}" if @debug
+        [command_name, get_response(request_uri)]
+      end
+
+      def in_test_mode?
+        @test_mode
+      end
+    
+      protected
+      
+      def command(command_name, parameters) 
+        Command.new(command_name).with_params( parameters.merge(@authentication_hash) )
+      end
+    
+      def get_response(uri)
+        if in_test_mode?
+          sms_requests << uri
+          FakeHttpResponse.new
+        else
+          clnt = HTTPClient.new
+          if @client_cert_file[:ca_path] == 'default'
+            clnt.ssl_config.set_default_paths
+          elsif !@client_cert_file[:ca_path].blank?
+            clnt.ssl_config.add_trust_ca @client_cert_file[:ca_path]
+          end
+          clnt.ssl_config.set_client_cert_file(@client_cert_file[:cert], @client_cert_file[:rsa_key])
+          clnt.get_content(uri)    
+        end
+      end
+        
+      private
+    
+      def allow_request_recording
+        class << self
+          define_method :sms_requests do
+            @sms_requests ||= []
+          end
+        end
+      end    
+      
+    end  
+     
+  end
+end

data/lib/multiinfo/api/response.rb

@@ -0,0 +1,86 @@
+module MultiInfo
+  class API
+  
+  # Used to parse HTTP responses returned from MultiInfo API calls.
+    class Response
+      class << self
+              
+        # Returns the HTTP response body data as a hash.
+        def parse(response_arr)
+          return { :status => 'OK' } if API.test_mode
+          command, http_response = response_arr
+          response_rows = http_response.split(/\r\n|\n/)
+          response_status, response_body = response_rows[0], response_rows[1..-1]
+          if response_status.to_i < 0 
+            raise MultiInfo::API::Error.new(response_status, response_body.first)
+          else
+            response_hash(command, response_body).merge({:status => response_status})
+          end
+        end
+        
+        private
+        def response_hash(command, response)
+          resp_hash = {}
+          API_RESPONSES[command].each_with_index { |message_key, i| resp_hash[message_key] = response[i] }
+          resp_hash
+        end
+        
+        public
+        API_RESPONSES = {
+          # Hash keys for each response lines.
+          # Line no 1 is skipped as it always is 'status'
+          
+          'sendsms'  => [
+            :sms_id                # 2
+          ],  
+          
+          'cancelsms' => [
+            :cancel_status         # 2
+          ],
+          
+          'infosms' => [
+            :sms_id,               # 2
+            :message_type,         # 3
+            :message_body,         # 4
+            :protocol_id,          # 5
+            :coding_scheme,        # 6
+            :service_id,           # 7
+            :conector_id,          # 8
+            :originator_sms_id,    # 9
+            :priority,             # 10
+            :send_date,            # 11
+            :valid_to,             # 12
+            :deliv_notif_request,  # 13
+            :originator,           # 14
+            :destination,          # 15
+            :message_status,       # 16
+            :status_date           # 17
+          ],
+          
+          'packageinfo' => [
+            :package_id,           # 2
+            :sent_message_count,   # 3
+            :waiting_message_count,# 4
+            :package_status        # 5
+          ],
+          
+          'getsms' => [
+            :sms_id,               # 2
+            :sender,               # 3
+            :destination,          # 4
+            :message_type,         # 5
+            :message_body,         # 6
+            :protocol_id,          # 7
+            :coding_scheme,        # 8
+            :service_id,           # 9
+            :conector_id,          # 9
+            :receive_date          # 10            
+          ]
+          
+        }
+        
+      end
+
+    end
+  end
+end

data/multiinfo.gemspec

@@ -0,0 +1,52 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{multiinfo}
+  s.version = "0.0.7"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["\305\201ukasz \305\201uczak", "Piotr Barczuk"]
+  s.date = %q{2012-05-24}
+  s.description = %q{This gem is Ruby interface to the Polkomtel's MultiInfo SMS gateway service, based on Luke Redpath's clickatel library. To use this gem, you will need an access to Polkomtel's MultiInfo service. You need user, password, sercvice_id and certificate for ssl connection. Contact Polkomtel sales reps for info how to obtain acces to MultiInfo service.}
+  s.email = %q{luka@weblify.pl}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "History.txt",
+     "License.txt",
+     "README.rdoc",
+     "VERSION",
+     "config_example.yml",
+     "lib/core-ext/hash.rb",
+     "lib/core-ext/string.rb",
+     "lib/multiinfo.rb",
+     "lib/multiinfo/api.rb",
+     "lib/multiinfo/api/command.rb",
+     "lib/multiinfo/api/error.rb",
+     "lib/multiinfo/api/executor.rb",
+     "lib/multiinfo/api/response.rb",
+     "multiinfo.gemspec",
+     "rakefile.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/luka/multiinfo}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Ruby interface to the Polkomtel's MultiInfo SMS gateway service, based on Luke Redpath's clickatel library}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httpclient>, [">= 2.2.5"])
+    else
+      s.add_dependency(%q<httpclient>, [">= 2.2.5"])
+    end
+  else
+    s.add_dependency(%q<httpclient>, [">= 2.2.5"])
+  end
+end

data/rakefile.rb

@@ -0,0 +1,17 @@
+begin
+  require 'jeweler'
+
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "multiinfo"
+    gemspec.summary = "Ruby interface to the Polkomtel's MultiInfo SMS gateway service, based on Luke Redpath's clickatel library"
+    gemspec.description = "This gem is Ruby interface to the Polkomtel's MultiInfo SMS gateway service, based on Luke Redpath's clickatel library.
+    To use this gem, you will need an access to Polkomtel's MultiInfo service. You need user, password, sercvice_id and certificate for ssl connection.
+    Contact Polkomtel sales reps for info how to obtain acces to MultiInfo service."
+    gemspec.email = "luka@weblify.pl"
+    gemspec.homepage = "http://github.com/luka/multiinfo"
+    gemspec.authors = ["Łukasz Łuczak"]    
+    gemspec.add_dependency('httpclient', '>= 2.2.5')    
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: multiinfo
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+  prerelease: 
+platform: ruby
+authors:
+- Łukasz Łuczak
+- Piotr Barczuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.5
+description: This gem is Ruby interface to the Polkomtel's MultiInfo SMS gateway service,
+  based on Luke Redpath's clickatel library. To use this gem, you will need an access
+  to Polkomtel's MultiInfo service. You need user, password, sercvice_id and certificate
+  for ssl connection. Contact Polkomtel sales reps for info how to obtain acces to
+  MultiInfo service.
+email: luka@weblify.pl
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- .gitignore
+- History.txt
+- License.txt
+- README.rdoc
+- VERSION
+- config_example.yml
+- lib/core-ext/hash.rb
+- lib/core-ext/string.rb
+- lib/multiinfo.rb
+- lib/multiinfo/api.rb
+- lib/multiinfo/api/command.rb
+- lib/multiinfo/api/error.rb
+- lib/multiinfo/api/executor.rb
+- lib/multiinfo/api/response.rb
+- multiinfo.gemspec
+- rakefile.rb
+homepage: http://github.com/luka/multiinfo
+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
+      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.24
+signing_key: 
+specification_version: 2
+summary: Ruby interface to the Polkomtel's MultiInfo SMS gateway service, based on
+  Luke Redpath's clickatel library
+test_files: []