oxr 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92128e15490b54bf144c83a1d16f81f950f7178a88d6b4138b6fe7a3da31043a
-  data.tar.gz: 42a8dea111e46dff4030d8a626e0b5f7e6e0dd653e1df82bd4436f88fd3d4c06
+  metadata.gz: b503f70d7b69e03db759d6bd5b2a629f78da39944de835f75db03f1156b4ef73
+  data.tar.gz: f7179b689f98c5a0237ce6639879f4980795ec0b8bdfc49ca65af5c430b4a9d9
 SHA512:
-  metadata.gz: ae7a594268c345b4ec69cf93829a904b1ce2345cc432174292f684740b37d1add47b61c1e62df5728f42fe8eade1472dee810c42326513cf9611792e9f5e7093
-  data.tar.gz: 7c1eb6b5a21118673857b42dec90878de993d47206cb98672e7cc46c4538774e775c51fef1b9892eaf3152f21468f58c8f306a8bdff08aef94d0748567b9a008
+  metadata.gz: 8b080b6d4312340ab657e9e22acb0dd1338a30e966fe250f4a16c77161015cbbea0ed3515a819460d02c246d9a5c027bd2deaedf7053817c102b5b64504322f0
+  data.tar.gz: 4e3e712532f41e8b8c6b6674e8dde2ca20120e8997e5779a78b511002d5e50ad7218e6be21c73770285b2bc4b966adbe01db1e0bee16a55aae96cb37017a0a4d

data/.gitlab-ci.yml

@@ -3,21 +3,25 @@ before_script:
   - bundle install --jobs="$(nproc)" --retry=3
 
 build:rubocop:
+  stage: build
   image: "ruby:3.0"
   script:
     - bundle exec rubocop
 
 test:ruby-2.6:
+  stage: test
   image: "ruby:2.6"
   script:
     - bundle exec rake test
 
 test:ruby-2.7:
+  stage: test
   image: "ruby:2.7"
   script:
     - bundle exec rake test
 
 test:ruby-3.0:
+  stage: test
   image: "ruby:3.0"
   script:
     - bundle exec rake test

data/.rubocop.yml

@@ -6,6 +6,3 @@ AllCops:
   NewCops: enable
   SuggestExtensions: false
   TargetRubyVersion: 2.5
-Metrics/AbcSize:
-  Exclude:
-    - test/oxr_test.rb

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## OXR 0.6.1 (April 16, 2021) ##
+
+* Accept endpoints as Pathnames or URIs as well as Strings
+* Eliminated redundant URI processing for default endpoints
+
 ## OXR 0.6.0 (April 15, 2021) ##
 
 *   Now works on Ruby 3.0

data/README.md

@@ -122,8 +122,9 @@ plan allows a limited number of requests per month, you probably want to avoid
 this when running in a test environment. You can stub the responses of specific
 API calls by configuring the endpoint for specific calls to use a local file
 instead of an HTTP request. Just provide a JSON file that reflects the payload
-of an actual API call. (You will find usable JSON files in test/fixtures
-included with this gem.)
+of an actual API call. You may provide this as a Pathname or a URI object, but
+a plain old String will work as well. (You will find usable JSON files in
+test/fixtures included with this gem.)
 
 When you're done, you can call `OXR.reset_sources` to restore the default behavior.
 

data/lib/oxr.rb

@@ -164,9 +164,13 @@ module OXR
     private
 
     def call(endpoint)
-      uri = URI.parse endpoint
-      data = uri.scheme ? uri.read : File.read(uri.path)
-      JSON.parse data
+      # This method makes it possible for a user to provide an endpoint path as
+      # either a String, Pathname, or URI. We will massage it until we have
+      # something that responds to #read.
+      endpoint = URI.parse(endpoint.to_s) unless endpoint.respond_to?(:read)
+      endpoint = File.open(endpoint.path) unless endpoint.respond_to?(:read)
+
+      JSON.parse endpoint.read
     rescue OpenURI::HTTPError => e
       raise ApiError, e
     end

data/lib/oxr/configuration.rb

@@ -18,7 +18,11 @@ module OXR
   # you might want deterministic results and do not want to waste real API
   # requests.
   class Configuration
-    ENDPOINT = 'https://openexchangerates.org/api/'
+    ENDPOINT   = 'https://openexchangerates.org/api/'
+    LATEST     = URI.join(ENDPOINT, 'latest.json').freeze
+    HISTORICAL = URI.join(ENDPOINT, 'historical/').freeze
+    USAGE      = URI.join(ENDPOINT, 'usage.json').freeze
+    CURRENCIES = URI.join(ENDPOINT, 'currencies.json').freeze
 
     ##
     # Get and set the application ID that will be sent to the API server.
@@ -30,7 +34,10 @@ module OXR
 
     ##
     # Set respective API endpoints. Use these if you want to sidestep the API
-    # server, e.g., for testing.
+    # server, e.g., for testing. The endpoint may be provided as a URI,
+    # Pathname, or String.
+    #
+    # Setting an endpoint to +nil+ will restore the default value.
     attr_writer :currencies, :historical, :latest, :usage
 
     def initialize
@@ -40,9 +47,7 @@ module OXR
     ##
     # Returns the endpoint for listing known currencies.
     def currencies
-      @currencies || URI.join(ENDPOINT, 'currencies.json').tap do |uri|
-        uri.query = "app_id=#{app_id}"
-      end.to_s
+      @currencies || append_query(CURRENCIES)
     end
 
     ##
@@ -51,27 +56,19 @@ module OXR
     #
     # Expects +date+ to respond #strftime.
     def historical(date)
-      @historical || URI.join(ENDPOINT, "historical/#{date.strftime('%F')}.json").tap do |uri|
-        uri.query = "app_id=#{app_id}"
-        uri.query += "&base=#{base}" if base
-      end.to_s
+      @historical || append_query(URI.join(HISTORICAL, "#{date.strftime('%F')}.json"), base: base)
     end
 
     ##
     # Returns the endpoint for the latest currency exchange rates.
     def latest
-      @latest || URI.join(ENDPOINT, 'latest.json').tap do |uri|
-        uri.query = "app_id=#{app_id}"
-        uri.query += "&base=#{base}" if base
-      end.to_s
+      @latest || append_query(LATEST, base: base)
     end
 
     ##
     # Returns the endpoint for fetch current API usage statistics.
     def usage
-      @usage || URI.join(ENDPOINT, 'usage.json').tap do |uri|
-        uri.query = "app_id=#{app_id}"
-      end.to_s
+      @usage || append_query(USAGE)
     end
 
     ##
@@ -82,5 +79,14 @@ module OXR
       @latest     = nil
       @usage      = nil
     end
+
+    private
+
+    def append_query(uri, base: nil)
+      uri.dup.tap do |u|
+        u.query = "app_id=#{app_id}"
+        u.query += "&base=#{base}" if base
+      end.to_s
+    end
   end
 end

data/lib/oxr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OXR
-  VERSION = '0.6.0'
+  VERSION = '0.6.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oxr
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - John Parker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-15 00:00:00.000000000 Z
+date: 2021-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler