webmoney 0.0.4.3 → 0.0.4.4

data/ChangeLog

@@ -1,5 +1,11 @@
 ChangeLog
 
+Sun Mar 15 2009 14:55:18 +0400
+----------------------------
+  V 0.0.4.4
+  * Fix bug in send_message (reqn related)
+  * Refactor for more extendable
+
 Thu Jan 22 2009 14:00:00 +0400
 ----------------------------
   V 0.0.4.3

data/README

@@ -1,11 +1,72 @@
-README
+== About Webmoney library
 
-For run tests create ~/.wm/config.yml file:
+This library should help to make requests to WebMoney Transfer http://www.wmtransfer.com
+XML-interfaces: http://www.wmtransfer.com/eng/developers/interfaces/index.shtml
 
-common:
-  type: classic
-  wmid: '123456789012'
-  key: 'gQABAIR6... YOUR BASE64-KEY (see wmsigner readme) ...2cC8FZTyKyjBM='
-  password: _your_password_
+Gem have built-in native *wmsigner*.
 
-and type: rake spec
+Author::    Alexander Oryol (mailto:eagle.alex@gmail.com)
+License::   MIT License
+
+== Request types
+
+Completed:
+- send_message       - x6
+- get_passport       - x11
+- bussines_level
+
+Incompleted (help need!):
+- create_invoice     - x1
+- create_transaction - x2
+- operation_history  - x3
+- outgoing_invoices  - x4
+- finish_protect     - x5
+- check_sign         - x7
+- find_wm            - x8
+- balance            - x9
+- incoming_invoices  - x10
+- reject_protection  - x13
+- transaction_moneyback - x14
+- i_trust               - x15
+- trust_me              - x15
+- trust_save            - x15
+- create_purse          - x16
+
+Please, see relative documentation and parameters on wiki:
+
+http://wiki.wmtransfer.com/wiki/list/XML-Interfaces
+
+http://wiki.webmoney.ru/wiki/list/XML-%D0%B8%D0%BD%D1%82%D0%B5%D1%80%D1%84%D0%B5%D0%B9%D1%81%D1%8B (in russian)
+
+or official sites:
+
+http://www.wmtransfer.com/eng/developers/interfaces/xml/index.shtml
+
+http://www.webmoney.ru/rus/developers/interfaces/xml/index.shtml (in russian)
+
+== Examples
+
+= Setup
+
+@wm = Webmoney.new(:wmid => '123456789012', :password => 'my_pass', :key => 'gQABAIR6...2cC8FZTyKyjBM=')
+
+wmid = '111222333444'
+
+= Passport (X11) request:
+
+passport = @wm.request(:get_passport, :wmid => wmid)
+
+= Bussines level request:
+
+bl = @wm.request(:bussines_level, :wmid => wmid)
+
+= Sending message
+
+... for one message:
+@wm.request(:send_message, :wmid => wmid, :subj => 'Subject', :text => 'Body of \<b>message\</b>')
+
+... for many messages (with queue):
+@wm.send_message(:wmid => wmid, :subj => 'Subject', :text => 'Body of \<b>message\</b>')
+
+
+Also, see examples into spec's.

data/lib/messenger.rb

@@ -13,12 +13,12 @@ class Webmoney
           unless msg.nil?
             begin
               result = @webmoney.request(:send_message, msg)
+              # Requeue if fail
               @queue.push(msg) unless result.kind_of?(Hash)
-            rescue ResultError
-              puts "ResultError: #{@webmoney.error} #{@webmoney.errormsg}"
-              # Silent drop message
-            rescue ResponseError
-              puts "ResponseError: #{@webmoney.error}"
+            rescue ResultError, ResponseError => e
+              # TODO Replace this to logger call
+              # puts "#{e}: #{@webmoney.error} #{@webmoney.errormsg}"
+
               # Requeue message
               @queue.push(msg)
             end
@@ -30,6 +30,8 @@ class Webmoney
     def push(msg)
       @queue.push(msg)
     end
+
+    # TODO callback on success send message
     
   end
   

data/lib/request.rb

@@ -0,0 +1,69 @@
+module Webmoney::XMLRequest    # :nodoc:all
+
+  def envelope(utf = true)
+    x = Builder::XmlMarkup.new(:indent => 1)
+    encoding = utf ? "utf-8" : "windows-1251"
+    x.instruct!(:xml, :version => "1.0", :encoding => encoding)
+    x
+  end  
+
+  def xml_get_passport(opt)
+    x = envelope(false)
+    x.request do
+      x.wmid @wmid
+      x.passportwmid opt[:wmid]
+      x.params { x.dict 0; x.info 1; x.mode 0 }
+      x.sign sign(@wmid + opt[:wmid]) if classic?
+    end
+    x
+  end
+
+  def xml_bussines_level(opt)
+    x = envelope
+    x.tag!('WMIDLevel.request') do
+      x.signerwmid @wmid
+      x.wmid opt[:wmid]
+    end
+    x
+  end
+
+  def xml_check_sign(opt)
+    x = envelope(false)
+    x.tag!('w3s.request') do
+      x.wmid @wmid
+      plan_out = @ic_out.iconv(opt[:plan])
+      x.testsign do
+        x.wmid opt[:wmid]
+        x.plan { x.cdata! plan_out }
+        x.sign opt[:sign]
+      end
+      if classic?
+        plan = @wmid + opt[:wmid] + plan_out + opt[:sign]
+        x.sign sign(plan)
+      end
+    end
+    x
+  end
+
+  def xml_send_message(opt)
+    x = envelope(false)
+    req = reqn()
+    x.tag!('w3s.request') do
+      x.wmid @wmid
+      x.reqn req
+      msgsubj = @ic_out.iconv(opt[:subj])
+      msgtext = @ic_out.iconv(opt[:text])
+      x.message do
+        x.receiverwmid opt[:wmid]
+        x.msgsubj { x.cdata! msgsubj }
+        x.msgtext { x.cdata! msgtext }
+      end
+      if classic?
+        @plan = opt[:wmid] + req + msgtext + msgsubj
+        x.sign sign(@plan)
+      end
+    end
+    x
+  end
+
+end

data/lib/result.rb

@@ -0,0 +1,21 @@
+module Webmoney::RequestResult    # :nodoc:all
+
+  def result_check_sign(doc)
+    doc.at('//testsign/res').inner_html == 'yes' ? true : false
+  end
+
+  def result_get_passport(doc)
+    Webmoney::Passport.new(doc)
+  end
+
+  def result_bussines_level(doc)
+    doc.at('//level').inner_html.to_i
+  end
+
+  def result_send_message(doc)
+    time = doc.at('//message/datecrt').inner_html
+    m = time.match(/(\d{4})(\d{2})(\d{2}) (\d{2}):(\d{2}):(\d{2})/)
+    time = Time.mktime(*m[1..6])
+    { :id => doc.at('//message')['id'], :date => time }
+  end
+end

data/lib/webmoney.rb

@@ -1,67 +1,7 @@
-=begin rdoc
-== About Webmoney library
-
-This library help to make requests to WebMoney Transfer http://www.wmtransfer.com
-XML-interfaces: http://www.wmtransfer.com/eng/developers/interfaces/index.shtml
-
-Gem have built-in native *wmsigner*.
-
-Author::    Alexander Oryol (mailto:eagle.alex@gmail.com)
-License::   MIT License
-
-== Request types
-
-- create_invoice     - x1
-- create_transaction - x2
-- operation_history  - x3
-- outgoing_invoices  - x4
-- finish_protect     - x5
-- send_message       - x6
-- check_sign         - x7
-- find_wm            - x8
-- balance            - x9
-- incoming_invoices  - x10
-- get_passport       - x11
-- reject_protection  - x13
-- transaction_moneyback - x14
-- i_trust               - x15
-- trust_me              - x15
-- trust_save            - x15
-- create_purse          - x16
-- bussines_level
-
-Please, see relative documentation and parameters on wiki:
-
-http://wiki.wmtransfer.com/wiki/list/XML-Interfaces
-
-http://wiki.webmoney.ru/wiki/list/XML-%D0%B8%D0%BD%D1%82%D0%B5%D1%80%D1%84%D0%B5%D0%B9%D1%81%D1%8B (in russian)
-
-or official sites:
-
-http://www.wmtransfer.com/eng/developers/interfaces/xml/index.shtml
-
-http://www.webmoney.ru/rus/developers/interfaces/xml/index.shtml (in russian)
-
-== Examples
-
-@wm = Webmoney.new(:wmid => '123456789012', :password => 'my_pass', :key => 'gQABAIR6...2cC8FZTyKyjBM=')
-
-passport = @wm.request(:get_passport, :wmid => @wm.wmid)
-
-bl = @wm.request(:bussines_level, :wmid => '123456789012')
-
-@wm.request(:send_message, :wmid => @wm.wmid, :subj => 'Subject', :text => 'Body of \<b>message\</b>')
-
-
-Also, see examples into spec's.
-=end
-
-
 # :title:Webmoney library Documentation
 # :main:lib/webmoney.rb
 # :include:README
 
