fxpotato 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb8890704ee0761a1495035f28e01fc790923a3c
-  data.tar.gz: 835441cd4b04471b01771d689974ee4c9e9099b0
+  metadata.gz: a2f6de8473ac29270e901906c6df69a443e6ea3f
+  data.tar.gz: 814ef8a5b3cf444cc9bcce0cb1e2c373cc489793
 SHA512:
-  metadata.gz: 69b6b6810b59d4daa04449092adf9cc83321418b65c26be46fccf0be5451e9f4d0add043b05b1900f80cd8d6e0eaf45b9ab40405686a861f0d53ade133b6324e
-  data.tar.gz: b17104b54ed1f792ba0ec3f5727c5cd2ece166b10fbc2d43fbca9770c04bc15e9458c5b69fe3592f784f4794c871cd7175e84da696d9a9942b598e8570898f79
+  metadata.gz: 476cab120e1797f427cf038ec896f7cec219d75b3d0928067d42b702646185b95f16bf283aec0b79e18ce57c4331fa6e8a7ecb5d6dab486e59553966240d5dd8
+  data.tar.gz: 5977afe0f51dfd77fd9803abe0e9515b0488f9cbb538b5dff478209e2f45c623a18ca60ff1e055970bbab8bf426bc9eaf2481e612f3b409a015de349cdf30bd8

data/README.md

@@ -21,7 +21,8 @@ Or install it yourself as:
     $ gem install fxpotato
 
 ### Configuration
-FxPotato takes rates from the [ECB website](http://www.ecb.europa.eu/stats/eurofxref/eurofxref-hist-90d.xml).
+FxPotato takes rates from the [ECB website](http://www.ecb.europa.eu/stats/eurofxref/eurofxref-hist-90d.xml). It then saves this data into a `rates.xml` file under the `data` directory in the root of your project. To configure either of those destinations, set the corresponding environment variables:
+`FXPOTATO_DATA_DIR` and `DATA_FILE`.
 
 To change the feed, set the `FXPOTATO_DATA_SOURCE_URL` environment variable to the new URL, and if the structure of the xml is different (or indeed not XML at all, which is also totes cool), set `FxPotato.repo` to equal an instance of a custom class of your own writing for locating rates in the new structure. Make sure to set `FxPotato.repo = YourClass.new` before you use the other functionality in `FxPotato`.
 
@@ -36,6 +37,43 @@ end
 If using the crontab functionality, configure your own schedule by editing the `config/schedule.rb` file, as per the [whenever documentation](https://github.com/javan/whenever#example-schedulerb-file).
 
 ## Usage
+### Crontab
+FxPotato comes with optional crontab functionality to keep itself up to date. To enable the cron job, run the rake task `rake fxpotato:update_crontab`. Then verify the job is in your crontab by running `crontab -l`.
+
+If you decide this was a big mistake and wish to purify your crontab of fxpotato, then run the rake task `rake fxpotato:clear_crontab`, and verify again.
+
+The details of the cron job is configurable, as mentioned before, by editing the `config/schedule.rb` file as per the [whenever documentation](https://github.com/javan/whenever#example-schedulerb-file).
+
+### In your ruby app
+Assuming you successfully followed the install instructions, and are still reading this exciting documentation with much reckless abandon, steady yourself!
+
+Now. Using the FxPotato gem in your app is as simple as:
+
+```
+FxPotato.at('GBP', 'USD', date)
+```
+
+The date parameter is a `Date` object, which will default to today if nil, and the currency keys are simply strings. The gem is case insensitive, so don't worry about that.
+
+This will return a hash that looks like this:
+
+```
+{
+  "date" => #<Date: 2017-06-06 ((2457911j,0s,0n),+0s,2299161j)>, // <-- a Date object
+  "base" => {
+    "key" => "GBP",
+    "rate" => 0.87268
+  },
+  "target" => {
+    "key" => "USD",
+    "rate" => 1.1217
+  },
+  "rate" => 1.2853508731722967
+}
+```
+
+If for any reason the call was unsuccessful, the root `rate` will be nil, and the unlocatable rate(s) will also be nil.
+
 ### CLI
 Get foreign exchange rates on the command line with the following command:
 

data/lib/fxpotato/cli.rb

@@ -10,7 +10,7 @@ module FxPotato
     def getrate(base, target)
       date = options[:date] || Date.today
       begin
-        fxrate = FxPotato.at(date, base, target)
+        fxrate = FxPotato.at(base, target, date)
         puts CLIFormatter.result(fxrate)
       rescue RuntimeError => message
         puts message

data/lib/fxpotato/version.rb

@@ -1,3 +1,3 @@
 module FxPotato
-  VERSION = '1.1.1'
+  VERSION = '2.0.0'
 end

data/lib/fxpotato.rb

@@ -9,7 +9,7 @@ require "fxpotato/railtie" if defined?(Rails)
 require 'date'
 
 module FxPotato
-  def self.at(date, base_key, target_key)
+  def self.at(base_key, target_key, date = nil)
     base_key = upcase_if_not_nil(base_key)
     target_key = upcase_if_not_nil(target_key)
     date ||= Date.today

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fxpotato
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Liam Stupid Name Humphreys