payture-cheques 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a1650598deeda99267fcb89839eff8a4fed1cd0
+  data.tar.gz: 3b49b35dc96a4550a5d76b8d8e03154651f1324c
+SHA512:
+  metadata.gz: af0a1b36a2bfc8fe1f6b840e1ea63f7fdb47fb9b6c3448a88cb02a08d8ca93515bd156d686e0df26e918ae173ccecddbc9fe2a7a86f0b99c878a8d894470a353
+  data.tar.gz: bac86af0856cce8def1f34ff8e1e7b1e634753b9fd1e1b065f5b52794073c9adc1d4cbc9aa79da43249d4dd39c3599c5977912f6bc6b657e7fc96188f929f5ff

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.2
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in payture-cheques.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Alexander Sviridov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Payture::Cheques
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/payture/cheques`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'payture-cheques'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install payture-cheques
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/payture-cheques.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "payture/cheques"
+require "json"
+
+# 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/payture/cheques.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+require 'faraday'
+require 'json'
+
+require "payture/cheques/version"
+
+require 'payture/cheques/client'
+require 'payture/cheques/config'
+require 'payture/cheques/methods/base'
+require 'payture/cheques/methods/create'
+require 'payture/cheques/methods/status'
+require 'payture/cheques/responses/base'
+require 'payture/cheques/responses/create'
+require 'payture/cheques/responses/status'
+require 'payture/cheques/responses/cheque_status'
+
+module Payture::Cheques
+  class Error < StandardError
+  end
+end
+
+module Payture
+  module Cheques
+    def self.client(**args)
+      Client.new(**args)
+    end
+  end
+end

data/lib/payture/cheques/client.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Payture::Cheques
+  class Client
+    attr_reader :config
+
+    def initialize(**options)
+      @config = Config.new(**options)
+    end
+
+    def create(**args)
+      Methods::Create.new(config).call(**args)
+    end
+
+    def status(**args)
+      Methods::Status.new(config).call(**args)
+    end
+  end
+end

data/lib/payture/cheques/config.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Payture::Cheques
+  class Config
+    # required
+    attr_reader :host
+    attr_reader :merchant_id
+    attr_reader :password
+
+    # optional
+    attr_reader :logger
+    attr_reader :timeout
+    attr_reader :open_timeout
+
+    def initialize(**options)
+      @host = options[:host]
+      @merchant_id = options[:merchant_id]
+      @password = options[:password]
+      @logger = options[:logger]
+      @timeout = options[:timeout]
+      @open_timeout = options[:open_timeout]
+
+      check_required_fields!
+    end
+
+    def base_url
+      "https://#{host}/apicheque"
+    end
+
+    private
+
+    def check_required_fields!
+      unless host && merchant_id && password
+        raise ArgumentError,
+          'Required options: host, merchant_id, password'
+      end
+    end
+  end
+end

data/lib/payture/cheques/methods/base.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Payture::Cheques
+  module Methods
+    class Base
+      attr_reader :config
+
+      def initialize(config)
+        @config = config
+      end
+
+      def call(**args)
+        http_response = make_request(url, params(**args))
+        build_response(http_response)
+      end
+
+      private
+
+      def url
+        raise NotImplementedError
+      end
+
+      def params
+        raise NotImplementedError
+      end
+
+      def response_class
+        raise NotImplementedError
+      end
+
+      def make_request(url, params)
+        conn = Faraday.new do |builder|
+          builder.adapter Faraday.default_adapter
+          builder.request :url_encoded
+          builder.response(:logger, config.logger) if config.logger
+        end
+        conn.post(url) do |req|
+          req.headers['Content-Type'] = 'application/json'
+          req.body = compact_hash(params).to_json
+          config.logger.debug(req.body) if config.logger
+          req.options.timeout = config.timeout if config.timeout
+          req.options.open_timeout = config.open_timeout if config.open_timeout
+        end
+      rescue Faraday::Error => e
+        raise Error, "#{e.class}: #{e.message}"
+      end
+
+      def build_response(http_response)
+        unless http_response.success?
+          raise Error, "Invalid http status: #{http_response.status}"
+        end
+
+        body =
+          begin
+            JSON.parse(http_response.body)
+          rescue JSON::ParserError => e
+            raise Error, "#{e.class}: #{e.message}"
+          end
+
+        config.logger.debug(pp(body)) if config.logger
+        response_class.new(body)
+      end
+
+      def encoded_data(**params)
+        params_str = compact_hash(params).map { |k, v| "#{k}=#{v}" }.join(';')
+        CGI.escape(params_str)
+      end
+
+      def compact_hash(hash)
+        hash.select { |k, v| k && v }
+      end
+    end
+  end
+end

data/lib/payture/cheques/methods/create.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Payture::Cheques
+  module Methods
+    class Create < Base
+      private
+
+      def url
+        "#{config.base_url}/Create"
+      end
+
+      def params(cheque_id:, inn:, content:, group: nil)
+        message = content.delete("Message") || content.delete(:Message)
+        params = {
+          Key: config.merchant_id,
+          Password: config.password,
+          Message: message,
+          Cheque: {
+            Id: cheque_id,
+            INN: inn,
+            Content: content,
+          },
+        }
+        params[:Group] = group if group
+        params
+      end
+
+      def response_class
+        Responses::Create
+      end
+    end
+  end
+end

data/lib/payture/cheques/methods/status.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Payture::Cheques
+  module Methods
+    class Status < Base
+      private
+
+      def url
+        "#{config.base_url}/Status"
+      end
+
+      def params(cheque_id:)
+        {
+          Key: config.merchant_id,
+          Password: config.password,
+          Id: cheque_id,
+        }
+      end
+
+      def response_class
+        Responses::Status
+      end
+    end
+  end
+end

data/lib/payture/cheques/responses/base.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Payture::Cheques
+  module Responses
+    class Base
+      attr_reader :body
+
+      def initialize(body)
+        @body = body
+      end
+
+      def success?
+        body['Success'] == 'True'
+      end
+
+      def error?
+        !success?
+      end
+
+      def error_code
+        body['ErrCode']
+      end
+    end
+  end
+end

data/lib/payture/cheques/responses/cheque_status.rb

@@ -0,0 +1,18 @@
+module Payture::Cheques
+  module Responses
+    class ChequeStatus
+      attr_reader :sent, :cheque, :error_code, :status
+
+      def initialize(args)
+        @sent = args["Sended"]
+        @cheque = args["Cheque"]
+        @status = args["Status"]
+        @error_code = args["ErrCode"] || Status::ERROR_STATES[@status]
+      end
+
+      def success?
+        @sent == true && @status == 'Created'
+      end
+    end
+  end
+end

data/lib/payture/cheques/responses/create.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Payture::Cheques
+  module Responses
+    class Create < Base
+      ERROR_STATES = {
+        'Conflict' => 'DUPLICATE_ID',
+        'BadRequest' => 'BAD_REQUEST_FORMAT',
+      }.freeze
+
+      def success?
+        body['Success'] == true && body['Status'] == 'Accepted'
+      end
+
+      def error_code
+        body['ErrCode'] || ERROR_STATES[body['Status']]
+      end
+    end
+  end
+end

data/lib/payture/cheques/responses/status.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Payture::Cheques
+  module Responses
+    class Status < Base
+      ERROR_STATES = {
+        'Unauthorized' => 'CANNOT_AUTHORIZE_TERMINAL',
+        'NotFound' => 'NOT_FOUND',
+        'Timeout' => 'TIMEOUT',
+        'Unknown' => 'UNKNOWN',
+      }.freeze
+
+      def cheques
+        @cheques ||= body['Cheques'].map { |c| ChequeStatus.new(c) }
+      end
+
+      def success?
+        body['Success'] == true
+      end
+
+      def error_code
+        body['ErrCode'] || ERROR_STATES[body['Status']]
+      end
+    end
+  end
+end

data/lib/payture/cheques/version.rb

@@ -0,0 +1,5 @@
+module Payture
+  module Cheques
+    VERSION = "0.1.0"
+  end
+end

data/payture-cheques.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'payture/cheques/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "payture-cheques"
+  spec.version       = Payture::Cheques::VERSION
+  spec.authors       = ["Alexander Sviridov"]
+  spec.email         = ["alexander.sviridov@gmail.com"]
+
+  spec.summary       = %q{Payture payment system API for sendind cheques separately from payments}
+  spec.homepage      = 'https://github.com/busfor/payture-cheques'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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 'faraday', '~> 0.9'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.51'
+  spec.add_development_dependency 'simplecov', '~> 0.14'
+  spec.add_development_dependency 'vcr', '~> 2.9'
+  spec.add_development_dependency 'webmock', '~> 3.0'
+  spec.add_development_dependency 'pp'
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: payture-cheques
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Sviridov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.51'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.51'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: pp
+  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: 
+email:
+- alexander.sviridov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/payture/cheques.rb
+- lib/payture/cheques/client.rb
+- lib/payture/cheques/config.rb
+- lib/payture/cheques/methods/base.rb
+- lib/payture/cheques/methods/create.rb
+- lib/payture/cheques/methods/status.rb
+- lib/payture/cheques/responses/base.rb
+- lib/payture/cheques/responses/cheque_status.rb
+- lib/payture/cheques/responses/create.rb
+- lib/payture/cheques/responses/status.rb
+- lib/payture/cheques/version.rb
+- payture-cheques.gemspec
+homepage: https://github.com/busfor/payture-cheques
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Payture payment system API for sendind cheques separately from payments
+test_files: []