browse_ai 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56398bbf96c77d517e531a411ab7f62a6d844364c756ee95f5bc1aeb79d2d4c4
-  data.tar.gz: f5b8efb74c756d0a24d7438abfa7ce29f0ccb9be5fc4449307444c428509e3eb
+  metadata.gz: 4e7866506b5497da51c581127b313886e293c42b7751e582d043d378bfebfcf3
+  data.tar.gz: c776eeae73a97f1581de1ae3e11f1f34c174666b961b07e3f73efd6ec1eb15c6
 SHA512:
-  metadata.gz: 9a85873d6f7f2b61fdaeaead78694221652296025c2e041064232d0bd2eb4f68e0f0d23626c5c637835205ea3c04d64ed0a35cdc27f122ceb6924c80c23c0762
-  data.tar.gz: 2750f1044810fceffef860a1c46948cb097645e05525db52699ba9346af7ae33d46db862cff7d92de89ab8457ae67985261a920e7acfaa95b6ac939b8b93a33d
+  metadata.gz: 0534b89bb1a07bda3d140e6e9b6442743e1c1b1148c652bdf28f77a212c57f84cc667e7a3bea3d1fcc6b1ce13a297784192afe56c154b30cd5cd3ce1e5d053c5
+  data.tar.gz: 4f7e32004d613edb8fe7185714b4bdf2038f3a4b4deb9c01dab3c75d9f82b4af1d0dc6cf066a125d4451c26b8fd47167975dcb77e2d61e16b43d672e302942df

data/README.md

@@ -47,6 +47,13 @@ Get a robot's task.
 task = BrowseAi.client.get_tasks(robot_id: '<robot UUID>', id: '<task UUID>')
 ```
 
+Run a robot.
+```
+# Example JSON payload. The input parameters will vary depending on your robot's configuration.
+payload = {'inputParameters' => {'originUrl' => 'Test'}}.to_json 
+task = BrowseAi.client.run_robot(robot_id: '<robot UUID>', payload:)
+```
+
 Get a robot's monitors.
 ```
 monitors = BrowseAi.client.get_monitors(robot_id: '<robot UUID>')

data/lib/browse_ai/dsl/bulk_runs.rb

@@ -0,0 +1,41 @@
+require 'browse_ai/dsl'
+
+module BrowseAi
+  module DSL::BulkRuns
+    # POST /robots/{robotId}/bulk-runs
+    # Executes a bulk run on a robot.
+    # @param [String] robot_id The ID of the robot the bulk_runs belongs to.
+    # @param [String] :payload The JSON payload to send to the robot.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [BrowseAi::Resources::BulkRun, nil].
+    def bulk_run_tasks(robot_id:, payload:)
+      raise ArgumentError, 'Robot ID cannot be blank' if robot_id.blank?
+      raise ArgumentError, 'Payload cannot be blank' if payload.blank?
+
+      Resources::BulkRun.parse(request(:post, "robots/#{robot_id}/bulk_runs/", payload), %w[result bulkRun])
+    end
+
+    # GET robots/{robotId}/bulk-runs
+    # Get bulk_runs.
+    # @param [String] robot_id The ID of the robot the bulk runs belongs to.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Array, nil].
+    def get_bulk_runs(robot_id:)
+      raise ArgumentError, 'Robot ID cannot be blank' if robot_id.blank?
+
+      Resources::BulkRun.parse(request(:get, "robots/#{robot_id}/bulk-runs/", nil), %w[result items])
+    end
+
+    # GET robots/{robotId}/bulk-runs/{id}
+    # Get a bulk_run.
+    # @param [String] id A bulk run's ID.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [BrowseAi::Resources::BulkRun, nil].
+    def get_bulk_run(robot_id:, id:)
+      raise ArgumentError, 'Robot ID cannot be blank' if robot_id.blank?
+      raise ArgumentError, 'ID cannot be blank' if id.blank?
+
+      Resources::BulkRun.parse(request(:get, "robots/#{robot_id}/bulk-runs/#{id}"), %w[result bulkRun])
+    end
+  end
+end

data/lib/browse_ai/dsl/monitors.rb

@@ -5,6 +5,7 @@ module BrowseAi
     # GET /Monitors
     # Get monitors.
     # @param [String] robot_id The ID of the robot the monitors belong to.
+    # @raise [ArgumentError] If the method arguments are blank.
     # @return [Array, nil].
     def get_monitors(robot_id:)
       raise ArgumentError, 'Robot ID cannot be blank' if robot_id.blank?

data/lib/browse_ai/dsl/tasks.rb

@@ -2,9 +2,23 @@ require 'browse_ai/dsl'
 
 module BrowseAi
   module DSL::Tasks
-    # GET /Tasks
+    # POST /robots/{robotId}/tasks
+    # Runs a task on a robot.
+    # @param [String] robot_id The ID of the robot the tasks belongs to.
+    # @param [String] :payload The JSON payload to send to the robot.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [BrowseAi::Resources::Task, nil].
+    def run_robot(robot_id:, payload:)
+      raise ArgumentError, 'Robot ID cannot be blank' if robot_id.blank?
+      raise ArgumentError, 'Payload cannot be blank' if payload.blank?
+
+      Resources::Task.parse(request(:post, "robots/#{robot_id}/tasks/", payload), ['result'])
+    end
+
+    # GET robots/{robotId}/tasks
     # Get tasks.
-    # @param [String] robot_id The ID of the robot the tasks belong to.
+    # @param [String] robot_id The ID of the robot the tasks belongs to.
+    # @raise [ArgumentError] If the method arguments are blank.
     # @return [Array, nil].
     def get_tasks(robot_id:)
       raise ArgumentError, 'Robot ID cannot be blank' if robot_id.blank?
@@ -12,7 +26,7 @@ module BrowseAi
       Resources::Task.parse(request(:get, "robots/#{robot_id}/tasks/", nil), %w[tasks items])
     end
 
-    # GET /Task/{id}
+    # GET robots/{robotId}/tasks/{id}
     # Get a task.
     # @param [String] id A task's ID.
     # @raise [ArgumentError] If the method arguments are blank.

data/lib/browse_ai/dsl/webhooks.rb

@@ -5,6 +5,7 @@ module BrowseAi
     # GET /Webhooks
     # Get webhooks.
     # @param [String] robot_id The ID of the robot the webhooks belong to.
+    # @raise [ArgumentError] If the method arguments are blank.
     # @return [Array, nil].
     def get_webhooks(robot_id:)
       raise ArgumentError, 'Robot ID cannot be blank' if robot_id.blank?

data/lib/browse_ai/dsl.rb

@@ -5,6 +5,7 @@ module BrowseAi
   end
 end
 
+require 'browse_ai/dsl/bulk_runs'
 require 'browse_ai/dsl/monitors'
 require 'browse_ai/dsl/robots'
 require 'browse_ai/dsl/tasks'
@@ -14,6 +15,7 @@ require 'mime-types'
 
 module BrowseAi
   module DSL
+    include BulkRuns
     include Monitors
     include Robots
     include Tasks

data/lib/browse_ai/resources/bulk_run.rb

@@ -0,0 +1,8 @@
+require 'browse_ai/resources/object'
+
+module BrowseAi
+  module Resources
+    class BulkRun < BrowseAi::Resources::Object
+    end
+  end
+end

data/lib/browse_ai/resources/object.rb

@@ -16,7 +16,7 @@ module BrowseAi
       attribute :date_updated_utc, Time
 
       def inspect
-        "#<#{self.class.name}:#{format('0x00%x', (object_id << 1))} #{inspect_attributes}>"
+        "#<#{self.class.name}:#{format('0x00%x', object_id << 1)} #{inspect_attributes}>"
       end
 
       private

data/lib/browse_ai/resources.rb

@@ -5,6 +5,7 @@ module BrowseAi
   end
 end
 
+require 'browse_ai/resources/bulk_run'
 require 'browse_ai/resources/monitor'
 require 'browse_ai/resources/object'
 require 'browse_ai/resources/robot'

data/lib/browse_ai/version.rb

@@ -1,3 +1,3 @@
 module BrowseAi
-  VERSION = '1.0.1'
+  VERSION = '1.0.3'
 end

