rev-api 1.0.3 → 1.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eaa50b9d9b8d001373ae19d4ae4e399ab21cb2e5
+  data.tar.gz: 8cb9bda20cd2cfca393614398dcc668ba1b6ebe2
+SHA512:
+  metadata.gz: 9bb0071290cbab2b0ba7000fe4465efc839d47af99ed4d9de0c18de23557563924d6a1d4b71e7f14266d39996fbac7edc50a32048472e9ed3a9694d23258843c
+  data.tar.gz: 24dd6b5479d6287d7886299e1ce5b770048f85f95eda4a885324a8168972515035641a7e4417ccfb45889a200963a46636a80f54e9865e747acbbebb09c18406

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    rev-api (1.0.2)
-      httparty (>= 0.11.0)
+    rev-api (1.0.4)
+      httparty (~> 0.11, >= 0.11.0)
 
 GEM
   remote: https://rubygems.org/
@@ -17,9 +17,10 @@ GEM
       thor
     crack (0.4.1)
       safe_yaml (~> 0.9.0)
-    httparty (0.11.0)
-      multi_json (~> 1.0)
+    httparty (0.13.1)
+      json (~> 1.8)
       multi_xml (>= 0.5.2)
+    json (1.8.1)
     mime-types (1.25)
     multi_json (1.8.0)
     multi_xml (0.5.5)
@@ -50,11 +51,11 @@ PLATFORMS
 
 DEPENDENCIES
   coveralls
-  rake (>= 10.1.0)
+  rake (~> 10.1, >= 10.1.0)
   redcarpet
   rev-api!
-  rubygems-tasks
-  turn (~> 0.9.6)
-  vcr (~> 2.6.0)
-  webmock (~> 1.11.0)
-  yard
+  rubygems-tasks (~> 0)
+  turn (~> 0.9.6, ~> 0.9)
+  vcr (~> 2.6.0, ~> 2.6)
+  webmock (~> 1.11.0, ~> 1.11)
+  yard (~> 0)

data/Rakefile

@@ -3,7 +3,7 @@ require 'yard'
 require 'rubygems/tasks'
 
 Rake::TestTask.new do |t|
-  t.test_files = FileList['spec/lib/rev/*_spec.rb']
+  t.test_files = FileList['spec/lib/rev/**/*_spec.rb']
   t.verbose = true
 end
 

data/examples/cli.rb

@@ -11,7 +11,7 @@ require 'pp'
 # 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}
+  COMMANDS = %w{help get list transcripts captions dl_transcripts dl_captions dl_sources place_tc place_cp cancel}
 
   def initialize
     options = { :environment => Rev::Api::PRODUCTION_HOST, :verbatim => false, :timestamps => false }
@@ -115,6 +115,27 @@ class RevCLI
     end
   end
 
+  def captions(args)
+    begin
+      order_num = args[0]
+      order = @rev_client.get_order order_num
+
+      if order.captions.empty?
+        puts "There are no captions for order #{order_num}"
+        return
+      end
+
+      order.captions.each do |t|
+        puts "Contents of #{t.name}"
+        puts "-----------------------------------"
+        puts @rev_client.get_attachment_content(t.id).body
+        puts
+      end
+    rescue Rev::BadRequestError => e
+      puts "Displaying captions failed with error code #{e.code}, message #{e.message}"
+    end
+  end
+
   def dl_transcripts(args)
     begin
       order_num = args[0]
@@ -135,6 +156,26 @@ class RevCLI
     end
   end
 
+  def dl_captions(args)
+    begin
+      order_num = args[0]
+      order = @rev_client.get_order order_num
+
+      if order.captions.empty?
+        puts "There are no captions for order #{order_num}"
+        return
+      end
+
+      filenames = order.captions.map { |t| t.name}.join(',')
+      puts "Downloading files: #{filenames}"
+      order.captions.each do |t|
+        @rev_client.save_attachment_content t.id, t.name
+      end
+    rescue Rev::BadRequestError => e
+      puts "Downloading captions failed with error code #{e.code}, message #{e.message}"
+    end
+  end
+
   def dl_sources(args)
     begin
       order_num = args[0]
@@ -165,24 +206,37 @@ class RevCLI
     end
   end
 
-  def place(args)
+  def place_tc(args)
+    inputs = upload(args, 'audio/mpeg')
+    tc_options = Rev::TranscriptionOptions.new(inputs)
+    place_helper(inputs, { :transcription_options => tc_options })
+  end
+
+  def place_cp(args)
+    inputs = upload(args, 'video/mpeg')
+    cp_options = Rev::CaptionOptions.new(inputs, {:output_file_formats => [Rev::CaptionOptions::OUTPUT_FILE_FORMATS[:scc]] })
+    place_helper(inputs, { :caption_options => cp_options })
+  end
+
+  def help(*args)
+    puts "commands are: #{COMMANDS.join(' ')} help exit"
+  end
+  
+  private
+  
+  def upload(args, type)
     input_urls = args.map do |f|
       puts "Uploading #{f}"
-      @rev_client.upload_input(f, 'audio/mpeg')
+      @rev_client.upload_input(f, type)
     end
-
+    input_urls.map { |url| Rev::Input.new(:uri => url, :audio_length => 3) }
+  end
+  
+  def place_helper(inputs, options)
     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)
+    options = options.merge({ :payment => payment, :client_ref => 'XB432423', :comment => 'Please work quickly' })
+    request = Rev::OrderRequest.new(payment, options)
 
-    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}"
@@ -190,10 +244,7 @@ class RevCLI
       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

data/lib/rev-api/exceptions.rb

@@ -53,8 +53,11 @@ module Rev
     # 10006 Input Location is not specified - neither of External Link and URI set for input media
     EXTERNAL_LINK_OR_URI_NOT_SPECIFIED = 10006
 
-    # 20001 Invalid Audio Length - If one of the input medias has a specified length that is not a positive integer
-    INVALID_AUDIO_LENGTH = 20001
+    # 20001 Invalid Media Length - If one of the input medias has a specified length that is not a positive integer
+    INVALID_MEDIA_LENGTH = 20001
+
+    # @deprecated Use {#OrderRequestErrorCodes.INVALID_MEDIA_LENGTH} instead
+    INVALID_AUDIO_LENGTH = INVALID_MEDIA_LENGTH
 
     # 20002 Invalid Word Count - word counts for translation are missing or inaccurate
     INVALID_WORD_COUNT = 20002

data/lib/rev-api/models/order.rb

@@ -1,14 +1,14 @@
 require 'rev-api/api_serializable'
 
 module Rev
-  # Represents Translation or Transcription order.
-  # Should have TranslationInfo or TranscriptionInfo, list
+  # Represents Translation, Caption, or Transcription order.
+  # Should have TranslationInfo, CaptionInfo, or TranscriptionInfo, list
   # of comments and attachments. Attributes names reflect
   # API exposed names, but occasional hyphens are replaced
   # with underscores
   class Order < ApiSerializable
     attr_reader :order_number, :price, :status, :attachments, :comments,
-      :translation, :transcription, :client_ref
+      :translation, :transcription, :caption, :client_ref
 
     # @param fields [Hash] hash of order fields parsed from JSON API response
     def initialize(fields)
@@ -17,6 +17,7 @@ module Rev
       @comments = fields['comments'].map { |comment_fields| Comment.new(comment_fields) }
       @translation = TranslationInfo.new(fields['translation']) if fields['translation']
       @transcription = TranscriptionInfo.new(fields['transcription']) if fields['transcription']
+      @caption = CaptionInfo.new(fields['caption']) if fields['caption']
     end
 
     # @return [Array of Attachment] with the kind of "transcript"
@@ -29,6 +30,11 @@ module Rev
       @attachments.select { |a| a.kind == Attachment::KINDS[:translation]}
     end
 
+    # @return [Array of Attachment] with the kind of "caption"
+    def captions
+      @attachments.select { |a| a.kind == Attachment::KINDS[:caption] }
+    end
+
     # @return [Array of Attachment] with the kind of "sources"
     def sources
       @attachments.select { |a| a.kind == Attachment::KINDS[:media]}
@@ -61,6 +67,11 @@ module Rev
   class TranscriptionInfo < ApiSerializable
     attr_reader :total_length, :verbatim, :timestamps
   end
+  
+  # Additional information specific to caption orders
+  class CaptionInfo < ApiSerializable
+    attr_reader :total_length
+  end
 
   # Represents order attachment - logical document associated with order
   class Attachment < ApiSerializable
@@ -69,17 +80,25 @@ module Rev
     KINDS = {
       :transcript => 'transcript',
       :translation => 'translation',
+      :caption => 'caption',
       :media => 'media'
     }
 
     # List of supported mime-types used to request attachment's content
     # within 'Accept' header
     REPRESENTATIONS = {
+      # Supported by :transcript and :translation
       :docx => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
       :doc => 'application/msword',
       :pdf => 'application/pdf',
       :txt => 'text/plain',
-      :youtube => 'text/plain; format=youtube-transcript'
+      :youtube => 'text/plain; format=youtube-transcript',
+      
+      # Supported by :caption
+      :srt => 'application/x-subrip',
+      :scc => 'text/x-scc',
+      :ttml => 'application/ttml+xml',
+      :qt => 'application/x-quicktime-timedtext'
     }
 
     # @param fields [Hash] fields of attachment fields parsed from JSON API response

data/lib/rev-api/models/order_request.rb

@@ -3,9 +3,9 @@ require 'rev-api/api_serializable'
 module Rev
   # OrderRequest is used for constructing order 'spec' in consumer code and passing it into.
   # It consists of three main elements: :payment, :transcription_options and :notification.
-  # You can also supply reference number and customer comment
+  # You can also supply priority, reference number, and customer comment
   #
-  # @note http://www.rev.com/api/ordersposttranscription, http://www.rev.com/api/ordersposttranslation
+  # @note http://www.rev.com/api/ordersposttranscription, http://www.rev.com/api/ordersposttranslation, http://www.rev.com/api/orderspostcaption
   class OrderRequest < ApiSerializable
     # see {Rev::Payment}
     attr_reader :payment
@@ -15,6 +15,9 @@ module Rev
 
     # see {Rev::TranslationOptions}
     attr_reader :translation_options
+    
+    # see {Rev::CaptionOptions}
+    attr_reader :caption_options
 
     # see {Rev::Notification}
     attr_reader :notification
@@ -24,10 +27,20 @@ module Rev
 
     # a comment with any special messages about the order (optional)
     attr_reader :comment
+    
+    # a requested priority for the order, defaults to normal (optional)
+    attr_reader :priority
+    
+    # use to correctly set priority
+    PRIORITY = {
+      :normal => 'Normal',
+      :time_insensitivie => 'TimeInsensitivie'
+    }
 
     # @param payment [Payment] payment info
     # @param fields [Hash] of fields to initialize instance. See instance attributes for available fields.
     def initialize(payment, fields = {})
+      fields = { :priority => PRIORITY[:normal] }.merge(fields)
       super fields
       @payment = payment
     end
@@ -84,23 +97,30 @@ module Rev
     attr_reader :number, :expiration_month, :expiration_year, :cardholder, :billing_address, :saved_id
   end
 
-  # Transcription options. This section contains the input media that must be transferred to our servers
-  # using a POST to /inputs, and are referenced using the URIs returned by that call. We also support external links.
-  # Following points explain usage of inputs:
-  # - For each input, you must provide either uri or external_link, but not both. If both or neither is provided,
-  #   error is returned.
-  # - You should only provide an external_link if it links to page where the media can be found, rather than directly to
-  #   the media file, and that we will not attempt to do anything with the link when the API call is made.
-  #   This is in contrast to when you post to /inputs with a link to a media file - in that case we do download the file.
-  #   So the external_link should only be used when you can't link to the media file directly.
-  # - The external_link can contain anything you want, but if it's a YouTube link, we will attempt to determine the
-  #   duration of the video on that page.
-  # We also allow users of the api to specify if translation should be done using our Verbatim option (:verbatim => true)
-  # and to specify if Time stamps should be included (:timestamps => true).
-  class TranscriptionOptions < ApiSerializable
-    # Mandatory, contains list of media to transcribe. Must have at least one element.
+  # Superclass for the business-line options that handles capture and common validation of inputs.
+  class InputOptions < ApiSerializable
+    # Mandatory, contains list of inputs. Must have at least one element.
     attr_reader :inputs
 
+    # @param inputs [Array] list of inputs
+    # @param info [Hash] of fields to initialize instance.
+    def initialize(inputs, info = {})
+      super info
+      raise(ArgumentError, "inputs must have at least one element") unless validate_inputs(inputs)
+      @inputs = inputs
+    end
+
+    private
+    
+    def validate_inputs(inputs)
+      !inputs.nil? && inputs.length > 0
+    end
+  end
+
+  # Transcription options. This section contains the input media that must be transferred to our servers
+  # using a POST to /inputs, and are referenced using the URIs returned by that call. We also support external links.
+  # @see http://www.rev.com/api/ordersposttranscription
+  class TranscriptionOptions < InputOptions
     # Optional, should we transcribe the provided files verbatim? If true,
     # all filler words (i.e. umm, huh) will be included.
     attr_reader :verbatim
@@ -113,8 +133,7 @@ module Rev
     #        - :verbatim => true/false
     #        - :timestams => true/false
     def initialize(inputs, info = {})
-      super info
-      @inputs = inputs
+      super inputs, info
     end
   end
 
@@ -122,10 +141,8 @@ module Rev
   # servers using a POST to /inputs, and are referenced using the URIs returned by that call.
   # For each media, word count must be specified. The language code for the source and desitination
   # languages must also be specified.
-  class TranslationOptions < ApiSerializable
-    # Mandatory, contains list of media to transcribe. Must have at least one element.
-    attr_reader :inputs
-
+  # @see http://www.rev.com/api/ordersposttranslation
+  class TranslationOptions < InputOptions
     # Mandatory, source language code
     attr_reader :source_language_code
 
@@ -138,8 +155,34 @@ module Rev
     #        - :destination_language_code
     # @note For language codes refer to http://www.loc.gov/standards/iso639-2/php/code_list.php
     def initialize(inputs, info = {})
-      super(info)
-      @inputs = inputs
+      super inputs, info
+    end
+  end
+  
+  # Caption options. This section contains the input media that must be transferred to our servers
+  # using a POST to /inputs, and are referenced using the URIs returned by that call. We also support external links.
+  # @see http://www.rev.com/api/orderspostcaption
+  class CaptionOptions < InputOptions
+    # Array of file formats the captions should be delivered as.  (Optional, default is SubRip)
+    attr_reader :output_file_formats
+
+    # All supported output file formats
+    OUTPUT_FILE_FORMATS = {
+      :subrip => 'SubRip',
+      :scc => 'Scc',
+      :ttml => 'Ttml',
+      :qttext => 'QTtext'
+    }
+    
+    def initialize(inputs, info = {})
+      super(inputs, info)
+      raise(ArgumentError, "invalid format(s)") unless validate_output_formats(info[:output_file_formats])
+    end
+    
+    private
+    
+    def validate_output_formats(formats)
+      formats.nil? || formats.select{|f| !OUTPUT_FILE_FORMATS.has_value?(f) }.empty?
     end
   end
 
@@ -149,11 +192,11 @@ module Rev
     attr_reader :word_length
 
     # Length of audio, in minutes (mandatory in case of inability to determine it automatically).
-    # Used within {Rev::OrderRequest::TranscriptionInfo}
+    # Used within {Rev::OrderRequest::TranscriptionInfo} and {Rev::OrderRequest::CaptionInfo}
     attr_reader :audio_length
 
     # Mandatory, URI of the media, as returned from the call to POST /inputs.
-    # :external_link might substitute :uri for Transcription.
+    # :external_link might substitute :uri for Transcription or Caption.
     attr_reader :uri
 
     # External URL, if sources wasn't POSTed as input (YouTube, Vimeo, Dropbox, etc)

data/lib/rev-api/version.rb

@@ -1,3 +1,3 @@
 module Rev
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 end

data/rev-api.gemspec

@@ -19,15 +19,15 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = [ "lib", "spec" ]
 
-  s.add_runtime_dependency('httparty', '>= 0.11.0')
+  s.add_runtime_dependency('httparty', '~> 0.11', '>= 0.11.0')
 
-  s.add_development_dependency('webmock', '~> 1.11.0')
-  s.add_development_dependency('vcr', '~> 2.6.0')
-  s.add_development_dependency('turn', '~> 0.9.6')
-  s.add_development_dependency('rake', '>= 10.1.0')
-  s.add_development_dependency('yard')
+  s.add_development_dependency('webmock', '~> 1.11', '~> 1.11.0')
+  s.add_development_dependency('vcr', '~> 2.6', '~> 2.6.0')
+  s.add_development_dependency('turn', '~> 0.9', '~> 0.9.6')
+  s.add_development_dependency('rake', '~> 10.1', '>= 10.1.0')
+  s.add_development_dependency('yard', '~> 0')
   s.add_development_dependency('redcarpet')
-  s.add_development_dependency('rubygems-tasks')
+  s.add_development_dependency('rubygems-tasks', '~> 0')
 
   s.has_rdoc = 'yard'
 end

data/spec/fixtures/api_cassettes/submit_cp_order.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://www.revtrunk.com/api/v1/orders
+    body:
+      encoding: UTF-8
+      string: ! '{"payment":{"type":"AccountBalance","credit_card":null},"caption_options":{"inputs":[{"external_link":"http://www.youtube.com/watch?v=UF8uR6Z6KLc"},{"audio_length":15,"external_link":"https://vimeo.com/7976699"}],"output_file_formats":["SubRip"]},"client_ref":"XB432423","comment":"Please
+        work quickly"}'
+    headers:
+      Content-Type:
+      - application/json
+      Authorization:
+      - Rev welcome:AAAAAu/YjZ3phXU5FsF35yIcgiA=
+      User-Agent:
+      - RevOfficialRubySDK/1.0.0
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Cache-Control:
+      - no-cache
+      Pragma:
+      - no-cache
+      Expires:
+      - '-1'
+      Location:
+      - https://www.revtrunk.com/api/v1/orders/CP12345
+      Server:
+      - Microsoft-IIS/7.5
+      X-Miniprofiler-Ids:
+      - ! '["43bcb320-a1c9-4e9f-96c1-320e01a31549","ad8a37cd-e5ea-4134-ac9e-0390f722d6f6"]'
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Wed, 18 Sep 2013 00:21:27 GMT
+      Content-Length:
+      - '0'
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version:
+  recorded_at: Wed, 18 Sep 2013 00:21:27 GMT
+recorded_with: VCR 2.5.0

data/spec/lib/rev/exceptions_spec.rb

@@ -0,0 +1,8 @@
+require_relative '../../spec_helper'
+
+describe 'Exceptions' do
+  it 'has INVALID_MEDIA_LENGTH' do
+    Rev::OrderRequestErrorCodes::INVALID_MEDIA_LENGTH.must_equal Rev::OrderRequestErrorCodes::INVALID_AUDIO_LENGTH
+  end
+end
+

data/spec/lib/rev/models/order_request_spec.rb

@@ -0,0 +1,93 @@
+require_relative '../../../spec_helper'
+
+describe 'OrderRequest' do
+  
+  it 'has normal priority' do
+    Rev::OrderRequest::PRIORITY[:normal].must_equal 'Normal'
+  end
+
+  it 'has time insensitivie priority' do
+    Rev::OrderRequest::PRIORITY[:time_insensitivie].must_equal 'TimeInsensitivie'
+  end
+
+  it 'defaults to normal priority' do
+    order = Rev::OrderRequest.new(Rev::Payment.with_credit_card_on_file, {})
+    order.priority.must_equal Rev::OrderRequest::PRIORITY[:normal]
+  end
+  
+  it 'accepts priority during init' do
+    priority = Rev::OrderRequest::PRIORITY[:time_insensitivie]
+    order = Rev::OrderRequest.new(Rev::Payment.with_credit_card_on_file, { 'priority' => priority })
+    order.priority.must_equal priority
+  end
+  
+  it 'has caption options' do
+    order = Rev::OrderRequest.new(Rev::Payment.with_credit_card_on_file, {})
+    order.must_respond_to :caption_options
+  end
+  
+  describe 'InputOptions' do
+    it 'is ApiSerializable' do
+      options = Rev::InputOptions.new([{}], {})
+      options.must_be_kind_of Rev::ApiSerializable
+    end
+    
+    it 'requires non-empty inputs' do
+      proc { Rev::InputOptions.new([]) }.must_raise ArgumentError
+    end
+
+    it 'requires non-nil inputs' do
+      proc { Rev::InputOptions.new(nil) }.must_raise ArgumentError
+    end
+    
+    it 'sets inputs from init' do
+      inputs = ['foo']
+      options = Rev::InputOptions.new(inputs)
+      options.inputs.must_equal inputs
+    end
+  end
+  
+  describe 'TranscriptionOptions' do
+    it 'is InputOptions' do
+      options = Rev::TranscriptionOptions.new([{}], {})
+      options.must_be_kind_of Rev::InputOptions
+    end
+  end
+
+  describe 'TranslationOptions' do
+    it 'is InputOptions' do
+      options = Rev::TranslationOptions.new([{}], {})
+      options.must_be_kind_of Rev::InputOptions
+    end
+  end
+
+  describe 'CaptionOptions' do
+    it 'is InputOptions' do
+      options = Rev::CaptionOptions.new([{}], {})
+      options.must_be_kind_of Rev::InputOptions
+    end
+    
+    it 'has output file formats attribute' do
+      options = Rev::CaptionOptions.new([{}], {})
+      options.must_respond_to :output_file_formats
+    end
+    
+    it 'has output file formats hash' do
+      Rev::CaptionOptions::OUTPUT_FILE_FORMATS[:subrip].must_equal 'SubRip'
+      Rev::CaptionOptions::OUTPUT_FILE_FORMATS[:scc].must_equal 'Scc'
+      Rev::CaptionOptions::OUTPUT_FILE_FORMATS[:ttml].must_equal 'Ttml'
+      Rev::CaptionOptions::OUTPUT_FILE_FORMATS[:qttext].must_equal 'QTtext'
+    end
+    
+    it 'rejects unknowns file formats' do
+      proc { Rev::CaptionOptions.new([{}], { :output_file_formats => ['invalid'] }) }.must_raise ArgumentError      
+    end
+    
+    it 'accepts valid file formats' do
+      order = Rev::CaptionOptions.new([{}], { :output_file_formats => [Rev::CaptionOptions::OUTPUT_FILE_FORMATS[:scc]] })
+      order.output_file_formats.length.must_equal 1
+      order.output_file_formats[0].must_equal Rev::CaptionOptions::OUTPUT_FILE_FORMATS[:scc];
+    end
+  end # CaptionOptions
+end
+

data/spec/lib/rev/models/order_spec.rb

@@ -0,0 +1,58 @@
+require_relative '../../../spec_helper'
+
+describe 'Order' do
+  let(:cp_order) { 
+    Rev::Order.new (
+      { 'attachments' => { },
+        'comments' => {},
+        'caption' => { 'total_length' => 5 }
+      }
+    )
+  }
+  
+  it 'has caption info' do
+    assert_respond_to cp_order, 'caption'
+  end
+
+  it 'parses caption info' do
+    assert_kind_of Rev::CaptionInfo, cp_order.caption
+  end
+  
+  it 'has captions attachments' do
+    assert_respond_to cp_order, 'captions'
+  end
+  
+  describe 'Attachments' do
+    describe 'REPRESENTATIONS' do
+      it 'has srt' do
+        Rev::Attachment::REPRESENTATIONS[:srt].must_equal 'application/x-subrip'
+      end
+
+      it 'has scc' do
+        Rev::Attachment::REPRESENTATIONS[:scc].must_equal 'text/x-scc'
+      end
+
+      it 'has ttml' do
+        Rev::Attachment::REPRESENTATIONS[:ttml].must_equal 'application/ttml+xml'
+      end
+
+      it 'has qt' do
+        Rev::Attachment::REPRESENTATIONS[:qt].must_equal 'application/x-quicktime-timedtext'
+      end
+    end
+  
+    describe 'KINDS' do
+      it 'has caption' do
+        Rev::Attachment::KINDS[:caption].must_equal 'caption'
+      end
+    end
+  end # Attachments
+  
+  describe 'CaptionInfo' do
+    it 'has total_length' do
+      info = Rev::CaptionInfo.new({})
+      assert_respond_to info, 'total_length'
+    end
+  end # CaptionInfo
+end
+

data/spec/lib/rev/post_order_spec.rb

@@ -32,10 +32,17 @@ describe 'POST /orders' do
     inputs = []
     inputs << Rev::Input.new(:word_length => 1000, :uri => 'urn:foxtranslate:inputmedia:SnVwbG9hZHMvMjAxMy0wOS0xNy9lMzk4MWIzNS0wNzM1LTRlMDAtODY1NC1jNWY4ZjE4MzdlMTIvc291cmNlZG9jdW1lbnQucG5n')
   }
+  let(:caption_inputs) {
+    inputs = []
+    inputs << Rev::Input.new(:external_link => 'http://www.youtube.com/watch?v=UF8uR6Z6KLc')
+  }
   let(:transcription_options) { Rev::TranscriptionOptions.new(transcription_inputs,
     :verbatim => true, :timestamps => true) }
   let(:translation_options) { Rev::TranslationOptions.new(translation_inputs,
     :source_language_code => 'es', :destination_language_code => 'en') }
+  let(:caption_options) {
+    Rev::CaptionOptions.new(caption_inputs, :output_file_formats => ['SubRip'])
+  }
 
   it 'must submit order using Credit Card including all attributes' do
     VCR.insert_cassette 'submit_tc_order_with_cc_and_all_attributes'
@@ -79,6 +86,7 @@ describe 'POST /orders' do
       },
       'client_ref' => 'XB432423',
       'comment' => 'Please work quickly',
+      'priority' => Rev::OrderRequest::PRIORITY[:normal],
       'notification' => {
         'url' => 'http://www.example.com',
         'level' => 'Detailed'
@@ -109,6 +117,7 @@ describe 'POST /orders' do
           'saved_id' => 1
         }
       },
+      'priority' => Rev::OrderRequest::PRIORITY[:normal],
       'transcription_options' => {
         'inputs' => [
           { 'external_link' => 'http://www.youtube.com/watch?v=UF8uR6Z6KLc' },
@@ -140,6 +149,7 @@ describe 'POST /orders' do
       'payment' => {
         'type' => 'AccountBalance'
       },
+      'priority' => Rev::OrderRequest::PRIORITY[:normal],
       'transcription_options' => {
         'inputs' => [
           { 'external_link' => 'http://www.youtube.com/watch?v=UF8uR6Z6KLc' },
@@ -170,7 +180,7 @@ describe 'POST /orders' do
     exception.code.must_equal Rev::OrderRequestErrorCodes::TC_OR_TR_OPTIONS_NOT_SPECIFIED
   end
 
-  it 'must submit translation order with translation options' do
+  it 'must submit translation order with options' do
     VCR.insert_cassette 'submit_tr_order'
 
     request = Rev::OrderRequest.new(
@@ -185,6 +195,7 @@ describe 'POST /orders' do
       'payment' => {
         'type' => 'AccountBalance'
       },
+      'priority' => Rev::OrderRequest::PRIORITY[:normal],
       'translation_options' => {
         'inputs'=> [
           { 'word_length' => 1000, 'uri' => 'urn:foxtranslate:inputmedia:SnVwbG9hZHMvMjAxMy0wOS0xNy9lMzk4MWIzNS0wNzM1LTRlMDAtODY1NC1jNWY4ZjE4MzdlMTIvc291cmNlZG9jdW1lbnQucG5n' },
@@ -199,6 +210,33 @@ describe 'POST /orders' do
       actual_body.must_equal expected_body
     end
   end
+  
+  it 'must submit caption order with options' do
+    VCR.insert_cassette 'submit_cp_order'
+    
+    request = Rev::OrderRequest.new(balance_payment, :caption_options => caption_options)
+    
+    new_order_num = client.submit_order(request)
+    
+    new_order_num.must_equal 'CP12345'
+    expected_body = {
+      'payment' => {
+        'type' => 'AccountBalance'
+      },
+      'priority' => Rev::OrderRequest::PRIORITY[:normal],
+      'caption_options' => {
+        'inputs'=> [
+          { 'external_link' => 'http://www.youtube.com/watch?v=UF8uR6Z6KLc' }
+        ],
+        'output_file_formats' => [Rev::CaptionOptions::OUTPUT_FILE_FORMATS[:subrip]]
+      }
+    }
+    assert_requested(:post, /.*\/orders/, :times => 1) do |req|
+      req.headers['Content-Type'] == 'application/json'
+      actual_body = JSON.load req.body
+      actual_body.must_equal expected_body
+    end
+  end
 
   after do
     VCR.eject_cassette

metadata

@@ -1,142 +1,155 @@
 --- !ruby/object:Gem::Specification
 name: rev-api
 version: !ruby/object:Gem::Version
-  version: 1.0.3
-  prerelease: 
+  version: 1.0.4
 platform: ruby
 authors:
 - Rev.com, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-12 00:00:00.000000000 Z
+date: 2014-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.11.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: turn
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.6
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+    - - '>='
       - !ruby/object:Gem::Version
         version: 10.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+    - - '>='
       - !ruby/object:Gem::Version
         version: 10.1.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rubygems-tasks
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
 description: Communicate with Rev.com API using plain Ruby objects without bothering
@@ -183,6 +196,7 @@ files:
 - spec/fixtures/api_cassettes/link_input.yml
 - spec/fixtures/api_cassettes/link_input_with_all_attributes.yml
 - spec/fixtures/api_cassettes/not_found_order.yml
+- spec/fixtures/api_cassettes/submit_cp_order.yml
 - spec/fixtures/api_cassettes/submit_tc_order_with_account_balance.yml
 - spec/fixtures/api_cassettes/submit_tc_order_with_cc_and_all_attributes.yml
 - spec/fixtures/api_cassettes/submit_tc_order_with_invalid_request.yml
@@ -194,39 +208,41 @@ files:
 - spec/fixtures/sourcedocument.png
 - spec/lib/rev/api_spec.rb
 - spec/lib/rev/cancel_order_spec.rb
+- spec/lib/rev/exceptions_spec.rb
 - spec/lib/rev/get_attachment_content_spec.rb
 - spec/lib/rev/get_attachment_metadata_spec.rb
 - spec/lib/rev/get_order_spec.rb
 - spec/lib/rev/get_orders_spec.rb
 - spec/lib/rev/http_client_spec.rb
+- spec/lib/rev/models/order_request_spec.rb
+- spec/lib/rev/models/order_spec.rb
 - spec/lib/rev/post_inputs_spec.rb
 - spec/lib/rev/post_order_spec.rb
 - spec/spec_helper.rb
 homepage: http://www.rev.com/api
 licenses:
 - Apache License 2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 - spec
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby wrapper for Rev.com API
 test_files:
 - spec/fixtures/api_cassettes/cancel_order.yml
@@ -246,6 +262,7 @@ test_files:
 - spec/fixtures/api_cassettes/link_input.yml
 - spec/fixtures/api_cassettes/link_input_with_all_attributes.yml
 - spec/fixtures/api_cassettes/not_found_order.yml
+- spec/fixtures/api_cassettes/submit_cp_order.yml
 - spec/fixtures/api_cassettes/submit_tc_order_with_account_balance.yml
 - spec/fixtures/api_cassettes/submit_tc_order_with_cc_and_all_attributes.yml
 - spec/fixtures/api_cassettes/submit_tc_order_with_invalid_request.yml
@@ -257,11 +274,15 @@ test_files:
 - spec/fixtures/sourcedocument.png
 - spec/lib/rev/api_spec.rb
 - spec/lib/rev/cancel_order_spec.rb
+- spec/lib/rev/exceptions_spec.rb
 - spec/lib/rev/get_attachment_content_spec.rb
 - spec/lib/rev/get_attachment_metadata_spec.rb
 - spec/lib/rev/get_order_spec.rb
 - spec/lib/rev/get_orders_spec.rb
 - spec/lib/rev/http_client_spec.rb
+- spec/lib/rev/models/order_request_spec.rb
+- spec/lib/rev/models/order_spec.rb
 - spec/lib/rev/post_inputs_spec.rb
 - spec/lib/rev/post_order_spec.rb
 - spec/spec_helper.rb
+has_rdoc: yard