site_prism.vcr 0.0.1

data/lib/site_prism_vcr/dsl/initial_adjuster.rb

@@ -0,0 +1,97 @@
+module SPV
+  module DSL
+    # This class provides DSL which is used while defining fixtures
+    # and applying them.
+    class InitialAdjuster
+      def initialize(options)
+        @options          = options
+        @tmp_keeper       = Fixtures::TmpKeeper.new(@options)
+        @fixtures_handler = Fixtures::Handler.new(@options)
+      end
+
+      # Defines fixtures which will be inserted into VCR.
+      #
+      # @param list [Array<String>] List of fixtures.
+      #
+      # @return [void]
+      #
+      # @api public
+      def fixtures(list)
+        prepared_fixtures = @fixtures_handler.handle_raw(
+          list,
+          [Fixtures::Modifiers::HomePath.new(@options)]
+        )
+
+        @tmp_keeper.add_fixtures(prepared_fixtures)
+      end
+
+      # Defines path to fixtures. Later this path
+      # can be used for defining fixtures. It is especially
+      # useful when you use deep subdirectories structure for storing fixtures.
+      #
+      # @param path [String] Path to fixtures.
+      #
+      # @return [void]
+      #
+      # @api public
+      def home_path(path)
+        @options.home_path = path
+      end
+
+      # Applies a given path to list of fixtures and defines
+      # those fixtures to be inserted into VCR.
+      #
+      # @param path [String] Path to fixtures.
+      # @param fixture_names [Array<String>] List of fixtures.
+      #
+      # @return [void]
+      #
+      # @raise [ArgumentError] If any of fixture names has path to a home directory.
+      #
+      # @api public
+      def path(path, fixture_names)
+        options_with_path  = OptionsWithPath.new(@options)
+        options_with_path.path = path
+
+        path_modifier      = Fixtures::Modifiers::Path.new(options_with_path)
+        home_path_modifier = Fixtures::Modifiers::HomePath.new(options_with_path)
+
+        prepared_fixtures = @fixtures_handler.handle_raw(
+          fixture_names,
+          [
+            path_modifier,
+            home_path_modifier
+          ]
+        )
+
+        @tmp_keeper.add_fixtures(prepared_fixtures)
+      end
+
+      # Defines a waiter which will be used for waiting until all HTTP
+      # interactions have finished.
+      #
+      # @param options [Hash, nil] Options which allows to change behavior of a waiter.
+      # @option options :eject_cassettes [Boolean] Whether or not to eject
+      #   all cassettes from VCR once a waiter meets an expectation.
+      #
+      # @yield Block to be used as a waiter.
+      #
+      # @return [void]
+      #
+      # @api public
+      def waiter(waiter_options = nil, &block)
+        @options.waiter         = block
+        @options.waiter_options = waiter_options
+      end
+
+      # Returns set of prepared fixtures.
+      #
+      # @return [SPV::Fixtures] A set of prepared fixtures.
+      #
+      # @api public
+      def prepared_fixtures
+        Fixtures.new(@tmp_keeper.fixtures)
+      end
+    end # class InitialAdjuster
+  end # module DSL
+end # module SPV

data/lib/site_prism_vcr/element.rb

@@ -0,0 +1,18 @@
+require 'delegate'
+
+module SPV
+  # Extends a native Capybara element with new methods.
+  class Element < SimpleDelegator
+    def initialize(element, parent, &block)
+      super element
+
+      @applier = Applier.new(parent, &block)
+    end
+
+    def click_and_apply_vcr(&adjusting_block)
+      @applier.apply(adjusting_block) do
+        click
+      end
+    end
+  end
+end

data/lib/site_prism_vcr/fixture.rb

@@ -0,0 +1,29 @@
+module SPV
+  # Keeps a path to fixture and options which should be
+  # passed to Vcr while inserting a cassette
+  class Fixture
+    attr_accessor :name, :options
+
+    # TODO: may be it makes sense to separately keep path from the name of a fixture?
+    def initialize(name, vcr_options = {})
+      @name, @options = name, vcr_options
+    end
+
+    def add_path(path)
+      self.name = path + name
+    end
+
+    def set_home_path(home_path)
+      self.name = self.name.gsub(/\A\~\//, home_path)
+    end
+
+    def has_link_to_home_path?
+      self.name[0..1] == '~/'
+    end
+
+    # Returns a name without a link to a home path
+    def clean_name
+      self.name[2..-1]
+    end
+  end
+end

data/lib/site_prism_vcr/fixtures/converter.rb

@@ -0,0 +1,17 @@
+module SPV
+  # Converts raw fixtures into list of
+  # SPV::Fixture objects.
+  class Fixtures
+    class Converter
+      def self.convert_raw(raw_list)
+        raw_list.map do |item|
+          if item.kind_of?(String)
+            Fixture.new(item)
+          else
+            Fixture.new(item[:fixture], item[:options])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/site_prism_vcr/fixtures/handler.rb

@@ -0,0 +1,31 @@
+module SPV
+  class Fixtures
+    # Prepares incoming raw fixtures to be used for inserting
+    # into VCR
+    class Handler
+      def initialize(options, convertor = Converter)
+        @options = options
+
+        @converter = convertor
+      end
+
+      def handle_raw(raw_fixtures, modifiers)
+        converted_fixtures = @converter.convert_raw(raw_fixtures)
+
+        modifiers.map do |modifier|
+          converted_fixtures.each do |converted_fixture|
+            modifier.modify(converted_fixture)
+          end
+        end
+
+        converted_fixtures
+      end
+
+      def handle_set_raws(*fixtures_set, modifiers)
+        fixtures_set.map do |fixtures_raw|
+          handle_raw fixtures_raw, modifiers
+        end
+      end
+    end
+  end
+end

data/lib/site_prism_vcr/fixtures/manager.rb

@@ -0,0 +1,38 @@
+module SPV
+  class Fixtures
+    # Takes cares about inserting and ejecting fixtures
+    # from Vcr.
+    class Manager
+      def initialize(options)
+        @options = options
+      end
+
+      # Injects given fixtures to Vcr.
+      #
+      # @param fixtures [Array<SPV::Fixture>] List of fixtures.
+      #
+      # @return [void]
+      #
+      # @raise [ArgumentError] If a list of fixtures is empty.
+      def inject(fixtures)
+        raise ArgumentError.new(
+          'No fixtures were specified to insert them into VCR'
+        ) if fixtures.size == 0
+
+        fixtures.each do |fixture|
+          VCR.insert_cassette fixture.name, fixture.options
+        end
+      end
+
+      # Ejects all fixtures from Vcr.
+      # Now it doesn't care which fixtures were inserted by
+      # an instance of this class. After calling this method
+      # Vcr will have no inserted fixtures at all.
+      #
+      # @return [void]
+      def eject
+        SPV::Helpers.eject_all_cassettes
+      end
+    end
+  end
+end

data/lib/site_prism_vcr/fixtures/modifiers/home_path.rb

@@ -0,0 +1,27 @@
+module SPV
+  class Fixtures
+    module Modifiers
+      # It takes a fixture and replaces "~/" with
+      # a defined home path
+      class HomePath
+        def initialize(options)
+          @options = options
+        end
+
+        def modify(fixture)
+          if fixture.has_link_to_home_path?
+            if @options.home_path
+              fixture.set_home_path(@options.home_path)
+            else
+              raise ArgumentError.new(
+                "You are trying to use a home path for #{fixture.name} fixture. " \
+                "Home path cannot be used since it is not defined, please refer to the documentation " \
+                "to make sure you define the home path properly."
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/site_prism_vcr/fixtures/modifiers/path.rb

@@ -0,0 +1,30 @@
+module SPV
+  class Fixtures
+    module Modifiers
+      # It takes a fixture and adds a path to it
+      class Path
+        def initialize(options)
+          @options = options
+        end
+
+        def modify(fixture)
+          if fixture.has_link_to_home_path?
+            raise HomePathError.new(
+              "You cannot use the home path while listing fixtures in the 'path' method. " <<
+              "Please, use 'fixtures' method for '#{fixture.clean_name}' fixture or " <<
+              "you can additionally use the 'path' method where you will specify a home path as a path name." <<
+              "Example: path('~/', ['#{fixture.clean_name}'])"
+            )
+          else
+            path = @options.path
+            path = path + '/' unless path[-1, 1] == '/'
+
+            fixture.add_path(path)
+          end
+        end
+
+        class HomePathError < ArgumentError; end
+      end
+    end
+  end
+end

data/lib/site_prism_vcr/fixtures/tmp_keeper.rb

@@ -0,0 +1,21 @@
+module SPV
+  class Fixtures
+    # This class is responsible for keeping a list
+    # of prepared fixtures which will be inserted to Vcr.
+    class TmpKeeper
+      attr_reader :fixtures
+
+      def initialize(options)
+        @fixtures, @options = [], options
+      end
+
+      def clean_fixtures
+        @fixtures = []
+      end
+
+      def add_fixtures(new_fixtures)
+        @fixtures.concat(new_fixtures)
+      end
+    end
+  end
+end

data/lib/site_prism_vcr/fixtures.rb

@@ -0,0 +1,41 @@
+module SPV
+  # This class is a container for keeping all prepared fixtures for inserting
+  # into VCR.
+  class Fixtures
+    include Enumerable
+
+    def initialize(vals)
+      @container = vals.each_with_object({}) do |fixture, memo|
+        memo[fixture.name] = fixture
+      end
+    end
+
+    def exchange(old_vals, new_vals)
+      new_list = self.each_with_object([]) do |item, memo|
+        memo << item unless old_vals.any? {|old_item| item.name == old_item.name }
+      end
+
+      self.class.new(new_list.concat(new_vals))
+    end
+
+    def replace(vals)
+      if vals.length > 0
+        self.class.new(vals)
+      else
+        self
+      end
+    end
+
+    def union(vals)
+      self.class.new(@container.values.concat(vals))
+    end
+
+    def each(&block)
+      @container.values.each &block
+    end
+
+    def size
+      @container.values
+    end
+  end
+end

data/lib/site_prism_vcr/options.rb

@@ -0,0 +1,22 @@
+# TODO: should be this class immutable?
+module SPV
+  class Options
+    attr_accessor :waiter, :waiter_options, :home_path
+
+    def initialize(options = {})
+      options.each do |key, val|
+        public_send("#{key}=", val)
+      end
+    end
+
+    def home_path=(val)
+      val << '/' unless val[-1, 1] == '/'
+
+      @home_path = val
+    end
+
+    def clone_options
+      dup
+    end
+  end
+end

data/lib/site_prism_vcr/options_with_path.rb

@@ -0,0 +1,7 @@
+require 'delegate'
+
+module SPV
+  class OptionsWithPath < SimpleDelegator
+    attr_accessor :path
+  end
+end

data/lib/site_prism_vcr/patches/element_container.rb

@@ -0,0 +1,15 @@
+module SitePrism::ElementContainer
+  def element_with_vcr(element_name, *args, &block)
+    element element_name, *args
+
+    origin_element_name = "origin_#{element_name}"
+
+    alias_method origin_element_name, element_name
+
+    define_method element_name.to_s do
+      elem = public_send(origin_element_name)
+
+      SPV::Element.new(elem, self, &block)
+    end
+  end
+end

data/lib/site_prism_vcr/patches/page.rb

@@ -0,0 +1,41 @@
+module SitePrism
+  class Page
+    # TODO: it should make sure this method does not a native method of SitePrism::Page class
+    def self.inherited(subclass)
+      # This code is required to allow subpages to inherit
+      # a defined adjuster block. Otherwise, that block should be
+      # duplicated in a subpage as well.
+      subclass.instance_variable_set(:@vcr_adjuster, @vcr_adjuster)
+    end
+
+    def self.vcr_options_for_load(&block)
+      @vcr_adjuster = block
+    end
+
+    def self.vcr_adjuster
+      @vcr_adjuster
+    end
+
+    def apply_vcr(*args, action_block, &adjusting_block)
+      applier = SPV::Applier.new(
+        self,
+        &self.class.vcr_adjuster
+      )
+
+      applier.apply(
+        adjusting_block
+      ) do
+        action_block.call
+      end
+    end
+
+    def load_and_apply_vcr(*args, &adjusting_block)
+      action_block = proc { load(*args) }
+
+      apply_vcr(
+        action_block,
+        &adjusting_block
+      )
+    end
+  end
+end

data/lib/site_prism_vcr/vcr_helpers.rb

@@ -0,0 +1,18 @@
+module SPV
+  module Helpers
+    # Ejects all cassettes from Vcr.
+    #
+    # It can be useful when you don't define a waiter while describing
+    # cassettes which will be applied on an action (click,
+    # page loading actions or any other). If you don't define a waiter
+    # this method should be used to avoid data mixing which can lead you to wrong
+    # behavior in your acceptance tests.
+    #
+    # @return [void]
+    # @api public
+    def self.eject_all_cassettes
+      while VCR.eject_cassette
+      end
+    end
+  end
+end

data/lib/site_prism_vcr/version.rb

@@ -0,0 +1,3 @@
+module SPV
+  VERSION = '0.0.1'
+end

data/lib/site_prism_vcr/waiter.rb

@@ -0,0 +1,23 @@
+module SPV
+  class Waiter
+    def initialize(node, fixtures_manager, options)
+      @node, @waiter_method = node, options.waiter
+      @fixtures_manager = fixtures_manager
+      @options = options.waiter_options || {}
+    end
+
+    def wait
+      if @waiter_method
+        @node.instance_eval &@waiter_method
+
+        if @options.fetch(:eject_cassettes, true)
+          @fixtures_manager.eject
+        end
+      end
+    end
+
+    def with_new_options(options)
+      self.class.new(@node, @fixtures_manager, options)
+    end
+  end
+end

data/lib/site_prism_vcr.rb

@@ -0,0 +1,24 @@
+require 'vcr'
+require 'capybara'
+require 'site_prism'
+require 'webmock'
+
+require 'site_prism_vcr/version'
+require 'site_prism_vcr/element'
+require 'site_prism_vcr/applier'
+require 'site_prism_vcr/fixture'
+require 'site_prism_vcr/fixtures'
+require 'site_prism_vcr/fixtures/tmp_keeper'
+require 'site_prism_vcr/fixtures/converter'
+require 'site_prism_vcr/fixtures/manager'
+require 'site_prism_vcr/fixtures/handler'
+require 'site_prism_vcr/fixtures/modifiers/path'
+require 'site_prism_vcr/fixtures/modifiers/home_path'
+require 'site_prism_vcr/options'
+require 'site_prism_vcr/options_with_path'
+require 'site_prism_vcr/dsl/initial_adjuster'
+require 'site_prism_vcr/dsl/adjuster'
+require 'site_prism_vcr/waiter'
+require 'site_prism_vcr/vcr_helpers'
+require 'site_prism_vcr/patches/page'
+require 'site_prism_vcr/patches/element_container'

data/site_prism.vcr.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'site_prism_vcr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'site_prism.vcr'
+  spec.version       = SPV::VERSION
+  spec.authors       = ['Dmitriy Nesteryuk']
+  spec.email         = ['nesterukd@gmail.com']
+  spec.description   = 'This gem integrates VCR library into SitePrism'
+  spec.summary       = 'VCR and SitePrism are awesome libraries. But, it is a bit difficult to work with them without some bridge between them. This gem combines these 2 libraries to provide a better way for stubbing external API request which your application is doing. This gem will be very helpful for developers which have an application working with an external API.'
+  spec.homepage      = 'https://github.com/nestd/site_prism.vcr'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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 'site_prism', '~> 2.4'
+  spec.add_dependency 'vcr',        '~> 2.6.0'
+  spec.add_dependency 'webmock'
+end

data/spec/fixtures/arya_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":"Arya 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/custom/blank.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":"<%= cat_owner %>","cat_name":"Max"}'
+    http_version:
+  recorded_at: Mon, 18 Mar 2013 21:29:05 GMT
+recorded_with: VCR 2.4.0

data/spec/fixtures/custom/bran_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":"Bran Stark","cat_name":"Max"}'
+    http_version:
+  recorded_at: Tue, 18 May 2013 23:31:55 GMT
+recorded_with: VCR 2.4.0