money-uphold-bank 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06b97ddab0656fba08ddc1e6bc35b21b0fb77270
+  data.tar.gz: a95bb0c3911f74e1a001ba645b2a04abda39868a
+SHA512:
+  metadata.gz: 588490db739884bde71916f384a3fdec0fb9026c0d6f03b606e2a5815ae8669fd567e05cb03e371a1130c756d814579c993702ba146532c4c0afe289b06d4038
+  data.tar.gz: 0d535317af0db2dbbe4cc7c8be93a735e3dd98e524cd5ba25be72227775f6f0a514a25c3d6f896d051cb5fa5800c092b110d5ecf2ff8c7b5cf36ab7f731f7358

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,64 @@
+AllCops:
+  Include:
+    - "**/Rakefile"
+    - "**/config.ru"
+  Exclude:
+    - "db/**/*"
+    - "config/**/*"
+    - "script/**/*"
+    - "bin/**/*"
+    - "vendor/**/*"
+    - "node_modules/**/*"
+    - "spec/factories.rb"
+    - "slack_bot/**/*"
+  TargetRubyVersion: 2.3
+
+Metrics/LineLength:
+  Enabled: false
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/PredicateName:
+  NamePrefixBlacklist:
+    - is_
+    - have_
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 2.2.0
+  - 2.1.5
+  - 2.0.0
+  - ruby-head
+  - jruby-1.6.8
+  - rbx-2.2.10
+before_install:
+  - gem install bundler -v 1.11.2
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-1.6.8
+    - rvm: rbx-2.2.10

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in money-uphold-bank.gemspec
+gemspec
+
+gem "pry"

data/README.md

@@ -0,0 +1,69 @@
+# Money Uphold Bank
+
+[![Build Status](https://travis-ci.org/subvisual/money-uphold-bank.svg?branch=master)](https://travis-ci.org/subvisual/money-uphold-bank) [![Code Climate](https://codeclimate.com/github/subvisual/money-uphold-bank/badges/gpa.svg)](https://codeclimate.com/github/subvisual/money-uphold-bank)
+
+A gem that calculates the exchange rate using published rates from https://uphold.com
+
+To be used as an exchange rate provider for the [money gem](https://github.com/RubyMoney/money)
+
+## Uphold API
+
+```json
+[{
+  "ask": "1",
+  "bid": "1",
+  "currency": "BTC",
+  "pair": "BTCBTC"
+}, {
+  "ask": "440.99",
+  "bid": "440",
+  "currency": "USD",
+  "pair": "BTCUSD"
+}]
+```
+
+Full description of the ticker endpoint: https://uphold.com/en/developer/api/documentation/#get-all-tickers
+Full Uphold API specification: https://uphold.com/en/developer/api/documentation
+
+## Features
+
+* Calculates exchange rates based on the mid market price, as [specified by Uphold itself](https://support.uphold.com/hc/en-us/articles/203664225-How-does-Uphold-set-its-conversion-rates-)
+* Supports all Uphold currencies, including Bitcoin, Litecoin, and Voxelus
+* Caches API response for a customizable time
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'money-uphold-bank'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install money-uphold-bank
+
+## Usage
+
+```ruby
+# Minimal requirements
+require "money/bank/uphold"
+
+bank = Money::Bank::Uphold.new
+
+# (optional)
+# Set the number of seconds after which the rates are automatically expired.
+# By default, they expire every hour
+bank.ttl_in_seconds = 3600
+
+Money.default_bank = bank
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/subvisual/money-uphold-bank. 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.
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:rubocop, :spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "money/uphold/bank"
+
+# 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

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/lib/money/bank/uphold.rb

@@ -0,0 +1,94 @@
+require "money/bank/variable_exchange"
+require "open-uri"
+
+class Money
+  module Bank
+    class Uphold < Money::Bank::VariableExchange
+      UPHOLD_TICKERS_URL = "https://api.uphold.com/v0/ticker".freeze
+      UPHOLD_BASE_CURRENCY = "USD".freeze
+
+      # Seconds after which the current rates are automatically expired
+      attr_accessor :ttl_in_seconds
+
+      # Parsed UpholdBank result as a Hash
+      attr_reader :tickers
+
+      # Rates expiration time
+      attr_reader :rates_expire_at
+
+      def initialize(*args, &block)
+        super
+        ttl_in_seconds = 3600 # 1 hour
+      end
+
+      # Update all rates from UpholdBank JSON
+      def update_rates
+        # clear all existing rates, even inferred ones
+        store.each_rate do |iso_from, iso_to, _rate|
+          add_rate(iso_from, iso_to, nil)
+        end
+        exchange_rates.each do |ticker|
+          add_exchange_rates_from_ticker(ticker)
+        end
+      end
+
+      alias original_get_rate get_rate
+
+      def get_rate(iso_from, iso_to, opts = {})
+        update_rates_if_expired
+
+        super || get_indirect_rate(iso_from, iso_to, opts)
+      end
+
+      private
+
+      def get_indirect_rate(iso_from, iso_to, opts = {})
+        return 1 if Currency.wrap(iso_from).iso_code == Currency.wrap(iso_to).iso_code
+
+        rate_to_base = original_get_rate(iso_from, UPHOLD_BASE_CURRENCY, opts)
+        rate_from_base = original_get_rate(UPHOLD_BASE_CURRENCY, iso_to, opts)
+
+        return unless rate_to_base && rate_from_base
+
+        rate = rate_to_base * rate_from_base
+
+        add_rate(iso_from, iso_to, rate)
+        add_rate(iso_to, iso_from, 1.0 / rate)
+
+        rate
+      end
+
+      def add_exchange_rates_from_ticker(ticker)
+        iso_from, iso_to = ticker["pair"].scan(/.{3}/)
+        rate = (ticker["ask"].to_f + ticker["bid"].to_f) * 0.5
+
+        return unless Money::Currency.find(iso_from) && Money::Currency.find(iso_to)
+
+        add_rate(iso_from, iso_to, rate)
+        add_rate(iso_to, iso_from, 1.0 / rate)
+      end
+
+      def update_rates_if_expired
+        update_rates if rates_expired?
+      end
+
+      def rates_expired?
+        return true unless rates_expire_at
+
+        rates_expire_at <= Time.now
+      end
+
+      def exchange_rates
+        raw_rates = JSON.parse(read_from_url)
+        @rates_expire_at = Time.now + ttl_in_seconds
+        raw_rates
+      rescue JSON::ParserError
+        []
+      end
+
+      def read_from_url
+        open(UPHOLD_TICKERS_URL).read
+      end
+    end
+  end
+end

data/money-uphold-bank.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "money-uphold-bank"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Miguel Palhas"]
+  spec.email         = ["miguel@subvisual.co"]
+
+  spec.description   = %q(A gem that calculates the exchange rate using published rates from uphold.com. Compatible with the money gem)
+  spec.summary       = %q(A gem that calculates the exchange rate using published rates from uphold.com.)
+  spec.homepage      = "https://github.com/subvisual/#{spec.name}"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "money", "~> 6.7"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.37.2"
+  spec.add_development_dependency "webmock", "~> 2.1.0"
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: money-uphold-bank
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Miguel Palhas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.37.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.37.2
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: A gem that calculates the exchange rate using published rates from uphold.com.
+  Compatible with the money gem
+email:
+- miguel@subvisual.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/money/bank/uphold.rb
+- money-uphold-bank.gemspec
+homepage: https://github.com/subvisual/money-uphold-bank
+licenses: []
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.2
+signing_key: 
+specification_version: 4
+summary: A gem that calculates the exchange rate using published rates from uphold.com.
+test_files: []