coin_market 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 00fc0871af9263ac9e952f8332e40ddb1d339603
+  data.tar.gz: 3b9666fe5b8b8a7767c4d2722c03a5afbe459300
+SHA512:
+  metadata.gz: 680cf54611884fb56fcba9ca8d6615401954bd52d1310dc3aa5ebdb8db6431f1cf998d964293a85d7f62259981fc4ced524c00b0537e6411ed253efaadaabfd3
+  data.tar.gz: d18494aa1483eef4385ec9837cde3d142982079ee7b46e7aebd85b06e4ea2c8a3d6cdced88c64edab77b264f3333d563b2464fe56b3d38ca888222b1cf5e9d2f

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,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

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 nap@zerosum.org. 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 coin_market.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    coin_market (0.1.0)
+      json (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    json (2.1.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  coin_market!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Nick Plante
+
+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,60 @@
+# CoinMarket
+
+Ruby API client for crypto market statistics. Currently uses the [CoinMarketCap API](https://coinmarketcap.com/api/).
+
+    Endpoints update every 5 minutes.
+    Please limit requests to no more than 10 per minute.
+
+See the link above for more information.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'coin_market'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install coin_market
+
+## Usage
+
+Fetch statistics about a specific token:
+
+    res = CoinMarket::Ticker.get('bitcoin')
+    puts "#{res.symbol}: #{res.price}"
+    # => BTC: 15330.8
+    puts "#{res.name}: #{res.market_cap}"
+    # Bitcoin: 256933859710.0
+    puts res.percent_change(period: '1h')
+    # => -1.03
+    puts res.percent_change(period: '24h')
+    # => 6.42
+
+Or fetch statistics for all of the top 100 currencies (based on market cap):
+
+    res = CoinMarket::Ticker.all
+    puts res[0..10].map(&:name).join(', ')
+    # => Bitcoin, Ethereum, Bitcoin Cash, Ripple, Litecoin, Cardano, IOTA, Dash, NEM, Monero, Bitcoin Gold
+
+## 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/zapnap/coin_market. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to follow the [code of conduct](https://github.com/zapnap/coin_market/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+Copyright © 2017 Nick Plante, released under the MIT license

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 "coin_market"
+
+# 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/coin_market.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "coin_market/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "coin_market"
+  spec.version       = CoinMarket::VERSION
+  spec.authors       = ["Nick Plante"]
+  spec.email         = ["nap@zerosum.org"]
+
+  spec.summary       = %q{Fetch current market data for top cryptocurrencies using the CoinMarketCap API}
+  spec.description   = %q{Fetch current market data for top cryptocurrencies using the CoinMarketCap API}
+  spec.homepage      = "https://github.com/zapnap/coin_market"
+  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_dependency "json", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/coin_market.rb

@@ -0,0 +1,7 @@
+require "coin_market/client"
+require "coin_market/ticker"
+require "coin_market/version"
+require "json"
+
+module CoinMarket
+end

data/lib/coin_market/client.rb

@@ -0,0 +1,37 @@
+require "open-uri"
+
+module CoinMarket
+  class Client
+    @@api_version = 'v1'
+    @@base_uri = "https://api.coinmarketcap.com/v1"
+
+    attr_accessor :api_key, :limit, :start, :convert
+
+    def initialize(options = {})
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+
+      yield(self) if block_given?
+    end
+
+    def request(endpoint, id=nil, options={})
+      res = read_url(build_url(endpoint, id, options))
+      JSON.parse(res)
+    rescue OpenURI::HTTPError => e
+      puts "ERROR: #{e}"
+      []
+    end
+
+    private
+
+    def build_url(endpoint, id, options={})
+      id = id.downcase.gsub(/\s/, '-').gsub(/[^\w-]/, '') unless id.nil?
+      url = [@@base_uri, endpoint, id].compact.join('/')
+    end
+
+    def read_url(url)
+      open(url).read
+    end
+  end
+end

data/lib/coin_market/ticker.rb

@@ -0,0 +1,61 @@
+module CoinMarket
+  class Ticker
+    class << self
+      def get(id)
+        response = CoinMarket::Client.new.request('ticker', id)
+        tickers = response.map { |obj| CoinMarket::Ticker.new(obj) }
+        tickers.length > 1 ? tickers : tickers[0]
+      end
+
+      def all
+        get(nil)
+      end
+    end
+
+    attr_reader :attributes
+
+    def initialize(obj)
+      @attributes = obj
+    end
+
+    def id; attributes['id']; end
+    def name; attributes['name']; end
+    def symbol; attributes['symbol']; end
+    def rank; attributes['rank'].to_f; end
+    def available_supply; attributes['available_supply'].to_f; end
+    def total_supply; attributes['total_supply'].to_f; end
+
+    def price(options={})
+      currency = options[:currency] || 'usd'
+      key = "price_#{currency}"
+
+      attributes.has_key?(key) ? attributes[key].to_f : nil
+    end
+
+    def volume(options={})
+      period = options[:period] || '24h'
+      currency = options[:currency] || 'usd'
+      key = "#{period}_volume_#{currency}"
+
+      attributes.has_key?(key) ? attributes[key].to_f : nil
+    end
+
+    def market_cap(options={})
+      currency = options[:currency] || 'usd'
+      key = "market_cap_#{currency}"
+
+      attributes.has_key?(key) ? attributes[key].to_f : nil
+    end
+
+    def percent_change(options={})
+      period = options[:period] || '24h'
+      key = "percent_change_#{period}"
+
+      attributes.has_key?(key) ? attributes[key].to_f : nil
+    end
+
+    def last_updated
+      Time.at(attributes['last_updated'].to_f)
+    end
+  end
+end

data/lib/coin_market/version.rb

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

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: coin_market
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Plante
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: Fetch current market data for top cryptocurrencies using the CoinMarketCap
+  API
+email:
+- nap@zerosum.org
+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
+- coin_market.gemspec
+- lib/coin_market.rb
+- lib/coin_market/client.rb
+- lib/coin_market/ticker.rb
+- lib/coin_market/version.rb
+homepage: https://github.com/zapnap/coin_market
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Fetch current market data for top cryptocurrencies using the CoinMarketCap
+  API
+test_files: []
+has_rdoc: