yandex-money-sdk 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bc4a805a893ffedcd0df89f8d383e287b051aee
-  data.tar.gz: 2ba73b073817413e27467427250095bc03f5d1aa
+  metadata.gz: e244659ec433db17836ed23c99ec4c29cf9aaa96
+  data.tar.gz: aaa309b840e92f5e1c592b53199af46cbb421d4b
 SHA512:
-  metadata.gz: c3758f7f3286616aa274f679c33f4f2c134c86f08577f6d334cf29a8e228c07e944a9fe9f1b6f8bf4ce5578dfbd173e60fd58c4de7dc7d3d40cb78ae4e60e6c0
-  data.tar.gz: 2c8da222474426e5ff251027832fa791e097794191f2dfb30cc603c4074040caaae0ff40a83ed82ac313a115a33501c688abdcf07acc3492df5b1552b545c1f4
+  metadata.gz: 0d4c9c824d457f59ddf75833a25612e54f90421ca7730638bf1521adbcaf81e6840f9e2a1b1778326d6336e44d3d7b0519faa7abda7ea5dcb4d91abea10df848
+  data.tar.gz: 5e648204b9d54e34109e9785ce15dc6051d530371617a19c6c90ccd6d4e5a13f4d19a2c21acd80326fb7d7f2e8e2a7b9fe1bd8d16f01a1464b82f942abcaabec

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.11.0 (September 26, 2014)
+
+Disable handling of HTTP errors inside gem in `process_payment` method.
+
 # 0.10.0 (September 20, 2014)
 
 Exceptions now is divided by classes, now it lives in `lib/yandex_money/exceptions.rb` for details.

data/README.md

@@ -1,270 +1,163 @@
-# Yandex Money Ruby SDK Ruby
-
 [![Build Status](https://travis-ci.org/yandex-money/yandex-money-sdk-ruby.svg)](https://travis-ci.org/yandex-money/yandex-money-sdk-ruby)
 [![Coverage Status](https://img.shields.io/coveralls/yandex-money/yandex-money-sdk-ruby.svg)](https://coveralls.io/r/yandex-money/yandex-money-sdk-ruby)
 [![Code Climate](https://codeclimate.com/github/yandex-money/yandex-money-sdk-ruby/badges/gpa.svg)](https://codeclimate.com/github/yandex-money/yandex-money-sdk-ruby)
 [![Gem Version](https://badge.fury.io/rb/yandex-money-sdk.svg)](http://badge.fury.io/rb/yandex-money-sdk)
 [![Dependency Status](https://gemnasium.com/yandex-money/yandex-money-sdk-ruby.svg)](https://gemnasium.com/yandex-money/yandex-money-sdk-ruby)
 
-Ruby gem for Yandex Money API usage.
-
-## Example application
-
-You could find small example application in [yandex-money/yandex-money-sdk-ruby-sample](https://github.com/yandex-money/yandex-money-sdk-ruby-sample) repository.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-  gem 'yandex-money-sdk'
-```
-
-And then execute:
+# Ruby Yandex.Money API SDK
 
-```
-  bundle
-```
-
-Or install it manually with:
-
-```
-  gem install yandex-money-sdk
-```
-
-## Usage
-
-### Initialize API
-
-#### Require gem
-
-```ruby
-  require 'yandex_money/api'
-```
+## Requirements
 
-#### Initialize API
+Supported ruby versions: 1.9.3, 2.0, 2.1, jruby, rbx-2
 
-```ruby
-  # If TOKEN was obtained previosly
-  api = YandexMoney::Api.new(token: TOKEN)
-```
+## Links
 
-```ruby
-  # If TOKEN is need to be obtained
-  api = YandexMoney::Api.new(
-    client_id: CLIENT_ID,
-    redirect_uri: REDIRECT_URI,
-    scope: "account-info operation-history"
-  )
-```
+1. Yandex.Money API page: [Ru](http://api.yandex.ru/money/),
+[En](http://api.yandex.com/money/)
 
-### Use user browser to send auth request to Yandex.Money server
+## Getting started
 
-After initializing `YandexMoney::Api` without token, you will find token request url in `api.client_url`. User need to visit that address with browser.
+### Installation
 
-After visiting `api.client_url` the user will be redirected to `REDIRECT_URL` with `code` parameter. It is authorization code, needed for token obtaining.
 
-To get token use `YandexMoney::Api#obtain_token`:
+Add this line to your Gemfile:
 
 ```ruby
-  api.code = "ACEB6F56EC46B66F280AFB9C805C61A66A8B5" # obtained code
-  token = api.obtain_token # token contains valid client token
+gem 'yandex-money-sdk'
 ```
 
-If `client_secret` is set:
+And then execute:
 
-```ruby
-  api.code = "ACEB6F56EC46B66F280AFB9C805C61A66A8B5" # obtained code
-  token = api.obtain_token(CLIENT_SECRET) # token contains valid client token
 ```
-
-## Methods
-
-### Information about a user's account
-
-#### account-info method
-
-Getting information about the status of user's account. Required permissions: `account-info`.
-
-```ruby
-  api.account_info
-  #<OpenStruct account="41001565326286", balance=48.98, currency="643", avatar={"ts"=>"2012-05-02T17:22:59.000+04:00", "url"=>"https://avatars.yandex.net/get-yamoney-profile/yamoney-profile-56809635-2/normal?1335964979000"}, account_type="personal", identified=false, account_status="named">
+bundle
 ```
 
-#### operation-history method
-
-This method allows viewing the full or partial history of operations in page mode. History records are displayed in reverse chronological order (from most recent to oldest).
-
-Required permissions: `operation-history`.
-
-```ruby
-  api.operation_history
-  #<OpenStruct next_record="30", operations=[{"operation_id"=>"462449992116028008", "title"=>"Возврат средств от:", "amount"=>1.0, "direction"=>"in", "datetime"=>"2014-08-27T10:19:52Z", "status"=>"success", "type"=>"deposition"}, ..., {"pattern_id"=>"p2p", "operation_id"=>"460970888534110007", "title"=>"Перевод на счет 410011700000000", "amount"=>3.02, "direction"=>"out", "datetime"=>"2014-08-10T07:28:15Z", "status"=>"success", "type"=>"outgoing-transfer"}]>
+Or install it manually with:
 
-  # you could pass params:
-  api.operation_history(records: 1)
-  #<OpenStruct next_record="1", operations=[{"pattern_id"=>"p2p", "operation_id"=>"463947376678019004", "title"=>"Перевод от 410011285000000", "amount"=>0.99, "direction"=>"in", "datetime"=>"2014-09-13T18:16:16Z", "status"=>"refused", "type"=>"incoming-transfer-protected"}]>
 ```
-
-#### operation-details method
-
-Provides detailed information about a particular operation from the history.
-
-Required permissions: `operation-details`.
-
-```ruby
-  api.operation_details(OPERATION_ID)
-  #<OpenStruct operation_id="462449992116028008", title="Возврат средств от:", amount=1.0, direction="in", datetime="2014-08-27T10:19:52Z", status="success", type="deposition", details="Отмена оплаты по банковской карте Яндекс.Денег\n , 5411, , \nНомер транзакции: 423910208430140827101810\nСумма в валюте платежа: 1.00 RUB">
+gem install yandex-money-sdk
 ```
 
-If operation doesn't exist, exception will be raised:
+Next, require it in application:
 
 ```ruby
-  api.operation_details "unknown"
-  #  YandexMoney::ApiError:
-  #    Illegal param operation id
+require 'yandex_money/api'
 ```
 
-If scope is insufficient, expcetion will be raised:
-
-```ruby
-  api = YandexMoney::Api.new(token: TOKEN)
-  api.operation_details(OPERATION_ID)
-  #  YandexMoney::InsufficientScopeError:
-  #     YandexMoney::InsufficientScopeError
-```
 
 ### Payments from the Yandex.Money wallet
 
-#### request-payment method
-
-Creates a payment, checks parameters and verifies that the merchant can accept the payment, or that funds can be transferred to a Yandex.Money user account.
-
-Permissions required for making a payment to a merchant: `payment.to-pattern` (Payment Pattern) or `payment-shop`.
-Permissions required for transferring funds to the accounts of other users: `payment.to-account ("payee ID," "ID type")` or `payment-p2p`.
-
-Basic request-payment method call:
-
-```ruby
-  api = YandexMoney::Api.new(token: TOKEN)
-  server_response = api.request_payment(
-    pattern_id: "p2p",
-    to: "410011285611534",
-    amount: "1.0",
-    comment: "test payment comment from yandex-money-ruby",
-    message: "test payment message from yandex-money-ruby",
-    label: "testPayment",
-  )
-  #<OpenStruct status="success", contract="The generated test outgoing money transfer to 410011285611534, amount 1.0", recipient_account_type="personal", recipient_account_status="anonymous", request_id="test-p2p", test_payment="true", contract_amount=1.0, money_source={"wallet"=>{"allowed"=>true}}, recipient_identified=false>
-```
-
-#### process-payment method
-
-Confirms a payment that was created using the `request_payment` method. Specifies the method for making the payment.
-
-Basic process-payment method call:
-
-```ruby
-  api = YandexMoney::Api.new(token: TOKEN)
-  api.process_payment(
-    request_id: "test-p2p",
-  )
-  #<OpenStruct status="success", payer="41001565326286", payee="test", credit_amount=20.3, payee_uid=56809635, test_payment="true", payment_id="test">
-```
-
-#### incoming-transfer-accept method
-
-Accepting incoming transfers with a secret code and deferred transfers.
-
-There is a limit on the number of attempts to accept an incoming transfer with a secret code. When the allowed number of attempts have been used up, the transfer is automatically rejected (the transfer is returned to the sender).
-
-Required token permissions: `incoming-transfers`.
-
-```ruby
-  api = YandexMoney::Api.new(token: TOKEN)
-  api.incoming_transfer_accept "463937708331015004", "0208"
-  # true
-  api.incoming_transfer_accept "463937708331015004", "WRONG"
-  #  YandexMoney::ApiError:
-  #     Illegal param protection code, attemps available: 2
-```
-
-#### incoming-transfer-reject method
-
-Canceling incoming transfers with a secret code and deferred transfers. If the transfer is canceled, it is returned to the sender.
-
-Required token permissions: `incoming-transfers`.
-
-```ruby
-  api = YandexMoney::Api.new(token: TOKEN)
-  api.incoming_transfer_reject "463947376678019004"
-  # true
-  api.incoming_transfer_reject ""
-  #  YandexMoney::ApiError:
-  #     Illegal param operation id
-```
+Using Yandex.Money API requires following steps
+
+1. Obtain token URL and redirect user's browser to Yandex.Money service.
+Note: `client_id`, `redirect_uri`, `client_secret` are constants that you get,
+when [register](https://sp-money.yandex.ru/myservices/new.xml) app in Yandex.Money API.
+
+    ```ruby
+    api = YandexMoney::Api.new(
+      client_id: CLIENT_ID,
+      redirect_uri: REDIRECT_URI,
+      scope: "account-info operation-history"
+    )
+    auth_url = api.client_url
+    ```
+
+2. After that, user fills Yandex.Money HTML form and user is redirected back to
+`REDIRECT_URI?code=CODE`.
+
+3. You should immediately exchange `CODE` with `ACCESS_TOKEN`.
+
+    ```ruby
+    api = YandexMoney::Api.new(
+      client_id: CLIENT_ID,
+      redirect_uri: REDIRECT_URI,
+      scope: "account-info operation-history"
+    )
+    api.code = params[:code] # obtained code
+    access_token = api.obtain_token
+    # or, if client secret defined:
+    # access_token = api.obtain_token(CLIENT_SECRET)
+    ```
+
+4. Now you can use Yandex.Money API.
+
+    ```ruby
+    api = YandexMoney::Api.new(token: TOKEN) # TOKEN is obtained token
+    account_info = api.account_info
+    balance = account_info.balance # and so on
+
+    request_options = {
+        "pattern_id": "p2p",
+        "to": "410011161616877",
+        "amount_due": "0.02",
+        "comment": "test payment comment from yandex-money-python",
+        "message": "test payment message from yandex-money-python",
+        "label": "testPayment",
+        "test_payment": true,
+        "test_result": "success"
+    };
+    request_result = api.request_payment(request_options)
+    # check status
+
+    process_payment = api.process_payment({
+        request_id: request_result.request_id,
+    })
+    # check result
+    if process_payment.status == "success"
+      # show success page
+    else
+      # something went wrong
+    end
+    ```
 
 ### Payments from bank cards without authorization
 
-#### instance-id method
-
-Registering an instance of the application.
-
-```ruby
-  api = YandexMoney::Api.new(client_id: CLIENT_ID)
-  api.get_instance_id # returns string, contains instance id
-```
-
-If `client_id` is wrong - exception will be raised.
-
-#### request-external-payment method
-
-Creating a payment and checking its parameters.
+1. Fetch instantce-id(ussually only once for every client. You can store
+result in DB).
+
+    ```ruby
+    api = YandexMoney::Api.new(client_id: CLIENT_ID)
+    response = api.get_instance_id # returns string, contains instance id
+    if reponse.status == "success"
+      instance_id = response.instance_id
+    else
+      # throw exception
+    end
+    ```
+
+2. Make request payment
+
+    ```ruby
+    api = YandexMoney::Api.new(
+      client_id: CLIENT_ID,
+      instance_id: INSTANCE_ID
+    )
+    response = api.request_external_payment({
+      pattern_id: "p2p",
+      to: "410011285611534",
+      amount_due: "1.00",
+      message: "test"
+    })
+    if response.status == "success"
+      request_id = response.request_id
+    else
+      # throw exception
+    end
+    ```
+
+3. Process the request with process-payment. 
+
+    ```ruby
+    api = YandexMoney::Api.new(instance_id: INSTANCE_ID)
+    result = api.process_external_payment({
+      request_id: REQUEST_ID,
+      ext_auth_success_uri: "http://example.com/success",
+      ext_auth_fail_uri: "http://example.com/fail"
+    })
+    # process result according to docs
+    ```
 
-```ruby
-  api = YandexMoney::Api.new(
-    client_id: CLIENT_ID,
-    instance_id: INSTANCE_ID
-  )
-  api.request_external_payment({
-    pattern_id: "p2p",
-    to: "410011285611534",
-    amount_due: "1.00",
-    message: "test"
-  })
-  #<OpenStruct status="success", title="Перевод на счет 4100000000000000", contract_amount=50.0, request_id="313230...93134623165", money_source={"payment-card"=>{}}>
-```
-
-#### process-external-payment method
-
-Making a payment. The application calls the method up until the final payment status is known (`status`=`success`/`refused`).
-The recommended retry mode is determined by the `next_retry` response field (by default, 5 seconds).
-
-```ruby
-  api = YandexMoney::Api.new(instance_id: INSTANCE_ID)
-  api.process_external_payment({
-    request_id: REQUEST_ID,
-    ext_auth_success_uri: "http://example.com/success",
-    ext_auth_fail_uri: "http://example.com/fail"
-  })
-  #<OpenStruct status="ext_auth_required", acs_params={"cps_context_id"=>"31323039373...93134623165", "paymentType"=>"FC"}, acs_uri="https://m.sp-money.yandex.ru/internal/public-api/to-payment-type">
-```
 
 ## Running tests
 
-Just run it with `rake` command.
-
-## Caveats
-
-This library is very unstable. Pull requests welcome!
-
-## Contributing
-
-1. Fork it ( https://github.com/yandex-money/yandex-money-sdk-ruby/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Write tests with rspec + VCR
-4. Write code
-5. Test code
-6. Commit your changes (`git commit -am 'Add some feature'`)
-7. Push to the branch (`git push origin my-new-feature`)
-8. Create a new Pull Request
+Just run it with `bundle exec rake` command.

data/lib/yandex_money/api.rb

@@ -1,5 +1,7 @@
 require "yandex_money/api/version"
 require "yandex_money/exceptions"
+require "yandex_money/logger/default"
+require "yandex_money/logger/empty"
 require "httparty"
 require "uri"
 require "ostruct"
@@ -16,6 +18,7 @@ module YandexMoney
     # Returns url to get token
     def initialize(options)
       # TOKEN provided
+      @logger = options[:logger] || YandexMoney::Logger::Empty.new(STDOUT)
       if options.length == 1 && options[:token] != nil
         @token = options[:token]
       else
@@ -44,8 +47,9 @@ module YandexMoney
         redirect_uri: @redirect_url
       }
       options[:client_secret] = client_secret if client_secret
-      @token = self.class.post(uri, body: options)
-                         .parsed_response["access_token"]
+      @logger.info("url: https://sp-money.yandex.ru#{uri}, params: #{URI.encode_www_form options}")
+      response = self.class.post(uri, body: options).parsed_response
+      @token = response["access_token"]
     end
 
     # obtains account info
@@ -74,29 +78,12 @@ module YandexMoney
 
     # basic request payment method
     def request_payment(options)
-      check_token
-      response = with_http_retries do
-        request = send_request("/api/request-payment", options)
-        OpenStruct.new request.parsed_response
-      end
-      if response.error
-        raise YandexMoney::ApiError.new response.error
-      else
-        response
-      end
+      send_payment_request("/api/request-payment", options)
     end
 
     # basic process payment method
     def process_payment(options)
-      check_token
-      request = send_request("/api/process-payment", options)
-      response = OpenStruct.new request.parsed_response
-
-      if response.error
-        raise YandexMoney::ApiError.new response.error
-      else
-        response
-      end
+      send_payment_request("/api/process-payment", options)
     end
 
     def get_instance_id
@@ -150,7 +137,6 @@ module YandexMoney
     def process_external_payment(payment_options)
       payment_options[:instance_id] ||= @instance_id
       request = send_request("/api/process-external-payment", payment_options)
-
       if request["status"] == "refused"
         raise YandexMoney::ApiError.new request["error"]
       elsif request["status"] == "in_progress"
@@ -163,10 +149,12 @@ module YandexMoney
     private
 
     def send_request(uri, options = nil)
+      @logger.info("url: https://money.yandex.ru#{uri}, bearer: #{@logger.mask_token(@token)}, params: #{URI.encode_www_form options || {}}")
       request = self.class.post(uri, base_uri: "https://money.yandex.ru", headers: {
         "Authorization" => "Bearer #{@token}",
         "Content-Type" => "application/x-www-form-urlencoded"
       }, body: options)
+      @logger.info("response: #{request.response.body}")
 
       case request.response.code
       when "403" then raise YandexMoney::InsufficientScopeError
@@ -175,13 +163,14 @@ module YandexMoney
       end
     end
 
-    # Retry when errors
-    def with_http_retries(&block)
-      begin
-        yield
-      rescue Errno::ECONNREFUSED, SocketError, Net::ReadTimeout
-        sleep 1
-        retry
+    def send_payment_request(uri, options)
+      check_token
+      request = send_request(uri, options)
+      response = OpenStruct.new request.parsed_response
+      if response.error
+        raise YandexMoney::ApiError.new response.error
+      else
+        response
       end
     end
 
@@ -191,6 +180,7 @@ module YandexMoney
 
     def send_authorize_request(options)
       uri = "/oauth/authorize"
+      @logger.info("url: https://money.yandex.ru#{uri}, params: #{URI.encode_www_form options || {}}")
       self.class.post(uri, body: options).request.path.to_s
     end
   end

data/lib/yandex_money/api/version.rb

@@ -1,5 +1,5 @@
 module YandexMoney
   class Api
-    VERSION = "0.10.0"
+    VERSION = "0.11.0"
   end
 end

data/lib/yandex_money/logger/default.rb

@@ -0,0 +1,17 @@
+require "logger"
+
+module YandexMoney
+  module Logger
+    class Default < ::Logger
+      # if token exists, then extract first 8 symbols
+      # and last 8 symbols, and join it with ".."
+      def mask_token(token)
+        if token
+          token.match(/\A(.?{8}).*?(.?{8})\z/)[1,2].join("..")
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/yandex_money/logger/empty.rb

@@ -0,0 +1,10 @@
+require "logger"
+
+module YandexMoney
+  module Logger
+    class Empty < Default
+      def info(text)
+      end
+    end
+  end
+end

data/spec/logger_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+
+describe "logger" do
+  it "should log to provided logger" do
+    @logger = double
+    expect(@logger).to receive(:info).at_least(:once)
+
+    VCR.use_cassette "obtain token for get account info" do
+      @api = YandexMoney::Api.new(
+        client_id: CLIENT_ID,
+        redirect_uri: REDIRECT_URI,
+        scope: "account-info operation-history operation-details",
+        logger: @logger
+      )
+      @api.code = "39041180F6631E2B56DD0058F75A34C7504226178A45D624313495ECD417DCC3AA6CBF1B010E65BB09F3F9EB5AE63452129BAE2B732B7457C33BE6B2039B7B60A8058D2A387729A601DC817BBFB27CB0CC2D65E3C70997D981AC0E31F18CF32C0675DFD461E2F5C5639B75AC0E5074CE64FCF4546447BBDC566E3459FB1B3C3B"
+      @api.obtain_token
+    end
+  end
+end

data/yandex-money-sdk.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "vcr", "~> 2.9", ">= 2.9.3"
   spec.add_development_dependency "webmock", "~> 1.8", ">= 1.8.0"
   spec.add_development_dependency "rspec", "~> 3.1", ">= 3.1.0"
+  spec.add_development_dependency "rspec-mocks", "~> 3.1", ">= 3.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yandex-money-sdk
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Alexander Maslov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-20 00:00:00.000000000 Z
+date: 2014-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -124,6 +124,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 description: SDK for Yandex Money API
 email:
 - drakmail@delta.pm
@@ -142,6 +162,8 @@ files:
 - lib/yandex_money/api.rb
 - lib/yandex_money/api/version.rb
 - lib/yandex_money/exceptions.rb
+- lib/yandex_money/logger/default.rb
+- lib/yandex_money/logger/empty.rb
 - spec/account_info_spec.rb
 - spec/auth_spec.rb
 - spec/cards_spec.rb
@@ -171,6 +193,7 @@ files:
 - spec/fixtures/vcr_cassettes/success_request_payment_to_an_account.yml
 - spec/fixtures/vcr_cassettes/token_with_client_secret.yml
 - spec/fixtures/vcr_cassettes/unauthorized_exception.yml
+- spec/logger_spec.rb
 - spec/payments_spec.rb
 - spec/spec_helper.rb
 - spec/support/constants.rb
@@ -229,6 +252,7 @@ test_files:
 - spec/fixtures/vcr_cassettes/success_request_payment_to_an_account.yml
 - spec/fixtures/vcr_cassettes/token_with_client_secret.yml
 - spec/fixtures/vcr_cassettes/unauthorized_exception.yml
+- spec/logger_spec.rb
 - spec/payments_spec.rb
 - spec/spec_helper.rb
 - spec/support/constants.rb