integration-diff 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97cfcbbd84c5a7bc1b00555ea38c2437d26303ae
-  data.tar.gz: 9337a1a04ecf3b7e95f7a92a647f5aad83d0d886
+  metadata.gz: 631209ac6e776d921e664db5fed095e6178b761b
+  data.tar.gz: 25ae1b328f8c0f77a88ec995e34223f4af6b90e4
 SHA512:
-  metadata.gz: d16826719150fe1768d51bb968b1a97c18ab793a08b0ce156ef12f0bded4ca0eaeef8e39cc116f648882ac3cd02ad1f9f5d8db0e04708b1d79c630782bd506d0
-  data.tar.gz: b53301ceadb3023d6f0be26ab4263bd296011e1f81bed949d4f5a18c45e657c653430994b72d5cc4377c5d2ca765d5314b94f7b64d07d3a3aa74084f64774db9
+  metadata.gz: 89b9abd69d75548df40336e7f5db4ae9d30eabf0c49792b34695f3803e287e7fc5dc5cfcff197bfcb524920ce13f7c37b7356be5bb6a8de393c3180b71f5c65b
+  data.tar.gz: 00836038fc50f5d024a5ffcc9dee2bebfefdd5a2a3e1b334527af5e42c94d281e3d135d0d57a2026a204c32ea46bb87f109fb1739468451d07b0853ab3ef521c

data/Readme.md

@@ -60,20 +60,59 @@ end
 
 ### Usage
 
-In your specs, simply use `idiff` helper. make sure that you pass unique identifier
-to screenshots that you take. unique identifier helps in differentiating this
-screenshot taken from other screenshots.
+In your specs, simply use `idiff` helper which has bunch of config utilities.
+
+First, you should specify environment details under which screenshots are
+taken. There are 6 parameters which can be configured.
+
+Parameter|Explanation
+---------|-----------
+browser  | which browser is used to take screenshots. default: 'firefox'
+         | supported: firefox, chrome, safari, ie, opera
+device   | which device is used to take screenshots. default: 'desktop'
+         | supported: desktop, laptop, tablet, phone
+os       | which os is used to take screenshots. default: 'linux'
+         | supported: android, ios, windows, osx, linux
+browser_version | (optional) version of browser used, for eg: '46' for firefox
+device_name     | (optional) name of device, for eg: 'MacBook Air'
+os_version      | (optional) version of os used, for eg: '10.11'
+
+
+They can be configured using `idiff` helper while running specs. For eg:
+
+```rb
+idiff.browser = 'firefox'
+idiff.device = 'laptop'
+idiff.os = 'osx'
+idiff.browser_version = '46'
+idiff.device_name = 'MBA'
+idiff.os_version = '10.11.5'
+```
+
+Also, `idiff` can used to take screenshots also. Make sure that you pass
+unique identifier to screenshots that you take. unique identifier helps
+in differentiating this screenshot taken from other screenshots for a
+given set of `browser`, `device`, and `os`.
 
 
 ```rb
 describe "Landing page" do
   it "has a big banner" do
     visit root_path
+
+    idiff.browser = 'chrome'
     idiff.screenshot("unique-identifier")
   end
 end
 ```
 
+Since there is flexibility to specify `browser`, `device`, and `os` while
+running specs dynamically (unlike specifying `project_name`), you can run
+all your specs in a loop by changing `browser`, `device` and `os` by
+changing selenium driver, or changing viewport etc. Flexibility for your
+service!
+
+
 ### Concurrency
 
 By default, when all the screenshots are collected, and before suite ends, this

data/lib/integration_diff/dummy_runner.rb

@@ -4,6 +4,9 @@ module IntegrationDiff
       @runner ||= DummyRunner.new
     end
 
+    attr_accessor :browser, :device, :os
+    attr_accessor :browser_version, :device_name, :os_version
+
     def start_run
     end
 

data/lib/integration_diff/runner.rb

