webstract 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6243396588bd377a63b7bde8eda4753f74580d2e
-  data.tar.gz: 1a3a31eb9db5c4e83b197798d00a8c049ca6acb6
+  metadata.gz: 2acd9f72a410808ca0c13b251ea4a90c6a8f16fe
+  data.tar.gz: 9bf28dbbd5dd17df779ef11bb8172808a5ba0620
 SHA512:
-  metadata.gz: 4a1b8514db48474677b8a2c51e59a4ad2da3a61d4f482372d2cc467dedfc98fbb8ad34abaee5fdca140b45afcf9f32cceefb473932da24a25761571e462c2a7e
-  data.tar.gz: 463d81732822cb8dea73e1c8055d71bc9f9824d8dc335d78ed1ef8557a5f48e2149da8132e74acc373e787e5c3658e4f05231a4816364304ee33d4e96e3db166
+  metadata.gz: f477129c1811a7ffce4d1bf3e8d2a77555102d8eaef1a82d9d6ef0a277236cef491e3c87c43e91b38bea994c8d2232d142349993bcca3b6e995002520b1893e0
+  data.tar.gz: 6ea30f55206ac01ccbb9a30d43928bdc7adfe13960510f84b27f49a27c61ae48e777e193c2c4f61cf1dba009f8d41f983034f116f594190b0299ddcb2a0d795c

data/README.md

@@ -1,6 +1,5 @@
 # Webstract
 
-TODO: Write a gem description
 
 ## Installation
 
@@ -10,6 +9,34 @@ Add this line to your application's Gemfile:
 gem 'webstract'
 ```
 
+```bash
+#
+# MAC OSX
+#
+brew install phantomjs
+
+#
+# Linux (Ubuntu/Debian)
+#
+sudo apt-get install libfreetype6 libfreetype6-dev
+sudo apt-get install libfontconfig1
+
+# now download from phantomjs website
+export PHANTOM_JS="phantomjs-1.9.7-linux-x86_64"
+wget https://bitbucket.org/ariya/phantomjs/downloads/$PHANTOM_JS.tar.bz2
+
+# create your symlinks
+sudo mv $PHANTOM_JS.tar.bz2 /usr/local/share/
+cd /usr/local/share/
+sudo tar xvjf $PHANTOM_JS.tar.bz2
+sudo ln -sf /usr/local/share/$PHANTOM_JS/bin/phantomjs /usr/local/share/phantomjs
+sudo ln -sf /usr/local/share/$PHANTOM_JS/bin/phantomjs /usr/local/bin/phantomjs
+sudo ln -sf /usr/local/share/$PHANTOM_JS/bin/phantomjs /usr/bin/phantomjs
+
+# now try it
+phantomjs --version
+```
+
 And then execute:
 
     $ bundle
@@ -20,7 +47,47 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+
+#
+# SCREENSHOTS
+#
+
+# setup your session
+ws = Webstract.screenshot(
+  url: "https://www.example.com/admin",
+  path: "/tmp/sidekiq.png", # where to save it
+  width: 1024,
+  height: 768,
+  user_agent: :ios, # also (:web, :android)
+  accept_language: 'es', # capture the page in a specific language
+  basic_auth: {
+    username: 'example-user',
+    password: 'example-pass'
+  }
+)
+
+# now capture the page and save it to the filesystem
+ws.capture
+
+#
+# FAVICONS
+#
+
+fav = Webstract.favicon(url: 'https://www.google.com')
+fav.fetch_and_save("/tmp/google.ico")
+
+# or just return raw data
+fav.fetch
+```
+
+## Debugging
+
+Just set the WEBSTRACT_DEBUG environment variable
+
+```bash
+WEBSTRACT_DEBUG=1 ruby my_screenshot_script.rb
+```
 
 ## Contributing
 

data/lib/webstract/errors.rb

@@ -1,4 +1,13 @@
 module Webstract
-  class Error < StandardError
+  module Errors
+
+    class PathNotWritableError < StandardError; ;end
+
+    # raised whenever a webpage capture fails due to browser/connection client errors
+    class CaptureError < StandardError; ;end
+
+    # raised when the target page could not be reached
+    # but due to server errors like 404, or 500.
+    class PageError < StandardError; ;end
   end
 end

data/lib/webstract/favicon.rb

@@ -1,14 +1,5 @@
 require 'faviconduit'
 
-=begin
-
-usage:
-
-favicon = Webstract::Favicon.new(url: 'https://example.com')
-favicon.fetch
-
-=end
-
 module Webstract
   class Favicon
     attr_accessor :url, :favicon_data
@@ -22,5 +13,13 @@ module Webstract
       @favicon_data = Faviconduit.get(url).data
     end
 
+    def fetch_and_save(path)
+      data = fetch
+      File.open(path, 'w') do |f|
+        f.write(data)
+        f.close
+      end
+    end
+
   end
 end

data/lib/webstract/screen_capture.rb

@@ -4,14 +4,18 @@ module Webstract
   class ScreenCapture
     include Capybara::DSL
 
-    attr_reader :width, :height, :user_agent, :accept_language, :path
+    attr_reader :width, :height, :user_agent, :accept_language, :path, :basic_auth
 
     def initialize(opts = {})
       Webstract::ScreenshotBackend.capybara_setup!
       @width  = opts.fetch(:width, Webstract::ScreenshotBackend.width)
       @height = opts.fetch(:height, Webstract::ScreenshotBackend.height)
-      @user_agent = opts.fetch(:user_agent, Webstract::ScreenshotBackend.user_agent)
       @accept_language = opts.fetch(:accept_language, Webstract::ScreenshotBackend.accept_language)
+      @basic_auth      = opts.fetch(:basic_auth, Webstract::ScreenshotBackend.basic_auth)
+
+      ua = opts.fetch(:user_agent, Webstract::ScreenshotBackend.user_agent)
+      @user_agent = Webstract::ScreenshotBackend::USER_AGENTS[ua] if ua.is_a?(Symbol)
+
 
       # Browser settings
       page.driver.resize(@width, @height)
@@ -19,6 +23,7 @@ module Webstract
         "User-Agent" => @user_agent,
         'Accept-Language' => @accept_language
       }
+      page.driver.basic_authorize(basic_auth[:username], basic_auth[:password]) if basic_auth
     end
 
     def start_session(&block)
@@ -49,11 +54,11 @@ module Webstract
         if page.driver.status_code.to_i == 200 || page.driver.status_code.to_i / 100 == 3
           page.driver.save_screenshot(path, :full => true)
         else
-          raise Webstract::Error.new("Could not fetch page: #{url.inspect}, error code: #{page.driver.status_code}")
+          raise Webstract::Errors::PageError.new("Could not fetch page: #{url.inspect}, error code: #{page.driver.status_code}")
         end
       rescue Capybara::Poltergeist::BrowserError, Capybara::Poltergeist::DeadClient, Capybara::Poltergeist::TimeoutError, Errno::EPIPE => e
         # TODO: Handle Errno::EPIPE and Errno::ECONNRESET
-        raise Webstract::Error.new("Capybara error: #{e.message.inspect}")
+        raise Webstract::Errors::CaptureError.new("Capybara error: #{e.message.inspect}")
       end
     end
   end

data/lib/webstract/screenshot.rb

@@ -1,7 +1,7 @@
 module Webstract
   class Screenshot
-    attr_accessor :url, :path, :width, :height, :user_agent, :accept_language
-    attr_reader :handle
+    attr_accessor :url, :width, :height, :user_agent, :accept_language, :basic_auth
+    attr_reader :handle, :path
 
     def initialize(options = {})
       @handle = Webstract::ScreenCapture.new(options)
@@ -10,10 +10,34 @@ module Webstract
         setter = "#{k}="
         self.public_send(setter, value) if self.respond_to?(setter)
       end
+      path = options[:path] || raise(ArgumentError.new('path required'))
+      @basic_auth ||= {}
+
+      raise(ArgumentError.new("basic_auth credentials must be a Hash: got #{@basic_auth.inspect}")) unless @basic_auth.is_a?(Hash)
+    end
+
+    def path=(path)
+      dir = File.dirname(path)
+      raise(Webstract::Errors::PathNotWritableError.new('path must be writable.')) unless File.writable?(dir)
+      @path = path
+    end
+
+    def username=(username)
+      @basic_auth[:username] = username
+    end
+
+    def password=(password)
+      @basic_auth[:password] = password
     end
 
     def capture
-      handle.capture(url, path, width: width, height: height, user_agent: user_agent, accept_language: accept_language)
+      handle.capture(url, path,
+        width: width,
+        height: height,
+        user_agent: user_agent,
+        accept_language: accept_language,
+        basic_auth: basic_auth
+      )
     end
 
   end

data/lib/webstract/screenshot_backend.rb

@@ -24,15 +24,18 @@ module Webstract
     mattr_accessor :accept_language
     @@accept_language = 'en-us,en;q=0.5'
 
+    mattr_accessor :basic_auth
+    @@basic_auth = nil
+
 
     # User agent
     class << self
 
       def user_agent
-        @user_agent ||= USER_AGENT[:web]
+        @user_agent ||= USER_AGENTS[:web]
       end
       def user_agent=(ua)
-        agent_string = USER_AGENT[ua]
+        agent_string = USER_AGENTS[ua]
         raise(ArgumentError.new('must be one of #{USER_AGENTS.inspect}')) unless agent_string
         @user_agent = agent_string
       end
@@ -54,6 +57,7 @@ module Webstract
         Capybara::Poltergeist::Driver.new(app, {
           # Raise JavaScript errors to Ruby
           js_errors: false,
+          debug: ENV['WEBSTRACT_DEBUG'] || false,
           # Additional command line options for PhantomJS
           phantomjs_options: ['--ignore-ssl-errors=yes'],
         })

data/lib/webstract/version.rb

@@ -1,3 +1,3 @@
 module Webstract
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webstract
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - John Faucett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-11 00:00:00.000000000 Z
+date: 2014-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport