rsipgate 0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Digineo GmbH, Germany
+
+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,40 @@
+# rsipgate
+
+## Installation
+
+``` ruby
+gem 'rsipgate'
+```
+
+## Configuration
+
+``` ruby
+Sipgate.user     = "your-account"
+Sipgate.password = "your-password"
+```
+If hostname of sipgate different from api.sipgate.net you can set it:
+
+``` ruby
+Sipgate.api_host = "another.api.host.sipgate.net"
+```
+
+## Usage
+
+### send a pdf
+
+``` ruby    
+fax = Sipgate::Fax('4912345678', File.read("document.pdf"))
+result = fax.send
+```
+
+### check sending status
+
+``` ruby    
+status = fax.status(result.session_id)
+```
+
+## Copyrights
+
+Copyright (c) 2012 Alexander Simonov (http://simonov.me/), released under the MIT license
+
+Copyright (c) 2009 Digineo GmbH (http://www.digineo.de/), released under the MIT license

data/lib/rsipgate.rb

@@ -0,0 +1,11 @@
+require 'xmlrpc/client'
+require 'base64'
+require 'rsipgate/response'
+require 'rsipgate/exception'
+require 'rsipgate/base'
+require 'rsipgate/fax'
+
+module Sipgate
+  extend self
+  attr_accessor :user, :password, :api_host
+end

data/lib/rsipgate/base.rb

@@ -0,0 +1,53 @@
+module Sipgate
+  class Base
+    
+    PATH = '/RPC2'
+    
+    def my_api_host
+      Sipgate.api_host || 'api.sipgate.net'
+    end
+    
+    def initialize(user = nil, password = nil)
+      user ||= Sipgate.user
+      password ||= Sipgate.password
+      @client = XMLRPC::Client.new3({
+        :host => my_api_host,
+        :path => PATH,
+        :use_ssl => true,
+        :user => user,
+        :password => password,
+        :port => 443
+      })
+    end
+    
+    # queries the status of a fax
+    def status(session_id)
+      call "samurai.SessionStatusGet",
+           'SessionID' => session_id
+    end
+    
+    def call(*args)
+      response = Response.new(rubyized_hash(@client.call(*args)))
+      unless response.success?
+        raise ::Sipgate::Exception, "Response failed with #{response.status_string} with code #{response.status_code}" 
+      end
+      response
+    end
+
+    # make server responses look more Ruby like (underscored Symbol as Hash keys)
+    def rubyized_hash(h)
+      h.inject({}) do |memo, (k, v)|
+        value = case v
+        when ::Hash
+          rubyized_hash(v)
+        when ::Array
+          v.map {|item| is_a?(::Hash) ? rubyized_hash(item) : item }
+        else
+          v
+        end
+        memo[k.to_s.gsub(/(.)([A-Z])/,'\1_\2').downcase.to_sym] = value
+        memo
+      end
+    end
+  end
+end

data/lib/rsipgate/exception.rb

@@ -0,0 +1,3 @@
+module Sipgate
+  class Exception < ::Exception; end
+end

data/lib/rsipgate/fax.rb

@@ -0,0 +1,14 @@
+module Sipgate
+  class Fax < Base
+
+    # send a fax
+    def send(number, pdf_message)
+      number.gsub!(/^(\+)/, "")
+      number.gsub!(/\s+/, "")
+      call "samurai.SessionInitiate",
+           'RemoteUri' => "sip:#{number}@sipgate.net",
+           'TOS'       => 'fax',
+           'Content'   => ::Base64.encode64(pdf_message)
+    end
+  end
+end

data/lib/rsipgate/response.rb

@@ -0,0 +1,33 @@
+module Sipgate
+  class Response
+  
+    CODE_SUCCESS = 200
+  
+    def initialize(response)
+      @response = response
+    end
+  
+    def success?
+      status_code == CODE_SUCCESS
+    end
+    
+    %w(session_id session_status status_code status_string).each do |key|
+      define_method(key) { @response[key.to_sym] }
+    end
+    
+    # returns the status of a fax transmission. possible answers:
+    # :pending, :sent, :failed
+    def sending_status
+      case session_status
+        when "sending", "queued"
+          :pending
+        when "sent"
+          :sent
+        when "error during submit", "failed"
+          :failed
+        else
+          raise "Could not determine status of response: #{inspect}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: rsipgate
+version: !ruby/object:Gem::Version
+  version: '0.2'
+  prerelease: 
+platform: ruby
+authors:
+- Alexander Simonov
+- Corny
+- Averell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-21 00:00:00.000000000Z
+dependencies: []
+description: 
+email: alex@simonov.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rsipgate/base.rb
+- lib/rsipgate/exception.rb
+- lib/rsipgate/fax.rb
+- lib/rsipgate/response.rb
+- lib/rsipgate.rb
+- README.md
+- MIT-LICENSE
+homepage: http://github.com/simonoff/rsipgate
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+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: send fax through sipgate and check their sending status
+test_files: []
+has_rdoc: