yookassa 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ac00c134955295ac36c5667a95f1b7c420b42daf1adeeec4f32b3c205620e4b
-  data.tar.gz: 0eb954e77d47f17d8ed1d567f881f7e5d42846258686f36e4ea57f19cc63adb7
+  metadata.gz: a2f2680a651266185ee0576e97e1589ab67b0944930d94af533794c320f6c5ea
+  data.tar.gz: fda07e32a04e3482995b1f6c86f74f1c1d7c90d21f6bd41668e63ce93c78c7f0
 SHA512:
-  metadata.gz: 57c3384c3237ccc32363578e00d1f84750420981eaeb8cd0e9449989a76c69646a6dabe7b0a6ccea7ebfbe29455f37e4d683215b4074e7456af01c11800fb179
-  data.tar.gz: 20523024b144dd7929bcd8f401f31cc5db9a8fa3f51af2d49c3e887636000ef4041b115fe650f8966bca831cbee36ed7f1b5a99c8d746a592c62c341038c84c3
+  metadata.gz: 5793beb1aff216c9c0bceb8324b58c8253b361390b0f8b1d57a143d286acff581a4a9059525b28d9ce314e714a86e1671ef3fa2a48dcb82c664dc09fc9366ab1
+  data.tar.gz: a882ed8cef54f185a519d84c10f2a0699a5dea6a77e444f4c4e00e50b1494e30c67c4febf101eacf9e79a6a323d7769daf18c7fe19ec0cd88bfa6a000f361268

data/.github/workflows/main.yml

@@ -0,0 +1,31 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby:
+          - 2.6
+          - 2.7
+          - 3.0
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Rubocop
+      run: bundle exec rubocop
+    - name: Rspec
+      run: bundle exec rspec

data/.rubocop.yml

@@ -1,13 +1,20 @@
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.6
+  NewCops: enable
 
-Metrics/BlockLength:
-  Exclude:
-    - 'spec/**/*.rb'
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
 
-Metrics/LineLength:
-  Max: 100
+Style/Documentation:
+  Enabled: false
 
-Naming/FileName:
-  Exclude:
-    - 'lib/*.rb'
+Layout/LineLength:
+  Max: 150
+
+Metrics/BlockLength:
+  IgnoredMethods: ['describe', 'context', 'shared_examples']

data/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
@@ -8,6 +8,13 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 gemspec
 
 group :development, :test do
-  gem 'pry',        platform: :mri
-  gem 'pry-byebug', platform: :mri
+  gem "pry"
+  gem "pry-byebug", "~> 3.8.0"
+  gem "rake", "~> 13.0"
+  gem "rspec", "~> 3.5"
+  gem "rubocop", "~> 1.22"
+  gem "rubocop-rake", "~> 0.6.0"
+  gem "rubocop-rspec", "~> 2.5"
+  gem "simplecov", "~> 0.16"
+  gem "webmock", "~> 3.14"
 end

data/Gemfile.lock

@@ -1,98 +1,137 @@
 PATH
   remote: .
   specs:
-    yookassa (0.1.0)
-      evil-client (~> 3.0)
+    yookassa (0.2.0)
+      dry-struct
+      http (~> 5.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
-    ast (2.4.0)
-    byebug (11.0.1)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.7)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    docile (1.3.1)
-    dry-initializer (3.0.4)
-    evil-client (3.0.4)
-      dry-initializer (>= 2.1, < 4)
-      mime-types (~> 3.1)
-      rack (~> 2)
-      tram-policy (>= 0.3.1, < 3)
-    hashdiff (0.4.0)
-    i18n (1.8.5)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    dry-configurable (0.13.0)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.2)
-    json (2.2.0)
-    method_source (0.9.2)
-    mime-types (3.3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2020.1104)
-    parallel (1.17.0)
-    parser (2.6.3.0)
-      ast (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-byebug (3.7.0)
+      dry-core (~> 0.6)
+    dry-container (0.9.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.13, >= 0.13.0)
+    dry-core (0.7.1)
+      concurrent-ruby (~> 1.0)
+    dry-inflector (0.2.1)
+    dry-logic (1.2.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5)
+    dry-struct (1.4.0)
+      dry-core (~> 0.5, >= 0.5)
+      dry-types (~> 1.5)
+      ice_nine (~> 0.11)
+    dry-types (1.5.1)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.5, >= 0.5)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    ffi (1.15.4)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    hashdiff (1.0.1)
+    http (5.0.4)
+      addressable (~> 2.8)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      llhttp-ffi (~> 0.4.0)
+    http-cookie (1.0.4)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    ice_nine (0.11.2)
+    llhttp-ffi (0.4.0)
+      ffi-compiler (~> 1.0)
+      rake (~> 13.0)
+    method_source (1.0.0)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.8.0)
       byebug (~> 11.0)
       pry (~> 0.10)
-    public_suffix (3.1.0)
-    rack (2.2.3)
+    public_suffix (4.0.6)
     rainbow (3.0.0)
-    rake (12.3.2)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.71.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.22.3)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
-    safe_yaml (1.0.5)
-    simplecov (0.16.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.12.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.5.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    tram-policy (2.0.1)
-      dry-initializer (> 2, < 4)
-      i18n (~> 1.0)
-    unicode-display_width (1.6.0)
-    webmock (3.5.1)
-      addressable (>= 2.3.6)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8)
+    unicode-display_width (2.1.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   pry
-  pry-byebug
-  rake (>= 10.0)
+  pry-byebug (~> 3.8.0)
+  rake (~> 13.0)
   rspec (~> 3.5)
-  rubocop (~> 0.71)
+  rubocop (~> 1.22)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.5)
   simplecov (~> 0.16)
-  webmock (~> 3.5)
+  webmock (~> 3.14)
   yookassa!
 
 BUNDLED WITH
-   1.17.3
+   2.2.22

data/README.md

@@ -1,6 +1,5 @@
 # YooKassa API Ruby Client
-
-[![Yookassa](https://circleci.com/gh/paderinandrey/yookassa.svg?style=svg)](https://circleci.com/gh/paderinandrey/yookassa)
+[![Github Actions](https://github.com/PaymentInstruments/yookassa/actions/workflows/main.yml/badge.svg)](https://github.com/PaymentInstruments/yookassa/actions/workflows/main.yml)
 [![Gem Version][gem-badger]][gem]
 [![License](https://img.shields.io/github/license/paderinandrey/yookassa.svg)](https://github.com/paderinandrey/yookassa)
 
@@ -26,12 +25,34 @@ Or install it yourself as:
 
 ## Usage
 
+### Configuration
+
+First of all you need to setup credentials to use Yookassa.
+You can configure your instance of Yookassa once in a application booting time. Ex. if you use rails, just put these lines into initializer file
+
+```ruby
+# config/initializers/yookassa.rb
+
+Yookassa.configure do |config|
+  config.shop_id = ENV.fetch('YOOKASSA_SHOP_ID') # or put your shop_id and api_key here directly
+  config.api_key = ENV.fetch('YOOKASSA_API_KEY') # can be taken from Rails.credentials too
+end
+```
+
+There are some cases, when you need to connect to different Yookassa accounts (say, your clients need to connect to Yookassa). That probably means that you run a marketplace or multitenant system. There is a solution for this one from Yookassa, see https://yookassa.ru/en/developers/special-solutions/checkout-for-platforms/basics or https://yookassa.ru/en/developers/partners-api/basics
+
+If that is not your case, and you still have multiple shop_ids and api_keys, and need to handle all of them under one application, then you need to instantiate clients inline
+
 ```ruby
-# Payment
+client1 = Yookassa::Client.new(shop_id: 'shop_1', api_key: '123')
+client2 = Yookassa::Client.new(shop_id: 'shop_2', api_key: '456')
+```
 
-client = Yookassa::Payment.new(shop_id: 'shop_id', api_key: 'api_key')
+### Making Payments
 
-payment = {
+#### Creating payment
+```ruby
+payload = {
     amount: {
         value:    100,
         currency: 'RUB'
@@ -43,23 +64,31 @@ payment = {
     }
 }
 
-client.create(payment: payment)
-
-client.get_payment_info(payment_id: '12345')
+payment = Yookassa.payments.create(payment: payload)
 
-client.capture(payment_id: '12345')
+# or
 
-client.cancel(payment_id: '12345')
+client = Yookassa::Client.new(shop_id: 'shop_1', api_key: '123')
+payment = client.payments.create(payment: payload)
+```
 
-# Refund
+#### Other payment requests
 
-client = Yookassa::Refund.new(shop_id: 'shop_id', api_key: 'api_key')
+```ruby
+Yookassa.payments.find(payment_id: '12345')
+Yookassa.payments.capture(payment_id: '12345')
+Yookassa.payments.cancel(payment_id: '12345')
+```
 
-client.create(payload: payload)
+### Refunds
 
-client.get_refund_info(payment_id: '12345')
+```ruby
+payment = Yookassa.refunds.create(payment: payload)
 
+# or
 
+client = Yookassa::Client.new(shop_id: 'shop_1', api_key: '123')
+payment = client.refunds.create(payment: payload)
 ```
 
 ## Contributing

data/Rakefile

@@ -1,6 +1,12 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "yookassa"
+
+begin
+  require "pry-byebug"
+  Pry.start
+rescue LoadError
+  require "irb"
+  IRB.start
+end

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/yookassa/client.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "http"
+require_relative "./payments"
+require_relative "./refunds"
+require_relative "./entity/error"
+
+module Yookassa
+  class Client
+    API_URL = "https://api.yookassa.ru/v3/"
+
+    attr_reader :http
+
+    def initialize(shop_id:, api_key:)
+      @http = HTTP.basic_auth(user: shop_id, pass: api_key).headers(accept: "application/json")
+    end
+
+    def payments
+      @payments ||= Payments.new(self)
+    end
+
+    def refunds
+      @refunds ||= Refunds.new(self)
+    end
+
+    def get(endpoint, query: {})
+      api_call { http.get("#{API_URL}#{endpoint}", params: query) }
+    end
+
+    def post(endpoint, idempotency_key:, payload: {})
+      api_call { http.headers("Idempotence-Key" => idempotency_key).post("#{API_URL}#{endpoint}", json: payload) }
+    end
+
+    private
+
+    def api_call
+      response = yield if block_given?
+      body = JSON.parse(response.body.to_s, symbolize_names: true)
+      return body if response.status.success?
+
+      Entity::Error.new(**body)
+    end
+  end
+end

data/lib/yookassa/config.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Yookassa
+  class Config
+    attr_accessor :shop_id, :api_key
+  end
+end

data/lib/yookassa/entity/amount.rb

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
 
+require_relative "./types"
+
 module Yookassa
   module Entity
-    class Amount
-      extend  Dry::Initializer
-      extend  Yookassa::Callable
-      include Yookassa::Optional
-
-      option :value, proc(&:to_f), optional: true
-      option :currency, proc(&:to_s), optional: true
+    class Amount < Dry::Struct
+      attribute :value, Types::Coercible::Float
+      attribute :currency, Types::String
     end
   end
 end

data/lib/yookassa/entity/authorization_details.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "./types"
+
+module Yookassa
+  module Entity
+    class AuthorizationDetails < Dry::Struct
+      # rrn [string, optional]
+      # Retrieval Reference Number is a unique identifier of a transaction in the issuer's system. Used for payments via bank card.
+      attribute? :rrn, Types::String
+
+      # auth_code [string, optional]
+      # Bank card's authorization code. Provided by the issuer to confirm authorization.
+      attribute? :auth_code, Types::String
+
+      # three_d_secure [object, optional]
+      # Information about user’s 3‑D Secure authentication for confirming the payment.
+      attribute? :three_d_secure, Types::Hash.schema(
+
+        # applied [boolean, required]
+        # Information on whether the 3-D Secure authentication form is displayed to the user for confirming the payment or not.
+        # true: YooMoney displayed the form to the user, so that they could complete 3-D Secure authentication;
+        # false: payment was processed without 3-D Secure authentication.
+        applied: Types::Bool
+      ).with_key_transform(&:to_sym)
+    end
+  end
+end

data/lib/yookassa/entity/cancellation_details.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "./types"
+
+module Yookassa
+  module Entity
+    class CancellationDetails < Dry::Struct
+      # party [string, required]
+      # The participant of the payment process that made the decision to cancel the payment.
+      # Possible values are yoo_money, payment_network, and merchant. More about initiators of payment cancelation
+      attribute :party, Types::String.enum("yoo_money", "payment_network", "merchant")
+
+      # reason [string, required]
+      # Reason behind the cancelation. Possible values https://yookassa.ru/en/developers/payments/declined-payments#cancellation-details-reason
+      attribute :reason, Types::String
+    end
+  end
+end