cbthelper 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33a28d1f8081b7d2de7fc2347e6d8fc8472c4a08a5d4997957fb92aea2447f82
-  data.tar.gz: 06a04084cbb16a75d2a4e3426c6ac1df6be3d61204df358efea15f116fd0a847
+  metadata.gz: 161f8104cb47450096f365dea539df6f962a6563bc8325b6150b5ce7d89481ea
+  data.tar.gz: 5d04fa37f9a50b45caf54f7a4bb90f4e8c8eafbd621bbc7ff2bcc0adaec6304e
 SHA512:
-  metadata.gz: b5f762286455d16f2bc033b8afd72078f3457e7530c1da279a8b3d7462b99dd34bdc21f756beb014b82dd51532ab95b2f57727ba32091edff539234071dab614
-  data.tar.gz: 36fac5fcf315bb22daec45b2a42d5468e3db1cef4847d878732b5c2036409ca540c3513fd4cd4cefff4f08dbda9853ad78eb2da8b9f73d17ed5e88c3239160d0
+  metadata.gz: '067458e98a2b601beac02fc495b234daa2463d103375570e8a90cb9dae467844614b94a29182f255818aa7f2a75cc9bb6bcd53927054d242779158796146a15c'
+  data.tar.gz: e3c5e0ae30ab7032ec4731c71af4c174aad0dbb016e8f1844da3ec93a0bc9d1524fbcbf61c9320eb0b0cb83beb1a998638a0fcb9be409f15cef27d416129cc97

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in cbthelper.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    cbthelper (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  cbthelper!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Daphne Magsby
+
+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,34 @@
+# Cbthelper
+
+
+cbthelper (Ruby) wraps CrossBrowserTesting's selenium api into an easy to use library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cbthelper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cbthelper
+
+## Usage
+
+See example.rb. Don't forget to set your username and authkey in that file.
+
+Or visit https://help.crossbrowsertesting.com/selenium-testing/getting-started/cbthelper-ruby/
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/crossbrowsertesting/cbthelper-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cbthelper"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cbthelper.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cbthelper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cbthelper"
+  spec.version       = Cbthelper::VERSION
+  spec.authors       = ["Daphne Magsby"]
+  spec.email         = ["daphnem@crossbrowsertesting.com"]
+
+  spec.summary       = "cbthelper"
+  spec.description   = "cbthelper wraps CrossBrowserTesting's (https://crossbrowsertesting.com/apidocs/v3/selenium.html) into an easy to use library."
+  spec.homepage      = "https://help.crossbrowsertesting.com/selenium-testing/getting-started/cbthelper-ruby/"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/crossbrowsertesting/cbthelper-ruby"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/cbthelper.rb

@@ -1,4 +1,4 @@
-require_relative "cbthelper/Globals"
+require_relative "cbthelper/version"
 require_relative "cbthelper/AutomatedTest"
 require_relative "cbthelper/CapsBuilder"
 require_relative "cbthelper/Snapshot"
@@ -6,43 +6,48 @@ require_relative "cbthelper/TestHistoryBuilder"
 require_relative "cbthelper/Video"
 require "rest-client"
 require "json"
-def getCapsBuilder
-=begin
-    Used to get the selenium capability builder
-    Generating the CapsBuilder pulls in a large amount of data, so user should not call the constrcutor manually
-=end
-    $CAPSBUILDER = CapsBuilder.new
-    return $CAPSBUILDER
-end
+require "selenium-webdriver"
 
+module Cbthelper
+	#Used to get the selenium capability builder
+	#Generating the CapsBuilder pulls in a large amount of data, so user should not call the constrcutor manually
+	def self.getCapsBuilder
+    	@@caps = CapsBuilder.new
+	end
 
-def login(username, authkey)
-    #Sets the username and authkey used to make the HTTP requests
-    $USERNAME = username
-    $AUTHKEY = authkey
+	#Sets the username and authkey used to make the HTTP requests
+	def self.login(username, authkey)
+    	@@username= username
+    	@@authkey = authkey	
+	end
 
-end
+	#Used to get the TestHistoryBuilder
+    #Can also just call the constructor. Method created to match getCapsBuilder()
+	def self.getTestHistoryBuilder
+    	return TestHistoryBuilder.new
+	end
 
-def getTestHistoryBuilder
-=begin
-    Used to get the TestHistoryBuilder
-    Can also just call the constructor. Method created to match getCapsBuilder()
-=end
-    return TestHistoryBuilder.new
-end
+	#Returns a ruby hash with the test history, filtering based on the options given.
+    #@param options: a ruby hash created by the TestHistoryBuilder
+	def self.getTestHistory(options)
+    	return JSON.parse(RestClient.get("https://#{@@username}:#{@@authkey}@crossbrowsertesting.com/api/v3/selenium/", params: options))	
+	end
 
-def getTestHistory(options)
-=begin
-    Returns a ruby hash with the test history, filtering based on the options given.
-    :param options: a ruby hash created by the TestHistoryBuilder
-=end
-    return JSON.parse(RestClient.get("https://#{$USERNAME}:#{$AUTHKEY}@crossbrowsertesting.com/api/v3/selenium/", params: options))
-end
+	#Creates an automated test from the selenium session id
+    #@param sessid: string for the seleneium session/test id. Should come from WebDriver
+	def self.getTestFromId(sessid)
+    	return AutomatedTest.new(sessid)
+	end
+
+	def self.username
+		@@username
+	end
+
+	def self.authkey
+		@@authkey
+	end
 
-def getTestFromId(sessid)
-=begin
-    Creates an automated test from the selenium session id
-    :param sessid: string for the seleneium session/test id. Should come from WebDriver
-=end
-    return AutomatedTest.new(sessid)
+	def self.caps
+		@@caps
+	end
 end

data/lib/cbthelper/AutomatedTest.rb

@@ -1,67 +1,63 @@
-require_relative "Globals"
 require_relative "Snapshot"
 require_relative "Video"
+require_relative "../cbthelper.rb"
 require "rest-client"
 require "json"
 
+#Helpful representation of a selenium test
 class AutomatedTest
-=begin
-	Helpful representation of a selenium test
-    :param testId: the selenium session ID, usually from webdriver
-  
-=end
+	
+
+    #@param testId: the selenium session ID, usually from webdriver 
 	def initialize(testId)
 		@testId = testId
 	end
 	
+	#Sets the score for our test in the CBT app
+    #@param score: should be 'pass', 'fail', or 'unset'.
 	def setScore(score)		
-=begin	
-		Sets the score for our test in the CBT app
-        :param score: should be 'pass', 'fail', or 'unset'. The main module exposes SCORE_PASS, SCORE_FAIL, SCORE_UNSET
-=end
-		RestClient.put("https://#{$USERNAME}:#{$AUTHKEY}@crossbrowsertesting.com/api/v3"+ "/selenium/#{@testId}",
+		RestClient.put("https://#{Cbthelper.username}:#{Cbthelper.authkey}@crossbrowsertesting.com/api/v3/selenium/#{@testId}",
             "action=set_score&score=#{score}")
 	end
 	
+	#Sets the description for the test in the web app
 	def setDescription(description)
-		#Sets the description for the test in the web app
-		RestClient.put("https://#{$USERNAME}:#{$AUTHKEY}@crossbrowsertesting.com/api/v3"+ "/selenium/#{@testId}",
+		RestClient.put("https://#{Cbthelper.username}:#{Cbthelper.authkey}@crossbrowsertesting.com/api/v3/selenium/#{@testId}",
             "action=set_description&description=#{description}")
 	end
 
-	def stop(score = "")
-=begin
-		score is optional, will combine setScore and stopTest
-        Sends the command to our api to stop the selenium test. Similar to driver.quit()
-=end
-		if score != ""
+   
+	#@param score is optional, will combine setScore and stopTest
+    #Sends the command to our api to stop the selenium test. Similar to driver.quit()
+	def stop(score = nil)
+		if score != nil
 			setScore(score)
-			RestClient.delete("https://#{$USERNAME}:#{$AUTHKEY}@crossbrowsertesting.com/api/v3/selenium/#{@testId}")
+			RestClient.delete("https://#{Cbthelper.username}:#{$Cbthelper.authkey}@crossbrowsertesting.com/api/v3/selenium/#{@testId}")
 		end
 
 	end
 
-	def takeSnapshot(description= "")
-=begin	
-		Sends the command to take a snapshot and returns a Snapshot instance
-        :param description: (optional) shortcut for Snapshot.setDescription
-        :returns: the Snapshot instance for this snapshot
-=end		
-		 response = RestClient.post("https://#{$USERNAME}:#{$AUTHKEY}@crossbrowsertesting.com/api/v3" + "/selenium/#{@testId}/snapshots",
+	#Sends the command to take a snapshot and returns a Snapshot instance
+    #@param description: (optional) shortcut for Snapshot.setDescription
+	def takeSnapshot(description= nil)
+
+        #@return : the Snapshot instance for this snapshot	
+		 response = RestClient.post("https://#{Cbthelper.username}:#{Cbthelper.authkey}@crossbrowsertesting.com/api/v3/selenium/#{@testId}/snapshots",
 		 	"selenium_test_id=#{@testId}")
 		 hash = /(?<="hash": ")((\w|\d)*)/.match(response)[0]
 		 snap = Snapshot.new(hash, @testId)
-		 if description != ""
+		 if description != nil
 		 	snap.setDescription(description)
 		 end
 		 return snap
 
 	end
 
+	#Returns all snapshots for this test
 	def getSnapshots()
-		# Returns all snapshots for this test
-		snaps = JSON.parse(RestClient.get("https://#{$USERNAME}:#{$AUTHKEY}@crossbrowsertesting.com/api/v3/selenium/" + @testId +"/snapshots/"))	
+		snaps = JSON.parse(RestClient.get("https://#{Cbthelper.username}:#{Cbthelper.authkey}@crossbrowsertesting.com/api/v3/selenium/#{@testId}/snapshots/"))	
 		ret = []
+
 		for snap in snaps
 			ret.push(Snapshot.new(snap["hash"], @testId))
 
@@ -69,62 +65,65 @@ class AutomatedTest
 		return ret
 	end
 
+	#Downloads all snapshots for this test into the provided directory
 	def saveAllSnapshots(directory, useDescription=false)
-		#Downloads all snapshots for this test into the provided directory
 		prefix = "image"
 		snaps = getSnapshots
 		makeDirectory(directory)
+      
 		for i in 0...snaps.size
 			if useDescription and snaps[i].info["description"] != ""
                 img = snaps[i].info["description"] + ".png"
             else
                 img = prefix + i.to_s + ".png"
             end
-            	snaps[i].saveLocally(File.join(directory, img))
+            	snaps[i].saveSnapshot(File.join(directory, img))
 		end
-
 	end
 
-	def RecordingVideo(description='')
-		#Return the video recording for this test
-		 response = RestClient.get("https://#{$USERNAME}:#{$AUTHKEY}@crossbrowsertesting.com/api/v3" + "/selenium/#{@testId}/videos")
+	#Return the video recording for this test
+	def RecordingVideo(description=nil)
+		 response = RestClient.get("https://#{Cbthelper.username}:#{Cbthelper.authkey}@crossbrowsertesting.com/api/v3/selenium/#{@testId}/videos")
 		 hash = /(?<="hash": ")((\w|\d)*)/.match(response)[0]
 		 video = Video.new(hash, @testId)
-		 if description != ""
+		 if description != nil
 		 	video.setDescription(description)
 		 end
 		 return video
 		
 	end
 
+	#Returns all videos for this test
 	def getVideos
-		# Returns all videos for this test
-		videos = JSON.parse(RestClient.get("https://#{$USERNAME}:#{$AUTHKEY}@crossbrowsertesting.com/api/v3/selenium/" + @testId +"/videos/"))	
+		videos = JSON.parse(RestClient.get("https://#{Cbthelper.username}:#{Cbthelper.authkey}@crossbrowsertesting.com/api/v3/selenium/#{@testId}/videos/"))	
 		ret = []
+
 		for video in videos
 			ret.push(Video.new(video["hash"], @testId))
 
 		end
+
 		return ret
 	end
 
+	#Downloads all videos for this test into a directory
 	def saveAllVideos(directory, useDescription=false)
-		# Downloads all videos for this test into a directory
 		prefix = "video"
 		videos = getVideos
 		makeDirectory(directory)
+
 		for i in 0...videos.size
 			if useDescription and videos[i].info["description"] != ""
                 vid = videos[i].info["description"] + ".mp4"
             else
                 vid = prefix + i.to_s + ".mp4"
             end
-            videos[i].saveLocally(File.join(directory, vid))
+            videos[i].saveVideo(File.join(directory, vid))
 		end
 
 	end
 
-
+	private 
 	def makeDirectory(dir)
 		Dir.mkdir(dir) unless Dir.exist?(dir)
 	

data/lib/cbthelper/CapsBuilder.rb

@@ -1,12 +1,13 @@
+require_relative "../cbthelper.rb"
 require "rest-client"
 require "json"
-require_relative "Globals"
 
+
+#Builder for generating selenium capabilities
+#All of the with... methods return self for method chaining
 class CapsBuilder
-=begin
-    Builder for generating selenium capabilities
-    All of the with... methods return self for method chaining
-=end
+    
+
     def initialize
         @capsData = JSON.parse(RestClient.get("https://crossbrowsertesting.com/api/v3/selenium/browsers"))
         @platform = nil
@@ -19,66 +20,62 @@ class CapsBuilder
         @recordNetwork = nil
     end
 
+    #Sets the platform (OS) the user wants to use. The string will be compared against the 'name' and 'api_name' properties returned from the selenium api.
+    #@param platform: a string specifying the platform (eg. Windows 7, Mac 10.13)
     def withPlatform(platform)
-=begin
-
-        Sets the platform (OS) the user wants to use. The string will be compared against the 'name' and 'api_name' properties returned from the selenium api.
-        :param platform: a string specifying the platform (eg. Windows 7, Mac 10.13)
-=end
         @platform = platform
         self
     end
 
+    #Sets the browser the user wants to use. The string will be compared against the 'name' and 'api_name' properties returned from the selenium api.
+    #@param browser: as string specifying the browser (eg. Edge 17, Chrome 55x64)
     def withBrowserApiName(browser)
-=begin
-        Sets the browser the user wants to use. The string will be compared against the 'name' and 'api_name' properties returned from the selenium api.
-        :param browser: as string specifying the browser (eg. Edge 17, Chrome 55x64)
-=end
         @browser = browser
         self
     end
-
+    
+    #Sets the screen size for the test
     def withResolution(width, height)
-        # Sets the screen size for the test
         @width = width
         @height = height
         self
     end
 
+    #Sets the name of the test in the web app
     def withName(name)
-        # Sets the name of the test in the web app
         @name = name
         self
     end
     
+    #Sets the build number in the web app
     def withBuild(build)
-        #Sets the build number in the web app
         @version = build
         self
     end 
 
+    #Records a video for the length of the test
     def withRecordVideo(bool)
-        #Records a video for the length of the test
         @recordVideo = bool
         self
     end
 
+    #Records network traffic for the length of the test
     def withRecordNetwork(bool)
-        #Records network traffic for the length of the test
         @recordNetwork = bool
         self
     end
 
+    #Used to generate the capabilites using any options the user specifies
     def build
-        #Used to generate the capabilites using any options the user specifies
         return choose
     end
 
+    #Determines the best platform based on user input :param target
     def bestOption(options, target)
-        #Determines the best platform based on user input :param target
         if target != nil
             target =target.downcase
         end
+        
         for option in options
             name = option['name'].downcase
             apiName = option['name'].downcase
@@ -89,9 +86,10 @@ class CapsBuilder
         return nil
     end
 
+    #Determines the best platform based on user input :param target when no platform provided
     def bestBrowserNoPlatform(target)
-        #Determines the best platform based on user input :param target when no platform provided
         target = target.downcase
+
         for platform in @capsData
             for browser in platform['browsers']
                 name = browser['name'].downcase
@@ -100,11 +98,13 @@ class CapsBuilder
                 end
             end
         end
+
         return nil
     end
 
+    private
+    #Sets the capabilities passed to the WebDriver
     def choose
-        #Sets the capabilities passed to the WebDriver
         data = @capsData
         caps = Selenium::WebDriver::Remote::Capabilities.new
         if @platform
@@ -113,6 +113,7 @@ class CapsBuilder
         if @browser
             caps['browser_api_name'] = @browser
         end
+
         if @width and @height
             caps['screenResolution'] = @width.to_s + 'x' + @height.to_s
         end
@@ -136,6 +137,4 @@ class CapsBuilder
     end
 
 
-
-
-end
+end

data/lib/cbthelper/Snapshot.rb

@@ -1,13 +1,13 @@
-require_relative "Globals"
+require_relative "../cbthelper.rb"
 require "json"
 require "rest-client"
 
+#Represents a snapshot for selenium tests
 class Snapshot
-=begin  
-    Represents a snapshot for selenium tests
-    :param hash: the hash for this image, returned by rest api when taking a screenshot
-    :param test: an AutomatedTest object that represents a test currently running
-=end 
+    
+ 
+    #@param hash: the hash for this image, returned by rest api when taking a screenshot
+    #@param test: an AutomatedTest object that represents a test currently running
     attr_accessor :info
     def initialize(hash, test)
         @hash = hash
@@ -15,35 +15,27 @@ class Snapshot
         getInfo
     end
 
+    #Calls out to api to get updated info for this snapshot
+    #@return : a hash object with all of the info for this Snapshot
     def getInfo
-=begin  
-        Calls out to api to get updated info for this snapshot
-        :returns: a hash object with all of the info for this Snapshot
-    
-=end
-        @info = JSON.parse(RestClient.get("https://#{$USERNAME}:#{$AUTHKEY}@crossbrowsertesting.com/api/v3/selenium/" + @testId +"/snapshots/"+ @hash))
-        return @info
+        @info = JSON.parse(RestClient.get("https://#{Cbthelper.username}:#{Cbthelper.authkey}@crossbrowsertesting.com/api/v3/selenium/#{@testId}/snapshots/#{@hash}"))
     end
-    def setDescription(description)
-        #Sets the description for this snapshot
-        
-        url = "https://#{$USERNAME}:#{$AUTHKEY}@crossbrowsertesting.com/api/v3/selenium/" + @testId + "/snapshots/" + @hash
+
+    #Sets the description for this snapshot
+    def setDescription(description) 
+        url = "https://#{Cbthelper.username}:#{Cbthelper.authkey}@crossbrowsertesting.com/api/v3/selenium/#{@testId}/snapshots/#{@hash}"
         @info = RestClient.put(url, "description=#{description}")
       
     end
 
-    def saveLocally(location)
-        #Downloads the snapshot to the given location
-        #:param location: a string with the location and filename for the image. Should have a .png extension
-        saveSnapshot(location)
-    end
-
+    #Downloads the snapshot to the given location
+    #@param location: a string with the location and filename for the image. Should have a .png extension
     def saveSnapshot(location)
         url = getInfo["image"]
         path = File.split(location)[0]
         Dir.mkdir(path) unless Dir.exist?(path)
 
-        # downloads the image to the given location in chunks
+        #downloads the image to the given location in chunks
         File.open(location, "wb") {|f|
             block = proc { |response|
                 response.read_body do |chunk|

data/lib/cbthelper/TestHistoryBuilder.rb

@@ -1,93 +1,82 @@
+#Builder to generate options for getting test history
+#All of the with... methods return self for method chaining
+
 class TestHistoryBuilder
-=begin     
-    Builder to generate options for getting test history
-    All of the with... methods return self for method chaining
-=end
+    
+
     def initialize
         @options = {}   
     end
 
+    #Sets the max number of tests to return
     def withLimit(limit)
-        # Sets the max number of tests to return
         @options["num"] = limit
         self
     end
 
+    #If set, will only return active or inactive tests
+    #@param active: boolean value
     def withActive(active)
-=begin        
-        If set, will only return active or inactive tests
-        :param active: boolean value
-=end
         @options["active"] = active
         self
     end
 
+    #Will only return tests that match the name given
     def withName(name)
-        # Will only return tests that match the name given
         @options["name"] = name
         self
     end
 
+    # Will only return tests that match the build given
     def withBuild(build)
-        # Will only return tests that match the build given
         @options["build"] = build
         self
     end
 
+    #Will only return tests that navigate to the same url
     def withUrl(url)
-        # Will only return tests that navigate to the same url
         @options["url"] = url
         self
     end
 
+    #Will only return tests with the score specified ('pass', 'fail', 'unset')
     def withScore(score)
-       #Will only return tests with the score specified ('pass', 'fail', 'unset')
         @options["score"] = score
         self
     end
 
+    #Will only return tests with the same platform (OS)
+    #@param platform: string with the platform (eg. 'Windows 10', 'Mac OS 10.13')
     def withPlatform(platform)
-=begin
-        Will only return tests with the same platform (OS)
-        :param platform: string with the platform (eg. 'Windows 10', 'Mac OS 10.13')
-=end
         @options["platform"] = platform
         self
      end
 
+    #Will only return tests with the same platformType (OS Family)
+    #@param platformType: string with the platform type (eg. 'Windows', 'Mac', 'Android')
     def withPlatformType(platformType)
-=begin
-        Will only return tests with the same platformType (OS Family)
-        :param platformType: string with the platform type (eg. 'Windows', 'Mac', 'Android')
-=end
         @options["platformType"] = platformType
         self
     end 
 
+    #Will only return tests that used the same browser
+    #@param browser: a string with the browser name and version: (eg. Chrome 65)
     def withBrowser(browser)
-=begin
-        Will only return tests that used the same browser
-        :param browser: a string with the browser name and version: (eg. Chrome 65)
-=end
         @options["browser"] = browser
         self
     end
 
+    #Will only return tests that used the same browser type
+    #@param browserType: a string representing the browser family (eg. 'Chrome', 'Edge', 'Safari')
+
     def withBrowserType(browserType)
-=begin
-        Will only return tests that used the same browser type
-        :param browserType: a string representing the browser family (eg. 'Chrome', 'Edge', 'Safari')
-=end
         @options["browserType"] = browserType
         self
     end
 
+    #Will only return tests that used the same resolution
+    #@param resolution: a string with the form 'WIDTHxHEIGHT' (eg. '1024x768')
     def withResolution(resolution)
-=begin
-        Will only return tests that used the same resolution
-        :param resolution: a string with the form 'WIDTHxHEIGHT' (eg. '1024x768')
-        
-=end
         @options["resolution"]= resolution
         self
     end
@@ -102,11 +91,9 @@ class TestHistoryBuilder
         self
     end
 
+    #Generates the test history options
+    #@return : a ruby hash to pass to getTestHistory()
     def build
-=begin
-        Generates the test history options
-        :returns: a ruby hash to pass to getTestHistory()
-=end
         return @options
     end
     

data/lib/cbthelper/Video.rb

@@ -1,14 +1,13 @@
-require_relative "Globals"
+require_relative "../cbthelper.rb"
 require "json"
 require "rest-client"
 
+#Represents a video recording for a selenium test
 class Video
-=begin
-	 Represents a video recording for a selenium test
-    :param hash: the hash for this video, returned by rest api when starting a recording
-    :param test: an AutomatedTest object that represents a test currently running
-=end
-
+	
+	
+    #@param hash: the hash for this video, returned by rest api when starting a recording
+    #@param test: an AutomatedTest object that represents a test currently running
 	attr_accessor :info
 	def initialize(hash, test)
 		@hash = hash
@@ -17,44 +16,34 @@ class Video
 
 	end
 
-	def getInfo
-=begin
-		 Calls out to api to get updated info for this video
-        :returns: a hash object with all of the info for this video
-=end
-		@info = JSON.parse(RestClient.get("https://#{$USERNAME}:#{$AUTHKEY}@crossbrowsertesting.com/api/v3/selenium/" + @testId +"/videos/"+ @hash))
-		return @info
-
+	#Calls out to api to get updated info for this video
+    #@return : a hash object with all of the info for this video
+    def getInfo
+		@info = JSON.parse(RestClient.get("https://#{Cbthelper.username}:#{Cbthelper.authkey}@crossbrowsertesting.com/api/v3/selenium/#{@testId}/videos/#{@hash}"))
 	end
 	
 	def stopRecording
-		# Sends the command to stop a video recording
-		RestClient.delete("https://#{$USERNAME}:#{$AUTHKEY}@crossbrowsertesting.com/api/v3/selenium/" + @testId +"/videos/"+ @hash)
+		#Sends the command to stop a video recording
+		RestClient.delete("https://#{Cbthelper.username}:#{Cbthelper.authkey}@crossbrowsertesting.com/api/v3/selenium/#{@testId}/videos/#{@hash}")
 		
 	end
 	 
+	#Sets the description for this video
 	def setDescription(description)
-		# Sets the description for this video
-		url = "https://#{$USERNAME}:#{$AUTHKEY}@crossbrowsertesting.com/api/v3/selenium/" + @testId + "/videos/" + @hash
+		url = "https://#{Cbthelper.username}:#{Cbthelper.authkey}@crossbrowsertesting.com/api/v3/selenium/#{@testId}/videos/#{@hash}"
         @info = RestClient.put(url, "description=#{description}")
 
 	end
 
-	def saveLocally(location)
-		#:param location: a string with the location and filename for the video. Should have a .mp4 extension
-        saveVideo(location)
-	end
+	#@param location: a string with the location and filename for the video. Should have a .mp4 extension
 	def saveVideo(location)
 		url = getInfo["video"]
-		if info["is_finished"] == false
-			stopRecording
-		end
+        stopRecording unless info["is_finished"]
 
-		#
         path = File.split(location)[0]
         Dir.mkdir(path) unless Dir.exist?(path)
 
-        # downloads the video to the given location in chunks
+        #downloads the video to the given location in chunks
         File.open(location, "wb") {|f|
             block = proc { |response|
                 response.read_body do |chunk|

data/lib/cbthelper/version.rb

@@ -0,0 +1,3 @@
+module Cbthelper
+  VERSION = "1.0.0"
+end

metadata

@@ -1,33 +1,76 @@
 --- !ruby/object:Gem::Specification
 name: cbthelper
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Daphne Magsby
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2018-09-20 00:00:00.000000000 Z
-dependencies: []
+date: 2018-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 description: cbthelper wraps CrossBrowserTesting's (https://crossbrowsertesting.com/apidocs/v3/selenium.html)
   into an easy to use library.
-email: daphnem@crossbrowsertesting.com
+email:
+- daphnem@crossbrowsertesting.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".DS_Store"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cbthelper.gemspec
+- lib/.DS_Store
 - lib/cbthelper.rb
+- lib/cbthelper/.DS_Store
 - lib/cbthelper/AutomatedTest.rb
 - lib/cbthelper/CapsBuilder.rb
-- lib/cbthelper/Globals.rb
 - lib/cbthelper/Snapshot.rb
 - lib/cbthelper/TestHistoryBuilder.rb
 - lib/cbthelper/Video.rb
-homepage: http://rubygems.org/gems/cbthelper
+- lib/cbthelper/version.rb
+homepage: https://help.crossbrowsertesting.com/selenium-testing/getting-started/cbthelper-ruby/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://help.crossbrowsertesting.com/selenium-testing/getting-started/cbthelper-ruby/
+  source_code_uri: https://github.com/crossbrowsertesting/cbthelper-ruby
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/cbthelper/Globals.rb

@@ -1,5 +0,0 @@
-$USERNAME = ""
-$AUTHKEY = ""
-$CAPSBUILDER = nil
-$API = "https://crossbrowsertesting.com/api/v3/selenium/"
-$HUB = "http://hub.crossbrowsertesting.com:80/wd/hub"