vcr 2.0.0.beta1 → 2.0.0.beta2

data/lib/vcr/structs.rb

@@ -0,0 +1,209 @@
+require 'time'
+require 'forwardable'
+
+module VCR
+  module Normalizers
+    module Body
+      def initialize(*args)
+        super
+        # Ensure that the body is a raw string, in case the string instance
+        # has been subclassed or extended with additional instance variables
+        # or attributes, so that it is serialized to YAML as a raw string.
+        # This is needed for rest-client.  See this ticket for more info:
+        # http://github.com/myronmarston/vcr/issues/4
+        self.body = String.new(body.to_s)
+      end
+    end
+
+    module Header
+      def initialize(*args)
+        super
+        normalize_headers
+      end
+
+    private
+
+      def normalize_headers
+        new_headers = {}
+
+        headers.each do |k, v|
+          val_array = case v
+            when Array then v
+            when nil then []
+            else [v]
+          end
+
+          new_headers[k] = convert_to_raw_strings(val_array)
+        end if headers
+
+        self.headers = new_headers
+      end
+
+      def convert_to_raw_strings(array)
+        # Ensure the values are raw strings.
+        # Apparently for Paperclip uploads to S3, headers
+        # get serialized with some extra stuff which leads
+        # to a seg fault. See this issue for more info:
+        # https://github.com/myronmarston/vcr/issues#issue/39
+        array.map do |v|
+          case v
+            when String; String.new(v)
+            when Array; convert_to_raw_strings(v)
+            else v
+          end
+        end
+      end
+    end
+  end
+
+  module OrderedHashSerializer
+    def each
+      @ordered_keys.each do |key|
+        yield key, self[key]
+      end
+    end
+
+    if RUBY_VERSION =~ /1.9/
+      # 1.9 hashes are already ordered.
+      def self.apply_to(*args); end
+    else
+      def self.apply_to(hash, keys)
+        hash.instance_variable_set(:@ordered_keys, keys)
+        hash.extend self
+      end
+    end
+  end
+
+  class Request < Struct.new(:method, :uri, :body, :headers)
+    include Normalizers::Header
+    include Normalizers::Body
+
+    def to_hash
+      {
+        'method'  => method.to_s,
+        'uri'     => uri,
+        'body'    => body,
+        'headers' => headers
+      }.tap { |h| OrderedHashSerializer.apply_to(h, members) }
+    end
+
+    def self.from_hash(hash)
+      method = hash['method']
+      method &&= method.to_sym
+      new method,
+          hash['uri'],
+          hash['body'],
+          hash['headers']
+    end
+
+    @@object_method = Object.instance_method(:method)
+    def method(*args)
+      return super if args.empty?
+      @@object_method.bind(self).call(*args)
+    end
+  end
+
+  class HTTPInteraction < Struct.new(:request, :response, :recorded_at)
+    extend ::Forwardable
+    def_delegators :request, :uri, :method
+
+    def initialize(*args)
+      @ignored = false
+      super
+      self.recorded_at ||= Time.now
+    end
+
+    def to_hash
+      {
+        'request'     => request.to_hash,
+        'response'    => response.to_hash,
+        'recorded_at' => recorded_at.httpdate
+      }.tap do |hash|
+        OrderedHashSerializer.apply_to(hash, members)
+      end
+    end
+
+    def self.from_hash(hash)
+      new Request.from_hash(hash.fetch('request', {})),
+          Response.from_hash(hash.fetch('response', {})),
+          Time.httpdate(hash.fetch('recorded_at'))
+    end
+
+    def ignore!
+      @ignored = true
+    end
+
+    def ignored?
+      !!@ignored
+    end
+
+    def filter!(text, replacement_text)
+      return self if [text, replacement_text].any? { |t| t.to_s.empty? }
+      filter_object!(self, text, replacement_text)
+    end
+
+  private
+
+    def filter_object!(object, text, replacement_text)
+      if object.respond_to?(:gsub)
+        object.gsub!(text, replacement_text) if object.include?(text)
+      elsif Hash === object
+        filter_hash!(object, text, replacement_text)
+      elsif object.respond_to?(:each)
+        # This handles nested arrays and structs
+        object.each { |o| filter_object!(o, text, replacement_text) }
+      end
+
+      object
+    end
+
+    def filter_hash!(hash, text, replacement_text)
+      filter_object!(hash.values, text, replacement_text)
+
+      hash.keys.each do |k|
+        new_key = filter_object!(k.dup, text, replacement_text)
+        hash[new_key] = hash.delete(k) unless k == new_key
+      end
+    end
+  end
+
+  class Response < Struct.new(:status, :headers, :body, :http_version)
+    include Normalizers::Header
+    include Normalizers::Body
+
+    def to_hash
+      {
+        'status'       => status.to_hash,
+        'headers'      => headers,
+        'body'         => body,
+        'http_version' => http_version
+      }.tap { |h| OrderedHashSerializer.apply_to(h, members) }
+    end
+
+    def self.from_hash(hash)
+      new ResponseStatus.from_hash(hash.fetch('status', {})),
+          hash['headers'],
+          hash['body'],
+          hash['http_version']
+    end
+
+    def update_content_length_header
+      # TODO: should this be the bytesize?
+      value = body ? body.length.to_s : '0'
+      key = %w[ Content-Length content-length ].find { |k| headers.has_key?(k) }
+      headers[key] = [value] if key
+    end
+  end
+
+  class ResponseStatus < Struct.new(:code, :message)
+    def to_hash
+      {
+        'code' => code, 'message' => message
+      }.tap { |h| OrderedHashSerializer.apply_to(h, members) }
+    end
+
+    def self.from_hash(hash)
+      new hash['code'], hash['message']
+    end
+  end
+end

data/lib/vcr/tasks/vcr.rake

@@ -0,0 +1,9 @@
+namespace :vcr do
+  desc "Migrate cassettes from the VCR 1.x format to the VCR 2.x format."
+  task :migrate_cassettes do
+    dir = ENV.fetch('DIR') { raise "You must pass the cassette library directory as DIR=<directory>" }
+    require 'vcr/cassette/migrator'
+    VCR::Cassette::Migrator.new(dir).migrate!
+  end
+end
+

data/lib/vcr/version.rb

@@ -3,7 +3,7 @@ module VCR
 
   def version
     @version ||= begin
-      string = '2.0.0.beta1'
+      string = '2.0.0.beta2'
 
       def string.parts
         split('.').map { |p| p.to_i }

data/spec/fixtures/cassette_spec/1_x_cassette.yml

@@ -0,0 +1,110 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: http://example.com:80/
+    body: 
+    headers: 
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      last-modified: 
+      - Tue, 15 Nov 2005 13:24:10 GMT
+      connection: 
+      - Keep-Alive
+      date: 
+      - Thu, 25 Feb 2010 07:52:38 GMT
+      content-type: 
+      - text/html; charset=UTF-8
+      etag: 
+      - "\"24ec5-1b6-4059a80bfd280\""
+      server: 
+      - Apache/2.2.3 (CentOS)
+      content-length: 
+      - "438"
+      age: 
+      - "3009"
+      accept-ranges: 
+      - bytes
+    body: |
+      <HTML>
+      <HEAD>
+        <TITLE>Example Web Page</TITLE>
+      </HEAD> 
+      <body>  
+      <p>You have reached this web page by typing &quot;example.com&quot;,
+      &quot;example.net&quot;,
+        or &quot;example.org&quot; into your web browser.</p>
+      <p>These domain names are reserved for use in documentation and are not available 
+        for registration. See <a href="http://www.rfc-editor.org/rfc/rfc2606.txt">RFC 
+        2606</a>, Section 3.</p>
+      </BODY>
+      </HTML>
+
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: http://example.com:80/foo
+    body: 
+    headers: 
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 404
+      message: Not Found
+    headers: 
+      connection: 
+      - close
+      content-type: 
+      - text/html; charset=iso-8859-1
+      date: 
+      - Thu, 25 Feb 2010 07:52:38 GMT
+      server: 
+      - Apache/2.2.3 (CentOS)
+      content-length: 
+      - "277"
+    body: |
+      <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
+      <html><head>
+      <title>404 Not Found</title>
+      </head><body>
+      <h1>Not Found</h1>
+      <p>The requested URL /foo was not found on this server.</p>
+      <hr>
+      <address>Apache/2.2.3 (CentOS) Server at example.com Port 80</address>
+      </body></html>
+
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: http://example.com:80/
+    body: 
+    headers: 
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      last-modified: 
+      - Tue, 15 Nov 2005 13:24:10 GMT
+      connection: 
+      - Keep-Alive
+      date: 
+      - Thu, 25 Feb 2010 07:52:38 GMT
+      content-type: 
+      - text/html; charset=UTF-8
+      etag: 
+      - "\"24ec5-1b6-4059a80bfd280\""
+      server: 
+      - Apache/2.2.3 (CentOS)
+      content-length: 
+      - "438"
+      age: 
+      - "3009"
+      accept-ranges: 
+      - bytes
+    body: Another example.com response
+    http_version: "1.1"

data/spec/fixtures/cassette_spec/example.yml

@@ -1,110 +1,111 @@
---- 
-- !ruby/struct:VCR::HTTPInteraction 
-  request: !ruby/struct:VCR::Request 
-    method: :get
-    uri: http://example.com:80/
-    body: 
-    headers: 
-  response: !ruby/struct:VCR::Response 
-    status: !ruby/struct:VCR::ResponseStatus 
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://example.com/
+    body: ''
+    headers: {}
+  response:
+    status:
       code: 200
       message: OK
-    headers: 
-      last-modified: 
+    headers:
+      Last-Modified:
       - Tue, 15 Nov 2005 13:24:10 GMT
-      connection: 
+      Connection:
       - Keep-Alive
-      date: 
+      Date:
       - Thu, 25 Feb 2010 07:52:38 GMT
-      content-type: 
+      Content-Type:
       - text/html; charset=UTF-8
-      etag: 
-      - "\"24ec5-1b6-4059a80bfd280\""
-      server: 
+      Etag:
+      - ! '"24ec5-1b6-4059a80bfd280"'
+      Server:
       - Apache/2.2.3 (CentOS)
-      content-length: 
-      - "438"
-      age: 
-      - "3009"
-      accept-ranges: 
+      Content-Length:
+      - '438'
+      Age:
+      - '3009'
+      Accept-Ranges:
       - bytes
-    body: |
-      <HTML>
-      <HEAD>
-        <TITLE>Example Web Page</TITLE>
-      </HEAD> 
-      <body>  
-      <p>You have reached this web page by typing &quot;example.com&quot;,
-      &quot;example.net&quot;,
-        or &quot;example.org&quot; into your web browser.</p>
-      <p>These domain names are reserved for use in documentation and are not available 
-        for registration. See <a href="http://www.rfc-editor.org/rfc/rfc2606.txt">RFC 
-        2606</a>, Section 3.</p>
-      </BODY>
-      </HTML>
-
-    http_version: "1.1"
-- !ruby/struct:VCR::HTTPInteraction 
-  request: !ruby/struct:VCR::Request 
-    method: :get
-    uri: http://example.com:80/foo
-    body: 
-    headers: 
-  response: !ruby/struct:VCR::Response 
-    status: !ruby/struct:VCR::ResponseStatus 
+    body: ! "<HTML>\n<HEAD>\n  <TITLE>Example Web Page</TITLE>\n</HEAD> \n<body>  \n<p>You
+      have reached this web page by typing &quot;example.com&quot;,\n&quot;example.net&quot;,\n
+      \ or &quot;example.org&quot; into your web browser.</p>\n<p>These domain names
+      are reserved for use in documentation and are not available \n  for registration.
+      See <a href=\"http://www.rfc-editor.org/rfc/rfc2606.txt\">RFC \n  2606</a>,
+      Section 3.</p>\n</BODY>\n</HTML>\n"
+    http_version: '1.1'
+  recorded_at: Tue, 01 Nov 2011 04:49:54 GMT
+- request:
+    method: get
+    uri: http://example.com/foo
+    body: ''
+    headers: {}
+  response:
+    status:
       code: 404
       message: Not Found
-    headers: 
-      connection: 
+    headers:
+      Connection:
       - close
-      content-type: 
+      Content-Type:
       - text/html; charset=iso-8859-1
-      date: 
+      Date:
       - Thu, 25 Feb 2010 07:52:38 GMT
-      server: 
+      Server:
       - Apache/2.2.3 (CentOS)
-      content-length: 
-      - "277"
-    body: |
-      <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
+      Content-Length:
+      - '277'
+    body: ! '<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
+
       <html><head>
+
       <title>404 Not Found</title>
+
       </head><body>
+
       <h1>Not Found</h1>
+
       <p>The requested URL /foo was not found on this server.</p>
+
       <hr>
+
       <address>Apache/2.2.3 (CentOS) Server at example.com Port 80</address>
+
       </body></html>
 
-    http_version: "1.1"
-- !ruby/struct:VCR::HTTPInteraction 
-  request: !ruby/struct:VCR::Request 
-    method: :get
-    uri: http://example.com:80/
-    body: 
-    headers: 
-  response: !ruby/struct:VCR::Response 
-    status: !ruby/struct:VCR::ResponseStatus 
+'
+    http_version: '1.1'
+  recorded_at: Tue, 01 Nov 2011 04:49:54 GMT
+- request:
+    method: get
+    uri: http://example.com/
+    body: ''
+    headers: {}
+  response:
+    status:
       code: 200
       message: OK
-    headers: 
-      last-modified: 
+    headers:
+      Last-Modified:
       - Tue, 15 Nov 2005 13:24:10 GMT
-      connection: 
+      Connection:
       - Keep-Alive
-      date: 
+      Date:
       - Thu, 25 Feb 2010 07:52:38 GMT
-      content-type: 
+      Content-Type:
       - text/html; charset=UTF-8
-      etag: 
-      - "\"24ec5-1b6-4059a80bfd280\""
-      server: 
+      Etag:
+      - ! '"24ec5-1b6-4059a80bfd280"'
+      Server:
       - Apache/2.2.3 (CentOS)
-      content-length: 
-      - "438"
-      age: 
-      - "3009"
-      accept-ranges: 
+      Content-Length:
+      - '438'
+      Age:
+      - '3009'
+      Accept-Ranges:
       - bytes
     body: Another example.com response
-    http_version: "1.1"
+    http_version: '1.1'
+  recorded_at: Tue, 01 Nov 2011 04:49:54 GMT
+recorded_with: VCR 1.11.3