whisperer 0.0.1 → 0.0.2

data/lib/whisperer/preprocessors/response_body.rb

@@ -7,7 +7,7 @@ module Whisperer
         body = @record.response.body
 
         unless body.data_obj.nil?
-          body.string = serializer_class(body.serializer).serialize(
+          body.string = serializer_class(body.serializer.to_sym).serialize(
             body.data_obj,
             body.serializer_opts
           )
@@ -16,7 +16,7 @@ module Whisperer
 
       protected
         def serializer_class(name)
-          Whisperer.serializer(name)
+          Whisperer::Serializers.fetch(name)
         end
     end
   end

data/lib/whisperer/record.rb

@@ -1,3 +1,4 @@
+require_relative 'record/default_value'
 require_relative 'record/request'
 require_relative 'record/response'
 
@@ -8,41 +9,7 @@ module Whisperer
     attribute :request,      Whisperer::Request,  default: proc { Whisperer::Request.new }
     attribute :response,     Whisperer::Response, default: proc { Whisperer::Response.new }
     attribute :http_version, String, default: ''
-    attribute :recorded_at,  String, default: proc { Time.now.httpdate }
+    attribute :recorded_at,  String, default: proc { DefaultValue.new(Time.now.httpdate) }
     attribute :sub_path,     String
-
-    def merge!(model)
-      merge_attrs(model, self)
-    end
-
-    protected
-      def merge_attrs(item, container)
-        item.attributes.each do |attr, val|
-          if val.respond_to?(:attributes)
-            merge_attrs(val, container[attr])
-          else
-            # We need to make sure that such attribute is declared
-            # for a record, otherwise, it cannot be written.
-            if container.class.attribute_set[attr].nil?
-              container.attribute(attr, item.class.attribute_set[attr])
-            end
-
-            attr_info = container.class.attribute_set[attr]
-
-            is_default = false
-
-            unless attr_info.nil?
-              def_val = attr_info.default_value
-              def_val = def_val.call if def_val.respond_to?(:call)
-
-              is_default = def_val == container[attr]
-            end
-
-            if container[attr].nil? || is_default
-              container[attr] = val
-            end
-          end
-        end
-      end
   end # class Record
 end # module Whisperer

data/lib/whisperer/record/body.rb

@@ -4,12 +4,12 @@ module Whisperer
   class Body
     include Virtus.model
 
-    attribute :encoding,   String
-    attribute :string,     String
+    attribute :encoding,   String, default: proc { DefaultValue.new('UTF-8') }
+    attribute :string,     String, default: proc { DefaultValue.new('') }
 
     # Attributes which are not part of Vcr response
     attribute :data_obj,         Object
-    attribute :serializer,       Symbol, default: proc { :json }
+    attribute :serializer,       Symbol, default: proc { DefaultValue.new(:json) }
     attribute :serializer_opts,  Hash,   default: {}
   end # class Body
 end # module Whisperer

data/lib/whisperer/record/default_value.rb

@@ -0,0 +1,13 @@
+module Whisperer
+  class DefaultValue
+    def initialize(val)
+      @val = val
+    end
+
+    def is_default; true; end
+
+    def to_sym; @val; end
+
+    def to_default; @val; end
+  end
+end

data/lib/whisperer/record/headers.rb

@@ -2,9 +2,14 @@ module Whisperer
   class Headers
      include Virtus.model
 
-    def initialize(*args)
+    def initialize(attrs = {})
       extend Virtus.model
 
+      attrs.each do |attr, val|
+        self.attribute(attr.to_sym, Object)
+        self.public_send("#{attr}=", val)
+      end
+
       super
     end
 

data/lib/whisperer/record/request.rb

@@ -6,7 +6,7 @@ module Whisperer
     include Virtus.model
 
     attribute :uri,     String
-    attribute :method,  Symbol
+    attribute :method,  Symbol, default: proc { DefaultValue.new(:get) }
     attribute :headers, Whisperer::Headers, default: proc {
       Whisperer::Headers.new
     }

data/lib/whisperer/record/response.rb

@@ -6,12 +6,7 @@ module Whisperer
   class Response
     include Virtus.model
 
-    attribute :headers, Whisperer::Headers, default: proc {
-      header = Whisperer::Headers.new
-      header.attribute(:content_length, String)
-      header
-    }
-
+    attribute :headers, Headers, default: proc { Headers.new(content_length: nil) }
     attribute :body,    Body,    default: proc { Body.new }
     attribute :status,  Status,  default: proc { Status.new }
   end # class Response

data/lib/whisperer/record/response/status.rb

@@ -3,8 +3,8 @@ module Whisperer
     class Status
       include Virtus.model
 
-      attribute :code,    Integer, default: 200
-      attribute :message, String,  default: 'OK'
+      attribute :code,    Integer, default: proc { DefaultValue.new(200) }
+      attribute :message, String,  default: proc { DefaultValue.new('OK') }
     end # class Status
   end # class Response
 end # module Whisperer

data/lib/whisperer/serializers.rb

@@ -0,0 +1,21 @@
+module Whisperer
+  module Serializers
+    @serializers = ThreadSafe::Hash.new
+
+    class << self
+      attr_reader :serializers
+
+      def fetch(name)
+        unless serializers[name]
+          raise ArgumentError.new("There is not serializer registered with \"#{name}\" name")
+        end
+
+        serializers[name]
+      end
+
+      def register(name, class_name)
+        serializers[name] = class_name
+      end
+    end
+  end
+end

data/lib/whisperer/serializers/json.rb

@@ -19,7 +19,7 @@ module Whisperer
 
       protected
         def prepare_data
-          @obj.marshal_dump
+          fetch_attrs(@obj)
         end
 
         # This method returns give data as it is.
@@ -28,6 +28,31 @@ module Whisperer
         def post_prepare_data(data)
           data
         end
+
+        def fetch_attrs(obj)
+          # When an OpenStruct object is given
+          if obj.respond_to?(:marshal_dump)
+            obj.marshal_dump
+          # When an object has the attributes method
+          elsif obj.respond_to?(:attributes)
+            obj.attributes
+          # When a pure ruby object is given
+          else
+            obj.instance_variables.each_with_object({}) do |attr, memo|
+              name = attr[1..-1]
+
+              # If there is an accessor method to read a value,
+              # we should use it.
+              memo[name] = if obj.respond_to?(name)
+                obj.public_send(name)
+              else
+                obj.instance_variable_get(attr)
+              end
+
+              memo
+            end
+          end
+        end
     end # class Json
   end # module Serializers
 end # module Whisperer

data/lib/whisperer/serializers/json_multiple.rb

@@ -6,7 +6,7 @@ module Whisperer
       protected
         def prepare_data
           @obj.map do |item|
-            item.marshal_dump
+            fetch_attrs(item)
           end
         end
     end # class JsonMultiple

data/lib/whisperer/storage.rb

@@ -0,0 +1,41 @@
+module Whisperer
+  class Storage
+    @cassette_records = ThreadSafe::Hash.new
+
+    class << self
+      attr_accessor :cassette_records
+      private :cassette_records=
+
+      def define(name, options = {}, &block)
+        dsl = Dsl.build
+        dsl.instance_eval &block
+        record = dsl.container
+
+        if options[:parent]
+          original_record = cassette_record(options[:parent])
+
+          if original_record.nil?
+            raise ArgumentError.new("Parent record \"#{options[:parent]}\" is not declared.")
+          else
+            Merger.merge(record, original_record)
+          end
+        end
+
+        cassette_records[name.to_sym] = record
+      end
+
+      # Returns true if at least one factory is defined, otherwise returns false.
+      def defined_any?
+        cassette_records.size > 0
+      end
+
+      def cassette_record(name)
+        cassette_records[name]
+      end
+
+      def reset_storage
+        @cassette_records.clear
+      end
+    end
+  end
+end

data/lib/whisperer/tasks/whisperer.rake

@@ -53,8 +53,8 @@ namespace :whisperer do
       begin
         Whisperer.generate_all
 
-        puts Rainbow('cassettes are generated').green
-      rescue Whisperer::NocassetteRecordError => error
+        puts Rainbow('Cassettes are generated').green
+      rescue Whisperer::NoCassetteRecordError => error
         puts Rainbow("Any cassette builder was found. Please, make sure you define at least one (We are looking for it like: #{config.builders_matcher}).").yellow
       end
     end
@@ -67,7 +67,7 @@ namespace :whisperer do
         Whisperer::generate(name)
 
         puts Rainbow("The cassette '#{name}' is generated").green
-      rescue Whisperer::NocassetteRecordError => error
+      rescue Whisperer::NoCassetteRecordError => error
         puts Rainbow(error.message).red
       end
     end

data/lib/whisperer/version.rb

@@ -1,3 +1,3 @@
 module Whisperer
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/cassettes/empty_robb_stark.yml

@@ -4,7 +4,7 @@ http_interactions:
     method: get
     uri: http://example.com/users/2
     body:
-      encoding: US-ASCII
+      encoding: UTF-8
       string: ''
     headers: {}
   response:
@@ -13,7 +13,7 @@ http_interactions:
       message: OK
     headers:
       Content-Length:
-      - '14'
+      - 14
     body:
       encoding: UTF-8
       string: '{"empty":true}'

data/spec/cassettes/girls/arya_stark.yml

@@ -4,7 +4,7 @@ http_interactions:
     method: get
     uri: http://example.com/users/1
     body:
-      encoding: US-ASCII
+      encoding: UTF-8
       string: ''
     headers: {}
   response:
@@ -13,7 +13,7 @@ http_interactions:
       message: OK
     headers:
       Content-Length:
-      - '58'
+      - 58
       Content-Type:
       - application/json;charset=utf-8
     body:

data/spec/cassettes/robb_stark.yml

@@ -4,7 +4,7 @@ http_interactions:
     method: get
     uri: http://example.com/users/1
     body:
-      encoding: US-ASCII
+      encoding: UTF-8
       string: ''
     headers:
       Accept:
@@ -15,7 +15,7 @@ http_interactions:
       message: OK
     headers:
       Content-Length:
-      - '57'
+      - 57
       Content-Type:
       - application/json;charset=utf-8
       X-Content-Type-Options:

data/spec/cassettes/robb_stark_without_content_length.yml

@@ -4,7 +4,7 @@ http_interactions:
     method: get
     uri: http://example.com/users/2
     body:
-      encoding: US-ASCII
+      encoding: UTF-8
       string: ''
     headers: {}
   response:
@@ -13,7 +13,7 @@ http_interactions:
       message: OK
     headers:
       Content-Length:
-      - '58'
+      - 58
     body:
       encoding: UTF-8
       string: '{"first_name":"Robb","last_name":"Stark","group":"member"}'

data/spec/cassettes/sansa_stark.yml

@@ -4,7 +4,7 @@ http_interactions:
     method: get
     uri: http://example.com/users/2
     body:
-      encoding: US-ASCII
+      encoding: UTF-8
       string: ''
     headers:
       Accept:

data/spec/cassettes/starks.yml

@@ -4,7 +4,7 @@ http_interactions:
     method: get
     uri: http://example.com/users
     body:
-      encoding: US-ASCII
+      encoding: UTF-8
       string: ''
     headers:
       Accept:
@@ -15,7 +15,7 @@ http_interactions:
       message: OK
     headers:
       Content-Length:
-      - '57'
+      - 57
       Content-Type:
       - application/json;charset=utf-8
       X-Content-Type-Options:

data/spec/cassettes/wolfs.yml

@@ -4,7 +4,7 @@ http_interactions:
     method: get
     uri: http://example.com/members
     body:
-      encoding: US-ASCII
+      encoding: UTF-8
       string: ''
     headers:
       Accept:
@@ -15,7 +15,7 @@ http_interactions:
       message: OK
     headers:
       Content-Length:
-      - '57'
+      - 57
       Content-Type:
       - application/json;charset=utf-8
       X-Content-Type-Options:

data/spec/unit/merger_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+describe Whisperer::Merger do
+  describe '#merge' do
+    let(:default_parent) {
+      r = Whisperer::Record.new(
+        request: {
+          uri: 'http://google.com',
+        },
+        response: {
+          body: {
+            encoding: 'UTF-8',
+            string:   'test'
+          }
+        },
+        recorded_at: 'test data'
+      )
+
+      r.request.headers.attribute(:content_length, Integer)
+      r.request.headers.attribute(:accept, String)
+
+      r.request.headers.content_length = 100
+      r.request.headers.accept         = 'javascript'
+
+      r.response.body.serializer = :test_serializer
+      r
+    }
+
+    let(:default_child) {
+      r = Whisperer::Record.new(
+        request: {
+          headers: {
+            content_length: 50
+          }
+        },
+        response: {
+          body: {
+            encoding: 'UTF-16'
+          }
+        }
+      )
+
+      r.request.headers.attribute(:content_length, Integer)
+
+      r.request.headers.content_length = 50
+      r
+    }
+
+    let(:parent) { default_parent }
+    let(:child)  { default_child }
+
+    subject { Whisperer::Merger.new(child, parent) }
+
+    before do
+      subject.merge
+    end
+
+    it 'has a correct content length header for the request' do
+      expect(child.request.headers.content_length).to eq(50)
+    end
+
+    it 'has an accept header for the request' do
+      expect(child.request.headers.accept).to eq('javascript')
+    end
+
+    it 'has an url' do
+      expect(child.request.uri).to eq('http://google.com')
+    end
+
+    it 'has a correct encoding for the body of the response' do
+      expect(child.response.body.encoding).to eq('UTF-16')
+    end
+
+    it 'has a string for the body of the response' do
+      expect(child.response.body.string).to eq('test')
+    end
+
+    it 'has a correct serializer for the body of the response' do
+      expect(child.response.body.serializer).to eq(:test_serializer)
+    end
+
+    it 'has a correct recorded_at value' do
+      expect(child.recorded_at).to eq('test data')
+    end
+
+    context 'when the default value for the serializer is used again' do
+      let(:child) {
+        r = default_child
+        r.response.body.serializer = :json
+        r
+      }
+
+      it 'has the newly defined value' do
+        expect(child.response.body.serializer).to eq(:json)
+      end
+    end
+  end
+end