doc: updates doc for #list methods

Author: bougyman

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    domeapi (0.0.1)
+    domeapi (0.0.2)
       dry-cli
       dry-configurable
       dry-container
@@ -197,7 +197,7 @@ CHECKSUMS
   crack (1.0.1) sha256=ff4a10390cd31d66440b7524eb1841874db86201d5b70032028553130b6d4c7e
   declarative (0.0.20) sha256=8021dd6cb17ab2b61233c56903d3f5a259c5cf43c80ff332d447d395b17d9ff9
   disposable (0.6.3) sha256=7f2a3fb251bff6cd83f25b164043d4ec3531209b51b066ed476a9df9c2d384cc
-  domeapi (0.0.1)
+  domeapi (0.0.2)
   dry-cli (1.3.0) sha256=984a715f9d7f8d9bf87b6530acdd4321dcf747636bfeb3ea7fd1b81bc0226e84
   dry-configurable (1.3.0) sha256=882d862858567fc1210d2549d4c090f34370fc1bb7c5c1933de3fe792e18afa8
   dry-container (0.11.0) sha256=23be9381644d47343f3bf13b082b4255994ada0bfd88e0737eaaadc99d035229

Readme.adoc

@@ -84,7 +84,22 @@ filter = Rubyists::Domeapi::Polymarket::Candlesticks::Filter.new(
     interval: 60
   )
 )
-candlesticks = client.polymarket.candlesticks.get(filter)
+candlesticks = client.polymarket.candlesticks.list(filter)
+----
+
+==== Trade History
+
+Get trade history:
+
+[source,ruby]
+----
+filter = Rubyists::Domeapi::Polymarket::TradeHistory::Filter.new(
+  Rubyists::Domeapi::Polymarket::TradeHistory::Filter::Properties.new(
+    market_slug: 'market_slug',
+    limit: 10
+  )
+)
+trades = client.polymarket.trade_history.list(filter)
 ----
 
 == Development

lib/domeapi/polymarket/candlesticks.rb

@@ -42,7 +42,7 @@ class Filter < Contract
         # @param filter [Filter] Filter options
         #
         # @return [Hash] candlestick data
-        def get(filter = Filter.new(Filter::Properties.new))
+        def list(filter = Filter.new(Filter::Properties.new))
           raise ArgumentError, filter.errors.full_messages.join(', ') unless filter.valid?
 
           client.get('markets/get_candlesticks', params: filter.to_h)

lib/domeapi/polymarket/client.rb

@@ -23,6 +23,10 @@ def markets
         def candlesticks
           @candlesticks ||= Candlesticks.new(client)
         end
+
+        def trade_history
+          @trade_history ||= TradeHistory.new(client)
+        end
       end
     end
   end

lib/domeapi/polymarket/trade_history.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Rubyists
+  module Domeapi
+    module Polymarket
+      # Trade History API endpoints
+      class TradeHistory
+        attr_reader :client
+
+        # @param client [Rubyists::Domeapi::Polymarket::Client]
+        #
+        # @return [void]
+        def initialize(client = Rubyists::Domeapi::Polymarket::Client.new)
+          @client = client
+        end
+
+        # Filter for trade history
+        class Filter < Contract
+          Properties = Struct.new(
+            :market_slug,
+            :condition_id,
+            :token_id,
+            :start_time,
+            :end_time,
+            :limit,
+            :offset,
+            :user,
+            keyword_init: true
+          )
+
+          Properties.members.each { |member| property member, populator: ->(model:, **) { model || skip! } }
+
+          validation do
+            params do
+              optional(:market_slug).maybe(:string)
+              optional(:condition_id).maybe(:string)
+              optional(:token_id).maybe(:string)
+              optional(:start_time).maybe(:integer)
+              optional(:end_time).maybe(:integer)
+              optional(:limit).maybe(:integer, gteq?: 1, lteq?: 1000)
+              optional(:offset).maybe(:integer, gteq?: 0)
+              optional(:user).maybe(:string)
+            end
+          end
+        end
+
+        # Get trade history
+        #
+        # @param filter [Filter] Filter options
+        #
+        # @return [Hash] trade history data
+        def list(filter = Filter.new(Filter::Properties.new))
+          raise ArgumentError, filter.errors.full_messages.join(', ') unless filter.validate({})
+
+          client.get('markets/get_trade_history', params: filter.to_h)
+        end
+      end
+    end
+  end
+end

test/domeapi/polymarket/candlesticks_test.rb

@@ -26,7 +26,7 @@
           interval: 60
         )
       )
-      response = candlesticks.get(filter)
+      response = candlesticks.list(filter)
 
       _(response).must_equal({ candlesticks: [] })
     end
@@ -43,7 +43,7 @@
           end_time: 200
         )
       )
-      response = candlesticks.get(filter)
+      response = candlesticks.list(filter)
 
       _(response).must_equal({ candlesticks: [] })
     end
@@ -53,7 +53,7 @@
         Rubyists::Domeapi::Polymarket::Candlesticks::Filter::Properties.new
       )
 
-      error = _ { candlesticks.get(filter) }.must_raise ArgumentError
+      error = _ { candlesticks.list(filter) }.must_raise ArgumentError
       _(error.message).must_include 'Condition Id must be filled'
       _(error.message).must_include 'Start Time must be filled'
       _(error.message).must_include 'End Time must be filled'
@@ -69,7 +69,7 @@
         )
       )
 
-      error = _ { candlesticks.get(filter) }.must_raise ArgumentError
+      error = _ { candlesticks.list(filter) }.must_raise ArgumentError
       _(error.message).must_include 'Interval must be less than or equal to 1440'
 
       filter = Rubyists::Domeapi::Polymarket::Candlesticks::Filter.new(
@@ -81,7 +81,7 @@
         )
       )
 
-      error = _ { candlesticks.get(filter) }.must_raise ArgumentError
+      error = _ { candlesticks.list(filter) }.must_raise ArgumentError
       _(error.message).must_include 'Interval must be greater than or equal to 1'
     end
   end

test/domeapi/polymarket/trade_history_test.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative '../../helper'
+
+describe Rubyists::Domeapi::Client do
+  let(:client) { Rubyists::Domeapi::Client.new }
+  let(:trade_history) { client.polymarket.trade_history }
+
+  before do
+    Rubyists::Domeapi.configure do |config|
+      config.api_key = 'test_api_key'
+    end
+  end
+
+  describe 'Polymarket Trade History' do
+    it 'gets trade history' do
+      stub_request(:get, 'https://api.domeapi.io/v1/polymarket/markets/get_trade_history')
+        .with(query: { market_slug: 'slug', limit: '10' })
+        .to_return(status: 200, body: '{"trades": []}')
+
+      filter = Rubyists::Domeapi::Polymarket::TradeHistory::Filter.new(
+        Rubyists::Domeapi::Polymarket::TradeHistory::Filter::Properties.new(
+          market_slug: 'slug',
+          limit: 10
+        )
+      )
+      response = trade_history.list(filter)
+
+      _(response).must_equal({ trades: [] })
+    end
+
+    it 'validates limit range' do
+      filter = Rubyists::Domeapi::Polymarket::TradeHistory::Filter.new(
+        Rubyists::Domeapi::Polymarket::TradeHistory::Filter::Properties.new(limit: 1001)
+      )
+
+      error = _ { trade_history.list(filter) }.must_raise ArgumentError
+      _(error.message).must_include 'Limit must be less than or equal to 1000'
+
+      filter = Rubyists::Domeapi::Polymarket::TradeHistory::Filter.new(
+        Rubyists::Domeapi::Polymarket::TradeHistory::Filter::Properties.new(limit: 0)
+      )
+
+      error = _ { trade_history.list(filter) }.must_raise ArgumentError
+      _(error.message).must_include 'Limit must be greater than or equal to 1'
+    end
+
+    it 'validates offset range' do
+      filter = Rubyists::Domeapi::Polymarket::TradeHistory::Filter.new(
+        Rubyists::Domeapi::Polymarket::TradeHistory::Filter::Properties.new(offset: -1)
+      )
+
+      error = _ { trade_history.list(filter) }.must_raise ArgumentError
+      _(error.message).must_include 'Offset must be greater than or equal to 0'
+    end
+  end
+end