pagelapse 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f8d6638ceb44da7aa0d6baaaf1c69e17da1cdfd
-  data.tar.gz: a0eec7989c94fb441e0605de10d224010703fe1a
+  metadata.gz: 8d7844184aa0b984de300e0a956b56549aa7bfbc
+  data.tar.gz: 7cb3a962d4786561df52daf3620019a544f98174
 SHA512:
-  metadata.gz: d1f965cab3bad214de6f0866b2a49a3833d99f763e48ca315e50cb3fcca6c68d2fcf7bc6a1d2ff6330de8e47c9ea9669f8be9347449bcd5d78b758eea9e7adfc
-  data.tar.gz: c14caa22ad972f86ec36b314fe1e2d4c22e5ce435e9b7a11c9be6cf57536992685ea2a7c1f4b15749e49e191426deec76a0de4451276da4db5aa360e12ee4d0f
+  metadata.gz: cae93edf1b2a0b693c0f70eac4601068ec6b919e220bb4f0d913467001b384686dc99f810e67e35ca774bb1eb7fed97d7f337be9554f85a5f01166f83fa34ec3
+  data.tar.gz: 14e3f0cca9f3c4490ea0ca9df9262b960c3036158e12db040ac6e09d5a9a334b889cfec5e4e2e98d604754ee91833be65a165150c4c8c3f1f1080c4f296e9778

data/README.md

@@ -14,26 +14,61 @@ And then install pagelapse:
 
 ## Usage
 
-Add a page to start capturing:
-
-    $ pagelapse record http://reddit.com
-
-Pagelapse will check the website every 20 seconds for changes. There are some settings, too:
-
-    $ pagelapse record http://reddit.com --interval 60 --width 1200 --height 1000 --full-page false
+To create a new pagelapse, add a `Lapsefile` to the current directory. If your timelapse is associated with a project, you may want to add this to the root directory of your project.
+
+In the `Lapsefile`, you can specify (using Ruby) which pages you'd like to record. For instance, to record a screenshot of my blog, `lord.io`, every 10 seconds with a browser window 1000 pixels by 800 pixels:
+
+```ruby
+record "lord", "http://www.lord.io/blog" do |r|
+  r.width = 1000
+  r.height = 800
+  r.interval = 10
+end
+```
+
+You can also run Capybara commands before the screenshot is taken:
+
+```ruby
+record "github", "http://github.com/login" do |r|
+  r.interval = 10
+  r.before_capture do
+    page.fill_in('login', :with => 'lord')
+    page.fill_in('password', :with => 'my password here')
+    page.click_button('Sign in')
+  end
+end
+```
+
+There are a couple other settings. The default behavior is capture pages only if they return a HTTP 200. You can change this by setting a `capture_if`, for instance if you only want to record if the page contains certain elements, or based on the status code:
+
+```ruby
+record "lord", "http://www.lord.io/blog" do |r|
+  r.capture_if do
+    page.driver.status_code == 404
+  end
+end
+```
+
+For instance, the above code will only capture the page *if* a 404 error code was generated.
+
+By default, new screenshots will be deleted if they are exactly the same as the previous screenshot. You can override this with `save_if`:
+
+```ruby
+record "lord", "http://www.lord.io/blog" do |r|
+  r.save_if do |old_file, new_file|
+    # Add checking code here
+    true
+  end
+end
+```
+
+For example, the code above will always save new screenshots. You could potentially use the `old_file` and `new_file` parameters passed (as file names) to the `save_if` block with Imagemagick or some other image program to determine if the images are different enough to save. The default method is to check the cryptographic hashes of the two files are the same.
 
 To view the websites you've recorded in a nice web interface:
 
     $ pagelapse view
 
-To stop recording a page:
-
-    $ pagelapse stop http://reddit.com
-
-To pause and resume the background server:
-
-    $ pagelapse pause
-    $ pagelapse resume
+Drag your cursor from left to right to play the timelapse.
 
 ## Contributing
 

data/lib/pagelapse/recorder.rb

@@ -49,18 +49,16 @@ module Pagelapse
     def capture
       @timer = Time.now
       ws = Pagelapse::Screenshot.new
-      if @on_load
-        ws.start_session(&@on_load)
-      else
-        ws.start_session
-      end.capture(
+
+      ws.capture(
         @url,
         filename,
         width: @width,
         height: @height,
         timeout: @timeout,
         capture_if: @capture_if,
-        save_if: @save_if
+        save_if: @save_if,
+        on_load: @on_load
       )
     end
   end

data/lib/pagelapse/screenshot.rb

@@ -8,19 +8,23 @@ module Pagelapse
     include Capybara::DSL
 
     # Captures a screenshot of +url+ saving it to +output_path+.
-    def capture(url, output_path, width: 1024, height: 768, full: false, timeout: false, capture_if: nil, save_if: nil)
+    def capture(url, output_path, width: 1024, height: 768, full: false, timeout: false, capture_if: nil, save_if: nil, on_load: nil)
+
+      # Reset session
+      Capybara.reset_sessions!
+
       # Browser settings
       page.driver.resize(width, height)
       page.driver.headers = {
         "User-Agent" => "Pagelapse #{Pagelapse::VERSION}",
       }
 
+      # Set default capture_if and save_if
       unless capture_if
         capture_if = Proc.new do
           page.driver.status_code == 200
         end
       end
-
       unless save_if
         save_if = Proc.new do |old_file, new_file|
           Digest::MD5.file(old_file).hexdigest != Digest::MD5.file(new_file).hexdigest
@@ -30,6 +34,9 @@ module Pagelapse
       # Open page
       visit url
 
+      # Run on_load
+      instance_eval(&on_load) if on_load
+
       # Timeout
       sleep timeout if timeout
 
@@ -54,8 +61,6 @@ module Pagelapse
     end
 
     def start_session(&block)
-      Capybara.reset_sessions!
-      Capybara.current_session.instance_eval(&block) if block_given?
       self
     end
 

data/lib/pagelapse/version.rb

@@ -1,3 +1,3 @@
 module Pagelapse
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pagelapse
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Robert Lord
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-06 00:00:00.000000000 Z
+date: 2014-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler