coincapper 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 51ccb6a048494876bbd683964f0f0f81f73faff6
+  data.tar.gz: 8c943acf1733761424d552fc601a60b72822acdf
+SHA512:
+  metadata.gz: 84959ca7d3e1dd8dc743b4e24b70b08a91702db3567342a59c4f7262c67ed4dd1dcf5c002cc56fa3c29983759c44e9abe174801b389dce7a84ea976c99387dc0
+  data.tar.gz: 910a35423289d094763ee017a632988e2cb9e422632cf44df0c297e4cd2cb840d4a861038cab592e58e6f60c6863ffb959ba13f617a2f05623a1853be45b8dc7

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - 'Gemfile'
+Documentation:
+  Enabled: false
+LineLength:
+  Max: 140
+Style/RaiseArgs:
+  EnforcedStyle: compact
+Metrics/AbcSize:
+  Enabled: false
+Metrics/MethodLength:
+  Max: 30

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.15.1
+script: 'bundle exec rake'

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 ankitsamar@outlook.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 coinmarketcap.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ankit Samarthya
+
+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,81 @@
+[![Gem Version](https://badge.fury.io/rb/coincapper.svg)](https://badge.fury.io/rb/coincapper) [![Build Status](https://travis-ci.org/kurt-smith/coincapper.svg?branch=master)](https://travis-ci.org/kurt-smith/coincapper) [![Code Climate](https://codeclimate.com/github/kurt-smith/coincapper/badges/gpa.svg)](https://codeclimate.com/github/kurt-smith/coincapper) [![Coverage Status](https://coveralls.io/repos/github/kurt-smith/coincapper/badge.svg?branch=master)](https://coveralls.io/github/kurt-smith/coincapper?branch=master) [![Issue Count](https://codeclimate.com/github/kurt-smith/coinmarketcap/badges/issue_count.svg)](https://codeclimate.com/github/kurt-smith/coincapper)
+
+# CoinCapper
+
+Rub gem that provides a wrapper to the public coinmarketcap.com V1 API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'coincapper', git: 'https://github.com/kurt-smith/coincapper', branch: 'master'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install coincapper
+
+## Usage
+
+### Coinmarketcap.com API responses
+
+#### All Coins
+
+```ruby
+CoinCapper.coins(limit: 0, rank:  nil, currency: nil)
+```
+
+#### Coin by Coin Market Cap ID
+
+```ruby
+CoinCapper.coin('litecoin', currency: nil)
+```
+
+#### Global
+
+```ruby
+CoinCapper.global(currency: nil)
+```
+
+### Additional Functionality
+
+#### Coin by symbol
+
+```ruby
+CoinCapper.coin_by_symbol('FUN')
+```
+
+#### Retrieve markets by coin
+
+```ruby
+CoinCapper.coin_markets(id: 'iota', symbol: nil)
+```
+
+#### Retrieve Coin historical price
+
+```ruby
+CoinCapper.historical_price('request-network', '2018-01-01', '2018-01-08')
+```
+
+## 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/kurt-smith/coinmarketcap. 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).
+
+## Code of Conduct
+
+Everyone interacting in the CoinCapper project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/kurt-smith/coinmarketcap/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'coincapper'
+
+# 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/coincapper.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'coincapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'coincapper'
+  spec.version       = CoinCapper::VERSION
+  spec.authors       = ['Kurt Smith']
+  spec.email         = ['zippydev@protonmail.com']
+
+  spec.summary       = 'Coin Market Cap V1 API wrapper'
+  spec.description   = 'coinmarketcap.com V1 API wrapper including additional historical prices and coin market pairs.'
+  spec.homepage      = 'https://github.com/kurt-smith/coincapper'
+  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'
+  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 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 'activesupport', '~> 5.1'
+  spec.add_dependency 'http',          '~> 3.0'
+  spec.add_dependency 'nokogiri',      '~> 1.8'
+
+  spec.add_development_dependency 'bundler',    '~> 1.14'
+  spec.add_development_dependency 'pry',        '~> 0.11'
+  spec.add_development_dependency 'rake',       '~> 10.0'
+  spec.add_development_dependency 'rspec',      '~> 3.7'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock', '~> 3.2'
+end

data/lib/coincapper.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: false
+
+require 'active_support'
+require 'active_support/core_ext'
+require 'coincapper/version'
+require 'http'
+require 'nokogiri'
+
+module CoinCapper
+  API_URL = 'https://api.coinmarketcap.com/v1'.freeze
+  BASE_URL = 'https://coinmarketcap.com'.freeze
+
+  # @param rank [Integer] Coins market cap rank greater than or equal
+  # @param limit [Integer] Maximum limit set. Defaults to 0 to return all results
+  # @param currency [String] Country currency code to convert price
+  # @return [Array<Hash>]
+  # @see https://coinmarketcap.com/api/
+  def self.coins(limit: 0, rank: nil, currency: nil)
+    params = {
+      limit: limit,
+      start: rank,
+      convert: currency
+    }.compact.to_param
+
+    url = "#{API_URL}/ticker/"
+    url << "?#{params}" if params.present?
+
+    response = HTTP.get(url)
+    JSON.parse(response.body.to_s, symbolize_names: true)
+  end
+
+  # @param id [Integer] Coinmarketcap coin id
+  # @param currency [String] Country currency code to convert price
+  # @return [Hash]
+  def self.coin(id, currency: nil)
+    params = {
+      convert: currency
+    }.compact.to_param
+
+    url = "#{API_URL}/ticker/#{id}/"
+    url << "?#{params}" if params.present?
+
+    response = HTTP.get(url)
+    json = JSON.parse(response.body.to_s, symbolize_names: true)
+    json.is_a?(Array) ? json.first : json
+  end
+
+  # @param symbol [String] Coin symbol
+  # @return [Hash]
+  def self.coin_by_symbol(symbol)
+    response = HTTP.get("#{API_URL}/ticker/?limit=0")
+    json = JSON.parse(response.body.to_s, symbolize_names: true)
+    json.find { |x| x[:symbol].strip.casecmp(symbol.strip.upcase).zero? }
+  end
+
+  # @param id [String] Coin market cap id
+  # @param symbol [String] Coin symbol
+  # @return [Array<Hash>]
+  def self.coin_markets(id: nil, symbol: nil)
+    raise ArgumentError.new('id or symbol is required') if id.blank? && symbol.blank?
+
+    coin_id = symbol.present? ? coin_by_symbol(symbol)[:id] : id
+    response = HTTP.get("#{BASE_URL}/currencies/#{coin_id}/\#markets")
+    html = Nokogiri::HTML(response.body.to_s)
+    rows = html.css('table#markets-table tbody tr')
+
+    markets = rows.each_with_object([]) do |row, arr|
+      td = row.css('td')
+      arr << {
+        source: td[1].text.strip,
+        pair: td[2].text.strip,
+        volume_usd: td[3].text.strip[/\$(.+)/, 1].delete(',').to_f,
+        price_usd: td[4].text.strip[/\$(.+)/, 1].delete(',').to_f,
+        volume_percentage: td[5].text.to_f,
+        last_updated: td[6].text.strip
+      }
+    end
+
+    markets
+  end
+
+  # @param currency [String] Country currency code to convert price
+  # @return [Hash]
+  def self.global(currency: nil)
+    params = {
+      convert: currency
+    }.compact.to_param
+
+    url = "#{API_URL}/global/"
+    url << "?#{params}" if params.present?
+
+    response = HTTP.get(url)
+    JSON.parse(response.body.to_s, symbolize_names: true)
+  end
+
+  # @param id [String] Coinmarketcap coin id
+  # @param start_date [String] Start date (YYYY-MM-DD)
+  # @param end_date [String] End date (YYYY-MM-DD)
+  # @return [Array<Hash>]
+  def self.historical_price(id, start_date, end_date)
+    sd = start_date.to_date.to_s.delete('-')
+    ed = end_date.to_date.to_s.delete('-')
+
+    url = "#{BASE_URL}/currencies/#{id}/historical-data/?start=#{sd}&end=#{ed}"
+    response = HTTP.get(url)
+    html = Nokogiri::HTML(response.body.to_s)
+    rows = html.css('#historical-data table tbody tr')
+
+    prices = rows.each_with_object([]) do |row, arr|
+      td = row.css('td')
+      daily = {
+        date: Date.parse(td[0].text).to_s,
+        open: td[1].text.to_f,
+        high: td[2].text.to_f,
+        low: td[3].text.to_f,
+        close: td[4].text.to_f
+      }
+
+      daily[:average] = ((daily[:high] + daily[:low]).to_d / 2).to_f
+      arr << daily
+    end
+
+    prices
+  end
+end

data/lib/coincapper/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CoinCapper
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: coincapper
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kurt Smith
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: coinmarketcap.com V1 API wrapper including additional historical prices
+  and coin market pairs.
+email:
+- zippydev@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- coincapper.gemspec
+- lib/coincapper.rb
+- lib/coincapper/version.rb
+homepage: https://github.com/kurt-smith/coincapper
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.11
+signing_key: 
+specification_version: 4
+summary: Coin Market Cap V1 API wrapper
+test_files: []