revo-loans_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2dfb894597f190e75388de268e743f4812ec76eef58f0ff42b3dee7320cd8734
+  data.tar.gz: aa46c90d6fbfd50d9906a7c543308915885445f5231774aa6a0f153e3fb75b32
+SHA512:
+  metadata.gz: c2a5ec880b9f0f8230e2c67bd346be63f4708ef9b00ed72e06b86ab88d55b8078491e1f25b70dfaedbc8eccbf1e871aa14c4c3fafae364645db04f813212f25c
+  data.tar.gz: a1b6f163aa421f56f127b5d995cd2435fc471f5c9cd9277e6cb718fe76b196adddef8cb93fa2ac0e0b70ff92825ff4047c96fafbfa1d64be3e450d8fc9abb946

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.4
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in revo-loans_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: .
+  specs:
+    revo-loans_api (0.0.1)
+      activesupport
+      http
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    concurrent-ruby (1.1.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.11.1)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    hashdiff (1.0.0)
+    http (4.2.0)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.0)
+      http-parser (~> 1.2.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.1.1)
+    http-parser (1.2.1)
+      ffi-compiler (>= 1.0, < 2.0)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.12.2)
+    public_suffix (4.0.1)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    safe_yaml (1.0.5)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+    vcr (5.0.0)
+    webmock (3.7.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  revo-loans_api!
+  rspec (~> 3.0)
+  vcr
+  webmock
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -0,0 +1,301 @@
+# Revo::LoansApi
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'revo-loans_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install revo-loans_api
+
+## Usage
+
+### Instantiating a client
+
+Besides providing `base_url`, you must either use your login & password or a sesion token when instantiating the client:
+
+```ruby
+client = Revo::LoansApi::Client.new(base_url: '...', login: '70001112233', password: '1234')
+# or session_token:
+client = Revo::LoansApi::Client.new(base_url: '...', session_token: 'abcdef')
+```
+
+### Authenticating
+
+```ruby
+result = client.create_session
+
+# Success:
+result.success? # => true
+# the token will automatically be used by the client (it's in `client.session_token`)
+
+# Failure:
+result.success? # => false
+result.response # => `{ errors: { manager: ['list of errors here'] } }`
+```
+
+### Creating a loan request
+
+```ruby
+result = client.create_loan_request(
+  amount: 3_000,
+  mobile_phone: '78881234567',
+  store_id: 309
+)
+
+# Success:
+result.success? # => true
+result.response # =>
+# token: 'some-lr-token', # you'll be using this value on later steps
+# terms: [
+#   {
+#     term: 3,
+#     term_id: 50,
+#     monthly_payment: 1073.0,
+#     total_of_payments: 3219.0,
+#     sum_with_discount: 3000.0,
+#     total_overpayment: 219.0,
+#     sms_info: 79.0,
+#     product_code: '03',
+#     min_amount: 1000.0,
+#     max_amount: 0.0,
+#     schedule: [
+#       {
+#         date: '26-12-2018',
+#         amount: 1073.0
+#       },
+#       {
+#         date: '27-01-2019',
+#         amount: 1073.0
+#       }
+#     ]
+#   }
+# ]
+
+# Failure:
+result.success? # => false
+result.response # => `{ errors: { store_id: ['list of errors here'] } }`
+```
+
+### Updating a loan request
+
+```ruby
+result = client.update_loan_request(
+  token: 'some-lr-token', # use the one you got when creating a loan request
+  options: { amount: 3000 }
+)
+
+# Success:
+result.success? # => true
+result.response # => `{}`
+
+# Failure:
+result.success? # => false
+result.response # => `{ errors: { amount: ['list of errors here'] } }`
+```
+
+### Documents
+
+```ruby
+result = client.document(
+  token: 'some-lr-token', # use the one you got when creating a loan request
+  type: :offer,
+  format: :pdf
+)
+
+# Success:
+result.success? # => true
+result.response # => (the raw data)
+
+# Failure:
+result.success? # => false
+result.response # => `{ errors: { client: ['list of errors here'] } }`
+```
+
+### Sending a loan confirmation text
+
+```ruby
+result = client.send_loan_confirmation_message(
+  token: 'some-lr-token' # use the one you got when creating a loan request
+)
+
+# Success:
+result.success? # => true
+result.response # => `nil`
+
+# Failure:
+result.success? # => false
+result.response # => `{ errors: { mobile_phone: ['list of errors here'] } }`
+```
+
+### Completing a loan request
+
+```ruby
+result = client.complete_loan_request(
+  token: 'some-lr-token', # use the one you got when creating a loan request
+  code: '1234' # use the code from the text you received
+)
+
+# Success:
+result.success? # => true
+result.response # =>
+# client: {
+#   first_name: 'Владилен',
+#   middle_name: 'Гарриевич',
+#   last_name: 'Пупкин',
+#   credit_limit: '6000.0',
+#   decision: 'approved',
+#   decision_code: 210,
+#   decision_message: 'Покупка на сумму 3000.0 ₽ успешно совершена!'
+# }
+
+# Failure:
+result.success? # => false
+result.response # => `{ errors: { code: ['list of errors here'] } }`
+```
+
+### Creating a loan
+
+```ruby
+result = client.create_loan(
+  token: 'some-lr-token', # use the one you got when creating a loan request
+  term_id: 51 # pick one of those provided when creating a loan request
+)
+
+# Success:
+result.success? # => true
+result.response # => `nil`
+
+# Failure:
+result.success? # => false
+result.response # => `{ errors: { base: ['list of errors here'] } }`
+```
+
+### Finalizing a loan
+
+```ruby
+result = client.finalize_loan(
+  token: 'some-lr-token', # use the one you got when creating a loan request
+  code: '1234' # use the code from the text you received (the same one)
+)
+
+# Success:
+result.success? # => true
+result.response # =>
+# offer_id: '244244102',
+# loan_application: {
+#   barcodes: {
+#     image: 'data:image/svg+xml;base64,...',
+#     text: '1ZZ0600023030002442441027'
+#   }
+# }
+
+# Failure:
+result.success? # => false
+result.response # => `{ errors: { confirmation_code: ['list of errors here'] } }`
+```
+
+### List orders
+
+```ruby
+result = client.orders(
+  store_id: 1,
+  filters: { mobile_phone: '8881112233' } # optional
+)
+
+# Success:
+result.success? # => true
+result.response # =>
+# orders: [
+#   {
+#     id: '1525182',
+#     client_name: 'Иванов Иван Иванович',
+#     mobile_phone: '8882200001',
+#     barcode: '10009302315006587574891'
+#   }
+# ]
+```
+
+### Send return confirmation code
+
+```ruby
+result = client.send_return_confirmation_code(
+  order_id: 1
+)
+
+# Success:
+result.success? # => true
+result.response # => `nil`
+```
+
+### Creating a return
+
+```ruby
+result = client.create_return(
+  order_id: 1,
+  code: '1234',
+  amount: 3000,
+  store_id: 1
+)
+
+# Success:
+result.success? # => true
+result.response # =>
+# return: {
+#   id: '234',
+#   barcode: '2ZZ011235616399006082053267'
+# }
+
+# Failure:
+result.success? # => false
+result.response # => `{ errors: { amount: ['error'], store_id: ['another error'] } }`
+```
+
+### Confirming a return
+
+```ruby
+result = client.confirm_return(
+  return_id: 1
+)
+
+# Success:
+result.success? # => true
+result.response # => `nil`
+```
+
+### Cancelling a return
+
+```ruby
+result = client.cancel_return(
+  return_id: 1
+)
+
+# Success:
+result.success? # => true
+result.response # => `nil`
+```
+
+### Possible Exceptions
+
+In case of generic HTTP errors (i.e. server is not reachable or network is down), `Revo::LoansApi::UnexpectedResponseError` will be raised.
+
+If the provided session token is invalid, you'll get `Revo::LoansApi::InvalidAccessTokenError`.
+In this case, you have to get a new one using your login and password by calling `#create_session`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/RevoTechnology/LoansClient.rb.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "revo/loans_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/revo/loans_api.rb

@@ -0,0 +1,11 @@
+require 'revo/loans_api/version'
+require 'revo/loans_api/client'
+
+module Revo
+  module LoansApi
+    class Error < StandardError; end
+    class UnprocessableEntityError < Error; end
+    class UnexpectedResponseError < Error; end
+    class InvalidAccessTokenError < Error; end
+  end
+end

data/lib/revo/loans_api/client.rb

@@ -0,0 +1,166 @@
+require 'http'
+require 'active_support/core_ext/object/blank'
+
+class HTTP::MimeType::JSON
+  def decode(str)
+    ::JSON.parse(str, symbolize_names: true)
+  end
+end
+
+class Revo::LoansApi::Client
+  attr_reader :session_token, :loan_request_token
+
+  Result = Struct.new(:success?, :response, keyword_init: true)
+
+  def initialize(base_url:, login: nil, password: nil, session_token: nil)
+    @base_url = base_url
+    @login = login
+    @password = password
+    @session_token = session_token
+  end
+
+  def create_session
+    make_request(
+      :post, 'sessions',
+      user: { login: login, password: password }
+    ).tap do |result|
+      @session_token = result.response.dig(:user, :authentication_token) if result&.success?
+    end
+  end
+
+  def create_loan_request(options)
+    response = make_request(:post, 'loan_requests', loan_request_params(options))
+    return response unless response.success?
+
+    @loan_request_token = response.response.dig(:loan_request, :token)
+    Result.new(
+      success?: true,
+      response: {
+        token: loan_request_token,
+        terms: loan_request_terms.response[:loan_request]
+      }
+    )
+  end
+
+  def update_loan_request(token:, options:)
+    update_params = { loan_request: options }
+    response = make_request(:put, "loan_requests/#{token}", update_params)
+
+    return response unless response.success?
+
+    Result.new(
+      success?: true,
+      response: {}
+    )
+  end
+
+  # prerequisite: a client with the LR's phone number should already exist
+  def document(token:, type:, format: 'html')
+    make_request(:get, "loan_requests/#{token}/documents/#{type}.#{format}")
+  end
+
+  def send_loan_confirmation_message(token:)
+    make_request(:post, "loan_requests/#{token}/client/confirmation")
+  end
+
+  def complete_loan_request(token:, code:)
+    make_request(:post, "loan_requests/#{token}/confirmation", code: code)
+  end
+
+  def create_loan(token:, term_id:)
+    make_request(:post, "loan_requests/#{token}/loan", term_id: term_id)
+  end
+
+  def finalize_loan(token:, code:)
+    make_request(:post, "loan_requests/#{token}/loan/finalization", loan: { agree_processing: '1', confirmation_code: code })
+  end
+
+  # returns
+  def orders(store_id:, filters: {})
+    make_request(:get, 'orders', store_id: store_id, filters: filters)
+  end
+
+  def send_return_confirmation_code(order_id:)
+    make_request(:post, "orders/#{order_id}/send_return_confirmation_code")
+  end
+
+  def create_return(order_id:, code:, amount:, store_id:)
+    params = {
+      return: {
+        order_id: order_id,
+        confirmation_code: code,
+        amount: amount,
+        store_id: store_id
+      }
+    }
+    make_request(:post, 'returns', params)
+  end
+
+  def confirm_return(return_id:)
+    make_request(:post, "returns/#{return_id}/confirm")
+  end
+
+  def cancel_return(return_id:)
+    make_request(:post, "returns/#{return_id}/cancel")
+  end
+
+  private
+
+  attr_reader :connection, :base_url, :login, :password
+
+  def connection
+    @connection ||= HTTP.persistent(base_url)
+  end
+
+  def loan_request_terms(&block)
+    make_request(:get, "loan_requests/#{loan_request_token}", &block)
+  end
+
+  def make_request(method, endpoint, params = {}, &block)
+    headers = { Authorization: session_token }.compact
+    response = connection.public_send(method, url_for(endpoint), json: params, headers: headers)
+    handle_response(response, &block)
+  rescue HTTP::Error => exception
+    handle_error(exception)
+  end
+
+  def handle_response(response)
+    if response.status.success?
+      if block_given?
+        yield response
+      else
+        response
+      end
+      Result.new(success?: true, response: parse(response))
+    else
+      handle_error(response)
+    end
+  end
+
+  def handle_error(response_or_exception)
+    response = response_or_exception if response_or_exception.respond_to?(:status)
+    if response
+      if response.status.unauthorized?
+        raise Revo::LoansApi::InvalidAccessTokenError
+      else
+        Result.new(success?: false, response: parse(response))
+      end
+    else
+      raise Revo::LoansApi::UnexpectedResponseError, response_or_exception
+    end
+  end
+
+  def parse(response)
+    response.parse if response.body.present?
+  rescue HTTP::Error
+    response.to_s.presence
+  end
+
+  def url_for(endpoint)
+    [base_url, endpoint].join('/')
+  end
+
+  def loan_request_params(options)
+    { loan_request: options }
+  end
+end

data/lib/revo/loans_api/version.rb

@@ -0,0 +1,5 @@
+module Revo
+  module LoansApi
+    VERSION = '0.0.1'
+  end
+end

data/revo-loans_api.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'revo/loans_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'revo-loans_api'
+  spec.version       = Revo::LoansApi::VERSION
+  spec.authors       = ['Revo Developers']
+  spec.email         = ['support@revoup.ru']
+
+  spec.summary       = %q{Revo Loans API client}
+  spec.description   = %q{Revo Loans API client}
+  spec.homepage      = 'https://github.com/RevoTechnology'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'http'
+  spec.add_dependency 'activesupport'
+  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_development_dependency 'vcr'
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: revo-loans_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Revo Developers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  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: activesupport
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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: vcr
+  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'
+description: Revo Loans API client
+email:
+- support@revoup.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/revo/loans_api.rb
+- lib/revo/loans_api/client.rb
+- lib/revo/loans_api/version.rb
+- revo-loans_api.gemspec
+homepage: https://github.com/RevoTechnology
+licenses: []
+metadata:
+  homepage_uri: https://github.com/RevoTechnology
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Revo Loans API client
+test_files: []