oyi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f83762c6223642f99bcb237c6a8996708002102aa6d36f33d256e49f01777777
+  data.tar.gz: d1f34080970ae1d8fe601357c01dccd7c4d9c8e17da61261666c05f1bc6a71e2
+SHA512:
+  metadata.gz: e6db05cc7ab9b469f22128ec28dc6e9d4355a33044aa758c5eb4eddfe3f504e979b69c814a12c4626f37b51a9c00707797c1169589a21d67f3a28d683afc8a09
+  data.tar.gz: fd3c4a5da13586a6f170d86ec9c93a2ef1ce1e54c797e19d0586bc7703c2cb6d758306857ab21ab217ddf2dd485b9be8e6181e4b25c6dfb7b7766d94ec40ad53

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/.tool-versions

@@ -0,0 +1 @@
+ruby 2.6.6

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at me@itsgg.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in oyi.gemspec
+gemspec
+
+gem 'rake'
+gem 'rspec'
+gem 'vcr'
+gem 'webmock'
+gem 'yard'
+gem 'webmock'

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    oyi (0.1.0)
+      rest-client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.4)
+    diff-lcs (1.3)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (1.0.1)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    netrc (0.11.0)
+    public_suffix (4.0.6)
+    rake (12.3.3)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    vcr (5.1.0)
+    webmock (3.9.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.25)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  oyi!
+  rake
+  rspec
+  vcr
+  webmock
+  yard
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Ganesh Gunasegaran
+
+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,152 @@
+# Oyi
+
+Ruby library for https://oyindonesia.com/ APIs
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'oyi'
+```
+
+And then execute:
+
+```bash
+bundle install
+````
+
+Or install it yourself as:
+
+```bash
+gem install oyi
+```
+
+## Development 
+
+### Running the tests
+
+```bash
+rake spec
+```
+### Generate Documentation
+```bash
+rake yard
+```
+## Usage
+
+### Configure the client
+
+For the request params and responses please refer https://api-docs.oyindonesia.com/
+
+```ruby
+Oyi::Client.configure(api_url: 'url', api_username: 'username', api_key: 'api_key')
+```
+
+### Account Methods
+
+Get beneficiery account details
+```ruby
+Oyi::Account.inquiry(params)
+```
+
+### Disbursement Methods
+
+Get beneficiary account details
+```ruby
+Oyi::Disbursement.inquiry(params)
+```
+
+Start disbursing money to a specific amount
+```ruby
+Oyi::Disbursement.remit(params)
+```
+
+Get status of a disbursement request
+```ruby
+Oyi::Disbursement.remit_status(params)
+```
+
+Get partner balance
+```ruby
+Oyi::Disbursement.balance
+```
+
+Create a scheduled disbursement
+```ruby
+Oyi::Disbursement.schedule_remit(params)
+```
+
+Get the details of a scheduled remit
+```ruby
+Oyi::Disbursement.schedule_remit_details(params)
+```
+
+Get a list of all scheduled remits
+```ruby
+Oyi::Disbursement.list_scheduled_remit(params)
+```
+
+Delete a scheduled remit
+```ruby
+Oyi::Disbursement.cancel_scheduled_remit(params)
+```
+
+Retry a scheduled remit
+```ruby
+Oyi::Disbursement.retry_scheduled_remit(params)
+```
+
+### Virtual Account Methods
+
+Create a new VA number
+```ruby
+Oyi::VirtualAccount.create(params)
+```
+
+Get VA details
+```ruby
+Oyi::VirtualAccount.get(id)
+```
+
+Update existing VA
+```ruby
+Oyi::VirtualAccount.update(id, params)
+```
+
+Get all VAs
+```ruby
+Oyi::VirtualAccount.all(params)
+```
+
+Get all transactions for a VA
+```ruby
+Oyi::VirtualAccount.transaction(id, params)
+```
+
+### Acceptance Methods
+
+Create a payment checkout URL
+```ruby
+Oyi::Acceptance.payment_checkout(params)
+```
+
+Create a payment checkout URL with addtional details for invoicing
+```ruby
+Oyi::Acceptance.create_invoice(params)
+```
+
+Get the status of a transaction
+```ruby
+Oyi::Acceptance.status(params)
+```
+
+Delete a payment/invoice link
+```ruby
+Oyi::Acceptance.delete(params)
+```
+
+Get the details of a payment/invoice link
+```ruby
+Oyi::Acceptance.get(params)
+```

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+
+YARD::Rake::YardocTask.new
+
+task default: :spec

data/bin/console

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'rest-client'
+require 'json'
+
+require 'oyi/status_codes'
+require 'oyi/errors'
+require 'oyi/version'
+require 'oyi/client'
+require 'oyi/account'
+require 'oyi/disbursement'
+require 'oyi/acceptance'
+require 'oyi/virtual_account'
+
+module Oyi; end

data/lib/oyi/acceptance.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Oyi
+  # Accept fund from yoru customers
+  class Acceptance
+    class << self
+      # Create a payment checkout URL
+      def payment_checkout(params)
+        Client.request http_method: :post, endpoint: '/api/payment-checkout/create-v2', params: params
+      end
+
+      # Create a payment checkout URL with addtional details for invoicing
+      def create_invoice(params)
+        Client.request http_method: :post, endpoint: '/api/payment-checkout/create-invoice', params: params
+      end
+
+      # Get the status of a transaction
+      def status(params)
+        Client.request http_method: :get, endpoint: "/api/payment-checkout/status?#{URI.encode_www_form(params)}"
+      end
+
+      # Delete a payment/invoice link
+      def delete(params)
+        Client.request http_method: :delete, endpoint: "/api/payment-checkout/#{params[:payment_link_id_or_partner_tx_id]}"
+      end
+
+      # Get the details of a payment/invoice link
+      def get(params)
+        Client.request http_method: :get, endpoint: "/api/payment-checkout/#{params[:payment_link_id_or_partner_tx_id]}"
+      end
+    end
+  end
+end

data/lib/oyi/account.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Oyi
+  # Handles beneficiary account details
+  class Account
+    class << self
+      # Get beneficiery account details
+      def inquiry(params)
+        Client.request http_method: :post, endpoint: '/api/account-inquiry', params: params
+      end
+    end
+  end
+end

data/lib/oyi/client.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Oyi
+  # The REST client that talks to OY API
+  class Client
+    class << self
+      def configure(api_url:, api_username:, api_key:)
+        @api_url = api_url
+        @api_username = api_username
+        @api_key = api_key
+      end
+
+      def configured?
+        @api_url && @api_username && @api_key
+      end
+
+      def request(http_method:, endpoint:, params: nil)
+        raise Error.new(message: 'Oyi client not configured') unless configured?
+
+        begin
+          response = RestClient::Request.execute method: http_method, url: "#{@api_url}/#{endpoint}",
+                                                 payload: params&.to_json, headers: {
+                                                   'Content-Type': 'application/json',
+                                                   'Accept': 'application/json',
+                                                   'X-OY-Username': @api_username,
+                                                   'X-Api-Key': @api_key
+                                                 }
+          @code = response.code
+          @message = begin
+                    JSON.parse(response.body)
+                     rescue JSON::ParserError
+                       response.body
+                  end
+        rescue RestClient::RequestFailed => e
+          @code = e.http_code
+          @message = e.message
+        end
+        status = @message['status']
+        if @code == HTTP_OK_CODE
+          raise ApiError.new(message: @message['message']) if status == false
+
+          custom_error_code = status.is_a?(Hash) && status['code']
+          if custom_error_code && !VALID_CODES.include?(custom_error_code)
+            raise ApiError.new(code: custom_error_code, message: @message)
+          end
+
+          return @message
+        end
+
+        raise error_class(@code).new(code: @code, message: @message)
+      end
+
+      def error_class(code)
+        case code
+        when HTTP_BAD_REQUEST_CODE
+          BadRequestError
+        when HTTP_UNAUTHORIZED_CODE
+          UnauthorizedError
+        when HTTP_FORBIDDEN_CODE
+          ForbiddenError
+        when HTTP_NOT_FOUND_CODE
+          NotFoundError
+        when HTTP_UNPROCESSABLE_ENTITY_CODE
+          UnprocessableEntityError
+        else
+          ApiError
+        end
+      end
+    end
+  end
+end

data/lib/oyi/disbursement.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Oyi
+  # Allows you to disburse fund to any bank accounts in Indonesia
+  class Disbursement
+    class << self
+      # Get beneficiary account details
+      def account_inquiry(params)
+        Client.request http_method: :post, endpoint: '/api/inquiry', params: params
+      end
+
+      # Start disbursing money to a specific amount
+      def remit(params)
+        Client.request http_method: :post, endpoint: '/api/remit', params: params
+      end
+
+      # Get status of a disbursement request
+      def remit_status(params)
+        Client.request http_method: :post, endpoint: '/api/remit-status', params: params
+      end
+
+      # Get partner balance
+      def balance
+        Client.request http_method: :get, endpoint: '/api/balance'
+      end
+
+      # Create a scheduled disbursement
+      def schedule_remit(params)
+        Client.request http_method: :post, endpoint: '/api/scheduled-remit', params: params
+      end
+
+      # Get the details of a scheduled remit
+      def scheduled_remit_details(params)
+        Client.request http_method: :get, endpoint: '/api/scheduled-remit', params: params
+      end
+
+      # Get a list of all scheduled remits
+      def list_scheduled_remit
+        Client.request http_method: :post, endpoint: '/api/scheduled-remit/list'
+      end
+
+      # Delete a scheduled remit
+      def cancel_scheduled_remit(params)
+        Client.request http_method: :delete, endpoint: '/api/scheduled-remit', params: params
+      end
+
+      # Retry a scheduled remit
+      def retry_scheduled_remit(params)
+        Client.request http_method: :post, endpoint: '/api/scheduled-remit/retry', params: params
+      end
+    end
+  end
+end

data/lib/oyi/errors.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Oyi
+  # Custom Error Classes
+  class Error < StandardError
+    attr_accessor :code, :message
+
+    def initialize(code: nil, message:)
+      @code = code
+      @message = message
+    end
+  end
+
+  BadRequestError = Class.new(Error)
+  UnauthorizedError = Class.new(Error)
+  ForbiddenError = Class.new(Error)
+  NotFoundError = Class.new(Error)
+  UnprocessableEntityError = Class.new(Error)
+  ApiError = Class.new(Error)
+end

data/lib/oyi/status_codes.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Oyi
+  HTTP_OK_CODE = 200
+  HTTP_BAD_REQUEST_CODE = 400
+  HTTP_UNAUTHORIZED_CODE = 401
+  HTTP_FORBIDDEN_CODE = 403
+  HTTP_NOT_FOUND_CODE = 404
+  HTTP_UNPROCESSABLE_ENTITY_CODE = 429
+  VALID_CODES = [
+    '000', # Success
+    '101', # Request processed
+    '103' # Scheduled
+  ].freeze
+end

data/lib/oyi/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Oyi
+  VERSION = '0.1.0'
+end

data/lib/oyi/virtual_account.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Oyi
+  # Use unique Virutal Account number as a payment method for your customers
+  class VirtualAccount
+    class << self
+      # Create a new VA number
+      def create(params)
+        Client.request http_method: :post, endpoint: '/api/generate-static-va', params: params
+      end
+
+      # Get VA details
+      def get(id)
+        Client.request http_method: :get, endpoint: "/api/static-virtual-account/#{id}"
+      end
+
+      # Update existing VA
+      def update(id, params)
+        Client.request http_method: :put, endpoint: "/api/static-virtual-account/#{id}", params: params
+      end
+
+      # Get all VAs
+      def all(params = {})
+        Client.request http_method: :get, endpoint: "/api/static-virtual-account?#{URI.encode_www_form(params)}"
+      end
+
+      # Get all transactions for a VA
+      def transactions(id, params = {})
+        Client.request http_method: :get, endpoint: "/api/va-tx-history/#{id}?#{URI.encode_www_form(params)}"
+      end
+    end
+  end
+end

data/oyi.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'lib/oyi/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'oyi'
+  spec.version = Oyi::VERSION
+  spec.authors = ['Ganesh Gunasegaran']
+  spec.email = ['me@itsgg.com']
+
+  spec.summary = 'Ruby library for https://oyindonesia.com/ APIs'
+  spec.homepage = 'https://www.bukukas.co.id/'
+  spec.license = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/itsgg/oyi'
+
+  spec.add_dependency 'rest-client'
+
+  # 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(__dir__)) 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']
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: oyi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ganesh Gunasegaran
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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'
+description: 
+email:
+- me@itsgg.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".tool-versions"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/oyi.rb
+- lib/oyi/acceptance.rb
+- lib/oyi/account.rb
+- lib/oyi/client.rb
+- lib/oyi/disbursement.rb
+- lib/oyi/errors.rb
+- lib/oyi/status_codes.rb
+- lib/oyi/version.rb
+- lib/oyi/virtual_account.rb
+- oyi.gemspec
+homepage: https://www.bukukas.co.id/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.bukukas.co.id/
+  source_code_uri: https://github.com/itsgg/oyi
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.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: Ruby library for https://oyindonesia.com/ APIs
+test_files: []