forex_rates 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e2c59737e399a395f17c73374fc43d4ff68eec584299ca47ffbd0d859cfbf310
+  data.tar.gz: 1838eb4f8785c88821cd00f4708f4743447223c18a5820c2467033c67441911c
+SHA512:
+  metadata.gz: 4c61f9fe84d4f22556a4c0befc3cd89724966ee58a612c890fd3d45a60926d5e240b66e71537e2c3f05e7b69bc9ad2011c0212d203398f85e3b6e2e059bd588a
+  data.tar.gz: 547e1af2727006cffea44893b711203387947160d6040508dce2fa7c831e085dd5783006300d1394831672fa114d1c7e9e0960fd6d5ed710e096158fe6bce271

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 1.17.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+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,
+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 and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* 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
+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.
+
+## 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.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at pghosh@enphaseenergy.com. All
+complaints will be reviewed and investigated and will result in a response that
+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.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in exchange_rates.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    forex_rates (0.0.1)
+      faraday (~> 1.0.1)
+      faraday-http-cache (~> 2.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    faraday-http-cache (2.2.0)
+      faraday (>= 0.8)
+    multipart-post (2.1.1)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  forex_rates!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Partho Ghosh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# Forex Rates
+
+Built upon https://exchangeratesapi.io/ , this gem allows to fetch latest and historical foreign exchange rates. The gem comes with an optional in-built caching support so that responses can be cached (and we don't end up spamming the source).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'forex_rates'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install forex_rates
+
+## Usage
+Require the lib
+```ruby
+  require "forex_rates"
+```
+
+To instantiate without caching, do the following:
+
+```ruby
+forex = ForexRates::Forex.new
+```
+To use the built-in cache, which is built on top of faraday-http-cache, you can do following:
+
+```ruby
+forex = ForexRates::Forex.new store: store # Only store
+# or
+forex = ForexRates::Forex.new store: store, serializer: Marshal, logger: logger  #pass either of store, serializer and/or logger params as you would do in faraday-http-cache
+```
+For more details around parameters, checkout https://github.com/sourcelevel/faraday-http-cache.
+
+You can perform following queries:
+
+```ruby
+ forex.get_latest
+ # or
+ forex.get_latest base: "USD", symbols: "INR,CAD"
+
+ forex.get_for_a_day "2020-03-01"
+ # or
+ forex.get_for_a_day "2020-03-01", base: "USD", symbols: "INR,CAD"
+
+ forex.get_historical "2020-01-01", "2020-07-10"
+ # or
+ forex.get_historical "2020-01-01", "2020-07-10", base: "USD", symbols: "INR,CAD"
+
+```
+For more details regarding parameters, head over to https://exchangeratesapi.io/
+
+
+
+## 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.
+
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/forex_rates. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ForexRates project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/forex_rates/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "forex_rates"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/forex_rates.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "forex_rates/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "forex_rates"
+  spec.version       = ForexRates::VERSION
+  spec.authors       = ["Partho Ghosh"]
+  spec.email         = ["partho.ghosh24@gmail.com"]
+
+  spec.summary       = %q{Simple gem to fetch foreign exchange rates with optional in-built caching.}
+  spec.description   = %q{Built upon https://exchangeratesapi.io/, this gem allows to fetch current exchange rates and more. It comes with an optional built-in cache support built on top of faraday-http-cache which if activated, can enable caching for the response.}
+  spec.homepage      = "https://github.com/parthoghosh24/forex_rates"
+  spec.license       = "MIT"
+
+  # 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"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/parthoghosh24/forex_rates"
+    spec.metadata["changelog_uri"] = "https://github.com/parthoghosh24/forex_rates"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "faraday", "~> 1.0.1"
+  spec.add_dependency "faraday-http-cache", "~> 2.2.0"
+end

data/lib/forex_rates.rb

@@ -0,0 +1,6 @@
+require "forex_rates/version"
+require "forex_rates/api"
+require "forex_rates/forex"
+
+module ForexRates
+end

data/lib/forex_rates/api.rb

@@ -0,0 +1,35 @@
+require "faraday"
+
+module ForexRates
+    class Api < Faraday::Connection
+        def initialize(url="https://api.exchangeratesapi.io")
+            super(url)
+        end
+
+        def get_latest(params)
+            self.get "/latest#{build_query_params(params[0])}"
+        end
+
+        def get_history(start_date, end_date, params)
+            params_hash = params[0] || {}
+            params_hash.merge!({start_at: start_date, end_at: end_date})
+            self.get "/history#{build_query_params(params_hash)}"
+        end
+
+        def get_for_a_day(date, params)
+            self.get "/#{date}#{build_query_params(params[0])}"
+        end
+
+        private
+
+        def build_query_params(params)
+            return nil unless params && params.size > 0
+            query_params = "?"
+            params.each_with_index do |(key, val), index|
+                index == 0 ? query_params << "#{key}=#{val}" : query_params << "&#{key}=#{val}"
+            end
+            query_params
+        end
+
+    end
+end

data/lib/forex_rates/forex.rb

@@ -0,0 +1,45 @@
+require "json"
+require "faraday-http-cache"
+
+module ForexRates
+    class ForexRatesError < StandardError; end
+
+    class Forex
+        attr_accessor :api
+
+        def initialize(*cache_opts)
+            if cache_opts[0] && cache_opts[0].size > 0
+                @api = Api.new do |builder|
+                     builder.use :http_cache, cache_opts[0]
+                     builder.adapter Faraday.default_adapter
+                end
+            else
+                @api = Api.new
+            end
+
+        end
+
+        def get_latest(*opts)
+            resp = api.get_latest(opts)
+            JSON.parse resp.body
+        end
+
+        def get_historical(start_date, end_date, *opts)
+            raise ForexRatesError.new "Date is not correct" unless verify_date(start_date) && verify_date(end_date)
+            resp = api.get_history(start_date, end_date, opts)
+            JSON.parse resp.body
+        end
+
+        def get_for_a_day(date, *opts)
+            raise ForexRatesError.new "Date is not correct" unless verify_date(date)
+            resp = api.get_for_a_day(date,opts)
+            JSON.parse resp.body
+        end
+
+        private
+
+        def verify_date(date)
+            date.match?(/\d{4}-\d{2}-\d{2}/)
+        end
+    end
+  end

data/lib/forex_rates/version.rb

@@ -0,0 +1,3 @@
+module ForexRates
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: forex_rates
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Partho Ghosh
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: faraday-http-cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+description: Built upon https://exchangeratesapi.io/, this gem allows to fetch current
+  exchange rates and more. It comes with an optional built-in cache support built
+  on top of faraday-http-cache which if activated, can enable caching for the response.
+email:
+- partho.ghosh24@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- forex_rates.gemspec
+- lib/forex_rates.rb
+- lib/forex_rates/api.rb
+- lib/forex_rates/forex.rb
+- lib/forex_rates/version.rb
+homepage: https://github.com/parthoghosh24/forex_rates
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/parthoghosh24/forex_rates
+  source_code_uri: https://github.com/parthoghosh24/forex_rates
+  changelog_uri: https://github.com/parthoghosh24/forex_rates
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Simple gem to fetch foreign exchange rates with optional in-built caching.
+test_files: []