riksbank_currency 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9cb06cc185f232c081fab9056bf2332c9ded9fb
-  data.tar.gz: 36ae9d4767b38845cc27aa9e244892c64a47ceda
+  metadata.gz: ff68a1ec03900b93f309ef1314e2977686c84f76
+  data.tar.gz: 10a41e49061cd1d6b4e97ffd99c5522fedf98c8d
 SHA512:
-  metadata.gz: b4fb912717f93c4176b426793ac97c9e4595b6d595f9d2ead159ca9efa91ade61fcbca2a2d6f293df78b0daf723f5df5528f57f7374f44760cf037be15748a53
-  data.tar.gz: 46aba20322e6226a4802f8c0026b6cfc8495b316b29fdc7095d5a0edd1d84bb42f1a8e23da7b5d79c6e82520d46804ff9b75e88fbfa4f075de2753ef226e8c3d
+  metadata.gz: 4e5109179f68b0d75482f8caddca6c830a7a0fb4b2ff2418ccbee6d72bbb406483399861495cf246a90959adda205ec5e2fc2f0568394423806561aa42a20d3d
+  data.tar.gz: f68f82dadb2d0660d857a66deeaaff455b7a12942d8998c5b9940ecb94418f398ffe16c6ebfb92615e6eba446747ef95085de24caf3605579a49f8ad4270ad10

data/README.md

@@ -1,6 +1,6 @@
 # Riksbank Exchange Rates
 
-Simple wrapper for Riksbank API that returns currency exchange rates for the specific date.
+Simple wrapper for Riksbank API that returns currency exchange rates for specific date.
 
 
 ## Installation
@@ -29,15 +29,15 @@ Or install it yourself as:
 
 Initializer options:
 
-  * `date` - the day for which we want to get exchange rates. It should be `Date` object 
-  * `base` - base currency (by default `SEK`)
+  * `date` - specific date we want to get exchange rates for. It should be a valid `Date` object 
+  * `base` - base currency (`SEK` is used by default)
   * `rates` - you can pass your own hash with rates. Can be useful for caching purposes
 
 
 ### Retrieve a specific rate
 
 ```ruby
-  # how many euros in one american dollar?
+  # How many euros in one american dollar?
   bank.rate('USD', 'EUR').to_f # => 0.80607
   
   # by default it converts to SEK
@@ -56,42 +56,48 @@ Get all rates
   bank.rates # => { 'NOK' => 105.556298, 'INR' => 13.619511, … }
 ```
 
-### Bank days and holidays
+### Rates from holidays / weekends
 
-During the holidays or weekends bank doesn't change exchange rates. It means that
-bank doesn't have exchange rates for Saturday or Christmas.
+Exchange rates are not changed during holidays or weekends. 
+If you query bank API directly, you will get an empty hash in response.
 
-Also, another problem in the current day. Bank refreshes rates twice per day (morning and evening).
-So, therefore at 3 o'clock of morning bank doensn't have fresh rates and we should use
-rates from prevoius day.
-
-This gem deals with all of this problems:
+To avoid that, this gem provides last known rates:
 
 ```ruby
-  # 20.01.2018 is Saturday, bank doesn't work at this day
+  # 20.01.2018 is Saturday, bank is closed
   holiday_bank = RiksbankCurrency::Rates.new(date: Date.new(2018, 1, 20))
   
-  # rates will be got from Friday!
+  # Last known rates will be fetched instead (from Friday).
   holiday_bank.rate_date # Fri, 19 Jan 2018
-  
-  
-  
-  
-  # imagine that we do it at night
+````
+
+### Riksbank updates rates twice a day (in the morning and in the evening)
+
+If you try to fetch rates at 03.00 in the morning, then you will get an empty hash from the bank.
+Therefore gem will return rates from a previous date.
+
+```ruby
   # Time.current => Fri, 26 Jan 2018 03:00:00 UTC +00:00 
   morning_bank = RiksbankCurrency::Rates.new
   
-  # it is too early, bank doensn't work at this time
-  # let's use yesterday rates 
+  # It's too early, bank doensn't work at this time
+  # Yesterday's rates will be used instead 
   morning_bank.rate_date # Thu, 25 Jan 2018
 ```
 
-### Available currencies
+#### Default currencies
 
-Pay attention to check available currencies at [official bank page](http://www.riksbank.se/en/Interest-and-exchange-rates/Series-for-web-services/).
+```ruby
+%w(AUD BRL CAD CHF CNY CZK DKK EUR GBP HKD HUF IDR INR ISK JPY
+   KRW MAD MXN NOK NZD PLN RUB SAR SGD THB TRY USD ZAR)
+```
+
+### Additional currencies
 
-By default this gem uses only existing currencies for 2018. For example, FIM (Finland Marka)
-has rates only till 2002 and it doesn't exist anymore in 2018.
+Check bank page to get a fresh list of provided currencies [official bank page](http://www.riksbank.se/en/Interest-and-exchange-rates/Series-for-web-services/).
+
+By default this gem is only using existing currencies from 2018.
+For example, FIM (Finland Marka) has published rates until 2002. 
 
 So, if you wanna get information about FIM exchange rate in 2001 you should 
 change the gem defaults:
@@ -106,13 +112,6 @@ change the gem defaults:
   today_bank.rate('FIM') # nil
 ```
 
-#### Default currencies
-
-```ruby
-%w(AUD BRL CAD CHF CNY CZK DKK EUR GBP HKD HUF IDR INR ISK JPY
-   KRW MAD MXN NOK NZD PLN RUB SAR SGD THB TRY USD ZAR)
-```
-
 ## Legal
 
 The author of this gem is not affiliated with the Riksbank.

data/lib/riksbank_currency/fetcher/date_fetcher.rb

@@ -3,8 +3,8 @@ module RiksbankCurrency
   #
   # @see https://swea.riksbank.se/sweaWS/docs/api/call/getInterestAndExchangeRates.htm
   #
-  # IMPORTANT! The date should be less than current date. To get rates for today
-  # see at TodayFetcher
+  # IMPORTANT! The date should be less than current date.
+  # To get current rates - check TodayFetcher
   class DateFetcher
     def initialize(date)
       @date = date

data/lib/riksbank_currency/rates.rb

@@ -33,11 +33,11 @@ module RiksbankCurrency
       @rates ||= fetcher.to_hash
     end
 
-    # Sometimes date passed to the initializer differs from real exchange date.
-    # It causes from holidays, weekends and etc.
+    # Sometimes date passed to the initializer is different from last available exchange date.
+    # It could be because of holidays, weekends or bank closing hours.
     #
     # For example, if we want to get rates for the `1st of January 2018` then rate date
-    # will be `27th of December 2017`
+    # will be `27th of December 2017`, because `1st of January` is a holiday.
     # @return [Date]
     def rate_date
       @rate_date ||= fetcher.rate_date

data/lib/riksbank_currency/version.rb

@@ -1,3 +1,3 @@
 module RiksbankCurrency
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riksbank_currency
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Andrey Yakovlev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-26 00:00:00.000000000 Z
+date: 2018-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri