testingbot 0.1.5 → 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6c1801b21d64a6515b1fd8d1f1a6db23b0915dff62121b49a681d02eff530c2a
+  data.tar.gz: 30edd8ebbc255bf2b14005e9c5ea881b5bfc1ef6a19a1e8b9a24ed2bc2584f59
+SHA512:
+  metadata.gz: 50e9843ec66a235debde34b17f2a40ab05bc545fd175959d14497b5b23a133beb9155408d61363cf307d2463b1aeb23cad50d081d05ff6a40dd431b9b82c3119
+  data.tar.gz: e781af83c71eeb24d0d086e29b1ee1e0bce71263b260045e1d2acc656f7d55409a03991bde4802edfae33bf474648184e45755bb7324ac6c9bcb8b0c1c48fc03

data/.github/workflows/test.yml

@@ -0,0 +1,26 @@
+name: Test Changes
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.5', '2.6' ]
+    name: Ruby ${{ matrix.ruby }} test
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Build and test
+        run: |
+          sudo apt-get -yqq install libpq-dev
+          gem install bundler
+          bundle install --jobs 3 --retry 3
+          bundle exec rake spec
+        env:
+          TB_KEY: ${{ secrets.TB_KEY }}
+          TB_SECRET: ${{ secrets.TB_SECRET }}
+

data/.travis.yml

@@ -1,5 +1,9 @@
 language: ruby
 rvm:
-  - 1.9.3
-before_script: echo "travis:rocks" > ~/.testingbot
-script: bundle exec rspec -P "spec/unit/*.rb"
+  - 2.0.0
+  - 2.1.1
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+script: bundle exec rake spec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 TestingBot
+Copyright (c) TestingBot
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -0,0 +1,207 @@
+[![Gem Version](https://badge.fury.io/rb/testingbot.svg)](https://badge.fury.io/rb/testingbot)
+
+# Testingbot-Ruby
+
+This is the TestingBot Ruby client which makes it easy to 
+interact with the [TestingBot API](https://testingbot.com/support/api)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'testingbot'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install testingbot
+
+
+## Configuration
+
+You'll need a [TestingBot account](https://testingbot.com).  TestingBot offers free trials.
+
+## Setup
+
+Once you have a TestingBot account, you can retrieve your unique TestingBot Key and Secret from the [TestingBot dashboard](https://testingbot.com/members)
+
+## Usage
+
+```ruby
+@api = TestingBot::Api.new(key, secret)
+```
+
+#### Environment variables
+You can set these environment variables to authenticate with our API:
+
+```bash
+TB_KEY=Your TestingBot Key
+TB_SECRET=Your TestingBot Secret
+```
+
+### get_browsers
+Gets a list of browsers you can test on
+
+```ruby
+@api.get_browsers
+```
+
+### get_devices
+Gets a list of (physical) devices you can test on
+
+```ruby
+@api.get_devices
+```
+
+### get_available_devices
+Gets a list of available (physical) devices you can test on
+
+```ruby
+@api.get_available_devices
+```
+
+### get_user_info
+Gets your user information
+
+```ruby
+@api.get_user_info
+```
+
+### update_user_info
+Updates your user information
+
+```ruby
+@api.update_user_info({ "first_name" => 'my name' })
+```
+
+### update_test
+Updates a Test with Meta-data to display on TestingBot.
+For example, you can specify the test name and whether the test succeeded or failed:
+
+```ruby
+@api.update_test(webdriver_session_id, { :name => new_name, :success => true })
+```
+
+### get_test
+Gets meta information for a test/job by passing in the WebDriver sessionID of the test you ran on TestingBot:
+
+```ruby
+@api.get_test(webdriver_session_id)
+```
+
+### get_tests
+Gets a list of previous jobs/tests that you ran on TestingBot, order by last run:
+
+```ruby
+@api.get_tests(0, 10)
+```
+
+### delete_test
+Deletes a test from TestingBot
+
+```ruby
+@api.delete_test(webdriver_session_id)
+```
+
+### stop_test
+Stops a running test on TestingBot
+
+```ruby
+@api.stop_test(webdriver_session_id)
+```
+
+### get_builds
+Gets a list of builds that you ran on TestingBot, order by last run:
+
+```ruby
+@api.get_builds(0, 10)
+```
+
+### get_build
+Gets a build from TestingBot
+
+```ruby
+@api.get_build(build_identifier)
+```
+
+### delete_build
+Deletes a build from TestingBot
+
+```ruby
+@api.delete_build(build_identifier)
+```
+
+### get_tunnels
+Gets a list of active tunnels for your account.
+
+```ruby
+@api.get_tunnels
+```
+
+### delete_tunnel
+Deletes an active tunnel.
+
+```ruby
+@api.delete_tunnel(tunnel_identifier)
+```
+
+### upload_local_file
+Uploads a local file (APK or IPA file) to TestingBot Storage for Mobile App Testing.
+
+```ruby
+@api.upload_local_file(localFilePath)
+```
+
+### upload_remote_file
+Uploads a remote file (APK or IPA URL) to TestingBot Storage for Mobile App Testing.
+
+```ruby
+@api.upload_remote_file(remoteFileUrl)
+```
+
+### get_uploaded_files
+Retrieves files previously uploaded TestingBot Storage for Mobile App Testing.
+
+```ruby
+@api.get_uploaded_files(offset = 0, count = 30)
+```
+
+### get_uploaded_file
+Retrieves meta-data for a file previously uploaded to TestingBot Storage.
+
+```ruby
+@api.get_uploaded_file(app_url)
+```
+
+### delete_uploaded_file
+Deletes a previously uploaded file
+
+```ruby
+@api.delete_uploaded_file(remoteFileUrl)
+```
+
+### upload_remote_file
+Uploads a remote file (APK or IPA URL) to TestingBot Storage for Mobile App Testing.
+
+```ruby
+@api.upload_remote_file(remoteFileUrl)
+```
+
+### get_authentication_hash
+Calculates the hash necessary to share tests with other people
+
+```ruby
+@api.get_authentication_hash(identifier)
+```
+
+## Contributing
+
+1. Fork this repository
+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 new Pull Request
+

data/bin/testingbot

@@ -4,8 +4,9 @@ if ARGV.any?
   api_key, api_secret = ARGV.first.split(':')
 else
   
-  p "This utility will help you set up your system to use testingbot.com's infrastructure."
-  p "Once you have entered your api key and secret you will be ready to use our grid"
+  p "This utility will help you set up your system to use TestingBot's infrastructure."
+  p "Once you have entered your API key and secret you will be ready to use our grid"
+  p "You can get these credentials from the TestingBot dashboard: https://testingbot.com/members"
 
   p "Please enter your testingbot API KEY:"
   api_key = gets.chomp
@@ -15,4 +16,4 @@ end
 
 File.open(File.expand_path("~/.testingbot"), 'w') {|f| f.write("#{api_key}:#{api_secret}") }
 
-p "Your system is now ready to use testingbot.com's grid infrastructure."
+p "Your system is now ready to use TestingBot's grid infrastructure."

data/lib/testingbot.rb

@@ -1,5 +1 @@
-require "testingbot/version"
-require "testingbot/config"
-require "testingbot/selenium"
-require "testingbot/api"
-require "testingbot/hooks"
+require "testingbot/api"

data/lib/testingbot/api.rb

@@ -1,4 +1,6 @@
 require 'json'
+require "rest-client"
+
 module TestingBot
 
   class Api
@@ -6,16 +8,49 @@ module TestingBot
     VERSION = 1
     API_URL = "https://api.testingbot.com"
 
-    attr_reader :config
+    attr_reader :key, :secret, :options
+
+    def initialize(key = nil, secret = nil, options = {})
+      @key = key
+      @secret = secret
+      @options = {
+        :debug => false
+      }.merge(options)
+      if @key.nil? || @secret.nil?
+        cached_credentials = load_config_file
+        @key, @secret = cached_credentials unless cached_credentials.nil?
+      end
+
+      if @key.nil? || @secret.nil?
+        @key = ENV["TESTINGBOT_KEY"] if ENV["TESTINGBOT_KEY"]
+        @secret = ENV["TESTINGBOT_SECRET"] if ENV["TESTINGBOT_SECRET"]
+      end
 
-    def initialize(opts = {})
-      @config = TestingBot::Config.new(opts)
+      if @key.nil? || @secret.nil?
+        @key = ENV["TB_KEY"] if ENV["TB_KEY"]
+        @secret = ENV["TB_SECRET"] if ENV["TB_SECRET"]
+      end
+
+      raise "Please supply a TestingBot Key" if @key.nil?
+      raise "Please supply a TestingBot Secret" if @secret.nil?
     end
 
     def get_user_info
       get("/user")
     end
 
+    def get_browsers
+      get("/browsers")
+    end
+
+    def get_devices
+      get("/devices")
+    end
+
+    def get_available_devices
+      get("/devices/available")
+    end
+
     def update_user_info(params = {})
       new_params = {}
       params.keys.each do |key|
@@ -29,7 +64,7 @@ module TestingBot
       get("/tests?offset=#{offset}&count=#{count}")
     end
 
-    def get_single_test(test_id)
+    def get_test(test_id)
       get("/tests/#{test_id}")
     end
 
@@ -47,19 +82,104 @@ module TestingBot
       response["success"]
     end
 
+    def stop_test(test_id)
+      response = put("/tests/#{test_id}/stop")
+      response["success"]
+    end
+
+    def get_builds(offset = 0, count = 10)
+      get("/builds?offset=#{offset}&count=#{count}")
+    end
+
+    def get_build(build_identifier)
+      get("/builds/#{build_identifier}")
+    end
+
+    def delete_build(build_identifier)
+      delete("/builds/#{build_identifier}")
+    end
+
+    def get_tunnels
+      get("/tunnel/list")
+    end
+
+    def delete_tunnel(tunnel_identifier)
+      delete("/tunnel/#{tunnel_identifier}")
+    end
+
+    def get_authentication_hash(identifier)
+      Digest::MD5.hexdigest("#{@key}:#{@secret}:#{identifier}")
+    end
+
+    def upload_local_file(file_path)
+      response = RestClient::Request.execute(
+        method: :post,
+        url: API_URL + "/v1/storage",
+        user: @key,
+        password: @secret,
+        timeout: 600,
+        payload: {
+          multipart: true,
+          file: File.new(file_path, 'rb')
+        }
+      )
+      parsed = JSON.parse(response.body)
+      parsed
+    end
+
+    def upload_remote_file(url)
+      post("/storage/", {
+        :url => url
+      })
+    end
+
+    def get_uploaded_files(offset = 0, count = 10)
+      get("/storage?offset=#{offset}&count=#{count}")
+    end
+
+    def get_uploaded_file(app_url)
+      get("/storage/#{app_url.gsub(/tb:\/\//, '')}")
+    end
+
+    def delete_uploaded_file(app_url)
+      response = delete("/storage/#{app_url.gsub(/tb:\/\//, '')}")
+      response["success"]
+    end
+
     private
 
+    def load_config_file
+      is_windows = false
+
+      begin
+        require 'rbconfig'
+        is_windows = (RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/)
+      rescue
+        is_windows = (RUBY_PLATFORM =~ /w.*32/) || (ENV["OS"] && ENV["OS"] == "Windows_NT")
+      end
+      
+      if is_windows
+        config_file = "#{ENV['HOMEDRIVE']}\\.testingbot"
+      else
+        config_file = File.expand_path("#{Dir.home}/.testingbot")
+      end
+      
+      if File.exists?(config_file)
+        str = File.open(config_file) { |f| f.readline }.chomp
+        return str.split(':')
+      end
+      
+      return nil
+    end
+
     def get(url)
-      uri = URI(API_URL + '/v' + VERSION.to_s + url)
-      req = Net::HTTP::Get.new(uri.request_uri)
-      req.basic_auth @config[:client_key], @config[:client_secret]
-      res = Net::HTTP.start(uri.host, uri.port) {|http|
-        http.request(req)
-      }
+      uri = API_URL + '/v' + VERSION.to_s + url
 
-      parsed = JSON.parse(res.body)
+      response = RestClient::Request.execute method: :get, url: uri, user: @key, password: @secret
+      parsed = JSON.parse(response.body)
 
-      if !parsed["error"].nil? && !parsed["error"].empty?
+      p parsed if @options[:debug]
+      if !parsed.is_a?(Array) && !parsed["error"].nil? && !parsed["error"].empty?
         raise parsed["error"]
       end
 
@@ -67,17 +187,13 @@ module TestingBot
     end
 
     def put(url, params = {})
-      uri = URI(API_URL + '/v' + VERSION.to_s + url)
-      req = Net::HTTP::Put.new(uri.request_uri)
-      req.basic_auth @config[:client_key], @config[:client_secret]
-      req.set_form_data(params)
-      res = Net::HTTP.start(uri.host, uri.port) {|http|
-        http.request(req)
-      }
+      uri = API_URL + '/v' + VERSION.to_s + url
 
-      parsed = JSON.parse(res.body)
+      response = RestClient::Request.execute method: :put, url: uri, payload: params, user: @key, password: @secret
+      parsed = JSON.parse(response.body)
 
-      if !parsed["error"].nil? && !parsed["error"].empty?
+      p parsed if @options[:debug]
+      if !parsed.is_a?(Array) && !parsed["error"].nil? && !parsed["error"].empty?
         raise parsed["error"]
       end
 
@@ -85,17 +201,12 @@ module TestingBot
     end
 
     def delete(url, params = {})
-      uri = URI(API_URL + '/v' + VERSION.to_s + url)
-      req = Net::HTTP::Delete.new(uri.request_uri)
-      req.basic_auth @config[:client_key], @config[:client_secret]
-      req.set_form_data(params)
-      res = Net::HTTP.start(uri.host, uri.port) {|http|
-        http.request(req)
-      }
-
-      parsed = JSON.parse(res.body)
+      uri = API_URL + '/v' + VERSION.to_s + url
+      response = RestClient::Request.execute method: :delete, url: uri, payload: params, user: @key, password: @secret
+      parsed = JSON.parse(response.body)
 
-      if !parsed["error"].nil? && !parsed["error"].empty?
+      p parsed if @options[:debug]
+      if !parsed.is_a?(Array) && !parsed["error"].nil? && !parsed["error"].empty?
         raise parsed["error"]
       end
 
@@ -103,10 +214,17 @@ module TestingBot
     end
 
     def post(url, params = {})
-      url = URI.parse(API_URL + '/v' + VERSION + url)
-      http = Net::HTTP.new(url.host, url.port)
-      http.basic_auth @config[:client_key], @config[:client_secret]
-      response = http.post(url.path, params.map { |k, v| "#{k.to_s}=#{v}" }.join("&"))
+      uri = API_URL + '/v' + VERSION.to_s + url
+
+      response = RestClient::Request.execute method: :post, url: uri, payload: params, user: @key, password: @secret
+      parsed = JSON.parse(response.body)
+
+      p parsed if @options[:debug]
+      if !parsed.is_a?(Array) && !parsed["error"].nil? && !parsed["error"].empty?
+        raise parsed["error"]
+      end
+
+      parsed
     end
   end
 end