tochka_cyclops_api 0.2.0 → 0.4.0

data/lib/tochka_cyclops_api/response.rb

@@ -1,63 +1,56 @@
 # frozen_string_literal: true
 
-require_relative './schemas/responses/echo'
+require_relative 'schemas/responses/error'
 
 module TochkaCyclopsApi
   # Class for processing the response received from the api bank
   class Response
-    def self.create(request, response, method)
-      @method = method
+    def self.create(request: ,response: ,method:)
       @request = request
-      @response = response
-      parse
+      @method = method
+      @body = JSON.parse(response.body)
+      @response_schema = "TochkaCyclopsApi::Schemas::Responses::#{camel_case_method}".constantize
+      @error_schema = 'TochkaCyclopsApi::Schemas::Responses::Error'.constantize
 
-      {
-        response_struct: @response_struct,
-        result: @result
-      }
+      call
     end
 
-    def self.parse
-      @body = JSON.parse(@response.body)
-      if @body.key? 'result'
-        parse_result
-      elsif @body.key? 'error'
+    private
+
+    def self.call
+      @result = @body['result']
+      @error = @body['error']
+
+      if @error.present?
         parse_error
+      else
+        parse_result
       end
     end
 
     def self.parse_result
-      @result = @body['result']
-      response_schema = schema || -> { "Schema for #{@method} is not found" }[]
+      return nil if @result.nil?
 
-      @response = TochkaCyclopsResponse.create(body: @body, result: @result)
-      @request.update(result: @response)
+      response = TochkaCyclopsResponse.create(body: @body, result: @result)
+      @request.update(result: response, status: 'success')
       @result.deep_symbolize_keys if @result.is_a? Hash
-      @response_struct = response_schema.new(@result)
+      response_struct = @response_schema.new(@result)
+
+      Result.success(response_struct)
     end
 
     def self.parse_error
-      @error = @body['error']
-      require_relative './schemas/responses/error'
-      response_schema = 'TochkaCyclopsApi::Schemas::Responses::Error'.constantize
+      return nil if @error.nil?
 
-      @response = TochkaCyclopsError.create(
+      response = TochkaCyclopsError.create(
         body: @body,
         code: @error['code'],
         message: @error['message']
       )
+      @request.update(result: response, status: 'failure')
+      response_struct = @error_schema.new(@error.deep_symbolize_keys)
 
-      @request.update(result: @response)
-
-      @response_struct = response_schema.new(@error.deep_symbolize_keys)
-    end
-
-    def self.schema
-      require_relative "./schemas/responses/#{@method}"
-      "TochkaCyclopsApi::Schemas::Responses::#{camel_case_method}".constantize
-    rescue StandardError => e
-      @errors = { error: e.message }
-      false
+      Result.success(response_struct)
     end
 
     def self.camel_case_method

data/lib/tochka_cyclops_api/result.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module TochkaCyclopsApi
+  # Displays the result of request
+  class Result
+    attr_reader :success, :data, :error_message
+
+    def self.create(success, data = nil, error_message = nil)
+      @success = success
+      @data = data
+      @error_message = error_message
+
+      display_result
+    end
+
+    def self.success(data)
+      Result.create(true, data)
+    end
+
+    def self.failure(error_message)
+      Result.create(false, nil, error_message)
+    end
+
+    private
+
+    def self.display_result
+      {
+        success: @success,
+        data: @data || @error_message
+      }
+    end
+  end
+end

data/lib/tochka_cyclops_api/schemas/requests/activate_beneficiary.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'dry-validation'
+
+module TochkaCyclopsApi
+  module Schemas
+    module Requests
+      # https://api.tochka.com/static/v1/tender-docs/cyclops/main/api_v2.html#api-v2-activate-beneficiary
+      class ActivateBeneficiary < Dry::Validation::Contract
+        schema do
+          required(:beneficiary_id).value(:string)
+        end
+
+        EXAMPLE = "
+{
+  beneficiary_id: '981fee11-9969-4e80-9f5f-02af462cb51e'
+}
+"
+      end
+    end
+  end
+end

data/lib/tochka_cyclops_api/schemas/requests/create_beneficiary_fl.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'dry-validation'
+
+module TochkaCyclopsApi
+  module Schemas
+    module Requests
+      # https://api.tochka.com/static/v1/tender-docs/cyclops/main/api_v2.html#api-v2-create-beneficiary-fl
+      class CreateBeneficiaryFl < Dry::Validation::Contract
+        # Schema for beneficiary_data field of main schema
+        class BeneficiaryData < Dry::Validation::Contract
+          params do
+            required(:first_name).value(:string)
+            required(:last_name).value(:string)
+            required(:birth_date).value(:string)
+            required(:birth_place).value(:string)
+            required(:passport_number).value(:string)
+            required(:passport_date).value(:string)
+            required(:registration_address).value(:string)
+
+            optional(:passport_series).value(:string)
+            optional(:middle_name).value(:string)
+            optional(:resident).value(:bool)
+          end
+        end
+
+        schema do
+          required(:inn).value(:string)
+          required(:beneficiary_data).schema(
+            TochkaCyclopsApi::Schemas::Requests::CreateBeneficiaryFl::BeneficiaryData.schema
+          )
+
+          optional(:nominal_account_code).value(:string)
+          optional(:nominal_account_bic).value(:string)
+        end
+
+        EXAMPLE ="
+{
+  inn: '7925930371',
+  nominal_account_code: '000000000000000000000',
+  nominal_account_bic: '0000000000',
+  beneficiary_data: {
+      first_name: 'Иван',
+      last_name: 'Иванов',
+      birth_date: '1990-01-24',
+      birth_place: 'г. Свердловск',
+      passport_series: '6509',
+      passport_number: '123456',
+      passport_date: '2020-01-01',
+      registration_address: '683031, г. Петропавловск-Камчатский, пр-кт. Карла Маркса, д. 21/1, офис 305'
+  }
+}"
+      end
+    end
+  end
+end

data/lib/tochka_cyclops_api/schemas/requests/create_beneficiary_ip.rb

@@ -5,25 +5,37 @@ require 'dry-validation'
 module TochkaCyclopsApi
   module Schemas
     module Requests
-      # Schema for beneficiary_data field of main schema
-      class BeneficiaryData < Dry::Validation::Contract
-        params do
-          required(:first_name).value(:string)
-          required(:last_name).value(:string)
-          optional(:middle_name).value(:string)
-        end
-      end
-
       # https://api.tochka.com/static/v1/tender-docs/cyclops/main/api_v2.html#api-v2-create-beneficiary-ip
       class CreateBeneficiaryIp < Dry::Validation::Contract
+        # Schema for beneficiary_data field of main schema
+        class BeneficiaryData < Dry::Validation::Contract
+          params do
+            required(:first_name).value(:string)
+            required(:last_name).value(:string)
+            optional(:middle_name).value(:string)
+          end
+        end
+
         schema do
           required(:inn).value(:string)
           optional(:nominal_account_code).value(:string)
           optional(:nominal_account_bic).value(:string)
           required(:beneficiary_data).schema(
-            TochkaCyclopsApi::Schemas::Reuqests::BeneficiaryData.schema
+            TochkaCyclopsApi::Schemas::Requests::CreateBeneficiaryIp::BeneficiaryData.schema
           )
         end
+
+        EXAMPLE =
+"{
+  inn: '7743745038',
+  nominal_account_code: '40702810338170022645',
+  nominal_account_bic: '044525225',
+  beneficiary_data: {
+    first_name: 'Иван',
+    last_name: 'Иванов',
+    middle_name: 'Иванович'
+  }
+}"
       end
     end
   end

data/lib/tochka_cyclops_api/schemas/requests/create_beneficiary_ul.rb

@@ -5,25 +5,37 @@ require 'dry-validation'
 module TochkaCyclopsApi
   module Schemas
     module Requests
-      # Schema for beneficiary_data field of main schema
-      class BeneficiaryData < Dry::Validation::Contract
-        params do
-          required(:name).value(:string)
-          required(:kpp).value(:string)
-          optional(:ogrn).value(:string)
-        end
-      end
-
       # https://api.tochka.com/static/v1/tender-docs/cyclops/main/api_v2.html#api-v2-create-beneficiary-ul
       class CreateBeneficiaryUl < Dry::Validation::Contract
