response_mate 0.3.3 → 0.4.0

data/spec/lib/response_mate/core_spec.rb

@@ -1,11 +1,15 @@
 require 'spec_helper'
 
 describe ResponseMate::Configuration do
+  subject(:configuration) { ResponseMate::Configuration.new }
+
   describe '.initialize' do
-    let(:subject) { ResponseMate::Configuration.new }
+    describe 'output_dir' do
+      subject { configuration.output_dir }
 
-    it 'assigns @output_dir' do
-      expect(subject.output_dir).to be_present
+      it 'has ./ as the default value' do
+        is_expected.to eq('./')
+      end
     end
 
     it 'assigns @requests_manifest' do
@@ -42,13 +46,6 @@ describe ResponseMate do
         end
       end
 
-      after do
-        ResponseMate.setup do |config|
-          config.output_dir        = './output/responses/'
-          config.requests_manifest = './requests.yml.erb'
-        end
-      end
-
       it 'properly assigns ivars' do
         expect(ResponseMate.configuration.output_dir).to eq('foo')
         expect(ResponseMate.configuration.requests_manifest).to eq('bar')

data/spec/lib/response_mate/environment_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe ResponseMate::Environment do
+  let(:filename) { 'a_file.yml' }
+
+  subject(:environment) { described_class.new(filename) }
+
+  describe 'initialization' do
+    describe 'filename' do
+      subject { environment.filename }
+
+      context 'when it is present' do
+        it 'is assigned to the specified value' do
+          is_expected.to eq(filename)
+        end
+      end
+
+      context 'when it is nil' do
+        let(:filename) { nil }
+
+        it 'is assigned to the default value' do
+          is_expected.to eq(ResponseMate.configuration.environment)
+        end
+      end
+    end
+
+    describe 'env' do
+      subject { environment.env }
+
+      context 'when the file exists' do
+        around do |example|
+          File.open(filename, 'w') { |f| f << ':foo: bar' }
+          example.run
+          File.delete(filename)
+        end
+
+        it 'is assigned to the parsed YAML file' do
+          is_expected.to eq(foo: 'bar')
+        end
+      end
+
+      context 'when the file does not exist' do
+        it 'is assigned to an empty Hash' do
+          is_expected.to eq({})
+        end
+      end
+    end
+  end
+
+  describe '#exists?' do
+    subject { environment.exists? }
+
+    context 'when the file with filename exists' do
+      around do |example|
+        File.write filename, ''
+        example.run
+        File.delete filename
+      end
+
+      it { is_expected.to be(true) }
+    end
+
+    context 'when the file with filename exists does not exist' do
+      it { is_expected.to be(false) }
+    end
+  end
+end

data/spec/lib/response_mate/manifest_spec.rb

@@ -0,0 +1,175 @@
+require 'spec_helper'
+
+describe ResponseMate::Manifest do
+  let(:filename) { 'a_file.yml' }
+  let(:file_contents) { ':requests: []' }
+  let(:environment) { }
+
+  subject(:manifest) { described_class.new(filename, environment) }
+
+  around do |example|
+    File.write filename, file_contents if filename
+    quietly { example.run }
+    File.delete filename rescue Errno::ENOENT # rubocop:disable Style/RescueModifier
+  end
+
+  describe '#filename' do
+    subject { manifest.filename }
+
+    context 'when it is present' do
+      it 'is assigned to the specified value' do
+        is_expected.to eq(filename)
+      end
+    end
+
+    context 'when it is nil' do
+      let(:filename) { nil }
+
+      before { allow_any_instance_of(described_class).to receive(:parse) }
+
+      it 'is assigned to the default value' do
+        is_expected.to eq(ResponseMate.configuration.requests_manifest)
+      end
+    end
+  end
+
+  describe '#environment' do
+    subject { manifest.environment }
+
+    before { allow(manifest).to receive(:parse) }
+
+    context 'when it is specified' do
+      it { is_expected.to eq(environment) }
+    end
+
+    context 'when it is not specified' do
+      it { is_expected.to be_nil }
+    end
+  end
+
+  describe '#requests_text' do
+    subject { manifest.requests_text }
+
+    context 'when the manifest file exists' do
+      let(:file_contents) { ':requests: []' }
+
+      context 'and is not a template' do
+        it 'returns the contents of the file' do
+          is_expected.to eq(file_contents)
+        end
+      end
+
+      context 'and is mustache template' do
+        let(:file_contents) { ':key: {{var}}' }
+
+        context 'and the environment file exists' do
+          let(:template_variable) { { var: 'value' } }
+          let(:environment) { double(exists?: true, env: template_variable) }
+
+          it 'returns the processed template' do
+            is_expected.to eq(":key: #{template_variable[:var]}")
+          end
+        end
+
+        context 'and the environment file does not exist' do
+          let(:environment) { double(exists?: false, env: {}) }
+
+          it 'returns the contents of the file' do
+            is_expected.to eq(':key: ')
+          end
+
+          it 'prints a warning to standard error' do
+            expect(capture(:stderr) { subject }).to match(/no environment file is found/)
+          end
+        end
+      end
+    end
+
+    context 'when the manifest file does not exist' do
+      let(:filename) { nil }
+
+      it { expect { subject }.to raise_error(ResponseMate::ManifestMissing) }
+    end
+  end
+
+  describe '#requests' do
+    subject { manifest.requests }
+
+    context 'when the requests text contains requests' do
+      let(:file_contents) do
+        <<-YAML
+        requests:
+          -
+            key: repos_show
+            request:
+              path: 'repos/rails/rails'
+        YAML
+      end
+
+      it 'returns them' do
+        expect(subject.map(&:key)).to match_array(%w[repos_show])
+      end
+    end
+
+    context 'when the requests text does not contain requests' do
+      let(:file_contents) { 'missing_requests: true' }
+
+      it 'prints a warning to standard error' do
+        expect(capture(:stderr) { subject }).to match(/contains no requests/)
+      end
+
+      it 'returns an empty Array' do
+        quietly { is_expected.to be_empty }
+      end
+    end
+  end
+
+  describe '#name' do
+    let(:name) { 'github apiv3' }
+    let(:file_contents) { "name: #{name}" }
+
+    subject { manifest.name }
+
+    it { is_expected.to eq(name) }
+  end
+
+  describe '#description' do
+    let(:description) { 'a short description of the requests contained in the manifest' }
+    let(:file_contents) { "description: #{description}" }
+
+    subject { manifest.description }
+
+    it { is_expected.to eq(description) }
+  end
+
+  describe '#requests_for_keys' do
+    let(:keys) { }
+    subject { manifest.requests_for_keys(keys) }
+
+    context 'when the specified keys are blank' do
+      it { is_expected.to eq([]) }
+    end
+
+    context 'when a key is missing' do
+      let(:keys) { %w[key1 key2] }
+      let(:existing_requests) { [keys][1..-1].map { |key| double(key: key) } }
+
+      it 'raises ResponseMate::KeysNotFound' do
+        expect { subject }.to raise_error(ResponseMate::KeysNotFound)
+      end
+    end
+
+    context 'when no key is missing' do
+      let(:keys) { %w[key1 key2] }
+      let(:existing_requests) { (keys + ['spare_key']).map { |key| double(key: key) } }
+
+      before do
+        allow(manifest).to receive(:requests).and_return(existing_requests)
+      end
+
+      it 'returns only the requests for the specified keys' do
+        expect(subject.map(&:key)).to match_array(keys)
+      end
+    end
+  end
+end

data/spec/lib/response_mate/recorder_spec.rb

@@ -57,7 +57,7 @@ describe ResponseMate::Recorder do
     context 'with no keys specified' do
       it 'records all keys in the manifest' do
         quietly { subject.record([]) }
-        expect(output_files.call).to have_exactly(2).items
+        expect(output_files.call.size).to eq(2)
       end
     end
   end

data/spec/spec_helper.rb

