BnmAPI 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fc66d3951b21035682a2b4b2f6ea0b4da1096d0d0e97b673c8882ed170181a3c
+  data.tar.gz: 6e1297d73b069c1b246010dd55569923f9331703663e4c64b1ff892f708486c7
+SHA512:
+  metadata.gz: 5ac8cdb7b96ecf0f4579d99d2cf487cc0eba8bf54f0be6af3fc0b1e604fa47c2595b9c82756fecf14518669ad5081c1f41ed33a715a5efa7ed899ddd2ba0ab91
+  data.tar.gz: e99bfa3283a5c872ef932bcfd1084a16299410905f51bc54304e159d04066b0a92e66de288a24ded7e5237f53170482542eb6fb0a2cdf42edb3cb9b54acd5c5e

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.1
+before_install: gem install bundler -v 1.17.2

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 jibone@gmail.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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 bnmapi.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    BnmAPI (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.8)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.5)
+    vcr (4.0.0)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  BnmAPI!
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  vcr
+  webmock
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 J Shamsul Bahri (jibone))
+
+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,151 @@
+# Bnmapi
+
+Ruby wrapper for Bank Negara Malaysia Open API. Details and API disclaimer can
+be found here [BNM Open API](https://api.bnm.gov.my/portal)
+
+_Note:_ This gem is still in early devvelopment stages and not ready for use.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bnmapi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bnmapi
+
+## Usage
+
+### Getting Started
+
+#### (/welcome)
+https://api.bnm.gov.my/portal#operation/Welcome
+
+Getting started API which returns information and descriptions for BNM Open APi.
+
+```ruby
+welcome = BnmAPI::Welcome.get
+
+puts welcome.name
+# BNM.API
+
+puts welcome.api
+# ['v1']
+
+puts welcome.description
+# displays API discription
+
+puts welcome.disclaimer
+# https://api.bnm.gov.my/disclaimer
+
+puts welcome.contact_name
+# BNM.API
+
+puts welcome.contact_email
+# oapi@bnm.gov.my
+```
+
+### Base Rate/BLR/Effective LR
+
+Current Base Rates and Base Lending Rates for retail loans or financing
+facilities and Indicative Effective Lending Rates for a standard housing
+loan/home financing offered by financial institutions.
+
+#### (latest)
+https://api.bnm.gov.my/portal#operation/BRLatest
+
+Creates a list of bank information with base rate and base lending rates
+details.
+
+```ruby
+collection = BnmAPI::BaseRate.latest
+
+collection.size
+# 35 (number if bank in the response like)
+
+puts collection[0].bank_code
+# BKKBMYKL
+
+puts collection[0].bank_name
+# Bangkok Bank Berhad
+
+puts collection[0].base_rate
+# 4.72
+
+puts collection[0].base_financing_rate
+# 7.37
+
+puts collection[0].base_lending_rate
+# 5.92
+
+puts collection[0].last_updated
+# 2019-02-14 11:48:23
+
+puts collection[0].effective_date
+# 2019-04-05
+```
+
+#### (by bank code)
+https://api.bnm.gov.my/portal#operation/BRBankCode
+
+```ruby
+bank = BnmAPI::BaseRate.by_bank_code('BKKBMYKL')
+
+puts bank.bank_code
+# BKKBMYKL
+
+puts bank.bank_name
+# Bangkok Bank Berhad
+
+puts bank.base_rate
+# 4.72
+
+puts bank.base_lending_rate
+# 7.37
+
+puts bank.indicative_eff_lending_rate
+# 5.92
+
+puts bank.last_updated
+# 2019-01-18 19:25:02
+
+puts bank.effective_date
+# 2019-04-05
+```
+
+## 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/jibone/bnmapi. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Bnmapi project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/jibone/bnmapi/blob/master/CODE_OF_CONDUCT.md).

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 "bnmapi"
+
+# 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/bnmapi.gemspec

@@ -0,0 +1,53 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bnmapi/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "BnmAPI"
+  spec.version       = BnmAPI::VERSION
+  spec.authors       = ["J Shamsul Bahri (jibone))"]
+  spec.email         = ["jibone@gmail.com"]
+
+  spec.summary       = %q{Wrapper around BNM open API}
+  #spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/jibone/bnmapi"
+  spec.license       = "MIT"
+
+  # 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["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  #  spec.metadata["homepage_uri"] = spec.homepage
+  #  spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #  spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  #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.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map do |f|
+    File.basename(f)
+  end
+
+  spec.require_paths = ["lib"]
+
+  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

data/lib/bnmapi/base_rate.rb

@@ -0,0 +1,46 @@
+module BnmAPI
+  class BaseRate
+    ENDPOINT = '/base-rate'
+
+    def self.latest
+      http = BnmAPI::HTTP::Client.new(endpoint: ENDPOINT)
+
+      res = JSON.parse(http.request.read_body)
+
+      collection = []
+
+      res['data'].each do |data|
+        collection << BnmAPI::Data::BankBaseRate.new(
+          data['bank_code'],
+          data['bank_name'],
+          data['base_rate'],
+          data['base_lending_rate'],
+          data['base_financing_rate'],
+          data['indicative_eff_lending_rate'],
+          res['meta']['last_updated'],
+          res['meta']['effective_date']
+        )
+      end
+
+      collection
+    end
+
+    def self.by_bank_code(bank_code)
+      http = BnmAPI::HTTP::Client.new(endpoint: ENDPOINT + '/' + bank_code)
+
+      res = JSON.parse(http.request.read_body)
+
+      BnmAPI::Data::BankBaseRate.new(
+          res['data']['bank_code'],
+          res['data']['bank_name'],
+          res['data']['base_rate'],
+          res['data']['base_lending_rate'],
+          res['data']['base_financing_rate'],
+          res['data']['indicative_eff_lending_rate'],
+          res['meta']['last_updated'],
+          res['meta']['effective_date']
+      )
+
+    end
+  end
+end

data/lib/bnmapi/data/bank_base_rate.rb

@@ -0,0 +1,17 @@
+module BnmAPI::Data
+  # not sure what is the difference between landing rate and financing rate
+  # the API response some returns landing rate and some returns financing rate
+  # including both in the data.
+  BankBaseRate = Struct.new(
+    :bank_code,
+    :bank_name,
+    :base_rate,
+    :base_lending_rate,
+    :base_financing_rate,
+    :indicative_eff_lending_rate,
+    :last_updated,
+    :effective_date
+  ) do
+
+  end
+end

data/lib/bnmapi/http/client.rb

@@ -0,0 +1,44 @@
+require 'net/http'
+require 'open-uri'
+require 'openssl'
+require 'json'
+
+module BnmAPI::HTTP
+  class Client
+    attr_accessor :endpoint
+
+    BASE_API = 'https://api.bnm.gov.my/public'
+    HEADER_ACCEPT = 'application/vnd.BNM.API.v1+json'
+
+    def initialize(endpoint:)
+      self.endpoint = endpoint
+    end
+
+    def request
+      uri = prepare_uri
+      http = prepare_http(uri)
+      http.request(prepare_request(uri))
+    end
+
+    def prepare_uri
+      uri = BASE_API + endpoint
+      URI.parse(uri)
+    end
+
+    def prepare_http(uri)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      http
+    end
+
+    def prepare_request(uri)
+      req = Net::HTTP::Get.new(uri.request_uri)
+      req['Accept'] = HEADER_ACCEPT
+
+      req
+    end
+
+  end
+end

data/lib/bnmapi/version.rb

@@ -0,0 +1,3 @@
+module BnmAPI
+  VERSION = "0.0.1"
+end

data/lib/bnmapi/welcome.rb

@@ -0,0 +1,34 @@
+module BnmAPI
+  Welcome = Struct.new(
+    :name,
+    :api,
+    :description,
+    :contact,
+    :disclaimer
+  ) do
+
+    API_PATH = '/welcome'
+
+    def self.get
+      http = BnmAPI::HTTP::Client.new(endpoint: API_PATH)
+
+      res = JSON.parse(http.request.read_body)
+
+      self.new(
+        res['name'],
+        res['api'],
+        res['description'],
+        res['contact'],
+        res['disclaimer']
+      )
+    end
+
+    def contact_name
+      contact['name']
+    end
+
+    def contact_email
+      contact['email']
+    end
+  end
+end

data/lib/bnmapi.rb

@@ -0,0 +1,10 @@
+require 'bnmapi/version'
+require 'bnmapi/http/client'
+require 'bnmapi/data/bank_base_rate'
+require 'bnmapi/welcome'
+require 'bnmapi/base_rate'
+
+module BnmAPI
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: BnmAPI
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- J Shamsul Bahri (jibone))
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-07 00:00:00.000000000 Z
+dependencies:
+- !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: 
+email:
+- jibone@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bnmapi.gemspec
+- lib/bnmapi.rb
+- lib/bnmapi/base_rate.rb
+- lib/bnmapi/data/bank_base_rate.rb
+- lib/bnmapi/http/client.rb
+- lib/bnmapi/version.rb
+- lib/bnmapi/welcome.rb
+homepage: https://github.com/jibone/bnmapi
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Wrapper around BNM open API
+test_files: []