response_mate 0.1.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzUyYjQzZWRjMjViY2FkOWNiNWNiZTBkZmNjYzVjOTEwYTQ5ODAyMA==
+  data.tar.gz: !binary |-
+    NDU1NjQxZTE1YjMzYzdiM2E5ZDZjOGUwOTVjMDNlZjFmZmY4M2IwZg==
+SHA512:
+  metadata.gz: !binary |-
+    OGY2ZmUyY2Q5YmZmMzI5YWEwYWFhMGJmYmQ3OGM0ZmI4OTVkYTBjNDM1MGI5
+    NDY3NDdiYTIzYjdjZTVmZjBhNGU0NTU0NzQyYTFhYTlkZDk4YTQ0MGEyNTlm
+    OWJmZGY3MTc3MzQ4OWFlZTZkMmNmMmMxNGYzNTI1OGEzOGVhMTg=
+  data.tar.gz: !binary |-
+    YmFiZjUxNjZkYTExODQ3ZGQyZTNjZmNkZGNkNWJkMThhMTc3Y2NhYzU5ZTFj
+    ODZjYmZhNDExNGVjZmQ0OTJiYzQ2OThhMjc5MjkzZTJmMjc0MjU2MGE4OGNm
+    OTI5ZTFkY2JmMjZlYjM5MjRmOTQzMTZiZmMyZjdhYzNlODk4NGM=

data/.gitignore

@@ -0,0 +1,15 @@
+coverage
+rdoc
+doc
+log
+pkg/*
+tmp
+.rvmrc
+.rbenv*
+
+output
+oauth.yml
+
+*.gem
+.bundle
+

data/.travis.yml

@@ -0,0 +1,10 @@
+---
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true
+script: bundle exec rake test

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'coveralls', require: false

data/Gemfile.lock

@@ -0,0 +1,107 @@
+PATH
+  remote: .
+  specs:
+    response_mate (0.1.0)
+      activesupport
+      addressable
+      awesome_print
+      colored
+      faraday
+      faraday_middleware
+      highline
+      mustache
+      thor (~> 0.18.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    ast (1.1.0)
+    atomic (1.1.14)
+    awesome_print (1.2.0)
+    coderay (1.0.9)
+    colored (1.2)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    diff-lcs (1.2.5)
+    docile (1.1.1)
+    fakefs (0.4.3)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    faraday_middleware (0.9.0)
+      faraday (>= 0.7.4, < 0.9)
+    highline (1.6.20)
+    i18n (0.6.9)
+    method_source (0.8.2)
+    mime-types (2.0)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    multipart-post (1.2.0)
+    mustache (0.99.5)
+    parser (2.1.1)
+      ast (~> 1.1)
+      slop (~> 3.4, >= 3.4.5)
+    powerpack (0.0.9)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-nav (0.2.3)
+      pry (~> 0.9.10)
+    pry-remote (0.1.7)
+      pry (~> 0.9)
+      slop (~> 3.0)
+    rainbow (1.99.0)
+    rake (10.1.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    rubocop (0.16.0)
+      parser (~> 2.1)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.1.4)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.4.6)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    tins (0.13.1)
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  coveralls
+  fakefs
+  pry
+  pry-nav
+  pry-remote
+  rake
+  response_mate!
+  rspec (~> 2.14)
+  rubocop

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Dimitris Zorbas / zorbash
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,107 @@
+## ResponseMate
+[![Build Status](https://travis-ci.org/Zorbash/response_mate.png?branch=master)](https://travis-ci.org/Zorbash/response_mate)
+[![Code Climate](https://codeclimate.com/github/Zorbash/response_mate.png)](https://codeclimate.com/github/Zorbash/response_mate)
+[![Dependencies tatus](https://gemnasium.com/Zorbash/response_mate.png)](https://gemnasium.com/Zorbash/response_mate)
+[[Coverage Status](https://coveralls.io/repos/Zorbash/response_mate/badge.png?branch=master)](https://coveralls.io/r/Zorbash/response_mate?branch=master)
+
+ResponseMate is a command line tool that aims to make inspecting and
+recording HTTP requests/responses. It is designed with APIs in mind.
+
+It is a cli supplement/replacement of [postman](https://github.com/a85/POSTMan-Chrome-Extension)
+
+#### Install
+`gem install response_mate`
+
+## Usage
+
+## Setup
+A specific directory structure must be present to store the recordings.
+To scaffold it do:
+`response_mate setup`
+
+ResponseMate's tasks heavily depend on a manifest file where you declare 
+the requests to be made. The default expected filename of this manifest
+is `requests.yml`.
+The expected format of this file is like [this](https://gist.github.com/anonymous/8055040)
+
+Example:
+
+```yaml
+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'
+
+```
+
+## Record
+### Default
+Record all the keys of the requests manifest file being `requests.yml`
+
+`response_mate record`
+
+### Specific key(s)
+
+`response_mate -k key1 key2`
+
+### Specify a different request manifest
+
+`response_mate -r foo_api.yml`
+
+### Specify a different base url for the requests
+
+`response_mate -b http://api.foo.com`
+
+## Clear
+
+Remove any existing recordings
+
+`response_mate clear`
+
+## List
+
+Lists existing recordings
+
+`response_mate list`
+
+## Export
+
+Exports a requests manifest file to a different format
+(currently only postman is supported)
+
+`response_mate export -f postman`
+
+### Export in pretty json
+
+`response_mate export -f postman -p`
+
+### Specify a different request manifest
+
+`response_mate export -f postman -r foo_api.yml`
+
+
+# List of contributors
+
+- [zorbash](https://github.com/zorbash)
+- [jimmikarily](https://github.com/jimmykarily)
+
+# Licence
+Released under the MIT License. See the
+[LICENSE](https://github.com/Zorbash/response_mate/blob/master/LICENSE) file
+for further details.
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/Zorbash/response_mate/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rspec/core/rake_task'
+
+desc 'Run RSpec'
+RSpec::Core::RakeTask.new(:test) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--color', '--format nested']
+end
+
+task :default => :test

data/bin/response_mate

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'response_mate'
+
+ResponseMate::CLI.start(ARGV)

data/environment.yml.sample

@@ -0,0 +1,4 @@
+foo: bar
+taco: kokomo
+duck: yellow
+pina: colada

data/lib/response_mate.rb

@@ -0,0 +1,43 @@
+# coding: utf-8
+require 'thor'
+require 'colored'
+require 'awesome_print'
+require 'active_support/all'
+require 'faraday'
+require 'faraday_middleware'
+require 'addressable/uri'
+require 'highline/import'
+require 'mustache'
+require 'ostruct'
+
+require 'response_mate/version'
+
+require 'response_mate/commands/base'
+
+# Load all commands
+Dir.glob(File.join(File.expand_path('..', __FILE__),
+  'response_mate/commands/*')).each(&method(:require))
+
+# Load all helpers
+Dir.glob(File.join(File.expand_path('..', __FILE__), 'response_mate/helpers/*')).each(&method(:require))
+
+require 'response_mate/manifest_parser'
+require 'response_mate/connection'
+require 'response_mate/http'
+require 'response_mate/core'
+require 'response_mate/request'
+require 'response_mate/environment'
+require 'response_mate/manifest'
+require 'response_mate/oauth'
+require 'response_mate/tape'
+require 'response_mate/recorder'
+require 'response_mate/inspector'
+require 'response_mate/cli'
+require 'response_mate/exporter'
+
+# Load all exporters
+require 'response_mate/exporters/postman'
+Dir.glob(File.join(File.expand_path('..', __FILE__),
+  'response_mate/exporters/*')).each(&method(:require))
+
+ResponseMate.setup

data/lib/response_mate/cli.rb

@@ -0,0 +1,58 @@
+# coding: utf-8
+
+module ResponseMate
+  class CLI < ::Thor
+    package_name 'response_mate'
+
+    desc 'Perform requests and records their output', 'Records'
+    method_option :base_url, aliases: '-b'
+    method_option :requests_manifest, aliases: '-r'
+    method_option :keys, aliases: '-k', type: :array
+    def record
+      ResponseMate::Commands::Record.new(args, options).run
+
+    rescue ResponseMate::OutputDirError
+      puts 'Output directory does not exist, invoking setup..'
+      puts 'Please retry after setup'
+      invoke :setup, []
+    end
+
+    desc 'Perform requests and prints their output', 'Records'
+    method_option :base_url, aliases: '-b'
+    method_option :requests_manifest, aliases: '-r'
+    method_option :interactive, type: :boolean, aliases: "-i"
+    method_option :print, type: :string, aliases: '-p', default: 'raw'
+    def inspect(*keys)
+      ResponseMate::Commands::Inspect.new(args, options).run
+    end
+
+    desc 'Initializes the required directory structure', 'Initializes'
+    def setup(output_dir = '')
+      ResponseMate::Commands::Setup.new(args, options).run
+    end
+
+    desc 'Deletes existing response files', 'Cleans up recordings'
+    def clear(output_dir = '')
+      ResponseMate::Commands::Clear.new(args, options).run
+    end
+
+    desc 'Lists available recordings or keys to record', 'Recording listing'
+    method_option :requests_manifest, aliases: '-r'
+    def list(type = 'requests')
+      ResponseMate::Commands::List.new(args, options).run
+
+    rescue ResponseMate::OutputDirError
+      puts 'Output directory does not exist, invoking setup..'
+      puts 'Please retry after setup'
+      invoke :setup, []
+    end
+
+    desc 'Exports to one of the available formats', 'Exports'
+    method_option :requests_manifest, aliases: '-r'
+    method_option :format, aliases: '-f'
+    method_option :pretty, aliases: '-p', default: false
+    def export
+      ResponseMate::Commands::Export.new(args, options).run
+    end
+  end
+end

data/lib/response_mate/commands.rb

@@ -0,0 +1 @@
+module ResponseMate::Commands; end

data/lib/response_mate/commands/base.rb

@@ -0,0 +1,12 @@
+module ResponseMate
+  module Commands
+    class Base
+      attr_accessor :args, :options
+
+      def initialize(args, options)
+        @args = args
+        @options = options.dup.symbolize_keys
+      end
+    end
+  end
+end

data/lib/response_mate/commands/clear.rb

@@ -0,0 +1,24 @@
+module ResponseMate
+  module Commands
+    # Handles the invocation of the clear command
+    class ResponseMate::Commands::Clear < Base
+      attr_accessor :output_dir
+
+      def initialize(args, options)
+        super(args, options)
+        @options = options.dup
+
+        @output_dir = if args.present?
+          args.first
+        else
+          ResponseMate.configuration.output_dir
+        end
+      end
+
+      def run
+        FileUtils.rm_rf(output_dir + '.')
+        puts "All clean and shiny!"
+      end
+    end
+  end
+end