oxr 0.1.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 644b32c3a84f34023d8e1809d3040c7d197e7b7c
-  data.tar.gz: 2863c2d71e004965e2950b507279dc26e8cecef0
+  metadata.gz: 61911998061bee0501d6db3d1fe3f3f00dcc7c9b
+  data.tar.gz: 4afda8ff15cf6b26a1728d3ae1b50d2b270305cb
 SHA512:
-  metadata.gz: 3245f994b6181e2bac92d5a652197661d9d72e654f32ee486e47c01e2f08cd738ad2bed058d4c5ae96dddb48f13ce6be9410966508aa88703e45c5e13fd5efee
-  data.tar.gz: 862bbba898c8f93e2ed56951e0ed9a327c6b74758295bd4c2f504f572d62161b2836facb37cc903624f7191fc8d24b71db547d965e65f24f115624e47b6953d6
+  metadata.gz: 8798474d8dbb3e53954857a2c7c56515a92eacc0674b5cdad083591927fb2794728f470a91bbb6ebe40db872b16499880d0b72e80d19c54cf41bdf8943ca76ff
+  data.tar.gz: 5108175cb8ac1ee4d79b4ecbd7b2c207c7f616b57ced79e7bcb60a85d1181e1e402cb7085b3243c00b40c974b409270b5d443240ba93c88536c6a11b9305fe64

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
 rvm:
+  - 2.1.8
+  - 2.2.4
   - 2.3.0
 before_install: gem install bundler -v 1.11.2

data/README.md

@@ -1,3 +1,5 @@
+# [![Gem Version](https://badge.fury.io/rb/oxr.svg)](https://badge.fury.io/rb/oxr) [![Build Status](https://travis-ci.org/jparker/oxr.svg?branch=master)](https://travis-ci.org/jparker/oxr)
+
 # OXR
 
 This gem provides a basic interface to the [Open Exchange Rates](https://openexchangerates.org) API.
@@ -28,7 +30,7 @@ Instantiate a new OXR object, passing your App ID as an argument.
 oxr = OXR.new 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
 ```
 
-The Open Exchange Rates API returns results as JSON objects. OXR parses these (using the [json](https://rubygems.org/gems/json)) and returns the resulting Hashes. To see the exact structure of the responses for different queries, check the [Open Exchange Rates documentation](https://docs.openexchangerates.org/) or examine the sample responses in `test/fixtures`.
+The Open Exchange Rates API returns results as JSON objects. OXR parses these (using the [json](https://rubygems.org/gems/json) gem) and returns the resulting Hashes. To see the exact structure of the responses for different queries, check the [Open Exchange Rates documentation](https://docs.openexchangerates.org/) or examine the sample responses in `test/fixtures`.
 
 Get the latest conversion rates with `OXR#latest`.
 
@@ -36,12 +38,38 @@ Get the latest conversion rates with `OXR#latest`.
 oxr.latest
 ```
 
+This will return a JSON object with a structure similar to the following:
+
+```json
+{
+  "disclaimer": "...",
+  "license": "...",
+  "timestamp": 1234567890,
+  "base": "USD",
+  "rates": {
+    "AED": 3.672995,
+    "AFN": 68.360001,
+    "ALL": 123.0332,
+    /* ... */
+  }
+}
+```
+
+`OXR#[]` is a shortcut for looking up the conversion rate for a single currency without digging through the JSON object returned by `OXR#latest` yourself.
+
+```ruby
+oxr['GBP'] # => 0.642607
+oxr['JPY'] # => 123.3267
+```
+
 Get historical conversion rates for specific dates with `OXR#historical`. This method requires you to provide a Date object for the date you wish to query.
 
 ```ruby
 oxr.historical on: Date.new(2016, 3, 24)
 ```
 
+This will return a JSON object with a structure similar to that returned by `OXR#latest`.
+
 Get a list of currently supported currencies with `OXR#currencies`.
 
 ```ruby
@@ -54,6 +82,29 @@ Get information about your account (including your usage for the current period)
 oxr.usage
 ```
 
+## Testing
+
+Normally, any API call will result in a live request to Open Exchange Rates. This probably isn't what you want when you're running tests. You can optionally stub the responses of specific API calls by adding an entry to `OXR.sources`. If you want to stop using custom sources, you can restore normal behavior by calling `OXR.reset_sources`. For example:
+
+```ruby
+class SomeTest < Minitest::Test
+  def setup
+    OXR.sources[:latest] = 'test/fixtures/sample_data.json'
+  end
+
+  def teardown
+    OXR.reset_sources
+  end
+
+  def test_something
+    oxr = OXR.new('XXX')
+    assert_equal 42, oxr.latest['rates']['GBP']
+  end
+end
+```
+
+In this example `test/fixtures/sample_data.json` should contain JSON data matching the structure of an actual Open Exchange Rates response. If you want to stop using custom sources, you can restore normal behavior by calling `OXR.reset_sources`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/oxr.rb

@@ -7,38 +7,75 @@ require 'open-uri'
 class OXR
   BASE_PATH = 'https://openexchangerates.org/api/'.freeze
 
+  class OXRError < StandardError
+    def initialize(message, response)
+      super message
+      @response = response
+    end
+
+    attr_reader :response
+  end
+
   def initialize(app_id)
     @app_id = app_id
   end
 
   attr_reader :app_id
 
-  def latest(only: nil)
-    endpoint        = URI.join BASE_PATH, 'latest.json'
-    endpoint.query  = "app_id=#{app_id}"
-    # Only allowed for paid plans
-    endpoint.query += "&symbols=#{Array(only).join ','}" if only
-    JSON.load open endpoint
+  def [](code)
+    latest['rates'][code]
   end
 
-  def historical(on:, only: nil)
-    date = on.strftime '%Y-%m-%d'
-    endpoint = URI.join BASE_PATH, 'historical/', "#{date}.json"
-    endpoint.query = "app_id=#{app_id}"
-    # Only allowed for paid plans
-    endpoint.query += "&symbols=#{Array(only).join ','}" if only
-    JSON.load open endpoint
+  def latest
+    endpoint = sources[:latest] || build_uri_endpoint('latest.json')
+    call endpoint
+  end
+
+  def historical(on:)
+    endpoint = sources[:historical] || \
+      build_uri_endpoint('historical/', "#{on.strftime '%Y-%m-%d'}.json")
+    call endpoint
   end
 
   def currencies
-    endpoint = URI.join BASE_PATH, 'currencies.json'
-    endpoint.query = "app_id=#{app_id}"
-    JSON.load open endpoint
+    endpoint = sources[:currencies] || build_uri_endpoint('currencies.json')
+    call endpoint
   end
 
   def usage
-    endpoint = URI.join BASE_PATH, 'usage.json'
-    endpoint.query = "app_id=#{app_id}"
+    endpoint= sources[:usage] || build_uri_endpoint('usage.json')
+    call endpoint
+  end
+
+  private
+
+  def build_uri_endpoint(*path, **params)
+    URI.join(BASE_PATH, *path).tap do |uri|
+      uri.query = "app_id=#{app_id}"
+    end
+  end
+
+  def call(endpoint)
     JSON.load open endpoint
+  rescue OpenURI::HTTPError => e
+    case e.message
+    when /\A4[[:digit:]]{2}/
+      response = JSON.load e.io
+      raise OXRError.new response['description'], response
+    else
+      raise
+    end
+  end
+
+  def sources
+    self.class.sources
+  end
+
+  def self.sources
+    @sources ||= {}
+  end
+
+  def self.reset_sources
+    sources.clear
   end
 end

data/lib/oxr/version.rb

@@ -1,3 +1,3 @@
 class OXR
-  VERSION = "0.1.0.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oxr
 version: !ruby/object:Gem::Version
-  version: 0.1.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - John Parker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-25 00:00:00.000000000 Z
+date: 2016-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler