pay_rb 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 57139eedbae4d0f81dcd43b157ade3f34331aadabf39424fcf10513b7ca998f0
+  data.tar.gz: 2aab59ec6e54fc7f6c4035139fd93b08ec6c1f7e80597dc19e97faa94e27e018
+SHA512:
+  metadata.gz: f57aaa4e3e786dafc3a184e2f160de5d5428de6a1f6cca12ab3db206af757a63a0782a4d54b8518a708bbb00454ccc0d6dc2b422d1334e5fdf4a05e02839b32a
+  data.tar.gz: f320ee6cecd277c47e36435a6e4fc90202049aa251ed448f7f28da7ea9325bf13a47ecbcd31002e37d8c38bf57534745be5de92e6435f1af5d87f31af83c57c0

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-01-06
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Kiriakos Velissariou
+
+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,76 @@
+# PayRb
+
+🚧 UNDER DEVELOPMENT 🚧 
+
+Ruby client for bank APIs.
+
+A Ruby wrapper for banks' REST API that provides a simple interface for managing banking operations. It support banks
+that have [this kind of API](https://gateway.jcc.com.cy/developer/en/integration/api/rest/rest.html).
+
+It currently supports [JCC](https://gateway.jcc.com.cy/developer/en/integration/api/rest/rest.html) and [DSK](https://uat.dskbank.bg/sandbox/en/integration/api/rest/rest.html) banks.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add pay_rb
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install pay_rb
+```
+
+## Usage
+
+```ruby
+require 'pay_rb'
+
+# Initialize the client
+# Requires the following parameters:
+# - username: Provided by Bank
+# - password: Provided by Bank
+# - environment: The environment to use (uat or production)
+# - bank: The bank to use (dsk, jcc)
+client = PayRb::Client.new(username: 'username', password: 'password', environment: 'uat', bank: 'dsk')
+
+# Register a new payment
+
+# The register_payment method requires the following parameters:
+# - amount: The amount of the payment
+# - return_url: The URL to redirect the user to after the payment is completed
+# - description: The description of the payment
+# - order_number: The order number
+
+response = client.register_payment(amount: 100, return_url: 'https://example.com', description: 'Test payment', orderNumber: '123')
+redirect_url = response['formUrl']
+
+# Get order status
+# The get_order_status method requires the following parameters:
+# - order_id: The order ID
+
+response = client.get_order_status('123')
+
+# Refund a payment
+# The refund_payment method requires the following parameters:
+# - amount: The amount of the refund in smaller unit
+# - order_id: The order ID
+
+response = client.refund_payment(amount: 100, order_id: '123')
+```
+
+## 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 the created tag, 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/kiriakosv/pay_rb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/lib/pay_rb/client.rb

@@ -0,0 +1,109 @@
+module PayRb
+  class Client
+    BASE_URLS = {
+      dsk: {
+        uat: 'https://uat.dskbank.bg',
+        production: 'https://epg.dskbank.bg'
+      },
+      jcc: {
+        uat: 'https://gateway-test.jcc.com.cy',
+        production: 'https://gateway.jcc.com.cy'
+      }
+    }.freeze
+
+    def initialize(username:, password:, environment:, bank:)
+      @username = username
+      @password = password
+      @environment = environment.to_sym
+      @bank = bank.to_sym
+
+      validate_environment
+      validate_bank
+
+      @base_url = BASE_URLS[@bank][@environment]
+    end
+
+    def payment_registration(params)
+      camelized_params = params.transform_keys { |key| key.to_s.camelize(:lower) }
+
+      response = connection.post('/payment/rest/register.do') do |req|
+        req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+        req.body = URI.encode_www_form(default_params.merge(camelized_params))
+      end
+
+      JSON.parse(response.body)
+    end
+
+    def get_order_status(order_id)
+      params = { orderId: order_id }
+
+      response = connection.post('/payment/rest/getOrderStatus.do') do |req|
+        req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+        req.body = URI.encode_www_form(default_params.merge(params))
+      end
+
+      JSON.parse(response.body)
+    end
+
+    def refund_payment(params)
+      camelized_params = params.transform_keys { |key| key.to_s.camelize(:lower) }
+
+      response = connection.post('/payment/rest/refund.do') do |req|
+        req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+        req.body = URI.encode_www_form(default_params.merge(camelized_params))
+      end
+
+      JSON.parse(response.body)
+    end
+
+    private
+
+    attr_reader :username, :password, :environment, :bank, :base_url
+
+    ALLOWED_ENVIRONMENTS = %i[uat].freeze
+    private_constant :ALLOWED_ENVIRONMENTS
+
+    ALLOWED_BANKS = %i[dsk].freeze
+    private_constant :ALLOWED_BANKS
+
+    def validate_environment
+      return if ALLOWED_ENVIRONMENTS.include?(environment)
+
+      raise(
+        ArgumentError,
+        "Invalid environment: #{environment}. Allowed environments: #{ALLOWED_ENVIRONMENTS.join(", ")}"
+      )
+    end
+
+    def validate_bank
+      return if ALLOWED_BANKS.include?(bank)
+
+      raise(
+        ArgumentError,
+        "Invalid bank: #{bank}. Allowed banks: #{ALLOWED_BANKS.join(", ")}"
+      )
+    end
+
+    def connection
+      @connection ||= Faraday.new(url: base_url, headers: default_headers) do |conn|
+        conn.adapter Faraday.default_adapter
+        conn.response :json
+        conn.response :raise_error
+        conn.request :url_encoded
+      end
+    end
+
+    def default_headers
+      {
+        'Content-Type' => 'application/x-www-form-urlencoded'
+      }
+    end
+
+    def default_params
+      {
+        'userName' => username,
+        'password' => password
+      }
+    end
+  end
+end

data/lib/pay_rb/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PayRb
+  VERSION = "0.2.0"
+end

data/lib/pay_rb.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "pay_rb/version"
+require_relative "pay_rb/client"
+
+require 'faraday'
+require 'active_support/core_ext/string/inflections'
+
+module PayRb
+  class Error < StandardError; end
+end

data/sig/pay_rb.rbs

@@ -0,0 +1,4 @@
+module PayRb
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: pay_rb
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Kiriakos Velissariou
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.24'
+description: A Ruby wrapper for banks' REST API that provides a simple interface for
+  managing banking operations.
+email:
+- kiriakos@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pay_rb.rb
+- lib/pay_rb/client.rb
+- lib/pay_rb/version.rb
+- sig/pay_rb.rbs
+homepage: https://github.com/kiriakosv/pay_rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kiriakosv/pay_rb
+  source_code_uri: https://github.com/kiriakosv/pay_rb
+  changelog_uri: https://github.com/kiriakosv/pay_rb/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Ruby client for banks
+test_files: []