payzilla 0.0.2

data/lib/payzilla/gateways.rb

@@ -0,0 +1,173 @@
+require 'rexml/document'
+
+module Payzilla
+  module Gateways
+    class Gateway
+      attr_accessor :config
+      attr_accessor :logger
+      attr_accessor :revision_page_size
+
+      # Creates gateway instance
+      #
+      # @param [Config] config the Payzilla::Config object
+      # @param [String] log path to config file
+      def initialize(config, log=nil)
+        @config = config
+
+        if defined?(Rails) && Rails.root.join('log/gateways').directory?
+          log ||= Rails.root.join("log/gateways/#{@config.keyword}.log")
+        end
+
+        if !log.respond_to?(:info)
+          @logger = Logger.new log.to_s, 2
+          @logger.level = Logger::DEBUG
+          @logger.level = @config.debug_level if @config.respond_to?(:debug_level)
+          @logger.formatter = Logger::Formatter.new
+        end
+
+        @revision_page_size = 5000
+      end
+
+      # Register some settings
+      #
+      # @param [Array] list list of strings, which are settings, defined in Payzilla::Config instance with appendix "setting_"
+      def self.register_settings(list)
+        @available_settings = list
+      end
+
+      # Register some attachments
+      #
+      # @param [Array] list list of strings, which are attachments, defined in Payzilla::Config instance with appendix "attachment_"
+      def self.register_attachments(list)
+        @available_attachments = list
+      end
+
+      # Register some switches
+      #
+      # @param [Array] list list of strings, which are switches, defined in Payzilla::Config instance with appendix "switch_"
+      def self.register_switches(list)
+        @available_switches = list
+      end
+
+      def self.require_payment_fields(list)
+        @required_payment_fields = list
+      end
+
+      def self.required_payment_fields
+        @required_payment_fields || []
+      end
+
+      # Show registered settings
+      #
+      # @return [Array] an array with registered settings
+      def self.available_settings
+        @available_settings || []
+      end
+
+      # Show registered attachments
+      #
+      # @return [Array] an array with registered attachments
+      def self.available_attachments
+        @available_attachments || []
+      end
+
+      # Show registered switches
+      #
+      # @return [Array] an array with registered switches
+      def self.available_switches
+        @available_switches || []
+      end
+
+      # Check if gateway requires revision
+      #
+      # @return [Boolean]
+      def requires_revision?
+        self.class.requires_revision?
+      end
+
+      # Check if gateway requires revision
+      #
+      # @return [Boolean]
+      def self.requires_revision?
+        @requires_revision == true
+      end
+
+      # Require gateway revision
+      def self.requires_revision
+        @requires_revision = true
+      end
+
+      # Check if gateway can list providers
+      def can_list_providers?
+        self.class.can_list_providers?
+      end
+
+      # Check if gateway can list providers
+      def self.can_list_providers?
+        @can_list_providers == true
+      end
+
+      # Set that Gateway can set providers
+      def self.can_list_providers
+        @can_list_providers = true
+      end
+
+      # Send revision to carrier
+      #
+      # @param [Revision] revision an object, created from Payzilla::Revision
+      # @return [String] error code
+      def revise(revision)
+        send_revision revision, generate_revision(revision)[1]
+      end
+
+    protected
+
+      # Paginate payments to avoid memory leaks in case of very lagre number of payments
+      #
+      # @param [Payment] payments payments, that you want to revise
+      # @param args that you need to generate request body
+      # @param block some block, that make operations with args
+      def paginate_payments(payments, *args, &block)
+        totals = {
+          :count        => 0,
+          :enrolled_sum => 0,
+          :paid_sum     => 0
+        }
+
+        if payments.respond_to?(:limit)
+          pages = (payments.count.to_f / revision_page_size.to_f).ceil
+
+          pages.times do |p|
+            slice = payments.offset(p*revision_page_size).limit(revision_page_size)
+
+            yield slice, *args
+
+            totals[:count]        += slice.count
+            totals[:enrolled_sum] += slice.map{|x| x.enrolled_amount}.inject(:+)
+            totals[:paid_sum]     += slice.map{|x| x.paid_amount}.inject(:+)
+          end
+        else
+          yield payments, *args
+
+          totals[:count]        = payments.count
+          totals[:enrolled_sum] = payments.map{|x| x.enrolled_amount}.inject(:+)
+          totals[:paid_sum]     = payments.map{|x| x.paid_amount}.inject(:+)
+        end
+
+        totals
+      end
+
+      # Generates XML dump. Usialy used for logging
+      #
+      # @param [String] text with XML response or request
+      # @return [String] ready to use in logging stringified XML
+      def dump_xml(text)
+        xml = ""
+        doc = REXML::Document.new(text)
+        doc.write(xml, 1)
+        xml = "XML DUMP\n#{'-'*30}\n#{xml}\n#{'-'*30}"
+        xml
+      end
+    end
+  end
+end

data/lib/payzilla/payment.rb

