capistrano-ghostinspector 0.1.2 → 0.2.0.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c0e84dade9219a86d28382f7fe24fe34f45e23f
-  data.tar.gz: 738460377e48ac52d6d460c531f0d54c6bffc196
+  metadata.gz: 3f2f6e5c14918854e600a4948d6e89e129dfd678
+  data.tar.gz: 03e2e2f1195a2592292017e6242236c2ace087ef
 SHA512:
-  metadata.gz: 6efdf7b65e840d4ff186907edd5e8de84acbe4ac76ed4f22e954958d62e665d05198c063f513a150004055a0b699659b5b070ac45491eac47a10490e9bbf4be4
-  data.tar.gz: 5d364ba7bc34e7bf88cd2cc2a9bdf40d83b475e5be7c8db80627cda54dafb1608768cf867eb7baa5ae337b3e37c86f0cb2901d2ad101c6bcc91a859f25035e62
+  metadata.gz: e5ae805e1a27347f674762e6169ab89c41fab16dc32d1caea478de6ebad7eb5c92f320b491898fcb501334e67c6c740e6a67b1f0f7b39df7a8223c265100d5ff
+  data.tar.gz: 5db5de9ef603a0b8c321246853df5bb35e9c2f6143c356d90947addd4a400446110f65fabed33e5e92dc529bba24c95db93544acc7f6fbe08027d227b333dbf4

data/README.md

@@ -1,6 +1,6 @@
 # Capistrano::Ghostinspector
 
-[![Scrutinizer Code Quality](https://www2.scrutinizer-ci.com/g/richdynamix/capistrano-ghostinspector/badges/quality-score.png?b=develop)](https://www2.scrutinizer-ci.com/g/richdynamix/capistrano-ghostinspector/?branch=develop) [![Build Status](https://www2.scrutinizer-ci.com/g/richdynamix/capistrano-ghostinspector/badges/build.png?b=develop)](https://www2.scrutinizer-ci.com/g/richdynamix/capistrano-ghostinspector/build-status/develop)
+[![Scrutinizer Code Quality](https://www2.scrutinizer-ci.com/g/richdynamix/capistrano-ghostinspector/badges/quality-score.png?b=develop)](https://www2.scrutinizer-ci.com/g/richdynamix/capistrano-ghostinspector/?branch=develop) [![Build Status](https://www2.scrutinizer-ci.com/g/richdynamix/capistrano-ghostinspector/badges/build.png?b=develop)](https://www2.scrutinizer-ci.com/g/richdynamix/capistrano-ghostinspector/build-status/develop) [![Gem Version](https://badge.fury.io/rb/capistrano-ghostinspector.svg)](https://badge.fury.io/rb/capistrano-ghostinspector)
 
 
 [Ghost Inspector](https://ghostinspector.com/ "Ghost Inspector") is an automated website regression testing tool. This [Capistrano](http://capistranorb.com/ "Capistrano") plugin is a simple, configurable gem that will provide the following features.

data/capistrano-ghostinspector.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'capistrano', "~> 2.15.5"
+  spec.add_dependency 'staccato'
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/capistrano/ghostinspector.rb

@@ -15,8 +15,12 @@ module Capistrano
 
               set :giconfig, YAML::load(File.read("gi_config.yaml"))
 
+              # Ghost Inspector API key
               set :gi_api_key, giconfig["APIKEY"]
 
+              # Google Analytics Tracking Property
+              set :ga_property, giconfig["ga_property"]
+
               # Get tests and suites from command line
               set :gitest, fetch(:gitest, nil)
               set :gisuite, fetch(:gisuite, nil)
@@ -32,13 +36,13 @@ module Capistrano
                 # run each test
                 Capistrano::Ghostinspector.getTests(gitest, giconfig["tests"]).each do |test|
                   puts "* * * Running Ghost Inspector Test * * *"
-                  set :passing, Capistrano::Ghostinspector.executeApi("tests", test, gi_api_key, domain, rollback)
+                  set :passing, Capistrano::Ghostinspector::Api.executeApi("tests", test, gi_api_key, domain, rollback, ga_property, current_revision[0,7])
                 end
 
                 # run each suite
                 Capistrano::Ghostinspector.getTests(gisuite, giconfig["suites"]).each do |suite|
                   puts "* * * Running Ghost Inspector Suite * * *"
-                  set :passing, Capistrano::Ghostinspector.executeApi("suites", suite, gi_api_key, domain, rollback)
+                  set :passing, Capistrano::Ghostinspector::Api.executeApi("suites", suite, gi_api_key, domain, rollback, ga_property, current_revision[0,7])
                 end
 
                 # If any test fails and the stage allows rollbacks then

data/lib/capistrano/ghostinspector/analytics.rb

@@ -0,0 +1,33 @@
+require "capistrano/ghostinspector/analytics"
+require "staccato"
+
+module Capistrano
+  module Ghostinspector
+	  module Analytics
+	    def self.pushDeployment(ga_property, current_revision)
+
+	    	tracker = Staccato.tracker(ga_property)
+
+			# inform GA of a new deployment
+			tracker.event(category: 'deployment', action: "deploy", label: current_revision, non_interactive: true)
+
+	    end
+
+	    def self.pushErrors(ga_property, current_revision, data)
+
+			tracker = Staccato.tracker(ga_property)
+
+			data['steps'].each do |step|
+
+				if (step['passing'] == false)
+					# send the errors to GA
+					tracker.event(category: 'error', action: step['error'], label: "Command: #{step['command']} - Target: #{step['target']}", non_interactive: true)
+				end
+
+			end
+
+	    end
+
+	  end
+  end
+end

data/lib/capistrano/ghostinspector/api.rb

@@ -1,31 +1,65 @@
+require "capistrano/ghostinspector/analytics"
 require 'net/https'
 require 'json'
 
 module Capistrano
   module Ghostinspector
-    def self.executeApi(type, test, gi_api_key, domain, rollback)
-
-    	# Determine if we should get results to 
-    	# check for any failed tests
-		if (rollback == false)
-			immediate = "&immediate=1"
-		else
-			immediate = ""
-			puts "* * * Gathering results. This could take a few minutes. * * *"
-		end
-		
-		# Default all tests pass
-		passing = true
-
-		# execute the Ghost Inspector API call
-		uri = URI("https://api.ghostinspector.com/v1/#{type}/#{test}/execute/?apiKey=#{gi_api_key}&startUrl=http://#{domain}/#{immediate}")
-		data = Net::HTTP.get(uri)
-
-		# Check the data returned for failed tests
-		if (rollback == true) 
+	  module Api
+	    def self.executeApi(type, test, gi_api_key, domain, rollback, ga_property, current_revision)
+
+	    	# Determine if we should get results to 
+	    	# check for any failed tests
+			immediate = self.includeResults(rollback, ga_property)
+			
+			# Default all tests pass
+			passing = true
+
+			# Lets push the deployment in GA if the configuration allows it.
+			Capistrano::Ghostinspector::Analytics.pushDeployment(ga_property, current_revision)
+
+			# # Perform the API request and get the results
+			results = self.sendRequest(type, test, gi_api_key, domain, immediate)
+
+			# Check the data returned for failed tests
+			if (rollback == true) 
+				passing = self.getPassing(type, results, ga_property)
+			end
+
+			if (passing == false && ga_property != "")
+				Capistrano::Ghostinspector::Analytics.pushErrors(ga_property, current_revision, results['data'])
+			end
+
+			return passing
+			
+	    end
+
+	    def self.includeResults(rollback, ga_property)
+	    	# Determine if we should get results to 
+	    	# check for any failed tests
+			if (rollback == false && ga_property == "")
+				immediate = "&immediate=1"
+			else
+				immediate = ""
+				puts "* * * Gathering results. This could take a few minutes. * * *"
+			end
+
+			return immediate
+	    end
+
+	    def self.sendRequest(type, test, gi_api_key, domain, immediate)
+	    	
+	    	# execute the Ghost Inspector API call
+			uri = URI("https://api.ghostinspector.com/v1/#{type}/#{test}/execute/?apiKey=#{gi_api_key}&startUrl=http://#{domain}/#{immediate}")
+			data = Net::HTTP.get(uri)
+
 			results = JSON.parse(data)
 
-			if (type == "suite")
+			return results
+	    end
+
+	    def self.getPassing(type, results, ga_property)
+	    	
+	    	if (type == "suite")
 				results['data'].each do |testItem|                  
 				  passing = testItem['passing']
 				end
@@ -33,10 +67,10 @@ module Capistrano
 				passing = results['data']['passing']
 			end
 
-		end
+			return passing
+	    	
+	    end
 
-		return passing
-		
-    end
+	  end
   end
 end

data/lib/capistrano/ghostinspector/config.rb

@@ -0,0 +1,13 @@
+require "capistrano/ghostinspector/analytics"
+
+module Capistrano
+  module Ghostinspector
+    def self.configure(config)
+
+		
+
+
+    end
+
+  end
+end

data/lib/capistrano/ghostinspector/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Ghostinspector
-    VERSION = "0.1.2"
+    VERSION = "0.2.0.rc"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-ghostinspector
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0.rc
 platform: ruby
 authors:
 - Steven Richardson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-18 00:00:00.000000000 Z
+date: 2015-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.15.5
+- !ruby/object:Gem::Dependency
+  name: staccato
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,8 +108,10 @@ files:
 - Rakefile
 - capistrano-ghostinspector.gemspec
 - lib/capistrano/ghostinspector.rb
+- lib/capistrano/ghostinspector/analytics.rb
 - lib/capistrano/ghostinspector/api.rb
 - lib/capistrano/ghostinspector/arrays.rb
+- lib/capistrano/ghostinspector/config.rb
 - lib/capistrano/ghostinspector/version.rb
 - spec/capistrano-ghostinspector_spec.rb
 - spec/spec_helper.rb
@@ -115,9 +131,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5