testingbot 0.2.3 → 1.0.0

data/lib/testingbot/resources/jobs.rb

@@ -0,0 +1,11 @@
+module TestingBot
+  module Resources
+    # Endpoints under /jobs.
+    module Jobs
+      # Poll the status/result of an asynchronous job (e.g. a Codeless Lab run).
+      def get_job(job_id)
+        get("/jobs/#{escape(job_id)}")
+      end
+    end
+  end
+end

data/lib/testingbot/resources/lab.rb

@@ -0,0 +1,74 @@
+module TestingBot
+  module Resources
+    # Codeless Lab test endpoints under /lab.
+    module Lab
+      def get_lab_tests(offset = 0, count = 10)
+        get("/lab#{query(:offset => offset, :count => count)}")
+      end
+
+      def create_lab_test(params = {})
+        post("/lab", params)
+      end
+
+      def get_lab_test(lab_test_id)
+        get("/lab/#{escape(lab_test_id)}")
+      end
+
+      def update_lab_test(lab_test_id, params = {})
+        put("/lab/#{escape(lab_test_id)}", params)
+      end
+
+      def delete_lab_test(lab_test_id)
+        delete("/lab/#{escape(lab_test_id)}")
+      end
+
+      def get_lab_test_steps(lab_test_id)
+        get("/lab/#{escape(lab_test_id)}/steps")
+      end
+
+      def set_lab_test_steps(lab_test_id, params = {})
+        post("/lab/#{escape(lab_test_id)}/steps", params)
+      end
+
+      def get_lab_test_browsers(lab_test_id)
+        get("/lab/#{escape(lab_test_id)}/browsers")
+      end
+
+      def set_lab_test_browsers(lab_test_id, params = {})
+        post("/lab/#{escape(lab_test_id)}/browsers", params)
+      end
+
+      def add_lab_test_alert(lab_test_id, params = {})
+        post("/lab/#{escape(lab_test_id)}/alert", params)
+      end
+
+      def update_lab_test_alert(lab_test_id, params = {})
+        put("/lab/#{escape(lab_test_id)}/alert", params)
+      end
+
+      def create_lab_test_report(lab_test_id, params = {})
+        post("/lab/#{escape(lab_test_id)}/report", params)
+      end
+
+      def update_lab_test_report(lab_test_id, params = {})
+        put("/lab/#{escape(lab_test_id)}/report", params)
+      end
+
+      def schedule_lab_test(lab_test_id, params = {})
+        post("/lab/#{escape(lab_test_id)}/schedule", params)
+      end
+
+      def trigger_lab_test(lab_test_id, params = {})
+        post("/lab/#{escape(lab_test_id)}/trigger", params)
+      end
+
+      def stop_lab_test(lab_test_id)
+        put("/lab/#{escape(lab_test_id)}/stop")
+      end
+
+      def trigger_all_lab_tests(params = {})
+        post("/lab/trigger_all", params)
+      end
+    end
+  end
+end

data/lib/testingbot/resources/lab_suites.rb

@@ -0,0 +1,46 @@
+module TestingBot
+  module Resources
+    # Codeless Lab suite endpoints under /labsuites.
+    module LabSuites
+      def get_lab_suites(offset = 0, count = 10)
+        get("/labsuites#{query(:offset => offset, :count => count)}")
+      end
+
+      def create_lab_suite(params = {})
+        post("/labsuites", params)
+      end
+
+      def get_lab_suite(suite_id)
+        get("/labsuites/#{escape(suite_id)}")
+      end
+
+      def delete_lab_suite(suite_id)
+        delete("/labsuites/#{escape(suite_id)}")
+      end
+
+      def get_lab_suite_tests(suite_id)
+        get("/labsuites/#{escape(suite_id)}/tests")
+      end
+
+      def add_lab_suite_tests(suite_id, params = {})
+        post("/labsuites/#{escape(suite_id)}/tests", params)
+      end
+
+      def remove_lab_suite_test(suite_id, test_id)
+        delete("/labsuites/#{escape(suite_id)}/tests/#{escape(test_id)}")
+      end
+
+      def get_lab_suite_browsers(suite_id)
+        get("/labsuites/#{escape(suite_id)}/browsers")
+      end
+
+      def set_lab_suite_browsers(suite_id, params = {})
+        post("/labsuites/#{escape(suite_id)}/browsers", params)
+      end
+
+      def trigger_lab_suite(suite_id, params = {})
+        post("/labsuites/#{escape(suite_id)}/trigger", params)
+      end
+    end
+  end
+end

data/lib/testingbot/resources/platform.rb

@@ -0,0 +1,29 @@
+module TestingBot
+  module Resources
+    # Browser, device and configuration endpoints.
+    module Platform
+      def get_browsers
+        get("/browsers")
+      end
+
+      # Optionally filter server-side by platform and/or web capability.
+      def get_devices(platform = nil, web = nil)
+        get("/devices#{query(:platform => platform, :web => web)}")
+      end
+
+      def get_available_devices
+        get("/devices/available")
+      end
+
+      # Fetch a single physical device by its numeric ID.
+      def get_device(device_id)
+        get("/devices/#{escape(device_id)}")
+      end
+
+      # List the IP ranges TestingBot tests originate from (firewall allow-listing).
+      def get_ip_ranges
+        get("/configuration/ip-ranges")
+      end
+    end
+  end
+end

data/lib/testingbot/resources/screenshots.rb

@@ -0,0 +1,19 @@
+module TestingBot
+  module Resources
+    # Endpoints under /screenshots.
+    module Screenshots
+      def take_screenshots(configuration)
+        post("/screenshots", configuration)
+      end
+
+      def get_screenshots_history(offset = 0, count = 10)
+        get("/screenshots#{query(:offset => offset, :count => count)}")
+      end
+
+      # +params+ accepts the optional excludeIds query param.
+      def get_screenshots(screenshots_id, params = {})
+        get("/screenshots/#{escape(screenshots_id)}#{query(params)}")
+      end
+    end
+  end
+end

data/lib/testingbot/resources/sharing.rb

@@ -0,0 +1,13 @@
+require 'digest'
+
+module TestingBot
+  module Resources
+    # Test/build sharing helpers.
+    module Sharing
+      # Compute the hash used to share private tests/builds with other people.
+      def get_authentication_hash(identifier)
+        Digest::MD5.hexdigest("#{@key}:#{@secret}:#{identifier}")
+      end
+    end
+  end
+end

data/lib/testingbot/resources/storage.rb

@@ -0,0 +1,44 @@
+module TestingBot
+  module Resources
+    # TestingBot Storage endpoints under /storage (mobile app testing).
+    #
+    # App URLs target a wildcard route, so they are only stripped of their
+    # tb:// scheme (slashes are preserved, not escaped).
+    module Storage
+      def upload_local_file(file_path)
+        File.open(file_path, 'rb') do |io|
+          @connection.request(:post, "/storage", { :multipart => true, :file => io }, :timeout => 600)
+        end
+      end
+
+      def upload_remote_file(url)
+        post("/storage", { :url => url })
+      end
+
+      # Replace the binary stored under an existing app key with a local file.
+      def update_local_file(app_url, file_path)
+        File.open(file_path, 'rb') do |io|
+          @connection.request(:post, "/storage/#{strip_scheme(app_url)}",
+                              { :multipart => true, :file => io }, :timeout => 600)
+        end
+      end
+
+      # Replace the binary stored under an existing app key with a remote URL.
+      def update_remote_file(app_url, url)
+        post("/storage/#{strip_scheme(app_url)}", { :url => url })
+      end
+
+      def get_uploaded_files(offset = 0, count = 10)
+        get("/storage#{query(:offset => offset, :count => count)}")
+      end
+
+      def get_uploaded_file(app_url)
+        get("/storage/#{strip_scheme(app_url)}")
+      end
+
+      def delete_uploaded_file(app_url)
+        success?(delete("/storage/#{strip_scheme(app_url)}"))
+      end
+    end
+  end
+end

data/lib/testingbot/resources/team.rb

@@ -0,0 +1,35 @@
+module TestingBot
+  module Resources
+    # Endpoints under /team-management.
+    module Team
+      def get_team
+        get("/team-management")
+      end
+
+      def get_users_in_team(offset = 0, count = 10)
+        get("/team-management/users#{query(:offset => offset, :count => count)}")
+      end
+
+      def get_user_in_team(user_id)
+        get("/team-management/users/#{escape(user_id)}")
+      end
+
+      # Fetch a team member's API client key (requires ADMIN rights).
+      def get_user_client_key(user_id)
+        get("/team-management/users/#{escape(user_id)}/client-key")
+      end
+
+      def create_user_in_team(user = {})
+        post("/team-management/users", user)
+      end
+
+      def update_user_in_team(user_id, user = {})
+        put("/team-management/users/#{escape(user_id)}", user)
+      end
+
+      def reset_credentials(user_id)
+        post("/team-management/users/#{escape(user_id)}/reset-keys")
+      end
+    end
+  end
+end

data/lib/testingbot/resources/tests.rb

@@ -0,0 +1,28 @@
+module TestingBot
+  module Resources
+    # Endpoints under /tests.
+    module Tests
+      # +filters+ accepts the backend's optional query params: since, browser_id,
+      # group, build, skip_fields.
+      def get_tests(offset = 0, count = 10, filters = {})
+        get("/tests#{query({ :offset => offset, :count => count }.merge(filters))}")
+      end
+
+      def get_test(test_id)
+        get("/tests/#{escape(test_id)}")
+      end
+
+      def update_test(test_id, params = {})
+        success?(put("/tests/#{escape(test_id)}", wrap_params("test", params)))
+      end
+
+      def delete_test(test_id)
+        success?(delete("/tests/#{escape(test_id)}"))
+      end
+
+      def stop_test(test_id)
+        success?(put("/tests/#{escape(test_id)}/stop"))
+      end
+    end
+  end
+end

data/lib/testingbot/resources/tunnels.rb

@@ -0,0 +1,20 @@
+module TestingBot
+  module Resources
+    # Endpoints under /tunnel.
+    module Tunnels
+      def get_tunnels
+        get("/tunnel/list")
+      end
+
+      # Fetch the active tunnel, or a specific tunnel by numeric ID.
+      def get_tunnel(tunnel_identifier = nil)
+        tunnel_identifier ? get("/tunnel/#{escape(tunnel_identifier)}") : get("/tunnel")
+      end
+
+      # Delete a tunnel by ID, or the active tunnel when called without an argument.
+      def delete_tunnel(tunnel_identifier = nil)
+        delete(tunnel_identifier ? "/tunnel/#{escape(tunnel_identifier)}" : "/tunnel")
+      end
+    end
+  end
+end

data/lib/testingbot/resources/user.rb

@@ -0,0 +1,19 @@
+module TestingBot
+  module Resources
+    # Endpoints under /user.
+    module User
+      def get_user_info
+        get("/user")
+      end
+
+      def update_user_info(params = {})
+        success?(put("/user", wrap_params("user", params)))
+      end
+
+      # Retrieve the account's API key/secret pair.
+      def get_user_keys
+        get("/user/keys")
+      end
+    end
+  end
+end

data/lib/testingbot/version.rb

@@ -1,3 +1,3 @@
-module Testingbot
-  VERSION = "0.2.3"
+module TestingBot
+  VERSION = "1.0.0"
 end

data/lib/testingbot.rb

@@ -1 +1,4 @@
-require "testingbot/api"
+require "testingbot/version"
+require "testingbot/errors"
+require "testingbot/connection"
+require "testingbot/api"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: testingbot
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Jochen Delabie
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-22 00:00:00.000000000 Z
+date: 2026-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: This gem makes interacting with the TestingBot API easy with Ruby
 email:
 - info@testingbot.com
@@ -74,8 +88,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/release.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -83,10 +99,21 @@ files:
 - bin/testingbot
 - lib/testingbot.rb
 - lib/testingbot/api.rb
+- lib/testingbot/connection.rb
+- lib/testingbot/errors.rb
+- lib/testingbot/resources/builds.rb
+- lib/testingbot/resources/jobs.rb
+- lib/testingbot/resources/lab.rb
+- lib/testingbot/resources/lab_suites.rb
+- lib/testingbot/resources/platform.rb
+- lib/testingbot/resources/screenshots.rb
+- lib/testingbot/resources/sharing.rb
+- lib/testingbot/resources/storage.rb
+- lib/testingbot/resources/team.rb
+- lib/testingbot/resources/tests.rb
+- lib/testingbot/resources/tunnels.rb
+- lib/testingbot/resources/user.rb
 - lib/testingbot/version.rb
-- spec/integration/api_spec.rb
-- spec/resources/test.apk
-- spec/spec_helper.rb
 homepage: https://testingbot.com
 licenses:
 - MIT
@@ -95,7 +122,7 @@ metadata:
   documentation_uri: https://github.com/testingbot/testingbot_ruby
   homepage_uri: https://github.com/testingbot/testingbot_ruby
   source_code_uri: https://github.com/testingbot/testingbot_ruby
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -110,11 +137,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Ruby API Gem to be used with testingbot.com
-test_files:
-- spec/integration/api_spec.rb
-- spec/resources/test.apk
-- spec/spec_helper.rb
+test_files: []

data/spec/integration/api_spec.rb

@@ -1,108 +0,0 @@
-require "uri"
-require "net/http"
-require 'rspec'
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-
-describe "Testingbot Api" do
-  context "the API should return valid user information" do
-    it "should return info for the current user" do 
-      @api = TestingBot::Api.new
-      @api.get_user_info.should_not be_empty
-      @api.get_user_info["first_name"].should_not be_empty
-    end
-
-    it "should raise an error when wrong credentials are provided" do
-      @api = TestingBot::Api.new("bogus", "false")
-      lambda { @api.get_user_info }.should raise_error(RestClient::Unauthorized)
-    end
-  end
-
-  context "updating my user info via the API should work" do
-    it "should allow me to update my own user info" do
-      @api = TestingBot::Api.new
-      new_name = rand(36**9).to_s(36)
-      @api.update_user_info({ "first_name" => new_name }).should == true
-      @api.get_user_info["first_name"].should == new_name
-    end
-  end
-
-  context "retrieve my own tests" do
-    it "should retrieve a list of my own tests" do
-      @api = TestingBot::Api.new
-      @api.get_tests.include?("data").should == true
-    end
-
-    it "should provide info for a specific test" do
-      @api = TestingBot::Api.new
-      data = @api.get_tests["data"]
-      if data.length > 0
-        test_id = data.first["id"]
-        
-        single_test = @api.get_test(test_id)
-        single_test["id"].should == test_id
-      end
-    end
-
-    it "should fail when trying to access a test that is not mine" do
-      @api = TestingBot::Api.new
-      lambda { @api.get_test(123423423423423) }.should raise_error(RestClient::NotFound)
-    end
-  end
-
-  context "update a test" do
-    it "should update a test of mine" do
-      @api = TestingBot::Api.new
-      data = @api.get_tests["data"]
-      if data.length > 0
-        test_id = data.first["id"]
-        new_name = rand(36**9).to_s(36)
-        @api.update_test(test_id, { :name => new_name }).should == true
-        single_test = @api.get_test(test_id)
-        single_test["name"].should == new_name
-      end
-    end
-
-    it "should not update a test that is not mine" do
-      @api = TestingBot::Api.new
-      lambda { @api.update_test(123423423423423, { :name => "testingbot" }) }.should raise_error(RestClient::NotFound)
-    end
-  end
-
-  context "fetch browsers" do
-    it "should fetch a list of browsers" do
-      @api = TestingBot::Api.new
-      @api.get_browsers.should_not be_empty
-    end
-  end
-
-  context "delete a test" do
-    it "should delete a test of mine" do
-      @api = TestingBot::Api.new
-      data = @api.get_tests["data"]
-      if data.length > 0
-        test_id = data.first["id"]
-        @api.delete_test(test_id).should == true
-        lambda { @api.get_test(test_id) }.should raise_error(RestClient::NotFound)
-      end
-    end
-
-    it "should not delete a test that is not mine" do
-      @api = TestingBot::Api.new
-      lambda { @api.delete_test(123423423423423) }.should raise_error(RestClient::NotFound)
-    end
-  end
-
-  context "TestingBot Storage" do
-    it "should upload a local file" do
-      @api = TestingBot::Api.new
-      response = @api.upload_local_file(File.join(File.dirname(__FILE__), "../resources/test.apk"))
-      response["app_url"].should include("tb://")
-    end
-
-    it "should upload a remote file" do
-      @api = TestingBot::Api.new
-      response = @api.upload_remote_file("https://testingbot.com/appium/sample.apk")
-      response["app_url"].should include("tb://")
-    end
-  end
-end

data/spec/resources/test.apk

@@ -1 +0,0 @@
-ok

data/spec/spec_helper.rb

@@ -1,7 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/../lib/testingbot/api.rb')
-require File.expand_path(File.dirname(__FILE__) + '/../lib/testingbot.rb')
-RSpec.configure do |config|
-  config.expect_with :rspec do |expectations|
-    expectations.syntax = :should
-  end
-end