wraith 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 632e6875afc7f887a075632ef30887a31410ba79
-  data.tar.gz: 1936f1eec71795aac70ae0e14abbd1471b93f3ae
+  metadata.gz: 4b91a9e01056e5ee44ce5a8726152a023023285f
+  data.tar.gz: 3043cc0f99e7dedee6c0878f09e41ff71f042923
 SHA512:
-  metadata.gz: 3a475a73580b5589cec9232c7588f7ccce6692897c63476f9773d2b5bbca65b52a8fe66aa79877e85a2f56565114a5542f02f097ecbb5fff3b2f213e305d93be
-  data.tar.gz: 1cfa109de3917ed0e1d78e9ce29b152de30ff94659472f26262d746adf9f47cd11e2f094152986e16b60add2958a0545fba7cd4819fd7c83a7829e171a88a683
+  metadata.gz: e0ea6720ac947da1b0ad1fda376fa288ae3ea58953c8b5cb239b22e08e410df49fd6f89ca8cd3bcd546148c413a29a16de4b7f65dd1a2eb7b10ecf3739a3830a
+  data.tar.gz: ccec5c11e607f1c3faf657edff070cfff0ba61b6641b135e7f97078290d452a34f0f808ec936ecdc525e08a65d2156cc1b0540aa527f29e6057e445b81076cb0

data/.travis.yml

@@ -3,7 +3,7 @@ rvm:
   - "1.9.2"
   - "2.0.0"
 
-script: "./bin/wraith"
+script: "./bin/wraith capture config"
 
 notifications:
   email:

data/README.md

@@ -62,20 +62,16 @@ And then download the PhantomJS binary package from
 
 Open terminal and run
 
-    git clone https://github.com/BBC-News/wraith
+    gem install wraith
 
-You can then run the following inside the Wraith directory:
+You can then run the following inside the Wraith directory to create a template snap.js and config file:
     
-    bundle install
-
-If you don't have bundler installed, install it :
-
-    gem install bundler
+    gem setup
 
 
 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
+    git clone https://github.com/BBC-News/wraith
     cd wraith
     bundle install    
 

data/lib/wraith/cli.rb

@@ -7,18 +7,31 @@ require 'wraith/folder'
 require 'wraith/thumbnails'
 require 'wraith/compare_images'
 require 'wraith/images'
+require 'wraith/gallery'
 
 class Wraith::CLI < Thor
+  include Thor::Actions
 
   attr_accessor :config_name
 
+  def self.source_root
+    File.expand_path('../../../templates/',__FILE__)
+  end
+
+  desc "setup", "creates config folder and default config"
+  def setup
+    template('configs/config.yaml', 'configs/config.yaml')
+    template('javascript/snap.js', 'javascript/snap.js')
+    template('assets/invalid.jpg', 'assets/invalid.jpg')
+  end
+
   desc "reset_shots", "removes all the files in the shots folder"
   def reset_shots(config_name)
     reset = Wraith::FolderManager.new(config_name)
     reset.clear_shots_folder
   end
 
-  desc "setup_folders", "create folders for images"
+  desc "folders", "create folders for images"
   def setup_folders(config_name)
     create = Wraith::FolderManager.new(config_name)
     create.create_folders
@@ -62,9 +75,9 @@ class Wraith::CLI < Thor
 
   desc "generate_gallery", "create page for viewing images"
   def generate_gallery(config_name)
-    dir = Wraith::Wraith.new(config_name)
-    puts 'Generating gallery'
-    `ruby lib/wraith/gallery.rb "#{dir.directory}"`
+    gallery = Wraith::GalleryGenerator.new(config_name)
+    gallery.generate_gallery
+    puts "Gallery generated"
   end
 
   desc "capture config_name", "A full Wraith job"

data/lib/wraith/gallery.rb

@@ -1,86 +1,100 @@
-#!/usr/bin/env ruby
-
-# Given all the screenshots in the shots/ directory, produces a nice looking
-# gallery
-
 require 'erb'
 require 'pp'
 require 'fileutils'
+require 'wraith/wraith'
+
+class Wraith::GalleryGenerator
+   attr_reader :wraith
 
-MATCH_FILENAME = /(\S+)_(\S+)\.\S+/
-TEMPLATE_LOCATION = "lib/wraith/gallery_template/gallery_template.erb"
-TEMPLATE_BY_DOMAIN_LOCATION = "lib/wraith/gallery_template/gallery_template.erb"
-BOOTSTRAP_LOCATION = "lib/wraith/gallery_template/bootstrap.min.css"
+  MATCH_FILENAME = /(\S+)_(\S+)\.\S+/
 
-def parse_directories(dirname)
+  TEMPLATE_LOCATION = File.expand_path('gallery_template/gallery_template.erb', File.dirname(__FILE__))
+  TEMPLATE_BY_DOMAIN_LOCATION = File.expand_path('gallery_template/gallery_template.erb', File.dirname(__FILE__))
+  BOOTSTRAP_LOCATION = File.expand_path('gallery_template/bootstrap.min.css', File.dirname(__FILE__))
+
+  def initialize(config)
+    @wraith = Wraith::Wraith.new(config)
+    @location = wraith.directory
+  end
+
+  def parse_directories(dirname)
     dirs = {}
     categories = Dir.foreach(dirname).select do |category|
-        if ['.', '..', 'thumbnails'].include? category
-            # Ignore special dirs
-            false
-        elsif File.directory? "#{dirname}/#{category}" then
-            # Ignore stray files
-            true
-        else
-            false
-        end
+      if ['.', '..', 'thumbnails'].include? category
+        # Ignore special dirs
+        false
+      elsif File.directory? "#{dirname}/#{category}" then
+        # Ignore stray files
+        true
+      else
+        false
+      end
     end
 
     categories.each do |category|
-        dirs[category] = {}
-        Dir.foreach("#{dirname}/#{category}") do |filename|
-            match = MATCH_FILENAME.match(filename)
-            if not match.nil? then
-                size = match[1].to_i
-                group = match[2]
-                filepath = category + "/" + filename
-                thumbnail = "thumbnails/#{category}/#{filename}"
-
-                if dirs[category][size].nil? then
-                    dirs[category][size] = {:variants => []}
-                end
-                size_dict = dirs[category][size]
-
-                case group
-                when 'diff'
-                    size_dict[:diff] = {
-                        :filename => filepath, :thumb => thumbnail
-                    }
-                when 'data'
-                    size_dict[:data] = File.read("#{dirname}/#{filepath}")
-                else
-                    size_dict[:variants] << {
-                        :name => group,
-                        :filename => filepath,
-                        :thumb => thumbnail
-                    }
-
-                end
-                size_dict[:variants].sort! {|a, b| a[:name] <=> b[:name] }
-            end
+      dirs[category] = {}
+      Dir.foreach("#{dirname}/#{category}") do |filename|
+        match = MATCH_FILENAME.match(filename)
+        if not match.nil? then
+          size = match[1].to_i
+          group = match[2]
+          filepath = category + "/" + filename
+          thumbnail = "thumbnails/#{category}/#{filename}"
+
+          if dirs[category][size].nil? then
+            dirs[category][size] = {:variants => []}
+          end
+          size_dict = dirs[category][size]
+
+          case group
+            when 'diff'
+              size_dict[:diff] = {
+                  :filename => filepath, :thumb => thumbnail
+              }
+            when 'data'
+              size_dict[:data] = File.read("#{dirname}/#{filepath}")
+            else
+              size_dict[:variants] << {
+                  :name => group,
+                  :filename => filepath,
+                  :thumb => thumbnail
+              }
+
+          end
+          size_dict[:variants].sort! { |a, b| a[:name] <=> b[:name] }
         end
+      end
     end
 
     return dirs
-end
+  end
 
-def generate_html(domain, directories, template, destination)
+  def generate_html(location, directories, template, destination, path)
     template = File.read(template)
-    html = ERB.new(template).result
+    locals = {
+        :location => location,
+        :directories => directories,
+        :path => path
+    }
+    html = ERB.new(template).result(ErbBinding.new(locals).get_binding)
     File.open(destination, 'w') do |outf|
-        outf.write(html)
+      outf.write(html)
     end
-end
+  end
 
-if ARGV.length < 1 then
-    puts "USAGE: create_gallery.rb <directory>"
-    exit 1
-end
 
-location = ARGV[0]
-domain = location
-directories = parse_directories(location)
-dest = "#{location}/gallery.html"
+  def generate_gallery(withPath="")
+    dest = "#{@location}/gallery.html"
+    directories = parse_directories(@location);
+    generate_html(@location, directories, TEMPLATE_BY_DOMAIN_LOCATION, dest, withPath)
+    FileUtils.cp(BOOTSTRAP_LOCATION, "#{@location}/bootstrap.min.css")
+
+  end
+
+  class ErbBinding < OpenStruct
+    def get_binding
+      return binding()
+    end
+  end
 
-generate_html(domain, directories, TEMPLATE_BY_DOMAIN_LOCATION, dest)
-FileUtils.cp(BOOTSTRAP_LOCATION, "#{location}/bootstrap.min.css")
+end

data/lib/wraith/gallery_template/gallery_template.erb

@@ -12,7 +12,7 @@
     <body>
         <div class="container">
             <div class="row page-header">
-                <h1>List of screenshots for <%= domain %> </h1>
+                <h1>List of screenshots for <%= location %> </h1>
             </div>
             <div class="row">
                 <!-- <%= directories.length %> -->
@@ -21,7 +21,7 @@
                         <div class="panel-heading">Screenshots:</div>
                         <ul class="list-group list-group-flush">
                             <% directories.keys.sort.each do |dir| %>
-                                <li class="list-group-item"><a href="#<%=dir%>"><%=dir%></a></li>
+                                <li class="list-group-item"><a href="#<%=path%><%=dir%>"><%=dir%></a></li>
                             <% end %>
                         </ul>
                     </div>
@@ -37,16 +37,16 @@
                                 <h3 class="col-lg-1 text-muted"><%=size%>px</h3>
                                 <% files[:variants].each do |file| %>
                                     <div class="col-lg-3">
-                                        <a href="<%=file[:filename]%>">
-                                            <img class="short-screenshot img-thumbnail" src="<%=file[:thumb]%>">
+                                        <a href="<%=path%>/<%=file[:filename]%>">
+                                            <img class="short-screenshot img-thumbnail" src="<%=path%><%=file[:thumb]%>">
                                         </a>
                                         <p class="text-center"><%=file[:name]%></p>
                                     </div>
                                 <% end %>
                                 <div class="col-lg-3">
                                     <% if files[:diff] %>
-                                        <a href="<%=files[:diff][:filename]%>">
-                                            <img class="short-screenshot img-thumbnail" src="<%=files[:diff][:thumb]%>">
+                                        <a href="<%=path%>/<%=files[:diff][:filename]%>">
+                                            <img class="short-screenshot img-thumbnail" src="<%=path%><%=files[:diff][:thumb]%>">
                                         </a>
                                     <% end %>
                                     <p class="text-center">diff</p>

data/lib/wraith/images.rb

@@ -11,7 +11,7 @@ class Wraith::Images
     files = Dir.glob("#{wraith.directory}/*/*.png").sort
     files.each do |filename|
       if File.stat("#{filename}").size == 0
-        FileUtils.cp 'lib/wraith/assets/invalid.jpg', "#{filename}"
+        FileUtils.cp 'assets/invalid.jpg', "#{filename}"
         puts "#{filename} is invalid"
       end
     end

data/lib/wraith/version.rb

@@ -1,3 +1,3 @@
 module Wraith
-  VERSION = '1.1.1'
+  VERSION = '1.1.2'
 end

data/templates/configs/config.yaml

@@ -0,0 +1,43 @@
+#Headless browser option
+browser:
+  webkit: "phantomjs"
+  # gecko: "slimerjs"
+
+#If you want to have multiple snapping files, set the file name here
+snap_file: "javascript/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

data/templates/javascript/snap.js

@@ -0,0 +1,85 @@
+var system = require('system');
+var page = require('webpage').create();
+var fs = require('fs');
+
+if (system.args.length === 3) {
+    console.log('Usage: snap.js <some URL> <view port width> <target image name>');
+    phantom.exit();
+}
+
+var url = system.args[1];
+var image_name = system.args[3];
+var view_port_width = system.args[2];
+var current_requests = 0;
+var last_request_timeout;
+var final_timeout;
+
+
+page.viewportSize = { width: view_port_width, height: 1500};
+page.settings = { loadImages: true, javascriptEnabled: true };
+
+// If you want to use additional phantomjs commands, place them here
+page.settings.userAgent = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_2) AppleWebKit/537.17 (KHTML, like Gecko) Chrome/28.0.1500.95 Safari/537.17';
+
+// You can place custom headers here, example below.
+// page.customHeaders = {
+
+//      'X-Candy-OVERRIDE': 'https://api.live.bbc.co.uk/'
+ 
+//  };
+
+// If you want to set a cookie, just add your details below in the following way.
+
+// phantom.addCookie({
+//     'name': 'ckns_policy',
+//     'value': '111',
+//     'domain': '.bbc.co.uk'
+// });
+// phantom.addCookie({
+//     'name': 'locserv',
+//     'value': '1#l1#i=6691484:n=Oxford+Circus:h=e@w1#i=8:p=London@d1#1=l:2=e:3=e:4=2@n1#r=40',
+//     'domain': '.bbc.co.uk'
+// });
+
+page.onResourceRequested = function(req) {
+  current_requests += 1;
+};
+
+page.onResourceReceived = function(res) {
+  if (res.stage === 'end') {
+    current_requests -= 1;
+    debounced_render();
+  }
+};
+
+page.open(url, function(status) {
+  if (status !== 'success') {
+    console.log('Error with page ' + url);
+    phantom.exit();
+  }
+});
+
+
+function debounced_render() {
+  clearTimeout(last_request_timeout);
+  clearTimeout(final_timeout);
+
+  // If there's no more ongoing resource requests, wait for 1 second before
+  // rendering, just in case the page kicks off another request
+  if (current_requests < 1) {
+      clearTimeout(final_timeout);
+      last_request_timeout = setTimeout(function() {
+          console.log('Snapping ' + url + ' at width ' + view_port_width);
+          page.render(image_name);
+          phantom.exit();
+      }, 1000);
+  }
+
+  // Sometimes, straggling requests never make it back, in which
+  // case, timeout after 5 seconds and render the page anyway
+  final_timeout = setTimeout(function() {
+    console.log('Snapping ' + url + ' at width ' + view_port_width);
+    page.render(image_name);
+    phantom.exit();
+  }, 5000);
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wraith
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Dave Blooman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-06 00:00:00.000000000 Z
+date: 2014-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -169,12 +169,12 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- assets/invalid.jpg
 - bin/wraith
 - configs/config.yaml
 - configs/config_nojs.yaml
 - configs/test_config.yaml
 - lib/wraith.rb
-- lib/wraith/assets/invalid.jpg
 - lib/wraith/cli.rb
 - lib/wraith/compare_images.rb
 - lib/wraith/crop.rb
@@ -192,6 +192,9 @@ files:
 - lib/wraith/version.rb
 - lib/wraith/wraith.rb
 - spec/wraith_spec.rb
+- templates/assets/invalid.jpg
+- templates/configs/config.yaml
+- templates/javascript/snap.js
 - wraith.gemspec
 homepage: http://responsivenews.co.uk
 licenses: