ecb_exchange 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2691157f887f862fb2bcedf326175bb3778d45cbefc7d669d5b6b400e4d77470
-  data.tar.gz: 651a99a0fde7e578018e7798c71b67d82b47e0bb6b76ee860c732e625f015883
+  metadata.gz: '0569c1270113499c32743bce9b846a4928a52389f678757789421b3f656609ba'
+  data.tar.gz: 283f20e271bbc1bfa5c39560b30d0f1d39b052775b556e9f7373a850b3307a60
 SHA512:
-  metadata.gz: 3ed216084ec2aeddc7d67b2f20c6b45e39afaf74d20aa70e0656f7c939a491a298cbde0c63efad4605d5cb2f106665eeae9bc4b6f0d64ee72fd5f33c522a2612
-  data.tar.gz: 698103784849f9d3a829352b0f60ac3f59fe757d58769a3eaf3175c039d2c05cc808c097b693bb82f3ae9cb82ef8f2a68dc2582d6cc63a3eab24adf64591e607
+  metadata.gz: 6921600dfcd10a823ca657979fa6462d4b33ef0cbbcfdac6211743554c0dc15ac06a21755f1a3e7c57cda86bac4fa90149ca72b32e4fbd9bcbefebc32392de34
+  data.tar.gz: 2d18faa58686485957e0a17e2a1bba8e6f124a518707f6f150258ec1f9e52208114bcc871ca090f0d8a8983ac476b0479ba9ef20e0d260b25fb5ef9510dd060d

data/.travis.yml

@@ -2,16 +2,11 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
- - 2.1.10
- - 2.2.9
- - 2.3.6
- - 2.4.3
- - 2.5.1
- - ruby-head
-
-before_install:
- - gem update --system
- - gem install bundler
+  - 2.3.8
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
+  - ruby-head
 
 matrix:
   allow_failures:

data/CHANGELOG.md

@@ -7,6 +7,14 @@ adheres to [Semantic Versioning](Semver).
 
 ## [Unreleased]
 
+- Your contribution here!
+
+## [0.2.0] - 2019-04-22
+### Changed
+- Require at least Ruby 2.3 - earlier versions no longer supported.
+### Added
+- `# frozen_string_literal: true` to all Ruby files.
+
 ## [0.1.2] - 2018-05-05
 ### Changed
 - Updated gemspec meta data links.
@@ -19,7 +27,8 @@ adheres to [Semantic Versioning](Semver).
 ### Added
 - Initial version released.
 
-[Unreleased]: https://github.com/matthutchinson/ecb_exchange/compare/v0.1.2...HEAD
+[Unreleased]: https://github.com/matthutchinson/ecb_exchange/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/matthutchinson/ecb_exchange/compare/v0.1.2...v0.2.0
 [0.1.2]: https://github.com/matthutchinson/ecb_exchange/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/matthutchinson/ecb_exchange/compare/v0.1.0...v0.1.1
 [0.1.0]: https://github.com/matthutchinson/ecb_exchange/compare/e7366b3...v0.1.0

data/CODE_OF_CONDUCT.md

@@ -1,24 +1,41 @@
-# Contributor Code of Conduct
+# Contributor Covenant Code of Conduct
 
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating
-documentation, submitting pull requests or patches, and other activities.
+## Our Pledge
 
-We are committed to making participation in this project a harassment-free
-experience for everyone, regardless of level of experience, gender, gender
-identity and expression, sexual orientation, disability, personal appearance,
-body size, race, ethnicity, age, religion, or nationality.
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or unprofessional conduct
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
 
 Project maintainers have the right and responsibility to remove, edit, or
 reject comments, commits, code, wiki edits, issues, and other contributions
@@ -26,24 +43,31 @@ that are not aligned to this Code of Conduct, or to ban temporarily or
 permanently any contributor for other behaviors that they deem inappropriate,
 threatening, offensive, or harmful.
 
-By adopting this Code of Conduct, project maintainers commit themselves to
-fairly and consistently applying these principles to every aspect of managing
-this project. Project maintainers who do not follow or enforce the Code of
-Conduct may be permanently removed from the project team.
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
 
-This code of conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
+## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at matt@hiddenloop.com. All
+reported by contacting the project team at matt@hiddenloop.com. All
 complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
 
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/
+[homepage]: https://www.contributor-covenant.org

data/CONTRIBUTING.md

@@ -34,4 +34,3 @@ request gets accepted:
 * Write a good [commit
   message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
 * Write tests.
-

data/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,16 @@
+
+Explain what you're changing and why here.
+
+---
+#### :memo: Checklist
+
+Please check this list and leave it intact for the reviewer. Thanks! :heart:
+
+- [ ] Commit messages provide context (why not just what, some tips [here](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)).
+- [ ] If relevant, mention GitHub issue number above and include in a commit message.
+- [ ] Latest code from master merged.
+- [ ] New behaviour has test coverage.
+- [ ] Avoid duplicating code.
+- [ ] No commented out code.
+- [ ] Avoid comments for your code, write code that explains itself.
+- [ ] Changes are simple, useful, clear and brief.

data/README.md

@@ -1,21 +1,21 @@
 # ECB Exchange
 
-[![Gem Version](https://img.shields.io/gem/v/ecb_exchange.svg?style=flat)](http://rubygems.org/gems/ecb_exchange)
-[![Travis Build Status](https://travis-ci.org/matthutchinson/ecb_exchange.svg?branch=master)](https://travis-ci.org/matthutchinson/ecb_exchange)
+[![Gem](https://img.shields.io/gem/v/ecb_exchange.svg?style=flat)](http://rubygems.org/gems/ecb_exchange)
+[![Travis](https://img.shields.io/travis/matthutchinson/ecb_exchange/master.svg?style=flat)](https://travis-ci.org/matthutchinson/ecb_exchange)
+[![Depfu](https://img.shields.io/depfu/matthutchinson/ecb_exchange.svg?style=flat)](https://depfu.com/github/matthutchinson/ecb_exchange)
 [![Maintainability](https://api.codeclimate.com/v1/badges/c67969dd7b921477bdcc/maintainability)](https://codeclimate.com/github/matthutchinson/ecb_exchange/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/c67969dd7b921477bdcc/test_coverage)](https://codeclimate.com/github/matthutchinson/ecb_exchange/test_coverage)
-[![Gem Dependency Status](https://gemnasium.com/badges/github.com/matthutchinson/ecb_exchange.svg)](https://gemnasium.com/github.com/matthutchinson/ecb_exchange)
 
 Currency conversion using the European Central Bank's foreign [exchange
 rates](http://www.ecb.europa.eu/stats/eurofxref/eurofxref-hist-90d.xml). Rates
 for the last 90 days are fetched and cached on demand. All calculations are
-  performed and returned as `BigDecimal`, usually a [good
+  performed and returned as `BigDecimal` (usually a [good
   idea](https://makandracards.com/makandra/1178-bigdecimal-arithmetic-in-ruby)
-  when dealing with money.
+  when dealing with money).
 
 ## Requirements
 
-* Ruby >= 2.1.0
+* [Ruby](http://ruby-lang.org/) >= 2.3
 
 ## Installation
 
@@ -27,54 +27,53 @@ gem 'ecb_exchange'
 
 ## Usage
 
-To convert an amount from one currency to another use:
+Convert an amount from one currency to another:
 
 ```ruby
 ECB::Exchange.convert(100, from: 'EUR', to: 'GBP')
 => 0.88235e2
 ```
 
-The converted amount (using today's current rate) will be returned (as a
-`BigDecimal`). In doing so the gem will have fetched and cached ECB rates for
-the last 90 days.
+The converted amount (using today's current rate) will be returned as
+`BigDecimal`. In doing this, the gem will fetch and cache ECB rates for the last
+90 days.
 
-You can ask the exchange to convert an amount on a specific date:
+Convert an amount on a specific date:
 
 ```ruby
 ECB::Exchange.convert(100, from: 'EUR', to: 'GBP', date: Date.parse('2017-01-11'))
 => 0.87235e2
 ```
 
-To return only the exchange rate multiplier between two currencies use:
+To fetch the exchange rate multiplier between two currencies:
 
 ```ruby
-ECB::Exchange.rate(from: 'EUR', to: 'USD')
+ECB::Exchange.rate(from: 'EUR', to: 'USD') # pass an optional `date` arg here too
 => 0.11969e1
-# you can pass an optional `date` argument to this method too
 ```
 
-You can ask for an array of supported currency codes with:
+You can ask for an array of all supported currencies with:
 
 ```ruby
 ECB::Exchange.currencies
 => ["USD", "JPY", "BGN", "CZK", "DKK", "GBP", "HUF" ... ]
 ```
 
-Finally, you can adjust the rates endpoint by setting the
+Finally, you can adjust the rates endpoint by setting your own
 `XMLFeed.endpoint` (e.g. in an initializer):
 
 ```ruby
 ECB::Exchange::XMLFeed.endpoint = "http://my-awesome-service.com/feed.xml"
 ```
 
-The XML feed must conform to the [ECB
+The XML feed at this endpoint must conform to the [ECB
 rates](http://www.ecb.europa.eu/stats/eurofxref/eurofxref-hist-90d.xml)
 structure.
 
 ## Handling Errors
 
 Not all dates, rates or currencies may be available, or the remote endpoint
-could be unresponsive. You should consider handling the following errors:
+could be unresponsive. For these cases consider handling these errors:
 
 * `ECB::Exchange::DateNotFoundError`
 * `ECB::Exchange::CurrencyNotFoundError`
@@ -85,18 +84,18 @@ Or rescue `ECB::Exchange::Error` to catch any of them.
 
 ## Caching
 
-By default rates will be cached to one of the following backend stores (with
-this order of preference).
+By default rates will be cached to one of the following backend stores (in this
+order of preference).
 
 * Your own backend cache store (see below)
-* The `Rails.cache`
+* `Rails.cache`
 * An `ECB::Exchange::MemoryCache` instance (a simple in memory cache store)
 
-To configure your own backend store:
+To configure your own backend store (e.g. in an initializer):
 
 ```ruby
 ECB::Exchange::Cache.backend =  MyAwesomeCache.new
-# your cache must implement public `read(key)` and `write(key, value)` methods
+# this cache must implement public `read(key)` and `write(key, value)` methods
 ```
 
 All keys in the cache are name-spaced with a `ecb_exchange_rates_for_date-`
@@ -108,8 +107,8 @@ Check out this repo and run `bin/setup`, this will install gem dependencies and
 generate docs. Use `bundle exec rake` to run tests and generate a coverage
 report.
 
-You can also run `bin/console` for an interactive prompt allowing you to
-experiment with the code.
+You can also run `bin/console` for an interactive prompt to experiment with the
+code.
 
 ## Tests
 
@@ -146,12 +145,10 @@ Covenant](http://contributor-covenant.org) code of conduct. See
 [here](https://github.com/matthutchinson/ecb_exchange/blob/master/CODE_OF_CONDUCT.md)
 for more details.
 
-
 ## Todo
 
 * Better RDoc documentation.
-* A small Rails app to demo this gem, with a one-click heroku install.
-* Allow `Net::HTTP` to be swapped out for any another HTTP client.
+* A Rails app to demo this gem (e.g. with a one-click Heroku install).
 
 ## License
 
@@ -160,11 +157,11 @@ The code is available as open source under the terms of
 
 ## Links
 
+* [Gem](http://rubygems.org/gems/ecb_exchange)
 * [Travis CI](https://travis-ci.org/matthutchinson/ecb_exchange)
 * [Maintainability](https://codeclimate.com/github/matthutchinson/ecb_exchange/maintainability)
 * [Test Coverage](https://codeclimate.com/github/matthutchinson/ecb_exchange/test_coverage)
 * [RDoc](http://rdoc.info/projects/matthutchinson/ecb_exchange)
 * [Issues](http://github.com/matthutchinson/ecb_exchange/issues)
 * [Report a bug](http://github.com/matthutchinson/ecb_exchange/issues/new)
-* [Gem](http://rubygems.org/gems/ecb_exchange)
 * [GitHub](https://github.com/matthutchinson/ecb_exchange)

data/ecb_exchange.gemspec

@@ -21,20 +21,13 @@ Gem::Specification.new do |spec|
   EOF
 
   spec.metadata = {
-    "homepage_uri"    => "https://github.com/matthutchinson/ecb_exchange",
-    "changelog_uri"   => "https://github.com/matthutchinson/ecb_exchange/blob/master/CHANGELOG.md",
-    "source_code_uri" => "https://github.com/matthutchinson/ecb_exchange",
-    "bug_tracker_uri" => "https://github.com/matthutchinson/ecb_exchange/issues",
+    "homepage_uri"      => "https://github.com/matthutchinson/ecb_exchange",
+    "changelog_uri"     => "https://github.com/matthutchinson/ecb_exchange/blob/master/CHANGELOG.md",
+    "source_code_uri"   => "https://github.com/matthutchinson/ecb_exchange",
+    "bug_tracker_uri"   => "https://github.com/matthutchinson/ecb_exchange/issues",
+    "allowed_push_host" => "https://rubygems.org"
   }
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the "allowed_push_host"
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata["allowed_push_host"] = "https://rubygems.org"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
-  end
-
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.test_files    = `git ls-files -- {test}/*`.split("\n")
   spec.bindir        = "bin"
@@ -46,7 +39,7 @@ Gem::Specification.new do |spec|
   spec.rdoc_options << "--title" << "ECB Exchange" << "--main" << "README.md" << "-ri"
 
   # non-gem dependecies
-  spec.required_ruby_version = ">= 2.1.0"
+  spec.required_ruby_version = ">= 2.3"
 
   # dev gems
   spec.add_development_dependency "bundler"

data/lib/ecb/exchange.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'date'
 require 'bigdecimal/util'
 
 module ECB
   module Exchange
-    VERSION = "0.1.2".freeze
+    VERSION = "0.2.0".freeze
 
     def self.convert(amount, from:, to:, date: Date.today)
       amount.to_d * rate(from: from, to: to, date: date)

data/lib/ecb/exchange/cache.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ECB
   module Exchange
     class Cache

data/lib/ecb/exchange/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ECB
   module Exchange
     class Error < StandardError; end

data/lib/ecb/exchange/memory_cache.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ECB
   module Exchange
     class MemoryCache

data/lib/ecb/exchange/xml_feed.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rexml/document"
 require "net/http"
 require "uri"

data/lib/ecb_exchange.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ecb/exchange'
 require 'ecb/exchange/xml_feed'
 require 'ecb/exchange/memory_cache'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecb_exchange
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Matthew Hutchinson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-05 00:00:00.000000000 Z
+date: 2019-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,6 +128,7 @@ files:
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
+- PULL_REQUEST_TEMPLATE.md
 - README.md
 - Rakefile
 - bin/console
@@ -161,15 +162,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Currency conversion using the European Central Bank's foreign exchange rates.