rev-api 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NWVlMzlkMWQ4YzBjZjMxODVkYmM0YWU2NTVjMWNmYWNjOWIwNTUwMw==
+  data.tar.gz: !binary |-
+    N2EwOTUzY2E4MzQyODczOTIxYzI1NDU3NTY0NDQzMTNmNThlNDYzMQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZWM0ZDhhYzk4NjJhYjExMDk0NWQ0NTcwMmVjYjcwZWY5OGY1YmRkMGIzZjJl
+    NDE4ZjAxMTc0YTk1N2ViNDIyYjY1NzkwNzkwMjkwNTc2OGE0MmQzMmRlZTFl
+    ZmJjYzBlNTNmMmUzM2E1ZWFhN2E5NDY3ZTVhMjBmMjg3MGFkM2M=
+  data.tar.gz: !binary |-
+    Njk4OWM0OGYzZjNmNjI2NzMwNmZmNDM3NmVkMTkzNWIyY2FmMjBhMzYxMjA3
+    NmQ2OGE5ZjFlOTM5NmMxMzM4NmY4YzZlYmExYzllZDdkNzMxMWRiNjMyYWI0
+    NzQ5MDM5NzQ3NGFiMTgxMzA4NDM2OWZjZWE1MTE0ZjQzMTJiOTE=

data/.gitignore

@@ -0,0 +1,20 @@
+.DS_Store
+
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+doc
+
+# YARD artifacts
+.yardoc
+_yardoc

data/.ruby-gemset