@@ -0,0 +1,161 @@
+module Payzilla
+  class Payment
+
+    # @!attribute id
+    #   Paymen identifier
+    #
+    #   Used by:
+    #   * Akado
+    #   * Beeline
+    #   * Cyberplat
+    #   * Mailru
+    #   * Matrix
+    #   * Megafon
+    #   * MTS
+    #   * OSMP
+    #   * Rapida
+    #   * Skylink
+    #   * Webmoney
+    #   * Yamoney
+    #   * Yota
+    #   @note Should be unique for each paymet (For example current time plus some salt)
+    #
+    # @!attribute account
+    #   Account, which you need to replenish
+    #
+    #   Used by:
+    #   * Akado
+    #   * Beeline
+    #   * Cyberplat
+    #   * Matrix
+    #   * Megafon
+    #   * MTS
+    #   * OSMP
+    #   * Skylink
+    #   * Yamoney
+    #   * Yota
+    #
+    # @!attribute created_at
+    #   Paymend creatiton date
+    #
+    #   Used by:
+    #   * Akado. Format: YYYY-MM-DD HH24:MI:SS by Moscow local time
+    #   * Beeline
+    #   * Matrix. Format: YYYY-MM-DD HH24:MI:SS by Moscow local time
+    #   * Megafon
+    #   * MTS
+    #   * Skylink
+    #   * Yota. Format: YYYY-MM-DDTHH24:MI:SS by  Moscow local time
+    #   @note If in this list format is missing, than you can use default DateTime.now without any formating
+    #
+    # @!attribute enrolled_amount
+    #   Amount of money, that client will recieve
+    #
+    #   Used by:
+    #   * Akado. Format: 100.00
+    #   * Beeline
+    #   * Cyberplat
+    #   * Mailru
+    #   * Matrix
+    #   * Megafon
+    #   * MTS. Format: 100.00
+    #   * OSMP
+    #   * Rapida
+    #   * Skylink
+    #   * Webmoney
+    #   * Yamoney
+    #   @note Missing format in this list mens, that you should use integer value without coins
+    #
+    # @!attribute paid_amount
+    #   Amount of money, that client put into kiosk
+    #
+    #   Used by:
+    #   * Beeline
+    #   * OSMP
+    #   * Skylink
+    #
+    # @!attribute discount_card
+    #   Client's discount card
+    #
+    #   Used by:
+    #   * Beeline _optional_
+    #
+    # @!attribute subagent_id
+    #   Subagent identifier
+    #
+    #   Used by:
+    #   * Beeline. _optional_
+    #
+    # @!attribute fields
+    #   Additional params, that can be passed into payment
+    #
+    #   Used by:
+    #   * Cyberplat
+    #   * Rapida
+    #   * Webmoney
+    #     * phone - account, you need to pay to
+    #     * purse - currency
+    #     * name  - your name
+    #     * passport_serie
+    #     * passport_date
+    #
+    # @!attribute agent_id
+    #   Agent identifier
+    #
+    #   Used by:
+    #   * Cyberplat
+    #
+    # @!attribute terminal_id
+    #   Terminal identifier
+    #
+    #   Used by:
+    #   * Cyberplat
+    #   * MTS
+    #   * Rapida
+    #
+    # @!attribute gateway_payment_id
+    #   Gateway payment idetifier. You can get it by parsing response of check method
+    #
+    #   Used by:
+    #   * Matrix
+    #   * MTS
+    #
+    # @!attribute gateway_provider_id
+    #   Gateway provider identifier
+    #
+    #   Used by:
+    #   * MTS
+    #   * OSMP
+    #   * Rapida
+    #
+    # @!attribute commision_amount
+    #   Amount of commision, that would be subtracted from enrolled amount
+    #
+    #   Used by:
+    #   * Rapida
+    #
+    # @!attribute payment_type
+    #   Chose payment type. On the left side is 'what you want', and on the right - what you should pass
+    #   * Cash         | self::TYPE_CASH
+    #   * Inner card   | self::TYPE_INNER_CARD
+    #   * Foreign card | self::TYPE_FOREIGN_CARD
+    #   * Bank account | self::TYPE_IBANK
+    #   * Account      | self::TYPE_ACCOUNT
+    attr_accessor :id, :account, :created_at, :enrolled_amount,
+                  :paid_amount, :terminal_id, :gateway_provider_id,
+                  :discount_card, :subagent_id, :agent_id, :fields,
+                  :commission_amount, :payment_type
+
+    TYPE_CASH         = 0
+    TYPE_INNER_CARD   = 1
+    TYPE_FOREIGN_CARD = 2
+    TYPE_IBANK        = 3
+    TYPE_ACCOUNT      = 4
+
+    def initialize(args={})
+      payment_type = self::TYPE_CASH
+
+      args.each{|k,v| send "#{k}=", v}
+    end
+  end
+end

data/lib/payzilla/revision.rb

@@ -0,0 +1,18 @@
+module Payzilla
+  class Revision
+
+    # @!attribute payments
+    #   Array of instances of Payzilla::Payment
+    #
+    # @!attribute date
+    #   Simple date instance, for example Date.today
+    #
+    # @!attribute id
+    #   Some unique revision identifier
+    attr_accessor :payments, :date, :id
+
+    def initialize(args={})
+      args.each{|k,v| send "#{k}=", v}
+    end
+  end
+end

data/lib/payzilla/transports/http.rb

@@ -0,0 +1,62 @@
+require 'rest-client'
+
+module Payzilla
+  module Transports
+    module HTTP
+      # Generate new RestClient resource
+      #
+      # @param [String] url carrier's server url
+      # @param [Hash] attributes additional attributes such as ssl certificate and keys
+      # @return [RestClient::Resource] resource, where you can send payment data with GET or POST methods
+      def resource(url, attributes)
+        RestClient::Resource.new url, attributes
+      end
+
+      # Send data via GET method
+      #
+      # @param [String] url carrier's server url
+      # @param [Hash] params data, which would be sent
+      # @param [Hash] attributes additional attributes such as ssl certificate and keys
+      # @return [String] server response
+      def get(url, params, attributes={})
+        logger.info "GET #{url}: #{params.inspect}" unless logger.blank?
+        logger.debug attributes.inspect unless logger.blank?
+        resource(url, attributes).get(:params => params).to_s
+      end
+
+      # Send data via POST method
+      #
+      # @param [String] url carrier's server url
+      # @param [Hash] params data, which would be sent
+      # @param [Hash] attributes additional attributes such as ssl certificate and keys
+      # @return [String] server response
+      def post(url, params, attributes={}, headers={})
+        logger.info "POST #{url}: #{params.inspect}" unless logger.blank?
+        logger.debug attributes.inspect unless logger.blank?
+        resource(url, attributes).post(params, headers).to_s
+      end
+
+      # Prepare SSL data to be sent
+      #
+      # @param [File] cert certificate file, that you should use to access to secure host
+      # @param [File] key key file, that you need to use to access to secure host
+      # @param [String] password password that used to read encrypted key file
+      # @param [File] ca certificate authority file, if it is needed
+      def ssl(cert, key, password, ca=false)
+        ssl = {
+          :ssl_client_cert  =>  OpenSSL::X509::Certificate.new(File.read cert.path),
+          :verify_ssl       =>  OpenSSL::SSL::VERIFY_NONE
+        }
+
+        unless password.blank?
+          ssl[:ssl_client_key] = OpenSSL::PKey::RSA.new(File.read(key.path), password)
+        else
+          ssl[:ssl_client_key] = OpenSSL::PKey::RSA.new(File.read(key.path))
+        end
+        ssl[:ssl_ca_file] = ca.path unless ca.blank?
+
+        ssl
+      end
+    end
+  end
+end

data/lib/payzilla/utils/string_file.rb

@@ -0,0 +1,14 @@
+require 'stringio'
+
+module Payzilla
+  module Utils
+    class StringFile < StringIO
+      attr_accessor :path
+
+      def initialize(filename, content)
+        self.path = filename
+        super content
+      end
+    end
+  end
+end

data/lib/payzilla/version.rb

@@ -0,0 +1,3 @@
+module Payzilla
+  VERSION = "0.0.2"
+end

data/lib/payzilla.rb

@@ -0,0 +1,19 @@
+require 'payzilla/version'
+require 'payzilla/payment'
+require 'payzilla/revision'
+require 'payzilla/gateways'
+require 'payzilla/transports/http'
+require 'payzilla/utils/string_file'
+require 'encoding/converter.rb' if RUBY_PLATFORM =~ /java/
+require 'string.rb'
+
+Dir["#{File.dirname(__FILE__)}/payzilla/gateways/*.rb"].each do |gateway|
+  begin
+    require gateway
+  rescue Exception => e
+    puts "WARNING: #{File.basename(gateway)} was not loaded: #{e}"
+  end
+end
+
+module Payzilla
+end

data/lib/string.rb

@@ -0,0 +1,12 @@
+String.class_eval do
+  # Changes case of the string into lowerCamelCase.
+  #
+  # @return [String] in lowerCamelCase style.
+  def lower_camelcase
+    str = dup
+    str.gsub!(/\/(.?)/) { "::#{$1.upcase}" }
+    str.gsub!(/(?:_+|-+)([a-z])/) { $1.upcase }
+    str.gsub!(/(\A|\s)([A-Z])/) { $1 + $2.downcase }
+    str
+  end
+end

data/payzilla.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'payzilla/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "payzilla"
+  gem.version       = Payzilla::VERSION
+  gem.authors       = ["Boris Staal", "Vasilij Melnychuck"]
+  gem.email         = ["boris@roundlake.ru", "v.melnychuck@roundlake.ru"]
+  gem.description   = %q{Payzilla}
+  gem.summary       = %q{Payzilla}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'rake'
+  gem.add_dependency 'json'
+  gem.add_dependency 'rest-client'
+  gem.add_dependency 'crack'
+  gem.add_dependency 'savon'
+  gem.add_dependency 'cyberplat_pki'
+  gem.add_dependency 'webmoney', '0.0.15.pre'
+  gem.add_dependency 'gyoku'
+  gem.add_dependency 'gpgme-ffi'
+
+  ['pry', 'rspec'].each do |dep|
+    gem.add_development_dependency(dep)
+  end
+end