first commit

Author: Corny K

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.

README

@@ -0,0 +1,23 @@
+Configuration
+================
+
+Sipgate.user     = "your-account"
+Sipgate.password = "your-password"
+
+
+Usage
+============
+
+
+sip = Sipgate.new
+
+# send a pdf
+result = sip.fax(4912345678, File.read("document.pdf"))
+
+# check sending status
+status = sip.status(result.session_id)
+
+
+
+
+Copyright (c) 2009 Digineo GmbH (http://www.digineo.de/), released under the MIT license

init.rb

@@ -0,0 +1,3 @@
+require 'sipgate'
+require 'response'
+require 'error'

lib/error.rb

@@ -0,0 +1,10 @@
+class Sipgate::Exception < Exception
+  
+  attr_reader :code
+  
+  def initialize(message,code)
+    @code = code
+    super(message)
+  end
+  
+end

lib/response.rb

@@ -0,0 +1,44 @@
+class Sipgate::Response
+  
+  CODE_SUCCESS = 200
+  
+  def initialize(response)
+    @response = response
+  end
+  
+  def success?
+    status_code == CODE_SUCCESS
+  end
+  
+  def session_id
+    @response[:session_id]
+  end
+  
+  def session_status
+    @response[:session_status]
+  end
+  
+  def status_code
+    @response[:status_code]
+  end
+  
+  def status_string
+    @response[:status_string]
+  end
+  
+  # gibt den Status eines Fax-Versandes zurück. Mögliche Antworten:
+  # :pending, :sent, :failed
+  def sending_status
+    case session_status
+      when "sending", "queued"
+        :pending
+      when "sent"
+        :sent
+      when "error during submit", "failed"
+        :failed
+      else
+        raise "Konnte keinen Status aus Antwort ermitteln: #{inspect}"
+    end
+  end
+  
+end

lib/sipgate.rb

@@ -0,0 +1,57 @@
+require 'xmlrpc/client'
+
+class Sipgate
+  
+  cattr_accessor :user, :password
+  
+  def initialize
+    @client = XMLRPC::Client.new2("https://#{self.class.user}:#{self.class.password}@samurai.sipgate.net/RPC2")
+    http    = @client.instance_variable_get(:@http)
+    http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    http.ca_path = '/etc/ssl/certs'
+  end
+  
+  # versendet ein Fax
+  def fax(number, pdf_message)
+    number = number.gsub(/^(\+)/, "").gsub(/\s+/,   "")
+    
+    call "samurai.SessionInitiate",
+         'RemoteUri' => "sip:#{number}@sipgate.net",
+         'TOS'       => 'fax',
+         'Content'   => Base64.encode64(pdf_message)
+  end
+  
+  # fragt den Status eines Faxes ab
+  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.new(response.status_string, response.status_code)
+    end
+    
+    response
+  end
+  
+  # make server responses look more Ruby like (underscored Symbol as Hash keys)
+  # source: http://github.com/martinrehfeld/telefon/blob/7133964255eefb4679d8759f467ec2f749459aaa/app/models/sipgate.rb
+  def rubyized_hash(h)
+    returning new_hash = {} do
+      h.each do |k,v|
+        new_val = if v.is_a?(Hash)
+          rubyized_hash(v)
+        elsif v.is_a?(Array)
+          v.map{|e| e.is_a?(Hash) ? rubyized_hash(e) : e}
+        else
+          v
+        end
+        new_hash[k.to_s.underscore.to_sym] = new_val
+      end
+    end
+  end
+  
+end

sipgate.gemspec

@@ -0,0 +1,23 @@
+
+Gem::Specification.new do |s|
+  s.name = %q{sipgate}
+  s.version = "0.0.1"
+  
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Corny", "Averell"]
+  s.date = %q{2009-08-21}
+  s.description = %q{send fax through sipgate and check their sending status.}
+  s.email = %q{[email protected]}
+  s.files = %w(
+    MIT-LICENSE
+    README.rdoc
+    init.rb
+    lib/sipgate.rb
+    lib/response.rb
+    lib/error.rb
+  )
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/corny/sipgate}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.0}
+end