lineup 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89ea9b6e95a25a526e1bb6317ec204a8518d4e4d
-  data.tar.gz: 01f7795b66bb5b652c0f01925307b5fa6af6ea2e
+  metadata.gz: a9c1277997e4c9f112ae3a09071a8a54ff47ea66
+  data.tar.gz: 91015501ca8250b834c1473b121546a632f0d0b5
 SHA512:
-  metadata.gz: 774b8f2777cd26e9609875e34a29336dcda9a5c254e3c78acf153a48d320b0a0587d2332c15090bdb8be10ed2daccec3c848f1fed0cbd8ccc1b662208aa5a5fb
-  data.tar.gz: bfd830aa1e580998ba50c87bfbea26004a76202b97e46418607de0358bb22b52827bba433ef5d3af474ce3d52f785bc447b882d4b1564b345415cb1fe7d2d5c3
+  metadata.gz: 20cf39c0e193c0c1672fc717bdb8c326b8bce914835c566c3e77545c575c083e4c6685c958040853d63cb0c411cccbc2d5dd1da36c2bcfa17225e2cac6d46929
+  data.tar.gz: fc4a0df84e6779908648a52bd25e512c6ffe3d3c660079a61f9c28886cfbfbbdee0a949f08e0ba7227a5737f608efdb656f8007d99e8e4daefc6a4282c8579e5

data/lib/controller/browser.rb

@@ -7,7 +7,7 @@ require_relative '../helper'
 
 class Browser
 
-  def initialize(baseurl, urls, resolutions, path, headless, wait, cookie = false)
+  def initialize(baseurl, urls, resolutions, path, headless, wait, cookies = [])
     @absolute_image_path = path
     FileUtils.mkdir_p @absolute_image_path
     @baseurl = baseurl
@@ -15,7 +15,7 @@ class Browser
     @resolutions = resolutions
     @headless = headless
     @wait = wait
-    @cookie = cookie
+    @cookies = cookies
   end
 
   def record(version)
@@ -54,9 +54,11 @@ class Browser
 
     url = Helper.url(@baseurl, url)
     @browser.goto url
-    if @cookie
+    if @cookies.any?
       @browser.cookies.clear
-      @browser.cookies.add(@cookie[:name], @cookie[:value], domain: @cookie[:domain], path: @cookie[:path], expires: Time.now + 7200, secure: @cookie[:secure])
+      @cookies.each do |cookie|
+        @browser.cookies.add(cookie[:name], cookie[:value], domain: cookie[:domain], path: cookie[:path], expires: Time.now + 7200, secure: cookie[:secure])
+      end
       @browser.goto url
     end
     sleep @wait if @wait

data/lib/lineup.rb

@@ -82,7 +82,6 @@ module Lineup
     end
 
 
-
     def resolutions(resolutions)
 
       # all resolutions to be tested are defined here
@@ -109,7 +108,6 @@ module Lineup
     end
 
 
-
     def filepath_for_images(path)
 
       # if required an absolute path to store all images can be passed here.
@@ -127,12 +125,11 @@ module Lineup
       raise_base_screenshots_taken('The path')
 
       # the path is one string. we just assign the variable
-      
+
       @screenshots_path = path
     end
 
-    
-    
+
     def use_phantomjs(boolean)
 
       # if required the headless environment can we skipped and firefox used for the screenshots
@@ -154,7 +151,6 @@ module Lineup
     end
 
 
-
     def difference_path(path)
 
       # if required an absolute path to store all difference images can be passed here.
@@ -201,6 +197,36 @@ module Lineup
       @cookie_for_experiment = cookie
     end
 
+    def cookies(cookies)
+
+      # a hash for cookies can be set here. this is optional.
+      #
+      # e.g {name: 'experiment', value: 'experiment_value', domain: 'domain.com', path: '/', expires: <Time>, secure: false}
+      #
+      # if it is not nil it has to be an array:
+
+      @cookies = []
+      if cookies
+        cookies.each do |cookie|
+          # generate :symbol => "value" hash map from "symbol" => "value"
+          cookie = cookie.inject({}) { |element, (symbol, value)| element[symbol.to_sym] = value; element }
+
+          #Validation
+          (raise "Cookie must be a hash of format
+                {name: 'experiment', value: 'experiment_value', domain: 'domain.com', path: '/', expires: <Time>, secure: false}
+                " unless cookie.is_a? Hash)
+
+          raise "cookie must have value for :name" unless (cookie[:name]).is_a? String
+          raise "cookie must have value for :value" unless (cookie[:value]).is_a? String
+          raise "cookie must have value for :domain" unless (cookie[:domain]).is_a? String
+          raise "cookie must have value for :path" unless (cookie[:path]).is_a? String
+          raise "cookie must have value for :secure" if (cookie[:secure]) == nil
+
+          @cookies.push(cookie)
+        end
+      end
+    end
+
 
     def wait_for_asynchron_pages(wait)
 
@@ -236,15 +262,24 @@ module Lineup
       difference_path(configuration["difference_path"])
       wait_for_asynchron_pages(configuration["wait_for_asynchron_pages"])
       cookie_for_experiment(configuration["cookie_for_experiment"])
+      cookies(configuration["cookies"])
+
+      if @cookies
+        cookies_merged= @cookies.inject([]) { |a,element| a << element.dup }
+      else
+        cookies_merged = []
+      end
+      if @cookie_for_experiment
+        cookies_merged.push(@cookie_for_experiment)
+      end
 
       # the method calls set the variables for the parameters, we return an array with all of them.
       # for the example above it is:
       # [["/multimedia", "/sport"], [600, 800, 1200], "~/images/", true, "#/images/diff"]
-      [@urls, @resolutions, @screenshots_path, @headless, @difference_path, @wait_for_asynchron_pages, @cookie_for_experiment]
+      [@urls, @resolutions, @screenshots_path, @headless, @difference_path, @wait_for_asynchron_pages, cookies_merged]
     end
 
 
-
     def record_screenshot(version)
 
       # to take a screenshot we have all parameters given from the methods above (or set to default values)
@@ -257,7 +292,15 @@ module Lineup
       # and saves the screenshot in the file
       #   @screenshot_path
 
-      browser = Browser.new(@baseurl, @urls, @resolutions, @screenshots_path, @headless, @wait_for_asynchron_pages, @cookie_for_experiment)
+      if @cookies
+        cookies_merged= @cookies.inject([]) { |a,element| a << element.dup }
+      else
+        cookies_merged = []
+      end
+      if @cookie_for_experiment
+        cookies_merged.push(@cookie_for_experiment)
+      end
+      browser = Browser.new(@baseurl, @urls, @resolutions, @screenshots_path, @headless, @wait_for_asynchron_pages, cookies_merged)
 
       # the only argument missing is if this is the "base" or "new" screenshot, this can be
       # passed as an argument. The value does not need to be "base" or "new", but can be anything
@@ -274,7 +317,6 @@ module Lineup
     end
 
 
-
     def compare(base, new)
 
       # this compares two previously taken screenshots
@@ -313,7 +355,7 @@ module Lineup
     end
 
     def clean(urls)
-      urls.gsub(' ', '').gsub(';',',')
+      urls.gsub(' ', '').gsub(';', ',')
     end
 
   end

data/lib/lineup/version.rb

@@ -1,7 +1,7 @@
 module Lineup
   class Version
     MAJOR = 0
-    MINOR = 3
+    MINOR = 4
     PATCH = 0
 
     class << self

data/tests/rspec/lineup_spec.rb

@@ -30,7 +30,7 @@ describe '#screeshot_recorder' do
     # Then
     expect(
         lineup.load_json_config(file)
-    ).to eq([['page1', 'page2'], [13,42], 'some/path', true, 'some/difference/image/path', 5, nil])
+    ).to eq([['page1', 'page2'], [13,42], 'some/path', true, 'some/difference/image/path', 5, []])
 
     # cleanup:
     FileUtils.rm file if (File.exists? file)
@@ -156,7 +156,21 @@ describe '#screeshot_recorder' do
                                       "domain":".google.de",
                                       "path":"/",
                                       "secure":false
-                                      }
+                                      },
+             "cookies" : [{
+                                      "name":"cookie2",
+                                      "value":"22222",
+                                      "domain":".google.de",
+                                      "path":"/",
+                                      "secure":false
+                          },
+                          {
+                                      "name":"cookie3",
+                                      "value":"33333",
+                                      "domain":".google.de",
+                                      "path":"/",
+                                      "secure":false
+                          }]
              }'
     save_json(json, file)
     lineup = Lineup::Screenshot.new(BASE_URL)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lineup
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Finn
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-02 00:00:00.000000000 Z
+date: 2016-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -180,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: lineup will help you in your automated design regression testing