response_mate 0.1.1

data/lib/response_mate/manifest.rb

@@ -0,0 +1,68 @@
+class ResponseMate::Manifest
+  include ResponseMate::ManifestParser
+
+  attr_accessor :filename, :requests, :requests_text, :base_url, :oauth,
+    :default_headers, :environment
+
+  def initialize(filename, environment = nil)
+    @filename = filename || ResponseMate.configuration.requests_manifest
+    @oauth = ResponseMate::Oauth.new
+    @environment = environment
+    parse
+  end
+
+  def preprocess_manifest
+    begin
+      @requests_text = File.read filename
+    rescue Errno::ENOENT
+      puts filename.red << ' does not seem to exist'
+      exit 1
+    end
+
+    @requests_text = Mustache.render(@requests_text, environment.try(:env) || {})
+  end
+
+  def parse
+    preprocess_manifest
+    @request_hashes = YAML.load(requests_text)
+    @base_url = @request_hashes['base_url']
+    @requests = @request_hashes['requests'].map { |rh| ResponseMate::Request.new(rh) }
+    @default_headers = @request_hashes['default_headers']
+    add_oauth_to_requests
+  end
+
+  def add_oauth_to_requests
+    @requests.each do |req|
+      if req[:params].present?
+        req[:params].merge!('oauth_token' => oauth.token)
+      else
+        req[:params] = { 'oauth_token' => oauth.token }
+      end
+    end
+  end
+
+  class << self
+    def parse_request(request)
+      return parse_request_string(request) if request.is_a? String
+      parse_request_hash(request) if request.is_a? Hash
+    end
+
+    def parse_request_hash(hash)
+      self::DEFAULT_REQUEST.merge(hash.symbolize_keys)
+    end
+
+    def parse_request_string(request_string)
+      raise ArgumentError if request_string !~ self::REQUEST_MATCHER
+      { verb: $~[:verb] || self::DEFAULT_REQUEST[:verb] }
+        .merge(extract_path_query($~[:path]))
+    end
+
+    def extract_path_query(str)
+      parsed = Addressable::URI.parse(str)
+      {
+        path: parsed.path,
+        params: parsed.query_values
+      }
+    end
+  end
+end

data/lib/response_mate/manifest_parser.rb

@@ -0,0 +1,7 @@
+module ResponseMate::ManifestParser
+  HTTP_VERBS = %w(GET POST PUT PATCH DELETE HEAD OPTIONS)
+  REQUEST_MATCHER = /^(?<verb>(#{HTTP_VERBS.join('|')})) (?<path>(.)*)$/im
+  DEFAULT_REQUEST = {
+    verb: 'GET'
+  }
+end

data/lib/response_mate/oauth.rb

@@ -0,0 +1,17 @@
+# coding: utf-8
+
+module ResponseMate
+  class Oauth
+    attr_accessor :manifest
+
+    def initialize
+      @manifest = YAML.load_file(ResponseMate.configuration.oauth_manifest)
+    rescue Errno::ENOENT
+      @manifest = nil
+    end
+
+    def token
+      manifest['token']
+    end
+  end
+end

data/lib/response_mate/recorder.rb

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+module ResponseMate
+  # Handles recording requests
+  class Recorder
+    include ResponseMate::ManifestParser
+
+    attr_accessor :base_url, :conn, :manifest, :oauth, :keys
+
+    def initialize(args = {})
+      @manifest = args[:manifest]
+
+      @keys = args[:keys]
+      @base_url = args[:base_url] || manifest.base_url
+
+      @conn = ResponseMate::Connection.new(base_url)
+      @conn.set_headers_from_manifest(manifest)
+    end
+
+    def record
+      requests = manifest.requests
+      requests.select! { |r| keys.include? r.key } if keys.present?
+      requests.each do |request|
+        process request.key, request
+      end
+    end
+
+    private
+
+    def process(key, request)
+      meta = request.meta
+      request = ResponseMate::Manifest.parse_request(request.request)
+
+      puts "[#{key}] #{request[:verb]}".cyan_on_black.bold << " #{request[:path]}"
+      puts "\tparams #{request[:params]}" if request[:params].present?
+      ResponseMate::Tape.new.write(key, request, conn.fetch(request), meta)
+    end
+  end
+end

data/lib/response_mate/request.rb

@@ -0,0 +1,2 @@
+class ResponseMate::Request < OpenStruct
+end

data/lib/response_mate/tape.rb

@@ -0,0 +1,18 @@
+class ResponseMate::Tape
+  def write(key, request, response, meta = {})
+    File.open("#{ResponseMate.configuration.output_dir}#{key}.yml", 'w') do |f|
+      file_content = {
+        request: request.select { |_, v| !v.nil? },
+        status: response.status,
+        headers: response.headers.to_hash,
+        body: response.body
+      }
+
+      file_content.merge!(meta: meta) if meta.present?
+
+      f << file_content.to_yaml
+    end
+  rescue Errno::ENOENT
+    raise ResponseMate::OutputDirError
+  end
+end

data/lib/response_mate/version.rb

@@ -0,0 +1,3 @@
+module ResponseMate
+  VERSION = '0.1.1'
+end

data/oauth.yml.sample

@@ -0,0 +1,12 @@
+---
+token: Vr/AzbfQt3ywQlKUonZk25VqRg2ILFAFV/voi69FD9xlJl5Yp9DmDWb6PAEsVwuI1KckH3aa1/vxRaj/Mbwg==
+application_token: false
+expires_at: 2013-12-16 15:27:33.304654000 Z
+user_id: 147606
+oauth2_client_id: 1330
+:permissions:
+- favorites
+- notifications
+- easy
+- public
+- current_user_profile

data/requests.yml.sample

@@ -0,0 +1,16 @@
+base_url: http://localhost:3000/api
+default_headers:
+  accept: 'application/vnd.github.beta+json'
+requests:
+  -
+    key: user_repos
+    request: 'GET /user/repos'
+  -
+    key: user_issues
+    request:
+      path: '/user/issues'
+      params:
+        sort: 'updated'
+  -
+    key: users_repos
+    request: 'GET /users/{{some_user_id}}/repos'

data/response_mate.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'response_mate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "response_mate"
+  spec.version       = ResponseMate::VERSION
+  spec.authors       = ["Dimitris Zorbas"]
+  spec.email         = ["zorbash@skroutz.gr"]
+  spec.description   = <<-DESC
+    Cli tool to make inspecting and recording HTTP requests fun again
+  DESC
+  spec.summary       = %q{}
+  spec.homepage      = ""
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-remote"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency 'fakefs'
+  spec.add_development_dependency 'rubocop'
+
+  spec.add_dependency "thor", "~> 0.18.1"
+  spec.add_dependency "awesome_print"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "colored"
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "addressable"
+  spec.add_dependency "highline"
+  spec.add_dependency "mustache"
+end

data/roadmap.md

@@ -0,0 +1,24 @@
+## 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

data/spec/fixtures/two_keys.yml.erb

@@ -0,0 +1,8 @@
+base_url: http://localhost:3000/api
+requests:
+  -
+    key: one
+    request: 'GET /categories?page=1&per=5'
+  -
+    key: two
+    request: 'GET /categories/root'

data/spec/lib/response_mate/cli_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+describe ResponseMate::CLI do
+  describe '.package_name' do
+    it 'names the tool response_mate' do
+      content = capture(:stdout) { ResponseMate::CLI.start %w[help] }
+      expect(content).to match(/response_mate commands:/m)
+    end
+  end
+
+  let(:command) { double(run: 'yay') }
+
+  describe '#record' do
+    before do
+      allow(ResponseMate::Commands::Record).to receive(:new).and_return(command)
+    end
+
+    it 'initializes ResponseMate::Commands::Record' do
+      expect(ResponseMate::Commands::Record).to receive(:new)
+      capture(:stdout) { ResponseMate::CLI.start %w[record] }
+    end
+
+    it 'runs the command passing any given options, arguments' do
+      expect(command).to receive(:run)
+      capture(:stdout) { ResponseMate::CLI.start %w[record] }
+    end
+  end
+
+  describe'#inspect' do
+    before do
+      allow(ResponseMate::Commands::Inspect).to receive(:new).and_return(command)
+    end
+
+    it 'initializes ResponseMate::Commands::Inspect' do
+      expect(ResponseMate::Commands::Inspect).to receive(:new)
+      capture(:stdout) { ResponseMate::CLI.start %w[inspect] }
+    end
+
+    it 'runs the command passing any given options, arguments' do
+      expect(command).to receive(:run)
+      capture(:stdout) { ResponseMate::CLI.start %w[inspect] }
+    end
+  end
+
+  describe '#setup' do
+    before do
+      allow(ResponseMate::Commands::Setup).to receive(:new).and_return(command)
+    end
+
+    it 'initializes ResponseMate::Commands::setup' do
+      expect(ResponseMate::Commands::Setup).to receive(:new)
+      capture(:stdout) { ResponseMate::CLI.start %w[setup] }
+    end
+
+    it 'runs the command passing any given options, arguments' do
+      expect(command).to receive(:run)
+      capture(:stdout) { ResponseMate::CLI.start %w[setup] }
+    end
+  end
+
+  describe '#clear' do
+    before do
+      allow(ResponseMate::Commands::Clear).to receive(:new).and_return(command)
+    end
+
+    it 'initializes ResponseMate::Commands::Clear' do
+      expect(ResponseMate::Commands::Clear).to receive(:new)
+      capture(:stdout) { ResponseMate::CLI.start %w[clear] }
+    end
+
+    it 'runs the command passing any given options, arguments' do
+      expect(command).to receive(:run)
+      capture(:stdout) { ResponseMate::CLI.start %w[clear] }
+    end
+  end
+
+  describe '#list' do
+    before do
+      allow(ResponseMate::Commands::List).to receive(:new).and_return(command)
+    end
+
+    it 'initializes ResponseMate::Commands::List' do
+      expect(ResponseMate::Commands::List).to receive(:new)
+      capture(:stdout) { ResponseMate::CLI.start %w[list] }
+    end
+
+    it 'runs the command passing any given options, arguments' do
+      expect(command).to receive(:run)
+      capture(:stdout) { ResponseMate::CLI.start %w[list] }
+    end
+  end
+
+  describe '#export' do
+    before do
+      allow(ResponseMate::Commands::Export).to receive(:new).and_return(command)
+    end
+
+    it 'initializes ResponseMate::Commands::Export' do
+      expect(ResponseMate::Commands::Export).to receive(:new)
+      capture(:stdout) { ResponseMate::CLI.start %w[export] }
+    end
+
+    it 'runs the command passing any given options, arguments' do
+      expect(command).to receive(:run)
+      capture(:stdout) { ResponseMate::CLI.start %w[export] }
+    end
+  end
+end

data/spec/lib/response_mate/core_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe ResponseMate::Configuration do
+  describe '.initialize' do
+    let(:subject) { ResponseMate::Configuration.new }
+
+    it 'assigns @output_dir' do
+      expect(subject.output_dir).to be_present
+    end
+
+    it 'assigns @requests_manifest' do
+      expect(subject.requests_manifest).to be_present
+    end
+
+    it 'assigns @oauth_manifest' do
+      expect(subject.oauth_manifest).to be_present
+    end
+  end
+end
+
+describe ResponseMate do
+  describe '.setup' do
+    context '@configuration is nil' do
+      before { ResponseMate.configuration = nil }
+
+      it 'assigns @configuration to a new ResponseMate::Configuration' do
+        expect(ResponseMate::Configuration).to receive(:new)
+        ResponseMate.setup
+      end
+    end
+
+    context '@configuration is not nil' do
+      before { ResponseMate.configuration = ResponseMate::Configuration.new }
+
+      it 'does not assign @configuration to a new ResponseMate::Configuration' do
+        ResponseMate::Configuration.should_not_receive(:new)
+        ResponseMate.setup
+      end
+    end
+
+    describe 'configuration block' do
+      before do
+        ResponseMate.setup do |config|
+          config.output_dir        = 'foo'
+          config.requests_manifest = 'bar'
+          config.oauth_manifest    = 'koko'
+        end
+      end
+
+      after do
+        ResponseMate.setup do |config|
+          config.output_dir        = './output/responses/'
+          config.requests_manifest = './requests.yml.erb'
+          config.oauth_manifest    = './oauth.yml'
+        end
+      end
+
+      it 'properly assigns ivars' do
+        expect(ResponseMate.configuration.output_dir).to eq('foo')
+        expect(ResponseMate.configuration.requests_manifest).to eq('bar')
+        expect(ResponseMate.configuration.oauth_manifest).to eq('koko')
+      end
+    end
+  end
+end