{"id":19554151,"url":"https://github.com/revdotcom/rev-ruby-sdk","last_synced_at":"2025-08-31T08:34:03.209Z","repository":{"id":10524490,"uuid":"12715399","full_name":"revdotcom/rev-ruby-sdk","owner":"revdotcom","description":"Ruby wrapper for Rev.com API","archived":false,"fork":false,"pushed_at":"2022-04-10T10:13:07.000Z","size":157,"stargazers_count":10,"open_issues_count":7,"forks_count":6,"subscribers_count":68,"default_branch":"develop","last_synced_at":"2025-04-26T21:33:55.308Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://www.rev.com/api/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/revdotcom.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-09-09T23:25:59.000Z","updated_at":"2023-06-29T09:22:39.000Z","dependencies_parsed_at":"2022-08-30T17:12:01.132Z","dependency_job_id":null,"html_url":"https://github.com/revdotcom/rev-ruby-sdk","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/revdotcom/rev-ruby-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revdotcom%2Frev-ruby-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revdotcom%2Frev-ruby-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revdotcom%2Frev-ruby-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revdotcom%2Frev-ruby-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/revdotcom","download_url":"https://codeload.github.com/revdotcom/rev-ruby-sdk/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revdotcom%2Frev-ruby-sdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272958517,"owners_count":25022051,"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","status":"online","status_checked_at":"2025-08-31T02:00:09.071Z","response_time":79,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-11T04:26:05.837Z","updated_at":"2025-08-31T08:34:03.193Z","avatar_url":"https://github.com/revdotcom.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Gem Version](https://badge.fury.io/rb/rev-api.png)](http://badge.fury.io/rb/rev-api)\n[![Build Status](https://secure.travis-ci.org/revdotcom/rev-ruby-sdk.png?branch=master)](https://secure.travis-ci.org/revdotcom/rev-ruby-sdk)\n[![Dependency Status](https://gemnasium.com/revdotcom/rev-ruby-sdk.png?travis)](https://gemnasium.com/revdotcom/rev-ruby-sdk)\n[![Code Climate](https://codeclimate.com/github/revdotcom/rev-ruby-sdk.png)](https://codeclimate.com/github/revdotcom/rev-ruby-sdk)\n\n[Reference](https://www.rev.com/api/docs) | [RDocs](http://rubydoc.info/github/revdotcom/rev-ruby-sdk/master/frames)\n\nrev-ruby-sdk\n------------\n\n### Background\n\nRev.com provides transcription, caption and translation services powered by humans. The Rev.com API allows you to tap transcription\nand caption services with no manual steps. It's a RESTful API, documented at \u003chttps://www.rev.com/api/docs\u003e.\n\nThe Ruby SDK for the Rev API provides a convenient Ruby wrapper for the Rev.com API. All operations of the API, as described\nat \u003chttps://www.rev.com/api/operations\u003e, are supported.\n\n### Install\n\n```shell\ngem install rev-api\n```\n\nor put it into your Gemfile.\n\nWhen you need it:\n\n```ruby\nrequire 'rev-api'\n```\n\n### Authentication\n\nIf you are building a new API client, you must first obtain a client API key, which you can do at \u003chttps://www.rev.com/api\u003e.\n\nAll operations in the API are performed on behalf of a Rev customer, identified by their user API key. The client key / user\nkey pair is used to authenticate each API operation. Once you have the two keys, you can create a new Rev.com API client:\n\n\n```ruby\nrequire 'rev-api'\n\nrev_client = Rev.new('your_client_key', 'your_user_key')\n```\n\nYou can read more about authentication in the Rev.com API at \u003chttps://www.rev.com/api/security\u003e\n\n### Sandbox\n\nAll operations can be executed against either the production or the sandbox environment. The sandbox environment allows you\nto test your API client without actually paying for orders and having them worked on.\n\nBy default, the Rev.com API client executes against the production environment. To go against the sandbox instead,\ninitialize the client this way:\n\n```ruby\nrequire 'rev-api'\n\nrev_client = Rev.new('your_client_key', 'your_user_key', Rev::Api::SANDBOX_HOST)\n```\n\n### Usage\n\nThe snippets below assume you've initialized `rev_client`:\n\n```ruby\nrev_client = Rev.new('your_client_key', 'your_user_key')\n```\n\n#### Listing orders\n\n```ruby\norders_page = rev_client.get_orders_page(1) # get a single page of orders\nall_orders = rev_client.get_all_orders # get first page of orders history\norders_by_client_ref = rev_client.get_orders_by_client_ref('some_ref') # get orders with reference id of 'some_ref'\n```\n\n#### Get a single order by order number\n\n```ruby\nsome_order = rev_client.get_order('TCxxxxxxxx')\nputs \"Original comment: #{some_order.comments.first.text}\"\n```\n\n#### Cancel an order given an order number\n\n```ruby\nrev_client.cancel_order('TCxxxxxxxx')\n```\n\n#### Print out the text of all transcripts in an order\n\n```ruby\norder = rev_client.get_order('TCxxxxxxx')\n\norder.transcripts.each do |t|\n\tputs rev_client.get_attachment_content_as_string t.id\n\tputs\nend\n```\n\nRefer to `cli.rb` in the `examples` directory for a full example illustrating placing orders, handling error responses, etc.\n\n### Documentation\n\n[YARD documentation](http://rubydoc.info/github/revdotcom/rev-ruby-sdk/master/frames) can be generated locally by running `rake yard` command, and will be placed in the `doc` directory.\n\nYou can find API documentation at \u003chttps://www.rev.com/api/docs\u003e.\n\n### Support\n\nIf you have any questions or suggestions for improvement, email us directly at api[at]rev[dot]com.\n\n### Compatibility\n\n- MRI 2.0.0\n\n### Tests\n\nMinitest suite might be run using `rake test` command.\nCurrent stack:\n\n- minitest\n- webmock\n- vcr\n- turn\n\n### Dependencies\n\n- httparty\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frevdotcom%2Frev-ruby-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frevdotcom%2Frev-ruby-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frevdotcom%2Frev-ruby-sdk/lists"}