cbthelper 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c0d344eb5bed1594c52cb3a3f793c643af8866e3a1cba768c5c6a52445326f64
+  data.tar.gz: 8c8d0263e924b9b4602c79138289b0d54ab2d7e597e7282ec0ac03b83478172e
+SHA512:
+  metadata.gz: b98849177569e7c854e0aef42859dedd875fe836b8b561d03891c34ae18df47601012faec9e2f52d39e05f751815494c9c50b785bdbb3cc10fd0d3406be248ea
+  data.tar.gz: b3fa1206472fb7c7be48533e5cd8c8fd9e2f189d5628d36680b1f689c37981b7668a106d8bb6723cfff498fda2865d76b7e61ad45b1efff4c5ba9b01d3767bee

data/lib/cbthelper.rb

@@ -0,0 +1,48 @@
+require_relative "cbthelper/Globals"
+require_relative "cbthelper/AutomatedTest"
+require_relative "cbthelper/CapsBuilder"
+require_relative "cbthelper/Snapshot"
+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
+
+
+def login(username, authkey)
+    #Sets the username and authkey used to make the HTTP requests
+    $USERNAME = username
+    $AUTHKEY = authkey
+
+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
+
+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/"))
+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)
+end

data/lib/cbthelper/AutomatedTest.rb

@@ -0,0 +1,133 @@
+require_relative "Globals"
+require_relative "Snapshot"
+require_relative "Video"
+require "rest-client"
+require "json"
+
+class AutomatedTest
+=begin
+	Helpful representation of a selenium test
+    :param testId: the selenium session ID, usually from webdriver
+  
+=end
+	def initialize(testId)
+		@testId = testId
+	end
+	
+	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}",
+            "action=set_score&score=#{score}")
+	end
+	
+	def setDescription(description)
+		#Sets the description for the test in the web app
+		RestClient.put("https://#{$USERNAME}:#{$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 != ""
+			setScore(score)
+			RestClient.delete("https://#{$USERNAME}:#{$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",
+		 	"selenium_test_id=#{@testId}")
+		 hash = /(?<="hash": ")((\w|\d)*)/.match(response)[0]
+		 snap = Snapshot.new(hash, @testId)
+		 if description != ""
+		 	snap.setDescription(description)
+		 end
+		 return snap
+
+	end
+
+	def getSnapshots()
+		# Returns all snapshots for this test
+		snaps = JSON.parse(RestClient.get("https://#{$USERNAME}:#{$AUTHKEY}@crossbrowsertesting.com/api/v3/selenium/" + @testId +"/snapshots/"))	
+		ret = []
+		for snap in snaps
+			ret.push(Snapshot.new(snap["hash"], @testId))
+
+		end
+		return ret
+	end
+
+	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))
+		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")
+		 hash = /(?<="hash": ")((\w|\d)*)/.match(response)[0]
+		 video = Video.new(hash, @testId)
+		 if description != ""
+		 	video.setDescription(description)
+		 end
+		 return video
+		
+	end
+
+	def getVideos
+		# Returns all videos for this test
+		videos = JSON.parse(RestClient.get("https://#{$USERNAME}:#{$AUTHKEY}@crossbrowsertesting.com/api/v3/selenium/" + @testId +"/videos/"))	
+		ret = []
+		for video in videos
+			ret.push(Video.new(video["hash"], @testId))
+
+		end
+		return ret
+	end
+
+	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))
+		end
+
+	end
+
+
+	def makeDirectory(dir)
+		Dir.mkdir(dir) unless Dir.exist?(dir)
+	
+	end
+	
+end

data/lib/cbthelper/CapsBuilder.rb

@@ -0,0 +1,153 @@
+require "rest-client"
+require "json"
+require_relative "Globals"
+
+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
+        @browser = nil
+        @browserVersion = nil
+        @width = nil
+        @height = nil
+        @name = nil
+        @version = nil
+        @recordVideo = nil
+        @recordNetwork = nil
+    end
+
+    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
+
+    def withBrowser(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
+
+    def withBrowserVersion(version)
+        # Sets the browser verson
+        @browserVersion = version
+        self
+    end
+
+    def withResolution(width, height)
+        # Sets the screen size for the test
+        @width = width
+        @height = height
+        self
+    end
+
+    def withName(name)
+        # Sets the name of the test in the web app
+        @name = name
+        self
+    end
+    
+    def withBuild(build)
+        #Sets the build number in the web app
+        @version = build
+        self
+    end 
+
+    def withRecordVideo(bool)
+        #Records a video for the length of the test
+        @recordVideo = bool
+        self
+    end
+
+    def withRecordNetwork(bool)
+        #Records network traffic for the length of the test
+        @recordNetwork = bool
+        self
+    end
+
+    def build
+        #Used to generate the capabilites using any options the user specifies
+        return choose
+    end
+
+    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
+            if target == name or target == apiName
+                return option
+            end
+        end
+        return nil
+    end
+
+    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
+                if target == name or target == apiName
+                    return browser
+                end
+            end
+        end
+        return nil
+    end
+
+    def choose
+        #Sets the capabilities passed to the WebDriver
+        data = @capsData
+        caps = Selenium::WebDriver::Remote::Capabilities.new
+        if @platform
+            caps['platform'] = @platform
+        end
+        if @browser
+            caps['browser'] = @browser
+        end
+
+        if @browserVersion
+            caps['browser_version'] = @browserVersion
+        end
+
+        if @width and @height
+            caps['screenResolution'] = @width.to_s + 'x' + @height.to_s
+        end
+
+        if @name
+            caps['name'] = @name
+        end
+
+        if @version
+            caps['build'] = @version
+        end 
+
+        if @recordVideo
+            caps['record_video'] = @recordVideo
+        end
+
+        if @recordNetwork
+            caps['record_network'] = @recordNetwork
+        end
+        return caps
+    end
+
+
+
+
+end

data/lib/cbthelper/Globals.rb

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

data/lib/cbthelper/Snapshot.rb

@@ -0,0 +1,58 @@
+require_relative "Globals"
+require "json"
+require "rest-client"
+
+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 
+    attr_accessor :info
+    def initialize(hash, test)
+        @hash = hash
+        @testId = test
+        getInfo
+    end
+
+    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
+    end
+    def setDescription(description)
+        #Sets the description for this snapshot
+        
+        url = "https://#{$USERNAME}:#{$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
+
+    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
+        File.open(location, "wb") {|f|
+            block = proc { |response|
+                response.read_body do |chunk|
+                    f.write chunk
+                end
+            }
+            RestClient::Request.execute(method: :get,
+                                        url: url,
+                                        block_response: block)
+        }
+    end
+end

data/lib/cbthelper/TestHistoryBuilder.rb

@@ -0,0 +1,114 @@
+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
+
+    def withLimit(limit)
+        # Sets the max number of tests to return
+        @options["num"] = limit
+        self
+    end
+
+    def withActive(active)
+=begin        
+        If set, will only return active or inactive tests
+        :param active: boolean value
+=end
+        @options["active"] = active
+        self
+    end
+
+    def withName(name)
+        # Will only return tests that match the name given
+        @options["name"] = name
+        self
+    end
+
+    def withBuild(build)
+        # Will only return tests that match the build given
+        @options["build"] = build
+        self
+    end
+
+    def withUrl(url)
+        # Will only return tests that navigate to the same url
+        @options["url"] = url
+        self
+    end
+
+    def withScore(score)
+       #Will only return tests with the score specified ('pass', 'fail', 'unset')
+        @options["score"] = score
+        self
+    end
+
+    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
+
+    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 
+
+    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
+
+    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
+
+    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
+
+    def withStartDate(startDate)
+        @options["startDate"] = startDate
+        self
+    end
+
+    def withEndDate(endDate)
+        @options["endDate"] = endDate
+        self
+    end
+
+    def build
+=begin
+        Generates the test history options
+        :returns: a ruby hash to pass to getTestHistory()
+=end
+        return @options
+    end
+    
+end
+

data/lib/cbthelper/Video.rb

@@ -0,0 +1,70 @@
+require_relative "Globals"
+require "json"
+require "rest-client"
+
+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
+
+	attr_accessor :info
+	def initialize(hash, test)
+		@hash = hash
+		@testId = test
+		getInfo
+
+	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
+
+	end
+	
+	def stopRecording
+		# Sends the command to stop a video recording
+		RestClient.delete("https://#{$USERNAME}:#{$AUTHKEY}@crossbrowsertesting.com/api/v3/selenium/" + @testId +"/videos/"+ @hash)
+		
+	end
+	 
+	def setDescription(description)
+		# Sets the description for this video
+		url = "https://#{$USERNAME}:#{$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
+	def saveVideo(location)
+		url = getInfo["video"]
+		if info["is_finished"] == false
+			stopRecording
+		end
+
+		#
+        path = File.split(location)[0]
+        Dir.mkdir(path) unless Dir.exist?(path)
+
+        # downloads the video to the given location in chunks
+        File.open(location, "wb") {|f|
+            block = proc { |response|
+                response.read_body do |chunk|
+                    f.write chunk
+                end
+            }
+            RestClient::Request.execute(method: :get,
+                                        url: url,
+                                        block_response: block)
+        }
+
+	end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: cbthelper
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Daphne Magsby
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-17 00:00:00.000000000 Z
+dependencies: []
+description: cbthelper wraps CrossBrowserTesting's (https://crossbrowsertesting.com/apidocs/v3/selenium.html)
+  into an easy to use library.
+email: daphnem@crossbrowsertesting.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cbthelper.rb
+- 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
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: cbthelper
+test_files: []