{"id":18146569,"url":"https://github.com/zorbash/response_mate","last_synced_at":"2025-04-23T16:43:21.796Z","repository":{"id":12842837,"uuid":"15518458","full_name":"zorbash/response_mate","owner":"zorbash","description":"Cli tool to make inspecting and recording HTTP requests fun again","archived":false,"fork":false,"pushed_at":"2018-06-15T17:06:09.000Z","size":182,"stargazers_count":10,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-14T06:55:36.667Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zorbash.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-12-30T02:05:05.000Z","updated_at":"2018-06-15T17:06:11.000Z","dependencies_parsed_at":"2022-08-28T11:41:11.738Z","dependency_job_id":null,"html_url":"https://github.com/zorbash/response_mate","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zorbash%2Fresponse_mate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zorbash%2Fresponse_mate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zorbash%2Fresponse_mate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zorbash%2Fresponse_mate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zorbash","download_url":"https://codeload.github.com/zorbash/response_mate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250472108,"owners_count":21436081,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-01T21:08:16.851Z","updated_at":"2025-04-23T16:43:21.775Z","avatar_url":"https://github.com/zorbash.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"## ResponseMate\n\n[![Gem version](https://badge.fury.io/rb/response_mate.png)](http://badge.fury.io/rb/response_mate)\n[![Code Climate](https://codeclimate.com/github/Zorbash/response_mate.png)](https://codeclimate.com/github/Zorbash/response_mate)\n[![Coverage Status](https://coveralls.io/repos/Zorbash/response_mate/badge.png?branch=master)](https://coveralls.io/r/Zorbash/response_mate?branch=master)\n[![Build Status](https://travis-ci.org/Zorbash/response_mate.svg)](https://travis-ci.org/Zorbash/response_mate)\n\nResponseMate is a command line tool that helps inspecting and\nrecording HTTP requests/responses from a terminal.\n\nIt is designed with APIs in mind.\n\n#### Install\n`gem install response_mate`\n\n## Commands\n\n* [record](#record)\n* [list](#list)\n* [inspect](#inspect)\n* [export](#export)\n* [version](#version)\n\n## Usage\n\nFor a list of available commands run `response_mate help`  \nFor help on a command run `response_mate help some_command`\n\n## Requests Manifest\n\nMost ResponseMate's tasks depend on a manifest file where you declare\nthe requests to be made.  \nThe default filename of this manifest is `requests.yml`.  \nYou may specify another file using the `-r` option.\nThis file has to be in [YAML](http://yaml.org/) format (but keep in mind\nthat JSON is a valid compatible subset of YAML).\n\n\nExample:\n\n```yaml\ndefault_headers:\n  accept: 'application/vnd.{{app_name}}.beta+json'\nrequests:\n  -\n    key: user_issues\n    request:\n      url: 'http://someapi.com/users/42/issues'\n  -\n    key: user_friends\n    request:\n      url: 'http://someapi.com/users/42/friends'\n      params:\n        since: 'childhood'\n        honest: '{{are_my_friends_honest}}'\n```\n\nExpressions inside `{{}}` will be evaluated as\n[Mustache templates](http://mustache.github.io/mustache.5.html) using values from a file \nnamed `environment.yml`.\n\nYou may specify a different location for the environment file using the\n`-e` option.\n\nExample:\n\n```shell\nresponse_mate inspect issues_show -e ./response_mate/production_environment.yml\n```\n\nIf your requests manifest does not contain\n[Mustache](http://mustache.github.io/mustache.5.html) tags you don't\nneed an environment file.\n\n\n## Environment File\n\nIn this file (default location: `./environment.yml`) you may place\nvariables to be used in the [requests manifest](#requests-manifest).\nWhere applicable you may configure the location of the environment file\nusing the `-e` option.\n\nExample\n\n```yaml\nresponse_mate record -e ./github/production_environment.yml\n```\n\nThis file has to be in [YAML](http://yaml.org/) format (but keep in mind\nthat JSON is a valid compatible subset of YAML).\n\n\n```yaml\n# environment.yml\nbase_url: http://api.github.com\nrepo: rails/rails\n```\n\nThen in the [requests manifest](#requests-manifest) any values of keys\ndeclared in the environment file can be used as follows.\n\n```yaml\n# requests.yml\nrequests:\n  -\n    key: repos_show\n    url: {{base_url}}/repos/{{repo}}\n```\n\n## Record\n\nRecords the responses of HTTP requests declared in a [requests\nmanifest](#requests-manifest) file.\n\n```shell\nresponse_mate record\n```\n\n\u003e By default responses are stored in the current working directory, but the\noutput directory is configurable using the `-o` option.\n\n### Default Behavior\n\nWithout any arguments / options it records all the keys of the [requests manifest](#requests-manifest).\n\n### Recording Specific Key(s)\n\nIf you wish to record the responses of a subset of the declared requests\nin the [requests manifest](#requests-manifest), you may use the `-k`\noption. You have to provide a space separated list of keys to be recorded.\n\n```shell\nresponse_mate record -k key1 key2\n```\n\n### Custom Manifest Location\n\nThe requests are expected to be declared in a file named `requests.yml`\nin the current working directory.\n\nYou may have many request files to use for various purposes.\nTo specify the one to be used you may supply the `-r` option.\n\n```shell\nresponse_mate record -r github_api.yml\n```\n\n## Inspect\n\nPerforms the request and displays the output without recording\n\n`response_mate inspect some_key`\n\n## List\n\nLists recording keys, prompting either to record or to inspect\n\n`response_mate list`\n\nSame as in the [record](#record) command you may specify the output\ndirectory using the `-o` option.\n\n## Export\n\nExports either the [requests manifest](#requests-manifest) or the environment file\nto a different format (currently only [postman](http://getpostman.com) is supported)\n\n```\nresponse_mate export\n```\n\n### Export in pretty json\n\n```shell\nresponse_mate export -f postman -p\n```\n\n### Custom Manifest Location\n\n```shell\nresponse_mate export -f postman -r github_requests.yml\n```\n\n### Export the Environment File\n\n```shell\nresponse_mate export --resource=environment\n```\n\n### Upload the exported and get a link\n\n```shell\nresponse_mate export --resource=environment --upload\n```\n\n## Version\n\nDisplays the version\n\n# Licence\nReleased under the MIT License. See the\n[LICENSE](https://github.com/Zorbash/response_mate/blob/master/LICENSE) file\nfor further details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzorbash%2Fresponse_mate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzorbash%2Fresponse_mate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzorbash%2Fresponse_mate/lists"}