testingbot 0.1.7 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87a1ad54759fec9b5b5f8d61ee9701937b578b30
-  data.tar.gz: ebf7766a47b4cb88fd3ac8881bdac927fa8cb97a
+  metadata.gz: 8aa6c0651947729f8124cb6b37c2c2d06a1fc623
+  data.tar.gz: c70cbfddb932e5cb39f19e186c63efd468e945ec
 SHA512:
-  metadata.gz: 0d5593c04195e0e342376a496bcbc933d758cdd3a3196f00eb08a3efc29ff4ee4a16ccff165d4d0ef79ce543ace22b7eae23d289d975843f47a21222fde3a445
-  data.tar.gz: 4d42d1999609784aaac998ab2a8279e85d0e0c22ce79f9510d0a36fae1adc7ed155351cc91edbf78a13db84550272100cbb3ad6dcf262bc161fff36c970d8228
+  metadata.gz: 44e00e76b7afb646894a7dda5c70fbc33c5dec05a25dc9a638969cb87a70e2971571c35777fd737c24ddd98126ada1d9fb507b53cfd9b9462c0cb630298595ac
+  data.tar.gz: 8a774bbca0819f5af90fcc5a640361f84272638f73cdc3e848f614899d5eb7b59072c0a54585899fb18ca8a0634b3152e575ae49b195ee7ae3104dd4a17e7b09

data/.travis.yml

@@ -3,5 +3,4 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.1
-before_script: echo "travis:rocks" > ~/.testingbot
-script: bundle exec rspec -P "spec/unit/*.rb"
+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,137 @@
+[![Build Status](https://travis-ci.org/testingbot/testingbot_ruby.png)](https://travis-ci.org/testingbot/testingbot_ruby)
+
+# 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_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)
+```
+
+### get_tunnels
+Gets a list of active tunnels for your account.
+
+```ruby
+@api.get_tunnels
+```
+
+### 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

@@ -6,16 +6,36 @@ 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["TB_KEY"] if ENV["TB_KEY"]
+        @secret = ENV["TB_SECRET"] if ENV["TB_SECRET"]
+      end
 
-    def initialize(opts = {})
-      @config = TestingBot::Config.new(opts)
+      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 update_user_info(params = {})
       new_params = {}
       params.keys.each do |key|
@@ -29,7 +49,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,38 +67,83 @@ 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 get_tunnels
+      get("/tunnel/list")
+    end
+
+    def get_authentication_hash(identifier)
+      Digest::MD5.hexdigest("#{@key}:#{@secret}:#{identifier}")
+    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]
+      req.basic_auth @key, @secret
       res = Net::HTTP.start(uri.host, uri.port, :use_ssl => true) {|http|
         http.request(req)
       }
-      p res.body
 
       parsed = JSON.parse(res.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
-
       parsed
     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.basic_auth @key, @secret
       req.set_form_data(params)
       res = Net::HTTP.start(uri.host, uri.port, :use_ssl => true) {|http|
         http.request(req)
       }
 
       parsed = JSON.parse(res.body)
+      p parsed if @options[:debug]
 
-      if !parsed["error"].nil? && !parsed["error"].empty?
+      if !parsed.is_a?(Array) && !parsed["error"].nil? && !parsed["error"].empty?
         raise parsed["error"]
       end
 
@@ -88,7 +153,7 @@ module TestingBot
     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.basic_auth @key, @secret
       req.set_form_data(params)
       res = Net::HTTP.start(uri.host, uri.port, :use_ssl => true) {|http|
         http.request(req)
@@ -96,7 +161,9 @@ module TestingBot
 
       parsed = JSON.parse(res.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
 
@@ -107,8 +174,17 @@ module TestingBot
       url = URI.parse(API_URL + '/v' + VERSION + url)
       http = Net::HTTP.new(url.host, url.port)
       http.use_ssl = true
-      http.basic_auth @config[:client_key], @config[:client_secret]
-      response = http.post(url.path, params.map { |k, v| "#{k.to_s}=#{v}" }.join("&"))
+      http.basic_auth @key, @secret
+      res = http.post(url.path, params.map { |k, v| "#{k.to_s}=#{v}" }.join("&"))
+      parsed = JSON.parse(res.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

data/lib/testingbot/version.rb

@@ -1,3 +1,3 @@
 module Testingbot
-  VERSION = "0.1.7"
+  VERSION = "0.2.0"
 end

data/spec/integration/api_spec.rb

@@ -4,23 +4,22 @@ 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 = 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({ :client_key => "bogus", :client_secret => "false" })
+      @api = TestingBot::Api.new("bogus", "false")
       lambda { @api.get_user_info }.should raise_error(RuntimeError, /^401 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()
+      @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
@@ -29,59 +28,66 @@ describe "Testingbot Api" do
 
   context "retrieve my own tests" do
     it "should retrieve a list of my own tests" do
-      @api = TestingBot::Api.new()
+      @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()
+      @api = TestingBot::Api.new
       data = @api.get_tests["data"]
       if data.length > 0
         test_id = data.first["id"]
         
-        single_test = @api.get_single_test(test_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_single_test(123423423423423) }.should raise_error(RuntimeError, /^404 Not Found./)
+      @api = TestingBot::Api.new
+      lambda { @api.get_test(123423423423423) }.should raise_error(RuntimeError, /^404 Not Found./)
     end
   end
 
   context "update a test" do
     it "should update a test of mine" do
-      @api = TestingBot::Api.new()
+      @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_single_test(test_id)
+        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()
+      @api = TestingBot::Api.new
       lambda { @api.update_test(123423423423423, { :name => "testingbot" }) }.should raise_error(RuntimeError, /^404 Not Found./)
     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()
+      @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_single_test(test_id) }.should raise_error(RuntimeError, /^404 Not Found./)
+        lambda { @api.get_test(test_id) }.should raise_error(RuntimeError, /^404 Not Found./)
       end
     end
 
     it "should not delete a test that is not mine" do
-      @api = TestingBot::Api.new()
+      @api = TestingBot::Api.new
       lambda { @api.delete_test(123423423423423) }.should raise_error(RuntimeError, /^404 Not Found./)
     end
   end