market_data 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c83d3644178f120e069d283ebfc132d543ac8dbe2aca9734388d2cd56274bf7c
-  data.tar.gz: eeef52d93f45e64b4869749bd787b0af576924a0b617e8897c4eada6dcf813b2
+  metadata.gz: a5feb3cbcff5474737a925a855588baf09152953e44595542122629072c55412
+  data.tar.gz: 1087e1885b7d70e91afe3d32904fadf95314180518d37073c146ec108ed75919
 SHA512:
-  metadata.gz: b01a71a756244d6461e19cad34abb3b25df2705b43e03e47a936a66a471879f8ae0038e49ab01f062ec0db4c046e40e2d80d3162a5c065f535ffa7877efed548
-  data.tar.gz: fe1a289aa65eb0e6a0682b9e263a232f0eb2b913a808b9c6ac5271e46b52123a4c805a586bc5b2a1b9aeda92c17fb640815e6230907a9dcf6a0c5379bcd34b59
+  metadata.gz: b3c2f565abae69a1b2c2d107535cd7bfbb92ece1667f29a97ab262cfeecf00a0849d9ccc5ef115c2b5a7c9552bd44a60b541c95c45fa1ec050b1471fd5f5d8a3
+  data.tar.gz: e57d6e8d18f9aefb841f450dec15f54dd7ae9a8ad81c02a097ce83e02452790a4e1e2252c4b810ce86ccbb1e01fe31571fb36775803088a458b839cf849e1bc3

data/CHANGELOG.md

@@ -29,4 +29,8 @@
 ## [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

data/lib/market_data/constants.rb

@@ -47,5 +47,9 @@ module MarketData
       high52: "high52",
       low52: "low52",
     }
+    MARKET_STATUS_FIELD_MAPPING = {
+      date: "date",
+      status: "status"
+    }
   end
 end

data/lib/market_data/mappers.rb

@@ -47,6 +47,13 @@ module MarketData
       ar
     end
 
+    def map_market_status response
+      MarketData::Models::MarketStatus.new(
+        date: response["date"][0],
+        status: response["status"][0],
+      )
+    end
+
     def map_fields_for(response, kind, i=0)
       mapping = {}
       case kind

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,6 @@ module MarketData
     end
 
     Earning = Struct.new(*Constants::EARNING_FIELD_MAPPING.keys)
+    MarketStatus = Struct.new(*Constants::MARKET_STATUS_FIELD_MAPPING.keys)
   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,34 @@ 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
+      end
+
+      return result.merge(response)
+    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.4.0"
 end

data/lib/market_data.rb

@@ -2,13 +2,14 @@
 
 require_relative "market_data/version"
 require "market_data/quotes"
+require "market_data/markets"
 
 module MarketData
   @@base_host = "api.marketdata.app"
   
   class Client
     include MarketData::Quotes
-    # include MarketData::Index
+    include MarketData::Markets
 
     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.4.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-14 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby client for the MarketData API.
 email:
@@ -29,6 +29,7 @@ files:
 - lib/market_data/constants.rb
 - lib/market_data/errors.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