payments-pl 0.4.1 → 0.4.2

data/doc/top-level-namespace.html

@@ -79,7 +79,7 @@
 </div>
     
     <div id="footer">
-  Generated on Tue Aug 17 16:13:28 2010 by 
+  Generated on Wed Aug 18 22:12:45 2010 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
   0.5.8 (ruby-1.8.7).
 </div>

data/lib/payments/pos.rb

@@ -4,6 +4,9 @@ module Payments
   class Pos
     attr_reader :pos_id, :pos_auth_key, :key1, :key2, :type, :encoding
 
+    # Creates new Pos instance
+    # @param [Hash] options options hash
+    # @return [Object] Pos object
     def initialize(options)
       options.symbolize_keys!
 
@@ -11,10 +14,20 @@ module Payments
       @pos_auth_key = options[:pos_auth_key]
       @key1         = options[:key1]
       @key2         = options[:key2]
-      @type         = options[:type] || 'express_gateway'
+      @type         = options[:type] || 'default'
       @encoding     = options[:encoding] || 'UTF'
+
+      raise PosInvalid.new('Missing pos_id parameter') if @pos_id.blank?
+      raise PosInvalid.new('Missing pos_auth_key parameter') if @pos_auth_key.blank?
+      raise PosInvalid.new('Missing key1 parameter') if @key1.blank?
+      raise PosInvalid.new('Missing key2 parameter') if @key2.blank?
+      raise PosInvalid.new("Invalid type parameter, expected one of these: #{Payments::POS_TYPES.join(', ')}") unless Payments::POS_TYPES.include?(@type)
+      raise PosInvalid.new("Invalid encoding parameter, expected one of these: #{Payments::ENCODINGS.join(', ')}") unless Payments::ENCODINGS.include?(@encoding)
     end
 
+    # Creates new transaction
+    # @param [Hash] options options hash for new transaction
+    # @return [Object] Transaction object
     def new_transaction(options = {})
       options.stringify_keys!
 
@@ -25,16 +38,30 @@ module Payments
       Transaction.new(options)
     end
 
+    # Returns new transaction url, depending on Pos type
+    # @return [String] new transaction url
     def new_transaction_url
-      if @type == 'express_gateway'
-        return "https://www.platnosci.pl/paygw/#{@encoding}/NewPayment"
-      elsif @type == 'sms_premium'
+      if @type == 'sms_premium'
         return "https://www.platnosci.pl/paygw/#{@encoding}/NewSMS"
       else
-        return nil
+        return "https://www.platnosci.pl/paygw/#{@encoding}/NewPayment"
       end
     end
 
+    def get(session_id)
+      send_request(:get, session_id)
+    end
+
+    def confirm(session_id)
+      send_request(:confirm, session_id)
+    end
+
+    def cancel(session_id)
+      send_request(:cancel, session_id)
+    end
+    
+    protected
+
     def path_for(method)
       case method
       when :get then "/paygw/#{@encoding}/Payment/get/txt"
@@ -58,18 +85,6 @@ module Payments
       return sig == t.trans_sig
     end
 
-    def get(session_id)
-      send_request(:get, session_id)
-    end
-
-    def confirm(session_id)
-      send_request(:confirm, session_id)
-    end
-
-    def cancel(session_id)
-      send_request(:cancel, session_id)
-    end
-
     def send_request(method, session_id)
       url = path_for(method)
       data = prepare_data(session_id)

data/lib/payments/transaction.rb

@@ -34,10 +34,14 @@ module Payments
     column :sig,            :string
     column :ts,             :string
 
+    # Returns Pos object for current transaction
+    # @return [Object] Pos object
     def pos
       Payments[pos_id]
     end
 
+    # Returns url for new payment, used in payment form
+    # @return [String] new payment url
     def new_url
       pos.new_transaction_url
     end

data/lib/payments_pl.rb

@@ -43,29 +43,50 @@ module Payments
     999 => 'Inny błąd krytyczny - prosimy o kontakt'
   }
 
+  POS_TYPES = ['default', 'sms_premium']
+  ENCODINGS = ['ISO', 'WIN', 'UTF']
+
   @@pos_table = {}
 
   class SignatureInvalid < StandardError; end
   class PosNotFound < StandardError; end
   class RequestFailed < StandardError; end
+  class PosInvalid < StandardError; end
 
   class << self
+
+    # Loads payments.yml file and creates specified Pos objects
     def init
-      config = YAML.load_file(File.join(RAILS_ROOT, 'config', 'payments.yml'))
-      config.each do |k, v|
-        pos = Pos.new(v)
-        @@pos_table[k] = pos
+      filename = File.join(Rails.root, 'config', 'payments.yml')
+      if File.exist?(filename)
+        config = YAML.load_file(filename)
+        config.each do |k, v|
+          pos = Pos.new(v)
+          @@pos_table[k] = pos
+        end
       end
     end
 
+    # Combined accessor, returns Pos object with given pos_id or name
+    #
+    # @param [String, Integer] name_or_id name or pos_id of Pos
+    # @return [Object] the Pos object
     def [](name_or_id)
       get_pos_by_name(name_or_id) || get_pos_by_id(name_or_id) || raise(PosNotFound)
     end
 
+    # Returns Pos object with given name, the same as in payments.yml file
+    #
+    # @param [String] name name of Pos
+    # @return [Object] the Pos object
     def get_pos_by_name(name)
       @@pos_table[name]
     end
 
+    # Returns Pos object with given pos_id, the same as in payments.yml file
+    #
+    # @param [Integer] id pos_id of Pos
+    # @return [Object] the Pos object
     def get_pos_by_id(id)
       id = id.to_i
       @@pos_table.each do |k, v|
@@ -74,6 +95,10 @@ module Payments
       nil
     end
 
+    # Returns error explanation for given error code
+    #
+    # @param [Integer] error_code
+    # @return [String] string with error message
     def error_text(error_code)
       ERRORS[error_code.to_i]
     end
@@ -81,4 +106,4 @@ module Payments
 end
 
 Payments.init
-ActionView::Base.send(:include, Payments::ViewHelpers)
+ActionView::Base.send(:include, Payments::ViewHelpers)

data/payments-pl.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{payments-pl}
-  s.version = "0.4.1"
+  s.version = "0.4.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Micha\305\202 M\305\202o\305\272niak"]
-  s.date = %q{2010-08-17}
+  s.date = %q{2010-08-18}
   s.description = %q{Simple library for payments via platnosci.pl}
   s.email = %q{m.mlozniak@gmail.com}
   s.extra_rdoc_files = [
@@ -19,12 +19,56 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
      ".gitignore",
+     ".yardoc/checksums",
+     ".yardoc/objects/Payments.dat",
+     ".yardoc/objects/Payments/ENCODINGS.dat",
+     ".yardoc/objects/Payments/ERRORS.dat",
+     ".yardoc/objects/Payments/POS_TYPES.dat",
+     ".yardoc/objects/Payments/Pos.dat",
+     ".yardoc/objects/Payments/Pos/cancel_i.dat",
+     ".yardoc/objects/Payments/Pos/confirm_i.dat",
+     ".yardoc/objects/Payments/Pos/encoding_i.dat",
+     ".yardoc/objects/Payments/Pos/encrypt_i.dat",
+     ".yardoc/objects/Payments/Pos/get_i.dat",
+     ".yardoc/objects/Payments/Pos/initialize_i.dat",
+     ".yardoc/objects/Payments/Pos/key1_i.dat",
+     ".yardoc/objects/Payments/Pos/key2_i.dat",
+     ".yardoc/objects/Payments/Pos/new_transaction_i.dat",
+     ".yardoc/objects/Payments/Pos/new_transaction_url_i.dat",
+     ".yardoc/objects/Payments/Pos/parse_response_body_i.dat",
+     ".yardoc/objects/Payments/Pos/path_for_i.dat",
+     ".yardoc/objects/Payments/Pos/pos_auth_key_i.dat",
+     ".yardoc/objects/Payments/Pos/pos_id_i.dat",
+     ".yardoc/objects/Payments/Pos/prepare_data_i.dat",
+     ".yardoc/objects/Payments/Pos/send_request_i.dat",
+     ".yardoc/objects/Payments/Pos/type_i.dat",
+     ".yardoc/objects/Payments/Pos/verify_i.dat",
+     ".yardoc/objects/Payments/PosInvalid.dat",
+     ".yardoc/objects/Payments/PosNotFound.dat",
+     ".yardoc/objects/Payments/RequestFailed.dat",
+     ".yardoc/objects/Payments/SignatureInvalid.dat",
+     ".yardoc/objects/Payments/Transaction.dat",
+     ".yardoc/objects/Payments/Transaction/column_c.dat",
+     ".yardoc/objects/Payments/Transaction/columns_c.dat",
+     ".yardoc/objects/Payments/Transaction/new_url_i.dat",
+     ".yardoc/objects/Payments/Transaction/pos_i.dat",
+     ".yardoc/objects/Payments/ViewHelpers.dat",
+     ".yardoc/objects/Payments/ViewHelpers/transaction_hidden_fields_i.dat",
+     ".yardoc/objects/Payments/_40_40pos_table.dat",
+     ".yardoc/objects/Payments/_5B_5D_c.dat",
+     ".yardoc/objects/Payments/error_text_c.dat",
+     ".yardoc/objects/Payments/get_pos_by_id_c.dat",
+     ".yardoc/objects/Payments/get_pos_by_name_c.dat",
+     ".yardoc/objects/Payments/init_c.dat",
+     ".yardoc/objects/root.dat",
+     ".yardoc/proxy_types",
      "LICENSE",
      "README.rdoc",
      "Rakefile",
      "VERSION",
      "doc/Payments.html",
      "doc/Payments/Pos.html",
+     "doc/Payments/PosInvalid.html",
      "doc/Payments/PosNotFound.html",
      "doc/Payments/RequestFailed.html",
      "doc/Payments/SignatureInvalid.html",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: payments-pl
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: false
   segments: 
   - 0
   - 4
-  - 1
-  version: 0.4.1
+  - 2
+  version: 0.4.2
 platform: ruby
 authors: 
 - !binary |
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-17 00:00:00 +02:00
+date: 2010-08-18 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -33,12 +33,56 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- .yardoc/checksums
+- .yardoc/objects/Payments.dat
+- .yardoc/objects/Payments/ENCODINGS.dat
+- .yardoc/objects/Payments/ERRORS.dat
+- .yardoc/objects/Payments/POS_TYPES.dat
+- .yardoc/objects/Payments/Pos.dat
+- .yardoc/objects/Payments/Pos/cancel_i.dat
+- .yardoc/objects/Payments/Pos/confirm_i.dat
+- .yardoc/objects/Payments/Pos/encoding_i.dat
+- .yardoc/objects/Payments/Pos/encrypt_i.dat
+- .yardoc/objects/Payments/Pos/get_i.dat
+- .yardoc/objects/Payments/Pos/initialize_i.dat
+- .yardoc/objects/Payments/Pos/key1_i.dat
+- .yardoc/objects/Payments/Pos/key2_i.dat
+- .yardoc/objects/Payments/Pos/new_transaction_i.dat
+- .yardoc/objects/Payments/Pos/new_transaction_url_i.dat
+- .yardoc/objects/Payments/Pos/parse_response_body_i.dat
+- .yardoc/objects/Payments/Pos/path_for_i.dat
+- .yardoc/objects/Payments/Pos/pos_auth_key_i.dat
+- .yardoc/objects/Payments/Pos/pos_id_i.dat
+- .yardoc/objects/Payments/Pos/prepare_data_i.dat
+- .yardoc/objects/Payments/Pos/send_request_i.dat
+- .yardoc/objects/Payments/Pos/type_i.dat
+- .yardoc/objects/Payments/Pos/verify_i.dat
+- .yardoc/objects/Payments/PosInvalid.dat
+- .yardoc/objects/Payments/PosNotFound.dat
+- .yardoc/objects/Payments/RequestFailed.dat
+- .yardoc/objects/Payments/SignatureInvalid.dat
+- .yardoc/objects/Payments/Transaction.dat
+- .yardoc/objects/Payments/Transaction/column_c.dat
+- .yardoc/objects/Payments/Transaction/columns_c.dat
+- .yardoc/objects/Payments/Transaction/new_url_i.dat
+- .yardoc/objects/Payments/Transaction/pos_i.dat
+- .yardoc/objects/Payments/ViewHelpers.dat
+- .yardoc/objects/Payments/ViewHelpers/transaction_hidden_fields_i.dat
+- .yardoc/objects/Payments/_40_40pos_table.dat
+- .yardoc/objects/Payments/_5B_5D_c.dat
+- .yardoc/objects/Payments/error_text_c.dat
+- .yardoc/objects/Payments/get_pos_by_id_c.dat
+- .yardoc/objects/Payments/get_pos_by_name_c.dat
+- .yardoc/objects/Payments/init_c.dat
+- .yardoc/objects/root.dat
+- .yardoc/proxy_types
 - LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
 - doc/Payments.html
 - doc/Payments/Pos.html
+- doc/Payments/PosInvalid.html
 - doc/Payments/PosNotFound.html
 - doc/Payments/RequestFailed.html
 - doc/Payments/SignatureInvalid.html