fx_fetcher 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb55735ff3c285ce9dd9a00b4ea34d92c5af8186
-  data.tar.gz: 8e3a18734448b9b1fe50cc88e694d8d510fd896e
+  metadata.gz: 417daac6594c715d6fac95bec4a56a010f7833ed
+  data.tar.gz: d128adb36727241d3ca53940abd9a50ce827528b
 SHA512:
-  metadata.gz: f32068257a70c84e8d5d1e1c548d285d48ca82212f2299e9589652d7ad632150363bc05f50e069926e72dd63ae285133472a315054c3afa703c2637bf50e2525
-  data.tar.gz: 3fe911da29357435a7324515e81c00cd3eea5ebbcdf80cb3fa36f602384caa6cdb6646a70fa27be9e3ed5d7c53dfe3f877f97825db7e1a745d36c0f90c3aa552
+  metadata.gz: 96e63e5fb42b21e71efb523a8ea8219d07298c8ba56349e6c14f96a5a5942eeb489ce7eb1fa1796b7c5c819dcc736784e247c9c06c9e5c47be331129fb7d5416
+  data.tar.gz: 986d4fe69f8fbf03a6af1e6ec10908f043ca5e0dfadf971afc44ef9939ceca1845396a38f14f52d0270b9c3924176e8ace674ded99a9ad548f05791858f97a84

data/README.md

@@ -1,6 +1,6 @@
 # FxFetcher
 
-TODO: Write a gem description
+FxFetcher is a gem that calculates the fx rate for a currency pair eg. EUR/USD. There is a basic demo at http://knox-fx.herokuapp.com/ to show how you could use it.
 
 ## Installation
 
@@ -20,7 +20,22 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+FxFetcher is currently quite basic and requires a model to be set up like so:
+
+    t.date :rate_date
+    t.string :base_currency
+    t.string :counter_currency
+    t.decimal :rate
+
+In your model type ```include FxFetcher``` and the following commands are available:
+
+```ModelName.at(Date.today,'GBP','USD')``` to calculate the fx rate
+
+```ModelName.currencies``` to get a list of possible currencies
+
+```ModelName.valid_amount?(amount)``` to check if amount is non text and greater than zero
+
+I plan to turn this into a Rails engine that will automate the setup of a database by just requiring the command ```rake db:migrate`
 
 ## Contributing
 

data/lib/fx_fetcher/version.rb

@@ -1,3 +1,3 @@
 module FxFetcher
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/fx_fetcher.rb

@@ -7,14 +7,14 @@ module FxFetcher
 
   module ClassMethods
     def at(date, base, counter)
-      if currency_present_for_date(date)
+      if currencies_present_for_date(date)
         search_for_rate(date, base, counter)
       else
         "No rates available for this date"
       end
     end
 
-    # helper to create list of available currencies
+    # helper to create list of available currencies to use in form
     def currencies
       currencies = []
       rates_for_date = self.where(rate_date: self.first.rate_date)
@@ -29,13 +29,14 @@ module FxFetcher
 
     private
 
-    def currency_present_for_date(date)
+    def currencies_present_for_date(date)
       self.where(rate_date: date).present?
     end
 
     def search_for_rate(date, base, counter)
       rates_for_date = self.where(rate_date: date)
       exchange_rate = rates_for_date.each do |rate|
+        return 1 if base == counter
         return rate.rate if rate.base_currency == base && rate.counter_currency == counter
         return (1/rate.rate).round(4) if rate.base_currency == counter && rate.counter_currency == base
       end

data/spec/fx_fetcher_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe FxFetcher do
+  it 'does stuff' do
+    pending # no code yet
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+# our gem
+require 'fx_fetcher'
+
+RSpec.configure do |config|
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fx_fetcher
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jeff Knox
@@ -64,9 +64,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- fx_fetcher-0.0.2.gem
 - fx_fetcher.gemspec
 - lib/fx_fetcher.rb
 - lib/fx_fetcher/version.rb
+- spec/fx_fetcher_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -91,4 +94,6 @@ rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: A tool to fetch fx data from a database
-test_files: []
+test_files:
+- spec/fx_fetcher_spec.rb
+- spec/spec_helper.rb