data/spec/browse_ai/dsl/bulk_runs_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe BrowseAi::DSL::BulkRuns do
+  def robot_id
+    VCR.use_cassette('get_robots') do
+      robots = BrowseAi.client.get_robots
+      robots.first['id']
+    end
+  end
+
+  # POST /robots/{robotId}/bulk-runs
+  describe '#bulk_run_tasks' do
+    let(:payload) do
+      {
+        'inputParameters' => {
+          'originUrl' => 'Test',
+        }
+      }.to_json
+    end
+
+    it 'creates a bulk run and executes it on the robot' do
+      VCR.use_cassette('bulk_run_tasks') do
+        bulk_run = BrowseAi.client.bulk_run_tasks(robot_id:, payload:)
+        expect(bulk_run).to be_a(BulkRun)
+      end
+    end
+  end
+
+  # GET robots/{robotId}/bulk_runs
+  describe '#get_bulk_runs' do
+    it 'returns an array of bulk_runs' do
+      VCR.use_cassette('get_bulk_runs') do
+        bulk_runs = BrowseAi.client.get_bulk_runs(robot_id:)
+        expect(bulk_runs).to be_a(Array)
+        expect(bulk_runs.first).to be_a(BulkRun)
+      end
+    end
+  end
+
+  # GET robots/{robotId}/bulk_runs/{id}
+  describe '#get_bulk_run' do
+    it 'returns an bulk_run' do
+      id = VCR.use_cassette('get_bulk_runs') do
+        bulk_runs = BrowseAi.client.get_bulk_runs(robot_id:)
+        bulk_runs.first['id']
+      end
+
+      VCR.use_cassette('get_bulk_run') do
+        expect(BrowseAi.client.get_bulk_run(robot_id:, id:)).to be_a(BulkRun)
+      end
+    end
+  end
+end

data/spec/browse_ai/dsl/tasks_spec.rb

@@ -8,7 +8,25 @@ describe BrowseAi::DSL::Tasks do
     end
   end
 
-  # GET /tasks
+  # POST /robots/{robotId}/tasks
+  describe '#run_robot' do
+    let(:payload) do
+      {
+        'inputParameters' => {
+          'originUrl' => 'Test',
+        }
+      }.to_json
+    end
+
+    it 'creates a task and runs it' do
+      VCR.use_cassette('run_robot') do
+        task = BrowseAi.client.run_robot(robot_id:, payload:)
+        expect(task).to be_a(Task)
+      end
+    end
+  end
+
+  # GET robots/{robotId}/tasks
   describe '#get_tasks' do
     it 'returns an array of tasks' do
       VCR.use_cassette('get_tasks') do
@@ -19,7 +37,7 @@ describe BrowseAi::DSL::Tasks do
     end
   end
 
-  # GET /tasks/{id}
+  # GET robots/{robotId}/tasks/{id}
   describe '#get_task' do
     it 'returns an task' do
       id = VCR.use_cassette('get_tasks') do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: browse_ai
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - David Iorns
@@ -184,6 +184,7 @@ files:
 - lib/browse_ai.rb
 - lib/browse_ai/client.rb
 - lib/browse_ai/dsl.rb
+- lib/browse_ai/dsl/bulk_runs.rb
 - lib/browse_ai/dsl/monitors.rb
 - lib/browse_ai/dsl/robots.rb
 - lib/browse_ai/dsl/tasks.rb
@@ -192,6 +193,7 @@ files:
 - lib/browse_ai/errors/client_error.rb
 - lib/browse_ai/errors/resource_not_found_error.rb
 - lib/browse_ai/resources.rb
+- lib/browse_ai/resources/bulk_run.rb
 - lib/browse_ai/resources/monitor.rb
 - lib/browse_ai/resources/object.rb
 - lib/browse_ai/resources/object/attributes.rb
@@ -203,6 +205,7 @@ files:
 - lib/browse_ai/utils/url_helper.rb
 - lib/browse_ai/version.rb
 - spec/browse_ai/client_spec.rb
+- spec/browse_ai/dsl/bulk_runs_spec.rb
 - spec/browse_ai/dsl/monitors_spec.rb
 - spec/browse_ai/dsl/robots_spec.rb
 - spec/browse_ai/dsl/tasks_spec.rb
@@ -231,6 +234,7 @@ specification_version: 4
 summary: A Ruby wrapper for the Browse AI API. https://www.browse.ai/docs/api/v2
 test_files:
 - spec/browse_ai/client_spec.rb
+- spec/browse_ai/dsl/bulk_runs_spec.rb
 - spec/browse_ai/dsl/monitors_spec.rb
 - spec/browse_ai/dsl/robots_spec.rb
 - spec/browse_ai/dsl/tasks_spec.rb