lariconv 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a90d47353f67337f935248d3fbaf1ae461c9783b1061c2ad518b05043779bf8
-  data.tar.gz: ba924d182e982e68d5c4db84e19faeec7de2487e0e50ad0e6b78796a2d4c8a04
+  metadata.gz: 11f69bda9dc9a3e1dbc43ed9e1e0b3922e4e1086f054e32235b03f1ee3d1187c
+  data.tar.gz: defc56c19133dee86f671bcb864cac005541e7fde4911f070b9f9dc8c7f6acac
 SHA512:
-  metadata.gz: 5d7e2f5837856d4070b6b451cb811b08955639b1b41c34275b373ce4e6f05b65b7f614cffa7bdb884433b7756dac970a27053ef499f73757919b9e18018bf543
-  data.tar.gz: 1f597a15f4a1e6e3476b17e9e525e31629c6d37223dc10ebb11136fd676dd85be7c866be86a760b3f5e129169f9569f3132e7ec46b95cbfc201b7dd13e678279
+  metadata.gz: 5e63a48e06efc6d4af84e57213be099f24aaf780d9d711eb930fdd1f3d7c428c7f8f2d19444629c00220409a9e843a5594dc868147495b0f5838ee63f02979c1
+  data.tar.gz: ae822d0f0ecbe6ba16c687312d17640ca5980eca6f5c384c6435874b588e7d8917a4a5d174953bb6a03ca3cac3fa7444d12a2b5d4f4dcd601edd9f7b09a94996

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+`lariconv` changelog
+====================
+
+## 0.2.0 (August 15, 2023)
+
+* Change `Lariconv#convert` signature
+* Add exception handling
+* Restrict list of currencies to reasonable
+
+
+## 0.1.0 (August 13, 2023)
+
+* Initial gem release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Den Patin
+
+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,33 @@
+`lariconv`
+==========
+
+[![Gem Version](https://badge.fury.io/rb/lariconv.svg)](https://badge.fury.io/rb/lariconv)
+
+Gem to convert different currencies to Georgian Lari based on
+the National Bank of Georgia's exchange rate for a given date.
+
+## Usage
+
+```ruby
+Lariconv.convert(amount: 1000, currency: 'GBP', date: '2022-08-15')
+# => 0.32829e4 (BigDecimal)
+
+Lariconv.convert(amount: BigDecimal('100.68'), currency: 'EUR')
+# => 0.28869e3 (BigDecimal)
+
+Lariconv.convert(amount: 1.5, currency: 'USD', date: '2023-08-15').to_f
+# => 3.93 (Float)
+
+Lariconv.convert(amount: 100, currency: 'EUR').to_s('F')
+# => "288.16" (String)
+
+Lariconv.convert(amount: 'abc', currency: 'EUR')
+# => Lariconv::InvalidAmountException
+
+Lariconv.convert(amount: 1000, currency: 'WTF')
+# => Lariconv::UnavailableCurrencyException
+```
+
+## Copyright
+
+Copyright (c) 2023 Den Patin. See LICENSE for details.

data/lib/lariconv.rb

@@ -1,18 +1,78 @@
 # frozen_string_literal: true
 
+require 'bigdecimal'
+require 'bigdecimal/util'
+require 'date'
 require 'json'
 require 'open-uri'
 
+# Link to the National Bank of Georgia's API in English
 URL = 'https://nbg.gov.ge/gw/api/ct/monetarypolicy/currencies/en/json'
 
+# List of currencies _BOTH_ available to run business in BoG and with the known exchange rate from NBG API
+CURRENCIES = %w[AED AMD AUD AZN BYN CAD CHF CNY DKK EUR GBP ILS INR JPY KZT NOK QAR SEK TRY UAH USD UZS].freeze
+# List of currencies with the known exchange rate from NBG API but _NOT_ available to run business in BoG
+NBG_CURRENCIES = %w[BGN BRL CZK EGP HKD HUF IRR ISK KGS KRW KWD MDL NZD PLN RON RSD RUB SGD TJS TMT ZAR].freeze
+# List of currencies available to run business in BoG but with _NOT_ available exchange rate from NBG API
+BOG_CURRENCIES = %w[BHD IDR JOD LBP MAD MXN MYR PHP PKR RUR SAR THB VND].freeze
+# TODO: Add info from TBC, Liberty, Basisbank, as well as from Wise Business and Revolut Business
+
 class Lariconv
-  def self.convert(amount, currency, date)
-    url = "#{URL}?currencies=#{currency}&date=#{date}"
-    response = JSON.parse(URI.parse(url).read)
-    data = response.first['currencies'].first
-    quantity = data['quantity']
-    rate = data['rate']
-    result = amount.to_f / quantity * rate
+  class InvalidAmountException < StandardError; end
+
+  class UnavailableCurrencyException < StandardError; end
+
+  def self.convert(...)
+    new(...).convert
+  end
+
+  def initialize(amount:, currency:, date: nil)
+    @amount = amount
+    @currency = currency.upcase
+    @date = date
+  end
+
+  # @param amount [Integer, Float, BigDecimal] Amount of money to convert
+  # @param currency [String] Currency to convert to Lari from
+  # @param date [String] Date to get the exchange rate for (default: today)
+  # @return [BigDecimal] Converted amount of money
+  def convert
+    quantity, rate = fetch_currency_data
+    result = (amount / quantity) * rate
     result.round(2)
   end
+
+  def amount
+    raise InvalidAmountException unless [Integer, Float, BigDecimal].include? @amount.class
+
+    @amount.to_d
+  end
+
+  def currency
+    raise UnavailableCurrencyException unless CURRENCIES.include? @currency
+
+    @currency
+  end
+
+  def date
+    @date ||= parse_date
+  end
+
+  private
+
+  def parse_date
+    Date.parse @date
+  rescue StandardError
+    Date.today
+  end
+
+  def fetch_currency_data
+    response = JSON.parse URI.parse(currency_url).read
+    data = response.first['currencies'].first
+    [data['quantity'].to_d, data['rate'].to_d]
+  end
+
+  def currency_url
+    "#{URL}?currencies=#{currency}&date=#{date}"
+  end
 end

metadata

@@ -1,23 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: lariconv
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Den Patin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-13 00:00:00.000000000 Z
-dependencies: []
+date: 2023-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
 description: |2
-      `lariconv` is a gem that converts different currencies to Georgian Lari
-      based on the National Bank of Georgia's exchange rate for a given date.
+      This gem converts different currencies to Georgian Lari based on
+      the National Bank of Georgia's exchange rate for a given date.
+      Compatible with the `money` gem.
 email: den@hey.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE
+- README.md
 - lib/lariconv.rb
 homepage: https://github.com/denpatin/lariconv
 licenses: