cnb 0.1.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8bebe99129e461c1bceb59a2a43f1754221488e
-  data.tar.gz: 31d620b7020a35a9a82d692d51d7daa085864565
+  metadata.gz: 9351e3fb55843dc18b709b659c1e4ba66a2ff569
+  data.tar.gz: 24e90dc3a78adec9b85fd123753c9f3f213d00b9
 SHA512:
-  metadata.gz: f7751cf538513923175f62e5321b306ea0d773dfdc9471be30e205e387c888e47212eb6e7196ec0e4ab53bda0359fc2a52928905a81b731da56b62d54e48e8b1
-  data.tar.gz: f2a93574bb6034564afd3af9b657f39c888f0143b28471ba35f98f3f9a12aca08893ae45c69b6828100a6f2ebdae81f6099372a8f2849f330a6d9f979bcbf6f9
+  metadata.gz: 5db0209ee7192c1ae21bc9f7dd812f492c194adac35cf7f02a5205b3fb23fb9e329e425e603e939087cf9a29a2b5767d724ec80219fe9106c78a171689f7cde8
+  data.tar.gz: a92319e72641dc7cd81c30bffc05c9ce7bc13a17bf9810e254b3a91b60fda6d76a9d84de54a11208458091e46a7b9e017a8fc312683ae1963a1ec1ed301d62e5

data/README.md

@@ -25,29 +25,42 @@ Or install the gem by on your own
 
 
 ### Daily currency rates
-To work with current currency rates start with the following code:
+To work with daily currency rates start with the following code:
 
     CNB.daily_rates
 
-Get currency rate of currency towards czech crown (CZK) with given currency code
+This will provide you object from which you can get the currency rates and other information. Everytime you use the code above, actual currency rates are retrived from Czech National Bank, so it is a good idea to assign the result to variable if you don't want to make more HTTP requests than neccessary.
 
-    CNB.rate('USD') # 19.927 (float value)
+Get currency rate of currency with given currency code towards czech crown (CZK)
+
+    CNB.daily_rates.rate('USD') # 19.927 (float value)
+    CNB.daily_rates.rate('EUR') # 27.34
+
+By using the code above you make 2 requests for currency rates.
+
+The following code does the same thing but it retrives the currency rates just once.
+
+    daily_rates = CNB.daily_rates
+    daily_rates.rate('USD')
+    daily_rates.rate('EUR')
 
 Get name of the currency in czech language.
 
-    CNB.name('USD') # dolar
+    CNB.daily_rates.name('USD') # dolar
 
 Get name of the country where the currency comes from in czech language.
 
-    CNB.country('USD') # USA
+    CNB.daily_rates.country('USD') # USA
 
-The currency code is not case sensitive.
+**The currency code parameter is not case sensitive.**
 
-Get date when the currency rates were published. Czech National Bank does not publish currency rates during the weekend, so may want to check when exactly were the values published.
+Get date when the currency rates were published. Czech National Bank does not publish currency rates during the weekend, so you may want to check when exactly were the values published.
 
     CNB.date
 
-Daily currency rates are used by default, so you can use the methods for getting rates, currency names and countries straight away.
+You can get all currencies as hash where currency codes are used as keys by the following code
+
+    CNB.daily_rates.currencies
 
 
 ### Monthly currency rates
@@ -59,12 +72,19 @@ To get the monthly currency rates use the following code:
     # Get currency rates for March 2013
     CNB.monthly_rates(3, 2013)
 
+You can only retrieve monthly currency rates that were published since 2004. If you try to get older currency rates, exception will be raised.
+
 After using the code above, you can use the same methods as for the daily currency rates.
 
-    CNB.rate('HNL')
-    CNB.name('HNL') # lempira
-    CNB.country('HNL') # Honduras
-    CNB.date
+    monthly_rates = CNB.monthly_rates(3, 2013)
+    monthly_rates.rate('HNL')
+    monthly_rates.name('HNL') # lempira
+    monthly_rates.country('HNL') # Honduras
+    monthly_rates.date
+
+Get all currencies as hash
+
+    CNB.monthly_rates(3, 2013).currencies
 
 
 ### Primary currency

data/lib/cnb/currency_rates.rb

@@ -29,6 +29,8 @@ module CNB
 
     def get_currencies
       xml_doc = Nokogiri::XML(open(@cur_rates_url))
+      raise 'Currency rates are not available at the moment' if xml_doc.text.empty?
+
       @date = Date.parse(xml_doc.css('kurzy').attr('datum').value)
 
       xml_doc.css('radek').each do |currency|

data/lib/cnb/version.rb

@@ -1,3 +1,3 @@
 module CNB
-  VERSION = '0.1.4'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cnb
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Jan Zikán