moneta-api 1.0.0

data/lib/moneta/api/responses/authorise_transaction_batch_response.rb

@@ -0,0 +1,17 @@
+module Moneta
+  module Api
+    module Responses
+      # Ответ на запрос регистрации операций в пакетном режиме.
+      # Transactions authorisation response in batch processing mode.
+
+      class AuthoriseTransactionBatchResponse
+        include Moneta::Api::DataMapper
+
+        # @return [Array[Moneta::Api::Types::OperationInfoBatchResponseType]] Детали проведенных операций, либо описание ошибок, если операция не проведена.
+        #   Порядок соответствует набору операций, переданных в AuthoriseTransactionBatchRequest.
+        #   / Either transaction details or error description in order of appearance in corresponding request.
+        property :transaction, Moneta::Api::Types::OperationInfoBatchResponseType
+      end
+    end
+  end
+end

data/lib/moneta/api/responses/authorise_transaction_response.rb

@@ -0,0 +1,10 @@
+module Moneta
+  module Api
+    module Responses
+      # Ответ на запрос регистрации операции.
+      # Transaction authorisation response.
+
+      class AuthoriseTransactionResponse < Types::OperationInfo; end
+    end
+  end
+end

data/lib/moneta/api/responses/cancel_transaction_batch_response.rb

@@ -0,0 +1,17 @@
+module Moneta
+  module Api
+    module Responses
+      # Ответ на запрос CancelTransactionBatchRequest.
+      # Transactions cancelation response in batch processing mode.
+
+      class CancelTransactionBatchResponse
+        include Moneta::Api::DataMapper
+
+        # @return [Array[Moneta::Api::Types::CancelTransactionBatchResponseType]] Детали проведенных операций, либо описание ошибок, если операция не проведена.
+        #   Порядок соответствует набору операций, переданных в CancelTransactionBatchRequest.
+        #   / Either transaction details or error description in order of appearance in corresponding request.
+        property :transaction, Types::CancelTransactionBatchResponseType
+      end
+    end
+  end
+end

data/lib/moneta/api/responses/cancel_transaction_response.rb

@@ -0,0 +1,10 @@
+module Moneta
+  module Api
+    module Responses
+      # Ответ на запрос CancelTransactionRequest.
+      # Transaction cancelation response.
+
+      class CancelTransactionResponse < Types::CancelTransactionResponseType; end
+    end
+  end
+end

data/lib/moneta/api/responses/confirm_transaction_batch_response.rb

@@ -0,0 +1,17 @@
+module Moneta
+  module Api
+    module Responses
+      # Ответ на запрос завершения операций в пакетном режиме.
+      # Transactions confirmation response in batch processing mode.
+
+      class ConfirmTransactionBatchResponse
+        include Moneta::Api::DataMapper
+
+        # @return [Moneta::Api::Types::OperationInfoBatchResponseType] Детали проведенных операций, либо описание ошибок, если операция не проведена.
+        #   Порядок соответствует набору операций, переданных в ConfirmTransactionBatchRequest.
+        #   / Either transaction details or error description in order of appearance in corresponding request.
+        property :transaction, Types::OperationInfoBatchResponseType
+      end
+    end
+  end
+end

data/lib/moneta/api/responses/confirm_transaction_response.rb

@@ -0,0 +1,10 @@
+module Moneta
+  module Api
+    module Responses
+      # Запрос на завершение (подтверждение) операции.
+      # Transaction confirmation request.
+
+      class ConfirmTransactionResponse < Types::OperationInfo; end
+    end
+  end
+end

data/lib/moneta/api/responses/create_account_response.rb

@@ -0,0 +1,19 @@
+module Moneta
+  module Api
+    module Responses
+      class CreateAccountResponse
+        include Moneta::Api::DataMapper
+
+        # @return [String] Номер счета в системе МОНЕТА.РУ
+        #   Account number
+        property :account_id
+
+        def fill(response)
+          @account_id = response
+
+          self
+        end
+      end
+    end
+  end
+end

data/lib/moneta/api/responses/find_account_by_alias_response.rb

@@ -0,0 +1,16 @@
+module Moneta
+  module Api
+    module Responses
+      # Ответ, который приходит на запрос FindAccountByAliasRequest.
+      # В ответе содержится информация по счету.
+      # Account searching by account alias response. Response contains Account information.
+
+      class FindAccountByAliasResponse
+        include Moneta::Api::DataMapper
+
+        # @return [Moneta::Api::Types::AccountInfo]
+        property :account, Moneta::Api::Types::AccountInfo
+      end
+    end
+  end
+end

data/lib/moneta/api/responses/find_account_by_id_response.rb

@@ -0,0 +1,16 @@
+module Moneta
+  module Api
+    module Responses
+      # Ответ, который приходит на запрос FindAccountByIdRequest.
+      # В ответе содержится информация по счету.
+      # Account searching by account number response. Response contains Account information.
+
+      class FindAccountByIdResponse
+        include Moneta::Api::DataMapper
+
+        # @return [Moneta::Api::Types::AccountInfo]
+        property :account, Moneta::Api::Types::AccountInfo
+      end
+    end
+  end
+end

data/lib/moneta/api/responses/find_accounts_list_response.rb

@@ -0,0 +1,15 @@
+module Moneta
+  module Api
+    module Responses
+      class FindAccountsListResponse
+        # Ответ, который содержит список счетов.
+        # Accounts searching response containing the list of accounts.
+
+        include Moneta::Api::DataMapper
+
+        # @return[Array[Moneta::Api::Types::AccountInfo]]
+        property :account, Moneta::Api::Types::AccountInfo
+      end
+    end
+  end
+end

data/lib/moneta/api/responses/find_last_operations_list_response.rb

@@ -0,0 +1,12 @@
+module Moneta
+  module Api
+    module Responses
+      # Ответ на запрос FindLastOperationsListRequest.
+      # В результате возвращается список последних операций.
+      # Transaction searching response.
+      # Result contains last transactions list.
+
+      class FindLastOperationsListResponse < Moneta::Api::Types::OperationInfoList; end
+    end
+  end
+end

data/lib/moneta/api/responses/find_operations_list_response.rb

@@ -0,0 +1,12 @@
+module Moneta
+  module Api
+    module Responses
+      # Ответ на запрос FindOperationsListRequest.
+      # В результате возвращается список операций, разбитый по страницам.
+      # Transaction searching response.
+      # Result contains paged transactions list.
+
+      class FindOperationsListResponse < Types::OperationInfoList; end
+    end
+  end
+end

data/lib/moneta/api/responses/forecast_transaction_response.rb

@@ -0,0 +1,16 @@
+module Moneta
+  module Api
+    module Responses
+    # Ответ на запрос предварительного расчета сумм и комиссий.
+    # Может использоваться для информирования пользователя о приблизительной сумме и комиссии операции.
+    # Фактические значения могут отличаться, если к моменту проведения операции
+    # доступны новые правила тарификации или новые курсы обмена валют.
+    # Response for preliminary calculation request.
+    # May be used for informing users with approximate amount and fee of transaction.
+    # Actual values may differ if newer financial rules and currency exchange rates
+    # are available at the moment of transaction processing.
+
+      class ForecastTransactionResponse < Types::ForecastTransactionResponseType; end
+    end
+  end
+end

data/lib/moneta/api/responses/get_account_payment_password_challenge_response.rb

@@ -0,0 +1,16 @@
+module Moneta
+  module Api
+    module Responses
+      # Ответ содержит строку запроса для платежного пароля
+      # Response contains of challenge string for payment password
+
+      class GetAccountPaymentPasswordChallengeResponse
+        include Moneta::Api::DataMapper
+
+        # @return [String] Запрос для платежного пароля
+        #   / Challenge of payment password
+        property :payment_password_challenge
+      end
+    end
+  end
+end

data/lib/moneta/api/responses/get_operation_details_by_id_response.rb

@@ -0,0 +1,15 @@
+module Moneta
+  module Api
+    module Responses
+      # Ответ на запрос получения информации по операции.
+      # Transaction information response.
+
+      class GetOperationDetailsByIdResponse
+        include Moneta::Api::DataMapper
+
+        # @return [Moneta::Api::Types::OperationInfo]
+        property :operation, Types::OperationInfo
+      end
+    end
+  end
+end

data/lib/moneta/api/responses/invoice_batch_response.rb

@@ -0,0 +1,17 @@
+module Moneta
+  module Api
+    module Responses
+      # Ответ на выставление счета к оплате в пакетном режиме.
+      # Invoice registration response in batch processing mode.
+
+      class InvoiceBatchResponse
+        include Moneta::Api::DataMapper
+
+        # @return [Moneta::Api::Types::TransactionBatchResponseType] Детали проведенных операций, либо описание ошибок, если операция не проведена.
+        #   Порядок соответствует набору операций, переданных в InvoiceBatchRequest.
+        #   / Either transaction details or error description in order of appearance in corresponding request.
+        property :transaction, Types::TransactionBatchResponseType
+      end
+    end
+  end
+end

data/lib/moneta/api/responses/invoice_response.rb

@@ -0,0 +1,10 @@
+module Moneta
+  module Api
+    module Responses
+      # Ответ на выставление счета к оплате.
+      # Invoice registration response.
+
+      class InvoiceResponse < Types::TransactionResponseType; end
+    end
+  end
+end

data/lib/moneta/api/responses/payment_response.rb

@@ -0,0 +1,10 @@
+module Moneta
+  module Api
+    module Responses
+      # Ответ на запрос перевода денежных средств.
+      # Money transfer registration response.
+
+      class PaymentResponse < Types::OperationInfo; end
+    end
+  end
+end

data/lib/moneta/api/responses/refund_response.rb

@@ -0,0 +1,10 @@
+module Moneta
+  module Api
+    module Responses
+      # Ответ по запросу возврата средств, содержащий информацию по возвратной операции.
+      # Response containing refund transaction information.
+
+      class RefundResponse < Types::OperationInfo; end
+    end
+  end
+end

data/lib/moneta/api/responses/transfer_response.rb

@@ -0,0 +1,9 @@
+module Moneta
+  module Api
+    module Responses
+      # Ответ на запрос перевода денежных средств.
+      # Money transfer registration response.
+      class TransferResponse < Types::TransactionResponseType; end
+    end
+  end
+end

data/lib/moneta/api/responses/verify_payment_response.rb

@@ -0,0 +1,10 @@
+module Moneta
+  module Api
+    module Responses
+      # Ответ на запрос проверки проведения операции в системе МОНЕТА.РУ
+      # Transaction verification response.
+
+      class VerifyPaymentResponse < Moneta::Api::Types::VerifyTransactionResponseType; end
+    end
+  end
+end

data/lib/moneta/api/responses/verify_transaction_response.rb

@@ -0,0 +1,10 @@
+module Moneta
+  module Api
+    module Responses
+      # Ответ на запрос проверки проведения операции в системе МОНЕТА.РУ
+      # Transaction verification response.
+
+      class VerifyTransactionResponse < Moneta::Api::Types::VerifyTransactionResponseType; end
+    end
+  end
+end

data/lib/moneta/api/responses/verify_transfer_response.rb

@@ -0,0 +1,10 @@
+module Moneta
+  module Api
+    module Responses
+      # Ответ на запрос проверки проведения операции в системе МОНЕТА.РУ
+      # Transaction verification response.
+
+      class VerifyTransferResponse < Types::VerifyTransferResponseType; end
+    end
+  end
+end

data/lib/moneta/api/service.rb

@@ -0,0 +1,18 @@
+module Moneta
+  module Api
+    class Service
+      include ServiceMethods
+      attr_reader :client
+
+      def initialize(username, password, params = {})
+        @client = Savon.client(prepare_params(username, password, params))
+      end
+
+      private
+
+      def prepare_params(username, password, params)
+        { wsdl: 'https://demo.moneta.ru/services.wsdl', wsse_auth: [ username, password ] }
+      end
+    end
+  end
+end

data/lib/moneta/api/service_methods.rb

@@ -0,0 +1,150 @@
+module Moneta
+  module Api
+    module ServiceMethods
+      # @param [Moneta::Api::Requests::AuthoriseTransactionRequest]
+      # @return [Moneta::Api::Responses::AuthoriseTransactionResponse]
+      def authorise_transaction(request)
+        call(__method__, request.to_hash)
+      end
+
+      # @param [Moneta::Api::Requests::AuthoriseTransactionBatchRequest]
+      # @return [Moneta::Api::Responses::AuthoriseTransactionBatchResponse]
+      def authorise_transaction_batch(request)
+        call(__method__, request.to_hash)
+      end
+
+      # @param [Moneta::Api::Requests::CancelTransactionRequest]
+      # @return [Moneta::Api::Responses::CancelTransactionResponse]
+      def cancel_transaction(request)
+        call(__method__, request.to_hash)
+      end
+
+      # @param [Moneta::Api::Requests::CancelTransactionBatchRequest]
+      # @return [Moneta::Api::Responses::CancelTransactionBatchResponse]
+      def cancel_transaction_batch(request)
+        call(__method__, request.to_hash)
+      end
+
+      # @param [Moneta::Api::Requests::ConfirmTransactionRequest]
+      # @return [Moneta::Api::Responses::ConfirmTransactionResponse]
+      def confirm_transaction(request)
+        call(__method__, request.to_hash)
+      end
+
+      # @param [Moneta::Api::Requests::ConfirmTransactionBatchRequest]
+      # @return [Moneta::Api::Responses::ConfirmTransactionBatchResponse]
+      def confirm_transaction_batch(request)
+        call(__method__, request.to_hash)
+      end
+
+      # @param [Moneta::Api::Requests::CreateAccountRequest]
+      # @return [Moneta::Api::Responses::CreateAccountResponse]
+      def create_account(request)
+        call(__method__, request.to_hash)
+      end
+
+      # @param [String]
+      # @return [Moneta::Api::Responses::FindAccountByAliasResponse]
+      def find_account_by_alias(request)
+        call(__method__, request)
+      end
+
+      # @param [Moneta::Api::Requests::FindAccountsListRequest]
+      # @return [Moneta::Api::Responses::FindAccountsListResponse]
+      def find_accounts_list(request)
+        call(__method__, request.to_hash)
+      end
+
+      # @param [Moneta::Api::Requests::FindOperationsListRequest]
+      # @return [Moneta::Api::Responses::FindOperationsListResponse]
+      def find_operations_list(request)
+        call(__method__, request.to_hash)
+      end
+
+      # @param [Moneta::Api::Requests::ForecastTransactionRequest]
+      # @return [Moneta::Api::Responses::ForecastTransactionResponse]
+      def forecast_transaction(request)
+        call(__method__, request.to_hash)
+      end
+
+      # @param [Integer]
+      # @return [Moneta::Api::Responses::FindAccountByIdResponse]
+      def find_account_by_id(id)
+        call(__method__, id)
+      end
+
+      # @param [Moneta::Api::Requests::FindLastOperationsListRequest]
+      # @return [Moneta::Api::Responses::FindLastOperationsListResponse]
+      def find_last_operations_list(request)
+        call(__method__, request.to_hash)
+      end
+
+      # @param [Moneta::Api::Requests::GetAccountPaymentPasswordChallengeRequest]
+      # @return [Moneta::Api::Responses::GetAccountPaymentPasswordChallengeResponse]
+      def get_account_payment_password_challenge(request)
+        call(__method__, request.to_hash)
+      end
+
+      # @param [Integer]
+      # @return [Moneta::Api::Responses::GetOperationDetailsByIdResponse]
+      def get_operation_details_by_id(id)
+        call(__method__, id)
+      end
+
+      # @param [Moneta::Api::Requests::InvoiceRequest]
+      # @return [Moneta::Api::Responses::InvoiceResponse]
+      def invoice(request)
+        call(__method__, request.to_hash)
+      end
+
+      # @param [Moneta::Api::Requests::InvoiceBatchRequest]
+      # @return [Moneta::Api::Responses::InvoiceBatchResponse]
+      def invoice_batch(request)
+        call(__method__, request.to_hash)
+      end
+
+      # @param [Moneta::Api::Requests::RefundRequest]
+      # @return [Moneta::Api::Responses::RefundResponse]
+      def refund(request)
+        call(__method__, request.to_hash)
+      end
+
+      # @param [Moneta::Api::Requests::TransferRequest]
+      # @return [Moneta::Api::Responses::TransferResponse]
+      def transfer(request)
+        call(__method__, request.to_hash)
+      end
+
+      # @param [Moneta::Api::Requests::PaymentRequest]
+      # @return [Moneta::Api::Responses::PaymentResponse]
+      def payment(request)
+        call(__method__, request.to_hash)
+      end
+
+      # @param [Moneta::Api::Requests::VerifyPaymentRequest]
+      # @return [Moneta::Api::Responses::VerifyPaymentResponse]
+      def verify_payment(request)
+        call(__method__, request.to_hash)
+      end
+
+      # @param [Moneta::Api::Requests::VerifyTransferRequest]
+      # @return [Moneta::Api::Responses::VerifyTransferResponse]
+      def verify_transfer(request)
+        call(__method__, request.to_hash)
+      end
+
+      # @param [Moneta::Api::Requests::VerifyTransactionRequest]
+      # @return [Moneta::Api::Responses::VerifyTransactionResponse]
+      def verify_transaction(request)
+        call(__method__, request.to_hash)
+      end
+
+      private
+
+      def call(method, request_message)
+        response = client.call(method, { message: request_message })
+        ResponseFactory.build(response)
+      end
+    end
+  end
+end

data/lib/moneta/api/types/account_access_info.rb

@@ -0,0 +1,24 @@
+module Moneta
+  module Api
+    module Types
+      # Тип, описывающий доступ к счету.
+      # Account access description type.
+
+      class AccountAccessInfo
+        include Moneta::Api::DataMapper
+
+        # @return [Boolean] Доступ на изменение свойств счета
+        # / Account attributes modification access
+        property :access_to_write
+
+        # @return [Boolean] Доступ на снятие средств со счета
+        # / Account debiting access
+        property :access_to_taken_out
+
+        # @return [Boolean] Доступ на зачисление средств на счет
+        # / Account crediting access
+        property :access_to_taken_in
+      end
+    end
+  end
+end

data/lib/moneta/api/types/account_info.rb

@@ -0,0 +1,72 @@
+module Moneta
+  module Api
+    module Types
+      # Тип, описывающий атрибуты счета в системе МОНЕТА.РУ.
+      # Account information container type.
+
+      class AccountInfo
+        include Moneta::Api::DataMapper
+
+        # @return [String] Номер счета в системе МОНЕТА.РУ
+        #   / Account number
+        property :id
+
+        # @return [String] Валюта данного счета
+        #   / Currency of account
+        property :currency
+
+        # @return [Float] Баланс на данном счете
+        #   / Current balance of account
+        property :balance
+
+        # @return [Float] Доступный баланс на данном счете
+        #   / Available balance of account
+        property :available_balance
+
+        # @return [Integer] Тип счета в системе МОНЕТА.РУ
+        #   / Type of account
+        property :type
+
+        # @return [String] Название счета в системе МОНЕТА.РУ. Необязательное поле
+        #   / Alias of account. Optional.
+        property :alias
+
+        # @return [String] URL после списания средств. Необязательное поле.
+        #   / URL on debiting. Optional.
+        property :on_successful_debit_url
+
+        # @return [String] URL после зачисления средств. Необязательное поле.
+        #   / URL on crediting. Optional.
+        property :on_successful_credit_url
+
+        # @return [String] Код проверки целостности данных. Необязательное поле.
+        #   / Payment form data integrity signature. Optional.
+        property :signature
+
+        # @return [Float] Если баланс счета меньше данного значения, то раз в сутки уходит уведомление об этом событии. Необязательное поле.
+        #   / Daily notifications if balance is less than threshold. Optional.
+        property :low_balance_threshold
+
+        # @return [Float] Если баланс счета больше данного значения, то раз в сутки уходит уведомление об этом событии. Необязательное поле.
+        #   / Daily notifications if balance is greater than threshold. Optional.
+        property :high_balance_threshold
+
+        # @return [AccountAccessInfo] Информация о доступе к счету. Информация отдается, если счет является делегированным. Необязательное поле.
+        #   / Account access information. Available if the account is delegated, otherwise omitted. Optional.
+        property :account_access, Moneta::Api::Types::AccountAccessInfo
+
+        # @return [Integer] Счет-прототип с которого берутся свойства "по умолчанию". Необязательное поле.
+        #   / Prototype account for default properties values. Optional.
+        property :prototype_account_id
+
+        # @return [String] URL после отмены списания средств. Необязательное поле.
+        #   / URL on cancelled debit. Optional.
+        property :on_cancelled_debit_url
+
+        # @return [String] URL после отмены зачисления средств. Необязательное поле.
+        #   / URL on cancelled credit. Optional.
+        property :on_cancelled_credit_url
+      end
+    end
+  end
+end

data/lib/moneta/api/types/authorise_transaction_batch_request_type.rb

@@ -0,0 +1,47 @@
+module Moneta
+  module Api
+    module Types
+      # Тип, описывающий параметры операции в запросах в пакетном режиме.
+      # Transaction parameters type for requests in batch processing mode.
+
+      class AuthoriseTransactionBatchRequestType < Entity
+        # @return [Boolean] Флаг, указывающий выполнять ли все денежные переводы в одной транзакции.
+        #   Если transactional = true, то:
+        #   при возникновении ошибки все проведенные операции будут отменены
+        #   можно проводить только операции со счетами монеты. Нельзя выводить деньги на внешние платежные системы.
+        #   Если transactional = false, то:
+        #   при возникновении ошибки все проведенные операции будут сохранены
+        #   можно проводить любые операции, которые доступны в TransferRequest
+        #   если выставить флаг exitOnFailure = false, то при возникновении ошибки можно пропустить операцию
+        #   и продолжить выполнение операций дальше
+        #   / Joining all transfers in batch processing into one transaction. True -- all processed transfers will be rolled back on exceptions, no external transfers are allowed. False -- only current transfer rolled back on exceptions, external transfers are allowed.
+        property :transactional
+
+        # @return [Boolean] Флаг, указывающий прерывать ли выполнение пакета операций, если произошла ошибка.
+        #   Используется только при transactional = false
+        #   / Stops batch processing on exceptions. Used only in conjunction with transactional=false.
+        property :exit_on_failure
+
+        # @return [Array[Moneta::Api::Types::Entity*]] Набор операций, которые необходимо выполнить в одном пакете.
+        #   Операции выполняются в том порядке, в котором они переданы в запросе.
+        #   / Set of transfers to be processed in one batch. Processed in order of appearance.
+        property :transaction
+
+        # Набор операций, которые необходимо выполнить в одном пакете.
+        #   Операции выполняются в том порядке, в котором они переданы в запросе.
+        #   / Set of transfers to be processed in one batch. Processed in order of appearance.
+        #
+        # @param [Moneta::Api::Types::Entity*]
+        # @return void
+        def add_transaction(item)
+          parents = item.class.ancestors
+          if parents.include?(Moneta::Api::Types::Entity)
+            (@transaction ||=[]).push(item)
+          else
+            raise TypeError.new("TypeError: #{ item.class } have not parent Moneta::Api::Types::Entity")
+          end
+        end
+      end
+    end
+  end
+end