site_prism.vcr 0.0.1

data/spec/fixtures/custom/daenerys_targaryen.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.github.com/users/max/orgs
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Mon, 18 Mar 2013 21:29:04 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - "60"
+      X-Ratelimit-Remaining:
+      - "54"
+      X-Github-Media-Type:
+      - github.beta
+      X-Content-Type-Options:
+      - nosniff
+      Content-Length:
+      - '2'
+      Etag:
+      - '"d751713988987e9331980363e24189ce"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+    body:
+      encoding: ASCII-8BIT
+      string: '{"cat_owner":"Daenerys Targaryen","cat_name":"Max"}'
+    http_version:
+  recorded_at: Mon, 18 Mar 2013 21:29:05 GMT
+recorded_with: VCR 2.4.0

data/spec/fixtures/jon_snow.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.github.com/users/felix/orgs
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Mon, 18 Mar 2013 21:29:04 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - '60'
+      X-Ratelimit-Remaining:
+      - '54'
+      X-Github-Media-Type:
+      - github.beta
+      X-Content-Type-Options:
+      - nosniff
+      Content-Length:
+      - '2'
+      Etag:
+      - '"d751713988987e9331980363e24189ce"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+    body:
+      encoding: ASCII-8BIT
+      string: '{"cat_owner":"Jon Snow","cat_name":"Felix"}'
+    http_version:
+  recorded_at: Mon, 18 Mar 2013 21:29:05 GMT
+recorded_with: VCR 2.5.0

data/spec/fixtures/ned_stark.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.github.com/users/max/orgs
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Mon, 18 Mar 2013 21:29:04 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - '60'
+      X-Ratelimit-Remaining:
+      - '54'
+      X-Github-Media-Type:
+      - github.beta
+      X-Content-Type-Options:
+      - nosniff
+      Content-Length:
+      - '2'
+      Etag:
+      - '"d751713988987e9331980363e24189ce"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+    body:
+      encoding: ASCII-8BIT
+      string: '{"cat_owner":"Ned Stark","cat_name":"Max"}'
+    http_version:
+  recorded_at: Thu, 23 May 2013 19:43:53 GMT
+recorded_with: VCR 2.5.0

data/spec/fixtures/robb_stark.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.github.com/users/felix/orgs
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Sun, 12 May 2013 18:09:05 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - '60'
+      X-Ratelimit-Remaining:
+      - '54'
+      X-Github-Media-Type:
+      - github.beta
+      X-Content-Type-Options:
+      - nosniff
+      Content-Length:
+      - '2'
+      Etag:
+      - '"d751713988987e9331980363e24189ce"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+    body:
+      encoding: ASCII-8BIT
+      string: '{"cat_owner":"Robb Stark","cat_name":"Felix"}'
+    http_version:
+  recorded_at: Sun, 12 May 2013 18:09:05 GMT
+recorded_with: VCR 2.5.0

data/spec/integration/http_interactions_on_even/click_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_integration_helper'
+
+feature 'Http interactions on event > Click' do
+  let(:cat_owner)     { test_app_page.cat_owner }
+  let(:test_app_page) { HomePage.new }
+  let(:action_method) { :click_and_apply_vcr }
+
+  before do
+    test_app_page.load
+  end
+
+  context 'clicks and handles one HTTP request' do
+    before do
+      test_app_page.link_with_one_request.click_and_apply_vcr
+    end
+
+    it 'applies a default fixture' do
+      expect(test_app_page.cat_owner).to have_content('Ned Stark')
+    end
+  end
+
+  context 'when there is a delay between clicking and doing an HTTP request' do
+    before do
+      test_app_page.link_with_one_request_and_delay.click_and_apply_vcr
+    end
+
+    it 'applies a fixture and the test waits for results' do
+      expect(cat_owner).to have_content('Ned Stark')
+    end
+  end
+
+  # TODO: should we write the same test for the page load?
+  context 'when an user clicks on the link which causes 2 HTTP requests' do
+    before do
+      test_app_page.link_with_2_requests.click_and_apply_vcr
+    end
+
+    it 'applies 2 fixtures' do
+      expect(cat_owner).to have_content('Ned Stark')
+      expect(cat_owner).to have_content('Robb Stark')
+    end
+  end
+
+  it_behaves_like 'when a custom fixture is applied' do
+    let(:actor) { test_app_page.link_with_one_request }
+
+    context 'when clicks again without specifying a custom fixture' do
+      it 'uses a default fixture again' do
+        actor.click_and_apply_vcr
+
+        expect(cat_owner).to have_content('Ned Stark')
+      end
+    end
+  end
+
+  context 'waiters' do
+    it_behaves_like 'when a default waiter does not eject fixtures' do
+      let(:actor) { test_app_page.link_without_ejecting_fixtures }
+    end
+
+    it_behaves_like 'custom waiters' do
+      let(:actor) { test_app_page.link_with_2_requests }
+    end
+  end
+
+  it_behaves_like 'when a home path is define' do
+    let(:actor_with_home_path)    { test_app_page.link_with_home_path }
+    let(:actor_without_home_path) { test_app_page.link_with_one_request }
+  end
+
+  it_behaves_like 'when a default fixture is exchanged' do
+    let(:actor_with_home_path)    { test_app_page.link_with_home_path }
+    let(:actor_without_home_path) { test_app_page.link_with_2_requests }
+  end
+end

data/spec/integration/immediate_http_interactions/page_load_on_click_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_integration_helper'
+
+feature 'Immediate Http interactions > Page load on click' do
+  let(:one_request_page) { ImmediateHttpInteractions::OneRequestPage.new }
+
+  before do
+    index_page = HomePage.new
+    index_page.load
+
+    one_request_page.apply_vcr proc { index_page.link_to_go_to_another_page.click }
+  end
+
+  it 'loads fixtures on opening a page by click on a link' do
+    expect(one_request_page.displayed?).to be_true
+
+    expect(one_request_page).to have_content('Ned Stark')
+  end
+end

data/spec/integration/immediate_http_interactions/page_load_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_integration_helper'
+
+feature 'Immediate Http interactions > Page load' do
+  let(:cat_owner)     { test_app_page.cat_owner }
+  let(:test_app_page) { ImmediateHttpInteractions::OneRequestPage.new }
+  let(:action_method) { :load_and_apply_vcr }
+
+  context 'when one default fixture is defined' do
+    it 'opens the page and applies a default fixture' do
+      test_app_page.load_and_apply_vcr
+
+      expect(cat_owner).to have_content('Ned Stark')
+    end
+  end
+
+  it 'applies additional query to url' do
+    test_app_page.load_and_apply_vcr(cat: 'ford')
+
+    expect(page.current_url).to match(/\?cat=ford/)
+  end
+
+  context 'when a subpage inherits a page with a defined vcr options' do
+    let(:test_app_page) { ImmediateHttpInteractions::SubPage.new }
+
+    it 'subpage inherits the defined options for its parent page' do
+      test_app_page.load_and_apply_vcr
+
+      expect(cat_owner).to have_content('Ned Stark')
+    end
+  end
+
+  it_behaves_like 'when a custom fixture is applied' do
+    let(:actor) { test_app_page }
+  end
+
+  context 'waiters' do
+    it_behaves_like 'when a default waiter does not eject fixtures' do
+      let(:actor) { ImmediateHttpInteractions::WaiterWithoutFixturesEjectionPage.new }
+    end
+
+    it_behaves_like 'custom waiters' do
+      let(:actor)         { ImmediateHttpInteractions::TwoRequestsPage.new }
+      let(:test_app_page) { actor }
+    end
+  end
+
+  it_behaves_like 'when a home path is define' do
+    let(:actor_with_home_path)    { ImmediateHttpInteractions::HomePathPage.new }
+    let(:actor_without_home_path) { ImmediateHttpInteractions::OneRequestPage.new }
+  end
+
+  it_behaves_like 'when a default fixture is exchanged' do
+    let(:actor_without_home_path) { ImmediateHttpInteractions::TwoRequestsPage.new }
+    let(:actor_with_home_path)    { ImmediateHttpInteractions::HomePathPage.new }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'bundler/setup'
+
+require 'rspec'
+require 'coveralls'
+
+require 'site_prism.vcr'
+
+Coveralls.wear!
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures'
+end

data/spec/spec_integration_helper.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+require 'capybara/rspec'
+require 'capybara/firebug'
+
+require 'support/test_app/test_app'
+
+Dir["./spec/support/shared/integration/**/*.rb"].sort.each {|f| require f }
+Dir["./spec/support/site_prism/pages/**/*.rb"].sort.each {|f| require f }
+
+Capybara.app = TestApp
+Capybara.default_driver = :selenium
+HTTPI.log = false
+
+Selenium::WebDriver::Firefox::Profile.firebug_version = '1.11.0'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures'
+  c.hook_into :webmock
+  c.ignore_localhost = true
+  c.preserve_exact_body_bytes { false }
+
+  c.default_cassette_options = {
+    serialize_with:         :psych,
+    allow_playback_repeats: true
+  }
+end

data/spec/support/shared/integration/custom_fixtures.rb

@@ -0,0 +1,32 @@
+shared_examples 'when a custom fixture is applied' do
+  context 'when no VCR options are passed' do
+    before do
+      actor.public_send(action_method) do
+        path 'custom', ['daenerys_targaryen']
+      end
+    end
+
+    it 'uses a custom fixture instead of a default one' do
+      expect(cat_owner).to have_content('Daenerys Targaryen')
+    end
+  end
+
+  context 'when VCR options are passed' do
+    before do
+      actor.public_send(action_method) do
+        path 'custom', [
+          {
+            fixture: 'blank',
+            options: {
+              erb: {cat_owner: 'Robert Baratheon'}
+            }
+          }
+        ]
+      end
+    end
+
+    it 'uses a custom fixture instead of a default one and takes VCR options' do
+      expect(cat_owner).to have_content('Robert Baratheon')
+    end
+  end
+end

data/spec/support/shared/integration/exchange.rb

@@ -0,0 +1,42 @@
+shared_examples 'when a default fixture is exchanged' do
+  context 'without a home path' do
+    before do
+      actor_without_home_path.public_send(action_method) do
+        waiter &:wait_for_arya_stark_and_robb_stark
+
+        exchange 'ned_stark', 'arya_stark'
+      end
+    end
+
+    it 'uses the exchanged fixture' do
+      expect(cat_owner).to have_content('Arya Stark')
+      expect(cat_owner).to have_content('Robb Stark')
+    end
+  end
+
+  context 'with a defined home path' do
+    context 'when fixtures are defined without Vcr options' do
+      before do
+        actor_with_home_path.public_send(action_method) do
+          exchange '~/daenerys_targaryen', '~/bran_stark'
+        end
+      end
+
+      it 'uses the exchanged fixture which are stored in the sub directory' do
+        expect(cat_owner).to have_content('Bran Stark')
+      end
+    end
+
+    context 'when fixtures are defined with Vcr options' do
+      before do
+        actor_with_home_path.public_send(action_method) do
+          exchange '~/daenerys_targaryen', {fixture: '~/blank', options: {erb: {cat_owner: 'Robert Baratheon'} }}
+        end
+      end
+
+      it 'uses the exchanged fixture with specified erb variables' do
+
+      end
+    end
+  end
+end

data/spec/support/shared/integration/home_path.rb

@@ -0,0 +1,49 @@
+shared_examples 'when a home path is define' do
+  shared_examples 'expects the custom fixture on the page' do
+    it 'applies a stored fixture in the directory defined in the home path' do
+      expect(test_app_page.cat_owner).to have_content('Bran Stark')
+    end
+  end
+
+  context 'when no custom fixture is applied' do
+    before do
+      actor_with_home_path.public_send(action_method)
+    end
+
+    it 'applies a stored fixture in the directory defined in the home path' do
+      expect(cat_owner).to have_content('Daenerys Targaryen')
+    end
+  end
+
+  context 'when a custom fixture is applied' do
+    before do
+      actor_with_home_path.public_send(action_method) do
+        fixtures ['~/bran_stark']
+      end
+    end
+
+    it_behaves_like 'expects the custom fixture on the page'
+  end
+
+  context 'when a home path is used within the path helper method' do
+    before do
+      actor_with_home_path.public_send(action_method) do
+        path '~/', ['bran_stark']
+      end
+    end
+
+    it_behaves_like 'expects the custom fixture on the page'
+  end
+
+  context 'when a home path is directly defined in the block for applying fixtures' do
+    before do
+      actor_without_home_path.public_send(action_method) do
+        home_path 'custom'
+
+        fixtures ['~/bran_stark']
+      end
+    end
+
+    it_behaves_like 'expects the custom fixture on the page'
+  end
+end

data/spec/support/shared/integration/waiter.rb

@@ -0,0 +1,75 @@
+shared_examples 'custom waiters' do
+  context 'when a waiter is redefined' do
+    before do
+      actor.public_send(action_method) do
+        fixtures ['arya_stark', 'jon_snow']
+
+        waiter &:wait_for_arya_stark_and_jon_snow
+      end
+    end
+
+    it 'uses a custom waiter' do
+      expect(cat_owner).to have_content('Arya Stark')
+      expect(cat_owner).to have_content('Jon Snow')
+    end
+
+    it 'VCR has not any fixtures' do
+      expect(VCR.eject_cassette).to be_nil
+    end
+
+    it 'uses a default waiter after using the custom waiter' do
+      actor.public_send(action_method)
+
+      expect(cat_owner).to have_content('Ned Stark')
+      expect(cat_owner).to have_content('Robb Stark')
+    end
+  end
+
+  context 'when a custom waiter does not eject fixtures' do
+    before do
+      my_page = test_app_page
+
+      actor.public_send(action_method) do
+        fixtures ['arya_stark', 'jon_snow']
+
+        waiter({eject_cassettes: false}, &:wait_for_arya_stark_and_jon_snow)
+      end
+    end
+
+    after do
+      SPV::Helpers.eject_all_cassettes
+    end
+
+    it 'uses a custom waiter' do
+      expect(cat_owner).to have_content('Arya Stark')
+      expect(cat_owner).to have_content('Jon Snow')
+    end
+
+    it 'VCR contains all cassettes' do
+      expect(VCR.eject_cassette.name).to eq('jon_snow')
+      expect(VCR.eject_cassette.name).to eq('arya_stark')
+      expect(VCR.eject_cassette).to be_nil
+    end
+  end
+end
+
+shared_examples 'when a default waiter does not eject fixtures' do
+  before do
+    actor.public_send(action_method)
+  end
+
+  after do
+    SPV::Helpers.eject_all_cassettes
+  end
+
+  it 'uses a default waiter' do
+    expect(cat_owner).to have_content('Ned Stark')
+    expect(cat_owner).to have_content('Robb Stark')
+  end
+
+  it 'VCR contains all cassettes' do
+    expect(VCR.eject_cassette.name).to eq('robb_stark')
+    expect(VCR.eject_cassette.name).to eq('ned_stark')
+    expect(VCR.eject_cassette).to be_nil
+  end
+end

data/spec/support/site_prism/pages/base.rb

@@ -0,0 +1,18 @@
+require_relative '../sections/console_block'
+
+class BasePage < SitePrism::Page
+  element :cat_owner, '#result'
+  section :console_block, ConsoleBlockSection, '#console'
+
+  def wait_for_arya_stark_and_jon_snow
+    console_block.arya_stark && console_block.jon_snow
+  end
+
+  def wait_for_ned_stark_and_robb_stark
+    console_block.ned_stark && console_block.robb_stark
+  end
+
+  def wait_for_arya_stark_and_robb_stark
+    console_block.arya_stark && console_block.robb_stark
+  end
+end

data/spec/support/site_prism/pages/home.rb

@@ -0,0 +1,44 @@
+require_relative './base'
+
+class HomePage < BasePage
+  set_url '/'
+
+  element :link_to_go_to_another_page, '#link_to_go_to_another_page'
+
+  element_with_vcr \
+    :link_with_one_request,
+    '#link_with_one_request' do
+      fixtures ['ned_stark']
+      waiter   &:wait_for_cat_owner
+    end
+
+  element_with_vcr \
+    :link_with_home_path,
+    '#link_with_one_request' do
+      home_path 'custom'
+
+      fixtures ['~/daenerys_targaryen']
+      waiter   &:wait_for_cat_owner
+    end
+
+  element_with_vcr \
+    :link_with_one_request_and_delay,
+    '#link_with_one_request_and_delay' do
+      fixtures ['ned_stark']
+      waiter   &:wait_for_cat_owner
+    end
+
+  element_with_vcr \
+    :link_with_2_requests,
+    '#link_with_2_requests' do
+      fixtures ['ned_stark', 'robb_stark']
+      waiter   &:wait_for_ned_stark_and_robb_stark
+    end
+
+  element_with_vcr \
+    :link_without_ejecting_fixtures,
+    '#link_with_2_requests' do
+      fixtures ['ned_stark', 'robb_stark']
+      waiter({eject_cassettes: false}, &:wait_for_ned_stark_and_robb_stark)
+    end
+end

data/spec/support/site_prism/pages/immediate_http_interactions/home_path.rb

@@ -0,0 +1,15 @@
+require_relative '../base'
+
+module ImmediateHttpInteractions
+  class HomePathPage < BasePage
+    set_url '/immediate-http-interactions/one-request'
+    set_url_matcher /immediate\-http\-interactions\/one\-request/
+
+    vcr_options_for_load do
+      home_path 'custom'
+
+      fixtures ['~/daenerys_targaryen']
+      waiter   &:wait_for_cat_owner
+    end
+  end
+end

data/spec/support/site_prism/pages/immediate_http_interactions/one_request.rb

@@ -0,0 +1,13 @@
+require_relative '../base'
+
+module ImmediateHttpInteractions
+  class OneRequestPage < BasePage
+    set_url '/immediate-http-interactions/one-request?cat={cat}'
+    set_url_matcher /immediate\-http\-interactions\/one\-request/
+
+    vcr_options_for_load do
+      fixtures ['ned_stark']
+      waiter   &:wait_for_cat_owner
+    end
+  end
+end

data/spec/support/site_prism/pages/immediate_http_interactions/subpage.rb

@@ -0,0 +1,7 @@
+require_relative './one_request'
+
+module ImmediateHttpInteractions
+  class SubPage < OneRequestPage
+    set_url '/immediate-http-interactions/one-request'
+  end
+end