-require File.dirname(__FILE__) +'/wmsigner'
 require 'time'
 require 'net/http'
 require 'net/https'
@@ -70,11 +10,23 @@ require 'iconv'
 require 'builder'
 require 'hpricot'
 
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+
+require 'wmsigner'
+require 'wmid'
+require 'passport'
+require 'request'
+require 'result'
+require 'messenger'
+
 # Main class for Webmoney lib. Instance contain info
 # for WMT-interfaces requests (wmid, key, etc).
 # Implement general requests.
 class Webmoney
 
+  include XMLRequest
+  include RequestResult
+
   # Error classes
   class WebmoneyError < StandardError; end
   class RequestError < WebmoneyError;  end
@@ -82,10 +34,6 @@ class Webmoney
   class IncorrectWmidError < WebmoneyError; end
   class CaCertificateError < WebmoneyError; end
   
-  require File.dirname(__FILE__) + '/../lib/wmid'
-  require File.dirname(__FILE__) + '/../lib/passport'
-  require File.dirname(__FILE__) + '/../lib/messenger'
-  
   attr_reader :wmid, :error, :errormsg, :last_request, :messenger
   
   # Required options:
@@ -172,69 +120,13 @@ class Webmoney
     reqn = reqn()
     raise ArgumentError unless opt.kind_of?(Hash)
     opt[:wmid] = @wmid if opt[:wmid].nil?
-    x = Builder::XmlMarkup.new(:indent => 1)
-    x.instruct!(:xml, :version=>"1.0", :encoding=>"windows-1251")
-    unless [:get_passport, :bussines_level].include?(iface)
-      x.tag!('w3s.request') do
-        x.wmid @wmid
-        case iface
-          when :check_sign then
-            plan_out = @ic_out.iconv(opt[:plan])
-            x.testsign do 
-              x.wmid opt[:wmid]
-              x.plan { x.cdata! plan_out } 
-              x.sign opt[:sign]
-            end
-            plan = @wmid + opt[:wmid] + plan_out + opt[:sign]
-          when :send_message
-            x.reqn reqn
-            msgsubj = @ic_out.iconv(opt[:subj])
-            msgtext = @ic_out.iconv(opt[:text])
-            x.message do
-              x.receiverwmid opt[:wmid]
-              x.msgsubj { x.cdata! msgsubj }
-              x.msgtext { x.cdata! msgtext }
-            end
-            plan = opt[:wmid] + reqn + msgtext + msgsubj
-        end
-        x.sign sign(plan) if classic?
-      end
-    else
-      case iface
-        when :bussines_level
-          x.tag!('WMIDLevel.request') do
-            x.signerwmid @wmid
-            x.wmid opt[:wmid]
-          end
-        when :get_passport
-          x.request do
-            x.wmid @wmid
-            x.passportwmid opt[:wmid]
-            x.params { x.dict 0; x.info 1; x.mode 0 }
-            x.sign sign(@wmid + opt[:wmid]) if classic?
-          end
-      end
-    end
-    
+
     # Do request
-    res = https_request(iface, x.target!)
-    
+    res = https_request(iface, make_xml(iface, opt))
+
     # Parse response
     parse_retval(res)
-    doc = Hpricot.XML(res)
-    case iface
-      when :check_sign
-        return doc.at('//testsign/res').inner_html == 'yes' ? true : false
-      when :get_passport
-        return Passport.new(doc)
-      when :bussines_level
-        return doc.at('//level').inner_html.to_i
-      when :send_message
-        time = doc.at('//message/datecrt').inner_html
-        m = time.match(/(\d{4})(\d{2})(\d{2}) (\d{2}):(\d{2}):(\d{2})/)
-        time = Time.mktime(*m[1..6])
-        return {:id => doc.at('//message')['id'], :date => time}
-    end
+    make_result(iface, res)
   end
 
   # Signing string by instance wmid's,
@@ -260,7 +152,7 @@ class Webmoney
     if File.file? @ca_cert
       http.ca_file = @ca_cert
     else
-      raise CaCertificateError
+      raise CaCertificateError, @ca_cert
     end
     http.use_ssl = true
     @last_request = xml
@@ -273,7 +165,7 @@ class Webmoney
       else
         @error = result.code
         @errormsg = result.body if result.class.body_permitted?()
-        raise RequestError
+        raise RequestError, [@error, @errormsg].join(' ')
     end
   end
 
@@ -291,7 +183,7 @@ class Webmoney
     unless retval == 0
         @error = retval
         @errormsg = retdesc
-        raise ResultError
+        raise ResultError, [@error, @errormsg].join(' ')
     end
   end
 
@@ -301,5 +193,20 @@ class Webmoney
     t = Time.now
     t.strftime('%Y%m%d%H%M%S') + t.to_f.to_s.match(/\.(\d\d)/)[1]
   end
-    
+
+  def make_xml(iface, opt)            # :nodoc:
+    iface_func = ('xml_'+iface.to_s).to_sym
+    self.send(iface_func, opt).target!
+  rescue NoMethodError
+    raise NotImplementedError, "#{iface_func}()"
+  end
+
+  def make_result(iface, res)         # :nodoc:
+    doc = Hpricot.XML(res)
+    iface_result = ('result_'+iface.to_s).to_sym
+    self.send(iface_result, doc)
+  rescue NoMethodError
+    raise NotImplementedError, "#{iface_result}()"
+  end
+
 end

data/lib/wmid.rb

@@ -6,7 +6,7 @@ class Webmoney
 
     def initialize(str)
       str = str.to_s unless str.kind_of?(String)
-      raise IncorrectWmidError, ': ' + str.to_s unless str =~ /^\d{12}$/
+      raise IncorrectWmidError, str unless str =~ /^\d{12}$/
       super(str)
     end
     

data/rakefile

@@ -4,7 +4,7 @@ require 'rake/clean'
 require 'tools/rakehelp'
 require 'spec/rake/spectask'
 
-GEM_VERSION="0.0.4.3"
+GEM_VERSION="0.0.4.4"
 
 setup_extension('wmsigner', 'wmsigner')
 

data/spec/unit/messenger_spec.rb

@@ -8,16 +8,20 @@ class Webmoney
       @wm = webmoney()                                                                                               
     end
     
-    it "should create instance and send messages" do
+    it "should create instance" do
       @wm.messenger.should be_nil
       @wm.send_message(:wmid => @wm.wmid, :subj => 'FIRST', :text => 'BODY')
       @wm.messenger.should be_instance_of(Messenger)
-      @wm.send_message(:wmid => @wm.wmid, :subj => 'SECOND', :text => 'SECOUND')
-      sleep(3)
     end
     
-    # TODO HOW TEST IT FUNCTIONALITY???
-    
+    it "should call request(:send_message) twice" do
+      params = { :wmid => @wm.wmid, :subj => 'FIRST', :text => 'BODY' }
+      @wm.should_receive(:request).
+        with(:send_message, params).twice().and_return({:test => 'test'})
+      @wm.send_message(params)
+      @wm.send_message(params)
+    end
+
   end
 
 end

data/spec/unit/webmoney_spec.rb

@@ -44,9 +44,9 @@ class Webmoney
     end
 
     it "should parse retval and raise error" do
-      lambda { @wm.request(:create_transaction)}.should raise_error(ResultError)
-      @wm.error.should == -3
-      @wm.errormsg.should match(%r{incorrect value of w3s.request/trans/tranid  is incorrect})
+      lambda { @wm.request(:send_message, :wmid => '')}.should raise_error(ResultError)
+      @wm.error.should == -2
+      @wm.errormsg.should match(%r{value of w3s.request/message/receiverwmid  is incorrect})
     end
 
     it "should sign string" do
@@ -106,6 +106,10 @@ class Webmoney
       ((result[:date] + 60) > Time.now).should be_true
     end
     
+    it "should raise error on undefined xml func" do
+      lambda { @wm.request(:unexistent_interface) }.should raise_error(::NotImplementedError)
+    end
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: webmoney
 version: !ruby/object:Gem::Version 
-  version: 0.0.4.3
+  version: 0.0.4.4
 platform: ruby
 authors: 
 - Alexander Oryol
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-22 00:00:00 +03:00
+date: 2009-03-15 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,6 +47,8 @@ files:
 - README
 - lib/WebMoneyCA.crt
 - lib/messenger.rb
+- lib/request.rb
+- lib/result.rb
 - lib/passport.rb
 - lib/webmoney.rb
 - lib/wmid.rb