currency_coin_converter 0.2.4 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d1075c2ccce1bb397d4a219bcecd2d60c291eec8d73825119763781b67e9c63
-  data.tar.gz: a7ba25a815b3008c7df632099b8b6e29e87f0c8f768cbf8e69d6739c67d652cf
+  metadata.gz: 5fbacf0f12f980a242f4f6c765c1e7195aeb73a36e92f668a23caf7de23ad0d8
+  data.tar.gz: dcd21694c722a945656103f084110d5d42bc77143e6f488ddbaf23b2c000e242
 SHA512:
-  metadata.gz: a612e5347ed886e5768fbc2b332e0987482573562aba0650c47fdc3a9624aed17769ea5a323934cb8620d5cbc77acfdc9ecc8f0d223d1da828c5f2ff3be7318c
-  data.tar.gz: 25307919d3ee45aad6159c1e8b420fde3f5e58b4d201a261ce301db64eab19da32c936c9172e10778f3c417943db945be5f19f043996a6897b9f67bef15c6c4c
+  metadata.gz: 45dee2fb4709e41770c912927d205428aa24b4574d52777c5761e32091afc49f9b5a4d40c81f789276538371433763a03181ad30340e59d1f1e9e1f74f2a7767
+  data.tar.gz: 0b331d65a475f5eb86d8eca9a5831c60ddfb383e45f03d5c1e916cd0e58a97c52fe644265f4c49592684ac6ddca6bee745d75f8907b0e41da25f92293c73102a

data/CHANGELOG.md

@@ -1,5 +1,5 @@
 ## [Unreleased]
 
-## [0.2.4] - 2024-09-10
+## [0.3.2] - 2024-09-10
 
 - Initial release

data/Gemfile

@@ -2,10 +2,10 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in currency_converter.gemspec
 gemspec
 
 gem "rake", "~> 13.0"
-gem 'httparty'
-gem 'dotenv'
 
+group :test do
+    gem "rspec"
+end

data/Gemfile.lock

@@ -1,32 +1,34 @@
 PATH
   remote: .
   specs:
