checkout_ru 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0a282cdafe5a22eec40082c3a726a2f07dff009
-  data.tar.gz: f34819469e964ef1fbb497bd696ced3f7fd78bab
+  metadata.gz: 67ba1776758aff93812e8db9601160ee5a095719
+  data.tar.gz: 6b6c449d9ca9aabb1ed0edf0ca63872f1a934922
 SHA512:
-  metadata.gz: ce436024add082677decc45b29a184cbc6e654352f3341b78815161ffce4ffcda4072242ca41e97c6e9311a43972c3c28709931dc60cad29473ccff24d075c14
-  data.tar.gz: f1db0972f18d62420b22662d0ff148af31df5ec01fa38c32cfb9f8962d74d9a878d64cb31176def6f5863635d98b2c7ec92e7eba6991deeb866c0896ee32f57e
+  metadata.gz: 442d13b106ee8ab3ab8a2375e99ade2b04eb699e412b8185452c8c88ee975065fc25219c038cd7a4f0a53b18232b16b5b9c841f28c37d81da12fe7a65e5b1466
+  data.tar.gz: 05d23e0922f1765dfffcb77c26dc5e74faef7f9103a27eb0f1f090b028a95a797ad78e29016cd13e7abf6a9b43dcd7e2bdbfd06b7c3603d047c56baae10aed8d

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.5.1
+
+- Support for first specialized error: CheckoutRu::NoDeliveryFoundError.
+  It's descendant from CheckoutRu::Error so doesn't break existing rescue code.
+  It's raised when checkout.ru has no delivery for certain settlement id.
+- All CheckoutRu::Error exceptions now have `code` attribute
+
 ## 0.5.0
 
 - Support new JSON errors (includes support for JSON expired-ticket response)

data/lib/checkout_ru.rb

@@ -11,7 +11,6 @@ require 'checkout_ru/order'
 
 module CheckoutRu
   SERVICE_URL = 'http://platform.checkout.ru'.freeze
-  Error = Class.new(RuntimeError)
 
   class << self
     attr_accessor \

data/lib/checkout_ru/error.rb

@@ -0,0 +1,34 @@
+module CheckoutRu
+  class Error < RuntimeError
+    class << self
+      def construct(response)
+        code, message = parse_error_response(response)
+        error_message = "#{message} (checkout.ru error, code #{code})"
+
+        case code
+        when 4   then NoDeliveryFoundError.new(error_message, code)
+        when nil then new(response.inspect)
+        else new(error_message, code)
+        end
+      end
+
+      def parse_error_response(response)
+        if response.respond_to?(:[]) &&
+          response[:error_code] &&
+          response[:error_message]
+
+          [response[:error_code], response[:error_message]]
+        end
+      end
+    end
+
+    attr_reader :code
+
+    def initialize(message, code = nil)
+      @code = code
+      super(message)
+    end
+  end
+
+  NoDeliveryFoundError = Class.new(Error)
+end

data/lib/checkout_ru/expired_ticket_response.rb

@@ -0,0 +1,37 @@
+module CheckoutRu
+  class ExpiredTicketResponse
+    attr_reader :response
+
+    def initialize(response)
+      @response = response || {}
+    end
+
+    def match?
+      # Checkout.ru changed (broke) invalid ticket responses a few times. These
+      # predicates reflect various ways we've seen that tickets can expire.
+      json_style_error_after_jan_2015? ||
+        old_style_error_before_jan_2015? ||
+        broken_error_as_of_oct_06_2014?
+    end
+
+    def json_style_error_after_jan_2015?
+      error && error_code == 3 && error_message =~ /is\s+expired\s+or\s+invalid/
+    end
+
+    def old_style_error_before_jan_2015?
+      [400, 500].include?(status) && body =~ /is\s+expired\s+or\s+invalid/
+    end
+
+    def broken_error_as_of_oct_06_2014?
+      status == 500 && body =~ /Сервис\s+временно\s+не\s+доступен/
+    end
+
+    private
+
+    def error;         response[:error]         end
+    def error_code;    response[:error_code]    end
+    def error_message; response[:error_message] end
+    def body;          response[:body]          end
+    def status;        response[:status]        end
+  end
+end

data/lib/checkout_ru/session.rb

@@ -1,27 +1,8 @@
+require 'checkout_ru/expired_ticket_response'
+require 'checkout_ru/error'
+
 module CheckoutRu
   class Session
-    # Checkout.ru changed (broke) invalid ticket responses a few times. These
-    # hashes reflect various ways we've seen up to date that ticket can expire.
-    EXPIRED_TICKET_MATCHERS = [
-      # the new JSON errors
-      lambda { |r|
-        r[:error] &&
-          r[:error_code] == 3 &&
-          r[:error_message] =~ /is\s+expired\s+or\s+invalid/
-      },
-
-      # before JSON errors were introduced
-      lambda { |r|
-        [400, 500].include?(r[:status]) &&
-          r[:body] =~ /is\s+expired\s+or\s+invalid/
-      },
-
-      # broken style as of 10-06-14
-      lambda { |r|
-        r[:status] == 500 && r[:body] =~ /Сервис\s+временно\s+не\s+доступен/
-      }
-    ].freeze
-
     class << self
       def initiate
         ticket = CheckoutRu.get_ticket
@@ -81,10 +62,7 @@ module CheckoutRu
       end
 
       if parsed_response[:error]
-        msg = "Error code: #{parsed_response[:error_code]}. "\
-          "Error message: #{parsed_response[:error_message]}"
-
-        raise Error, msg
+        raise Error.construct(parsed_response)
       end
 
       parsed_response
@@ -95,9 +73,7 @@ module CheckoutRu
     end
 
     def expired_ticket?(parsed_response)
-      parsed_response && EXPIRED_TICKET_MATCHERS.any? do |matcher|
-        matcher.call(parsed_response)
-      end
+      ExpiredTicketResponse.new(parsed_response).match?
     end
   end
 end

data/lib/checkout_ru/version.rb

@@ -1,3 +1,3 @@
 module CheckoutRu
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

data/test/checkout_ru/expired_ticket_response_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+class ExpiredTicketResponseTest < MiniTest::Test
+  def test_json_style_error_after_jan_2015_is_recognized
+    response = {
+      error: true, error_code: 3, error_message: "Ticket is expired or invalid"
+    }
+
+    assert CheckoutRu::ExpiredTicketResponse.new(response).match?
+  end
+
+  def test_old_style_error_before_jan_2015_is_recognized
+    response1 = { status: 400, body: "Ticket is expired or invalid" }
+    response2 = { status: 500, body: "Ticket is expired or invalid" }
+
+    assert CheckoutRu::ExpiredTicketResponse.new(response1).match?
+    assert CheckoutRu::ExpiredTicketResponse.new(response2).match?
+  end
+
+  def test_broken_error_as_of_oct_06_2014_is_recognzied
+    response = { status: 500, body: "Сервис временно не доступен" }
+    assert CheckoutRu::ExpiredTicketResponse.new(response).match?
+  end
+end

data/test/checkout_ru/session_test.rb

@@ -85,4 +85,22 @@ class CheckoutRu::SessionTest < MiniTest::Test
       assert_equal 'г. Москва', place.full_name
     end
   end
+
+  def test_get_no_delivery_found_error
+    VCR.use_cassette('get_no_delivery_found_error') do
+      error = assert_raises(CheckoutRu::NoDeliveryFoundError) do
+        @session.calculation(
+          :place_id     => 'b0122c31-eb1c-40ae-b998-08f9e99a0fa1',
+          :total_sum    => 1500,
+          :assessed_sum => 2000,
+          :items_count  => 2,
+          :total_weight => 1
+        )
+      end
+
+      assert_equal 4, error.code
+      assert_match /no delivery found/, error.message
+      assert_match /code 4/, error.message
+    end
+  end
 end

data/test/checkout_ru_test.rb

@@ -71,8 +71,6 @@ class CheckoutRuTest < MiniTest::Test
     end
   end
 
-  # Test is broken. Request on update returns error status without description.
-  #    Must be discussed in skype with support.
   def test_update_order
     VCR.use_cassette('update_order') do
       id = create_order

data/test/fixtures/get_no_delivery_found_error.yml

@@ -0,0 +1,103 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://platform.checkout.ru/service/checkout/calculation?placeId=b0122c31-eb1c-40ae-b998-08f9e99a0fa1&totalSum=1500&assessedSum=2000&itemsCount=2&totalWeight=1&ticket=tests-will-autorequest-a-valid-ticket
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+      Accept:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      server:
+      - nginx/1.7.7
+      date:
+      - Wed, 28 Jan 2015 00:46:24 GMT
+      content-type:
+      - application/json;charset=UTF-8
+      transfer-encoding:
+      - chunked
+      connection:
+      - close
+      set-cookie:
+      - JSESSIONID=B7124F28808555872014EE6D7E9BAF26.srv100; Path=/; HttpOnly
+    body:
+      encoding: UTF-8
+      string: '{"error":true,"errorCode":3,"errorMessage":"ticket: ticket is expired
+        or invalid; "}'
+    http_version: 
+  recorded_at: Wed, 28 Jan 2015 00:46:24 GMT
+- request:
+    method: get
+    uri: http://platform.checkout.ru/service/login/ticket/valid-api-key
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+      Accept:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      server:
+      - nginx/1.7.7
+      date:
+      - Wed, 28 Jan 2015 00:46:24 GMT
+      content-type:
+      - application/json;charset=UTF-8
+      content-length:
+      - '113'
+      connection:
+      - close
+    body:
+      encoding: UTF-8
+      string: '{"ticket":"211e40247d084107eedfcf4ebc5fffb8", "receiverEmailNotRequired":"false",
+        "isCashOnDeliveryOnly":"false"}'
+    http_version: 
+  recorded_at: Wed, 28 Jan 2015 00:46:25 GMT
+- request:
+    method: get
+    uri: http://platform.checkout.ru/service/checkout/calculation?placeId=b0122c31-eb1c-40ae-b998-08f9e99a0fa1&totalSum=1500&assessedSum=2000&itemsCount=2&totalWeight=1&ticket=211e40247d084107eedfcf4ebc5fffb8
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+      Accept:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      server:
+      - nginx/1.7.7
+      date:
+      - Wed, 28 Jan 2015 00:46:25 GMT
+      content-type:
+      - application/json;charset=UTF-8
+      transfer-encoding:
+      - chunked
+      connection:
+      - close
+      set-cookie:
+      - JSESSIONID=0367069015CE5D427494A3220B42CE5D.srv100; Path=/; HttpOnly
+    body:
+      encoding: UTF-8
+      string: '{"error":true,"errorCode":4,"errorMessage":"no delivery found for place
+        specified"}'
+    http_version: 
+  recorded_at: Wed, 28 Jan 2015 00:46:25 GMT
+recorded_with: VCR 2.9.0

data/test/test_helper.rb

@@ -5,7 +5,9 @@ require 'vcr'
 require 'cgi'
 
 REAL_API_KEY = ENV['CHECKOUT_RU_API_KEY']
-CheckoutRu.api_key = ENV['CHECKOUT_RU_API_KEY'] || 'valid-api-key'
+FAKE_API_KEY = 'valid-api-key'
+
+CheckoutRu.api_key = REAL_API_KEY || FAKE_API_KEY
 CheckoutRu.auto_renew_session = true
 
 VCR.configure do |c|
@@ -13,7 +15,7 @@ VCR.configure do |c|
   c.hook_into :faraday
 
   if REAL_API_KEY
-    c.filter_sensitive_data('valid-api-key') { CheckoutRu.api_key }
+    c.filter_sensitive_data(FAKE_API_KEY) { REAL_API_KEY }
   end
 
   c.before_record do |i|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkout_ru
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Maxim Chernyak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-21 00:00:00.000000000 Z
+date: 2015-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -182,15 +182,19 @@ files:
 - lib/checkout_ru/address.rb
 - lib/checkout_ru/delivery.rb
 - lib/checkout_ru/entity.rb
+- lib/checkout_ru/error.rb
+- lib/checkout_ru/expired_ticket_response.rb
 - lib/checkout_ru/item.rb
 - lib/checkout_ru/order.rb
 - lib/checkout_ru/session.rb
 - lib/checkout_ru/user.rb
 - lib/checkout_ru/version.rb
+- test/checkout_ru/expired_ticket_response_test.rb
 - test/checkout_ru/session_test.rb
 - test/checkout_ru_test.rb
 - test/fixtures/calculation.yml
 - test/fixtures/create_order.yml
+- test/fixtures/get_no_delivery_found_error.yml
 - test/fixtures/get_place_by_postal_code.yml
 - test/fixtures/get_places_by_query.yml
 - test/fixtures/get_postal_code_by_address.yml
@@ -227,10 +231,12 @@ signing_key:
 specification_version: 4
 summary: Ruby client for checkout.ru
 test_files:
+- test/checkout_ru/expired_ticket_response_test.rb
 - test/checkout_ru/session_test.rb
 - test/checkout_ru_test.rb
 - test/fixtures/calculation.yml
 - test/fixtures/create_order.yml
+- test/fixtures/get_no_delivery_found_error.yml
 - test/fixtures/get_place_by_postal_code.yml
 - test/fixtures/get_places_by_query.yml
 - test/fixtures/get_postal_code_by_address.yml