@@ -13,6 +13,9 @@ module IntegrationDiff
                              IntegrationDiff.javascript_driver)
     end
 
+    attr_accessor :browser, :device, :os
+    attr_accessor :browser_version, :device_name, :os_version
+
     def initialize(project_name, javascript_driver)
       @project_name = project_name
       @javascript_driver = javascript_driver
@@ -20,6 +23,10 @@ module IntegrationDiff
       dir = IntegrationDiff::Utils.images_dir
       Dir.mkdir('tmp') unless Dir.exist?('tmp')
       Dir.mkdir(dir) unless Dir.exist?(dir)
+
+      self.browser = 'firefox'
+      self.device = 'desktop'
+      self.os = 'linux'
     end
 
     # TODO: Improve error handling here for network timeouts
@@ -42,9 +49,14 @@ module IntegrationDiff
     end
 
     def screenshot(identifier)
+      raise 'no browser information provided' if browser.nil?
+      raise 'no device information provided' if device.nil?
+      raise 'no os information provided' if os.nil?
+
       screenshot_name = IntegrationDiff::Utils.image_file(identifier)
       page.save_screenshot(screenshot_name, full: true)
-      @uploader.enqueue(identifier)
+      @uploader.enqueue(identifier, browser, device, os, browser_version,
+                        device_name, os_version)
     end
 
     private

data/lib/integration_diff/uploaders/concurrent.rb

@@ -11,11 +11,14 @@ module IntegrationDiff
         @screenshots_taken = 0
       end
 
-      def enqueue(identifier)
+      def enqueue(identifier, browser, device, os, browser_version,
+                  device_name, os_version)
         @screenshots_taken += 1
 
         @pool.post do
-          IntegrationDiff::Utils.upload_image(@run_id, identifier)
+          IntegrationDiff::Utils
+            .upload_image(@run_id, identifier, browser, device, os,
+                          browser_version, device_name, os_version)
         end
       end
 

data/lib/integration_diff/uploaders/sequential.rb

@@ -5,16 +5,22 @@ module IntegrationDiff
     class Sequential
       def initialize(run_id)
         @run_id = run_id
-        @identifiers = []
+        @identifiers_with_env = []
       end
 
-      def enqueue(identifier)
-        @identifiers << identifier
+      def enqueue(identifier, browser, device, os, browser_version,
+                  device_name, os_version)
+        @identifiers_with_env << [identifier, browser, device, os,
+                                  browser_version, device_name,
+                                  os_version]
       end
 
       def wrapup
-        @identifiers.each do |identifier|
-          IntegrationDiff::Utils.upload_image(@run_id, identifier)
+        @identifiers_with_env
+          .each do |identifier, browser, device, os, browser_version, device_name, os_version|
+          IntegrationDiff::Utils
+            .upload_image(@run_id, identifier, browser, device, os,
+                          browser_version, device_name, os_version)
         end
       end
     end

data/lib/integration_diff/utils.rb

@@ -15,11 +15,14 @@ module IntegrationDiff
       'tmp/idiff_images'.freeze
     end
 
-    def self.upload_image(run_id, identifier)
+    def self.upload_image(run_id, identifier, browser, device, os, browser_version,
+                          device_name, os_version)
       IntegrationDiff.logger.fatal "uploading #{identifier}"
       image_io = Faraday::UploadIO.new(image_file(identifier), 'image/png')
       connection.post("/api/v1/runs/#{run_id}/run_images",
-                      identifier: identifier, image: image_io)
+                      identifier: identifier, image: image_io, browser: browser,
+                      device: device, os: os, browser_version: browser_version,
+                      device_name: device_name, os_version: os_version)
     end
 
     def self.image_file(identifier)

data/lib/integration_diff/version.rb

@@ -1,3 +1,3 @@
 module IntegrationDiff
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: integration-diff
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yuva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-22 00:00:00.000000000 Z
+date: 2016-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday