response_mate 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93c14f8ebe00b8759584452bf612e52f105375e2
-  data.tar.gz: 090bffd16367fe10de84dbcdeefe298bdf9b4a9f
+  metadata.gz: 886ee91f9cc8611ed603ada2aba4256a34626d5e
+  data.tar.gz: a593e47b886bc4160c43453f03bf2fa8ff26da44
 SHA512:
-  metadata.gz: 05c4ddfbba025b2733c026e01e74ac173e7a7d5592c253dd1e925329929cc9942a513e76dfb403b1fc9eb77f777b8294fc5b01b7a739baebee3c84372ddfc1f3
-  data.tar.gz: bcb334033c8a5f880ae51aa1dbfb1ca1647ac91601b73ff1362241c2fba443339d3910c8a381d9f653740b5d6f2012c020eabb77e736d8b22a33ca5bd5f5c912
+  metadata.gz: c6d9ba046034288193fc61e786d27f7c16ef663b15bb62f5791a32a3b22bb10aa0aadbe387401c87382099d86b56cf7a71f1218d4c7b061c589fefd9d4a4bb15
+  data.tar.gz: 34339559073b743d0cd29e8cdf51521ce1548bd3fb386aacac329c8ab8616defc90668be9f8b91f00dda077b5ea7f75ae5ab8b541007e750e490ffa454270341

data/.rubocop.yml

@@ -1,3 +1,8 @@
+AllCops:
+  Exclude:
+    - Guardfile
+    - response_mate.gemspec
+
 Style/LineLength:
   Max: 120
 
@@ -29,3 +34,6 @@ Style/SpaceInsideBlockBraces:
 Style/Blocks:
   Exclude:
     - spec/**/*.rb
+
+Style/EachWithObject:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## Unreleased
+
+## [0.4.0] - 2015-08-19
+
+## Added
+
+* `record`, `inspect`, `list` commands accept `-e` option to specify the
+  environment file
+* Warning when a manifest contains no requests
+* ResponseMate::Environment#exists? to check if an environment file
+  exists
+* List command now accepts `-o` option to specify the output directory
+  of recordings
+
+## Changed
+
+* The verb key in the recorded response is now lower cased Symbol (was
+  upper case String)
+* Manifests are preprocessed as Mustache templates only if they are
+  identified as Mustache
+* ResponseMate::Manifest#requests_for_keys returns empty array for any
+  kind of blank input
+* ResponseMate::Manifest#parse becomes private
+* ResponseMate::Environment#parse does not exit when the file is missing
+* The default output directory for the recordings is the current working
+  directory (used to be `./output/responses/`)
+
+## Fixed
+
+* Exception handling for ManifestMissing, OutputDirError, KeysNotFound
+  in bin/response_mate
+
+## [0.3.3] - 2015-03-02
+
+### Changed
+
+* Force internal and external encoding to UTF-8

data/CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# Contributing
+
+If you discover issues, have ideas for improvements or new features,
+please report them to the [issue tracker][1] of the repository or
+submit a pull request. Please, try to follow these guidelines when you
+do so.
+
+## Issue reporting
+
+* Check that the issue has not already been reported.
+* Check that the issue has not already been fixed in the latest code
+  (a.k.a. `master`).
+* Be clear, concise and precise in your description of the problem.
+* Open an issue with a descriptive title and a summary in grammatically correct,
+  complete sentences.
+* Mention the version of the gem you are using.
+* Include any relevant code to the issue summary.
+
+## Pull requests
+
+* Read [how to properly contribute to open source projects on Github][2].
+* Fork the project.
+* Use a topic/feature branch to easily amend a pull request later, if necessary.
+* Comply with our [git style guide][3].
+* Use the same coding conventions as the rest of the project.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it
+  in a future version unintentionally.
+* Add an entry to the [Changelog](CHANGELOG.md) accordingly.
+* Make sure the test suite is passing and the code you wrote doesn't produce
+  RuboCop offenses.
+* [Squash related commits together][5].
+* Open a [pull request][4] that relates to *only* one subject with a clear title
+  and description in grammatically correct, complete sentences.
+
+This text is adapted from [rubocop - contributing](https://github.com/bbatsov/rubocop/blob/master/CONTRIBUTING.md)
+
+[1]: https://github.com/Zorbash/response_mate/issues
+[2]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request
+[3]: https://github.com/agis-/git-style-guide
+[4]: https://help.github.com/articles/using-pull-requests
+[5]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html

data/Gemfile

@@ -7,12 +7,11 @@ gem 'coveralls', require: false
 group :development, :test do
   gem 'pry-debugger', platforms: :mri_19
   gem 'pry-byebug', platforms: :mri_21
-  gem 'guard-rspec', require: false
   gem 'guard-rubocop', require: false
 end
 
 group :test do
-  gem 'rspec', '~> 2.14.0'
+  gem 'guard-rspec', require: false
   gem 'simplecov', '~> 0.9'
   gem 'fakeweb', '~> 1.2.8'
 end

data/Guardfile

@@ -10,7 +10,7 @@ guard 'rspec', rspec_options do
   watch(%r{^app/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
 end
 
-#guard :rubocop, all_on_start: false do
-  #watch(%r{.+\.rb$})
-  #watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0])  }
-#end
+guard :rubocop, all_on_start: false, cli: ['-D'] do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0])  }
+end

data/README.md

@@ -6,27 +6,36 @@
 [![Coverage Status](https://coveralls.io/repos/Zorbash/response_mate/badge.png?branch=master)](https://coveralls.io/r/Zorbash/response_mate?branch=master)
 [![Build Status](https://travis-ci.org/Zorbash/response_mate.svg)](https://travis-ci.org/Zorbash/response_mate)
 
-ResponseMate is a command line tool that aims to make inspecting and
-recording HTTP requests/responses. It is designed with APIs in mind.
+ResponseMate is a command line tool that helps inspecting and
+recording HTTP requests/responses from a terminal.
 
-It is a cli supplement/replacement of [postman](https://github.com/a85/POSTMan-Chrome-Extension)
+It is designed with APIs in mind.
 
 #### Install
 `gem install response_mate`
 
+## Commands
+
+* [record](#record)
+* [list](#list)
+* [inspect](#inspect)
+* [export](#export)
+* [version](#version)
+
 ## Usage
 
-For a list of available commands run `response_mate help`
+For a list of available commands run `response_mate help`  
 For help on a command run `response_mate help some_command`
 
-## Setup
-A specific directory structure must be present to store the recordings.
-To scaffold it do:
-`response_mate setup`
+## Requests Manifest
+
+Most ResponseMate's tasks depend on a manifest file where you declare
+the requests to be made.  
+The default filename of this manifest is `requests.yml`.  
+You may specify another file using the `-r` option.
+This file has to be in [YAML](http://yaml.org/) format (but keep in mind
+that JSON is a valid compatible subset of YAML).
 
-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`.
 
 Example:
 
@@ -44,30 +53,98 @@ requests:
       url: 'http://someapi.com/users/42/friends'
       params:
         since: 'childhood'
-        honest: '{{are_my_friends_host}}'
+        honest: '{{are_my_friends_honest}}'
+```
+
+Expressions inside `{{}}` will be evaluated as
+[Mustache templates](http://mustache.github.io/mustache.5.html) using values from a file 
+named `environment.yml`.
+
+You may specify a different location for the environment file using the
+`-e` option.
+
+Example:
+
+```shell
+response_mate inspect issues_show -e ./response_mate/production_environment.yml
+```
+
+If your requests manifest does not contain
+[Mustache](http://mustache.github.io/mustache.5.html) tags you don't
+need an environment file.
+
+
+## Environment File
+
+In this file (default location: `./environment.yml`) you may place
+variables to be used in the [requests manifest](#requests-manifest).
+Where applicable you may configure the location of the environment file
+using the `-e` option.
+
+Example
+
+```yaml
+response_mate record -e ./github/production_environment.yml
+```
+
+This file has to be in [YAML](http://yaml.org/) format (but keep in mind
+that JSON is a valid compatible subset of YAML).
+
+
+```yaml
+# environment.yml
+base_url: http://api.github.com
+repo: rails/rails
+```
+
+Then in the [requests manifest](#requests-manifest) any values of keys
+declared in the environment file can be used as follows.
+
+```yaml
+# requests.yml
+requests:
+  -
+    key: repos_show
+    url: {{base_url}}/repos/{{repo}}
 ```
-Expressions inside `{{}}` will be evaluated as Mustache templates using
-values from a file `environment.yml` that may be present.
 
 ## Record
-### Default
-Record all the keys of the requests manifest file being `requests.yml`
 
-`response_mate record`
+Records the responses of HTTP requests declared in a [requests
+manifest](#requests-manifest) file.
+
+```shell
+response_mate record
+```
 
-### Specific key(s)
+> By default responses are stored in the current working directory, but the
+output directory is configurable using the `-o` option.
 
-`response_mate record -k key1 key2`
+### Default Behavior
 
-### Specify a different request manifest
+Without any arguments / options it records all the keys of the [requests manifest](#requests-manifest).
 
-`response_mate record -r foo_api.yml`
+### Recording Specific Key(s)
 
-## Clear
+If you wish to record the responses of a subset of the declared requests
+in the [requests manifest](#requests-manifest), you may use the `-k`
+option. You have to provide a space separated list of keys to be recorded.
+
+```shell
+response_mate record -k key1 key2
+```
 
-Remove any existing recordings
+### Custom Manifest Location
 
-`response_mate clear`
+The requests are expected to be declared in a file named `requests.yml`
+in the current working directory.
+
+You may have many request files to use for various purposes.
+To specify the one to be used you may supply the `-r` option.
+
+```shell
+response_mate record -r github_api.yml
+```
 
 ## Inspect
 
@@ -77,37 +154,49 @@ Performs the request and displays the output without recording
 
 ## List
 
-Lists existing recordings
+Lists recording keys, prompting either to record or to inspect
 
 `response_mate list`
 
+Same as in the [record](#record) command you may specify the output
+directory using the `-o` option.
+
 ## Export
 
-Exports a requests manifest file to a different format
-(currently only postman is supported)
+Exports either the [requests manifest](#requests-manifest) or the environment file
+to a different format (currently only [postman](http://getpostman.com) is supported)
 
-`response_mate export`
+```
+response_mate export
+```
 
 ### Export in pretty json
 
-`response_mate export -f postman -p`
+```shell
+response_mate export -f postman -p
+```
 
-### Specify a different request manifest
+### Custom Manifest Location
 
-`response_mate export -f postman -r foo_api.yml`
+```shell
+response_mate export -f postman -r github_requests.yml
+```
 
-### Export the environment.yml
+### Export the Environment File
 
-`response_mate export --resource=environment`
+```shell
+response_mate export --resource=environment
+```
 
 ### Upload the exported and get a link
 
-`response_mate export --resource=environment --upload`
+```shell
+response_mate export --resource=environment --upload
+```
 
-# List of contributors
+## Version
 
-- [zorbash](https://github.com/zorbash)
-- [jimmikarily](https://github.com/jimmykarily)
+Displays the version
 
 # Licence
 Released under the MIT License. See the

data/Rakefile

@@ -6,7 +6,7 @@ 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']
+  spec.rspec_opts = ['--color', '--format documentation']
 end
 
 task default: :test

data/bin/response_mate

@@ -5,4 +5,21 @@ require 'response_mate'
 Encoding.default_internal = Encoding::UTF_8
 Encoding.default_external = Encoding::UTF_8
 
-ResponseMate::CLI.start(ARGV)
+# Exit codes try to follow sysexits(3)
+begin
+  ResponseMate::CLI.start(ARGV)
+rescue ResponseMate::ManifestMissing => e
+  puts ['The specified requests manifest '.red, e.message.underline, ' does not exist'.red].
+    join, 'You may specify a different requests manifest file using the "-r" option'
+
+  exit 66 # EX_NOINPUT
+rescue ResponseMate::OutputDirError => e
+  puts ['The specified output directory '.red, e.message.underline, ' does not exist'.red].
+    join, 'You may specify a different output directory using the "-o" option'
+
+  exit 66 # EX_NOINPUT
+rescue ResponseMate::KeysNotFound => e
+  puts "The following keys were not found: #{e.message.underline}".red
+
+  exit 65 # EX_DATAERR
+end

data/lib/response_mate.rb

@@ -1,5 +1,5 @@
 require 'thor'
-require 'colored'
+require 'colorize'
 require 'awesome_print'
 require 'active_support/all'
 require 'faraday'

data/lib/response_mate/cli.rb

@@ -6,19 +6,21 @@ module ResponseMate
     desc 'record', 'Perform requests and record their output'
     method_option :requests_manifest, aliases: '-r', banner:
       'requests.yml'
+    method_option :environment, aliases: '-e', banner:
+      'environment.yml'
     method_option :output_dir, aliases: '-o', type: :string, banner:
       './a_dir_to_place_the_recordings'
     method_option :keys, aliases: '-k', type: :array, default: [], banner:
       'key_to_record1 key_to_record2'
     def record
       ResponseMate::Commands::Record.new(args, options).run
-    rescue ResponseMate::KeysNotFound => e
-      puts "The requested keys: #{e.message} could not be found"
     end
 
     desc 'inspect [key1,key2]', 'Perform requests and print their output'
     method_option :requests_manifest, aliases: '-r', banner:
       'requests.yml'
+    method_option :environment, aliases: '-e', banner:
+      'environment.yml'
     def inspect(*keys) # rubocop:disable Lint/UnusedMethodArgument
       ResponseMate::Commands::Inspect.new(args, options).run
     end
@@ -26,6 +28,10 @@ module ResponseMate
     desc 'list', 'List available keys to record or inspect'
     method_option :requests_manifest, aliases: '-r', banner:
       'requests.yml'
+    method_option :environment, aliases: '-e', banner:
+      'environment.yml'
+    method_option :output_dir, aliases: '-o', type: :string, banner:
+      './a_dir_to_place_the_recordings'
     def list # rubocop:disable Lint/UnusedMethodArgument
       ResponseMate::Commands::List.new(args, options).run
     end
@@ -36,8 +42,6 @@ module ResponseMate
     end
     map ['--version'] => :version
 
-    default_task :version
-
     desc 'export', 'Export manifest or environment to one of the available formats'
     method_option :requests_manifest, aliases: '-r', banner:
       'requests.yml'