buzzrb 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2028c5b5d0a40e237c0e329d459a14dcd51f32b238af6d3def30cd26f6b11f94
-  data.tar.gz: 176213d9064087d7068d19842064536efcf88494d0fa041b961d4dd4cceddce9
+  metadata.gz: f2b0def7e301a26ceeaee2e000224b6c92962af3296e7ce18859ac69f32a314e
+  data.tar.gz: dfba2184f95d0395dc42b90b130162815d335d729fec0995d2e9cf018222fcd2
 SHA512:
-  metadata.gz: 5ee311629160203785bd975a143dd7b4ce600b77946c70301ee4ddfbebee09fa39929dddb0f6c4d96ea7437ed9dd273f54c93b7a474bab5bc6d3336a9565df12
-  data.tar.gz: 15531566ffea5bf3b43b8db8816e99736347a50956ed9e7f8af81d6d0595db0b3880e6aa0aa232a01bd2c6a50bc06b47c3d46fc087d40bc6f357a43f91c89c49
+  metadata.gz: cee5da98edc7e203d740f76945c5ce469af645f55f04e5c2795f82fda80d883bada6a8cbbd6ce14cc99299bcf9b340e93f148586cd686d16920e76cc4d68bc58
+  data.tar.gz: 77438264221d2d174ee6dcaad5f7a9ccdf8e0d4cb166079362d0bd2a3fd35a67a12277c290a5e008bc2cd3066b917f702c82b3ecdf9299fe4c228efa07c290c4

data/lib/buzz/error.rb

@@ -31,4 +31,7 @@ module Buzz
 
   class ServerError < Error
   end
+
+  class QueryTimeoutError < Error
+  end
 end

data/lib/buzz/resources/reporting.rb

@@ -2,6 +2,9 @@
 
 module Buzz
   module Resources
+    # Beeswax Report Builder 2.0. Queries are async: POST run-query returns a
+    # task_id, then GET async-results until 200 (204 means still running).
+    # https://api-docs.freewheel.tv/advertiser/v2.0/docs/reporting
     class Reporting
       attr_reader :client
 
@@ -9,28 +12,64 @@ module Buzz
         @client = client
       end
 
-      # Query performance data (spend, impressions, clicks, etc.)
-      def query(dimensions: [], metrics: [], **params)
-        body = {dimensions: dimensions, metrics: metrics}.merge(params)
-        response = client.post("/rest/v2/report-data", body)
-        response.data["results"]
+      def run_query(view:, fields:, filters: {}, result_format: "json", query_timezone: nil, **params)
+        body = {view: view, fields: Array(fields)}
+        body[:filters] = filters if filters && !filters.empty?
+        body[:result_format] = result_format if result_format
+        body[:query_timezone] = query_timezone if query_timezone
+        body.merge!(params)
+
+        response = client.post("/rest/v2/reporting/run-query", body)
+        task_id = response.data.is_a?(Hash) ? response.data["task_id"] : nil
+        raise Error.new("run-query did not return a task_id", status: response.status, body: response.data) if task_id.nil? || task_id.to_s.empty?
+
+        task_id
+      end
+
+      def async_results(task_id)
+        client.get("/rest/v2/reporting/async-results/#{task_id}")
       end
 
-      # CRUD on saved report definitions
-      def list(params = {})
-        Paginator.new(client, "/rest/v2/reports", params)
+      def query(view:, fields:, filters: {}, result_format: "json", query_timezone: nil, timeout: 300, interval: 1, **params)
+        task_id = run_query(view: view, fields: fields, filters: filters, result_format: result_format, query_timezone: query_timezone, **params)
+        wait_for_results(task_id, timeout: timeout, interval: interval)
       end
 
-      def find(id)
-        client.get("/rest/v2/reports/#{id}").data
+      def reports
+        client.get("/rest/v2/reporting/reports").data
       end
 
-      def create(attributes = {})
-        client.post("/rest/v2/reports", attributes).data
+      def report(name)
+        client.get("/rest/v2/reporting/reports/#{name}").data
       end
 
-      def delete(id)
-        client.delete("/rest/v2/reports/#{id}").data
+      private
+
+      def wait_for_results(task_id, timeout:, interval:)
+        started = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+        loop do
+          response = async_results(task_id)
+          return extract_rows(response.data) if response.status == 200
+
+          elapsed = Process.clock_gettime(Process::CLOCK_MONOTONIC) - started
+          if elapsed >= timeout
+            raise QueryTimeoutError.new(
+              "Reporting query #{task_id} did not complete within #{timeout}s",
+              status: response.status,
+              body: response.data
+            )
+          end
+
+          sleep interval
+        end
+      end
+
+      def extract_rows(data)
+        return data if data.is_a?(Array)
+        return data["results"] if data.is_a?(Hash) && data.key?("results")
+
+        data
       end
     end
   end

data/lib/buzz/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: buzzrb
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - swlkr
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby client for the Buzz/Freewheel Advertiser API v2.0
 test_files: []