-    currency_coin_converter (0.2.2)
-      httparty (~> 0.18)
+    currency_coin_converter (0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    bigdecimal (3.1.8)
-    csv (3.3.0)
-    dotenv (3.1.2)
-    httparty (0.22.0)
-      csv
-      mini_mime (>= 1.0.0)
-      multi_xml (>= 0.5.2)
-    mini_mime (1.1.5)
-    multi_xml (0.7.1)
-      bigdecimal (~> 3.1)
+    diff-lcs (1.5.1)
     rake (13.2.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.1)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
   currency_coin_converter!
-  dotenv
-  httparty
   rake (~> 13.0)
+  rspec
 
 BUNDLED WITH
    2.4.10

data/README.md

@@ -19,10 +19,11 @@ If bundler is not being used to manage dependencies, install the gem by executin
     $ gem install currency_coin_converter
 
 ## Usage
-To use this gem, you need to set up an environment variable for the Exchange Rate API key:
+To use this gem, you need to set up an initializer for the Exchange Rate API key:
 
-```bash
-export EXCHANGE_RATE_API_KEY='your_api_key_here'
+```rb
+# This should be placed before the application tries to get the exchange rate.
+CurrencyCoinConverter::Base.api_key = <your exchange rate api key>
 ```
 <br>
 
@@ -30,7 +31,7 @@ In your main file you can use
 ```
 require 'currency_coin_converter'
 
-amount_in_euros = CurrencyCoinConverter.convert(100, from: "USD", to: "EUR")
+amount_in_euros = CurrencyCoinConverter::Base.convert(100, from: "USD", to: "EUR", round: 3)
 puts amount_in_euros
 ```
 

data/bin/console

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require "bundler/setup"
-require "currency_converter"
+require "currency_coin_converter"
 
 # 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.

data/currency_coin_converter.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "lib/currency_coin_converter/version"
+require_relative "lib/currency_coin_converter"
 
 Gem::Specification.new do |spec|
   spec.name = "currency_coin_converter"
@@ -16,11 +16,9 @@ Gem::Specification.new do |spec|
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
-  # URL do projeto no GitHub
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = 'https://github.com/bussularf/currency_coin_converter'
 
-  # Arquivos incluídos na gem
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject do |f|
       f.end_with?('currency_converter.gemspec') || f.end_with?('.gem')
@@ -30,7 +28,4 @@ Gem::Specification.new do |spec|
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-
-  # Dependências, se houver
-  spec.add_dependency "httparty", "~> 0.18"  # Exemplo de dependência para chamadas HTTP
 end

data/lib/currency_coin_converter.rb

@@ -1,29 +1,79 @@
-require_relative './currency_coin_converter/version'
-require 'httparty'
-require 'dotenv/load'
+require 'json'
+require 'net/http'
+require 'singleton'
+require 'uri'
 
 module CurrencyCoinConverter
+  VERSION = "0.3.2"
+
   class Error < StandardError; end
 
-  API_URL = "https://v6.exchangerate-api.com/v6/#{ENV['EXCHANGE_RATE_API_KEY']}/latest/"
+  class Base
+    include ::Singleton
 
-  def self.convert(amount, from:, to:)
-    rates = fetch_rates(from)
-    conversion_rate = rates[to]
+    def initialize
+      self.api_version = "v6"
+    end
 
-    if conversion_rate
-      (amount * conversion_rate).round(2)
-    else
-      raise "Conversão de #{from} para #{to} não encontrada."
+    def convert(amount, from:, to:, round: 2)
+      (amount * conversion_rate(from:, to:)).round(round)
     end
-  end
 
-  def self.fetch_rates(base_currency)
-    response = HTTParty.get("#{API_URL}/#{base_currency}")
-    if response.success?
-      response.parsed_response["conversion_rates"]
-    else
-      raise "Erro ao buscar taxas de câmbio."
+    def conversion_rate(from:, to:)
+      conversion_rate = conversion_rates(from)[to]
+      return conversion_rate unless conversion_rate.nil?
+
+      raise Error, "currency code is invalid: #{to}"
+    end
+
+    def conversion_rates(base_currency)
+      get(path: base_currency)["conversion_rates"]
+    end
+
+    attr_accessor :api_key
+    attr_reader :api_version
+
+    private
+
+    attr_writer :api_version
+
+    def get(path:)
+      raise Error, "api key should be present" if api_key.strip.empty?
+      raise Error, "api version should be present" if api_version.strip.empty?
+
+      uri = ::URI::HTTPS.build(host: "#{api_version}.exchangerate-api.com", path: "/#{api_version}/#{api_key}/latest/#{path}")
+      response = ::Net::HTTP.get_response(uri)
+      parsed_response = JSON.parse(response.body)
+
+      return parsed_response if response.is_a?(::Net::HTTPSuccess)
+
+      raise Error, "#{parsed_response["error-type"]}: could not complete the request."
+    end
+
+    class << self
+      def api_key
+        instance.api_key
+      end
+
+      def api_key=(api_key)
+        instance.api_key = api_key
+      end
+
+      def api_version
+        instance.api_version
+      end
+
+      def convert(amount, from:, to:, round: 2)
+        instance.convert(amount, from:, to:, round: round)
+      end
+
+      def conversion_rate(from:, to:)
+        instance.conversion_rate(from:, to:)
+      end
+
+      def conversion_rates(base_currency)
+        instance.conversion_rates(base_currency)
+      end
     end
   end
 end

data/spec/currency_coin_converter_spec.rb

@@ -1,15 +1,42 @@
 require 'currency_coin_converter'
 
-RSpec.describe CurrencyCoinConverter do
+require 'json'
+
+RSpec.describe CurrencyCoinConverter::Base do
   before do
-    allow(ENV).to receive(:[]).with('EXCHANGE_RATE_API_KEY').and_return('fake_key')
+    described_class.api_key = "fake_key"
+  end
+
+  it '#api_key returns the set api key' do
+    expect(described_class.api_key).to eq("fake_key")
+  end
+
+  it '#api_version returns the initialized api version' do
+    expect(described_class.api_version).to eq("v6")
+  end
+
+  it '#conversion_rates returns the conversion rate for a valid currency code' do
+    response = JSON.parse(File.read("spec/examples/inr.json"))
+    allow_any_instance_of(described_class).to receive(:get).with(path: "INR").and_return(response)
+
+    expect(described_class.conversion_rates("INR")).to eq(response["conversion_rates"])
+  end
+
+  it '#conversion_rate returns the conversion rate for valid currency codes' do
+    response = JSON.parse(File.read("spec/examples/inr.json"))
+    allow_any_instance_of(described_class).to receive(:get).with(path: "INR").and_return(response)
+
+    expect(described_class.conversion_rate(from: "INR", to: "USD")).to eq(response["conversion_rates"]["USD"])
+    expect { described_class.conversion_rate(from: "INR", to: "US") }.to raise_error CurrencyCoinConverter::Error, "currency code is invalid: US"
   end
 
-  it "converte corretamente entre duas moedas" do
-    allow(CurrencyCoinConverter).to receive(:fetch_rates).with("USD").and_return({"EUR" => 0.85})
+  it '#convert returns the converted amount from one currency code to another' do
+    response = JSON.parse(File.read("spec/examples/inr.json"))
+    allow_any_instance_of(described_class).to receive(:get).with(path: "INR").and_return(response)
 
-    result = CurrencyCoinConverter.convert(100, from: "USD", to: "EUR")
-    expect(result).to eq(85.0)
+    expect(described_class.convert(130, from: "INR", to: "USD")).to eq(1.55)
+    expect(described_class.convert(130, from: "INR", to: "USD", round: 1)).to eq(1.5)
+    expect(described_class.convert(130, from: "INR", to: "USD", round: 5)).to eq(1.547)
   end
 end
 

data/spec/examples/inr.json

@@ -0,0 +1,174 @@
+{
+    "result":"success",
+    "documentation":"https://www.exchangerate-api.com/docs",
+    "terms_of_use":"https://www.exchangerate-api.com/terms",
+    "time_last_update_unix":1726012802,
+    "time_last_update_utc":"Wed, 11 Sep 2024 00:00:02 +0000",
+    "time_next_update_unix":1726099202,
+    "time_next_update_utc":"Thu, 12 Sep 2024 00:00:02 +0000",
+    "base_code":"INR",
+    "conversion_rates":{
+     "INR":1,
+     "AED":0.04372,
+     "AFN":0.8358,
+     "ALL":1.0753,
+     "AMD":4.6129,
+     "ANG":0.02131,
+     "AOA":11.2097,
+     "ARS":11.4069,
+     "AUD":0.01788,
+     "AWG":0.02131,
+     "AZN":0.02025,
+     "BAM":0.02112,
+     "BBD":0.02381,
+     "BDT":1.4227,
+     "BGN":0.02112,
+     "BHD":0.004476,
+     "BIF":34.6000,
+     "BMD":0.01190,
+     "BND":0.01554,
+     "BOB":0.08246,
+     "BRL":0.06652,
+     "BSD":0.01190,
+     "BTN":1.0000,
+     "BWP":0.1593,
+     "BYN":0.03848,
+     "BZD":0.02381,
+     "CAD":0.01618,
+     "CDF":33.9533,
+     "CHF":0.01009,
+     "CLP":11.2497,
+     "CNY":0.08477,
+     "COP":50.4925,
+     "CRC":6.2304,
+     "CUP":0.2857,
+     "CVE":1.1906,
+     "CZK":0.2705,
+     "DJF":2.1158,
+     "DKK":0.08057,
+     "DOP":0.7139,
+     "DZD":1.5804,
+     "EGP":0.5758,
+     "ERN":0.1786,
+     "ETB":1.3612,
+     "EUR":0.01080,
+     "FJD":0.02647,
+     "FKP":0.009105,
+     "FOK":0.08058,
+     "GBP":0.009104,
+     "GEL":0.03206,
+     "GGP":0.009105,
+     "GHS":0.1897,
+     "GIP":0.009105,
+     "GMD":0.8401,
+     "GNF":103.2731,
+     "GTQ":0.09217,
+     "GYD":2.4918,
+     "HKD":0.09284,
+     "HNL":0.2956,
+     "HRK":0.08135,
+     "HTG":1.5707,
+     "HUF":4.2876,
+     "IDR":184.0541,
+     "ILS":0.04481,
+     "IMP":0.009105,
+     "IQD":15.5923,
+     "IRR":505.6787,
+     "ISK":1.6439,
+     "JEP":0.009105,
+     "JMD":1.8688,
+     "JOD":0.008441,
+     "JPY":1.7008,
+     "KES":1.5373,
+     "KGS":1.0105,
+     "KHR":48.4400,
+     "KID":0.01789,
+     "KMF":5.3120,
+     "KRW":15.9849,
+     "KWD":0.003637,
+     "KYD":0.009921,
+     "KZT":5.6804,
+     "LAK":260.9012,
+     "LBP":1065.4911,
+     "LKR":3.5819,
+     "LRD":2.3242,
+     "LSL":0.2135,
+     "LYD":0.05674,
+     "MAD":0.1161,
+     "MDL":0.2071,
+     "MGA":54.2239,
+     "MKD":0.6600,
+     "MMK":33.8932,
+     "MNT":40.0564,
+     "MOP":0.09563,
+     "MRU":0.4733,
+     "MUR":0.5495,
+     "MVR":0.1839,
+     "MWK":20.7582,
+     "MXN":0.2382,
+     "MYR":0.05172,
+     "MZN":0.7610,
+     "NAD":0.2135,
+     "NGN":19.5736,
+     "NIO":0.4385,
+     "NOK":0.1289,
+     "NPR":1.6000,
+     "NZD":0.01935,
+     "OMR":0.004577,
+     "PAB":0.01190,
+     "PEN":0.04543,
+     "PGK":0.04649,
+     "PHP":0.6708,
+     "PKR":3.3198,
+     "PLN":0.04623,
+     "PYG":91.5037,
+     "QAR":0.04333,
+     "RON":0.05368,
+     "RSD":1.2635,
+     "RUB":1.0843,
+     "RWF":16.1947,
+     "SAR":0.04464,
+     "SBD":0.1004,
+     "SCR":0.1613,
+     "SDG":5.3270,
+     "SEK":0.1236,
+     "SGD":0.01554,
+     "SHP":0.009105,
+     "SLE":0.2680,
+     "SLL":268.0041,
+     "SOS":6.8034,
+     "SRD":0.3491,
+     "SSP":39.7604,
+     "STN":0.2645,
+     "SYP":153.2201,
+     "SZL":0.2135,
+     "THB":0.4017,
+     "TJS":0.1263,
+     "TMT":0.04168,
+     "TND":0.03639,
+     "TOP":0.02777,
+     "TRY":0.4056,
+     "TTD":0.08086,
+     "TVD":0.01789,
+     "TWD":0.3824,
+     "TZS":32.3728,
+     "UAH":0.4903,
+     "UGX":44.2520,
+     "USD":0.01190,
+     "UYU":0.4810,
+     "UZS":150.3032,
+     "VES":0.4370,
+     "VND":298.5911,
+     "VUV":1.4093,
+     "WST":0.03221,
+     "XAF":7.0827,
+     "XCD":0.03214,
+     "XDR":0.008858,
+     "XOF":7.0827,
+     "XPF":1.2885,
+     "YER":2.9822,
+     "ZAR":0.2135,
+     "ZMW":0.3146,
+     "ZWL":0.1660
+    }
+}

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: currency_coin_converter
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.2
 platform: ruby
 authors:
 - Fernanda de Jesus
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-10 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: httparty
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.18'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.18'
+date: 2024-09-17 00:00:00.000000000 Z
+dependencies: []
 description: This gem allows you to convert amounts between different currencies using
   the ExchangeRate API.
 email:
@@ -44,9 +30,8 @@ files:
 - bin/setup
 - currency_coin_converter.gemspec
 - lib/currency_coin_converter.rb
-- lib/currency_coin_converter/version.rb
-- sig/currency_coin_converter.rbs
 - spec/currency_coin_converter_spec.rb
+- spec/examples/inr.json
 homepage: https://github.com/bussularf/currency_coin_converter
 licenses:
 - MIT

data/lib/currency_coin_converter/version.rb

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

data/sig/currency_coin_converter.rbs

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