yaka 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36c144585b7419aad297e628678093039ee6b896bc48ba43c155928574988079
-  data.tar.gz: b9088bdef6e24e0a2ab2c38784f722bf64c25d0d31d903c3c7bda6b468285cc6
+  metadata.gz: 974f7ba0a3bdd56aaddef4625ee7e57be4235fd09cb310b489b19c21bb59dd20
+  data.tar.gz: 2be2cf7054857aac7575a794ec8b99e4eb822f31362beca6c6e629775d5d38e7
 SHA512:
-  metadata.gz: 8375c0979cc280b0d2b722846e9e1f2fc20918e7b8c341c9230c72bf5640fc790ed0b4b64acf64a14db0e74a3c107bb0293543a996ba9867da25faed6dc33b63
-  data.tar.gz: 3097195b9e4054ef88c4a84c1fca9cce5132e2e7b732714d43e96173a1b1e3804fd58f15191cfe644e9c05691641aea2b87b9a309eaf318e335dd57b2189e0f3
+  metadata.gz: 861fd5d7f14efb25be050277d31a03c6b268f3cf66b79cf18a079bfb2eb56481b2b0497b71148a1cca5a928680730c0010ee7cba227483c50965d73bf367184a
+  data.tar.gz: b9f0ec56e9d7ff01168043f8301984a923ca5bf5e84fcedb10660fa571b1a9097ac77458eb6ec13388dc8ff3f2b78254849b38fbb4c6ce9091ee8a273bfbb7d5

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 1.0.0
+Breaking changes
+* Simplified class model
+* Added wrapper for card payments
+* Added Check for Yandex IP(for callback)
 
 # 0.0.1
 Initial release

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    yaka (0.0.1)
+    yaka (1.0.0)
       dry-configurable
-      faker
+      dry-struct
       faraday
       oj
       pry
@@ -11,26 +11,54 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
     coderay (1.1.2)
     concurrent-ruby (1.1.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
     dry-configurable (0.8.3)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.4, >= 0.4.7)
+    dry-container (0.7.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
     dry-core (0.4.7)
       concurrent-ruby (~> 1.0)
+    dry-equalizer (0.2.2)
+    dry-inflector (0.1.2)
+    dry-logic (1.0.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-struct (1.0.0)
+      dry-core (~> 0.4, >= 0.4.3)
+      dry-equalizer (~> 0.2)
+      dry-types (~> 1.0)
+      ice_nine (~> 0.11)
+    dry-types (1.0.0)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.2, >= 0.2.2)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0)
     faker (1.9.3)
       i18n (>= 0.7)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
+    hashdiff (0.4.0)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
     method_source (0.9.2)
     multipart-post (2.1.1)
     oj (3.7.12)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
+    public_suffix (3.1.0)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -45,14 +73,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    safe_yaml (1.0.5)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.17)
+  faker
   rake (~> 10.0)
   rspec (~> 3.0)
+  webmock
   yaka!
 
 BUNDLED WITH

data/README.md

@@ -20,7 +20,61 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+1. Attach gem for your project
+2. Create initializer for your project that will set `shop_id` and `private_key`.
+    ```ruby
+    # yaka.rb
+     
+    Yaka.config.shop_id = ENV['YANDEX_SHOP_ID']
+    Yaka.config.private_key = ENV['YANDEX_PRIVATE_KEY']
+    ```
+3. Create payment at client side:
+    ```html
+        <script src="https://static.yandex.net/checkout/js/v1/"></script>
+         <script src="https://static.yandex.net/checkout/ui/v1/"></script>
+         <button class="btn" onclick="$checkout.open()">Pay 100</button>
+         <script>
+           const $checkout = YandexCheckoutUI(<%= Yaka.config.shop_id %>, {amount: 100});
+           $checkout.on('yc_success', function(response) {
+             $.ajax({
+               url: "/route_for_yandex_kassa",
+               type: 'POST',
+               dataType: "json",
+               contentType: "application/json; charset=utf-8",
+               data: JSON.stringify({
+                 redirect_url: 'https://example.com',
+                 token: response.data.response.paymentToken,
+                 amount: 100,
+                 json_data: {ololo: 4}
+               })
+             }).then(x => {
+                 if (x.status === "succeeded") {
+                   $checkout.chargeSuccessful();
+                 } else {
+                   if (x.status === "pending") {
+                     window.location = x.confirmation.confirmation_url;
+                   } else {
+                     $checkout.chargeFailful();
+                   }
+                 }
+               }
+             );
+           });
+    ```
+4. Create payment at backend side:
+    
+    Token is received from front-end(`token` from the code above).
+    ```ruby
+    payment = Yaka::Payment.new(amount: params[:amount], description: "Пополнение счета через карту", payment_token: params[:token], metadata: params[:json_data], client_ip: request.remote_ip, confirmation: { type: "redirect", return_url: params[:redirect_url]})
+    response = Yaka.publish_payment(payment, SecureRandom.uuid)
+    ```
+    If payment is successful - you will receive status `succeeded`. 
+    If pending - in `confirmation.confirmation_url` you will have a 3ds confirmation URL. Use it!
+     
+5. Then you will receive a callback about payment attempt(callback is configured at yandex site).
+
+    You can use `Yaka.yandex_ip?(ip)` to check remote ip of received request to avoid scams and cheatings.
+    
 
 ## Development
 

data/lib/yaka/basic_struct.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Yaka
+  module Types
+    include Dry::Types.module
+  end
+
+  class BasicStruct < Dry::Struct
+
+    def self.primitive
+      Types::Hash
+    end
+
+    transform_types do |type|
+      if type.default?
+        type.constructor do |value|
+          value.nil? ? Dry::Types::Undefined : value
+        end
+      else
+        type
+      end
+    end
+
+    transform_keys(&:to_sym)
+
+    def to_json(_args = {})
+      attributes.to_json
+    end
+  end
+end

data/lib/yaka/class_methods.rb

@@ -2,25 +2,34 @@
 
 module Yaka
   module ClassMethods
-    HOST_URL = 'https://payment.yandex.net'
-    PAYMENTS_URL = '/api/v3/payments'
-
-    def publish_payment(payment, token = nil)
-      raise Yaka::Error, 'Only payment should be sent to API' unless payment.is_a?(Yaka::Payment)
+    def publish_payment(data, token = nil)
+      payment = data.is_a?(Yaka::Payment) ? data : Yaka::Payment.new(data)
 
       data = payment.to_json
 
-      conn = Faraday.new(url: HOST_URL) # create a new Connection with base URL
+      conn = Faraday.new(url: Yaka::HOST_URL) # create a new Connection with base URL
       conn.basic_auth(Yaka.config.shop_id, Yaka.config.private_key) # set the Authentication header
 
       @result = conn.post do |req|
-        req.url PAYMENTS_URL
+        req.url Yaka::PAYMENTS_URL
         req.headers['Content-Type'] = 'application/json'
         req.headers['Idempotence-Key'] = token
         req.body = data
       end
 
-      JSON.parse(@result.body)
+      Yaka::PaymentResponse.new(JSON.parse(@result.body))
+    end
+
+    def yandex_ip?(ip)
+      addr = IPAddr.new(ip)
+
+      if addr.ipv4?
+        Yaka::ALLOWED_YANDEX_V4_MASKS.any? { |mask, length| addr.mask(length) == mask }
+      elsif addr.ipv6?
+        Yaka::ALLOWED_YANDEX_V6_MASKS.any? { |mask, length| addr.mask(length) == mask }
+      else
+        raise Yaka::Error, 'Invalid request ip address'
+      end
     end
   end
 end

data/lib/yaka/payment.rb

@@ -1,23 +1,36 @@
 # frozen_string_literal: true
 
 module Yaka
-  class Payment < SerializableObject
-
-    REQUIRED_FIELDS = %i[amount confirmation capture].freeze
-    OPTIONAL_FIELDS = %i[description receipt payment_token metadata].freeze
-
-    attr_accessor(*REQUIRED_FIELDS)
-    attr_accessor(*OPTIONAL_FIELDS)
-
-    def initialize(amount:, client_ip: nil, description: nil, metadata: nil, receipt: nil, payment_token: nil, confirmation: { type: "redirect", return_url: Yaka.config.redirect_url}, capture: true)
-      @amount = amount
-      @receipt = receipt
-      @description = description
-      @payment_token = payment_token
-      @confirmation = confirmation
-      @capture = capture
-      @metadata = metadata
-      @client_ip = client_ip
+  class Payment < BasicStruct
+    # This class is used for sending payments to Yandex Kassa.
+    attribute :amount, BasicStruct do
+      attribute :value, Types::String
+      attribute :currency, Types::String
+    end
+    attribute :confirmation, BasicStruct do
+      attribute :type, Types::String.default('redirect')
+      attribute :return_url, Types::Strict::String
+    end
+    attribute :capture, Types::Bool.default(true)
+    attribute :description, Types::Strict::String
+    attribute :receipt, BasicStruct.meta(omittable: true) do
+      attribute :items, Types::Array.of(BasicStruct).default([]) do
+        attribute :description, Types::String
+        attribute :amount, BasicStruct.meta(omittable: true) do
+          attribute :value, Types::String.meta(omittable: true)
+          attribute :currency, Types::String.meta(omittable: true)
+        end
+        attribute :quantity, Types::Integer
+        attribute :vat_code, Types::String
+        attribute :payment_mode, Types::Strict::String.meta(omittable: true)
+        attribute :payment_subject, Types::String.meta(omittable: true)
+      end
+      attribute :phone, Types::String.meta(omittable: true)
+      attribute :email, Types::String.meta(omittable: true)
+      attribute :tax_system_code, Types::String.meta(omittable: true)
     end