+        # Schema for beneficiary_data field of main schema
+        class BeneficiaryData < Dry::Validation::Contract
+          params do
+            required(:name).value(:string)
+            required(:kpp).value(:string)
+            optional(:ogrn).value(:string)
+          end
+        end
+
         schema do
           required(:inn).value(:string)
           optional(:nominal_account_code).value(:string)
           optional(:nominal_account_bic).value(:string)
           required(:beneficiary_data).schema(
-            TochkaCyclopsApi::Schemas::Requests::BeneficiaryData.schema
+            TochkaCyclopsApi::Schemas::Requests::CreateBeneficiaryUl::BeneficiaryData.schema
           )
         end
+
+        EXAMPLE =
+"{
+  inn: '7743745038',
+  nominal_account_code: '40702810338170022645',
+  nominal_account_bic: '044525225',
+  beneficiary_data: {
+    name: 'ООО «ТК ИнжСтройКомплект»',
+    kpp: '773401001',
+    ogrn: '1097746324169'
+  }
+}"
       end
     end
   end

data/lib/tochka_cyclops_api/schemas/requests/deactivate_beneficiary.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'dry-validation'
+
+module TochkaCyclopsApi
+  module Schemas
+    module Requests
+      # https://api.tochka.com/static/v1/tender-docs/cyclops/main/api_v2.html#api-v2-deactivate-beneficiary
+      class DeactivateBeneficiary < Dry::Validation::Contract
+        schema do
+          required(:beneficiary_id).value(:string)
+        end
+
+        EXAMPLE = "
+{
+  beneficiary_id: '981fee11-9969-4e80-9f5f-02af462cb51e'
+}
+"
+      end
+    end
+  end
+end

data/lib/tochka_cyclops_api/schemas/requests/echo.rb

@@ -10,6 +10,8 @@ module TochkaCyclopsApi
         schema do
           required(:text).value(:string)
         end
+
+        EXAMPLE = "{ text: 'Echo' }"
       end
     end
   end

data/lib/tochka_cyclops_api/schemas/requests/get_beneficiary.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'dry-validation'
+
+module TochkaCyclopsApi
+  module Schemas
+    module Requests
+      # https://api.tochka.com/static/v1/tender-docs/cyclops/main/api_v2.html#api-v2-get-beneficiary
+      class GetBeneficiary < Dry::Validation::Contract
+        schema do
+          required(:beneficiary_id).value(:string)
+        end
+
+        EXAMPLE = "
+{
+  beneficiary_id: '981fee11-9969-4e80-9f5f-02af462cb51e'
+}
+"
+      end
+    end
+  end
+end

data/lib/tochka_cyclops_api/schemas/requests/list_beneficiary.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'dry-validation'
+
+module TochkaCyclopsApi
+  module Schemas
+    module Requests
+      # https://api.tochka.com/static/v1/tender-docs/cyclops/main/api_v2.html#api-v2-list-beneficiary
+      class ListBeneficiary < Dry::Validation::Contract
+        # Schema for beneficiary_data field of main schema
+        class Filters < Dry::Validation::Contract
+          params do
+            optional(:inn).value(:string)
+            optional(:is_active).value(:bool)
+            optional(:legal_type).value(:string)
+            optional(:nominal_account_code).value(:string)
+            optional(:nominal_account_bic).value(:string)
+          end
+        end
+
+        schema do
+          optional(:page).value(:integer)
+          optional(:per_page).value(:integer)
+          optional(:filters).schema(
+            TochkaCyclopsApi::Schemas::Requests::ListBeneficiary::Filters.schema
+          )
+        end
+
+        EXAMPLE = "
+{
+  page: 2,
+  per_page: 20,
+  filters: {
+    is_active: true,
+    legal_type: 'F',
+    nominal_account_code: '000000000000000000000',
+    nominal_account_bic: '0000000000',
+  }
+}
+"
+      end
+    end
+  end
+end

data/lib/tochka_cyclops_api/schemas/requests/update_beneficiary_fl.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'dry-validation'
+
+module TochkaCyclopsApi
+  module Schemas
+    module Requests
+      # https://api.tochka.com/static/v1/tender-docs/cyclops/main/api_v2.html#api-v2-update-beneficiary-fl
+      class UpdateBeneficiaryFl < Dry::Validation::Contract
+        # Schema for beneficiary_data field of main schema
+        class BeneficiaryData < Dry::Validation::Contract
+          params do
+            required(:first_name).value(:string)
+            required(:last_name).value(:string)
+            required(:birth_date).value(:string)
+            required(:birth_place).value(:string)
+            required(:passport_number).value(:string)
+            required(:passport_date).value(:string)
+            required(:registration_address).value(:string)
+
+            optional(:passport_series).value(:string)
+            optional(:middle_name).value(:string)
+            optional(:resident).value(:bool)
+          end
+        end
+
+        schema do
+          required(:beneficiary_id).value(:string)
+          required(:beneficiary_data).schema(
+            TochkaCyclopsApi::Schemas::Requests::UpdateBeneficiaryFl::BeneficiaryData.schema
+          )
+        end
+
+        EXAMPLE = "
+{
+  beneficiary_id: '981fee11-9969-4e80-9f5f-02af462cb51e',
+  beneficiary_data: {
+      first_name: 'Иван',
+      last_name: 'Иванов',
+      birth_date: '1990-01-24',
+      birth_place: 'г. Свердловск',
+      passport_series: '6509',
+      passport_number: '123456',
+      passport_date: '2020-01-01',
+      registration_address: '683031, г. Петропавловск-Камчатский, пр-кт. Карла Маркса, д. 21/1, офис 305'
+  }
+}"
+      end
+    end
+  end
+end

data/lib/tochka_cyclops_api/schemas/requests/update_beneficiary_ip.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'dry-validation'
+
+module TochkaCyclopsApi
+  module Schemas
+    module Requests
+      # https://api.tochka.com/static/v1/tender-docs/cyclops/main/api_v2.html#api-v2-update-beneficiary-ip
+      class UpdateBeneficiaryIp < Dry::Validation::Contract
+        # Schema for beneficiary_data field of main schema
+        class BeneficiaryData < Dry::Validation::Contract
+          params do
+            required(:first_name).value(:string)
+            required(:last_name).value(:string)
+            optional(:middle_name).value(:string)
+          end
+        end
+
+        schema do
+          required(:beneficiary_id).value(:string)
+          required(:beneficiary_data).schema(
+            TochkaCyclopsApi::Schemas::Requests::UpdateBeneficiaryIp::BeneficiaryData.schema
+          )
+        end
+
+        EXAMPLE = "
+{
+  beneficiary_id: 981fee11-9969-4e80-9f5f-02af462cb51e,
+  beneficiary_data: {
+    first_name: 'Иван',
+    middle_name: 'Иванович',
+    last_name: 'Иванов'
+  }
+}
+"
+      end
+    end
+  end
+end

data/lib/tochka_cyclops_api/schemas/requests/update_beneficiary_ul.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'dry-validation'
+
+module TochkaCyclopsApi
+  module Schemas
+    module Requests
+      # https://api.tochka.com/static/v1/tender-docs/cyclops/main/api_v2.html#api-v2-update-beneficiary-ul
+      class UpdateBeneficiaryUl < Dry::Validation::Contract
+        # Schema for beneficiary_data field of main schema
+        class BeneficiaryData < Dry::Validation::Contract
+          params do
+            required(:name).value(:string)
+            required(:kpp).value(:string)
+            optional(:ogrn).value(:string)
+          end
+        end
+
+        schema do
+          required(:beneficiary_id).value(:string)
+          required(:beneficiary_data).schema(
+            TochkaCyclopsApi::Schemas::Requests::UpdateBeneficiaryUl::BeneficiaryData.schema
+          )
+        end
+
+        EXAMPLE = "
+{
+  beneficiary_id: '981fee11-9969-4e80-9f5f-02af462cb51e',
+  beneficiary_data: {
+    name: 'ООО \"Рога и Копыта\"',
+    kpp: '246301001'
+  }
+}
+"
+      end
+    end
+  end
+end

data/lib/tochka_cyclops_api/schemas/responses/activate_beneficiary.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'dry-struct'
+
+module Types
+  include Dry.Types()
+end
+
+module TochkaCyclopsApi
+  module Schemas
+    module Responses
+      # Response schema for activate_beneficiary request
+      class ActivateBeneficicary < Dry::Struct
+        # Schema for beneficiary field of main response
+        class BeneficiaryData < Dry::Struct
+          attribute :inn, Types::Strict::String
+          attribute :id, Types::Strict::String
+        end
+
+        attribute :beneficiary, BeneficiaryData
+      end
+    end
+  end
+end

data/lib/tochka_cyclops_api/schemas/responses/create_beneficiary_fl.rb

@@ -0,0 +1,24 @@
+require 'dry-struct'
+
+module Types
+  include Dry.Types()
+end
+
+module TochkaCyclopsApi
+  module Schemas
+    module Responses
+      # Response schema for create_beneficiary_fl request
+      class CreateBeneficiaryFl < Dry::Struct
+        # Schema for beneficiary field of main response
+        class BeneficiaryData < Dry::Struct
+          attribute :inn, Types::Strict::String
+          attribute :id, Types::Strict::String
+          attribute :nominal_account_code, Types::Strict::String.optional
+          attribute :nominal_account_bic, Types::Strict::String.optional
+        end
+
+        attribute :beneficiary, BeneficiaryData
+      end
+    end
+  end
+end

data/lib/tochka_cyclops_api/schemas/responses/create_beneficiary_ip.rb

@@ -5,8 +5,17 @@ require 'dry-struct'
 module TochkaCyclopsApi
   module Schemas
     module Responses
-      # Response chema for create_beneficiary_ip request
+      # Response schema for create_beneficiary_ip request
       class CreateBeneficiaryIp < Dry::Struct
+        # Schema for beneficiary field of main response
+        class BeneficiaryData < Dry::Struct
+          attribute :inn, Types::Strict::String
+          attribute :id, Types::Strict::String
+          attribute :nominal_account_code, Types::Strict::String.optional
+          attribute :nominal_account_bic, Types::Strict::String.optional
+        end
+
+        attribute :beneficiary, BeneficiaryData
       end
     end
   end

data/lib/tochka_cyclops_api/schemas/responses/create_beneficiary_ul.rb

@@ -9,16 +9,16 @@ end
 module TochkaCyclopsApi
   module Schemas
     module Responses
-      # Schema for beneficiary field of main response
-      class BeneficiaryData < Dry::Struct
-        attribute :inn, Types::Strict::String
-        attribute :id, Types::Strict::String
-        attribute :nominal_account_code, Types::Strict::String.optional
-        attribute :nominal_account_bic, Types::Strict::String.optional
-      end
-
-      # Response chema for create_beneficiary_ul request
+      # Response schema for create_beneficiary_ul request
       class CreateBeneficiaryUl < Dry::Struct
+        # Schema for beneficiary field of main response
+        class BeneficiaryData < Dry::Struct
+          attribute :inn, Types::Strict::String
+          attribute :id, Types::Strict::String
+          attribute :nominal_account_code, Types::Strict::String.optional
+          attribute :nominal_account_bic, Types::Strict::String.optional
+        end
+
         attribute :beneficiary, BeneficiaryData
       end
     end

data/lib/tochka_cyclops_api/schemas/responses/deactivate_beneficiary.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'dry-struct'
+
+module Types
+  include Dry.Types()
+end
+
+module TochkaCyclopsApi
+  module Schemas
+    module Responses
+      # Response schema for deactivate_beneficiary request
+      class DeactivateBeneficicary < Dry::Struct
+        # Schema for beneficiary field of main response
+        class BeneficiaryData < Dry::Struct
+          attribute :inn, Types::Strict::String
+          attribute :id, Types::Strict::String
+        end
+
+        attribute :beneficiary, BeneficiaryData
+      end
+    end
+  end
+end

data/lib/tochka_cyclops_api/schemas/responses/echo.rb

@@ -5,7 +5,7 @@ require 'dry-struct'
 module TochkaCyclopsApi
   module Schemas
     module Responses
-      # Response chema for echo request
+      # Response schema for echo request
       class Echo
         attr_accessor :text
 

data/lib/tochka_cyclops_api/schemas/responses/error.rb

@@ -5,11 +5,14 @@ require 'dry-struct'
 module TochkaCyclopsApi
   module Schemas
     module Responses
-      # Response chema for bank's api errors
+      module Types
+        include Dry.Types()
+      end
+      # Response schema for bank's api errors
       class Error < Dry::Struct
         attribute :code, Types::Strict::Integer
         attribute :message, Types::Strict::String
-        attribute :meta, Types::Strict::Array
+        attribute :meta, Types::Strict::Array.optional
       end
     end
   end