yandex-money-sdk 0.11.0 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e244659ec433db17836ed23c99ec4c29cf9aaa96
-  data.tar.gz: aaa309b840e92f5e1c592b53199af46cbb421d4b
+  metadata.gz: 478c50bf64ad5fb25f23a2729b39f102f76e14af
+  data.tar.gz: 22ef302f42e010a897513e38bcbfb7035655fc42
 SHA512:
-  metadata.gz: 0d4c9c824d457f59ddf75833a25612e54f90421ca7730638bf1521adbcaf81e6840f9e2a1b1778326d6336e44d3d7b0519faa7abda7ea5dcb4d91abea10df848
-  data.tar.gz: 5e648204b9d54e34109e9785ce15dc6051d530371617a19c6c90ccd6d4e5a13f4d19a2c21acd80326fb7d7f2e8e2a7b9fe1bd8d16f01a1464b82f942abcaabec
+  metadata.gz: 03fa5e4c1a9c14b3ccee965056f963fe2e99e9d43cfef5ac9fbd64c51caeae9ac8696bc90f59da4ec93312b71f45413a098774a5b963ad644497f291d1a23091
+  data.tar.gz: 29b8a373243901e0ab736c3fd81845c5138e04fbaf2637b05fa31d45b0f717cabf4ef3812cae448718b21d0c7d94cb889774192e1b41a19ab8ac8a927863be34

data/.gitignore

@@ -22,3 +22,4 @@ tmp
 mkmf.log
 .DS_Store
 *.swp
+spec/support/constants.rb

data/.travis.yml

@@ -1,13 +1,16 @@
 language: ruby
-script: "rake"
+script: rake
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
+- 1.9.3
+- 2.0.0
+- 2.1.0
 matrix:
   include:
-    - rvm: jruby-19mode
-    - rvm: rbx-2
+  - rvm: jruby-19mode
+  - rvm: rbx-2
   fast_finish: true
 branches:
   only: master
+before_install:
+- openssl aes-256-cbc -K $encrypted_b75809a34a66_key -iv $encrypted_b75809a34a66_iv
+  -in constants.rb.enc -out spec/support/constants.rb -d

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/CHANGELOG.md

@@ -1,6 +1,38 @@
-# 0.11.0 (September 26, 2014)
+# 1.0.5 (April 3, 2015)
+
+Release of 1.0.5 version.
+
+# 1.0.4pre (December 9, 2014)
+
+Now you could set API url through config:
+
+```
+YandexMoney.configure do |config|
+  config.money_url = "https://money.yandex.ru"
+  config.sp_money_url = "https://sp-money.yandex.ru"
+end
+```
+
+# 1.0.3pre (November 25, 2014)
+
+Some API changes - now exceptions raised only for 4xx and 500 error codes, changed returned values.
+
+# 1.0.2pre (November 10, 2014)
+
+Big refactoring of specs, they are can run without vcr cassettes with success, small fixes in README, list of operations in operations history now are OpenStruct, not hash.
+
+# 1.0.1pre (November 7, 2014)
+
+Change OpenStruct to RecursiveOpenStruct in all responses.
+
+# 1.0.0pre (October 29, 2014)
+
+Totally new API (like in other implementations), temporally removed logger, removed `spec/support/constants` from git (for travis now it encrypted).
+
+# 0.11.0 (October 14, 2014)
 
 Disable handling of HTTP errors inside gem in `process_payment` method.
+Add support for logging.
 
 # 0.10.0 (September 20, 2014)
 

data/README.md

@@ -54,12 +54,11 @@ 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 = YandexMoney::Wallet.build_obtain_token_url(
+      CLIENT_ID,
+      REDIRECT_URI,
+      "account-info operation-history" # SCOPE
     )
-    auth_url = api.client_url
     ```
 
 2. After that, user fills Yandex.Money HTML form and user is redirected back to
@@ -68,21 +67,27 @@ when [register](https://sp-money.yandex.ru/myservices/new.xml) app in Yandex.Mon
 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"
+    access_token = YandexMoney::Wallet.get_access_token(
+      CLIENT_ID,
+      CODE,
+      REDIRECT_URI
     )
-    api.code = params[:code] # obtained code
-    access_token = api.obtain_token
     # or, if client secret defined:
-    # access_token = api.obtain_token(CLIENT_SECRET)
+    access_token = YandexMoney::Wallet.get_access_token(
+      CLIENT_ID,
+      CODE,
+      REDIRECT_URI,
+      CLIENT_SECRET
+    )
     ```
 
+    If `access_token` couldn't be obtained, `YandexMoney::ApiError` expection will be raised.
+
+
 4. Now you can use Yandex.Money API.
 
     ```ruby
-    api = YandexMoney::Api.new(token: TOKEN) # TOKEN is obtained token
+    api = YandexMoney::Wallet.new(access_token)
     account_info = api.account_info
     balance = account_info.balance # and so on
 
@@ -116,22 +121,13 @@ when [register](https://sp-money.yandex.ru/myservices/new.xml) app in Yandex.Mon
 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
+    instance_id = YandexMoney::ExternalPayment.get_instance_id(CLIENT_ID)
     ```
 
 2. Make request payment
 
     ```ruby
-    api = YandexMoney::Api.new(
-      client_id: CLIENT_ID,
-      instance_id: INSTANCE_ID
-    )
+    api = YandexMoney::ExternalPayment.new(INSTANCE_ID)
     response = api.request_external_payment({
       pattern_id: "p2p",
       to: "410011285611534",
@@ -148,7 +144,7 @@ result in DB).
 3. Process the request with process-payment. 
 
     ```ruby
-    api = YandexMoney::Api.new(instance_id: INSTANCE_ID)
+    api = YandexMoney::ExternalPayment.new(INSTANCE_ID)
     result = api.process_external_payment({
       request_id: REQUEST_ID,
       ext_auth_success_uri: "http://example.com/success",
@@ -160,4 +156,4 @@ result in DB).
 
 ## Running tests
 
-Just run it with `bundle exec rake` command.
+Fill values in `spec/support/constants.rb` file (example could be found in `spec/support/constants.example.rb`) and after this just run tests with `bundle exec rake` command.

data/lib/yandex_money/api.rb

@@ -1,187 +1,5 @@
 require "yandex_money/api/version"
+require "yandex_money/config"
 require "yandex_money/exceptions"
-require "yandex_money/logger/default"
-require "yandex_money/logger/empty"
-require "httparty"
-require "uri"
-require "ostruct"
-
-module YandexMoney
-  class Api
-    include HTTParty
-
-    base_uri "https://sp-money.yandex.ru"
-    default_timeout 30
-
-    attr_accessor :client_url, :code, :token, :instance_id
-
-    # 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
-        @client_id = options[:client_id]
-        @redirect_uri = options[:redirect_uri]
-        @instance_id = options[:instance_id]
-        if options[:scope] != nil
-          @client_url = send_authorize_request(
-            client_id: @client_id,
-            response_type: "code",
-            redirect_uri: @redirect_uri,
-            scope: options[:scope]
-          )
-        end
-      end
-    end
-
-    # obtains and saves token from code
-    def obtain_token(client_secret = nil)
-      raise YandexMoney::FieldNotSetError.new(:code) if @code == nil
-      uri = "/oauth/token"
-      options = {
-        code: @code,
-        client_id: @client_id,
-        grant_type: "authorization_code",
-        redirect_uri: @redirect_url
-      }
-      options[:client_secret] = client_secret if client_secret
-      @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
-    def account_info
-      check_token
-      OpenStruct.new send_request("/api/account-info").parsed_response
-    end
-
-    # obtains operation history
-    def operation_history(options=nil)
-      check_token
-      OpenStruct.new send_request("/api/operation-history", options).parsed_response
-    end
-
-    # obtains operation details
-    def operation_details(operation_id)
-      check_token
-      request = send_request("/api/operation-details", operation_id: operation_id)
-      details = OpenStruct.new request.parsed_response
-      if details.error
-        raise YandexMoney::ApiError.new details.error
-      else
-        details
-      end
-    end
-
-    # basic request payment method
-    def request_payment(options)
-      send_payment_request("/api/request-payment", options)
-    end
-
-    # basic process payment method
-    def process_payment(options)
-      send_payment_request("/api/process-payment", options)
-    end
-
-    def get_instance_id
-      request = send_request("/api/instance-id", client_id: @client_id)
-      if request["status"] == "refused"
-        raise YandexMoney::ApiError.new request["error"]
-      else
-        request["instance_id"]
-      end
-    end
-
-    def incoming_transfer_accept(operation_id, protection_code = nil)
-      uri = "/api/incoming-transfer-accept"
-      if protection_code
-        request_body = {
-          operation_id: operation_id,
-          protection_code: protection_code
-        }
-      else
-        request_body = { operation_id: operation_id }
-      end
-      request = send_request("/api/incoming-transfer-accept", request_body)
-
-      if request["status"] == "refused"
-        raise YandexMoney::AcceptTransferError.new request["error"], request["protection_code_attempts_available"]
-      else
-        true
-      end
-    end
-
-    def incoming_transfer_reject(operation_id)
-      request = send_request("/api/incoming-transfer-reject", operation_id: operation_id)
-
-      if request["status"] == "refused"
-        raise YandexMoney::ApiError.new request["error"]
-      else
-        true
-      end
-    end
-
-    def request_external_payment(payment_options)
-      payment_options[:instance_id] ||= @instance_id
-      request = send_request("/api/request-external-payment", payment_options)
-      if request["status"] == "refused"
-        raise YandexMoney::ApiError.new request["error"]
-      else
-        OpenStruct.new request.parsed_response
-      end
-    end
-
-    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"
-        raise YandexMoney::ExternalPaymentProgressError.new request["error"], request["next_retry"]
-      else
-        OpenStruct.new request.parsed_response
-      end
-    end
-
-    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
-      when "401" then raise YandexMoney::UnauthorizedError.new request["www-authenticate"]
-      else request
-      end
-    end
-
-    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
-
-    def check_token
-      raise YandexMoney::FieldNotSetError.new(:token) unless @token
-    end
-
-    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
-end
+require "yandex_money/wallet"
+require "yandex_money/external_payment"

data/lib/yandex_money/api/version.rb

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

data/lib/yandex_money/config.rb

@@ -0,0 +1,26 @@
+module YandexMoney
+  class << self
+    attr_writer :config
+
+    def config
+      @config ||= Config.new
+    end
+
+    def configure
+      yield(config)
+    end
+
+    def reset_config
+      @config = Config.new
+    end
+  end
+
+  class Config
+    attr_accessor :money_url, :sp_money_url
+
+    def initialize
+      @money_url = "https://money.yandex.ru"
+      @sp_money_url = "https://sp-money.yandex.ru"
+    end
+  end
+end

data/lib/yandex_money/exceptions.rb

@@ -1,18 +1,28 @@
 module YandexMoney
   class Error < StandardError; end
 
-  class InsufficientScopeError < Error; end
-
-  class UnauthorizedError < Error
+  class ErrorWithMessage < Error
     def initialize(error)
       @err = error
     end
 
     def message
-      @err
+      if @err["www-authenticate"]
+        "#{@err.msg} - #{@err["www-authenticate"]}"
+      else
+        @err.msg
+      end
     end
   end
 
+  class InsufficientScopeError < ErrorWithMessage; end
+
+  class InvalidRequestError < ErrorWithMessage; end
+
+  class UnauthorizedError < ErrorWithMessage; end
+
+  class ServerError < Error; end
+
   class FieldNotSetError < Error
     def initialize(field)
       @field = field

data/lib/yandex_money/external_payment.rb

@@ -0,0 +1,78 @@
+module YandexMoney
+  # Payments from bank cards without authorization
+  #
+  # @see http://api.yandex.com/money/doc/dg/reference/process-external-payments.xml
+  # @see https://tech.yandex.ru/money/doc/dg/reference/process-external-payments-docpage/
+  class ExternalPayment
+    def initialize(instance_id)
+      @instance_id = instance_id
+    end
+
+    # Registers instance of application
+    #
+    # @see http://api.yandex.com/money/doc/dg/reference/instance-id.xml
+    # @see https://tech.yandex.ru/money/doc/dg/reference/instance-id-docpage/
+    #
+    # @param client_id [String] An identifier of application
+    #
+    # @raise [YandexMoney::InvalidRequestError] HTTP request does not conform to protocol format. Unable to parse HTTP request, or the Authorization header is missing or has an invalid value.
+    # @raise [YandexMoney::ServerError] A technical error occurs (the server responds with the HTTP code 500 Internal Server Error). The application should repeat the request with the same parameters later.
+    #
+    # @return [RecursiveOpenStruct] A status of operation
+    def self.get_instance_id(client_id)
+      request = send_external_payment_request("/api/instance-id", client_id: client_id)
+      RecursiveOpenStruct.new request.parsed_response
+    end
+
+    # Requests a external payment
+    #
+    # @see http://api.yandex.com/money/doc/dg/reference/request-external-payment.xml
+    # @see https://tech.yandex.ru/money/doc/dg/reference/request-external-payment-docpage/
+    #
+    # @param payment_options [Hash] Method's parameters. Check out docs for more information.
+    #
+    # @raise [YandexMoney::InvalidRequestError] HTTP request does not conform to protocol format. Unable to parse HTTP request, or the Authorization header is missing or has an invalid value.
+    # @raise [YandexMoney::ServerError] A technical error occurs (the server responds with the HTTP code 500 Internal Server Error). The application should repeat the request with the same parameters later.
+    #
+    # @return [RecursiveOpenStruct] A struct, containing `payment_id` and additional information about a recipient and payer
+    def request_external_payment(payment_options)
+      payment_options[:instance_id] = @instance_id
+      request = self.class.send_external_payment_request("/api/request-external-payment", payment_options)
+      RecursiveOpenStruct.new request.parsed_response
+    end
+
+    # Confirms a payment that was created using the request-extenral-payment method
+    #
+    # @see http://api.yandex.com/money/doc/dg/reference/process-external-payment.xml
+    # @see https://tech.yandex.ru/money/doc/dg/reference/process-external-payment-docpage/
+    #
+    # @param payment_options [Hash] Method's parameters. Check out docs for more information.
+    #
+    # @raise [YandexMoney::InvalidRequestError] HTTP request does not conform to protocol format. Unable to parse HTTP request, or the Authorization header is missing or has an invalid value.
+    # @raise [YandexMoney::ServerError] A technical error occurs (the server responds with the HTTP code 500 Internal Server Error). The application should repeat the request with the same parameters later.
+    #
+    # @return [RecursiveOpenStruct] A status of payment and additional steps for authorization (if needed)
+    def process_external_payment(payment_options)
+      payment_options[:instance_id] = @instance_id
+      request = self.class.send_external_payment_request("/api/process-external-payment", payment_options)
+      RecursiveOpenStruct.new request.parsed_response
+    end
+
+    private
+
+    def self.send_external_payment_request(uri, options)
+      request = HTTParty.post(uri, base_uri: YandexMoney.config.money_url, headers: {
+        "Content-Type" => "application/x-www-form-urlencoded"
+      }, body: options)
+      case request.response.code
+      when "400" then raise YandexMoney::InvalidRequestError.new request.response
+      when "401" then raise YandexMoney::UnauthorizedError.new request.response
+      when "403" then raise YandexMoney::InsufficientScopeError request.response
+      when "500" then raise YandexMoney::ServerError
+      else
+        request
+      end
+    end
+
+  end
+end