browserstack-ruby-sdk 0.1.0

data/sample/browserstack_sample.yml

@@ -0,0 +1,298 @@
+# =============================================================================================================================
+# Set BrowserStack Credentials
+# =============================================================================================================================
+userName: YOUR_USERNAME
+accessKey: YOUR_ACCESS_KEY
+
+# =============================================================================================================================
+# Parallels per Platform
+# =============================================================================================================================
+# The number of parallel threads to be used for each platform set.
+# BrowserStack's SDK runner will select the best strategy based on the configured value
+#
+# Example 1 - If you have configured 3 platforms and set `parallelsPerPlatform` as 2, a total of 6 (2 * 3) parallel threads
+# will be used on BrowserStack
+#
+# Example 2 - If you have configured 1 platform and set `parallelsPerPlatform` as 5, a total of 5 (1 * 5) parallel threads 
+# will be used on BrowserStack
+parallelsPerPlatform: 1
+
+# =============================================================================================================================
+# Platforms (Browsers / Devices to test)
+# =============================================================================================================================
+# Platforms object contains all the browser / device combinations you want to test on.
+
+platforms:
+  - os: OS X
+    osVersion: Big Sur
+    browserName: Chrome
+    browserVersion: latest
+    # ===============================================
+    # Chrome Browser Specific Capabilities (OPTIONAL)
+    # ===============================================
+    chrome:
+      driver: 112.0.5615.28
+    chromeOptions: 
+      args:                      
+        - --start-maximized
+    # ===============================================  
+  - os: Windows
+    osVersion: 11
+    browserName: Edge
+    browserVersion: latest
+    # ===============================================
+    # Edge Browser Specific Capabilities (OPTIONAL)
+    # ===============================================
+    edge: 
+      enablePopups: false #<boolean> (Default: X) Set to true if you want to enable Popups
+      enableSidebar: false #<boolean> (Default: X) Set to true if you want to enable sidebar
+    # ===============================================        
+  - os: Windows
+    osVersion: 10
+    browserName: Firefox
+    browserVersion: latest
+    # ===============================================
+    # Firefox Browser Specific Capabilities (OPTIONAL)
+    # ===============================================
+    firefox: 
+      driver: 0.32.0 #Set the driver version you want to use
+    # ===============================================        
+  - os: OS X
+    osVersion: Big Sur
+    browserName: Safari
+    browserVersion: 14.1
+    # ===============================================
+    # Safari Browser Specific Capabilities (OPTIONAL)
+    # ===============================================
+    safari:
+      driver: 2.45 #Set the driver version you want to use
+      enablePopups: false #<boolean> (Default: X) Set to true if you want to enable Popups
+      allowAllCookies: false #<boolean> (Default: false) Set to true if you want to allow all cookies
+    # ===============================================        
+
+# =============================================================================================================================
+# BrowserStack Reporting 
+# =============================================================================================================================
+#Set 'projectName' to the name of your project.
+projectName: BrowserStack Samples 
+
+#Set 'projectName' to the name of your project.
+buildName: browserstack build 
+
+# buildIdentifier` is a unique id to differentiate every execution that gets appended to buildName. 
+# Choose your buildIdentifier format from the available expressions:
+# ${BUILD_NUMBER} (Default): Generates an incremental counter with every execution
+# ${DATE_TIME}: Generates a Timestamp with every execution. Eg. 05-Nov-19:30
+buildIdentifier: '#${BUILD_NUMBER}'
+
+# =============================================================================================================================
+# BrowserStack Local (For localhost, staging/private websites)
+# =============================================================================================================================
+
+# Set browserStackLocal to true if your website under test is not accessible publicly over the internet
+browserstackLocal: true # <boolean> (Default true)
+# Options to be passed to BrowserStack local in-case of advanced configurations
+browserStackLocalOptions:
+  forceLocal: true  # <boolean> (Default: false) Set to true to resolve all your traffic via BrowserStack Local tunnel.
+  localIdentifier: randomstring # <string> (Default: null) Needed if you need to run multiple instances of local.
+  proxyHost: 127.0.0.1 
+  proxyPort: 8000
+  proxyUser: user
+  proxyPass: password
+  -pac-file: <pac_file_abs_path> #<string> Pass the absolute path of PAC file for proxy server related decisioning
+  f: /my/awesome/folder # <string> Pass the path of test HTML files on BrowserStack local.
+  localProxyHost: 127.0.0.1
+  localProxyPort: 8000
+  -localProxyUser: user
+  -localProxyPass: password
+  verbose: 4
+  -log-file: ./local.log
+  -exclude-hosts: ".*.ups.com .*.ams1907.com"
+
+# =============================================================================================================================
+# Debugging features
+# =============================================================================================================================
+debug: false # <boolean> # Set to true if you need screenshots for every selenium command ran
+networkLogs: false # <boolean> Set to true to enable HAR logs capturing
+consoleLogs: errors # <string> Remote browser's console debug levels to be printed (Default: errors)
+# Available options are `disable`, `errors`, `warnings`, `info`, `verbose` (Default: errors)  
+
+# =============================================================================================================================
+# TEST CONFIGURATION CAPABILITIES
+# =============================================================================================================================
+video: true
+seleniumLogs: true
+telemetryLogs: true
+geoLocation: CN
+timezone: New_York 
+resolution: 1024x768
+idleTimeout: 30
+maskCommands: setValues, getValues, setCookies, getCookies
+maskBasicAuth: true
+autoWait: 35
+hosts: 1.2.3.4 staging.website.com
+bfcache: 1
+wsLocalSupport: true
+disableCorsRestrictions: true
+httpProxy: http://user:pwd@127.0.0.1:1234  #Add the proxy parameters in the adjacent format to use httpProxy
+httpsProxy: https://user:pwd@127.0.0.1:1234  #Add the proxy parameters in the adjacent format to use httpsProxy
+envFile: test.env # load custom environment
+logDir: 'log'
+# =============================================================================================================================
+# MOBILE SPECIFIC CAPABILITIES
+# =============================================================================================================================
+
+# Set the screen orientation of mobile device.
+deviceOrientation: portrait # select between portrait/landscape
+# Required if you want to simulate the custom network condition.
+customNetwork: 1000 #download speed (kbps), upload speed (kbps), latency (ms), packet loss (%)
+# Required if you want to simulate different network conditions.
+networkProfile: 2g-gprs-good #(select between multiple options)
+
+# =============================================================================================================================
+# BROWSER SPECIFIC CAPABILITIES
+# =============================================================================================================================
+
+# Browser specific capabilities have to be strictly placed with respective platform capabilites inside the platforms object 
+
+# ===============================================
+# Chrome Browser Specific Capabilities
+# ===============================================
+# platforms:
+#   - os: OS X
+#     osVersion: Big Sur
+#     browserName: Chrome
+#     browserVersion: latest
+#     #Chrome specific capabilities
+#     chrome: 
+#       driver: 112.0.5615.28
+#     chromeOptions: 
+#       args:                      
+#         - incognito
+#         - --start-maximized
+#       perfLoggingPrefs:
+#       enableNetwork: false
+
+# ===============================================
+# Edge Browser Specific Capabilities 
+# ===============================================
+# platforms:
+#   - os: Windows
+#     osVersion: 11
+#     browserName: Edge
+#     browserVersion: 111.0
+#     # Edge specific capabilities
+#     edge: 
+#       enablePopups: false #<boolean> (Default: X) Set to true if you want to enable Popups
+#       enableSidebar: false #<boolean> (Default: X) Set to true if you want to enable sidebar
+
+# ===============================================
+# Safari Browser Specific Capabilities 
+# ===============================================
+# platforms:
+#   - os: OS X
+#     osVersion: Big Sur
+#     browserName: Safari
+#     browserVersion: 14.1
+#     # Safari Specific Capabilities (OPTIONAL)
+#     safari:
+#       driver: 2.45 #Set the driver version you want to use
+#       enablePopups: false #<boolean> (Default: X) Set to true if you want to enable Popups
+#       allowAllCookies: false #<boolean> (Default: false) Set to true if you want to allow all cookies
+
+# ===============================================
+# Firefox Browser Specific Capabilities 
+# ===============================================
+
+# platforms:
+#   - os: Windows
+#     osVersion: 10
+#     browserName: Firefox
+#     browserVersion: latest
+#   # Firefox specific capabilities (Optional)
+#     firefox: 
+#       driver: 0.32.0 #Set the driver version you want to use
+  
+# ===============================================
+# IE Browser Specific Capabilities 
+# ===============================================      
+# platforms:
+#   - os: Windows
+#     osVersion: 10
+#     browserName: IE
+#     browserVersion: 11.0
+#     # IE specific capabilities (OPTIONAL)
+#     ie: 
+#       driver: 4.0.0 
+#       noFlash: false #<boolean> (Default: X) Set to true if you want to enable flash
+#       compatibility: <value>
+#       arch: <value>
+#       enablePopups: false #<boolean> (Default: X) Set to true if you want to enable Popups
+#       enableSidebar: false #<boolean> (Default: X) Set to true if you want to enable sidebar
+#       sendKeys: true #<boolean> (Default: X) Allows to type content automatically into editable field while executing tests.
+  
+# =============================================================================================================================
+# ADDITIONAL SDK SPECIFIC CONFIG
+# =============================================================================================================================
+
+# Use this to toggle verbose logging for SDK 
+logLevel: debug #<enum(error|warn|info|debug)> (Default: info)
+testContextOptions:
+   skipSessionName: true #<boolean> (Default: false) Set to true if you want to skip SDK from marking session name on bstack dashboard
+   skipSessionStatus: true #<boolean> (Default: false) Set to true if you want to skip SDK from marking session status on bstack dashboard
+# staticWebDriver: true #<boolean> (Default: true) Set to true in java to handle static initialisation of webdriver
+
+# platforms:
+#   - os: Windows
+#     osVersion: 10
+#     browserName: Firefox
+#     browserVersion: latest
+#     #<object> (Default: X) Set any platform specific custom key value pairs
+#     customVariables:
+#       customKey: customValue
+#     #<object> (Default: X) Set additional playwright config options
+##    playwrightConfigOptions: 
+##      use:
+##        deviceName: iPhone 6
+##        locale: de
+
+# =============================================================================================================================
+# PRODUCT SPECIFIC OPTIONS
+# =============================================================================================================================
+
+# ===============================================
+# TEST OBSERVABILITY
+# ===============================================
+# Test Observability is an intelligent test reporting & debugging product. It collects data using the SDK.
+# Visit observability.browserstack.com to see your test reports and insights. To disable test observability, 
+# specify `testObservability: false` in the key below.
+# Read about what data is collected at https://www.browserstack.com/docs/test-observability/references/terms-and-conditions
+testReporting: true 
+
+# ===============================================
+# ACCESSIBILITY
+# ===============================================
+accessibility: true #<boolean> (Default: false)
+#<object> (Default: X) Read more https://www.browserstack.com/docs/accessibility-automation/references/configuration-options
+#accessibilityOptions:
+#  wcagVersion: wcag21 #<enum(wcag21AAA|wcag21A|wcag20A)> (Default: wcag21aa)
+#  includeIssueType: 
+#        bestPractice: true #<boolean> (Default: false)
+#        needsReview: true #<boolean> (Default: true)
+# platforms:
+#   - os: Windows
+#     osVersion: 10
+#     browserName: Chrome
+#     browserVersion: latest
+#     accessibility: true #<boolean> (Default: false) Set to true/false to override root level accessibility key behavior
+
+# ===============================================
+# PERCY OR APP PERCY
+# ===============================================
+percy: true #<boolean> (Default: false)
+#percyCaptureMode: auto #<enum(auto|screenshot|click|testcase|manual)> (Default: auto)
+
+# Pass custom header params
+headerParams:
+  header_param_key1: someval
+  header_param_key2: someval

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: browserstack-ruby-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- BrowserStack
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fiddle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+- !ruby/object:Gem::Dependency
+  name: grpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: parallel_tests
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A comprehensive Ruby SDK for BrowserStack that provides automation capabilities
+  and enhanced testing features for web/app applications.
+email:
+- support@browserstack.com
+executables:
+- browserstack-sdk
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- STYLE_GUIDE.md
+- exe/browserstack-sdk
+- generated/browserstack/sdk/v1/sdk_pb.rb
+- generated/browserstack/sdk/v1/sdk_services_pb.rb
+- lib/browserstack/browserstack_logger_factory.rb
+- lib/browserstack/browserstack_ruby_agent.rb
+- lib/browserstack/child_initializer.rb
+- lib/browserstack/cli/browserstack_cli.rb
+- lib/browserstack/cli/grpc_client.rb
+- lib/browserstack/cli/sdk_cli_utils.rb
+- lib/browserstack/command_executor.rb
+- lib/browserstack/config/browserstack_config.rb
+- lib/browserstack/constants.rb
+- lib/browserstack/eventbus/event.rb
+- lib/browserstack/eventbus/event_dispatcher.rb
+- lib/browserstack/frameworks/automationFrameworks/automation_framework.rb
+- lib/browserstack/frameworks/automationFrameworks/selenium_framework.rb
+- lib/browserstack/frameworks/constants/automation_constants.rb
+- lib/browserstack/frameworks/state/automation_framework_state.rb
+- lib/browserstack/frameworks/state/hook_state.rb
+- lib/browserstack/frameworks/state/test_framework_state.rb
+- lib/browserstack/frameworks/testFrameworks/cucumber_framework.rb
+- lib/browserstack/frameworks/testFrameworks/test_framework.rb
+- lib/browserstack/instance/automation_framework_instance.rb
+- lib/browserstack/instance/test_framework_instance.rb
+- lib/browserstack/instance/tracked_context.rb
+- lib/browserstack/instance/tracked_instance.rb
+- lib/browserstack/modules/base_module.rb
+- lib/browserstack/modules/web_driver_module.rb
+- lib/browserstack/monitor/performance.rb
+- lib/browserstack/monitor/performance_annotator.rb
+- lib/browserstack/monitor/performance_constants.rb
+- lib/browserstack/monitor/performance_test.rb
+- lib/browserstack/monitor/sdk_integration.rb
+- lib/browserstack/patches/appium_lib_core_patch.rb
+- lib/browserstack/patches/cucumber_patches.rb
+- lib/browserstack/patches/selenium_patches.rb
+- lib/browserstack/runner.rb
+- lib/browserstack/utils/api_utility_methods.rb
+- lib/browserstack/utils/framework_detector.rb
+- lib/browserstack/utils/http_calls.rb
+- lib/browserstack/utils/util_method.rb
+- lib/browserstack/version.rb
+- lib/browserstack_sdk.rb
+- proto/browserstack/sdk/v1/sdk.proto
+- sample/browserstack_sample.yml
+homepage: https://github.com/browserstack/browserstack-ruby-sdk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/browserstack/browserstack-ruby-sdk
+  source_code_uri: https://github.com/browserstack/browserstack-ruby-sdk
+  changelog_uri: https://github.com/browserstack/browserstack-ruby-sdk/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/browserstack/browserstack-ruby-sdk/issues
+  documentation_uri: https://github.com/browserstack/browserstack-ruby-sdk/blob/main/README.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Ruby SDK for BrowserStack automation
+test_files: []