wraith 1.0.0 → 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 632e6875afc7f887a075632ef30887a31410ba79
+  data.tar.gz: 1936f1eec71795aac70ae0e14abbd1471b93f3ae
+SHA512:
+  metadata.gz: 3a475a73580b5589cec9232c7588f7ccce6692897c63476f9773d2b5bbca65b52a8fe66aa79877e85a2f56565114a5542f02f097ecbb5fff3b2f213e305d93be
+  data.tar.gz: 1cfa109de3917ed0e1d78e9ce29b152de30ff94659472f26262d746adf9f47cd11e2f094152986e16b60add2958a0545fba7cd4819fd7c83a7829e171a88a683

data/.gemset

@@ -0,0 +1 @@
+wraith

data/.gitignore

@@ -0,0 +1,5 @@
+.bundle/*
+shots/
+data.txt
+.DS_Store
+*.swp

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "2.0.0"
+
+script: "./bin/wraith"
+
+notifications:
+  email:
+    recipients:
+      - david.blooman@bbc.co.uk
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ..gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,203 @@
+# Wraith 
+
+[![Build Status](https://secure.travis-ci.org/BBC-News/wraith.png?branch=master)](http://travis-ci.org/BBC-News/wraith)
+[![Code Climate](https://codeclimate.com/github/BBC-News/wraith.png)](https://codeclimate.com/github/BBC-News/wraith)
+
+ * Website: http://responsivenews.co.uk
+ * Source: http://github.com/bbc-news/wraith
+
+Wraith is a screenshot comparison tool, created by developers at BBC News.
+
+
+## What is it?
+
+Wraith uses either [PhantomJS](http://phantomjs.org) or
+[SlimerJS](http://slimerjs.org) to create screen-shots of different environments
+and then creates a diff of the two images, the affected areas are highlighted in
+blue
+
+![Photo of BBC News with a
+diff](http://bbc-news.github.io/wraith/images/320_diff.png)
+
+
+## Requirements
+
+You'll need either PhantomJS or SlimerJS, ImageMagick & Ruby 1.9.3 or greater.
+It's up to you to decide which browser engine you want to run it against.
+
+### OSX
+On Mac OS X, the best way to install dependencies is if you have [homebrew](http://brew.sh).  It is the quickest way to install PhantomJS & ImageMagick.
+
+    brew install imagemagick
+    brew install phantomjs or brew install slimerjs
+    
+### Windows
+On Windows it's important to install ImageMagick from the binary found [here](http://www.imagemagick.org/script/binary-releases.php#windows). 
+This will ensure that ImageMagick is listed first in your PATH.
+
+To check your path after installing, open a command line window and type:
+
+    path
+
+This will return a list of executables in you PATH separated by semi-colons ;
+
+    C:\Program Files\ImageMagick-6.8.7-Q16;C:\Windows\system32;C:\Windows...
+
+If ImageMagick is in your path but not listed first you can edit your path by following the instructions [here](http://geekswithblogs.net/renso/archive/2009/10/21/how-to-set-the-windows-path-in-windows-7.aspx)
+
+If ImageMagick is not in your PATH at all but you have it installed you will need to add it in. Follow the instructions from the link above and add in the path to where you have ImageMagick installed. For example C:\Program Files\ImageMagick-6.8.7-Q16; 
+Make sure the version number and location are correct for your system.
+
+### Ubuntu
+On Ubuntu 12.04, you will need to apt-get the following packages:
+
+* libicu-dev
+* imagemagick
+* rake
+
+And then download the PhantomJS binary package from
+[http://phantomjs.org/](http://phantomjs.org/).
+
+## Installation
+
+Open terminal and run
+
+    git clone https://github.com/BBC-News/wraith
+
+You can then run the following inside the Wraith directory:
+    
+    bundle install
+
+If you don't have bundler installed, install it :
+
+    gem install bundler
+
+
+Alternatively you can download the install script via curl, this will not create a git repo though.    
+    
+    curl -fsSL https://raw.github.com/bbc-news/wraith/go/install | bash
+    cd wraith
+    bundle install    
+
+## Config
+
+All config options will be placed in config.yaml. You can specify the snap file name, this could be used in a situation where you have a large amount of config files.  You can set the headless browser, domains of the 2 sites you are comparing, URL paths, screen widths & HTTP headers.  If you don't want to set paths, you can use the spidering option to check your entire website  Remove/comment out the `path:` entries in `config.yaml`.
+
+```yaml
+
+# Headless browser option
+browser:
+  webkit: "phantomjs"
+  # gecko: "slimerjs"
+
+# If you want to have multiple snapping files, set the file name here
+snap_file: "snap.js"
+
+# Type the name of the directory that shots will be stored in
+directory:
+  - 'shots'
+
+# Add only 2 domains, key will act as a label
+domains:
+  english: "http://www.live.bbc.co.uk/news"
+  russian: "http://www.live.bbc.co.uk/russian"
+
+#Type screen widths below, here are a couple of examples
+screen_widths:
+  - 320
+  - 600
+  - 768
+  - 1024
+  - 1280
+
+#Type page URL paths below, here are a couple of examples
+paths:
+  home: /
+  uk_index: /uk
+
+# If you don't want to name the paths explicitly you can use a yaml
+# collection as follows, and names will be derived by replacing / with _
+#
+# paths:
+#  - /imghp
+#  - /maps
+
+#Amount of fuzz ImageMagick will use 
+fuzz: '20%' 
+
+#Set the number of days to keep the site spider file
+spider_days:
+  - 10
+
+```
+
+You can also specify PhantomJS command line options in config.yaml.
+
+For example to tell PhantomJS to ignore SSL errors:
+
+```yaml
+phantomjs_options: "--ignore-ssl-errors=true"
+```
+
+## Using Wraith
+
+If you are new to ruby, rake and PhantomJS, [here is a great screencast](http://www.youtube.com/watch?v=gE_19L0l2q0) about how to use Wraith by [Kevin Lamping](https://twitter.com/klamping)
+
+There are two ways of using Wraith, the fastest is to simply type rake.
+
+```sh
+rake
+```
+
+You may want to deal with multiple config files so you can compare different pages, different sites or different viewports.  In order to handle this, you can pass in a different config file by typing the following into terminal.  The default is config.yaml, so even if you don't pass a file in, it will still run.  If you have deleted config.yaml, make sure you are inside the `configs` directory before running the command.
+
+```sh
+rake config[config_name]
+```
+
+On Windows before running the rake command you will need to make a small edit to the wraith.rb file.
+Locate lines 60 and 70 and switch the commenting as described.
+
+
+## Output
+
+After each screenshot is captured, the compare task will run, this will output a diff.png and a data.txt.  The data.txt for each file will show the number of pixels that have changed.  There is a main data.txt which is in the root of the output folder that will combine all of these values to easier view all the pixel changes.
+
+## Gallery
+
+A gallery is available to view each of the images and the respective diff images located in the shots folder once all the images have been compared.
+
+## Grabber
+
+If you just want to see a single domains images and not compare them, perhaps for archiving, remove a domain and run the new rake task.   For default config, use grab, or specify a config using grabber. 
+
+`rake grab` and `rake grabber[config]`
+
+## Contributing
+
+If you want to add functionality to this project, pull requests are welcome.
+
+ * Create a branch based off master and do all of your changes with in it.
+ * If you have to pause to add a 'and' anywhere in the title, it should be two pull requests.
+ * Make commits of logical units and describe them properly
+ * Check for unnecessary whitespace with git diff --check before committing.
+ * If possible, submit tests to your patch / new feature so it can be tested easily.
+ * Assure nothing is broken by running all the test
+ * Please ensure that it complies with coding standards.
+
+**Please raise any issues with this project as a GitHub issue.**
+
+## Changelog - updated 24/01/14
+New features include some refactoring and the start of additional cli work.  We have removed the webdriver features for the time being, this will return in a more capable and fully feature state.
+
+## License
+
+Wraith is available to everyone under the terms of the Apache 2.0 open source license. 
+Take a look at the LICENSE file in the code.
+
+## Credits
+
+ * [Dave Blooman](http://twitter.com/dblooman)
+ * [John Cleveley](http://twitter.com/jcleveley)
+ * [Simon Thulbourn](http://twitter.com/sthulbourn)
+

data/Rakefile

@@ -0,0 +1,68 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+
+require 'bundler/gem_tasks'
+require 'wraith/save_images'
+require 'wraith/crop'
+require 'wraith/spider'
+require 'wraith/folder'
+require 'wraith/thumbnails'
+require 'wraith/compare_images'
+require 'wraith/images'
+
+@config = ('config')
+
+task :grabber, [:yaml] do |t, custom|
+  custom.with_defaults(:yaml => "config")
+  @config = "#{custom[:yaml]}"
+  Rake::Task["grab"].invoke
+end
+
+task :default => [:reset_shots_folder, :check_for_paths, :setup_folders, :save_images, :generate_thumbnails, :generate_gallery] do
+  puts 'Done!';
+end
+
+task :reset_shots_folder do
+  reset = Wraith::FolderManager.new(@config)
+  reset.clear_shots_folder
+end
+
+task :setup_folders do
+  create = Wraith::FolderManager.new(@config)
+  create.create_folders
+end
+
+task :compare_images do
+  compare = Wraith::CompareImages.new(@config)
+  compare.compare_images
+end
+
+task :check_for_paths do
+  spider = Wraith::Spidering.new(@config)
+  spider.check_for_paths
+end
+
+task :save_images do
+  @save_images = Wraith::SaveImages.new(@config)
+  @save_images.save_images
+end
+
+task :crop_images do
+  crop = Wraith::CropImages.new(@save_images.directory)
+  crop.crop_images
+end
+
+task :check_images do
+  image = Wraith::Images.new(@save_images.directory)
+  image.files
+end
+
+task :generate_thumbnails do
+  thumbs = Wraith::Thumbnails.new(@config)
+  thumbs.generate_thumbnails
+end
+
+task :generate_gallery do
+  sh "ruby lib/wraith/gallery.rb #{@save_images.directory}"
+end
+
+