coingecko_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2d4ca5a09aa9298cb8612205166f45778d4fcb5ccdcdd78b7e801b70b941f80f
+  data.tar.gz: 7730cf32e62d09879c8288ea5188ee3e1d8f8d491d21e1fbd4dce9c714c177b8
+SHA512:
+  metadata.gz: b4ca439622cddb324295ffc518b45318d72899402360a42543e83f5b90959b444c494cfd5797bfc255c3d0a88afa5bc2df8afe03d4bc418d8bb18b59de87b325
+  data.tar.gz: 55d787ce4dbd09cd6915eeabb987b94402eb3345b210d7b4f748d1d147b97d2a415b899e88640702c0f93f6bc75ce363b3e091f45d4a601b0926beba30c328f6

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Julian Foo Siang Sen
+
+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,72 @@
+# CoingeckoRuby
+
+CoingeckoRuby is an easy-to-use client/wrapper for CoinGecko's awesome cryptocurrency API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'coingecko_ruby'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install coingecko_ruby
+
+## Usage
+
+1. Require the gem.
+
+```ruby
+require 'coingecko_ruby'
+```
+
+2. Create a client instance.
+
+```ruby
+client = CoingeckoRuby.client
+```
+
+3. Use the client to fetch your desired data.
+
+```ruby
+# Example: Fetching the current price of Bitcoin
+client.get_prices(ids: 'bitcoin', vs_currencies: 'usd')
+```
+
+## Documentation
+
+WORK IN PROGRESS
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/julianfssen/coingecko_ruby.
+
+## License
+
+MIT License
+
+Copyright (c) 2021 Julian Foo Siang Sen
+
+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/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/coingecko_ruby.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/coingecko_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "coingecko_ruby"
+  spec.version       = CoingeckoRuby::VERSION
+  spec.authors       = ["Julian Foo Siang Sen"]
+  spec.email         = ["juliandevmy@gmail.com"]
+
+  spec.summary       = %q{An easy-to-use client/wrapper for CoinGecko's crypto API}
+  spec.description   = %q{An easy-to-use client/wrapper for CoinGecko's crypto API. Get prices, exchanges, volume, and more without building your own API class.}
+  spec.homepage      = "https://github.com/julianfssen/coingecko_ruby"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/julianfssen/coingecko_ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/julianfssen/coingecko_ruby"
+
+  # 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.files = %w(LICENSE.md README.md Rakefile coingecko_ruby.gemspec)
+  spec.files += Dir.glob("lib/**/*.rb")
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/coingecko_ruby.rb

@@ -0,0 +1,10 @@
+require "coingecko_ruby/version"
+require "coingecko_ruby/client"
+
+module CoingeckoRuby
+  class << self
+    def client
+      @client = CoingeckoRuby::Client.new
+    end
+  end
+end

data/lib/coingecko_ruby/client.rb

@@ -0,0 +1,13 @@
+require 'coingecko_ruby/connection'
+require 'coingecko_ruby/client/status'
+require 'coingecko_ruby/client/prices'
+require 'coingecko_ruby/client/coins'
+
+module CoingeckoRuby
+  class Client
+    include CoingeckoRuby::Connection
+    include CoingeckoRuby::Client::Status
+    include CoingeckoRuby::Client::Prices
+    include CoingeckoRuby::Client::Coins
+  end
+end

data/lib/coingecko_ruby/client/coins.rb

@@ -0,0 +1,25 @@
+module CoingeckoRuby
+  class Client
+    module Coins
+      def coins_list
+        get('coins/list')
+      end
+
+      def get_coin_data(id:)
+        get("coins/#{id}")
+      end
+
+      def get_coin_tickers(id:)
+        get("coins/#{id}")
+      end
+
+      def get_coin_data(id:)
+        get("coins/#{id}")
+      end
+
+      def markets
+        get('coins/markets')
+      end
+    end
+  end
+end

data/lib/coingecko_ruby/client/prices.rb

@@ -0,0 +1,27 @@
+module CoingeckoRuby
+  class Client
+    module Prices
+      def get_prices(ids:, vs_currencies: 'usd')
+        get('simple/price', { query: { ids: ids, vs_currencies: vs_currencies } })
+      end
+
+      def get_historical_price_on_date(id:, date:)
+        get("coins/#{id}/history", { query: { date: date } })
+      end
+
+      def get_minutely_historical_prices(id:, vs_currency: 'usd')
+        get("coins/#{id}/market_chart", { query: { vs_currency: vs_currency, days: 1 } })
+      end
+
+      def get_hourly_historical_prices(id:, days:)
+        return get_daily_historical_prices(id: id, days: days) if days > 90
+
+        get("coins/#{id}/market_chart", { query: { vs_currency: vs_currency, days: days } })
+      end
+
+      def get_daily_historical_prices(id:, days:)
+        get("coins/#{id}/market_chart", { query: { vs_currency: vs_currency, days: days, interval: 'daily' } })
+      end
+    end
+  end
+end

data/lib/coingecko_ruby/client/status.rb

@@ -0,0 +1,9 @@
+module CoingeckoRuby
+  class Client
+    module Status
+      def status
+        get('ping')
+      end
+    end
+  end
+end

data/lib/coingecko_ruby/connection.rb

@@ -0,0 +1,26 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+module CoingeckoRuby
+  module Connection
+    BASE_URL = 'https://api.coingecko.com/api/v3/'
+
+    def get(endpoint, options = {})
+      url = BASE_URL + endpoint
+      uri = URI(url)
+      if options[:query]
+        uri = build_params(uri, options[:query])
+      end
+      response = Net::HTTP.get(uri)
+      JSON.parse(response)
+    end
+
+    private
+
+    def build_params(uri, params)
+      uri.query = URI.encode_www_form(params)
+      uri
+    end
+  end
+end

data/lib/coingecko_ruby/version.rb

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

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: coingecko_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julian Foo Siang Sen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-05-13 00:00:00.000000000 Z
+dependencies: []
+description: An easy-to-use client/wrapper for CoinGecko's crypto API. Get prices,
+  exchanges, volume, and more without building your own API class.
+email:
+- juliandevmy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- Rakefile
+- coingecko_ruby.gemspec
+- lib/coingecko_ruby.rb
+- lib/coingecko_ruby/client.rb
+- lib/coingecko_ruby/client/coins.rb
+- lib/coingecko_ruby/client/prices.rb
+- lib/coingecko_ruby/client/status.rb
+- lib/coingecko_ruby/connection.rb
+- lib/coingecko_ruby/version.rb
+homepage: https://github.com/julianfssen/coingecko_ruby
+licenses: []
+metadata:
+  homepage_uri: https://github.com/julianfssen/coingecko_ruby
+  source_code_uri: https://github.com/julianfssen/coingecko_ruby
+  changelog_uri: https://github.com/julianfssen/coingecko_ruby
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: An easy-to-use client/wrapper for CoinGecko's crypto API
+test_files: []