moneta-api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d1c57b143f1deaff1fd20aab54676724403a76ba
+  data.tar.gz: 1c2ace8fff474fb919bb77dca1a145b3a243fa14
+SHA512:
+  metadata.gz: c3b2b4bb3223ab341c26536bd36f98c777c8f10254ffef902db9d24e52ff26336faa758d5aa6d2d51fa2f5d2ee4c47f7a3a4d3755973feba121d03ea61f80638
+  data.tar.gz: 71ddfcf91f937a1cd72ce54a1fdbbbd58be77d71fa14a35bba2d6853635f36173ad02bede4f087111725e55af70b9aa29c8b6c0d15bf1b722c4acec9b307aab3

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea
+spec/support/moneta.yml

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--colour
+--format documentation

data/.yardopts

@@ -0,0 +1,6 @@
+--no-private
+--exclude features
+--markup markdown
+--hide-void-return
+-
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in moneta-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 ssnikolay
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# Moneta::Api
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'moneta-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install moneta-api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/moneta-api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/moneta/api/data_mapper.rb

@@ -0,0 +1,91 @@
+module Moneta
+  module Api
+    module DataMapper
+      def self.included(base)
+        base.extend ClassMethods
+
+        base.class_eval do
+          def fill(data)
+            properties.each do |property, type|
+              value = data[ property ]
+              if value
+                property_value = type.nil? ? value : build_complex_value(type, value)
+                instance_variable_set("@#{ property }", property_value)
+              end
+            end
+
+            self
+          end
+
+          def to_hash
+            properties.each_with_object({}) do |(property, _), hash|
+              value = send(property)
+              unless value.nil?
+                hash[ classify_with_lower(property.to_s) ] = to_hash_complex_value(value)
+              end
+            end
+          end
+
+          def classify_with_lower(str)
+            str = classify(str)
+            str[0] = str[0].downcase
+
+            str
+          end
+
+          def classify(str)
+            str.split('_').map(&:capitalize).join
+          end
+
+          private
+
+          def build_complex_value(type, value)
+            value.kind_of?(Array) ?
+              value.map { |v| type.build(v) } :
+              type.build(value)
+          end
+
+          def to_hash_complex_value(value)
+            if value.kind_of?(Array)
+              value.map(&:to_hash)
+            elsif value.respond_to?(:to_hash)
+              value.to_hash
+            else
+              value
+            end
+          end
+        end
+      end
+
+      module ClassMethods
+        def property(name, base_type=nil)
+          attr_accessor(name)
+
+          # Сохраняем свойста и перезаписываем instance метод
+          current_properties = instance_variable_get('@properties') || {}
+          properties = instance_variable_set('@properties',
+            current_properties.merge(name => base_type).merge(parents_properties)
+          )
+
+          send(:define_method, :properties) { properties }
+        end
+
+        def build(data)
+          self.new.tap { |object| object.fill(data) }
+        end
+
+        private
+
+        def parents_properties
+          instance_variable_get('@parents_properties') ||
+            instance_variable_set('@parents_properties', ancestors.each_with_object({}) do |klass, hash|
+              if klass.name.match(/Moneta::Api::(Types|Requests|Responses)/)
+                hash.merge!(klass.instance_variable_get('@properties') || {})
+              end
+            end
+          )
+        end
+      end
+    end
+  end
+end

data/lib/moneta/api/requests/authorise_transaction_batch_request.rb

@@ -0,0 +1,9 @@
+module Moneta
+  module Api
+    module Requests
+      # Запрос на регистрацию операции с блокировкой средств на счете плательщика в пакетном режиме.
+      # Request for transactions registration and debiting funds from payer's account in batch processing mode.
+      class AuthoriseTransactionBatchRequest < Types::AuthoriseTransactionBatchRequestType; end
+    end
+  end
+end

data/lib/moneta/api/requests/authorise_transaction_request.rb

@@ -0,0 +1,15 @@
+module Moneta
+  module Api
+    module Requests
+      # Запрос на регистрацию операции с блокировкой средств на счете плательщика.
+      # Завершить (подтвердить) операцию можно с помощью ConfirmTransactionRequest.
+      # Если операция не будет закончена с помощью ConfirmTransactionRequest, то
+      # операция будет отменена автоматически по истечению срока блокировки.
+      # Request for transaction registration and debiting funds from payer's account.
+      # To finish (confirm) this transaction use ConfirmTransactionRequest.
+      # Authorised but not cofirmed transactions are cancelled automaticaly after authorisation expiry.
+
+      class AuthoriseTransactionRequest < Types::AuthoriseTransactionRequestType; end
+    end
+  end
+end

data/lib/moneta/api/requests/cancel_transaction_batch_request.rb

@@ -0,0 +1,10 @@
+module Moneta
+  module Api
+    module Requests
+      # Запрос на отмену операций в пакетном режиме.
+      # Transactions cancelation request in batch processing mode.
+
+      class CancelTransactionBatchRequest < Types::CancelTransactionBatchRequestType; end
+    end
+  end
+end

data/lib/moneta/api/requests/cancel_transaction_request.rb

@@ -0,0 +1,14 @@
+module Moneta
+  module Api
+    module Request
+      # Запрос на отмену операции. Отменять операцию можно при выполнении всех условий:
+      # незавершенные операции;
+      # если есть доступ к счету плательщика и счету получателя (то есть свои внутренние операции).
+      # Transaction cancelation request if transasction fulfils following conditions:
+      # transaction is in processing (incompleted);
+      # principal has an access to both (payer and payee) accounts.
+
+      class CancelTransactionRequest < Types::CancelTransactionRequestType; end
+    end
+  end
+end

data/lib/moneta/api/requests/confirm_transaction_batch_request.rb

@@ -0,0 +1,10 @@
+module Moneta
+  module Api
+    module Requests
+      # Запрос на завершение (подтверждение) операций в пакетном режиме.
+      # Transactions confirmation request in batch processing mode.
+
+      class ConfirmTransactionBatchRequest < Types::ConfirmTransactionBatchRequestType; end
+    end
+  end
+end

data/lib/moneta/api/requests/confirm_transaction_request.rb

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

data/lib/moneta/api/requests/create_account_request.rb

@@ -0,0 +1,65 @@
+module Moneta
+  module Api
+    module Requests
+      # Запрос на создание счета.
+      # Счет создается для указанного пользователя или,
+      # если это поле не указано, - для текущего пользователя.
+      # Account creation request. Account is created for given structure element (unitId) or for authenticated user's structure if unitId is omitted.
+
+      class CreateAccountRequest
+        include Moneta::Api::DataMapper
+        # @return [String] Валюта счета
+        #   / Currency of account
+        property :currency
+
+        # @return [String] Название счета.
+        #   Название счета должно быть уникальным среди счетов одного пользователя.
+        #   Необязательное поле.
+        #   / Alias of account. Must be unique among accounts of given user. Optional.
+        property :alias
+
+        # @return [String] Платежный пароль. Минимальная длина - 5 символов
+        #   / Payment password. Minimum length is 5 symbols.
+        property :payment_password
+
+        # @return [Integer] Пользователь, которому будет принадлежать данный счет.
+        #   Если это поле не задано, то счет создается для текущего пользователя.
+        #   Необязательное поле.
+        #   / Structure element, where the account belongs to. If omitted authenticated user's structure is used. Optional.
+        property :unit_id
+
+        # @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] Код проверки целостности данных. Необязательное поле.
+        #   / Mandatory payment form 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 [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/requests/find_accounts_list_request.rb

@@ -0,0 +1,38 @@
+module Moneta
+  module Api
+    module Requests
+      # Запрос на получение списка счетов по заданным условиям поиска.
+      # Accounts searching by given filter.
+
+      class FindAccountsListRequest
+        include Moneta::Api::DataMapper
+
+        # @return [Integer] Пользователь, которому принадлежат счета.
+        #   Если это поле не задано, то используется текущий пользователь.
+        #   Необязательное поле.
+        #   / Structure element, where accounts belong to. If omitted authenticated user's structure is used. Optional.
+        property :unit_id
+
+        # @return [String] Название счета. Поиск происходит по прямому совпадению.
+        #   Для задания маски можно указать спец-символы "*" или "?".
+        #   Необязательное поле.
+        #   / Alias of account. Wildcards "*" and "?" may be used. Optional.
+        property :alias
+
+        # @return [String] Валюта счета. Необязательное поле.
+        #   / Currency of account. Optional.
+        property :currency
+
+        # @return [Boolean] Является ли счет делегированным. Необязательное поле.
+        #   - поле не указано - выбрать все счета
+        #   - false - выбрать только неделегированные счета
+        #   - true - выбрать только делегированные счета
+        #   / The boolean flag indicating if account is deligated. Optional.
+        #   - select all accounts if omitted
+        #   - false - select only non-delegated (owned) accounts
+        #   - true - select only delegated accounts
+        property :is_delegated_account
+      end
+    end
+  end
+end

data/lib/moneta/api/requests/find_last_operations_list_request.rb

@@ -0,0 +1,24 @@
+module Moneta
+  module Api
+    module Requests
+      # Запрос на получение списка последних операций.
+      # Если данные не найдены, то size в ответе равен 0.
+      # Last transactions searching.
+      # Response element "size" is 0 if no data found.
+
+      class FindLastOperationsListRequest
+        include Moneta::Api::DataMapper
+        
+        # @return [Integer] ID пользователя в системе МОНЕТА.РУ.
+        #   Если это поле не задано, то используется текущий пользователь.
+        #   Необязательное поле.
+        #   / Structure identificator in MONETA.RU. If omitted authenticated user's structure is used. Optional.
+        property :unit_id
+
+        # @return [Integer] Количество операций. Необязательное поле.
+        #   / Transactions quantity. Optional.
+        property :transactions_quantity
+      end
+    end
+  end
+end

data/lib/moneta/api/requests/find_operations_list_request.rb

@@ -0,0 +1,26 @@
+module Moneta
+  module Api
+    module Requests
+      # Запрос на получение списка операций по заданному фильтру.
+      # Обязательными в фильтре являются только поля с датами периода.
+      # Все остальные поля в фильтре необязательные.
+      # Если данные не найдены, то size в ответе равен 0.
+      # Transaction searching by given filter.
+      # Filter requires date period values to be set.
+      # Other parameters are optional.
+      # Response element "size" is 0 if no data found.
+
+      class FindOperationsListRequest
+        include Moneta::Api::DataMapper
+
+        # @return [Moneta::Api::Types::Pager] Настройки страницы данных. Необязательное поле.
+        #   / Paging settings. Optional.
+        property :pager
+
+        # @return [Moneta::Api::Types::FindOperationsListRequestFilter] Фильтр, по которому ищем операции.
+        #   / Transactions filter.
+        property :filter
+      end
+    end
+  end
+end

data/lib/moneta/api/requests/forecast_transaction_request.rb

@@ -0,0 +1,9 @@
+module Moneta
+  module Api
+    module Requests
+      # Запрос предварительного расчета сумм и комиссий по параметрам операции.
+      # Request for amount and fee preliminary calculation by transaction parameters.
+      class Moneta::Api::Requests::ForecastTransactionRequest < Types::TransactionRequestType; end
+    end
+  end
+end

data/lib/moneta/api/requests/get_account_payment_password_challenge_request.rb

@@ -0,0 +1,16 @@
+module Moneta
+  module Api
+    module Requests
+      # Получить запрос для платежного пароля
+      # Receive challenge for payment password
+
+      class GetAccountPaymentPasswordChallengeRequest
+        include Moneta::Api::DataMapper
+
+        # @return [Integer] Номер счета
+        #   / Account number
+        property :account_id
+      end
+    end
+  end
+end

data/lib/moneta/api/requests/invoice_batch_request.rb

@@ -0,0 +1,10 @@
+module Moneta
+  module Api
+    module Requests
+      # Выставление счета к оплате в пакетном режиме.
+      # Making new invoice (request for payment) in batch processing mode.
+
+      class InvoiceBatchRequest < Types::InvoiceBatchRequestType; end
+    end
+  end
+end

data/lib/moneta/api/requests/invoice_request.rb

@@ -0,0 +1,10 @@
+module Moneta
+  module Api
+    module Requests
+      # Выставление счета к оплате.
+      # Making new invoice (request for payment).
+
+      class InvoiceRequest < Types::InvoiceRequestType; end
+    end
+  end
+end

data/lib/moneta/api/requests/payment_request.rb

@@ -0,0 +1,9 @@
+module Moneta
+  module Api
+    module Requests
+      # Запрос на перевод денежных средств. Отличается от TransferRequest тем, что в качестве получателя можно указывать не только номер счета.
+      # Money Transfer Request. The difference from TransferRequest is that payee may be addressed not only by account number rather than transaction ID, e-mail address or phone number.
+      class PaymentRequest < Types::PaymentRequestType; end
+    end
+  end
+end

data/lib/moneta/api/requests/refund_request.rb

@@ -0,0 +1,42 @@
+module Moneta
+  module Api
+    module Requests
+      # Возврат средств по указанной операции.
+      # Refund given transaction.
+
+      class RefundRequest
+        include Moneta::Api::DataMapper
+
+        # @return [Integer] Номер операции в системе МОНЕТА.РУ, по которой необходимо вернуть деньги
+        #   / Transaction ID in Moneta.ru
+        property :transaction_id
+
+        # @return [Float] Сумма, которую необходимо возвратить.
+        #   Если сумма не указана, то сумма для возврата берется из указанной операции.
+        #   Необязательное поле.
+        #   / Amount to refund in source transaction payee's currency. If omitted the source transaction payees' amount is used. Optional.
+        property :amount
+
+        # @return [String] Платежный пароль
+        #   / Payment password for payer account
+        property :payment_password
+
+        # @return [String] Внешний номер операции
+        #   / External transaction ID
+        property :client_transaction
+
+        # @return [String] Описание операции
+        #   / Transaction description or comments
+        property :description
+
+        # @return [Moneta::Api::Types::OperationInfo] Набор полей, которые необходимо сохранить в качестве атрибутов операции. Значения дат в формате dd.MM.yyyy HH:mm:ss
+        #   / Key-value pairs that will be saved as a transaction attributes. Use format dd.MM.yyyy HH:mm:ss for date values
+        property :operation_info, Types::OperationInfo
+
+        # @return [String] Запрос для платежного пароля
+        #   / Payment password challenge
+        property :payment_password_challenge
+      end
+    end
+  end
+end

data/lib/moneta/api/requests/transfer_request.rb

@@ -0,0 +1,9 @@
+module Moneta
+  module Api
+    module Requests
+      # Запрос на перевод денежных средств.
+      # Money Transfer Request.
+      class TransferRequest < Types::TransactionRequestType; end
+    end
+  end
+end

data/lib/moneta/api/requests/verify_payment_request.rb

@@ -0,0 +1,10 @@
+module Moneta
+  module Api
+    module Requests
+      # Запрос возможности провести операцию в системе МОНЕТА.РУ. Отличается от VerifyTransferRequest тем, что в качестве получателя можно указывать не только номер счета.
+      # Transaction verification request. The difference from VerifyTransferRequest is that payee may be addressed not only by account number rather than transaction ID, e-mail address or phone number.
+
+      class VerifyPaymentRequest < Types::PaymentRequestType; end
+    end
+  end
+end

data/lib/moneta/api/requests/verify_transaction_request.rb

@@ -0,0 +1,51 @@
+module Moneta
+  module Api
+    module Requests
+      # Запрос возможности провести операцию в системе МОНЕТА.РУ.
+      # Transaction verification request.
+
+      class VerifyTransactionRequest < Moneta::Api::Types::Entity
+        # @return [Integer] Идентификатор операции в системе МОНЕТА.РУ, которую надо проверить.
+        #   / The identifier of transaction which has to be verified.
+        property :transaction_id
+
+        # @return [Integer] Номер счета плательщика
+        #   / Payer account number
+        property :payer
+
+        # @return [Float] Сумма операции.
+        #   Если флаг isPayerAmount отсутствует
+        #   и пользователь имеет доступ только к счету плательщика,
+        #   то интерпретируется как сумма к списанию (в валюте плательщика).
+        #   Если флаг isPayerAmount отсутствует
+        #   и пользователь имеет доступ только к счету получателя,
+        #   то интерпретируется как сумма к зачислению (в валюте получателя).
+        #   / Transaction amount. If isPayerAmount is omitted and user has access only to payer account, then is interpreted as debit amount (in payer's currency). If isPayerAmount is omitted and user has access only to payee account, then is interpreted as credit amount (in payee's currency).
+        property :amount
+
+        # @return [Boolean] Если пользователь имеет доступ как к счету плательщика, так и счету получателя,
+        #   то флаг isPayerAmount обязателен.
+        #   Если флаг isPayerAmount установлен (true), то amount используется как сумма к списанию (в валюте плательщика).
+        #   Если флаг isPayerAmount сброшен (false), то amount используется как сумма к зачислению (в валюте получателя).
+        #   / If user has access to both accounts, then isPayerAmount flag is obligatory. If isPayerAmount flag is "true", then amount is used as debit amount (in payer's currency). If isPayerAmount flag is "false", then amount is used as credit amount (in payee's currency).
+        property :is_payer_amount
+
+        # @return [Moneta::Api::Types::OperationInfo] Набор полей, которые необходимо использовать в качестве атрибутов операции. Значения дат в формате dd.MM.yyyy HH:mm:ss
+        #   / Key-value pairs that will be used as a transaction attributes. Use format dd.MM.yyyy HH:mm:ss for date values
+        property :operation_info, Moneta::Api::Types::OperationInfo
+
+        # @return [String] Платежный пароль счета плательщика
+        #   / Payment password for payer account
+        property :payment_password
+
+        # @return [String] Запрос для платежного пароля
+        #   / Payment password challenge
+        property :payment_password_challenge
+
+        # @return [String] Внешний номер операции
+        #   / External transaction ID
+        property :client_transaction
+      end
+    end
+  end
+end

data/lib/moneta/api/requests/verify_transfer_request.rb

@@ -0,0 +1,10 @@
+module Moneta
+  module Api
+    module Requests
+      # Запрос возможности провести операцию в системе МОНЕТА.РУ.
+      # Transaction verification request.
+
+      class VerifyTransferRequest < Types::TransactionRequestType; end
+    end
+  end
+end

data/lib/moneta/api/response_factory.rb

@@ -0,0 +1,22 @@
+module Moneta
+  module Api
+    class ResponseFactory
+      class << self
+        # @param [Savon::Response]
+        # @return [Moneta::Api::Responses::*]
+        def build(response)
+          klass, data = response.to_hash.to_a.first
+          klass = classify(klass)
+
+          Object.const_get("Moneta::Api::Responses::#{ klass }").build(data)
+        end
+
+        private
+
+        def classify(str)
+          str.to_s.split('_').map(&:capitalize).join
+        end
+      end
+    end
+  end
+end