browse_ai 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bffa5df7a1da9581dcfcfa89c210a0ea078349e98edd4dcdb5d7d66a5e0ff6df
-  data.tar.gz: 59670edeb76def4ea436b0547527759b2637f239ef91db7ea560da04692a8d6a
+  metadata.gz: aa9be724e4e1f9095648bf053458241214deea87e3968bcce3a55e331ce5f76e
+  data.tar.gz: 6ead772fc6dfae7a2a1172393bb79eaa13ce0c43661a7a3de441a31dccecd21d
 SHA512:
-  metadata.gz: 31a5722b43a96ded76d0c2dc24430fc5c524772d1f01daa15d898d6a0b2c39682752cc3630eeb5b9a62e7362b8c868999f916f1215f521f391459727934b0c17
-  data.tar.gz: 0bdae608d3bf6da3a6aa55f35760da25c74e67adb0419cabb7ac4bc6bb937034721d251b48cadbb2e850249ad4bc2aaef161968f4ed489171d10cab47ad98109
+  metadata.gz: 5fef398b81317b7c69f6e3633e19b90c22e45f66e91c7215ad548433af01bcc21d5f9e4fe54d4e608e82c2605c90f04ecb5560ffef4e2c10e5b7fb06ac279b6d
+  data.tar.gz: 2e699ba07291d8366a7f334137d5b1ee5e3b9e35c9c772425276b3c3b5c8adaee6d88ae40f52987449963e41c3fad310ba9332972e3ce4bef40738cce2930f81

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/browse_ai.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 3.0.0'
 
   spec.add_dependency 'activesupport', '~> 8.0', '>= 8.0.2'
-  spec.add_dependency 'faraday', '~> 2.13', '>= 2.13.1'
+  spec.add_dependency 'faraday', '>= 1.0'
   spec.add_dependency 'faraday-multipart', '~> 1.1'
   spec.add_dependency 'mime-types', '~> 3.7'
 

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/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/version.rb

@@ -1,3 +1,3 @@
 module BrowseAi
-  VERSION = '1.0.0'
+  VERSION = '1.0.2'
 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,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: browse_ai
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - David Iorns
 bindir: bin
 cert_chain: []
-date: 2025-06-25 00:00:00.000000000 Z
+date: 2025-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -33,22 +33,16 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.13'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.13.1
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.13'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.13.1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faraday-multipart
   requirement: !ruby/object:Gem::Requirement