BnmAPI 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce36e8209b58c4a626102148db4881260685bc80474e047d2a5d208ca11f6d38
-  data.tar.gz: d03fd8557fa540500ddbadb94f52dddb73eb18d997285498091d5158c87d62fc
+  metadata.gz: 1db572c75b9ac8f3c08255a25fe154b2d344851c12b57526ada5d0677de94c71
+  data.tar.gz: ae6ef3c73bd15f81899785ce867f7311e3daa96bd7d24df4453c9f1513d7a0f2
 SHA512:
-  metadata.gz: 2ebd4debd931b28525aeb87a4634e1d595d4f6349ad6258d7d5e7842be6c7401de6b9597e6dd7c1be55ff1fe008b5348636d2b4b01f1d1a441c11eba8ca6c3ce
-  data.tar.gz: e5394be3062c4485cb85e7e055b2907137b967d17bbb952b10af0c1141e9871f6d11a5faf4ecb495b14a92cff7ced9e7f6efe22f39000e788a76ff19621af11e
+  metadata.gz: 82b24c23630970776788e7a5856ba1d96e0b5f4bbc6dcbe33bf0d5a191a65bcbc89a7342442217b88ee79caa939dfab265f964aa25ecae2a372f1b51da24236c
+  data.tar.gz: 1886ac4524a0f5ea6d725a4ca263dcfffdba7cce8617aec69b094badec05309751de74bbdcebcc9245fbbea8c7057671cb45e1d7413d7e276fb25259dd89f10a

data/.travis.yml

@@ -1,7 +1,17 @@
----
+env:
+  global:
+    - CC_TEST_REPORTER_ID=eb717534daf85909a03c990170e4dbd849d1eef16cc9cc804cfa912b284df872
 sudo: false
 language: ruby
 cache: bundler
 rvm:
   - 2.6.1
 before_install: gem install bundler -v 1.17.2
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile.lock

@@ -1,17 +1,21 @@
 PATH
   remote: .
   specs:
-    BnmAPI (0.1.1)
+    BnmAPI (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.6.0)
       public_suffix (>= 2.0.2, < 4.0)
+    ansi (1.5.0)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
+    docile (1.3.1)
     hashdiff (0.3.8)
+    hirb (0.7.3)
+    json (2.2.0)
     public_suffix (3.0.3)
     rake (10.5.0)
     rspec (3.8.0)
@@ -28,6 +32,15 @@ GEM
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
     safe_yaml (1.0.5)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-console (0.4.2)
+      ansi
+      hirb
+      simplecov
+    simplecov-html (0.10.2)
     vcr (4.0.0)
     webmock (3.5.1)
       addressable (>= 2.3.6)
@@ -42,6 +55,8 @@ DEPENDENCIES
   bundler (~> 1.17)
   rake (~> 10.0)
   rspec (~> 3.0)
+  simplecov
+  simplecov-console
   vcr
   webmock
 

data/README.md

@@ -1,9 +1,13 @@
 # Bnmapi
 
+[![Maintainability](https://api.codeclimate.com/v1/badges/b6e071e2dc07ea011a62/maintainability)](https://codeclimate.com/github/jibone/bnmapi/maintainability)
+[![Test
+Coverage](https://api.codeclimate.com/v1/badges/b6e071e2dc07ea011a62/test_coverage)](https://codeclimate.com/github/jibone/bnmapi/test_coverage)
+
 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.
+_Note:_ This gem is still in early development stages and not ready for use.
 
 ## Installation
 
@@ -68,7 +72,7 @@ details.
 collection = BnmAPI::BaseRate.latest
 
 collection.size
-# 35 (number if bank in the response like)
+# 35 (number of banks that the response return)
 
 puts collection[0].bank_code
 # BKKBMYKL
@@ -124,14 +128,87 @@ puts bank.last_updated.class
 
 puts bank.last_updated.iso8601
 # 2019-01-18T19:25:02+00:00
+# it returns and DateTime object
 
 puts bank.effective_date.class
 # Date
 
 puts bank.effective_date.iso8601
 # 2019-04-05
+# it returns and Date object
+```
+
+### Daily FX Turnover
+
+Daily foreign exchange turnover for all currencies including interbank and
+customer deals
+
+#### (latest)
+https://api.bnm.gov.my/portal#operation/DFXTLatest
+
+Get the latest FX turnover.
+
+```ruby
+fx_turn_over = BnmAPI::DailyFXTurnover.latest
+
+puts fx_turn_over.date.iso8601
+# 2019-04-05
+# it returns and Date object
+
+puts fx_turn_over.total_sum
+# 11.95
+
+puts fx_turn_over.last_updated
+# 2019-01-18T19:25:02+00:00
+# it returns and DateTime object
+```
+
+#### (by date)
+https://api.bnm.gov.my/portal#operation/DFXTDate
+
+Get daily FX turnover for the date.
+
+```ruby
+# by an initialize Date object
+date = Date.parse('10-4-2019')
+fx_turn_over = BnmAPI::DailyFXTurnover.by_date(date)
+
+# from a string that can be parse to a date
+fx_turn_over = BnmAPI::DailyFXTurnover.by_date('10-4-2019')
+
+puts fx_turn_over.date.iso8601
+# 2019-04-05
+# it returns and Date object
+
+puts fx_turn_over.total_sum
+# 11.95
+
+puts fx_turn_over.last_updated
+# 2019-01-18T19:25:02+00:00
+# it returns and DateTime object
+```
+
+#### (by year and month)
+https://api.bnm.gov.my/portal#operation/DFXTMonth
+
+Get the list of daily FX turnover for the month
+
+```ruby
+fx_collection = BnmAPI::DailyFXTurnover.by_month(year: 2019, month: 4)
+
+puts fx_collection[0].date.iso8601
+# 2019-04-05
+# it returns and Date object
+
+puts fx_collection[0].total_sum
+# 11.95
+
+puts fx_collection[0].last_updated
+# 2019-01-18T19:25:02+00:00
+# it returns and DateTime object
 ```
 
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/bnmapi.gemspec

@@ -24,9 +24,11 @@ Gem::Specification.new do |spec|
 
   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 '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'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-console'
 end

data/lib/bnmapi.rb

@@ -1,9 +1,12 @@
 require 'bnmapi/version'
 require 'bnmapi/http/client'
 require 'bnmapi/data/bank_base_rate'
+require 'bnmapi/data/fx_turnover'
 require 'bnmapi/error/invalid_bank_code'
+require 'bnmapi/error/no_fx_turnover'
 require 'bnmapi/welcome'
 require 'bnmapi/base_rate'
+require 'bnmapi/daily_fx_turnover'
 
 module BnmAPI
   # Your code goes here...

data/lib/bnmapi/daily_fx_turnover.rb

@@ -0,0 +1,54 @@
+module BnmAPI
+  class DailyFXTurnover
+    ENDPOINT = '/fx-turn-over'
+
+    def self.latest
+      res = fetch_data(ENDPOINT)
+      present_data(res['data'], res['meta']['last_updated'])
+    end
+
+    def self.by_date(date)
+      date_string = if date.is_a?(Date)
+        "#{date.year}-#{date.month}-#{date.day}"
+      else
+        d = Date.parse(date)
+        "#{d.year}-#{d.month}-#{d.day}"
+      end
+
+      res = fetch_data(ENDPOINT + '/date/' + date_string)
+      present_data(res['data'], res['meta']['last_updated'])
+    end
+
+    def self.by_month(year:, month:)
+      res = fetch_data("#{ENDPOINT}/year/#{year}/month/#{month}")
+
+      collection = []
+      res['data'].each do |data|
+        collection << present_data(data, res['meta']['last_updated'])
+      end
+
+      collection
+    end
+
+    private
+
+    def self.fetch_data(endpoint)
+      http = BnmAPI::HTTP::Client.new(endpoint: endpoint)
+      res = http.request
+
+      if res.code == '404'
+        raise BnmAPI::Error::NoFXTurnover.new(endpoint: endpoint)
+      end
+
+      JSON.parse(res.read_body)
+    end
+
+    def self.present_data(data, last_updated)
+      BnmAPI::Data::FXTurnover.new(
+        data['total_sum'],
+        data['date'],
+        last_updated
+      )
+    end
+  end
+end

data/lib/bnmapi/data/fx_turnover.rb

@@ -0,0 +1,16 @@
+module BnmAPI::Data
+  FXTurnover = Struct.new(
+    :total_sum,
+    :date_data,
+    :last_updated_data
+  ) do
+
+    def last_updated
+      DateTime.parse(last_updated_data)
+    end
+
+    def date
+      Date.parse(date_data)
+    end
+  end
+end

data/lib/bnmapi/error/no_fx_turnover.rb

@@ -0,0 +1,10 @@
+module BnmAPI::Error
+  class NoFXTurnover < StandardError
+    attr_reader :date
+
+    def initialize(msg: 'No fx turnover on date. endpoint: ', endpoint:)
+      @date = date
+      super(msg + endpoint)
+    end
+  end
+end

data/lib/bnmapi/version.rb

@@ -1,3 +1,3 @@
 module BnmAPI
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: BnmAPI
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - J Shamsul Bahri (jibone))
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-11 00:00:00.000000000 Z
+date: 2019-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: simplecov-console
+  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
@@ -103,8 +131,11 @@ files:
 - bnmapi.gemspec
 - lib/bnmapi.rb
 - lib/bnmapi/base_rate.rb
+- lib/bnmapi/daily_fx_turnover.rb
 - lib/bnmapi/data/bank_base_rate.rb
+- lib/bnmapi/data/fx_turnover.rb
 - lib/bnmapi/error/invalid_bank_code.rb
+- lib/bnmapi/error/no_fx_turnover.rb
 - lib/bnmapi/http/client.rb
 - lib/bnmapi/version.rb
 - lib/bnmapi/welcome.rb