market_data 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c83d3644178f120e069d283ebfc132d543ac8dbe2aca9734388d2cd56274bf7c
-  data.tar.gz: eeef52d93f45e64b4869749bd787b0af576924a0b617e8897c4eada6dcf813b2
+  metadata.gz: 76061b4644a7a3092a819581faa9b7141dfb88e064b3a78a3615aa4c76ac1b0a
+  data.tar.gz: '09d87650d7235f8419524a0bb4cba5a43dd1d8d1a4e0eae4cb1b2cc24fc27dbf'
 SHA512:
-  metadata.gz: b01a71a756244d6461e19cad34abb3b25df2705b43e03e47a936a66a471879f8ae0038e49ab01f062ec0db4c046e40e2d80d3162a5c065f535ffa7877efed548
-  data.tar.gz: fe1a289aa65eb0e6a0682b9e263a232f0eb2b913a808b9c6ac5271e46b52123a4c805a586bc5b2a1b9aeda92c17fb640815e6230907a9dcf6a0c5379bcd34b59
+  metadata.gz: d369b7b3d1e391decd1679262e2c0f9ef8fe20463aac5ef3ebc05ce00a46c86ea94d13441e8d8d2f76ed78220a3f45b99f3cb4caf80da52d115b8e97d54fdb7f
+  data.tar.gz: 50a5fc1e57d70f12722d84ecac720a4649a1e71ea6f4fa12f7d521f15b2ca8940c19f95e33f93d78b2b998e299f015091812a033b61011f6a1d80ea07a98c84e

data/CHANGELOG.md

@@ -29,4 +29,12 @@
 ## [0.3.0] - 2024-10-09
 
 - Add support for Earnings endpoint under the `earnings` method
-- Introduced `Validations` module for parameter validation logic
+- Introduced `Validations` module for parameter validation logic
+
+## [0.4.0] - 2024-10-14
+
+- Add support for Markets status endpoint under the `market_status` method
+
+## [0.5.0] - 2024-10-15
+
+- Add support for Indexes endpoints under `index_quote` and `ìndex_candles`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    market_data (0.1.2)
+    market_data (0.4.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -2,7 +2,7 @@
 
 A Ruby wrapper for the [MarketData API](https://www.marketdata.app/docs/api).
 
-![coverage](https://img.shields.io/badge/coverage%3A-87.77%25-yellow.svg)
+![coverage](https://img.shields.io/badge/coverage%3A-87.68%25-yellow.svg)
 
 ## Installation
 
@@ -139,11 +139,11 @@ From Stocks endpoints:
 - [X] Earnings
 
 From Markets endpoints:
-- [ ] Status
+- [X] Status
 
 From Indices endpoints:
-- [ ] Quotes
-- [ ] Candles
+- [X] Quotes
+- [X] Candles
 
 From Stocks endpoints:
 - [ ] Support for optional parameters for Candles

data/lib/market_data/conn.rb

@@ -6,6 +6,18 @@ module MarketData
   module Conn
     include MarketData::Errors
 
+    def do_request path, query
+      path_hash = {
+        host: MarketData.base_host,
+        path: path,
+      }
+      path_hash[:query] = URI.encode_www_form(query) unless query.empty?
+        
+      do_connect(
+        get_uri path_hash
+      )
+    end
+
     def do_connect(path)
       begin
         conn = URI.open(path, get_auth_headers) 

data/lib/market_data/constants.rb

@@ -47,5 +47,26 @@ module MarketData
       high52: "high52",
       low52: "low52",
     }
+    MARKET_STATUS_FIELD_MAPPING = {
+      date: "date",
+      status: "status"
+    }
+    INDEX_QUOTE_FIELD_MAPPING = {
+      symbol: "symbol",
+      last: "last",
+      change: "change",
+      change_pct: "changepct",
+      high52: "52weekHigh",
+      low52: "52weekLow",
+      updated: "updated",
+    }
+    INDEX_CANDLE_FIELD_MAPPING = {
+      symbol: "symbol",
+      open: "o",
+      close: "c",
+      low: "l",
+      high: "h",
+      time: "t",
+    }
   end
 end

data/lib/market_data/indexes.rb

@@ -0,0 +1,27 @@
+module MarketData
+  module Indexes
+    include MarketData::Conn
+    include MarketData::Mappers
+    include MarketData::Validations
+
+    @@quotes = "/v1/indices/quotes/"
+    @@candles = "/v1/indices/candles/"
+
+    def index_quote(symbol, opts = {w52: nil})
+      query = validate_index_quote_input!(**opts)
+
+      map_index_quote(
+        do_request(@@quotes + symbol, query)
+      )
+    end
+
+    def index_candles(symbol, opts = {resolution: nil, from: nil, to: nil, countback: nil})
+      query = validate_index_candles_input!(**opts)
+
+      map_index_candles(
+        do_request("#{@@candles}#{opts[:resolution]}/#{symbol}", query),
+        symbol
+      )
+    end
+  end
+end

data/lib/market_data/mappers.rb

@@ -5,6 +5,7 @@ module MarketData
     include MarketData::Models
     SYMBOL_RESPONSE_KEY = "symbol"
     STATUS_RESPONSE_KEY = "s"
+    OPEN_RESPONSE_KEY = "o"
 
     def map_quote response, i=0
       Quote.new(**map_fields_for(response, :quote, i))
@@ -21,7 +22,7 @@ module MarketData
 
     def map_candles response, symbol
       ar = []
-      (0..(response["o"].size - 1)).each do |i|
+      (0..(response[OPEN_RESPONSE_KEY].size - 1)).each do |i|
         args = map_fields_for(response, :candle, i)
         args[:symbol] = symbol
         ar << Candle.new(**args)
@@ -47,6 +48,27 @@ module MarketData
       ar
     end
 
+    def map_market_status response
+      MarketData::Models::MarketStatus.new(
+        date: response["date"][0],
+        status: response["status"][0],
+      )
+    end
+    
+    def map_index_quote response
+      IndexQuote.new(**map_fields_for(response, :index_quote))
+    end
+
+    def map_index_candles response, symbol
+      ar = []
+      (0..(response[OPEN_RESPONSE_KEY].size - 1)).each do |i|
+        args = map_fields_for(response, :index_candle, i)
+        args[:symbol] = symbol
+        ar << Models::IndexCandle.new(**args)
+      end
+      ar
+    end
+
     def map_fields_for(response, kind, i=0)
       mapping = {}
       case kind
@@ -54,6 +76,10 @@ module MarketData
         mapping = Constants::CANDLE_FIELD_MAPPING
       when :earning
         mapping = Constants::EARNING_FIELD_MAPPING
+      when :index_candle
+        mapping = Constants::INDEX_CANDLE_FIELD_MAPPING
+      when :index_quote
+        mapping = Constants::INDEX_QUOTE_FIELD_MAPPING
       when :quote
         mapping = Constants::QUOTE_FIELD_MAPPING
       else

data/lib/market_data/markets.rb

@@ -0,0 +1,17 @@
+module MarketData
+  module Markets
+    include MarketData::Validations  
+    
+    @@status = "/v1/markets/status/"
+    
+    def market_status(country: nil, date: nil, from: nil, to: nil, countback: nil)
+      query =  validate_market_status_input!(country: country, date: date, from: from, to: to, countback: countback)
+
+      path_hash = { host: MarketData.base_host, path: @@status }
+      path_hash[:query] = URI.encode_www_form(query)
+      
+      res = do_connect(get_uri path_hash)
+      map_market_status res
+    end
+  end
+end

data/lib/market_data/models.rb

@@ -15,5 +15,11 @@ module MarketData
     end
 
     Earning = Struct.new(*Constants::EARNING_FIELD_MAPPING.keys)
+    
+    MarketStatus = Struct.new(*Constants::MARKET_STATUS_FIELD_MAPPING.keys)
+    
+    IndexQuote = Struct.new(*Constants::INDEX_QUOTE_FIELD_MAPPING.keys)
+
+    IndexCandle = Struct.new(*Constants::INDEX_CANDLE_FIELD_MAPPING.keys)
   end
 end

data/lib/market_data/quotes.rb

@@ -18,24 +18,18 @@ module MarketData
 
     def quote(symbol, w52 = false, extended = false)
       query = validate_quotes_input!(symbol: symbol, w52: w52, extended: extended)
-      
-      path_hash = { host: MarketData.base_host, path: @@single + symbol }
-      if !query.empty?
-        path_hash[:query] = URI.encode_www_form(query)
-      end
-      
-      res = do_connect(get_uri path_hash)
-      map_quote(res)
+
+      map_quote(
+        do_request @@single + symbol, query
+      )
     end
 
     def bulk_quotes(symbols, snapshot = false, extended = false)
       query = validate_bulk_quotes_input!(symbols: symbols, snapshot: snapshot, extended: extended)
       
-      path_hash = { host: MarketData.base_host, path: @@bulk  }
-      path_hash[:query] = URI.encode_www_form(query)
-
-      res = do_connect(get_uri path_hash)
-      map_bulk_quotes res
+      map_bulk_quotes(
+        do_request @@bulk, query
+      )
     end
   
     def candles(symbol, opts = {})
@@ -43,31 +37,27 @@ module MarketData
       opts = defaults.merge(opts)
       query =  validate_candles_input!(**opts)
       
-      path_hash = { host: MarketData.base_host, path: @@candles + opts[:resolution] + "/" + symbol }
-      path_hash[:query] = URI.encode_www_form(query)
-      
-      res = do_connect(get_uri path_hash)
-      map_candles res, symbol
+      map_candles(
+        do_request(@@candles + opts[:resolution] + "/" + symbol, query),
+        symbol
+      )
     end
 
     def bulk_candles(symbols, resolution = "D")
       query = validate_bulk_candles_input!(symbols: symbols, resolution: resolution)
       query = query.except(:resolution)
       
-      path_hash = { host: MarketData.base_host, path: @@bulk_candles + resolution + "/" }
-      path_hash[:query] = URI.encode_www_form(query)
-      
-      res = do_connect(get_uri path_hash)
-      map_bulk_candles res
+      map_bulk_candles(
+        do_request @@bulk_candles + resolution + "/", query
+      )
     end
 
     def earnings(symbol, opts = {from: nil, to: nil, countback: nil, date: nil, report: nil})
-      path_hash = { host: MarketData.base_host(), path: @@earnings + symbol}
       query = validate_earnings_input!(**opts)
-      path_hash[:query] = URI.encode_www_form(query)
 
-      res = do_connect(get_uri path_hash)
-      map_earning res
+      map_earning(
+        do_request @@earnings + symbol, query
+      )
     end
   end
 end

data/lib/market_data/validations.rb

@@ -56,10 +56,7 @@ module MarketData
       r.merge({symbols: symbols.join(",")})
     end
 
-    def validate_candles_input!(
-      resolution: nil, from: nil, to: nil, countback: nil
-    )
-
+    def validate_candles_input!(resolution: nil, from: nil, to: nil, countback: nil)
       state, response = validate_from_to_countback_strategy(from: from, to: to, countback: countback)
       if state == :invalid
         raise BadParameterError.new(response)
@@ -73,9 +70,7 @@ module MarketData
       response.merge(res)
     end
     
-    def validate_earnings_input!(
-      from: nil, to: nil, countback: nil, date: nil, report: nil
-    )
+    def validate_earnings_input!(from: nil, to: nil, countback: nil, date: nil, report: nil)
       if !date.nil?
         return {date: date}
       end
@@ -91,6 +86,45 @@ module MarketData
       return response
     end
 
+    def validate_market_status_input!(country: nil, date: nil, from: nil, to: nil, countback: nil)
+      result = {}
+
+      if [country, date, from, to, countback].all? { |x| x.nil? }
+        return result
+      end
+
+      if !country.nil?
+        result.merge!({country: country})  
+      end
+      
+      if !date.nil?
+        # date has higher priority than from-to-countback
+        return result.merge({date: date})
+      end
+
+      if [from, to, countback].all? { |x| x.nil? }
+        return result
+      else
+        state, response = validate_from_to_countback_strategy(from: from, to: to, countback: countback)
+        if state == :invalid
+          raise BadParameterError.new(response)
+        end
+
+        return result.merge(response)
+      end
+    end
+    
+    def validate_index_quote_input!(w52: nil)
+      if w52.nil? || !w52
+        return {}
+      end
+      {"52week" => w52}
+    end
+
+    def validate_index_candles_input!(resolution: nil, from: nil, to: nil, countback: nil)
+      validate_candles_input!(resolution: resolution, from: from, to: to, countback: countback)
+    end
+
     def validate_from_to_countback_strategy(
       from: nil, to: nil, countback: nil
     )

data/lib/market_data/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MarketData
-  VERSION = "0.3.0"
+  VERSION = "0.5.0"
 end

data/lib/market_data.rb

@@ -2,13 +2,16 @@
 
 require_relative "market_data/version"
 require "market_data/quotes"
+require "market_data/markets"
+require "market_data/indexes"
 
 module MarketData
   @@base_host = "api.marketdata.app"
   
   class Client
     include MarketData::Quotes
-    # include MarketData::Index
+    include MarketData::Markets
+    include MarketData::Indexes
 
     def initialize token
       @access_token = token

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: market_data
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Sebastián González
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-11 00:00:00.000000000 Z
+date: 2024-10-16 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby client for the MarketData API.
 email:
@@ -28,7 +28,9 @@ files:
 - lib/market_data/conn.rb
 - lib/market_data/constants.rb
 - lib/market_data/errors.rb
+- lib/market_data/indexes.rb
 - lib/market_data/mappers.rb
+- lib/market_data/markets.rb
 - lib/market_data/models.rb
 - lib/market_data/quotes.rb
 - lib/market_data/validations.rb