@@ -0,0 +1 @@
+rev-sdk

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p448

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    rev-api (1.0.0)
+      httparty (>= 0.11.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    ansi (1.4.3)
+    crack (0.4.1)
+      safe_yaml (~> 0.9.0)
+    httparty (0.11.0)
+      multi_json (~> 1.0)
+      multi_xml (>= 0.5.2)
+    multi_json (1.8.0)
+    multi_xml (0.5.5)
+    rake (10.1.0)
+    redcarpet (3.0.0)
+    rubygems-tasks (0.2.4)
+    safe_yaml (0.9.5)
+    turn (0.9.6)
+      ansi
+    vcr (2.5.0)
+    webmock (1.11.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+    yard (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (>= 10.1.0)
+  redcarpet
+  rev-api!
+  rubygems-tasks
+  turn (~> 0.9.6)
+  vcr (~> 2.5.0)
+  webmock (~> 1.11.0)
+  yard

data/LICENSE

@@ -0,0 +1,191 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification within
+third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,124 @@
+rev-ruby-sdk
+------------
+
+### Background
+
+Rev.com provides transcription and translation services powered by humans. The Rev.com API allows you to tap these services
+with no manual steps. It's a RESTful API, documented at <http://www.rev.com/api/docs>.
+
+The Ruby SDK for the Rev API provides a convenient Ruby wrapper for the Rev.com API. All operations of the API, as described
+at <http://www.rev.com/api/operations>, are supported.
+
+### Install
+
+```shell
+gem install rev-api
+```
+
+or put it into your Gemfile.
+
+When you need it:
+
+```ruby
+require 'rev-api'
+```
+
+### Authentication
+
+If you are building a new API client, you must first obtain a client API key, which you can do at <http://www.rev.com/api>.
+
+All operations in the API are performed on behalf of a Rev customer, identified by their user API key. The client key / user
+key pair is used to authenticate each API operation. Once you have the two keys, you can create a new Rev.com API client:
+
+
+```ruby
+require 'rev-api'
+
+rev_client = Rev.new('your_client_key', 'your_user_key')
+```
+
+You can read more about authentication in the Rev.com API at <http://www.rev.com/api/security>
+
+### Sandbox
+
+All operations can be executed against either the production or the sandbox environment. The sandbox environment allows you
+to test your API client without actually paying for orders and having them worked on.
+
+By default, the Rev.com API client executes against the production environment. To go against the sandbox instead,
+initialize the client this way:
+
+```ruby
+require 'rev-api'
+
+rev_client = Rev.new('your_client_key', 'your_user_key', Rev::Api::SANDBOX_HOST)
+```
+
+### Usage
+
+The snippets below assume you've initialized `rev_client`:
+
+```ruby
+rev_client = Rev.new('your_client_key', 'your_user_key')
+```
+
+#### Listing orders
+
+```ruby
+orders_page = rev_client.get_orders_page(1); # get a single page of orders
+all_orders = rev_client.get_all_orders; # get first page of orders history
+```
+
+#### Get a single order by order number
+
+```ruby
+some_order = rev_client.get_order('TCxxxxxxxx')
+puts "Original comment: #{some_order.comments.first.text}"
+```
+
+#### Cancel an order given an order number
+
+```ruby
+rev_client.cancel_order('TCxxxxxxxx')
+```
+
+#### Print out the text of all transcripts in an order
+
+```ruby
+order = rev_client.get_order('TCxxxxxxx')
+
+order.transcripts.each do |t|
+	puts rev_client.get_attachment_content_as_string t.id
+	puts
+end
+```
+
+Refer to `cli.rb` in the `examples` directory for a full example illustrating placing orders, handling error responses, etc.
+
+### Documentation
+
+YARD documentation can be generated by running `rake yard` command, and will be placed in the `doc` directory.
+
+You can find API documentation at <http://www.rev.com/api/docs>.
+
+### Support
+
+If you have any questions or suggestions for improvement, email us directly at api[at]rev[dot]com.
+
+### Compatibility
+
+- MRI 1.9.3
+- MRI 2.0.0
+
+### Tests
+
+Minitest suite might be run using `rake test` command.
+Current stack:
+
+- minitest
+- webmock
+- vcr
+- turn
+
+### Dependencies
+
+- httparty

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rake/testtask'
+require 'yard'
+require 'rubygems/tasks'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['spec/lib/rev/*_spec.rb']
+  t.verbose = true
+end
+
+YARD::Rake::YardocTask.new 
+
+Gem::Tasks.new
+
+task :default => :test

data/examples/cli.rb

@@ -0,0 +1,200 @@
+require 'rev-api'
+require 'optparse'
+require 'pp'
+
+# An example app using the official Ruby SDK for the Rev.com API
+#   This ruby script sets up a basic command line interface (CLI)
+#   that prompts a user to authenticate on the web, then
+#   allows them to type commands to manipulate their orders.
+#
+# To start, run:
+# ruby examples/cli.rb --sandbox --client-key your_client_key --user-key your_user_key
+
+class RevCLI
+  COMMANDS = %w{help get list transcripts dl_transcripts dl_sources place cancel}
+
+  def initialize
+    options = { :environment => Rev::Api::PRODUCTION_HOST, :verbatim => false, :timestamps => false }
+    optparse = OptionParser.new do |opts|
+      opts.banner = "Usage: cli.rb [options]. You will be prompted for command then."
+
+      opts.on("--client-key CLIENT-KEY", "Use CLIENT-KEY as the API Client Key for Authorization") do |client_key|
+        options[:client_key] = client_key
+      end
+
+      opts.on("--user-key USER-KEY", "Use USER-KEY as the API User Key for Authorization") do |user_key|
+        options[:user_key] = user_key
+      end
+
+      opts.on("--sandbox", "Execute against the Sandbox environment rather than production") do
+        options[:environment] = Rev::Api::SANDBOX_HOST
+      end
+
+      opts.on("--[no-]verbatim", "Request verbatim transcription") do |v|
+        options[:verbatim] = v
+      end
+
+      opts.on("--[no-]timestamps", "Request timestamps transcription") do |t|
+        options[:timestamps] = t
+      end
+    end
+    optparse.parse!
+
+    raise OptionParser::MissingArgument, "--client-key" if options[:client_key].nil?
+    raise OptionParser::MissingArgument, "--user-key" if options[:user_key].nil?
+
+    @rev_client = Rev.new(options[:client_key], options[:user_key], options[:environment])
+  end
+
+  def command_loop
+    puts "Enter a command or 'help' or 'exit'"
+    command_line = ''
+
+    while command_line.strip != 'exit'
+      begin
+        execute_command(command_line)
+      rescue RuntimeError => e
+        puts "Command Line Error! #{e.class}: #{e}"
+        puts e.backtrace
+      end
+      print '> '
+      command_line = gets.strip
+    end
+
+    puts 'Goodbye!'
+    exit(0)
+  end
+
+  def execute_command(cmd_line)
+    command = cmd_line.split
+    method = command.first
+    if COMMANDS.include? method
+      begin
+        send(method.to_sym, command[1..-1])
+      rescue Rev::BadRequestError => e
+        puts "Server returned error with code #{e.code}, message #{e.message}"
+      rescue Rev::ApiError => e
+        puts "Server returned error with message #{e.message}"
+      end
+    elsif command.first && !command.first.strip.empty?
+      puts 'Invalid command. Type \'help\' to see commands.'
+    end
+  end
+
+  def get(args)
+    order_num = args[0]
+    order = @rev_client.get_order order_num
+    pp order
+  end
+
+  def list(args)
+    orders = @rev_client.get_all_orders
+    orders.each { |o| puts("#{o.order_number}") }
+
+    puts 'There are no orders placed so far.' if orders.empty?
+  end
+
+  def transcripts(args)
+    begin
+      order_num = args[0]
+      order = @rev_client.get_order order_num
+
+      if order.transcripts.empty?
+        puts "There are no transcripts for order #{order_num}"
+        return
+      end
+
+      order.transcripts.each do |t|
+        puts "Contents of #{t.name}"
+        puts "-----------------------------------"
+        puts @rev_client.get_attachment_content_as_string t.id
+        puts
+      end
+    rescue Rev::BadRequestError => e
+      puts "Displaying transcripts failed with error code #{e.code}, message #{e.message}"
+    end
+  end
+
+  def dl_transcripts(args)
+    begin
+      order_num = args[0]
+      order = @rev_client.get_order order_num
+
+      if order.transcripts.empty?
+        puts "There are no transcripts for order #{order_num}"
+        return
+      end
+
+      filenames = order.transcripts.map { |t| t.name}.join(',')
+      puts "Downloading files: #{filenames}"
+      order.transcripts.each do |t|
+        @rev_client.save_attachment_content t.id, t.name
+      end
+    rescue Rev::BadRequestError => e
+      puts "Downloading transcripts failed with error code #{e.code}, message #{e.message}"
+    end
+  end
+
+  def dl_sources(args)
+    begin
+      order_num = args[0]
+      order = @rev_client.get_order order_num
+
+      if order.sources.empty?
+        puts "There are no source files for order #{order_num}"
+        return
+      end
+
+      filenames = order.sources.map { |t| t.name }.join(',')
+      puts "Downloading files: #{filenames}"
+      order.sources.each do |t|
+        @rev_client.save_attachment_content t.id, t.name
+      end
+    rescue Rev::BadRequestError => e
+      puts "Downloading sources failed with error code #{e.code}, message #{e.message}"
+    end
+  end
+
+  def cancel(args)
+    begin
+      order_num = args[0]
+      @rev_client.cancel_order order_num
+      puts "Order #{order_num} cancelled"
+    rescue Rev::BadRequestError => e
+      puts "Cancelling order failed with error code #{e.code}, message #{e.message}"
+    end
+  end
+
+  def place(args)
+    input_urls = args.map do |f|
+      puts "Uploading #{f}"
+      @rev_client.upload_input(f, 'audio/mpeg')
+    end
+
+    payment = Rev::Payment.with_credit_card_on_file
+    inputs = input_urls.map { |url| Rev::Input.new(:uri => url, :audio_length => 3) }
+    tc_options = Rev::TranscriptionOptions.new(inputs)
+
+    request = Rev::OrderRequest.new(
+      payment,
+      :transcription_options => tc_options,
+      :client_ref => 'XB432423',
+      :comment => 'Please work quickly'
+    )
+
+    # act!
+    begin
+      new_order = @rev_client.submit_order(request)
+      puts "New order: #{new_order}"
+    rescue Rev::BadRequestError => e
+      puts "Order placement failed with error code #{e.code}, message #{e.message}"
+    end
+  end
+
+  def help(*args)
+    puts "commands are: #{COMMANDS.join(' ')} help exit"
+  end
+end
+
+cli = RevCLI.new
+cli.command_loop