Class: Diffux::Snapshotter

Inherits:

Object

• Object
• Diffux::Snapshotter

Defined in:

lib/diffux_core/snapshotter.rb

Overview

Snapshotter is responsible for delegating to PhantomJS to take the snapshot for a given URL and viewoprt, and then saving that snapshot to a file and storing any metadata on the Snapshot object.

Constant Summary

SCRIPT_PATH =

File.join(File.dirname(__FILE__),
'script/take-snapshot.js').to_s

Instance Method Summary

• #initialize(url: raise, viewport_width: raise, outfile: raise, user_agent: nil, crop_selector: nil) ⇒ Snapshotter constructor

  A new instance of Snapshotter.

• #take_snapshot! ⇒ Hash

  Takes a snapshot of the URL and saves it in the outfile as a PNG image.

Constructor Details

#initialize(url: raise, viewport_width: raise, outfile: raise, user_agent: nil, crop_selector: nil) ⇒ Snapshotter

Returns a new instance of Snapshotter.

Parameters:

• url (String) (defaults to: raise) —

  the URL to snapshot

• viewport_width (Integer) (defaults to: raise) —

  the width of the screen used when snapshotting

• outfile (File) (defaults to: raise) —

  where to store the snapshot PNG.

• user_agent (String) (defaults to: nil) —

  an optional useragent string to used when requesting the page.

• crop_selector (String) (defaults to: nil) —

  an optional string containing a CSS selector. If this is present, and the page contains something matching it, the resulting snapshot image will only contain that element. If the page contains multiple elements mathing the selector, only the first element will be used.

# File 'lib/diffux_core/snapshotter.rb', line 25

def initialize(url:     raise, viewport_width: raise,
               outfile: raise, user_agent: nil,
               crop_selector: nil)
  @viewport_width = viewport_width
  @crop_selector  = crop_selector
  @user_agent     = user_agent
  @outfile        = outfile
  @url            = url
end

Instance Method Details

#take_snapshot! ⇒ Hash

Takes a snapshot of the URL and saves it in the outfile as a PNG image.

Returns:

• (Hash) —

  a hash containing the following keys: title [String] the