coingecko_ruby 0.3.1 → 0.4.0

data/fixtures/vcr_cassettes/test_that_it_gets_price_for_one_coin_in_a_different_currency.yml

@@ -68,4 +68,53 @@ http_interactions:
       encoding: ASCII-8BIT
       string: '{"bitcoin":{"myr":203620}}'
   recorded_at: Sat, 15 May 2021 14:10:15 GMT
+- request:
+    method: get
+    uri: https://api.coingecko.com/api/v3/simple/price
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 422
+      message: Unprocessable Entity
+    headers:
+      Date:
+      - Mon, 19 Jul 2021 03:15:55 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Vary:
+      - Accept-Encoding, Origin
+      Cache-Control:
+      - no-cache
+      X-Request-Id:
+      - 623b2a81-35ef-4085-a08c-73554740918d
+      X-Runtime:
+      - '0.002243'
+      Cf-Cache-Status:
+      - MISS
+      Expect-Ct:
+      - max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 6710c9bdf91d3d0c-HKG
+      Alt-Svc:
+      - h3-27=":443"; ma=86400, h3-28=":443"; ma=86400, h3-29=":443"; ma=86400, h3=":443";
+        ma=86400
+    body:
+      encoding: ASCII-8BIT
+      string: '{"error":"Missing parameter ids"}'
+  recorded_at: Mon, 19 Jul 2021 03:15:55 GMT
 recorded_with: VCR 6.0.0

data/lib/coingecko_ruby/client.rb

@@ -23,5 +23,11 @@ module CoingeckoRuby
     include CoingeckoRuby::Client::Derivatives
     include CoingeckoRuby::Client::Events
     include CoingeckoRuby::Client::Infos
+
+    attr_reader :client
+
+    def initialize
+      @client = self
+    end
   end
 end

data/lib/coingecko_ruby/client/categories.rb

@@ -6,7 +6,7 @@ module CoingeckoRuby
       # @return [Array<Hash>] each category's id and name
       #
       # @example Get all coin categories.
-      #   client.get_categories
+      #   client.categories
       # @example Sample response object
       #   [{
       #     "category_id" => "recently_added",
@@ -15,16 +15,21 @@ module CoingeckoRuby
       #     "category_id" => "aave-tokens",
       #     "name" => "Aave Tokens"
       #   }]
-      def get_categories
+      def categories
         get 'coins/categories/list'
       end
 
+      # @deprecated Use {#categories} instead
+      def get_categories
+        categories
+      end
+
       # Fetches the list of coin categories with its respective market data.
       #
       # @return [Array<Hash>] each category's id, name, and market data
       #
       # @example Get all coin categories with market data.
-      #   client.get_categories_with_market_data
+      #   client.categories_with_market_data
       # @example Sample response object
       #   [
       #     {
@@ -44,16 +49,21 @@ module CoingeckoRuby
       #       "updated_at" => "2021-05-16T08:20:20.877Z"
       #     }
       #   ]
-      def get_categories_with_market_data
+      def categories_with_market_data
         get 'coins/categories'
       end
 
+      # @deprecated Use {#categories_with_market_data} instead
+      def get_categories_with_market_data
+        categories_with_market_data
+      end
+
       # Fetches the list of asset platforms (e.g. Ethereum, OpenLedger, Counterpart) listed in CoinGecko.
       #
       # @return [Array<Hash>] each asset platform's id, name, short name, and chain identifier
       #
       # @example Get all asset platforms.
-      #   client.get_asset_platforms
+      #   client.asset_platforms
       # @example Sample response object
       #   [
       #     {"id"=>"factom", "chain_identifier"=>nil, "name"=>"Factom", "shortname"=>""},
@@ -62,9 +72,14 @@ module CoingeckoRuby
       #      "name"=>"OpenLedger",
       #      "shortname"=>""}
       #   ]
-      def get_asset_platforms
+      def asset_platforms
         get 'asset_platforms'
       end
+
+      # @deprecated Use {#asset_platforms} instead
+      def get_asset_platforms
+        asset_platforms
+      end
     end
   end
 end

data/lib/coingecko_ruby/client/coins.rb

@@ -3,7 +3,7 @@ module CoingeckoRuby
     module Coins
       # Fetches the id, name, and symbol of every coin supported by CoinGecko's API.
       #
-      # @param include_contract_address [Boolean] displays the coin's platform contract address (e.g. 0x... for ETH-based tokens) 
+      # @option options include_platform [Boolean] displays the coin's platform contract address (e.g. 0x... for ETH-based tokens) 
       #
       # @return [Array<Hash>] returns an array of hashes for every supported coin's id, name, symbol, and platform contract address (optional).
       #
@@ -21,8 +21,8 @@ module CoingeckoRuby
       #       "name" => "0.5X Long Algorand Token"
       #     }, {
       #   ]
-      def coins_list(include_contract_address: false)
-        get 'coins/list', { include_contract_address: include_contract_address }
+      def coins_list(**options)
+        get 'coins/list', options
       end
 
       # Fetches detailed current data for a coin.
@@ -36,16 +36,21 @@ module CoingeckoRuby
       # @return [Hash] returns comprehensive current data for the given coin.
       #
       # @example Fetch Bitcoin's current data.
-      #   client.get_coin_data(id: 'bitcoin')
+      #   client.coin('bitcoin')
+      def coin(id, **options)
+        get "coins/#{id}", options
+      end
+
+      # @deprecated Use {#coin} instead
       def get_coin_data(id:, options: {})
-        get "coins/#{id}", { options: options }
+        coin(id, **options)
       end
 
       # Fetches the list of tickers (e.g: BTC-USD) for a coin
       #
       # @param id [String] the coin id to fetch.
-      # @option options [String] :exchange_id fetch tickers from the given exchange id (e.g. 'binance').
-      # @option options [String] :include_exchange_logo includes the exchange's logo.
+      # @option options [String] :exchange_ids filter ticker results from the given exchange ids (e.g. 'binance, bitfinex').
+      # @option options [Boolean] :include_exchange_logo flag to show the exchange's logo.
       # @option options [Integer] :page sets the page for results.
       # @option options [String] :order ('trust_score_desc') sets the sort order for results. Valid values: trust_score_desc', 'trust_score_asc', 'volume_desc.
       # @option options [Boolean] :depth (false) displays orderbook depth (2%).
@@ -53,7 +58,7 @@ module CoingeckoRuby
       # @return [Hash] returns the list of tickers for the given coin.
       #
       # @example Fetch Bitcoin's tickers.
-      #   client.get_tickers(id: 'bitcoin)
+      #   client.tickers('bitcoin')
       # @example Sample response object (truncated)
       #   {
       #     "name" => "Bitcoin",
@@ -87,7 +92,7 @@ module CoingeckoRuby
       #     }],
       #   }
       # @example Fetch Bitcoin's tickers from Binance with 2% orderbook depth data.
-      #   client.get_tickers(id: 'bitcoin', options: { exchange_id: 'binance', depth: true })
+      #   client.tickers('bitcoin', exchange_id: 'binance', depth: true)
       # @example Sample response object (truncated)
       #   {
       #     "name" => "Bitcoin",
@@ -122,14 +127,19 @@ module CoingeckoRuby
       #       "target_coin_id" => "tether"
       #     }],
       #   }
+      def tickers(id, **options)
+        get "coins/#{id}/tickers", options
+      end
+
+      # @deprecated Use {#tickers} instead
       def get_tickers(id:, options: {})
-        get "coins/#{id}/tickers", { options: options }
+        tickers(id, **options)
       end
 
       # Fetches market data for a coin or a list of coins.
       #
       # @param ids [String] the coin id or ids to fetch.
-      # @param currency [String] the currency to display market price data.
+      # @option options [String] :vs_currency the currency to display market price data.
       # @option options [String] :category filter results by the given coin category.
       # @option options [String] :order ('market_cap_desc') sets the sort order for results. Valid values: market_cap_desc, gecko_desc, gecko_asc, market_cap_asc, market_cap_desc, volume_asc, volume_desc, id_asc, id_desc.
       # @option options [Integer] :per_page (100) sets the number of results to return per page.
@@ -140,7 +150,7 @@ module CoingeckoRuby
       # @return [Array<Hash>] returns market data for the given coin or coins.
       #
       # @example Fetch market data for Bitcoin and Ethereum in USD.
-      #   client.get_markets(ids: 'bitcoin, ethereum', currency: 'gbp')
+      #   client.markets('bitcoin, ethereum', vs_currency: 'gbp')
       # @example Sample response object
       #   [{
       #       "id" => "bitcoin",
@@ -205,10 +215,13 @@ module CoingeckoRuby
       #       "last_updated" => "2021-05-16T07:06:00.946Z"
       #     }
       #   ]
-      # @example Fetch market data for every CoinGecko-supported coin in USD.
-      #   client.get_markets(currency: 'usd')
+      def markets(ids, **options)
+        get 'coins/markets', { ids: ids, **options }
+      end
+
+      # @deprecated Use {#markets} instead
       def get_markets(ids:, currency: 'usd', options: {})
-        get 'coins/markets', { ids: ids, vs_currency: currency, options: options }
+        markets(ids, vs_currency: currency, **options)
       end
     end
   end

data/lib/coingecko_ruby/client/derivatives.rb

@@ -8,7 +8,7 @@ module CoingeckoRuby
       # @return [Array<Hash>] each derivative product's information.
       #
       # @example Get all unexpired derivatives.
-      #   client.get_derivatives(options: { include_tickers: 'unexpired' })
+      #   client.derivatives(include_tickers: 'unexpired')
       # @example Sample response object (truncated)
       #   [
       #     {
@@ -44,8 +44,13 @@ module CoingeckoRuby
       #       "expired_at" => nil
       #     },
       #   ]
+      def derivatives(**options)
+        get 'derivatives', options
+      end
+
+      # @deprecated Use {#derivatives} instead
       def get_derivatives(options: {})
-        get 'derivatives', { options: options }
+        derivatives(**options)
       end
 
       # Fetches the list of derivative exchanges listed in CoinGecko.
@@ -57,7 +62,7 @@ module CoingeckoRuby
       # @return [Array<Hash>] each derivative exchange's information.
       #
       # @example Get one derivative exchange.
-      #   client.get_derivative_exchanges(options: { per_page: 1 })
+      #   client.derivative_exchanges(per_page: 1)
       # @example Sample response object
       #   [{
       #     "name" => "Binance (Futures)",
@@ -73,19 +78,25 @@ module CoingeckoRuby
       #     "description" => "",
       #     "url" => "https://www.binance.com/"
       #   }]
+      def derivative_exchanges(**options)
+        get 'derivatives/exchanges', options
+      end
+
+      # @deprecated Use {#derivative_exchanges} instead
       def get_derivative_exchanges(options: {})
-        get 'derivatives/exchanges', { options: options }
+        derivative_exchanges(**options)
       end
 
       # Fetches data for a specific derivative exchange.
       #
-      # @option options [String] :id the id of the derivative exchange.
+      # @param id [String] the id of the derivative exchange.
+      #
       # @option options [String] :include_tickers determines whether to display all tickers or only show unexpired tickers. Does not return any ticker data if left blank. Valid values: all, unexpired
       #
       # @return [Hash] the derivative exchange's information.
       #
       # @example Get data for the Binance Futures derivative exchange.
-      #   client.get_derivative_exchange(id: 'binance_futures')
+      #   client.derivative_exchange('binance_futures')
       # @example Sample response object
       #   {
       #     "name" => "Binance (Futures)",
@@ -100,8 +111,13 @@ module CoingeckoRuby
       #     "description" => "",
       #     "url" => "https://www.binance.com/"
       #   }
+      def derivative_exchange(id, **options)
+        get "derivatives/exchanges/#{id}", options
+      end
+
+      # @deprecated Use {#derivative_exchange} instead
       def get_derivative_exchange(id:, options: {})
-        get "derivatives/exchanges/#{id}", { options: options }
+        derivative_exchange(id, **options)
       end
 
       # Fetches the list ids and names of derivative exchanges listed in CoinGecko.
@@ -109,7 +125,7 @@ module CoingeckoRuby
       # @return [Array<Hash>] each derivative exchange's id and name.
       #
       # @example Get all unexpired derivatives.
-      #   client.get_derivative_exchanges_ids_and_names
+      #   client.derivative_exchanges_ids_and_names
       # @example Sample response object (truncated)
       #   [
       #     {
@@ -125,9 +141,14 @@ module CoingeckoRuby
       #       "name" => "FTX (Derivatives)"
       #     }
       #   ]
-      def get_derivative_exchanges_ids_and_names
+      def derivative_exchanges_ids_and_names
         get 'derivatives/exchanges/list'
       end
+
+      # @deprecated Use {#derivative_exchanges_ids_and_names} instead
+      def get_derivative_exchanges_ids_and_names
+        derivative_exchanges_ids_and_names
+      end
     end
   end
 end

data/lib/coingecko_ruby/client/events.rb

@@ -14,9 +14,14 @@ module CoingeckoRuby
       # @return [Array<Hash>] each finance platform's name, category, url, facts (description), and centralized status.
       #
       # @example Get all upcoming events.
-      #   client.get_events(options: { upcoming_events_only: true })
+      #   client.events(upcoming_events_only: true) 
+      def events(**options)
+        get 'events', options
+      end
+
+      # @deprecated Use {#events} instead
       def get_events(options: {})
-        get 'events', { options: options }
+        events(**options)
       end
 
       # Fetches the valid list of countries to fetch events from.
@@ -24,7 +29,7 @@ module CoingeckoRuby
       # @return [Hash] each country's name and code and the total country count.
       #
       # @example Get all event countries.
-      #   client.get_event_countries
+      #   client.event_countries
       # @example Sample response object (truncated)
       #   {
       #     "data" => [{
@@ -46,24 +51,34 @@ module CoingeckoRuby
       #     ],
       #     "count" => 4
       #   }
-      def get_event_countries
+      def event_countries
         get 'events/countries'
       end
 
+      # @deprecated Use {#event_countries} instead
+      def get_event_countries
+        event_countries
+      end
+
       # Fetches the valid list of events to fetch.
       #
       # @return [Array<Hash>] the list of event types and total event types count.
       #
       # @example Get all event types.
-      #   client.get_event_types
+      #   client.event_types
       # @example Sample response object
       #   {
       #     "data" => ["Event", "Conference", "Meetup"],
       #     "count" => 3
       #   }
-      def get_event_types
+      def event_types
         get 'events/types'
       end
+
+      # @deprecated Use {#event_types} instead
+      def get_event_types
+        event_types
+      end
     end
   end
 end

data/lib/coingecko_ruby/client/exchanges.rb

@@ -9,7 +9,7 @@ module CoingeckoRuby
       # @return [Array<Hash>] returns an array of hashes of detailed exchange data.
       #
       # @example Fetch complete exchange data with 1 result per page.
-      #   client.get_exchanges(options: { per_page: 1 })
+      #   client.exchanges(per_page: 1)
       # @example Sample response object
       #   [{
       #     "id" => "binance",
@@ -25,8 +25,13 @@ module CoingeckoRuby
       #     "trade_volume_24h_btc" => 982949.3975723931,
       #     "trade_volume_24h_btc_normalized" => 982949.3975723931
       #   }]
+      def exchanges(**options)
+        get 'exchanges', options
+      end
+
+      # @deprecated Use {#exchanges} instead
       def get_exchanges(options: {})
-        get 'exchanges', { options: options }
+        exchanges(**options)
       end
 
       # Fetches complete data for a specific exchange.
@@ -36,17 +41,22 @@ module CoingeckoRuby
       # @return [Hash] returns detailed data for the given exchange.
       #
       # @example Fetch complete exchange data for Binance.
-      #   client.get_exchange_data(id: 'binance')
-      def get_exchange_data(id:)
+      #   client.exchange('binance')
+      def exchange(id)
         get "exchanges/#{id}"
       end
 
+      # @deprecated Use {#exchange} instead
+      def get_exchange_data(id:)
+        exchange(id)
+      end
+
       # Fetches exchange ids for every exchange currently supported by the CoinGecko API.
       #
       # @return [Array<Hash>] returns an array of hashes of the exchange id and name.
       #
       # @example Fetch all exchange ids.
-      #   client.get_exchanges_ids
+      #   client.exchange_ids
       # @example Sample response object
       #   [{
       #     "id" => "aave",
@@ -58,13 +68,19 @@ module CoingeckoRuby
       #     "id" => "aax_futures",
       #     "name" => "AAX Futures"
       #   }]
-      def get_exchanges_ids
+      def exchange_ids
         get 'exchanges/list'
       end
 
+      # @deprecated Use {#exchange_ids} instead
+      def get_exchanges_ids
+        exchange_ids
+      end
+
       # Fetches coin tickers from a specific exchange.
       #
       # @param id [String] the exchange id to fetch.
+      #
       # @option options [String] :coin_ids comma-separated list of tickers to fetch from the given exchange id (e.g. 'bitcoin, eth, litecoin').
       # @option options [String] :include_exchange_logo includes the exchange's logo.
       # @option options [Integer] :page sets the page for results.
@@ -74,7 +90,7 @@ module CoingeckoRuby
       # @return [Hash] the exchange name and tickers as provided or all tickers if coin_ids is not provided.
       #
       # @example Get Bitcoin tickers from Binance.
-      #   client.get_exchange_tickers(id: 'binance', options: { coin_ids: 'bitcoin' })
+      #   client.exchange_tickers('binance', coin_ids: 'bitcoin')
       # @example Sample response object
       #   {
       #     "name" => "Binance", "tickers" => [{
@@ -104,20 +120,26 @@ module CoingeckoRuby
       #       "target_coin_id" => "tether"
       #     }]
       #   }
+      def exchange_tickers(id, **options)
+        get "exchanges/#{id}/tickers", options
+      end
+
+      # @deprecated Use {#exchange_tickers} instead
       def get_exchange_tickers(id:, options: {})
-        get "exchanges/#{id}/tickers", { options: options }
+        exchange_tickers(id, **options)
       end
 
       # Fetches news,announcments, and updates from a specific exchange.
       #
       # @param id [String] the exchange id to fetch.
+      #
       # @option options [Integer] :per_page (100) sets the number of results to return per page.
       # @option options [Integer] :page sets the page for results.
       #
       # @return [Hash] the status update data for the given exchange.
       #
       # @example Get the last 3 status updates from Binance.
-      #   client.get_exchange_status_updates(id: 'binance', options: { per_page: 1 })
+      #   client.exchange_status('binance', per_page: 1)
       # @example Sample response object
       #   {
       #     "status_updates" => [{
@@ -134,27 +156,37 @@ module CoingeckoRuby
       #       }
       #     }]
       #   }
+      def exchange_status(id, **options)
+        get "exchanges/#{id}/status_updates", options
+      end
+
+      # @deprecated Use {#exchange_status} instead
       def get_exchange_status_updates(id:, options: {})
-        get "exchanges/#{id}/status_updates", { options: options }
+        exchange_status(id, **options)
       end
 
       # Fetches trade volume data from a specific exchange.
       #
       # @param id [String] the exchange id to fetch.
-      # @param days [Integer] number of days ago to fetch trade volume data.
+      # @param days [Integer] number of days ago to fetch trade volume data. Defaults to 7 days.
       #
       # @return [Array<Array<Float, String>>] the exchange's trade volume data in 10-minute intervals, hourly intervals, or daily intervals depending on the number of days given
       #
       # @example Get Binance's trade volume from a day ago.
-      #   client.get_exchange_volume(id: 'binance', days: 1)
+      #   client.exchange_volume('binance', days: 1)
       # @example Sample response object (truncated)
       #   [
       #     [1620550200000.0, "1005476.2667217359131632087795432176371669876601688256288859094077173967202827700534809705802"], # [UNIX timestamp for exchange trade volume data, trade volume]
       #     [1620553800000.0, "1018442.2775982988468591292487708941265043962519659923872972786095536137127193126138169804088"],
       #     [1620557400000.0, "1042158.4333253484568599192332614201045319574863305612009609211497295171074087677404153278624"]
       #   ]
+      def exchange_volume(id, days: 7, **options)
+        get "exchanges/#{id}/volume_chart", { days: days, **options }
+      end
+
+      # @deprecated Use {#exchange_volume} instead
       def get_exchange_volume(id:, days:)
-        get "exchanges/#{id}/volume_chart", { days: days }
+        exchange_volume(id, days: days)
       end
     end
   end