@@ -7,6 +7,39 @@ Coveralls.wear!
 
 Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
 
+module OutputHelpers
+  # Deprecated in active_support due to thread-safety
+  # see: https://github.com/rails/rails/blob/v4.2.2/activesupport/lib/active_support/core_ext/kernel/reporting.rb#L114
+  # We use it only as a testing helper in a non-threaded environment
+  def quietly
+    silence_stream(STDOUT) do
+      silence_stream(STDERR) do
+        yield
+      end
+    end
+  end
+
+  # Deprecated in active_support due to thread-safety
+  # see: https://github.com/rails/rails/blob/v4.2.2/activesupport/lib/active_support/core_ext/kernel/reporting.rb#L88
+  # We use it only as a testing helper in a non-threaded environment
+  def capture(stream)
+    stream = stream.to_s
+    captured_stream = Tempfile.new(stream)
+    stream_io = eval("$#{stream}") # rubocop:disable Lint/Eval
+    origin_stream = stream_io.dup
+    stream_io.reopen(captured_stream)
+
+    yield
+
+    stream_io.rewind
+    return captured_stream.read
+  ensure
+    captured_stream.close
+    captured_stream.unlink
+    stream_io.reopen(origin_stream)
+  end
+end
+
 RSpec.configure do |c|
-  c.treat_symbols_as_metadata_keys_with_true_values = true
+  c.include OutputHelpers
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: response_mate
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Dimitris Zorbas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-07 00:00:00.000000000 Z
+date: 2015-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,19 +95,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: colored
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.5
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -191,6 +191,8 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - Guardfile
 - LICENSE
@@ -222,14 +224,15 @@ files:
 - lib/response_mate/version.rb
 - requests.yml.sample
 - response_mate.gemspec
-- roadmap.md
 - spec/fixtures/two_keys.yml.erb
 - spec/lib/response_mate/cli_spec.rb
 - spec/lib/response_mate/commands/inspect_spec.rb
 - spec/lib/response_mate/commands/list_spec.rb
 - spec/lib/response_mate/commands/record_spec.rb
 - spec/lib/response_mate/core_spec.rb
+- spec/lib/response_mate/environment_spec.rb
 - spec/lib/response_mate/exporters/postman/collection_spec.rb
+- spec/lib/response_mate/manifest_spec.rb
 - spec/lib/response_mate/recorder_spec.rb
 - spec/lib/response_mate/tape_spec.rb
 - spec/lib/response_mate_spec.rb
@@ -271,7 +274,9 @@ test_files:
 - spec/lib/response_mate/commands/list_spec.rb
 - spec/lib/response_mate/commands/record_spec.rb
 - spec/lib/response_mate/core_spec.rb
+- spec/lib/response_mate/environment_spec.rb
 - spec/lib/response_mate/exporters/postman/collection_spec.rb
+- spec/lib/response_mate/manifest_spec.rb
 - spec/lib/response_mate/recorder_spec.rb
 - spec/lib/response_mate/tape_spec.rb
 - spec/lib/response_mate_spec.rb

data/roadmap.md

@@ -1,24 +0,0 @@
-## Milestone 0.1.0
-- Make the list command prompt you to perform any of the listed requests ✓
-- Recording is optional, you may just perform requests to inspect their
-- output. [Done]
-- Support mustache templates in favor of erb ✓
-- Extract Manifest to a separate class ✓
-- Add usage instructions in README.md [Done]
-- Remove support for .yml.erb request manifests [Done]
-- Export Connection as a separate class [Done]
-- Export Tape as a separate class [Done]
-
-## Milestone 0.2.0
-- Request helpers (random ids, uuids).
-- Paraller requests.
-- Expectations, a expectations.yml file will contain a list of keys and
-- status codes to match against the recordings.
-- response_mate server command that serves the recorded responses when
-- requests matching requests.yml are replayed.
-- Curl exporter.
-- Export environment.yml to postman format
-- Accept extra params/headers from cli
-- Support request types: [:raw, urlencoded]
-- read manifest file from url
-- Allow multiline input for inspect