coin_market_pro 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4c96f4eac050e2cca43487f3587c459a6f7abf6842102b2bb46dd3ca63441ba
-  data.tar.gz: 6afc15d173a654b54956de14d580bef88f577699813468020a13ed8621e3df5d
+  metadata.gz: e5d17f07be79da69922c5737daa7e9d0c518ce5f3d082a0b530c6478f332096e
+  data.tar.gz: af126477e9dfa0fea53b1e6e8eab8db454bf722592e164ee53e538149913c1bd
 SHA512:
-  metadata.gz: 249644538690c41eca62ca0082de2824f925f2e4acc3f831bc3f3469da1b8541d2698972ee44c2d65dafae81baaefde2795ecda9a0873aaa0e498e523f30ff30
-  data.tar.gz: d4ca79f7adbb38a2bf18623aade6ae6bcb92ddbee9042ee1820717a39859fdc6a56cad98b39a916163238607d03db050f574b115954667aeeebc9f21d847f89b
+  metadata.gz: 6a0e6ab9fac771c8393d97452d89169b920ef7a37adc5d192b623ab5dd497254e625ab8e45518c247b46999d8604e8d407992b20a14cc86587444e6c25fa549a
+  data.tar.gz: 448c47f2cd89f66ae37754c79f03c2a1db9c9eba74839cdaa2459a1999b1961dc664322b2e7b530907071795ee8a28479cd86281a9fc4af7a360c6c65e2872d3

data/.gitignore

@@ -10,4 +10,4 @@
 # rspec failure tracking
 .rspec_status
 
-.gem
+*.gem

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    coin_market_pro (0.1.0)
-      activesupport (>= 4.2)
+    coin_market_pro (0.1.1)
+      activesupport (~> 5.1)
       multi_json (~> 1.13)
       rest-client (~> 2.0)
 
@@ -82,7 +82,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.16)
   coin_market_pro!
-  pry
+  pry (~> 0.11)
   rake (~> 12.3)
   rspec (~> 3.8)
   simplecov (~> 0.16)

data/README.md

@@ -6,10 +6,10 @@ The CoinMarketCap Professional API is a suite of high-performance RESTful JSON e
 
 ## Available Endpoints:
 
-* [Cryptocurrency](####Cryptocurrency)
-* [Exchange](####Exchange)
-* [Global Metrics](####Global Metrics)
-* [Tools](####Global Metrics)
+* [Cryptocurrency](#cryptocurrency)
+* [Exchange](#exchange)
+* [Global Metrics](#global-metrics)
+* [Tools](#tools)
 
 ## Installation
 
@@ -26,26 +26,27 @@ Or install it yourself as:
 
 ## Environment Variables
 
-| Variable                  |  Description          | Default   |
-| --------------------------|:----------------------|:---------:|
-| `COIN_MARKET_PRO_API_KEY` | CoinMarketCap API Key | -         |
+| Variable          |  Description              | Default   |
+| ------------------|:--------------------------|:---------:|
+| `CMC_PRO_API_KEY` | CoinMarketCap Pro API Key | -         |
 
 ## Usage
 
 ### Initialize CoinMarketPro
 
-Client Api Key defaults to `COIN_MARKET_PRO_API_KEY` ENV. Override the client with `api_key` param.
+Client Api Key defaults to `CMC_PRO_API_KEY` ENV. Override the client with `api_key` param.
 
 ```ruby
   # Rails Example
   #
   # config/initializers/coin_market_pro.rb
   module CoinMarketPro
-    Api ||= CoinMarketPro.new(api_key: 'Coinbase-Pro-Api-Key', logger: Rails.logger)
+    # Testing endpoint available with sandbox: true option
+    Api ||= CoinMarketPro.new(api_key: 'CMC-Pro-Api-Key', logger: Rails.logger)
   end
 
   # Ruby
-  client = CoinMarketPro.new(api_key: 'Coinbase-Pro-Api-Key')
+  client = CoinMarketPro.new(api_key: 'CMC-Pro-Api-Key')
 ```
 
 ### [Common Errors](https://pro.coinmarketcap.com/api/v1#section/Errors-and-Rate-Limits)
@@ -62,77 +63,9 @@ Client Api Key defaults to `COIN_MARKET_PRO_API_KEY` ENV. Override the client wi
 
 Response object returned as hash with keys: `status`, `code`, `headers`, `body`, `raw`. For consistency, `body` will always be returned as an array.
 
-```ruby
-# Using `client` defined from above
-
-client.cryptocurrency.info(id: [1])
-# => #<CoinMarketPro::Client::Result:0x00007f9045657d18
-#  @body=
-#   [{:urls=>
-#      {:website=>["https://bitcoin.org/"],
-#       :twitter=>[],
-#       :reddit=>["https://reddit.com/r/bitcoin"],
-#       :message_board=>["https://bitcointalk.org"],
-#       :announcement=>[],
-#       :chat=>[],
-#       :explorer=>["https://blockchain.info/", "https://live.blockcypher.com/btc/", "https://blockchair.com/bitcoin/blocks"],
-#       :source_code=>["https://github.com/bitcoin/"]},
-#     :logo=>"https://s2.coinmarketcap.com/static/img/coins/64x64/1.png",
-#     :id=>1,
-#     :name=>"Bitcoin",
-#     :symbol=>"BTC",
-#     :slug=>"bitcoin",
-#     :date_added=>"2013-04-28T00:00:00.000Z",
-#     :tags=>["mineable"],
-#     :category=>"coin"}],
-#  @code=200,
-#  @headers=
-#   {:content_type=>"application/json; charset=utf-8",
-#    :transfer_encoding=>"chunked",
-#    :connection=>"keep-alive",
-#    :date=>"Mon, 08 Oct 2018 02:04:13 GMT",
-#    :server=>"nginx",
-#    :vary=>"origin,accept-encoding",
-#    :access_control_expose_headers=>"WWW-Authenticate,Server-Authorization",
-#    :cache_control=>"no-cache",
-#    :content_encoding=>"gzip",
-#    :x_cache=>"Miss from cloudfront",
-#    :via=>"1.1 39f9e0f028321e95b5ebd1cd55661fd6.cloudfront.net (CloudFront)",
-#    :x_amz_cf_id=>"uQcyrXXRjyNb_oFO5hlXDAAX9TgYvmUXUaXujxxzYgRfoq_XleXjhQ=="},
-#  @raw=
-#   {:status=>{:timestamp=>"2018-10-08T02:04:13.628Z", :error_code=>0, :error_message=>nil, :elapsed=>11, :credit_count=>1},
-#    :data=>
-#     {:"1"=>
-#       {:urls=>
-#         {:website=>["https://bitcoin.org/"],
-#          :twitter=>[],
-#          :reddit=>["https://reddit.com/r/bitcoin"],
-#          :message_board=>["https://bitcointalk.org"],
-#          :announcement=>[],
-#          :chat=>[],
-#          :explorer=>
-#           ["https://blockchain.info/", "https://live.blockcypher.com/btc/", "https://blockchair.com/bitcoin/blocks"],
-#          :source_code=>["https://github.com/bitcoin/"]},
-#        :logo=>"https://s2.coinmarketcap.com/static/img/coins/64x64/1.png",
-#        :id=>1,
-#        :name=>"Bitcoin",
-#        :symbol=>"BTC",
-#        :slug=>"bitcoin",
-#        :date_added=>"2013-04-28T00:00:00.000Z",
-#        :tags=>["mineable"],
-#        :category=>"coin"}}},
-#  @status=
-#   {:timestamp=>"2018-10-08T02:04:13.628Z",
-#    :error_code=>0,
-#    :error_message=>nil,
-#    :elapsed=>11,
-#    :credit_count=>1,
-#    :result=>:success}>
-```
-
-### Endpoints
+## Endpoints
 
-#### [Cryptocurrency](https://pro.coinmarketcap.com/api/v1#tag/cryptocurrency)
+## [Cryptocurrency](https://pro.coinmarketcap.com/api/v1#tag/cryptocurrency)
 
 ##### [Info/Metadata](https://pro.coinmarketcap.com/api/v1#operation/getV1CryptocurrencyInfo)
 
@@ -336,7 +269,7 @@ Get the latest market quote for 1 or more cryptocurrencies. Use the "convert" op
   client.cryptocurrency.quotes(id: [1]).body
 ```
 
-#### [Exchange](https://pro.coinmarketcap.com/api/v1#tag/exchange)
+## [Exchange](https://pro.coinmarketcap.com/api/v1#tag/exchange)
 
 ##### [Info/Metadata](https://pro.coinmarketcap.com/api/v1#operation/getV1ExchangeInfo)
 
@@ -428,7 +361,7 @@ Get the latest 24 hour volume quote for 1 or more exchanges. Additional market d
   client.exchange.quotes(id: [1, 2])
 ```
 
-#### [Global Metrics](https://pro.coinmarketcap.com/api/v1#tag/global-metrics)
+## [Global Metrics](https://pro.coinmarketcap.com/api/v1#tag/global-metrics)
 
 ##### [Quotes (Historical)](https://pro.coinmarketcap.com/api/v1#operation/getV1GlobalmetricsQuotesHistorical)
 
@@ -460,7 +393,7 @@ Get the latest quote of aggregate market metrics. Use the "convert" option to re
   client.global_metrics.quotes
 ```
 
-#### [Tools](https://pro.coinmarketcap.com/api/v1#tag/tools)
+## [Tools](https://pro.coinmarketcap.com/api/v1#tag/tools)
 
 ##### [Price conversion](https://pro.coinmarketcap.com/api/v1#operation/getV1ToolsPriceconversion)
 

data/lib/coin_market_pro.rb

@@ -6,6 +6,11 @@ require_relative 'coin_market_pro/client/base'
 module CoinMarketPro
   module_function
 
+  # @param args [Hash]
+  # @param args [String] :api_key Required. Defaults to CMC_PRO_API_KEY
+  # @param args [Boolean] :sandbox Defaults to false
+  # @param args [Logger] :logger Defaults to Logger.new(STDOUT)
+  # @param args [Integer] :timeout Defaults to 10
   def new(**args)
     Client::Base.new(args)
   end

data/lib/coin_market_pro/client/base.rb

@@ -16,15 +16,23 @@ module CoinMarketPro
     end
 
     class Base
-      attr_reader :host, :api_key, :logger, :cryptocurrency, :exchange, :global_metrics, :tools
+      attr_reader :host, :api_key, :sandbox, :logger, :cryptocurrency, :exchange, :global_metrics, :tools
 
-      API_DOMAIN = 'https://pro-api.coinmarketcap.com'
+      API_DOMAIN = 'https://SUBDOMAIN.coinmarketcap.com'
       API_VERSION = 'v1'
       API_URL = "#{API_DOMAIN}/#{API_VERSION}"
       DEFAULT_TIMEOUT = 10
-
-      def initialize(api_key: ENV.fetch('COIN_MARKET_PRO_API_KEY'), logger: Logger.new(STDOUT), timeout: DEFAULT_TIMEOUT)
-        @host = API_URL
+      PRO_SUBDOMAIN = 'pro-api'
+      SANDBOX_SUBDOMAIN = 'sandbox'
+
+      # @param api_key [String] Required. Defaults to CMC_PRO_API_KEY
+      # @param sandbox [Boolean] Defaults to false
+      # @param logger [Logger]
+      # @param timeout [Integer] Defaults to DEFAULT_TIMEOUT
+      def initialize(api_key: ENV.fetch('CMC_PRO_API_KEY'), sandbox: false,
+                     logger: Logger.new(STDOUT), timeout: DEFAULT_TIMEOUT)
+        @sandbox = sandbox
+        @host = @sandbox ? API_URL.gsub('SUBDOMAIN', SANDBOX_SUBDOMAIN) : API_URL.gsub('SUBDOMAIN', PRO_SUBDOMAIN)
         @api_key = api_key
         @logger = logger
         @timeout = timeout
@@ -112,6 +120,11 @@ module CoinMarketPro
         @open_timeout || DEFAULT_TIMEOUT
       end
 
+      # @return [Boolean]
+      def sandbox?
+        sandbox
+      end
+
       private
 
       # @return [Boolean]

data/lib/coin_market_pro/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CoinMarketPro
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coin_market_pro
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - snogrammer