simple_forex 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7f8fe0b066cf31095f691d59a2de93f598c8dfb451d50c7cd8f5db32db5220d
-  data.tar.gz: 4ded0bbeac22ede49e1710c3ebb7d68e85837aad215c596a9f743b285006e6b8
+  metadata.gz: 219ceb3f562efe60fe2ef6acfe7ccc508dfb873d2d6e77b69628406e32add8d2
+  data.tar.gz: 1d6657f7b100388d7b30595be3691e78185c19cb6889f5f5f7bf9a9683fd0836
 SHA512:
-  metadata.gz: 14fca18d0274872d468a095784e38e2d8f95371dcaa7477f8946614b2be051abb26f00a5064915a509d932fd24eee796d37a438fc440bf5eab5197c61de07706
-  data.tar.gz: 48f47f757fedbda7419d0eda29ce63cdcd853069742e6f18cb8d9a816c129f2be3b1d5701f65032935055c4207e06db6081ef6da3a0118947a01be543e10e700
+  metadata.gz: c0c71fc05cd97fff4860a5b59324e6436e06204435f4612e545d6875731995c8db4737b6a1fd86ba41c65a60fd91bd9b25402ab5f212815f33aabd598a74db6e
+  data.tar.gz: 5b6219904cd741b08cbf7fdad58886bfc30d85ebaa7bb7ce38e305bc73b26a213485a95e7ff4cc94baa71293153b458e64edfa17317dfe3225b193f4ca7de469

data/README.md

@@ -1,64 +1,87 @@
 # SimpleForex
 
-The goal of the simple_forex gem is to help you quickly:
+This ruby gem lets you fetch exchange rates for ~170 currencies (a total of ~14,000 imputed currency pairs) for free, on an hourly frequently (sufficient for most, but not all, use cases), and takes only about 5 minutes to set up. 
+
+The usage instructions below show how to create a currencies table, run a rake task to update the exchange rates, and use `convert()` to convert between currencies inside your application. Total time to implementation should be ~5 minutes. 
 
-- Add a currencies table to your rails app
-- Schedule the retrieval of up to date foreign exchange data (hourly from a free API)
-- Convert between currencies
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+Install the gem in one of the usual ways:
 
 ```bash
 bundle add simple_forex
-```
-
-If bundler is not being used to manage dependencies, install the gem by executing:
 
-```bash
 gem install simple_forex
 ```
 
 ## Usage
 
+### Create a currencies table 
 
-
-### Add a currencies table to your rails app
-
-After installing the gem, run this to add a currencies table to your rails app 
+Use the included generator will make a currencies table migration: 
 
 ```bash
 rails generate simple_forex
 ```
 
-followed by 
+Then run the migration: 
 
 ```
 rake db:migrate
 ```
 
-### Run a rake task to update currencies 
+### Fetch exchange rates 
 
-
-Get a [free API key](https://openexchangerates.org/signup/free), open credentials.yml (`EDITOR="vim" rails credentials:edit`) and add the API key to credentials.yml like so:
+Create a [free API key](https://openexchangerates.org/signup/free), open credentials.yml (`EDITOR="vim" rails credentials:edit`) and add the API key to credentials.yml like so:
 
 ```
 # config/credentials.yml.enc
+
 simple_forex:
   openexchangerates_key: 1234abcd
 ```
 
-Then, run this to retrieve currencies in the currencies table:
+Run this rate task to retrieve currencies and store them in the currencies table:
 
 ```bash
 rake simple_forex:fetch_rates
 ```
 
-View the exchange rate data in the rails console with `Currency.last`.
+View the exchange rate data in the rails console with `Currency.last`:
 
+```
+=> #<SimpleForex::Currency:0x000000013c4bae78
+ id: 1,
+ blob:
+  {"base"=>"USD",
+   "rates"=>
+    {"AED"=>"3.67286",
+     "AFN"=>"89.49999",
+     "ALL"=>"108.164235",
+     "AMD"=>"388.147964",
+     "ANG"=>"1.798456",
+     "AOA"=>"503.891",
+     "ARS"=>"198.1831",
+     "AUD"=>"1.485125",
+
+     ...
+     
+     "XOF"=>"617.115134",
+     "XPD"=>"0.00069861",
+     "XPF"=>"112.265627",
+     "XPT"=>"0.00103175",
+     "YER"=>"250.300106",
+     "ZAR"=>"18.23512",
+     "ZMW"=>"19.934751",
+     "ZWL"=>"322.0"},
+   "license"=>"https://openexchangerates.org/license",
+   "timestamp"=>1678096800,
+   "disclaimer"=>"Usage subject to terms: https://openexchangerates.org/terms"},
+ created_at: Mon, 06 Mar 2023 10:43:54 UTC +00:00,
+ updated_at: Mon, 06 Mar 2023 10:43:54 UTC +00:00>
+```
 
-### Schedule task to update currencies
 
 **Optional**
 
@@ -76,7 +99,7 @@ require 'simple_forex'
 convert(amount, from_currency, to_currency)
 ```
 
-For example 
+Example 
 
 ```ruby
 require 'simple_forex'
@@ -84,18 +107,16 @@ convert(100, 'USD', 'EUR')
 # => 0.939717e2
 ```
 
-Note the decimal value returned uses scientific notation, evidenced by the `e` in the decimal's representation.
-
+Note ruby decimals use scientific notation, evidenced by the `e` toward the end of the value.
 
-## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## Requirements
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+This gem *probably* only works on Rails 6 and Rails 7 apps, and only those using a postgres database.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/stevecondylios/simple_forex.
+Bug reports and pull requests are very welcome at https://github.com/stevecondylios/simple_forex.
 
 ## License
 

data/lib/doc/CreateCurrencies.html

@@ -0,0 +1,137 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class CreateCurrencies - RDoc Documentation</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+  var index_rel_prefix = "./";
+</script>
+
+<script src="./js/navigation.js" defer></script>
+<script src="./js/search.js" defer></script>
+<script src="./js/search_index.js" defer></script>
+<script src="./js/searcher.js" defer></script>
+<script src="./js/darkfish.js" defer></script>
+
+<link href="./css/fonts.css" rel="stylesheet">
+<link href="./css/rdoc.css" rel="stylesheet">
+
+
+<body id="top" role="document" class="class">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="./index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="./table_of_contents.html#pages">Pages</a>
+    <a href="./table_of_contents.html#classes">Classes</a>
+    <a href="./table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search" spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+
+  </div>
+
+  
+
+  <div id="class-metadata">
+    
+    
+<div id="parent-class-section" class="nav-section">
+  <h3>Parent</h3>
+
+  <p class="link">MIGRATION_CLASS
+</div>
+
+    
+    
+    
+<!-- Method Quickref -->
+<div id="method-list-section" class="nav-section">
+  <h3>Methods</h3>
+
+  <ul class="link-list" role="directory">
+    <li ><a href="#method-i-change">#change</a>
+  </ul>
+</div>
+
+  </div>
+</nav>
+
+<main role="main" aria-labelledby="class-CreateCurrencies">
+  <h1 id="class-CreateCurrencies" class="class">
+    class CreateCurrencies
+  </h1>
+
+  <section class="description">
+    
+  </section>
+
+  <section id="5Buntitled-5D" class="documentation-section">
+
+
+
+
+
+     <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
+       <header>
+         <h3>Public Instance Methods</h3>
+       </header>
+
+      <div id="method-i-change" class="method-detail ">
+        <div class="method-heading">
+          <span class="method-name">change</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+
+        <div class="method-description">
+          
+
+          <div class="method-source-code" id="change-source">
+            <pre><span class="ruby-comment"># File simple_forex/migration.rb, line 9</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">change</span>
+  <span class="ruby-identifier">create_table</span> <span class="ruby-value">:currencies</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">t</span><span class="ruby-operator">|</span>
+    <span class="ruby-identifier">t</span>.<span class="ruby-identifier">jsonb</span> <span class="ruby-value">:blob</span>
+    <span class="ruby-identifier">t</span>.<span class="ruby-identifier">timestamps</span>
+  <span class="ruby-keyword">end</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+
+
+      </div>
+
+    </section>
+
+  </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="https://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.3.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+

data/lib/doc/Object.html

@@ -0,0 +1,114 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class Object - RDoc Documentation</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+  var index_rel_prefix = "./";
+</script>
+
+<script src="./js/navigation.js" defer></script>
+<script src="./js/search.js" defer></script>
+<script src="./js/search_index.js" defer></script>
+<script src="./js/searcher.js" defer></script>
+<script src="./js/darkfish.js" defer></script>
+
+<link href="./css/fonts.css" rel="stylesheet">
+<link href="./css/rdoc.css" rel="stylesheet">
+
+
+<body id="top" role="document" class="class">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="./index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="./table_of_contents.html#pages">Pages</a>
+    <a href="./table_of_contents.html#classes">Classes</a>
+    <a href="./table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search" spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+
+  </div>
+
+  
+
+  <div id="class-metadata">
+    
+    
+<div id="parent-class-section" class="nav-section">
+  <h3>Parent</h3>
+
+  <p class="link">BasicObject
+</div>
+
+    
+<div id="includes-section" class="nav-section">
+  <h3>Included Modules</h3>
+
+  <ul class="link-list">
+    <li><a class="include" href="SimpleForex.html">SimpleForex</a>
+  </ul>
+</div>
+
+    
+    
+  </div>
+</nav>
+
+<main role="main" aria-labelledby="class-Object">
+  <h1 id="class-Object" class="class">
+    class Object
+  </h1>
+
+  <section class="description">
+    
+  </section>
+
+  <section id="5Buntitled-5D" class="documentation-section">
+
+
+    <section class="constants-list">
+      <header>
+        <h3>Constants</h3>
+      </header>
+      <dl>
+        <dt id="MIGRATION_CLASS">MIGRATION_CLASS
+        <dd>
+      </dl>
+    </section>
+
+
+
+  </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="https://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.3.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+

data/lib/doc/SimpleForex/Currency.html

@@ -0,0 +1,99 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class SimpleForex::Currency - RDoc Documentation</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "../";
+  var index_rel_prefix = "../";
+</script>
+
+<script src="../js/navigation.js" defer></script>
+<script src="../js/search.js" defer></script>
+<script src="../js/search_index.js" defer></script>
+<script src="../js/searcher.js" defer></script>
+<script src="../js/darkfish.js" defer></script>
+
+<link href="../css/fonts.css" rel="stylesheet">
+<link href="../css/rdoc.css" rel="stylesheet">
+
+
+<body id="top" role="document" class="class">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="../index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="../table_of_contents.html#pages">Pages</a>
+    <a href="../table_of_contents.html#classes">Classes</a>
+    <a href="../table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search" spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+
+  </div>
+
+  
+
+  <div id="class-metadata">
+    
+    
+<div id="parent-class-section" class="nav-section">
+  <h3>Parent</h3>
+
+  <p class="link">ActiveRecord::Base
+</div>
+
+    
+    
+    
+  </div>
+</nav>
+
+<main role="main" aria-labelledby="class-SimpleForex::Currency">
+  <h1 id="class-SimpleForex::Currency" class="class">
+    class SimpleForex::Currency
+  </h1>
+
+  <section class="description">
+    
+<p>From: <a href="https://stackoverflow.com/a/31701809/5783745">stackoverflow.com/a/31701809/5783745</a> Otherwise after the migration you get Currency.count # uninitialized constant <a href="Currency.html"><code>Currency</code></a> (NameError)</p>
+
+  </section>
+
+  <section id="5Buntitled-5D" class="documentation-section">
+
+
+
+
+
+  </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="https://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.3.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+

data/lib/doc/SimpleForex/Error.html

@@ -0,0 +1,97 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class SimpleForex::Error - RDoc Documentation</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "../";
+  var index_rel_prefix = "../";
+</script>
+
+<script src="../js/navigation.js" defer></script>
+<script src="../js/search.js" defer></script>
+<script src="../js/search_index.js" defer></script>
+<script src="../js/searcher.js" defer></script>
+<script src="../js/darkfish.js" defer></script>
+
+<link href="../css/fonts.css" rel="stylesheet">
+<link href="../css/rdoc.css" rel="stylesheet">
+
+
+<body id="top" role="document" class="class">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="../index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="../table_of_contents.html#pages">Pages</a>
+    <a href="../table_of_contents.html#classes">Classes</a>
+    <a href="../table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search" spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+
+  </div>
+
+  
+
+  <div id="class-metadata">
+    
+    
+<div id="parent-class-section" class="nav-section">
+  <h3>Parent</h3>
+
+  <p class="link">StandardError
+</div>
+
+    
+    
+    
+  </div>
+</nav>
+
+<main role="main" aria-labelledby="class-SimpleForex::Error">
+  <h1 id="class-SimpleForex::Error" class="class">
+    class SimpleForex::Error
+  </h1>
+
+  <section class="description">
+    
+  </section>
+
+  <section id="5Buntitled-5D" class="documentation-section">
+
+
+
+
+
+  </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="https://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.3.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+