browse_ai 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bffa5df7a1da9581dcfcfa89c210a0ea078349e98edd4dcdb5d7d66a5e0ff6df
+  data.tar.gz: 59670edeb76def4ea436b0547527759b2637f239ef91db7ea560da04692a8d6a
+SHA512:
+  metadata.gz: 31a5722b43a96ded76d0c2dc24430fc5c524772d1f01daa15d898d6a0b2c39682752cc3630eeb5b9a62e7362b8c868999f916f1215f521f391459727934b0c17
+  data.tar.gz: 0bdae608d3bf6da3a6aa55f35760da25c74e67adb0419cabb7ac4bc6bb937034721d251b48cadbb2e850249ad4bc2aaef161968f4ed489171d10cab47ad98109

data/.github/dependabot.yml

@@ -0,0 +1,12 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 10

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/fixtures/vcr_cassettes/
+/tmp/
+.idea/
+*.bundle
+*.so
+*.o
+*.a
+*.gem
+mkmf.log
+/config/gem_secret.yml

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in browse_ai.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 David Iorns
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+# Browse AI Ruby Client
+
+A Ruby wrapper for the Browse AI API.
+
+https://www.browse.ai/docs/api/v2
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'browse_ai'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install browse_ai
+
+## Usage
+
+Set the client API key.
+```
+BrowseAi.api_key = <your API key>
+```
+
+Get robots.
+```
+robots = BrowseAi.client.get_robots
+```
+
+Get a robot.
+```
+robot = BrowseAi.client.get_robot(id: '<robot UUID>')
+```
+
+Get a robot's tasks.
+```
+tasks = BrowseAi.client.get_tasks(robot_id: '<robot UUID>')
+```
+
+Get a robot's task.
+```
+task = BrowseAi.client.get_tasks(robot_id: '<robot UUID>', id: '<task UUID>')
+```
+
+Get a robot's monitors.
+```
+monitors = BrowseAi.client.get_monitors(robot_id: '<robot UUID>')
+```
+
+Get a robot's monitor.
+```
+monitor = BrowseAi.client.get_monitors(robot_id: '<robot UUID>', id: '<monitor UUID>')
+```
+
+Get a robot's webhooks.
+```
+webhooks = BrowseAi.client.get_webhooks(robot_id: '<robot UUID>')
+```
+
+## Testing
+
+Testing uses [RSpec](https://github.com/rspec/rspec), [Webmock](https://github.com/bblimke/webmock) and [VCR](https://github.com/vcr/vcr).
+
+<strong>Tests will make real requests to the API endpoints</strong>. Ensure your test and production data is separated.
+
+<strong>Tests currently require real data to exist for each resource.</strong> 
+Tests will fail if no data is present in your account for a specific resource.
+For example `spec/browse_ai/dsl/robots_spec.rb` will fail if you have not yet added a robot to your account.
+
+### Test setup
+- Copy and rename `config/gem_secret.yml.example` to `config/gem_secret.yml` . <strong>Do not check `config/gem_secret.yml` into version control</strong>.
+- In `config/gem_secret.yml` fill in your test API key. `browse_ai_api_key: '<your API key>'`
+- Run rspec `bundle exec rspec` 
+
+## API Documentation
+https://www.browse.ai/docs/api/v2
+
+## Contributing
+
+1. Fork it ( https://github.com/dior001/browse-ai-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/browse_ai.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'browse_ai/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'browse_ai'
+  spec.version       = BrowseAi::VERSION
+  spec.authors       = ['David Iorns']
+  spec.email         = ['david.iorns@gmail.com']
+  spec.summary       = 'A Ruby wrapper for the Browse AI API. https://www.browse.ai/docs/api/v2'
+  spec.homepage      = 'https://www.browse.ai/'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  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-multipart', '~> 1.1'
+  spec.add_dependency 'mime-types', '~> 3.7'
+
+  spec.add_development_dependency 'bundler', '~> 2.6', '>= 2.6.9'
+  spec.add_development_dependency 'rake', '~> 13.3'
+  spec.add_development_dependency 'rspec', '~> 3.13', '>= 3.13.1'
+  spec.add_development_dependency 'vcr', '~> 6.3', '>= 6.3.1'
+  spec.add_development_dependency 'webmock', '~> 3.25', '>= 3.25.1'
+end

data/config/gem_secret.yml.example

@@ -0,0 +1 @@
+browse_ai_api_key: 'YOUR TESTING API KEY GOES HERE'

data/lib/browse_ai/client.rb

@@ -0,0 +1,78 @@
+require 'faraday'
+require 'faraday/multipart'
+require 'json'
+require 'openssl'
+require 'active_support/all'
+require 'browse_ai/dsl'
+require 'browse_ai/errors'
+require 'browse_ai/utils'
+
+module BrowseAi
+  class Client
+    include DSL
+    include Errors
+    include Utils
+
+    REQUESTS = %i[get post put delete]
+    HEADERS = { 'Accept' => 'application/json', 'Content-Type' => 'application/json' }
+
+    def initialize(api_key = BrowseAi.api_key, url = BrowseAi.url)
+      @api_key = api_key
+      @url = url
+
+      # Setup HTTP request connection to UpWoof.
+      @connection ||= Faraday.new do |builder|
+        builder.request :multipart
+        builder.request :url_encoded
+        builder.response :logger
+        builder.adapter Faraday.default_adapter
+      end
+    end
+
+    # @param [:get, :post, :put, :delete] method.
+    # @param [String] path.
+    # @param [Hash] query (optional).
+    # @param [Hash] headers request headers (optional).
+    # @raise [ArgumentError] If the response is blank.
+    # @raise [ResourceNotFoundError] If the response code is 404.
+    # @raise [ClientError] If the response code is not in the success range.
+    # @return [Faraday::Response] server response.
+    def request(method, path, query = {}, headers = {})
+      headers.reverse_merge!(default_headers)
+
+      unless REQUESTS.include?(method)
+        raise ArgumentError,
+              "Unsupported method #{method.inspect}. Only :get, :post, :put, :delete are allowed"
+      end
+
+      token_url = UrlHelper.build_url(path: "#{@url}#{path}")
+      payload = nil
+      if query.present?
+        accept = headers.present? ? headers['Accept'] : nil
+        payload = if accept.present? && accept == 'application/json'
+                    JSON.generate(query)
+                  else
+                    query
+                  end
+      end
+      response = @connection.run_request(method, token_url, payload, headers)
+
+      case response.status.to_i
+      when 200..299
+        response
+      when 404
+        raise ResourceNotFoundError.new(response: response)
+      else
+        raise ClientError.new(response: response)
+      end
+    end
+
+    def default_headers
+      {
+        'Accept' => 'application/json',
+        'Content-Type' => 'application/json',
+        'Authorization' => "Bearer #{@api_key}"
+      }
+    end
+  end
+end

data/lib/browse_ai/dsl/monitors.rb

@@ -0,0 +1,27 @@
+require 'browse_ai/dsl'
+
+module BrowseAi
+  module DSL::Monitors
+    # GET /Monitors
+    # Get monitors.
+    # @param [String] robot_id The ID of the robot the monitors belong to.
+    # @return [Array, nil].
+    def get_monitors(robot_id:)
+      raise ArgumentError, 'Robot ID cannot be blank' if robot_id.blank?
+
+      Resources::Monitor.parse(request(:get, "robots/#{robot_id}/monitors/", nil), %w[monitors items])
+    end
+
+    # GET /Monitor/{id}
+    # Get a monitor.
+    # @param [String] id A monitor's ID.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [BrowseAi::Resources::Monitor, nil].
+    def get_monitor(robot_id:, id:)
+      raise ArgumentError, 'Robot ID cannot be blank' if robot_id.blank?
+      raise ArgumentError, 'ID cannot be blank' if id.blank?
+
+      Resources::Monitor.parse(request(:get, "robots/#{robot_id}/monitors/#{id}"), ['monitor'])
+    end
+  end
+end

data/lib/browse_ai/dsl/robots.rb

@@ -0,0 +1,23 @@
+require 'browse_ai/dsl'
+
+module BrowseAi
+  module DSL::Robots
+    # GET /Robots
+    # Get robots.
+    # @return [Array, nil].
+    def get_robots
+      Resources::Robot.parse(request(:get, 'robots/', nil), %w[robots items])
+    end
+
+    # GET /Robot/{id}
+    # Get a robot.
+    # @param [String] id A robot's ID.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [BrowseAi::Resources::Robot, nil].
+    def get_robot(id:)
+      raise ArgumentError, 'ID cannot be blank' if id.blank?
+
+      Resources::Robot.parse(request(:get, "robots/#{id}"), ['robot'])
+    end
+  end
+end

data/lib/browse_ai/dsl/tasks.rb

@@ -0,0 +1,27 @@
+require 'browse_ai/dsl'
+
+module BrowseAi
+  module DSL::Tasks
+    # GET /Tasks
+    # Get tasks.
+    # @param [String] robot_id The ID of the robot the tasks belong to.
+    # @return [Array, nil].
+    def get_tasks(robot_id:)
+      raise ArgumentError, 'Robot ID cannot be blank' if robot_id.blank?
+
+      Resources::Task.parse(request(:get, "robots/#{robot_id}/tasks/", nil), %w[tasks items])
+    end
+
+    # GET /Task/{id}
+    # Get a task.
+    # @param [String] id A task's ID.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [BrowseAi::Resources::Task, nil].
+    def get_task(robot_id:, id:)
+      raise ArgumentError, 'Robot ID cannot be blank' if robot_id.blank?
+      raise ArgumentError, 'ID cannot be blank' if id.blank?
+
+      Resources::Task.parse(request(:get, "robots/#{robot_id}/tasks/#{id}"), ['task'])
+    end
+  end
+end

data/lib/browse_ai/dsl/webhooks.rb

@@ -0,0 +1,15 @@
+require 'browse_ai/dsl'
+
+module BrowseAi
+  module DSL::Webhooks
+    # GET /Webhooks
+    # Get webhooks.
+    # @param [String] robot_id The ID of the robot the webhooks belong to.
+    # @return [Array, nil].
+    def get_webhooks(robot_id:)
+      raise ArgumentError, 'Robot ID cannot be blank' if robot_id.blank?
+
+      Resources::Webhook.parse(request(:get, "robots/#{robot_id}/webhooks/", nil), %w[webhooks items])
+    end
+  end
+end

data/lib/browse_ai/dsl.rb

@@ -0,0 +1,23 @@
+require 'browse_ai'
+
+module BrowseAi
+  module DSL
+  end
+end
+
+require 'browse_ai/dsl/monitors'
+require 'browse_ai/dsl/robots'
+require 'browse_ai/dsl/tasks'
+require 'browse_ai/dsl/webhooks'
+require 'browse_ai/utils'
+require 'mime-types'
+
+module BrowseAi
+  module DSL
+    include Monitors
+    include Robots
+    include Tasks
+    include Utils
+    include Webhooks
+  end
+end

data/lib/browse_ai/errors/client_error.rb

@@ -0,0 +1,9 @@
+module BrowseAi
+  module Errors
+    class ClientError < StandardError
+      def initialize(response:)
+        @response = response
+      end
+    end
+  end
+end

data/lib/browse_ai/errors/resource_not_found_error.rb

@@ -0,0 +1,8 @@
+require 'browse_ai/errors/client_error'
+
+module BrowseAi
+  module Errors
+    class ResourceNotFoundError < ClientError
+    end
+  end
+end

data/lib/browse_ai/errors.rb

@@ -0,0 +1,9 @@
+require 'browse_ai'
+
+module BrowseAi
+  module Errors
+  end
+end
+
+require 'browse_ai/errors/resource_not_found_error'
+require 'browse_ai/errors/client_error'

data/lib/browse_ai/resources/monitor.rb

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

data/lib/browse_ai/resources/object/attributes.rb

@@ -0,0 +1,69 @@
+module BrowseAi::Resources::Object::Attributes
+  module ClassMethods
+    def attributes
+      @attributes ||=
+        if superclass.respond_to?(:attributes)
+          superclass.attributes.dup
+        else
+          Hash.new { |hash, key| hash[key] = ::Object }
+        end
+    end
+
+    # @return [Module] module holding all attribute accessors
+    def attributes_module
+      @attributes_module ||= const_set(:AttributeMethods, Module.new)
+    end
+
+    def define_attribute_accessor(name, type = nil)
+      type ||= attributes[name.to_sym] || Object
+      attributes_module.send(:define_method, name) do
+        deserialize_attribute(name, type)
+      end
+    end
+
+    def attribute(name, type = String)
+      attributes[name] = type
+
+      define_attribute_accessor(name, type)
+    end
+
+    alias has_many attribute
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+    super
+  end
+
+  def attributes
+    {}.tap do |result|
+      __getobj__.keys.each do |key|
+        attribute = key.to_s.downcase
+        result[attribute] = public_send(attribute)
+      end
+    end
+  end
+
+  def method_missing(name, *args, &block)
+    attribute = name.to_s.upcase
+    if __getobj__.key?(attribute)
+      self.class.define_attribute_accessor(name)
+      deserialize_attribute(name, self.class.attributes[name.to_sym])
+    else
+      super
+    end
+  end
+
+  private
+
+  def respond_to_missing?(name, include_all = false)
+    __getobj__.key?(name.to_s.upcase) || super(name, include_all)
+  end
+
+  # @param [String, Symbol] name
+  # @param [Class, #to_s] type
+  def deserialize_attribute(name, type)
+    raw = __getobj__[name.to_s.upcase]
+    self.class.serializer_for(type).deserialize(raw)
+  end
+end

data/lib/browse_ai/resources/object/serializers.rb

@@ -0,0 +1,104 @@
+require 'logger'
+module BrowseAi
+  module Resources
+    class Object
+      module Serializers
+        module Object
+          def self.serialize(value)
+            value.to_s
+          end
+
+          def self.deserialize(value)
+            case value
+            when Array
+              value.map { |v| v.deep_transform_keys { |key| key.downcase } }
+            when Hash
+              value.deep_transform_keys { |key| key.downcase }
+            else
+              value
+            end
+          end
+        end
+
+        module Time
+          def self.serialize(value)
+            value.utc.xmlschema
+          end
+
+          def self.deserialize(value)
+            ::Time.parse(value)
+          end
+        end
+
+        module ClassMethods
+          # @return [Hash] corresponding serializers for different attributes
+          def serializers
+            @serializers ||= {}
+          end
+
+          # @param [String, Symbol] type type of attribute to be serialized or deserialized
+          # @return [#serialize, #deserialize] serializer for provided type
+          def serializer_for(type)
+            serializers[type] ||=
+              begin
+                class_symbol = type.to_s.to_sym
+                if type.respond_to?(:deserialize) && type.respond_to?(:serialize)
+                  type
+                elsif Serializers.constants.include?(class_symbol)
+                  Serializers.const_get(class_symbol)
+                elsif Resources.constants.include?(class_symbol)
+                  Resources.const_get(class_symbol)
+                else
+                  Serializers::Object
+                end
+              end
+          end
+
+          # Deserialize a Faraday response.
+          # @param [Faraday::Response] response.
+          # @raise [ArgumentError] If the response is blank.
+          # @return [Object, nil].
+          def deserialize(response, root = [])
+            raise ArgumentError, 'Response cannot be blank' if response.blank?
+
+            attributes = response.body
+            begin
+              attributes = JSON.parse(response.body)
+              attributes = attributes.dig(*root) if attributes.is_a?(Hash) && root.any?
+
+              case attributes
+              when Array
+                return attributes.map { |object| new(object) }
+              when Hash
+                return new(attributes)
+              end
+            rescue JSON::ParserError
+              logger = Logger.new(STDOUT)
+              logger.error("Could not parse: #{response.body}")
+            end
+            nil
+          end
+
+          alias parse deserialize
+
+          def serialize(object)
+            object.serialize
+          end
+        end
+
+        def self.included(base)
+          super
+          base.extend ClassMethods
+        end
+
+        def serialize
+          {}.tap do |result|
+            attributes.each do |name, value|
+              result[name.upcase] = self.class.serializer_for(name).serialize(value)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/browse_ai/resources/object.rb

@@ -0,0 +1,29 @@
+require 'delegate'
+require 'json'
+require 'time'
+
+module BrowseAi
+  module Resources
+    class Object < SimpleDelegator
+      require 'browse_ai/resources/object/serializers'
+      require 'browse_ai/resources/object/attributes'
+
+      include Serializers
+      include Attributes
+
+      # Define common attributes, applicable to different resources
+      attribute :date_created_utc, Time
+      attribute :date_updated_utc, Time
+
+      def inspect
+        "#<#{self.class.name}:#{format('0x00%x', (object_id << 1))} #{inspect_attributes}>"
+      end
+
+      private
+
+      def inspect_attributes
+        attributes.map { |key, value| "@#{key}=#{value.inspect}" }.join(' ')
+      end
+    end
+  end
+end

data/lib/browse_ai/resources/robot.rb

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

data/lib/browse_ai/resources/task.rb

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

data/lib/browse_ai/resources/webhook.rb

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

data/lib/browse_ai/resources.rb

@@ -0,0 +1,12 @@
+require 'browse_ai'
+
+module BrowseAi
+  module Resources
+  end
+end
+
+require 'browse_ai/resources/monitor'
+require 'browse_ai/resources/object'
+require 'browse_ai/resources/robot'
+require 'browse_ai/resources/task'
+require 'browse_ai/resources/webhook'

data/lib/browse_ai/utils/url_helper.rb

@@ -0,0 +1,17 @@
+module BrowseAi
+  module Utils
+    class UrlHelper
+      # Build a URL with a querystring containing optional params if supplied.
+      # @param [String] path The name of the resource path as per the URL e.g. contacts.
+      # @param [Hash] params A hash of params we're turning into a querystring (optional).
+      # @return [String] The URL of the resource with required params.
+      def self.build_url(path:, params: {})
+        params.delete_if { |_k, v| v.blank? }
+        params = params.to_query
+        query = path
+        query << ('?' + params) unless params.blank?
+        query
+      end
+    end
+  end
+end

data/lib/browse_ai/utils.rb

@@ -0,0 +1,8 @@
+require 'browse_ai'
+
+module BrowseAi
+  module Utils
+  end
+end
+
+require 'browse_ai/utils/url_helper'

data/lib/browse_ai/version.rb

@@ -0,0 +1,3 @@
+module BrowseAi
+  VERSION = '1.0.0'
+end

data/lib/browse_ai.rb

@@ -0,0 +1,24 @@
+require 'browse_ai/version'
+
+module BrowseAi
+  autoload :Client, 'browse_ai/client'
+  autoload :DSL, 'browse_ai/dsl'
+  autoload :Resources, 'browse_ai/resources'
+  autoload :Errors, 'browse_ai/errors'
+  autoload :Utils, 'browse_ai/utils'
+
+  class << self
+    # @return [String]
+    attr_accessor :api_key
+    attr_accessor :url, :logger
+  end
+
+  self.url = 'https://api.browse.ai/v2/'
+
+  module_function
+
+  # @return [BrowseAi::Client]
+  def client
+    @client ||= Client.new(BrowseAi.api_key, BrowseAi.url)
+  end
+end

data/spec/browse_ai/client_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe BrowseAi::Client do
+  subject(:client) { BrowseAi::Client.new }
+end

data/spec/browse_ai/dsl/monitors_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe BrowseAi::DSL::Monitors do
+  def robot_id
+    VCR.use_cassette('get_robots') do
+      robots = BrowseAi.client.get_robots
+      robots.first['id']
+    end
+  end
+
+  # GET /monitors
+  describe '#get_monitors' do
+    it 'returns an array of monitors' do
+      VCR.use_cassette('get_monitors') do
+        monitors = BrowseAi.client.get_monitors(robot_id:)
+        expect(monitors).to be_a(Array)
+        expect(monitors.first).to be_a(Monitor)
+      end
+    end
+  end
+
+  # GET /monitors/{id}
+  describe '#get_monitor' do
+    it 'returns an monitor' do
+      id = VCR.use_cassette('get_monitors') do
+        monitors = BrowseAi.client.get_monitors(robot_id:)
+        monitors.first['id']
+      end
+
+      VCR.use_cassette('get_monitor') do
+        expect(BrowseAi.client.get_monitor(robot_id:, id:)).to be_a(Monitor)
+      end
+    end
+  end
+end

data/spec/browse_ai/dsl/robots_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe BrowseAi::DSL::Robots do
+  # GET /robots
+  describe '#get_robots' do
+    it 'returns an array of robots' do
+      VCR.use_cassette('get_robots') do
+        robots = BrowseAi.client.get_robots
+        expect(robots).to be_a(Array)
+        expect(robots.first).to be_a(Robot)
+      end
+    end
+  end
+
+  # GET /robots/{id}
+  describe '#get_robot' do
+    it 'returns an robot' do
+      id = VCR.use_cassette('get_robots') do
+        robots = BrowseAi.client.get_robots
+        robots.first['id']
+      end
+
+      VCR.use_cassette('get_robot') do
+        expect(BrowseAi.client.get_robot(id:)).to be_a(Robot)
+      end
+    end
+  end
+end

data/spec/browse_ai/dsl/tasks_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe BrowseAi::DSL::Tasks do
+  def robot_id
+    VCR.use_cassette('get_robots') do
+      robots = BrowseAi.client.get_robots
+      robots.first['id']
+    end
+  end
+
+  # GET /tasks
+  describe '#get_tasks' do
+    it 'returns an array of tasks' do
+      VCR.use_cassette('get_tasks') do
+        tasks = BrowseAi.client.get_tasks(robot_id:)
+        expect(tasks).to be_a(Array)
+        expect(tasks.first).to be_a(Task)
+      end
+    end
+  end
+
+  # GET /tasks/{id}
+  describe '#get_task' do
+    it 'returns an task' do
+      id = VCR.use_cassette('get_tasks') do
+        tasks = BrowseAi.client.get_tasks(robot_id:)
+        tasks.first['id']
+      end
+
+      VCR.use_cassette('get_task') do
+        expect(BrowseAi.client.get_task(robot_id:, id:)).to be_a(Task)
+      end
+    end
+  end
+end

data/spec/browse_ai/dsl/webhooks_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe BrowseAi::DSL::Webhooks do
+  def robot_id
+    VCR.use_cassette('get_robots') do
+      robots = BrowseAi.client.get_robots
+      robots.first['id']
+    end
+  end
+
+  # GET /webhooks
+  describe '#get_webhooks' do
+    it 'returns an array of webhooks' do
+      VCR.use_cassette('get_webhooks') do
+        webhooks = BrowseAi.client.get_webhooks(robot_id:)
+        expect(webhooks).to be_a(Array)
+        expect(webhooks.first).to be_a(Webhook)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'webmock/rspec'
+require 'browse_ai'
+require 'vcr'
+include BrowseAi::Resources
+
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+cnf = YAML.load_file(File.join(APP_ROOT, 'config/gem_secret.yml'))
+browse_ai_api_key = cnf['browse_ai_api_key']
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.hook_into :webmock
+  c.filter_sensitive_data('<BROWSE_AI_API_KEY>') { browse_ai_api_key }
+end
+
+RSpec.configure do |config|
+  config.before do
+    BrowseAi.api_key = browse_ai_api_key
+  end
+end

metadata

@@ -0,0 +1,244 @@
+--- !ruby/object:Gem::Specification
+name: browse_ai
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- David Iorns
+bindir: bin
+cert_chain: []
+date: 2025-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.2
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.13.1
+  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
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.9
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.13.1
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.3.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.25'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.25.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.25'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.25.1
+email:
+- david.iorns@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".github/dependabot.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- browse_ai.gemspec
+- config/gem_secret.yml.example
+- lib/.DS_Store
+- lib/browse_ai.rb
+- lib/browse_ai/client.rb
+- lib/browse_ai/dsl.rb
+- lib/browse_ai/dsl/monitors.rb
+- lib/browse_ai/dsl/robots.rb
+- lib/browse_ai/dsl/tasks.rb
+- lib/browse_ai/dsl/webhooks.rb
+- lib/browse_ai/errors.rb
+- 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/monitor.rb
+- lib/browse_ai/resources/object.rb
+- lib/browse_ai/resources/object/attributes.rb
+- lib/browse_ai/resources/object/serializers.rb
+- lib/browse_ai/resources/robot.rb
+- lib/browse_ai/resources/task.rb
+- lib/browse_ai/resources/webhook.rb
+- lib/browse_ai/utils.rb
+- lib/browse_ai/utils/url_helper.rb
+- lib/browse_ai/version.rb
+- spec/browse_ai/client_spec.rb
+- spec/browse_ai/dsl/monitors_spec.rb
+- spec/browse_ai/dsl/robots_spec.rb
+- spec/browse_ai/dsl/tasks_spec.rb
+- spec/browse_ai/dsl/webhooks_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.browse.ai/
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.6
+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/monitors_spec.rb
+- spec/browse_ai/dsl/robots_spec.rb
+- spec/browse_ai/dsl/tasks_spec.rb
+- spec/browse_ai/dsl/webhooks_spec.rb
+- spec/spec_helper.rb