moneta-api 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2bd8ba9619326c34b72b79371521849fe44e5b78
-  data.tar.gz: 1a9a33ce255cb1a7c8bdf4a40c69999659992da7
+  metadata.gz: 24f8697207e35d2545e5ff4d599f06846e723d87
+  data.tar.gz: 4272d2c91359233ede767dbf3dd2492208e44b6f
 SHA512:
-  metadata.gz: ecd96715a52e1fc07270eb7e872ec91b6b7fc69c0521ef99b79c403ec41eda12574308fad9b8b94e4a0a161e85c3d82d10fdaa0625113f4de21d2864df634f40
-  data.tar.gz: d35540807da05ab55e0f9c7872da1f6567b36275a046d52d7ce27701ba89f4bbfc3555e0f44bbc03ed32824bbf9405c4c06e8d0d984ec71535ea0ac606b0aaf7
+  metadata.gz: 7bfc0ca2695fa20b40d3d108151c4698313e9b2daa576cdb0eeace9df5afe9d222b09949aad8055cf5a37386a0b698c45809809475180043b2aa3451f1faa395
+  data.tar.gz: 90a7004453ae3aaa2bd36ab266a55e8072e829ae3337f7ff5174eb5b81df640093ba95e495fd0f8f02d39ced298a4ce4e864dac3b0d2f04edf31766b0aa69f68

data/.travis.yml

@@ -0,0 +1,10 @@
+  language: ruby
+
+  rvm:
+    - 2.0.0
+    - 2.1
+    - 2.2
+  before_script:
+    - cp spec/support/moneta.example.yml spec/support/moneta.yml
+  script:
+    - CODECLIMATE_REPO_TOKEN=d10be753ffa1a760be2df97c61673629a3fa86270cdd898250b8366213b0799c bundle exec rspec

data/README.md

@@ -1,31 +1,104 @@
-# Moneta::Api
+[![Gem Version](https://badge.fury.io/rb/moneta-api.svg)](http://badge.fury.io/rb/moneta-api)
+[![Build Status](https://travis-ci.org/ssnikolay/moneta-api.svg?branch=master)](https://travis-ci.org/ssnikolay/moneta-api)
+[![Code Climate](https://codeclimate.com/github/ssnikolay/moneta-api/badges/gpa.svg)](https://codeclimate.com/github/ssnikolay/moneta-api)
+[![Test Coverage](https://codeclimate.com/github/ssnikolay/moneta-api/badges/coverage.svg)](https://codeclimate.com/github/ssnikolay/moneta-api)
+[![Inline docs](http://inch-ci.org/github/ssnikolay/moneta-api.svg?branch=master)](http://inch-ci.org/github/ssnikolay/moneta-api)
 
-TODO: Write a gem description
+[Описание MerchantAPI](https://www.moneta.ru/doc/MONETA.MerchantAPI.v2.ru.pdf) | [RDoc](http://www.rubydoc.info/gems/moneta-api) |
+[Список методов](http://www.rubydoc.info/gems/moneta-api/Moneta/Api/ServiceMethods)
 
-## Installation
+# moneta-api
 
-Add this line to your application's Gemfile:
+МОНЕТА.РУ (MONETA.MerchantAPI.v2).
+
+## Установка
+
+Добавьте эти строки в Gemfile вашего приложения:
 
 ```ruby
 gem 'moneta-api'
 ```
 
-And then execute:
+И выполните:
 
     $ bundle
 
-Or install it yourself as:
+Или установите напрямую:
 
     $ gem install moneta-api
 
-## Usage
+## Использование
+
+#### Базовый пример
+
+```ruby
+  require 'moneta/api'
+
+  # получить данные счета
+  service = Moneta::Api::Service.new('username', 'password', { demo_mode: true })
+  response = service.find_account_by_id(10999)
+  puts response.class.name
+  # => 'Moneta::Api::Responses::FindAccountByIdResponse'
+  puts "Баланс до пополнения: #{ response.account.balance} #{ response.account.currency }"
+  # => 'Баланс до пополнения: 100 RUB'
+  
+  # перевод
+  transfer_request = Moneta::Api::Requests::TransferRequest.new.tap do |request|
+    request.payee = 28988504
+    request.payer = 10999
+    request.amount = 10
+    request.is_payer_amount = false
+    request.payment_password = '123456'
+  end
+  response = service.transfer(transfer_request)
+  
+  # данные транзакции
+  puts response.class.name
+  # => 'Moneta::Api::Responses::TransferResponse'
+  puts response.status
+  # => 'SUCCEED'
+  
+  # проверить данные счета
+  response = service.find_account_by_id(10999)
+  puts "Баланс после пополнения: #{ response.account.balance} #{ response.account.currency }"
+  # => 'Баланс после пополнения: 110 RUB'
+```
+
+**Полный [список методов](http://www.rubydoc.info/gems/moneta-api/Moneta/Api/ServiceMethods), с помощью которых вы можете обратиться к MONETA.MerchantAPI.v2**
 
-TODO: Write usage instructions here
+### Настройки
+
+#### Logger
+
+```ruby
+  Moneta::Api::Service.new('username', 'password', {
+    logger: Rails.logger,
+    log_level: :info,
+    filters: [:password]
+  })
+```
+
+Доступны следующие настройки:
+
+ Название                  | Описание
+---------------------------|:-----------------------------------------------------------
+`:logger`                  | **moneta-api** по умолчанию пишет логи в `$STDOUT` с помощью ruby Logger'а. Можно переопределить на любой другой Logger. (прим: `Rails.logger`)
+`:log_level`               | Используется для фильтрации вывода в log по приоритету. Допускаются следующие значения - `:info`, `:debug`, `:warn`, `:error`, `:fatal`.
+`:log`                     | Определяет, нужно ли писать в log. (`true` или `false`)
+`:filters`                  | Конфиденциальная информация, которую не следует писать в log.
+`:pretty_print_xml`        | Определяет, нужно ли выводить в log XML запроса\ответа. (`true` или `false`)
+
+#### Demo режим
+Для использования тестового сервера (http://demo.moneta.ru) следует инициализировать сервис со специальным флагом
+
+```ruby
+  Moneta::Api::Service.new('username', 'password', { demo_mode: true })
+```
 
 ## 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
+1. Стандартная схема с pull-request workflow
+2. Для локального запуска тестов необходимо создать конфигурационный файл со своими demo доступами
+```bash
+  echo "username: 'username'\npassword: 'password'" > spec/support/moneta.yml
+```

data/lib/moneta/api/data_mapper.rb

@@ -21,22 +21,11 @@ module Moneta
             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)
+                hash[ property.to_s.classify_with_lower ] = 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)

data/lib/moneta/api/response_factory.rb

@@ -6,15 +6,8 @@ module Moneta
         # @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
+          Object.const_get("Moneta::Api::Responses::#{ klass.to_s.classify }").build(data)
         end
       end
     end

data/lib/moneta/api/service_methods.rb

@@ -4,43 +4,43 @@ module Moneta
       # @param [Moneta::Api::Requests::AuthoriseTransactionRequest]
       # @return [Moneta::Api::Responses::AuthoriseTransactionResponse]
       def authorise_transaction(request)
-        call(__method__, request.to_hash)
+        call(__method__, request)
       end
 
       # @param [Moneta::Api::Requests::AuthoriseTransactionBatchRequest]
       # @return [Moneta::Api::Responses::AuthoriseTransactionBatchResponse]
       def authorise_transaction_batch(request)
-        call(__method__, request.to_hash)
+        call(__method__, request)
       end
 
       # @param [Moneta::Api::Requests::CancelTransactionRequest]
       # @return [Moneta::Api::Responses::CancelTransactionResponse]
       def cancel_transaction(request)
-        call(__method__, request.to_hash)
+        call(__method__, request)
       end
 
       # @param [Moneta::Api::Requests::CancelTransactionBatchRequest]
       # @return [Moneta::Api::Responses::CancelTransactionBatchResponse]
       def cancel_transaction_batch(request)
-        call(__method__, request.to_hash)
+        call(__method__, request)
       end
 
       # @param [Moneta::Api::Requests::ConfirmTransactionRequest]
       # @return [Moneta::Api::Responses::ConfirmTransactionResponse]
       def confirm_transaction(request)
-        call(__method__, request.to_hash)
+        call(__method__, request)
       end
 
       # @param [Moneta::Api::Requests::ConfirmTransactionBatchRequest]
       # @return [Moneta::Api::Responses::ConfirmTransactionBatchResponse]
       def confirm_transaction_batch(request)
-        call(__method__, request.to_hash)
+        call(__method__, request)
       end
 
       # @param [Moneta::Api::Requests::CreateAccountRequest]
       # @return [Moneta::Api::Responses::CreateAccountResponse]
       def create_account(request)
-        call(__method__, request.to_hash)
+        call(__method__, request)
       end
 
       # @param [String]
@@ -52,19 +52,19 @@ module Moneta
       # @param [Moneta::Api::Requests::FindAccountsListRequest]
       # @return [Moneta::Api::Responses::FindAccountsListResponse]
       def find_accounts_list(request)
-        call(__method__, request.to_hash)
+        call(__method__, request)
       end
 
       # @param [Moneta::Api::Requests::FindOperationsListRequest]
       # @return [Moneta::Api::Responses::FindOperationsListResponse]
       def find_operations_list(request)
-        call(__method__, request.to_hash)
+        call(__method__, request)
       end
 
       # @param [Moneta::Api::Requests::ForecastTransactionRequest]
       # @return [Moneta::Api::Responses::ForecastTransactionResponse]
       def forecast_transaction(request)
-        call(__method__, request.to_hash)
+        call(__method__, request)
       end
 
       # @param [Integer]
@@ -76,13 +76,13 @@ module Moneta
       # @param [Moneta::Api::Requests::FindLastOperationsListRequest]
       # @return [Moneta::Api::Responses::FindLastOperationsListResponse]
       def find_last_operations_list(request)
-        call(__method__, request.to_hash)
+        call(__method__, request)
       end
 
       # @param [Moneta::Api::Requests::GetAccountPaymentPasswordChallengeRequest]
       # @return [Moneta::Api::Responses::GetAccountPaymentPasswordChallengeResponse]
       def get_account_payment_password_challenge(request)
-        call(__method__, request.to_hash)
+        call(__method__, request)
       end
 
       # @param [Integer]
@@ -94,57 +94,77 @@ module Moneta
       # @param [Moneta::Api::Requests::InvoiceRequest]
       # @return [Moneta::Api::Responses::InvoiceResponse]
       def invoice(request)
-        call(__method__, request.to_hash)
+        call(__method__, request)
       end
 
       # @param [Moneta::Api::Requests::InvoiceBatchRequest]
       # @return [Moneta::Api::Responses::InvoiceBatchResponse]
       def invoice_batch(request)
-        call(__method__, request.to_hash)
+        call(__method__, request)
       end
 
       # @param [Moneta::Api::Requests::RefundRequest]
       # @return [Moneta::Api::Responses::RefundResponse]
       def refund(request)
-        call(__method__, request.to_hash)
+        call(__method__, request)
       end
 
       # @param [Moneta::Api::Requests::TransferRequest]
       # @return [Moneta::Api::Responses::TransferResponse]
       def transfer(request)
-        call(__method__, request.to_hash)
+        call(__method__, request)
       end
 
       # @param [Moneta::Api::Requests::PaymentRequest]
       # @return [Moneta::Api::Responses::PaymentResponse]
       def payment(request)
-        call(__method__, request.to_hash)
+        call(__method__, request)
       end
 
       # @param [Moneta::Api::Requests::VerifyPaymentRequest]
       # @return [Moneta::Api::Responses::VerifyPaymentResponse]
       def verify_payment(request)
-        call(__method__, request.to_hash)
+        call(__method__, request)
       end
 
       # @param [Moneta::Api::Requests::VerifyTransferRequest]
       # @return [Moneta::Api::Responses::VerifyTransferResponse]
       def verify_transfer(request)
-        call(__method__, request.to_hash)
+        call(__method__, request)
       end
 
       # @param [Moneta::Api::Requests::VerifyTransactionRequest]
       # @return [Moneta::Api::Responses::VerifyTransactionResponse]
       def verify_transaction(request)
-        call(__method__, request.to_hash)
+        call(__method__, request)
       end
 
       private
 
-      def call(method, request_message)
-        response = client.call(method, { message: request_message })
+      def call(method, request)
+        validate!(method, request)
+
+        response = client.call(method, {
+          message: request.respond_to?(:to_hash) ? request.to_hash : request
+        })
         ResponseFactory.build(response)
       end
+
+      def validate!(method, request)
+        expected_request_class = get_expected_request_class(method)
+
+        unless request.kind_of?(expected_request_class)
+          raise TypeError.new("#{ request.class.name } can't be coerced into #{ expected_request_class.name }")
+        end
+      end
+
+      def get_expected_request_class(method)
+        {
+          'find_account_by_alias' => String,
+          'find_account_by_id' => Integer,
+          'get_operation_details_by_id' => Integer
+        }[ method.to_s ] || Object.const_get("Moneta::Api::Requests::#{ method.to_s.classify }Request")
+      end
     end
   end
 end

data/lib/moneta/api/version.rb

@@ -1,5 +1,5 @@
 module Moneta
   module Api
-    VERSION = '1.0.1'
+    VERSION = '1.0.2'
   end
 end

data/lib/moneta/api.rb

@@ -1,6 +1,7 @@
 require 'moneta/api/version'
 require 'savon'
 
+require 'moneta/core_ext/string'
 require 'moneta/api/service_methods'
 require 'moneta/api/service'
 require 'moneta/api/data_mapper'

data/lib/moneta/core_ext/string.rb

@@ -0,0 +1,29 @@
+module Moneta
+  module CoreExt
+    module String
+
+      def self.included(base)
+        unless 'moneta'.respond_to?(:classify)
+          base.send(:include, Extension)
+        end
+      end
+
+      module Extension
+        def classify_with_lower
+          str = dup
+          str = str.classify
+          str[0] = str[0].downcase
+
+          str
+        end
+
+        def classify
+          dup.split('_').map(&:capitalize).join
+        end
+      end
+
+    end
+  end
+end
+
+String.send :include, Moneta::CoreExt::String

data/moneta-api.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'fakeweb'
   spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'codeclimate-test-reporter'
 end

data/spec/lib/moneta/api/service_spec.rb

@@ -21,4 +21,8 @@ describe Moneta::Api::Service do
       it { is_expected.to eq 'https://www.moneta.ru/services.wsdl' }
     end
   end
+
+  describe 'request validate' do
+    it { expect { service.authorise_transaction('invalid request') }.to raise_exception(TypeError, "String can't be coerced into Moneta::Api::Requests::AuthoriseTransactionRequest") }
+  end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,8 @@
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
+end
+
 require 'rspec'
 require 'pry'
 require 'rspec/its'
@@ -19,6 +24,7 @@ VCR.configure do |config|
   config.hook_into :fakeweb
   config.filter_sensitive_data('<USERNAME>') { $username }
   config.filter_sensitive_data('<PASSWORD>') { $password }
+  config.ignore_hosts 'codeclimate.com'
 end
 
 RSpec.configure do |config|

data/spec/support/moneta.example.yml

@@ -0,0 +1,2 @@
+username: 'username'
+password: 'password'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moneta-api
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - ssnikolay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-14 00:00:00.000000000 Z
+date: 2015-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -136,6 +136,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: МОНЕТА.РУ (MONETA.MerchantAPI.v2).
 email:
 - ssnikolay@gmail.com
@@ -145,6 +159,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - .yardopts
 - Gemfile
 - LICENSE.txt
@@ -225,6 +240,7 @@ files:
 - lib/moneta/api/types/verify_transaction_response_type.rb
 - lib/moneta/api/types/verify_transfer_response_type.rb
 - lib/moneta/api/version.rb
+- lib/moneta/core_ext/string.rb
 - moneta-api.gemspec
 - spec/lib/moneta/api/requests/authorise_transaction_batch_request_spec.rb
 - spec/lib/moneta/api/requests/authorise_transaction_request_spec.rb
@@ -240,6 +256,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/context.rb
 - spec/support/matchers.rb
+- spec/support/moneta.example.yml
 - spec/support/wsdl
 - spec/vcr/moneta_api_requests_authorisetransactionbatchrequest/use_when_one_operation_transaction_transaction_.yml
 - spec/vcr/moneta_api_requests_authorisetransactionbatchrequest/use_when_two_operations_transaction_first_transaction_.yml
@@ -290,6 +307,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/context.rb
 - spec/support/matchers.rb
+- spec/support/moneta.example.yml
 - spec/support/wsdl
 - spec/vcr/moneta_api_requests_authorisetransactionbatchrequest/use_when_one_operation_transaction_transaction_.yml
 - spec/vcr/moneta_api_requests_authorisetransactionbatchrequest/use_when_two_operations_transaction_first_transaction_.yml