crypto_val 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 94ab7c7da8be8b0a4a3204d92438acfd6ee9859c
+  data.tar.gz: a3b4cc9ad0bca88b896a63cf114115fe0183ee24
+SHA512:
+  metadata.gz: edefe54a285a2bbcaac0ebca703629d6073f8be825c5c1d76e02595fc202387a7d76aff3820dc672b6dcde074d7a76874303fa95e49f075b4162b39d71a5b315
+  data.tar.gz: 3f51e2d50c333e4395282783a1873a2662529323ea472af35b49921ca8bf6b789d1aeb0aee60ba60bebcfb13ebe3afd06334298fe660a17e0d4d2039e77d08dc

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.5
+before_install: gem install bundler -v 1.13.2

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 marvin.baltazar@gmail.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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in crypto_val.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    crypto_val (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.10.1)
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.13)
+  crypto_val!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.13.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Marvin Baltazar
+
+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,76 @@
+# CryptoVal
+
+CryptoVal is a Ruby gem that fetches the latest value of a Cryptocurrency. In addition, it also provides exchange rate conversion for several currencies.
+
+[![Gem Version](https://badge.fury.io/rb/cryptoval.svg)](https://badge.fury.io/rb/cryptoval)
+[![Build Status](https://travis-ci.org/marvs/cryptoval.png)](https://travis-ci.org/marvs/cryptoval)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'crypto_val'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install crypto_val
+
+## Usage
+
+### Basic Usage
+
+The basic usage of this gem is to get the latest USD value of Bitcoin (BTC):
+
+`CryptoVal::Latest.fetch`
+
+This will return a Hash similar to:
+
+`{:symbol=>"BTC", :currency=>"USD", :value=>4121.19}`
+
+Additional options can be provided:
+
+* symbol - the symbol of the Cryptocurrency (e.g. "LTC", "XRP")
+* currency - the fiat currency that will be used
+
+For example, to get the PHP value of Ripple (XRP):
+
+`CryptoVal::Latest.fetch(symbol: "XRP", currency: "PHP")`
+
+This returns the following:
+
+`{:symbol=>"XRP", :currency=>"PHP", :value=>12.03}`
+
+### Exchange Rate
+
+It is possible to just get the current exchange rate for different currencies. This method can be used for a more performant code by fetching the current exchange rate only once for all of the Cryptocurrency values.
+
+`CryptoVal::FiatExchange.fetch(source_currency: "USD", target_currency: "PHP")`
+
+* source_currency - the fiat symbol of the source currency (defaults to "USD")
+* target_currency - the fiat symbol of the target currency
+
+This returns the date and the current exchange rate:
+
+`{:source_currency=>"USD", :target_currency=>"PHP", :date=>#<Date: 2017-08-24 ((2457990j,0s,0n),+0s,2299161j)>, :rate=>51.08}`
+
+## 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.
+
+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/marvs/cryptoval. 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](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'crypto_val/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "crypto_val"
+  spec.version       = CryptoVal::VERSION
+  spec.authors       = ["Marvin Baltazar"]
+  spec.email         = ["marvin.baltazar@gmail.com"]
+
+  spec.summary       = %q{Ruby wrapper for the latest valuations of various cryptocurrencies.}
+  spec.description   = %q{Ruby wrapper for the latest valuations of various cryptocurrencies.}
+  spec.homepage      = "https://github.com/marvs/cryptoval"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/crypto_val.rb

@@ -0,0 +1,11 @@
+require 'date'
+require 'net/http'
+require 'json'
+require "crypto_val/version"
+require "crypto_val/crypto_exchange/cryptonator"
+require "crypto_val/fiat_exchange"
+require "crypto_val/fiat_exchange/fixer"
+require "crypto_val/latest"
+
+module CryptoVal
+end

data/lib/crypto_val/crypto_exchange/cryptonator.rb

@@ -0,0 +1,56 @@
+module CryptoVal::CryptoExchange
+  class Cryptonator
+    DEFAULT_SYMBOL = "BTC"
+    DEFAULT_CURRENCY = "USD"
+    
+    attr_reader :symbol, :currency
+
+    def initialize opts={}
+      @symbol   = opts[:symbol] || DEFAULT_SYMBOL
+      @currency = opts[:currency] || DEFAULT_CURRENCY
+    end
+    
+    def fetch
+      format_response
+    end
+    
+    def self.fetch opts={}
+      new(opts).fetch
+    end
+    
+    private
+    
+    def base_url
+      "https://api.cryptonator.com"
+    end
+    
+    def url
+      "#{base_url}/api/ticker/#{@symbol}-#{@currency}"
+    end
+    
+    def response
+      @response ||= get_response
+    end
+    
+    def get_response
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      request = Net::HTTP::Get.new(uri.request_uri)
+      http.request(request).body
+    end
+    
+    def parsed
+      @parsed ||= JSON.parse(response)
+    end
+    
+    def format_response
+      {
+        symbol: parsed["ticker"]["base"],
+        currency: parsed["ticker"]["target"],
+        price: parsed["ticker"]["price"].to_f
+      }
+    end
+
+  end
+end

data/lib/crypto_val/fiat_exchange.rb

@@ -0,0 +1,31 @@
+module CryptoVal
+  class FiatExchange
+    DEFAULT_CURRENCY = "USD"
+    
+    def initialize opts={}
+      @source_currency  = opts[:source_currency] || DEFAULT_CURRENCY
+      @target_currency  = opts[:target_currency]
+      @exchange_klass   = opts[:exchange_class] || CryptoVal::FiatExchange::Fixer
+    end
+    
+    def fetch
+      { 
+        source_currency: exchange[:source],
+        target_currency: exchange[:target],
+        date: exchange[:date],
+        rate: exchange[:rate]
+      } 
+    end
+    
+    def self.fetch opts={}
+      new(opts).fetch
+    end
+  
+    private
+    
+    def exchange
+      @exchange ||= @exchange_klass.fetch({ source_currency: @source_currency, target_currency: @target_currency })
+    end
+  
+  end
+end

data/lib/crypto_val/fiat_exchange/fixer.rb

@@ -0,0 +1,62 @@
+module CryptoVal
+  class FiatExchange::Fixer
+    DEFAULT_SOURCE = "USD"
+    DEFAULT_TARGET = "PHP"
+    
+    attr_reader :source_currency, :target_currency
+
+    def initialize opts={}
+      @source_currency = opts[:source_currency] || DEFAULT_SOURCE
+      @target_currency = opts[:target_currency] || DEFAULT_TARGET
+    end
+    
+    def fetch
+      format_response
+    end
+    
+    def self.fetch opts={}
+      new(opts).fetch
+    end
+    
+    private
+    
+    def base_url
+      "https://api.fixer.io"
+    end
+    
+    def url
+      "#{base_url}/latest?base=#{@source_currency}&symbols=#{@target_currency}"
+    end
+    
+    def response
+      @response ||= get_response
+    end
+    
+    def get_response
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      request = Net::HTTP::Get.new(uri.request_uri)
+      http.request(request).body
+    end
+    
+    def parsed
+      @parsed ||= JSON.parse(response)
+    end
+    
+    def parsed_date
+      Date.parse(parsed["date"]) rescue nil
+    end
+    
+    def format_response
+      {
+        source: parsed["base"],
+        target: @target_currency,
+        date: parsed_date,
+        rate: parsed["rates"][@target_currency].to_f
+      }
+    end
+  
+  end
+  
+end

data/lib/crypto_val/latest.rb

@@ -0,0 +1,49 @@
+module CryptoVal
+  class Latest
+    # Gets the latest value of a cryptocurrency
+    DEFAULT_CRYPTO = "BTC"
+    DEFAULT_CURRENCY = "USD"
+    
+    def initialize opts={}
+      @symbol       = opts[:symbol] || DEFAULT_CRYPTO
+      @currency     = opts[:currency] || DEFAULT_CURRENCY
+      @crypto_klass = opts[:crypto_klass] || CryptoVal::CryptoExchange::Cryptonator
+      @fiat_klass   = opts[:fiat_klass] || CryptoVal::FiatExchange
+    end
+    
+    def fetch
+      { 
+        symbol: @symbol,
+        currency: @currency,
+        value: currency_value
+      } 
+    end
+    
+    def self.fetch opts={}
+      new(opts).fetch
+    end
+  
+    private
+    
+    def crypto
+      @crypto ||= @crypto_klass.fetch({ symbol: @symbol })
+    end
+    
+    def fiat
+      @fiat ||= @fiat_klass.fetch({ target_currency: @currency })
+    end
+    
+    def crypto_value
+      @crypto_value ||= crypto[:price]
+    end
+    
+    def exchange_rate
+      exchange_rate ||= fiat[:rate]
+    end
+    
+    def currency_value
+      @currency != DEFAULT_CURRENCY ? (crypto_value * exchange_rate).to_f.round(2) : crypto_value.to_f.round(2)
+    end
+  
+  end
+end

data/lib/crypto_val/version.rb

@@ -0,0 +1,3 @@
+module CryptoVal
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: crypto_val
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marvin Baltazar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Ruby wrapper for the latest valuations of various cryptocurrencies.
+email:
+- marvin.baltazar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- crypto_val.gemspec
+- lib/crypto_val.rb
+- lib/crypto_val/crypto_exchange/cryptonator.rb
+- lib/crypto_val/fiat_exchange.rb
+- lib/crypto_val/fiat_exchange/fixer.rb
+- lib/crypto_val/latest.rb
+- lib/crypto_val/version.rb
+homepage: https://github.com/marvs/cryptoval
+licenses:
+- MIT
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the latest valuations of various cryptocurrencies.
+test_files: []