webmoney 0.0.4.2 → 0.0.4.3

data/ChangeLog

@@ -1,5 +1,12 @@
 ChangeLog
 
+Thu Jan 22 2009 14:00:00 +0400
+----------------------------
+  V 0.0.4.3
+  * Move Webmoney#sign to public methods
+  * Add gemspec
+  * Add more rdoc
+
 Tue Oct 14 2008 18:46:50 +0400
 ----------------------------
   V 0.0.4.2

data/README

@@ -0,0 +1,11 @@
+README
+
+For run tests create ~/.wm/config.yml file:
+
+common:
+  type: classic
+  wmid: '123456789012'
+  key: 'gQABAIR6... YOUR BASE64-KEY (see wmsigner readme) ...2cC8FZTyKyjBM='
+  password: _your_password_
+
+and type: rake spec

data/lib/messenger.rb

@@ -1,4 +1,3 @@
-require 'iconv'
 require 'thread'
 
 class Webmoney

data/lib/webmoney.rb

@@ -1,3 +1,66 @@
+=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'
@@ -7,15 +70,9 @@ require 'iconv'
 require 'builder'
 require 'hpricot'
 
-class Object
-  def blank?
-    respond_to?(:empty?) ? empty? : !self
-  end
-end
-
 # Main class for Webmoney lib. Instance contain info
-# for Webmoney interfaces requests (wmid, key, etc). 
-# Implement base requests to Webmoney.
+# for WMT-interfaces requests (wmid, key, etc).
+# Implement general requests.
 class Webmoney
 
   # Error classes
@@ -32,14 +89,20 @@ class Webmoney
   attr_reader :wmid, :error, :errormsg, :last_request, :messenger
   
   # Required options:
-  # :wmid (WMID)
-  # :password (on Classic key or Light X509 certtificate & key)
-  # :key (Base64 string for Classic key) 
-  # OR TODO!
-  # :key (OpenSSL::PKey::RSA or OpenSSL::PKey::DSA object) AND
-  # :cert OpenSSL::X509::Certificate object
+  #
+  # - :wmid - WMID
+  # - :password - on Classic key or Light X509 certificate & key
+  # - :key - Base64 string for Classic key
+  #
+  # OR
+  # #TODO
+  # - :key - OpenSSL::PKey::RSA or OpenSSL::PKey::DSA object
+  # - :cert - OpenSSL::X509::Certificate object
+  #
   # Optional:
-  # :ca_cert (path of a CA certification file in PEM format)
+  #
+  # - :ca_cert - path of a CA certification file in PEM format
+
   def initialize(opt = {})
     @wmid = Wmid.new(opt[:wmid])
     
@@ -76,7 +139,7 @@ class Webmoney
       'incoming_invoices' => URI.parse( w3s + 'XMLInInvoices.asp'), # x10
       'get_passport' => URI.parse( 'https://passport.webmoney.ru/asp/XMLGetWMPassport.asp'), # x11
       'reject_protection' => URI.parse( w3s + 'XMLRejectProtect.asp'), # x13
-      'transaction_moneyback' => URI.parse( w3s + 'XMLTransMoneyback.asp'), # 14
+      'transaction_moneyback' => URI.parse( w3s + 'XMLTransMoneyback.asp'), # x14
       'i_trust'  => URI.parse( w3s + 'XMLTrustList.asp'), # x15
       'trust_me'  => URI.parse( w3s + 'XMLTrustList2.asp'), # x15
       'trust_save'  => URI.parse( w3s + 'XMLTrustSave2.asp'), # x15
@@ -87,21 +150,24 @@ class Webmoney
     @ic_in = Iconv.new('UTF-8', 'CP1251')
     @ic_out = Iconv.new('CP1251', 'UTF-8')
   end
-  
+
+  # Webmoney instance is classic type?
+
   def classic?
     ! @signer.nil?
   end
   
   # Send message through Queue and Thread
-  # Params - :wmid, :subj, :text
+  #
+  # Params: { :wmid, :subj, :text }
+
   def send_message(params)
     @messenger = Messenger.new(self) if @messenger.nil?
     @messenger.push(params)
   end
   
-  # ================================================
-  # Main interface function
-  # ================================================
+  # Generic function for request to WMT-interfaces
+
   def request(iface, opt ={})
     reqn = reqn()
     raise ArgumentError unless opt.kind_of?(Hash)
@@ -150,7 +216,7 @@ class Webmoney
       end
     end
     
-    # Request do!
+    # Do request
     res = https_request(iface, x.target!)
     
     # Parse response
@@ -170,16 +236,18 @@ class Webmoney
         return {:id => doc.at('//message')['id'], :date => time}
     end
   end
-  
-  protected
 
-  # Signing string by instance wmid's
-  # Return signed string
+  # Signing string by instance wmid's,
+  # return signed string
+
   def sign(str)
-    @signer.sign(str) unless str.blank?
+    @signer.sign(str) unless str.nil? || str.empty?
   end
-    
+
+  protected
+
   # Make HTTPS request, return result body if 200 OK
+
   def https_request(iface, xml)
     url = case iface
       when Symbol
@@ -209,7 +277,7 @@ class Webmoney
     end
   end
 
-  def parse_retval(response_xml)
+  def parse_retval(response_xml)         # :nodoc:
     doc = Hpricot.XML(response_xml)
     retval_element = doc.at('//retval')
     # Workaround for passport interface
@@ -227,8 +295,8 @@ class Webmoney
     end
   end
 
-  # Create unique Request Number based on time
-  # Return 16 digits string
+  # Create unique Request Number based on time,
+  # return 16 digits string
   def reqn
     t = Time.now
     t.strftime('%Y%m%d%H%M%S') + t.to_f.to_s.match(/\.(\d\d)/)[1]

data/lib/wmid.rb

@@ -1,7 +1,9 @@
 # Support class
 class Webmoney
   class Wmid < String
-    
+
+    # Parameter: wmid - String or Wmid
+
     def initialize(str)
       str = str.to_s unless str.kind_of?(String)
       raise IncorrectWmidError, ': ' + str.to_s unless str =~ /^\d{12}$/

data/rakefile

@@ -1,11 +1,10 @@
 require 'rubygems'
 require 'rake'
 require 'rake/clean'
-require 'rake/gempackagetask'
 require 'tools/rakehelp'
 require 'spec/rake/spectask'
 
-GEM_VERSION="0.0.4.2"
+GEM_VERSION="0.0.4.3"
 
 setup_extension('wmsigner', 'wmsigner')
 
@@ -36,6 +35,7 @@ gemspec = Gem::Specification.new do |gemspec|
   gemspec.require_path = 'lib'
   gemspec.add_dependency('hpricot')
   gemspec.add_dependency('builder')
+  gemspec.add_dependency('iconv')
 
   if RUBY_PLATFORM.match("win32")
     gemspec.platform = Gem::Platform::WIN32
@@ -46,18 +46,5 @@ gemspec = Gem::Specification.new do |gemspec|
   end
 end
 
-task :package => [:clean, :compile, :spec]
-Rake::GemPackageTask.new( gemspec ) do |task|
-  task.gem_spec = gemspec
-  task.need_tar = true
-end
-
-setup_clean ["ext/wmsigner/*.{so,o}", "ext/wmsigner/Makefile", "lib/wmsigner.so", "pkg", "*.gem"]
+CLEAN.include ["ext/wmsigner/*.{so,o}", "ext/wmsigner/Makefile", "lib/wmsigner.so", "pkg", "*.gem"]
 
-task :install => [:default, :package] do
-  sh %{ sudo gem install pkg/webmoney-#{GEM_VERSION}.gem }
-end
-
-task :uninstall do
-  sh %{ sudo gem uninstall webmoney }
-end

data/spec/unit/passport_spec.rb

@@ -8,7 +8,7 @@ class Webmoney
       @wm = webmoney()                                                                                               
     end
     
-    def make_request(wmid=nil)
+    def make_request(wmid=nil)      #   :nodoc:
       test_wmid = wmid || @wm.wmid
       x = Builder::XmlMarkup.new
       x.request do

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: webmoney
 version: !ruby/object:Gem::Version 
-  version: 0.0.4.2
+  version: 0.0.4.3
 platform: ruby
 authors: 
 - Alexander Oryol
-autorequire: webmoney
+autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-10-14 00:00:00 +04:00
+date: 2009-01-22 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -38,42 +38,37 @@ executables: []
 
 extensions: 
 - ext/wmsigner/extconf.rb
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- ChangeLog
+- README
 files: 
 - rakefile
 - ChangeLog
+- README
 - lib/WebMoneyCA.crt
 - lib/messenger.rb
 - lib/passport.rb
-- lib/wmid.rb
 - lib/webmoney.rb
-- spec/spec_helper.rb
-- spec/unit/time_spec.rb
-- spec/unit/signer_spec.rb
-- spec/unit/messenger_spec.rb
-- spec/unit/passport_spec.rb
-- spec/unit/webmoney_spec.rb
-- spec/unit/wmid_spec.rb
-- ext/wmsigner/md4.h
+- lib/wmid.rb
+- ext/wmsigner/extconf.rb
+- ext/wmsigner/base64.cpp
+- ext/wmsigner/base64.h
+- ext/wmsigner/cmdbase.cpp
 - ext/wmsigner/cmdbase.h
+- ext/wmsigner/crypto.cpp
 - ext/wmsigner/crypto.h
-- ext/wmsigner/signer.h
-- ext/wmsigner/base64.h
+- ext/wmsigner/md4.cpp
+- ext/wmsigner/md4.h
+- ext/wmsigner/rsalib1.cpp
 - ext/wmsigner/rsalib1.h
+- ext/wmsigner/signer.cpp
+- ext/wmsigner/signer.h
+- ext/wmsigner/stdafx.cpp
 - ext/wmsigner/stdafx.h
-- ext/wmsigner/base64.cpp
-- ext/wmsigner/rsalib1.cpp
-- ext/wmsigner/md4.cpp
 - ext/wmsigner/wmsigner.cpp
-- ext/wmsigner/cmdbase.cpp
-- ext/wmsigner/crypto.cpp
-- ext/wmsigner/stdafx.cpp
-- ext/wmsigner/signer.cpp
-- ext/wmsigner/extconf.rb
 - tools/rakehelp.rb
-has_rdoc: false
-homepage: 
+has_rdoc: true
+homepage: http://github.com/eagleas/webmoney
 post_install_message: 
 rdoc_options: []
 
@@ -93,10 +88,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.2.0
+rubyforge_project: webmoney
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: Webmoney interfaces and native wmsigner
-test_files: []
-
+test_files: 
+- spec/spec_helper.rb
+- spec/unit/messenger_spec.rb
+- spec/unit/passport_spec.rb
+- spec/unit/signer_spec.rb
+- spec/unit/time_spec.rb
+- spec/unit/webmoney_spec.rb
+- spec/unit/wmid_spec.rb