whisperer 0.0.1

data/lib/whisperer/record/body.rb

@@ -0,0 +1,15 @@
+module Whisperer
+  # This class is used for request and response parts of HTTP
+  # interactions, it should include only common attributes and methods.
+  class Body
+    include Virtus.model
+
+    attribute :encoding,   String
+    attribute :string,     String
+
+    # Attributes which are not part of Vcr response
+    attribute :data_obj,         Object
+    attribute :serializer,       Symbol, default: proc { :json }
+    attribute :serializer_opts,  Hash,   default: {}
+  end # class Body
+end # module Whisperer

data/lib/whisperer/record/headers.rb

@@ -0,0 +1,22 @@
+module Whisperer
+  class Headers
+     include Virtus.model
+
+    def initialize(*args)
+      extend Virtus.model
+
+      super
+    end
+
+    def to_hash
+      prepared_attrs, attrs = {}, super
+
+      attrs.each do |key, val|
+        key = key.to_s.titleize.split(' ').join('-')
+        prepared_attrs[key] = val
+      end
+
+      prepared_attrs
+    end
+  end # class Header
+end # module Whisperer

data/lib/whisperer/record/request.rb

@@ -0,0 +1,16 @@
+require_relative 'headers'
+require_relative 'body'
+
+module Whisperer
+  class Request
+    include Virtus.model
+
+    attribute :uri,     String
+    attribute :method,  Symbol
+    attribute :headers, Whisperer::Headers, default: proc {
+      Whisperer::Headers.new
+    }
+
+    attribute :body, Body, default: proc { Body.new }
+  end # class Request
+end # module Whisperer

data/lib/whisperer/record/response.rb

@@ -0,0 +1,18 @@
+require_relative 'headers'
+require_relative 'body'
+require_relative 'response/status'
+
+module Whisperer
+  class Response
+    include Virtus.model
+
+    attribute :headers, Whisperer::Headers, default: proc {
+      header = Whisperer::Headers.new
+      header.attribute(:content_length, String)
+      header
+    }
+
+    attribute :body,    Body,    default: proc { Body.new }
+    attribute :status,  Status,  default: proc { Status.new }
+  end # class Response
+end # module Whisperer

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

@@ -0,0 +1,10 @@
+module Whisperer
+  class Response
+    class Status
+      include Virtus.model
+
+      attribute :code,    Integer, default: 200
+      attribute :message, String,  default: 'OK'
+    end # class Status
+  end # class Response
+end # module Whisperer

data/lib/whisperer/samples/cassette_builder.rb

@@ -0,0 +1,24 @@
+Whisperer.define(:my_fixture_builder) do
+  request do
+    uri    'http://example.com/users/1'
+    method :get
+  end
+
+  response do
+    status do
+      code    200
+      message 'OK'
+    end
+
+    headers do
+      content_type 'application/json;charset=utf-8'
+    end
+
+    body do
+      encoding 'UTF-8'
+      factory  'my_factory', :json
+    end
+  end
+
+  recorded_at Time.new
+end

data/lib/whisperer/serializers/base.rb

@@ -0,0 +1,24 @@
+require 'multi_json'
+
+require_relative 'base'
+
+module Whisperer
+  module Serializers
+    class Base
+      extend Helpers
+
+      add_builder :serialize
+
+      attr_reader :options
+
+      def initialize(obj, options: {})
+        @obj     = obj
+        @options = options
+      end
+
+      def serialize
+        raise NotImplementedError
+      end
+    end # class Base
+  end # module Serializers
+end # module Whisperer

data/lib/whisperer/serializers/json.rb

@@ -0,0 +1,33 @@
+require 'multi_json'
+require_relative 'base'
+
+module Whisperer
+  module Serializers
+    class Json < Base
+      def initialize(obj, options: {}, json_dumper: MultiJson)
+        super obj, options: options
+
+        @json_dumper = json_dumper
+      end
+
+      def serialize
+        data = prepare_data
+        data = post_prepare_data(data)
+
+        @json_dumper.dump(data)
+      end
+
+      protected
+        def prepare_data
+          @obj.marshal_dump
+        end
+
+        # This method returns give data as it is.
+        # The purpose of this method is to give a way in child classes
+        # to alter data structure before converting data.
+        def post_prepare_data(data)
+          data
+        end
+    end # class Json
+  end # module Serializers
+end # module Whisperer

data/lib/whisperer/serializers/json_multiple.rb

@@ -0,0 +1,14 @@
+require_relative 'json'
+
+module Whisperer
+  module Serializers
+    class JsonMultiple < Json
+      protected
+        def prepare_data
+          @obj.map do |item|
+            item.marshal_dump
+          end
+        end
+    end # class JsonMultiple
+  end # module Serializers
+end # module Whisperer

data/lib/whisperer/tasks/whisperer.rake

@@ -0,0 +1,88 @@
+require 'whisperer'
+
+require 'active_support/core_ext/hash/deep_merge'
+require 'factory_girl'
+require 'rainbow'
+require 'yaml'
+
+config = Whisperer::Config.load('.whisperer.yml')
+
+Dir[
+  config.factories_matcher,
+  config.builders_matcher
+].each {|f| require f }
+
+namespace :whisperer do
+  desc 'Creates minimal structure of directories, creates a config file with default options'
+  task install: ['config:create'] do
+    path_to_builders = 'spec/cassette_builders'
+
+    if Dir.exists?(path_to_builders)
+      puts Rainbow("Skipped creating of #{path_to_builders} since it already exists").green
+    else
+      Dir.mkdir(path_to_builders)
+
+      puts Rainbow("Created directory for cassette builders: #{path_to_builders}").green
+    end
+  end
+
+  namespace :config do
+    desc 'Creates a config file with default options'
+    task :create do
+      if File.exists?('.whisperer.yml')
+        puts Rainbow("Skipped creating the sample of config (.whisperer.yml) since it already exists").green
+      else
+        File.open(
+          '.whisperer.yml',
+          File::CREAT|File::RDWR,
+          0644
+        ) do |f|
+          f.write(config.to_yml)
+
+          f.close
+        end
+
+        puts Rainbow("Created the sample of config: .whisperer.yml").green
+      end
+    end
+  end
+
+  namespace :cassettes do
+    desc 'Takes all cassette builders and generates cassettes for VCR'
+    task :generate_all do
+      begin
+        Whisperer.generate_all
+
+        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
+
+    desc 'Takes a specific cassette builder and generates one specific cassette for VCR'
+    task :generate, :name do |t, args|
+      name = args[:name]
+
+      begin
+        Whisperer::generate(name)
+
+        puts Rainbow("The cassette '#{name}' is generated").green
+      rescue Whisperer::NocassetteRecordError => error
+        puts Rainbow(error.message).red
+      end
+    end
+
+    namespace :builders do
+      desc 'Creates a sample of the cassette builder'
+      task :sample do
+        sample = File.join(File.dirname(__FILE__), '../samples/cassette_builder.rb')
+
+        path_to_save = config.path_to_builders + '/sample.rb'
+
+        FileUtils.cp(sample, path_to_save)
+
+        puts Rainbow("Created the sample of the cassette builder: #{path_to_save}").green
+      end
+    end
+  end
+end

data/lib/whisperer/version.rb

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

data/spec/cassette_builders/arya_stark.rb

@@ -0,0 +1,26 @@
+Whisperer.define(:arya_stark) do
+  request do
+    uri    'http://example.com/users/1'
+    method :get
+  end
+
+  response do
+    status do
+      code    200
+      message 'OK'
+    end
+
+    headers do
+      content_type 'application/json;charset=utf-8'
+    end
+
+    body do
+      encoding 'UTF-8'
+      factory  'arya_stark'
+    end
+  end
+
+  recorded_at 'Mon, 13 Jan 2014 21:01:47 GMT'
+
+  sub_path 'girls'
+end

data/spec/cassette_builders/bran_stark.rb

@@ -0,0 +1,19 @@
+Whisperer.define(:bran_stark) do
+  request do
+    uri    'http://example.com/users/2'
+    method :get
+
+    headers do
+      accept '*/*'
+    end
+  end
+
+  response do
+    body do
+      serializer :custom
+      factory    'bran_stark'
+    end
+  end
+
+  recorded_at 'Mon, 13 Jan 2014 21:01:47 GMT'
+end

data/spec/cassette_builders/empty_robb_stark.rb

@@ -0,0 +1,20 @@
+Whisperer.define(:empty_robb_stark) do
+  request do
+    uri    'http://example.com/users/2'
+    method :get
+  end
+
+  response do
+    status do
+      code    200
+      message 'OK'
+    end
+
+    body do
+      encoding 'UTF-8'
+      string   '{"empty":true}'
+    end
+  end
+
+  recorded_at 'Mon, 13 Jan 2014 21:01:47 GMT'
+end

data/spec/cassette_builders/robb_stark.rb

@@ -0,0 +1,30 @@
+Whisperer.define(:robb_stark) do
+  request do
+    uri    'http://example.com/users/1'
+    method :get
+
+    headers do
+      accept '*/*'
+    end
+  end
+
+  response do
+    status do
+      code    200
+      message 'OK'
+    end
+
+    headers do
+      content_type           'application/json;charset=utf-8'
+      content_length         57
+      x_content_type_options 'nosniff'
+    end
+
+    body do
+      encoding 'UTF-8'
+      factory  'robb_stark'
+    end
+  end
+
+  recorded_at 'Mon, 13 Jan 2014 21:01:47 GMT'
+end

data/spec/cassette_builders/robb_stark_without_content_length.rb

@@ -0,0 +1,20 @@
+Whisperer.define(:robb_stark_without_content_length) do
+  request do
+    uri    'http://example.com/users/2'
+    method :get
+  end
+
+  response do
+    status do
+      code    200
+      message 'OK'
+    end
+
+    body do
+      encoding 'UTF-8'
+      factory  'robb_stark'
+    end
+  end
+
+  recorded_at 'Mon, 13 Jan 2014 21:01:47 GMT'
+end

data/spec/cassette_builders/sansa_stark.rb

@@ -0,0 +1,9 @@
+require_relative 'bran_stark'
+
+Whisperer.define(:sansa_stark, parent: :bran_stark) do
+  response do
+    body do
+      factory 'sansa_stark'
+    end
+  end
+end

data/spec/cassette_builders/starks.rb

@@ -0,0 +1,31 @@
+Whisperer.define(:starks) do
+  request do
+    uri    'http://example.com/users'
+    method :get
+
+    headers do
+      accept '*/*'
+    end
+  end
+
+  response do
+    status do
+      code    200
+      message 'OK'
+    end
+
+    headers do
+      content_type           'application/json;charset=utf-8'
+      content_length         57
+      x_content_type_options 'nosniff'
+    end
+
+    body do
+      encoding   'UTF-8'
+      serializer :json_multiple
+      factories  ['robb_stark', 'ned_stark']
+    end
+  end
+
+  recorded_at 'Mon, 13 Jan 2014 21:01:47 GMT'
+end