+    attribute :payment_token, Types::String
+    attribute :metadata, Types::Hash
+    attribute :client_ip, Types::String
   end
 end

data/lib/yaka/payment_response.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Yaka
+  class PaymentResponse < BasicStruct
+    # This class is used to wrap response from Yandex Kassa about necessary actions to complete/process if it's required
+
+    attribute :id, Types::String
+    attribute :status, Types::String
+    attribute :paid, Types::Bool
+    attribute :amount, BasicStruct do
+      attribute :value, Types::String
+      attribute :currency, Types::String
+    end
+    attribute :authorization_details, BasicStruct do
+      attribute :rrn, Types::String
+      attribute :auth_code, Types::String
+    end
+    attribute :captured_at, Types::DateTime
+    attribute :created_at, Types::DateTime
+    attribute :description, Types::String
+    attribute :metadata, Types::Hash
+    attribute :payment_method, BasicStruct do
+      attribute :id, Types::String
+      attribute :type, Types::String
+      attribute :saved, Types::String
+      attribute :title, Types::String
+      attribute :card, BasicStruct do
+        attribute :first6, Types::String
+        attribute :last4, Types::String
+        attribute :expiry_month, Types::String
+        attribute :expiry_year, Types::String
+        attribute :card_type, Types::String
+      end
+    end
+    attribute :recipient, BasicStruct do
+      attribute :account_id, Types::String
+      attribute :gateway_id, Types::String
+    end
+    attribute :refundable, Types::Bool
+    attribute :refunded_amount, BasicStruct do
+      attribute :value, Types::String
+      attribute :currency, Types::String
+    end
+    attribute :test, Types::Bool
+  end
+end

data/lib/yaka/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Yaka
-  VERSION = "0.0.1"
+  VERSION = '1.0.0'
 end

data/lib/yaka.rb

@@ -1,16 +1,35 @@
 # frozen_string_literal: true
 
 require 'dry-configurable'
+require 'dry-struct'
+require 'ipaddr'
+require 'date'
+
 require 'yaka/version'
-require 'yaka/serializable_object'
-require 'yaka/amount'
+require 'yaka/basic_struct'
 require 'yaka/class_methods'
 require 'yaka/payment'
-require 'yaka/receipt'
-require 'yaka/receipt_item'
+require 'yaka/payment_response'
+
 require 'faraday'
 
 module Yaka
+  HOST_URL = 'https://payment.yandex.net'
+  PAYMENTS_URL = '/api/v3/payments'
+  ALLOWED_YANDEX_V4_MASKS = {
+    '185.71.76.0' => 27,
+    '185.71.77.0' => 27,
+    '77.75.153.0' => 25,
+    '77.75.154.128' => 25
+  }.freeze
+
+  ALLOWED_YANDEX_V6_MASKS = {
+    '2a02:5180:0:1509::' => 64,
+    '2a02:5180:0:2655::' => 64,
+    '2a02:5180:0:1533::' => 64,
+    '2a02:5180:0:2669::' => 64
+  }.freeze
+
   class Error < StandardError; end
 
   extend Dry::Configurable
@@ -19,7 +38,5 @@ module Yaka
 
   setting :private_key, 'ololo'
 
-  setting :redirect_url, 'example.com/callbacks'
-
   extend ClassMethods
 end

data/yaka.gemspec

@@ -39,9 +39,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock"
   spec.add_dependency "pry"
   spec.add_dependency 'dry-configurable'
+  spec.add_dependency 'dry-struct'
   spec.add_dependency 'oj'
   spec.add_dependency 'faraday'
-  spec.add_dependency 'faker'
+  spec.add_development_dependency 'faker'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaka
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Igor Pavlov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-03 00:00:00.000000000 Z
+date: 2019-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -115,7 +143,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -143,12 +171,10 @@ files:
 - bin/console
 - bin/setup
 - lib/yaka.rb
-- lib/yaka/amount.rb
+- lib/yaka/basic_struct.rb
 - lib/yaka/class_methods.rb
 - lib/yaka/payment.rb
-- lib/yaka/receipt.rb
-- lib/yaka/receipt_item.rb
-- lib/yaka/serializable_object.rb
+- lib/yaka/payment_response.rb
 - lib/yaka/version.rb
 - yaka.gemspec
 homepage: https://github.com/beastia/yaka

data/lib/yaka/amount.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Yaka
-  class Amount < SerializableObject
-    REQUIRED_FIELDS = %i[value currency].freeze
-    OPTIONAL_FIELDS = %i[].freeze
-
-    attr_accessor(*REQUIRED_FIELDS)
-
-    def initialize(value:, currency: 'RUB')
-      @value = value
-      @currency = currency
-    end
-  end
-end

data/lib/yaka/receipt.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Yaka
-  class Receipt < SerializableObject
-    # Tax system codes
-    # 1:  Общая система налогообложения
-    # 2:  Упрощенная (УСН, доходы)
-    # 3:  Упрощенная (УСН, доходы минус расходы)
-    # 4:  Единый налог на вмененный доход (ЕНВД)
-    # 5:  Единый сельскохозяйственный налог (ЕСН)
-    # 6:  Патентная система налогообложения
-
-    REQUIRED_FIELDS = %i[items].freeze
-    OPTIONAL_FIELDS = %i[phone email tax_system_code].freeze
-
-    attr_accessor(*REQUIRED_FIELDS)
-    attr_accessor(*OPTIONAL_FIELDS)
-
-    def initialize(items: [], phone: nil, email: nil, tax_system_code: nil)
-      @items = items
-      @phone = phone
-      @email = email
-      @tax_system_code = tax_system_code
-      raise Yaka::Error, 'Invalid input parameters: phone or email should be present' if @phone.nil? && @email.nil?
-    end
-  end
-end

data/lib/yaka/receipt_item.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-module Yaka
-  class ReceiptItem < SerializableObject
-    # Vat codes
-    #
-    # 1: Без НДС
-    # 2: НДС по ставке 0%
-    # 3: НДС по ставке 10%
-    # 4: НДС чека по ставке 20%
-    # 5: НДС чека по расчетной ставке 10/110
-    # 6: НДС чека по расчетной ставке 20/120
-    #
-    # Payment subjects
-    # commodity:                Товар
-    # excise:                   Подакцизный товар
-    # job:                      Работа
-    # service:                  Услуга
-    # gambling_bet:             Ставка в азартной игре
-    # gambling_prize:           Выигрыш в азартной игре
-    # lottery:                  Лотерейный билет
-    # lottery_prize:            Выигрыш в лотерею
-    # intellectual_activity:    Результаты интеллектуальной деятельности
-    # payment:                  Платеж
-    # agent_commission:         Агентское вознаграждение
-    # property_right:           Имущественные права
-    # non_operating_gain:       Внереализационный доход
-    # insurance_premium:        Страховой сбор
-    # sales_tax:                Торговый сбор
-    # resort_fee:               Курортный сбор
-    # composite:                Несколько вариантов
-    # another:                  Другое
-    #
-    # Payment mode
-    # full_prepayment:          Полная предоплата
-    # partial_prepayment:       Частичная предоплата
-    # advance:                  Аванс
-    # full_payment:             Полный расчет
-    # partial_payment:          Частичный расчет и кредит
-    # credit:                   Кредит
-    # credit_payment:           Выплата по кредиту
-    REQUIRED_FIELDS = %i[description amount quantity vat_code].freeze
-    OPTIONAL_FIELDS = %i[payment_subject payment_mode].freeze
-
-    attr_accessor(*REQUIRED_FIELDS)
-    attr_accessor(*OPTIONAL_FIELDS)
-
-    def initialize(description:, amount:, quantity:, vat_code:, payment_subject: nil, payment_mode: nil)
-      @description = description
-      @amount = amount
-      @quantity = quantity
-      @vat_code = vat_code
-      @payment_subject = payment_subject
-      @payment_mode = payment_mode
-    end
-
-    def to_json(*_args)
-      {
-        description: @description,
-        amount: @amount,
-        quantity: @quantity,
-        vat_code: @vat_code
-      }.to_json
-    end
-  end
-end

data/lib/yaka/serializable_object.rb

@@ -1,19 +0,0 @@
-module Yaka
-  class SerializableObject
-    def to_json(*_args)
-      required_fields = self.class.const_get(:REQUIRED_FIELDS)
-      initial = required_fields.each_with_object({}) do |field_name, result|
-        result[field_name] = public_send(field_name)
-      end
-
-      optional_fields = self.class.const_get(:OPTIONAL_FIELDS)
-
-      optional_fields.each do |field_name|
-        value = public_send(field_name)
-        initial[field_name] = value unless value.nil?
-      end
-
-      initial.to_json
-    end
-  end
-end