percy-capybara 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c6f285faa3d3fa23666d4cc56279775e235e13e
-  data.tar.gz: 5cf5533530d1083769131b3ace61b20f89083d07
+  metadata.gz: 19a9bfb3b76169ea2b1ba301f69e6466d2da4cef
+  data.tar.gz: 1f1963b73fa8ce3df14d48c34003cc631b5aa4a0
 SHA512:
-  metadata.gz: 146c18609ebc74f87bbcd1a678da4924f738560c3e0d91c74e04d4243f1ee6fcc6585b67f728634ac88d00574099a7cb2f63b19ca1b6092aaff6bef43dc92417
-  data.tar.gz: e589de3b4add655ff9c9d8c3b0d224fbf6f3adf4d4a06c79f5ef6cee63f323029b93547fe979edc60c63168fd7c8b53ddef98380ee34eb5abf1757cc16536006
+  metadata.gz: cccbace3dee7650f246cd96736e620719428ba22eaa88cec41f7aafa3564901d6af0271e77247a3a2b4f8f2758efb2e570bf33b9ea6f409138bb048af8e967b9
+  data.tar.gz: 99c6891ee227853322830ebff8648df6dbf7bc5fc11488151ed43c9e6a9065948c16faee2e82c8e9ad47d7f87863801d5a594c547e12ac120fba96cd5b4d4924

data/.gitignore

@@ -1,35 +1,16 @@
-*.gem
-*.rbc
-/.config
+/.bundle/
+/Gemfile.lock
+/.yardoc
+/_yardoc/
 /coverage/
-/InstalledFiles
+/doc/
 /pkg/
 /spec/reports/
-/test/tmp/
-/test/version_tmp/
 /tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.rbc
+mkmf.log
 .DS_Store
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalisation:
-/.bundle/
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--require spec_helper
+--format d
+

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.1
+  - 2.2.2
+  - ruby-head
+script: bundle exec rspec

data/.yardopts

@@ -0,0 +1,2 @@
+--protected
+--no-private

data/Gemfile

@@ -1,4 +1,9 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in perceptual.gemspec
+# Specify your gem's dependencies in percy-capybara.gemspec
 gemspec
+
+gem 'guard-rspec', require: false
+
+# (for development)
+# gem 'percy-client', path: '~/src/percy-client'

data/Guardfile

@@ -0,0 +1,14 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+Copyright (c) 2015 Perceptual Inc.
 
-Copyright (c) 2015 Mike Fotinakis
+The MIT License (MIT)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,2 +1,34 @@
-# perceptual-ruby
-Ruby client library for Perceptual CI
+# Percy::Capybara
+
+[![Build Status](https://travis-ci.org/percy/percy-capybara.svg?branch=master)](https://travis-ci.org/percy/percy-capybara)
+[![Gem Version](https://badge.fury.io/rb/percy-capybara.svg)](http://badge.fury.io/rb/percy-capybara)
+
+(in development, coming soon)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'percy-capybara'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install percy-capybara
+
+## Usage
+
+...
+
+## Contributing
+
+1. Fork it ( https://github.com/percy/percy-capybara/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -1,2 +1,2 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 

data/lib/percy/capybara.rb

@@ -0,0 +1,47 @@
+require 'percy'
+require 'percy/capybara/version'
+require 'percy/capybara/client'
+
+module Percy
+  module Capybara
+    # @see Percy::Capybara::Client
+    def self.capybara_client
+      @capybara_client ||= Percy::Capybara::Client.new
+    end
+
+    # {include:Percy::Capybara::Client::Snapshots#snapshot}
+    # @param (see Percy::Capybara::Client::Snapshots#snapshot)
+    # @option (see Percy::Capybara::Client::Snapshots#snapshot)
+    # @see Percy::Capybara::Client::Snapshots#snapshot
+    def self.snapshot(page, options = {})
+      capybara_client.snapshot(page, options)
+    end
+
+    # Creates a new build.
+    #
+    # This usually does not need to be called explictly because the build is automatically created
+    # the first time a snapshot is created. However, this method might be useful in situations like
+    # multi-process tests where a single build must be created before forking.
+    #
+    # @see Percy::Capybara::Client::Builds#initialize_build
+    def self.initialize_build
+      capybara_client.initialize_build
+    end
+
+    # Finalize the current build.
+    #
+    # This must be called to indicate that the build is complete after all snapshots have been
+    # taken. It will silently return if no build or snapshots were created.
+    #
+    # @see Percy::Capybara::Client::Builds#finalize_current_build
+    def self.finalize_build
+      return if !capybara_client.build_initialized?
+      capybara_client.finalize_current_build
+    end
+
+    # Reset the global Percy::Capybara module state.
+    def self.reset
+      @capybara_client = nil
+    end
+  end
+end

data/lib/percy/capybara/client.rb

@@ -0,0 +1,20 @@
+require 'percy/capybara/client/builds'
+require 'percy/capybara/client/snapshots'
+
+module Percy
+  module Capybara
+    class Client
+      include Percy::Capybara::Client::Builds
+      include Percy::Capybara::Client::Snapshots
+
+      class Error < Exception; end
+      class BuildNotInitializedError < Error; end
+
+      attr_reader :client
+
+      def initialize(options = {})
+        @client = options[:client] || Percy.client
+      end
+    end
+  end
+end

data/lib/percy/capybara/client/builds.rb

@@ -0,0 +1,24 @@
+module Percy
+  module Capybara
+    class Client
+      module Builds
+        def current_build
+          @current_build ||= client.create_build(client.config.repo)
+        end
+        alias_method :initialize_build, :current_build
+
+        def build_initialized?
+          !!@current_build
+        end
+
+        def finalize_current_build
+          if !build_initialized?
+            raise Percy::Capybara::Client::BuildNotInitializedError.new(
+              'Failed to finalize build because no build has been initialized.')
+          end
+          client.finalize_build(current_build['data']['id'])
+        end
+      end
+    end
+  end
+end

data/lib/percy/capybara/client/snapshots.rb

@@ -0,0 +1,147 @@
+require 'faraday'
+require 'httpclient'
+require 'digest'
+
+module Percy
+  module Capybara
+    class Client
+      module Snapshots
+        # @private
+        FETCH_SENTINEL_VALUE = '[[FETCH]]'
+
+        # Takes a snapshot of the given page HTML and its assets.
+        #
+        # @param [Capybara::Session] page The Capybara page to snapshot.
+        # @param [Hash] options
+        # @option options [String] :name A unique name for the current page that identifies it across
+        #   builds. By default this is the URL of the page, but can be customized if the URL does not
+        #   entirely identify the current state.
+        def snapshot(page, options = {})
+          name = options[:name]
+          current_build_id = current_build['data']['id']
+          resource_map = _find_resources(page)
+          snapshot = client.create_snapshot(current_build_id, resource_map.values, name: name)
+
+          # Upload the content for any missing resources.
+          snapshot['data']['links']['missing-resources']['linkage'].each do |missing_resource|
+            sha = missing_resource['id']
+            client.upload_resource(current_build_id, resource_map[sha].content)
+          end
+        end
+
+        # @private
+        def _find_resources(page)
+          resource_map = {}
+          resources = []
+          resources << _get_root_html_resource(page)
+          resources += _get_css_resources(page)
+          resources.each { |resource| resource_map[resource.sha] = resource }
+          resource_map
+        end
+        private :_find_resources
+
+        # @private
+        def _get_root_html_resource(page)
+          # Primary HTML.
+          script = <<-JS
+            var htmlElement = document.getElementsByTagName('html')[0];
+            return htmlElement.outerHTML;
+          JS
+          html = _evaluate_script(page, script)
+          sha = Digest::SHA256.hexdigest(html)
+          resource_url = page.current_url
+          Percy::Client::Resource.new(
+            sha, resource_url, is_root: true, mimetype: 'text/html', content: html)
+        end
+        private :_get_root_html_resource
+
+        # @private
+        def _get_css_resources(page)
+          resources = []
+          # Find all CSS resources.
+          # http://www.quirksmode.org/dom/w3c_css.html#access
+          script = <<-JS
+            function findStylesRecursively(stylesheet, result_data) {
+              result_data = result_data || {};
+              if (stylesheet.href) {
+                result_data[stylesheet.href] = result_data[stylesheet.href] || '';
+
+                // Remote stylesheet rules cannot be accessed because of the same-origin policy.
+                // Unfortunately, if you touch .cssRules in Selenium, it throws a JavascriptError
+                // with 'The operation is insecure'. To work around this, skip any remote stylesheets
+                // and mark them with a sentinel value so we can fetch them later.
+                var parser = document.createElement('a');
+                parser.href = stylesheet.href;
+                if (parser.host != window.location.host) {
+                  result_data[stylesheet.href] = '#{FETCH_SENTINEL_VALUE}'; // Must be a string.
+                  return;
+                }
+              }
+
+              for (var i = 0; i < stylesheet.cssRules.length; i++) {
+                var rule = stylesheet.cssRules[i];
+                // Skip stylesheet without hrefs (inline stylesheets).
+                // These will be present in the HTML snapshot.
+                if (stylesheet.href) {
+                  // Append current rule text.
+                  result_data[stylesheet.href] += rule.cssText + '\\n';
+                }
+
+                // Handle recursive @imports.
+                if (rule.styleSheet) {
+                  findStylesRecursively(rule.styleSheet, result_data);
+                }
+              }
+            }
+
+            var percy_resources = {};
+            for (var i = 0; i < document.styleSheets.length; i++) {
+              findStylesRecursively(document.styleSheets[i], percy_resources);
+            }
+            return percy_resources;
+          JS
+
+          # Returned datastructure: {"<absolute URL>" => "<CSS text>", ...}
+          resource_data = _evaluate_script(page, script)
+
+          resource_data.each do |resource_url, css|
+            if css == FETCH_SENTINEL_VALUE
+              # Handle sentinel value that indicates a remote CSS resource that must be fetched.
+              response = _fetch_resource_url(resource_url)
+              next if !response
+              css = response.body
+            end
+
+            sha = Digest::SHA256.hexdigest(css)
+            resources << Percy::Client::Resource.new(
+              sha, resource_url, mimetype: 'text/css', content: css)
+          end
+          resources
+        end
+        private :_get_css_resources
+
+        # @private
+        def _fetch_resource_url(url)
+          response = Faraday.get(url)
+          content = response.body
+          if response.status != 200
+            STDERR.puts "[percy] Warning: failed to fetch page resource, this might be a bug: #{url}"
+            return nil
+          end
+          response
+        end
+
+        # @private
+        def _evaluate_script(page, script)
+          script = <<-JS
+            (function() {
+              #{script}
+            })();
+          JS
+          page.evaluate_script(script)
+        end
+        private :_evaluate_script
+      end
+    end
+  end
+end

data/lib/percy/capybara/version.rb

@@ -0,0 +1,5 @@
+module Percy
+  module Capybara
+    VERSION = '0.1.0'
+  end
+end

data/percy-capybara.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'percy/capybara/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'percy-capybara'
+  spec.version       = Percy::Capybara::VERSION
+  spec.authors       = ['Perceptual Inc.']
+  spec.email         = ['team@percy.io']
+  spec.summary       = %q{Percy::Capybara}
+  spec.description   = %q{}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'percy-client', '~> 0.1'
+  spec.add_dependency 'faraday'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'capybara', '~> 2.4'
+  spec.add_development_dependency 'capybara-webkit', '~> 1.5'
+  spec.add_development_dependency 'selenium-webdriver'
+  spec.add_development_dependency 'webmock', '~> 1'
+end

data/spec/lib/percy/capybara/client/builds_spec.rb

@@ -0,0 +1,42 @@
+RSpec.describe Percy::Capybara::Client::Builds do
+  let(:capybara_client) { Percy::Capybara::Client.new }
+
+  describe '#current_build' do
+    it 'returns the current build or creates a new one' do
+      mock_double = double('build')
+      expect(capybara_client.client).to receive(:create_build)
+        .with(capybara_client.client.config.repo)
+        .and_return(mock_double)
+        .once
+
+      current_build = capybara_client.current_build
+      expect(current_build).to eq(mock_double)
+      # Verify that it memoizes the current build by calling it again:
+      expect(current_build).to eq(mock_double)
+    end
+  end
+  describe '#build_initialized?' do
+    it 'is false before a build is initialized and true afterward' do
+      expect(capybara_client.client).to receive(:create_build).and_return(double('build'))
+      expect(capybara_client.build_initialized?).to be_falsey
+
+      capybara_client.initialize_build
+      expect(capybara_client.build_initialized?).to be_truthy
+    end
+  end
+  describe '#finalize_current_build' do
+    it 'finalizes the current build' do
+      build_data = {'data' => {'id' => 123}}
+      expect(capybara_client.client).to receive(:create_build).and_return(build_data)
+      capybara_client.initialize_build
+
+      expect(capybara_client.client).to receive(:finalize_build).with(123)
+      capybara_client.finalize_current_build
+    end
+    it 'raises an error if no current build exists' do
+      expect do
+        capybara_client.finalize_current_build
+      end.to raise_error(Percy::Capybara::Client::BuildNotInitializedError)
+    end
+  end
+end

data/spec/lib/percy/capybara/client/snapshots_spec.rb

@@ -0,0 +1,147 @@
+require 'json'
+require 'digest'
+
+RSpec.describe Percy::Capybara::Client::Snapshots do
+  let(:capybara_client) { Percy::Capybara::Client.new }
+
+  # Start a temp webserver that serves the testdata directory.
+  # You can test this server manually by running:
+  # ruby -run -e httpd spec/lib/percy/capybara/testdata -p 9090
+  before(:all) do
+    port = get_random_open_port
+    Capybara.app_host = "http://localhost:#{port}"
+    Capybara.run_server = false
+
+    # Note: using this form of popen to keep stdout and stderr silent and captured.
+    dir = File.expand_path('../testdata/', __FILE__)
+    @process = IO.popen([
+      'ruby', '-run', '-e', 'httpd', dir, '-p', port.to_s, err: [:child, :out]
+    ].flatten)
+
+    # Block until the server is up.
+    verify_server_up(Capybara.app_host)
+  end
+  after(:all) { Process.kill('INT', @process.pid) }
+
+  describe '#_get_root_html_resource', type: :feature, js: true do
+    it 'includes the root DOM HTML' do
+      visit '/'
+      resource = capybara_client.send(:_get_root_html_resource, page)
+
+      expect(resource.is_root).to be_truthy
+      expect(resource.mimetype).to eq('text/html')
+      expect(resource.resource_url).to match(/http:\/\/localhost:\d+\//)
+      expect(resource.content).to include('Hello World!')
+      expect(resource.sha).to eq(Digest::SHA256.hexdigest(resource.content))
+    end
+  end
+  describe '#_get_css_resources', type: :feature, js: true do
+    it 'includes all linked and imported stylesheets' do
+      # For capybara-webkit.
+      page.driver.respond_to?(:allow_url) && page.driver.allow_url('maxcdn.bootstrapcdn.com')
+
+      visit '/test-css.html'
+      resources = capybara_client.send(:_get_css_resources, page)
+
+      expect(resources.length).to eq(7)
+      expect(resources.collect(&:mimetype).uniq).to eq(['text/css'])
+
+      resource = resources.select do |resource|
+        resource.resource_url.match(/http:\/\/localhost:\d+\/css\/base\.css/)
+      end.fetch(0)
+      expect(resource.is_root).to be_falsey
+
+      expect(resource.content).to include('.colored-by-base { color: red; }')
+      expect(resource.sha).to eq(Digest::SHA256.hexdigest(resource.content))
+
+      resource = resources.select do |resource|
+        resource.resource_url.match(/http:\/\/localhost:\d+\/css\/simple-imports\.css/)
+      end.fetch(0)
+      expect(resource.is_root).to be_falsey
+      expect(resource.content).to include('@import url("imports.css")')
+      expect(resource.sha).to eq(Digest::SHA256.hexdigest(resource.content))
+
+      resource = resources.select do |resource|
+        resource.resource_url.match(/http:\/\/localhost:\d+\/css\/imports\.css/)
+      end.fetch(0)
+      expect(resource.is_root).to be_falsey
+      expect(resource.content).to include('.colored-by-imports { color: red; }')
+      expect(resource.sha).to eq(Digest::SHA256.hexdigest(resource.content))
+
+      resource = resources.select do |resource|
+        resource.resource_url.match(/http:\/\/localhost:\d+\/css\/level0-imports\.css/)
+      end.fetch(0)
+      expect(resource.is_root).to be_falsey
+      expect(resource.content).to include('@import url("level1-imports.css")')
+      expect(resource.content).to include('.colored-by-level0-imports { color: red; }')
+      expect(resource.sha).to eq(Digest::SHA256.hexdigest(resource.content))
+
+      resource = resources.select do |resource|
+        resource.resource_url.match(/http:\/\/localhost:\d+\/css\/level1-imports\.css/)
+      end.fetch(0)
+      expect(resource.is_root).to be_falsey
+      expect(resource.content).to include('@import url("level2-imports.css")')
+      expect(resource.content).to include('.colored-by-level1-imports { color: red; }')
+      expect(resource.sha).to eq(Digest::SHA256.hexdigest(resource.content))
+
+      resource = resources.select do |resource|
+        resource.resource_url.match(/http:\/\/localhost:\d+\/css\/level2-imports\.css/)
+      end.fetch(0)
+      expect(resource.is_root).to be_falsey
+      expect(resource.content).to include(".colored-by-level2-imports { color: red; }")
+      expect(resource.sha).to eq(Digest::SHA256.hexdigest(resource.content))
+
+      resource = resources.select do |resource|
+        resource.resource_url == (
+          'https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css')
+      end.fetch(0)
+      expect(resource.is_root).to be_falsey
+      expect(resource.content).to include('Bootstrap v3.3.4 (http://getbootstrap.com)')
+      expect(resource.sha).to eq(Digest::SHA256.hexdigest(resource.content))
+    end
+  end
+  describe '#snapshot', type: :feature, js: true do
+    context 'simple page with no resources' do
+      let(:content) { '<html><body>Hello World!</body><head></head></html>' }
+
+      it 'creates a snapshot and uploads missing resource' do
+        visit '/'
+
+        mock_response = {
+          'data' => {
+            'id' => '123',
+            'type' => 'builds',
+          },
+        }
+        stub_request(:post, 'https://percy.io/api/v1/repos/percy/percy-capybara/builds/')
+          .to_return(status: 201, body: mock_response.to_json)
+
+        resource = capybara_client.send(:_get_root_html_resource, page)
+        mock_response = {
+          'data' => {
+            'id' => '256',
+            'type' => 'snapshots',
+            'links' => {
+              'self' => "/api/v1/snapshots/123",
+              'missing-resources' => {
+                'linkage' => [
+                  {
+                    'type' => 'resources',
+                    'id' => resource.sha,
+                  },
+                ],
+              },
+            },
+          },
+        }
+        stub_request(:post, 'https://percy.io/api/v1/builds/123/snapshots/')
+          .to_return(status: 201, body: mock_response.to_json)
+
+        stub_request(:post, "https://percy.io/api/v1/builds/123/resources/")
+          .with(body: /#{resource.sha}/).to_return(status: 201, body: {success: true}.to_json)
+
+        resource_map = capybara_client.snapshot(page)
+      end
+    end
+  end
+end

data/spec/lib/percy/capybara/client/testdata/css/base.css

@@ -0,0 +1 @@
+.colored-by-base { color: red; }

data/spec/lib/percy/capybara/client/testdata/css/imports.css

@@ -0,0 +1 @@
+.colored-by-imports { color: red; }

data/spec/lib/percy/capybara/client/testdata/css/level0-imports.css

@@ -0,0 +1,2 @@
+@import url('level1-imports.css');
+.colored-by-level0-imports { color: red; }

data/spec/lib/percy/capybara/client/testdata/css/level1-imports.css

@@ -0,0 +1,2 @@
+@import url('level2-imports.css');
+.colored-by-level1-imports { color: red; }

data/spec/lib/percy/capybara/client/testdata/css/level2-imports.css

@@ -0,0 +1 @@
+.colored-by-level2-imports { color: red; }

data/spec/lib/percy/capybara/client/testdata/css/simple-imports.css

@@ -0,0 +1 @@
+@import url('imports.css');

data/spec/lib/percy/capybara/client/testdata/index.html

@@ -0,0 +1 @@
+<html><body>Hello World!</body><head></head></html>

data/spec/lib/percy/capybara/client/testdata/test-css.html

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+  <title>Test Percy::Capybara</title>
+  <link href="../css/base.css" rel="stylesheet" type="text/css">
+  <link href="/css/simple-imports.css" rel="stylesheet" type="text/css">
+  <link href="/css/level0-imports.css" rel="stylesheet" type="text/css">
+  <link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css" rel="stylesheet" type="text/css">
+  <style>
+    .colored-by-inline { color: red; }
+  </style>
+  <h1>Hello World!</h1>
+  <div class="colored-by-inline">This should be red</div>
+  <div class="colored-by-base">This should be red</div>
+  <div class="colored-by-imports">This should be red</div>
+  <div class="colored-by-level0-imports">This should be red</div>
+  <div class="colored-by-level1-imports">This should be red</div>
+  <div class="colored-by-level2-imports">This should be red</div>
+</html>

data/spec/lib/percy/capybara_spec.rb

@@ -0,0 +1,49 @@
+RSpec.describe Percy::Capybara do
+  before(:each) { Percy::Capybara.reset }
+
+  describe '#capybara_client' do
+    it 'returns the current client or creates a new one' do
+      capybara_client = Percy::Capybara.capybara_client
+      expect(capybara_client).to be
+      # Verify that it memoizes the current object by calling it again:
+      expect(Percy::Capybara.capybara_client).to eq(capybara_client)
+    end
+  end
+  describe '#snapshot' do
+    it 'passes all arguments through to the current capybara_client' do
+      mock_page = double('page')
+      capybara_client = Percy::Capybara.capybara_client
+      expect(capybara_client).to receive(:snapshot).with(mock_page, {}).once
+      Percy::Capybara.snapshot(mock_page)
+      expect(capybara_client).to receive(:snapshot).with(mock_page, name: '/foo.html (modal)').once
+      Percy::Capybara.snapshot(mock_page, name: '/foo.html (modal)')
+    end
+  end
+  describe '#snapshot' do
+    it 'delgates to Percy::Capybara::Client' do
+      capybara_client = Percy::Capybara.capybara_client
+      expect(capybara_client).to receive(:initialize_build).once
+      Percy::Capybara.initialize_build
+    end
+  end
+  describe '#finalize_build' do
+    it 'returns silently if no build is initialized' do
+      expect { Percy::Capybara.finalize_build }.to_not raise_error
+    end
+    it 'delgates to Percy::Capybara::Client' do
+      capybara_client = Percy::Capybara.capybara_client
+      build_data = {'data' => {'id' => 123}}
+      expect(capybara_client.client).to receive(:create_build).and_return(build_data).once
+      Percy::Capybara.initialize_build
+      expect(capybara_client).to receive(:finalize_current_build).once
+      Percy::Capybara.finalize_build
+    end
+  end
+  describe '#reset' do
+    it 'clears the current capybara_client' do
+      capybara_client = Percy::Capybara.capybara_client
+      Percy::Capybara.reset
+      expect(Percy::Capybara.capybara_client).to_not eq(capybara_client)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+require 'capybara/rspec'
+require 'capybara/webkit'
+require 'webmock/rspec'
+require 'support/test_helpers'
+require 'percy'
+require 'percy/capybara'
+
+RSpec.configure do |config|
+  config.include TestHelpers
+
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4.
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.disable_monkey_patching!
+  # config.warnings = true
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # Comment this out to test the default Selenium/Firefox flow:
+  Capybara.javascript_driver = :webkit
+
+  config.before(:all) do
+    WebMock.disable_net_connect!(allow_localhost: true, allow: [/maxcdn.bootstrapcdn.com/])
+  end
+end

data/spec/support/test_helpers.rb

@@ -0,0 +1,27 @@
+require 'socket'
+require 'timeout'
+
+module TestHelpers
+  class ServerDown < Exception; end
+
+  def get_random_open_port
+    # Using a port of "0" relies on the system to pick an open port.
+    server = TCPServer.new('127.0.0.1', 0)
+    port = server.addr[1]
+    server.close
+    port
+  end
+
+  def verify_server_up(host)
+    http = HTTPClient.new
+    4.times do
+      begin
+        http.get(host)
+        return true
+      rescue Errno::ECONNREFUSED
+        sleep 0.5
+      end
+    end
+    raise ServerDown, "Server failed to start: #{host}"
+  end
+end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: percy-capybara
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
-- Mike Fotinakis
+- Perceptual Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-05 00:00:00.000000000 Z
+date: 2015-05-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: percy-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,21 +66,111 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: capybara-webkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 description: ''
 email:
-- mike@fotinakis.com
+- team@percy.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
-- lib/perceptual.rb
-- lib/perceptual/version.rb
-- perceptual.gemspec
+- lib/percy/capybara.rb
+- lib/percy/capybara/client.rb
+- lib/percy/capybara/client/builds.rb
+- lib/percy/capybara/client/snapshots.rb
+- lib/percy/capybara/version.rb
+- percy-capybara.gemspec
+- spec/lib/percy/capybara/client/builds_spec.rb
+- spec/lib/percy/capybara/client/snapshots_spec.rb
+- spec/lib/percy/capybara/client/testdata/css/base.css
+- spec/lib/percy/capybara/client/testdata/css/imports.css
+- spec/lib/percy/capybara/client/testdata/css/level0-imports.css
+- spec/lib/percy/capybara/client/testdata/css/level1-imports.css
+- spec/lib/percy/capybara/client/testdata/css/level2-imports.css
+- spec/lib/percy/capybara/client/testdata/css/simple-imports.css
+- spec/lib/percy/capybara/client/testdata/index.html
+- spec/lib/percy/capybara/client/testdata/test-css.html
+- spec/lib/percy/capybara_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_helpers.rb
 homepage: ''
 licenses:
 - MIT
@@ -76,5 +194,19 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Write me.
-test_files: []
+summary: Percy::Capybara
+test_files:
+- spec/lib/percy/capybara/client/builds_spec.rb
+- spec/lib/percy/capybara/client/snapshots_spec.rb
+- spec/lib/percy/capybara/client/testdata/css/base.css
+- spec/lib/percy/capybara/client/testdata/css/imports.css
+- spec/lib/percy/capybara/client/testdata/css/level0-imports.css
+- spec/lib/percy/capybara/client/testdata/css/level1-imports.css
+- spec/lib/percy/capybara/client/testdata/css/level2-imports.css
+- spec/lib/percy/capybara/client/testdata/css/simple-imports.css
+- spec/lib/percy/capybara/client/testdata/index.html
+- spec/lib/percy/capybara/client/testdata/test-css.html
+- spec/lib/percy/capybara_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_helpers.rb
+has_rdoc: 

data/lib/perceptual.rb

@@ -1,5 +0,0 @@
-require "perceptual/version"
-
-module Perceptual
-  # Your code goes here...
-end

data/lib/perceptual/version.rb

@@ -1,3 +0,0 @@
-module Perceptual
-  VERSION = "0.0.1"
-end

data/perceptual.gemspec

@@ -1,23 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'perceptual/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "percy-capybara"
-  spec.version       = Perceptual::VERSION
-  spec.authors       = ["Mike Fotinakis"]
-  spec.email         = ["mike@fotinakis.com"]
-  spec.summary       = "Write me."
-  spec.description   = ""
-  spec.homepage      = ""
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-end