market_data 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a789c526a0c59a4986980a39f9069f1482f35b5b6b5a447e11ec65d3fae26bc
-  data.tar.gz: e4924d8db772dfd0e9eeaea07a5364550a93f2b2f59788254b4c7246defd80af
+  metadata.gz: '082a3b709ed32b745807906d0324a3b839a90c95e55bc199b564db75518d1fbc'
+  data.tar.gz: dab55b3c50200dbf92e071dc0bd3eab5b8d712928f82d045c92a80a5f09b0979
 SHA512:
-  metadata.gz: 923c8d9c20f0f240336a173bf72e31b1178ba4bc12917d9c82f661dfcb1dcb426516614d4ff777c49817de3534098e0425c2309a6e352d3fdb201e15c464eb7b
-  data.tar.gz: '01027894f69698156d2606d5f3c38ea582c1b14ef5899df51f7c8cfe06803bfa610532f45937a8fd931c73738c4e4cf1cb89c7eeb1732f520ec63bae78a9ccee'
+  metadata.gz: 64fca38c4e459cb4244f845ad4137939249c353b2e91922cc0bb416a2b1129871916c80bf0d44e3a71e8c48b797de2a27f378192a790286aed9d2f985345c556
+  data.tar.gz: 97b5508677cbff6418254771f78e68eb48c0ee66c067274663a40ad2c6cd00af3355dac9b93bd812e90290f2fb1c10af2d0b6ba3aa447bcc760f43024ccc8dc9

data/CHANGELOG.md

@@ -7,4 +7,16 @@
 ## [0.1.1] - 2024-09-12
 
 - Fix handling of snapshot parameter in bulk quotes method
-- Rename fetch method to quote on Quote submodule. Quotes methods are no longer wrapped in parent module.
+- Rename fetch method to quote on Quote submodule. Quotes methods are no longer wrapped in parent module.
+
+## [0.1.2] - 2024-09-24
+
+- Change validations for bulk_quotes method
+- Add `token` method to `Client` class
+
+## [0.2.0] - 2024-09-30
+
+- Internal rework of code. New modules for models, mappers, constants and errors
+- Introduced unit tests for almost all modules.
+- Introduced coverage. Currently at 85%
+- Add functionality for [Candles](https://www.marketdata.app/docs/api/stocks/candles) and [Bulk Candles](https://www.marketdata.app/docs/api/stocks/bulkcandles) endpoints

data/Gemfile

@@ -7,4 +7,8 @@ gemspec
 
 gem "rake", "~> 13.0"
 
-gem "minitest", "~> 5.0"
+group :test do
+  gem "minitest", "~> 5.0"
+  gem 'simplecov', require: false
+  gem 'mocha'
+end

data/Gemfile.lock

@@ -1,13 +1,23 @@
 PATH
   remote: .
   specs:
-    market_data (0.1.0)
+    market_data (0.1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    docile (1.4.1)
     minitest (5.16.3)
+    mocha (2.4.5)
+      ruby2_keywords (>= 0.0.5)
     rake (13.0.6)
+    ruby2_keywords (0.0.5)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.1)
+    simplecov_json_formatter (0.1.4)
 
 PLATFORMS
   arm64-darwin-23
@@ -15,7 +25,9 @@ PLATFORMS
 DEPENDENCIES
   market_data!
   minitest (~> 5.0)
+  mocha
   rake (~> 13.0)
+  simplecov
 
 BUNDLED WITH
    2.4.1

data/README.md

@@ -1,34 +1,54 @@
 # MarketData
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/market_data`. To experiment with that code, run `bin/console` for an interactive prompt.
+A Ruby wrapper for the [MarketData API](https://www.marketdata.app/docs/api).
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+    $ gem install market-data
+    $ bundle install
+
+## Usage
 
-Install the gem and add to the application's Gemfile by executing:
+    $ client = MarketData.Client.new "YOUR_API_TOKEN"
+    $ client.quote("AAPL")
+    $ => <struct MarketData::Models::Quote symbol="AAPL", ask=231.42, askSize=2, bid=231.4, .....
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+## ROADMAP
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+The following is an ordered list of next expected developments, based on the endpoints present in the [docs](https://www.marketdata.app/docs/api)
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+From Stocks endpoints:
+- [X] Stocks
+- [X] Bulk Stocks
+- [X] Candles
+- [X] Bulk Candles
+- [X] Support for optional parameters for Bulk Candles
+- [] Earnings
+
+From Markets endpoints:
+- [] Status
+
+From Indices endpoints:
+- [] Quotes
+- [] Candles
+
+From Stocks endpoints:
+- [] Support for optional parameters for Candles
+- [] Support for optional parameters for Bulk Candles
 
-## Usage
 
-TODO: Write usage instructions here
+## Tests
 
-## Development
+Run tests with
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+    $ rake 
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To run tests and check coverage
 
+    $  rake && open coverage/index.html 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/market_data. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/market_data/blob/main/CODE_OF_CONDUCT.md).
+Leave an issue or contact me at sebagonz91@gmail.com
 
 ## License
 

data/lib/market_data/constants.rb

@@ -0,0 +1,13 @@
+module MarketData
+  module Constants
+    SECOND = 1
+    MINUTE = 60
+    HOUR = MINUTE * 60
+    DAY = HOUR * 24
+    WEEK = DAY * 7
+    YEAR = DAY * 365
+
+    QUOTE_FIELDS = [:symbol, :ask, :askSize, :bid, :bidSize, :mid, :last, :change, :changepct, :volume, :updated, :high52, :low52]
+    CANDLE_FIELDS = [:symbol, :open, :high, :low, :close, :volume, :time]
+  end
+end

data/lib/market_data/errors.rb

@@ -1,15 +1,32 @@
+require 'json'
+
 module MarketData
 
   class ClientError < StandardError;end
   class UnauthorizedError < ClientError; end
+  class RateLimitedError < ClientError; end
   class BadParameterError < ClientError; end
+  class NotFoundError < ClientError; end
 
   module Errors
     def handle_error e
       er = e.io
+      parsed_info = JSON.parse(er.string)
       case er.status[0]
+      when "400"
+        if parsed_info["s"] == "error"
+          raise BadParameterError.new(parsed_info["errmsg"])
+        end
+        raise BadParameterError
+      when "404"
+        if parsed_info["s"] == "no_data"
+            raise NotFoundError.new("no candle information was found for the request")  
+        end
+        raise NotFoundError
       when "401"
-        raise UnauthorizedError
+        raise UnauthorizedError.new(parsed_info["errmsg"])
+      when "429"
+        raise RateLimitedError
       else 
         raise e
       end

data/lib/market_data/mappers.rb

@@ -0,0 +1,67 @@
+require 'market_data/models'
+
+module MarketData
+  module Mappers
+    include MarketData::Models
+
+    SYMBOL_RESPONSE_KEY = "symbol"
+    STATUS_RESPONSE_KEY = "s"
+
+    def map_quote response, i=0
+      Quote.new(
+        symbol: response["symbol"][i],
+        ask: response["ask"][i],
+        askSize: response["askSize"][i],
+        bid: response["bid"][i],
+        bidSize: response["bidSize"][i],
+        mid: response["mid"][i],
+        last: response["last"][i],
+        change: response["change"][i],
+        changepct: response["changepct"][i],
+        volume: response["volume"][i],
+        updated: response["updated"][i],
+        high52: response.fetch("high52", nil),
+        low52: response.fetch("low52", nil),
+      )
+    end
+
+    def map_bulk_quotes response
+      h = Hash.new
+      size = response[SYMBOL_RESPONSE_KEY].size
+      for i in 0..(size - 1) do
+        qquote = map_quote(response, i)
+        h[response[SYMBOL_RESPONSE_KEY][i]] = !qquote.blank? ? qquote : nil
+      end
+      h
+    end
+
+    def map_candles response, symbol
+      ar = []
+      size = response["o"].size
+    
+      for i in 0..(size - 1) do
+        ar << Candle.new(
+          open: response["o"][i],
+          high: response["h"][i],
+          low: response["l"][i],
+          close: response["c"][i],
+          volume: response["v"][i],
+          time: response["t"][i],
+          symbol: symbol
+        )
+      end
+      ar
+    end
+
+    def map_bulk_candles response
+      h = Hash.new
+      size = response[SYMBOL_RESPONSE_KEY].size
+    
+      for i in 0..(size - 1) do
+        candle = Candle.new(symbol: response["symbol"][i], open: response["o"][i], high: response["h"][i], low: response["l"][i], close: response["c"][i], volume: response["v"][i], time: response["t"][i])
+        h[response[SYMBOL_RESPONSE_KEY][i]] = !candle.blank? ? candle : nil
+      end
+      h
+    end
+  end
+end

data/lib/market_data/models.rb

@@ -0,0 +1,19 @@
+require 'market_data/constants'
+
+module MarketData
+  module Models
+    include MarketData::Constants
+
+    Quote = Struct.new(*Constants::QUOTE_FIELDS) do
+      def blank?
+        (QUOTE_FIELDS - [:symbol]).all? { |mmethod| self[mmethod].nil?}
+      end
+    end
+
+    Candle = Struct.new(*Constants::CANDLE_FIELDS) do
+      def blank?
+        (CANDLE_FIELDS - [:symbol]).all? { |mmethod| self[mmethod].nil?}
+      end
+    end
+  end
+end

data/lib/market_data/quotes.rb

@@ -1,32 +1,25 @@
 require 'market_data/conn'
 require 'market_data/errors'
+require 'market_data/mappers'
 
 module MarketData
   module Quotes
+    include MarketData::Mappers
     include MarketData::Errors
     include MarketData::Conn
 
-    SYMBOL_RESPONSE_KEY = "symbol"
-    STATUS_RESPONSE_KEY = "s"
-
-    QUOTE_FIELDS = [:symbol, :ask, :askSize, :bid, :bidSize, :mid, :last, :change, :changepct, :volume, :updated, :high52, :low52]
     @@single = "/v1/stocks/quotes/"
     @@bulk = "/v1/stocks/bulkquotes/"
+    @@candles = "/v1/stocks/candles/"
+    @@bulk_candles = "/v1/stocks/bulkcandles/"
 
-    # Quote is the struct to hold ticker request information
-    Quote = Struct.new(*QUOTE_FIELDS) do
-      def blank?
-        (QUOTE_FIELDS - [:symbol]).all? { |mmethod| self[mmethod].nil?}
-      end
-    end
-    
     def quote(symbol, w52 = false)
       path_hash = { host: MarketData.base_host, path: @@single + symbol }
-        if w52
-          path_hash[:query] = URI.encode_www_form({"52week" => true })
-        end
-        res = do_connect(get_uri path_hash)
-        Quote.new(*res.except(STATUS_RESPONSE_KEY).values.map { |ar| ar[0] })
+      if w52
+        path_hash[:query] = URI.encode_www_form({"52week" => true })
+      end
+      res = do_connect(get_uri path_hash)
+      map_quote(res)
     end
 
     def bulk_quotes(symbols, snapshot = false)
@@ -36,7 +29,7 @@ module MarketData
       if snapshot
         query_hash[:snapshot] = true
       else
-        unless symbols.is_a?(Array) && symbols.size > 1
+        if !symbols.is_a?(Array) || symbols.size < 1
           raise BadParameterError.new("symbols must be a non-empty list")
         end
         query_hash = { symbols: symbols.join(",") }
@@ -45,17 +38,49 @@ module MarketData
       path_hash[:query] = URI.encode_www_form(query_hash)
 
       res = do_connect(get_uri path_hash)
-      Quotes.map_quotes(res)
+      map_bulk_quotes res
+    end
+  
+    def candles(symbol, opts = {})
+      defaults = {resolution: "D", from: nil, to: Time.now.utc.to_i, countback: nil}
+      opts = defaults.merge(opts)
+      
+      query_hash = {to: opts[:to]}
+    
+      # TODO Move method validations into own class
+      # TODO check to is either iso8601 or unix
+      if opts[:from].nil? && opts[:countback].nil?
+        raise BadParameterError.new("either :from or :countback must be supplied")
+      end
+
+      if opts[:from].nil?
+        query_hash[:countback] = opts[:countback]
+      else
+        query_hash[:from] = opts[:from]
+      end
+      
+      path_hash = { host: MarketData.base_host, path: @@candles + opts[:resolution] + "/" + symbol }
+      path_hash[:query] = URI.encode_www_form(query_hash)
+      
+      res = do_connect(get_uri path_hash)
+      map_candles res, symbol
     end
 
-    def self.map_quotes(quotes)
-      h = Hash.new
-      size = quotes[SYMBOL_RESPONSE_KEY].size
-      for i in 0..(size - 1) do
-        qquote = Quote.new(*quotes.except(STATUS_RESPONSE_KEY).values.map { |ar| ar[i] })
-        h[quotes[SYMBOL_RESPONSE_KEY][i]] = !qquote.blank? ? qquote : nil
+    def bulk_candles(symbols, resolution = "D")
+      unless resolution == "daily" || resolution == "1D" || resolution == "D"
+        raise BadParameterError.new("only daily resolution is allowed for this endpoint")
       end
-      h
+      path_hash = { host: MarketData.base_host, path: @@bulk_candles + resolution + "/" }
+      
+      if !symbols.is_a?(Array) || symbols.size < 1
+        raise BadParameterError.new("symbols must be a non-empty list")
+      end
+      query_hash = { symbols: symbols.join(",") }
+
+      path_hash[:query] = URI.encode_www_form(query_hash)
+
+      res = do_connect(get_uri path_hash)
+      map_bulk_candles res
     end
   end
 end

data/lib/market_data/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: market_data
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Sebastián González
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-12 00:00:00.000000000 Z
+date: 2024-09-30 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby client for the MarketData API.
 email:
@@ -26,7 +26,10 @@ files:
 - Rakefile
 - lib/market_data.rb
 - lib/market_data/conn.rb
+- lib/market_data/constants.rb
 - lib/market_data/errors.rb
+- lib/market_data/mappers.rb
+- lib/market_data/models.rb
 - lib/market_data/quotes.rb
 - lib/market_data/version.rb
 - market_data.gemspec