rev-api 2.2.0 → 2.4.0

data/spec/lib/rev/post_order_spec.rb

@@ -1,195 +1,163 @@
-require_relative '../../spec_helper'
-
-describe 'POST /orders' do
-  let(:client) { Rev.new('welcome', 'AAAAAu/YjZ3phXU5FsF35yIcgiA=', 'www.revtrunk.com') }
-
-  # some defaults we use often
-  let(:billing_address) { Rev::BillingAddress.new(
-    :street => '123 Pine Lane',
-    :street2 => 'Apt D',
-    :city => 'MyTown',
-    :state => 'MN',
-    :zip => '12345',
-    :country_alpha2 => 'US'
-  )}
-
-  let(:balance_payment) { Rev::Payment.new(Rev::Payment::TYPES[:account_balance]) }
-  let(:transcription_inputs) {
-      inputs = []
-      inputs << Rev::Input.new(:external_link => 'http://www.youtube.com/watch?v=UF8uR6Z6KLc')
-      inputs << Rev::Input.new(:audio_length_seconds => 900, :external_link => 'https://vimeo.com/7976699')
-  }
-  let(:translation_inputs) {
-    inputs = []
-    inputs << Rev::Input.new(:word_length => 1000, :uri => 'urn:rev:inputmedia:SnVwbG9hZHMvMjAxMy0wOS0xNy9lMzk4MWIzNS0wNzM1LTRlMDAtODY1NC1jNWY4ZjE4MzdlMTIvc291cmNlZG9jdW1lbnQucG5n')
-  }
-  let(:caption_inputs) {
-    inputs = []
-    inputs << Rev::Input.new(:video_length_seconds => 900, :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'])
-  }
-  let(:subtitle_options) {
-    Rev::CaptionOptions.new(caption_inputs, :subtitle_languages => ['es','it'],
-    :output_file_formats => ['SubRip'])
-  }
-
-  it 'must place order using account balance' do
-    VCR.insert_cassette 'submit_tc_order_with_account_balance'
-
-    request = Rev::OrderRequest.new(
-      :transcription_options => transcription_options
-    )
-
-    new_order_num = client.submit_order(request)
-
-    new_order_num.must_equal 'TC0406615008'
-    expected_body = {
-      'payment' => {
-        'type' => 'AccountBalance'
-      },
-      'non_standard_tat_guarantee' => false,
-      'transcription_options' => {
-        'inputs' => [
-          { 'external_link' => 'http://www.youtube.com/watch?v=UF8uR6Z6KLc' },
-          { 'external_link' => 'https://vimeo.com/7976699', 'audio_length_seconds' => 900 }
-        ],
-        'verbatim' => true,
-        'timestamps' => true
-      }
-    }
-    assert_order_placement_success(expected_body)
-  end
-
-  it 'must default to account balance if payment property not set' do
-    VCR.insert_cassette 'submit_tc_order_without_specifying_payment'
-
-    request = Rev::OrderRequest.new(
-        :transcription_options => transcription_options
-    )
-
-    new_order_num = client.submit_order(request)
-
-    new_order_num.must_equal 'TC0406615008'
-    expected_body = {
-        'payment' => {
-            'type' => 'AccountBalance'
-        },
-        'non_standard_tat_guarantee' => false,
-        'transcription_options' => {
-            'inputs' => [
-                { 'external_link' => 'http://www.youtube.com/watch?v=UF8uR6Z6KLc' },
-                { 'external_link' => 'https://vimeo.com/7976699', 'audio_length_seconds' => 900 }
-            ],
-            'verbatim' => true,
-            'timestamps' => true
-        }
-    }
-    assert_order_placement_success(expected_body)
-  end
-
-  it 'must raise BadRequest error in case of request validation failure' do
-    VCR.insert_cassette 'submit_tc_order_with_invalid_request'
-
-    # example - missing transcription options
-    request = Rev::OrderRequest.new
-
-    action = lambda { client.submit_order(request) }
-    exception = action.must_raise Rev::BadRequestError
-    exception.message.must_match '10004: You must specify either translation or transcription options in an order'
-    exception.code.must_equal Rev::OrderRequestErrorCodes::TC_OR_TR_OPTIONS_NOT_SPECIFIED
-  end
-
-  it 'must submit translation order with options' do
-    VCR.insert_cassette 'submit_tr_order'
-
-    request = Rev::OrderRequest.new(
-      :translation_options => translation_options
-    )
-
-    new_order_num = client.submit_order(request)
-
-    new_order_num.must_equal 'TR0235803277'
-    expected_body = {
-      'payment' => {
-        'type' => 'AccountBalance'
-      },
-      'non_standard_tat_guarantee' => false,
-      'translation_options' => {
-        'inputs'=> [
-          { 'word_length' => 1000, 'uri' => 'urn:rev:inputmedia:SnVwbG9hZHMvMjAxMy0wOS0xNy9lMzk4MWIzNS0wNzM1LTRlMDAtODY1NC1jNWY4ZjE4MzdlMTIvc291cmNlZG9jdW1lbnQucG5n' },
-        ],
-        'source_language_code' => 'es',
-        'destination_language_code' => 'en'
-      }
-    }
-    assert_order_placement_success(expected_body)
-  end
-
-  it 'must submit caption order with options' do
-    VCR.insert_cassette 'submit_cp_order'
-
-    request = Rev::OrderRequest.new(:caption_options => caption_options)
-
-    new_order_num = client.submit_order(request)
-
-    new_order_num.must_equal 'CP12345'
-    expected_body = {
-      'payment' => {
-        'type' => 'AccountBalance'
-      },
-      'non_standard_tat_guarantee' => false,
-      'caption_options' => {
-        'inputs'=> [
-          { 'video_length_seconds' => 900, 'external_link' => 'http://www.youtube.com/watch?v=UF8uR6Z6KLc' }
-        ],
-        'output_file_formats' => [Rev::CaptionOptions::OUTPUT_FILE_FORMATS[:subrip]]
-      }
-    }
-    assert_order_placement_success(expected_body)
-  end
-
-  it 'must submit subtitle order with options' do
-    VCR.insert_cassette 'submit_su_order'
-
-    request = Rev::OrderRequest.new(:caption_options => subtitle_options)
-
-    new_order_num = client.submit_order(request)
-
-    new_order_num.must_equal 'CP56789'
-    expected_body = {
-      'payment' => {
-        'type' => 'AccountBalance'
-      },
-      'non_standard_tat_guarantee' => false,
-      'caption_options' => {
-        'inputs'=> [
-          { 'video_length_seconds' => 900, 'external_link' => 'http://www.youtube.com/watch?v=UF8uR6Z6KLc' }
-        ],
-        'subtitle_languages' => ['es','it'],
-        'output_file_formats' => [Rev::CaptionOptions::OUTPUT_FILE_FORMATS[:subrip]]
-      }
-    }
-    assert_order_placement_success(expected_body)
-  end
-
-  after do
-    VCR.eject_cassette
-  end
-
-  private
-
-  def assert_order_placement_success(expected_body)
-    assert_requested(:post, /.*\/orders/, :times => 1) do |req|
-      req.headers['Content-Type'].must_equal 'application/json'
-      actual_body = JSON.load req.body
-      actual_body.must_equal expected_body
-    end
-  end
-
-end
+require_relative '../../spec_helper'
+
+describe 'POST /orders' do
+  let(:client) { Rev.new('welcome', 'AAAAAu/YjZ3phXU5FsF35yIcgiA=', 'www.revtrunk.com') }
+
+  # some defaults we use often
+  let(:billing_address) { Rev::BillingAddress.new(
+    :street => '123 Pine Lane',
+    :street2 => 'Apt D',
+    :city => 'MyTown',
+    :state => 'MN',
+    :zip => '12345',
+    :country_alpha2 => 'US'
+  )}
+
+  let(:balance_payment) { Rev::Payment.new(Rev::Payment::TYPES[:account_balance]) }
+  let(:transcription_inputs) {
+      inputs = []
+      inputs << Rev::Input.new(:external_link => 'http://www.youtube.com/watch?v=UF8uR6Z6KLc', accents: ['AmericanNeutral', 'Australian'])
+      inputs << Rev::Input.new(:audio_length_seconds => 900, :external_link => 'https://vimeo.com/7976699', speakers: ['Billy', 'Bob'], glossary: ['Sandwich'])
+  }
+  let(:caption_inputs) {
+    inputs = []
+    inputs << Rev::Input.new(:video_length_seconds => 900, :external_link => 'http://www.youtube.com/watch?v=UF8uR6Z6KLc', speakers: ['Billy', 'Bob'], glossary: ['Sandwich'])
+  }
+  let(:transcription_options) { Rev::TranscriptionOptions.new(transcription_inputs,
+    :verbatim => true, :timestamps => true) }
+  let(:caption_options) {
+    Rev::CaptionOptions.new(caption_inputs, :output_file_formats => ['SubRip'])
+  }
+  let(:subtitle_options) {
+    Rev::CaptionOptions.new(caption_inputs, :subtitle_languages => ['es','it'],
+    :output_file_formats => ['SubRip'])
+  }
+
+  it 'must place order using account balance' do
+    VCR.insert_cassette 'submit_tc_order_with_account_balance'
+
+    request = Rev::OrderRequest.new(
+      :transcription_options => transcription_options
+    )
+
+    new_order_num = client.submit_order(request)
+
+    new_order_num.must_equal 'TC0406615008'
+    expected_body = {
+      'payment' => {
+        'type' => 'AccountBalance'
+      },
+      'non_standard_tat_guarantee' => false,
+      'transcription_options' => {
+        'inputs' => [
+          { 'external_link' => 'http://www.youtube.com/watch?v=UF8uR6Z6KLc', 'accents' => ['AmericanNeutral', 'Australian']},
+          { 'external_link' => 'https://vimeo.com/7976699', 'audio_length_seconds' => 900, 'speakers' => ['Billy', 'Bob'], 'glossary' => ['Sandwich'] }
+        ],
+        'verbatim' => true,
+        'timestamps' => true
+      }
+    }
+    assert_order_placement_success(expected_body)
+  end
+
+  it 'must default to account balance if payment property not set' do
+    VCR.insert_cassette 'submit_tc_order_without_specifying_payment'
+
+    request = Rev::OrderRequest.new(
+        :transcription_options => transcription_options
+    )
+
+    new_order_num = client.submit_order(request)
+
+    new_order_num.must_equal 'TC0406615008'
+    expected_body = {
+        'payment' => {
+            'type' => 'AccountBalance'
+        },
+        'non_standard_tat_guarantee' => false,
+        'transcription_options' => {
+            'inputs' => [
+                { 'external_link' => 'http://www.youtube.com/watch?v=UF8uR6Z6KLc', 'accents' => ['AmericanNeutral', 'Australian']},
+                { 'external_link' => 'https://vimeo.com/7976699', 'audio_length_seconds' => 900, 'speakers' => ['Billy', 'Bob'], 'glossary' => ['Sandwich'] }
+            ],
+            'verbatim' => true,
+            'timestamps' => true
+        }
+    }
+    assert_order_placement_success(expected_body)
+  end
+
+  it 'must raise BadRequest error in case of request validation failure' do
+    VCR.insert_cassette 'submit_tc_order_with_invalid_request'
+
+    # example - missing transcription options
+    request = Rev::OrderRequest.new
+
+    action = lambda { client.submit_order(request) }
+    exception = action.must_raise Rev::BadRequestError
+    exception.message.must_match '10004: You must specify either transcription or caption options in an order'
+    exception.code.must_equal Rev::OrderRequestErrorCodes::OPTIONS_NOT_SPECIFIED
+  end
+
+  it 'must submit caption order with options' do
+    VCR.insert_cassette 'submit_cp_order'
+
+    request = Rev::OrderRequest.new(:caption_options => caption_options)
+
+    new_order_num = client.submit_order(request)
+
+    new_order_num.must_equal 'CP12345'
+    expected_body = {
+      'payment' => {
+        'type' => 'AccountBalance'
+      },
+      'non_standard_tat_guarantee' => false,
+      'caption_options' => {
+        'inputs'=> [
+          { 'video_length_seconds' => 900, 'external_link' => 'http://www.youtube.com/watch?v=UF8uR6Z6KLc', 'speakers' => ['Billy', 'Bob'], 'glossary' => ['Sandwich'] }
+        ],
+        'output_file_formats' => [Rev::CaptionOptions::OUTPUT_FILE_FORMATS[:subrip]]
+      }
+    }
+    assert_order_placement_success(expected_body)
+  end
+
+  it 'must submit subtitle order with options' do
+    VCR.insert_cassette 'submit_su_order'
+
+    request = Rev::OrderRequest.new(:caption_options => subtitle_options)
+
+    new_order_num = client.submit_order(request)
+
+    new_order_num.must_equal 'CP56789'
+    expected_body = {
+      'payment' => {
+        'type' => 'AccountBalance'
+      },
+      'non_standard_tat_guarantee' => false,
+      'caption_options' => {
+        'inputs'=> [
+          { 'video_length_seconds' => 900, 'external_link' => 'http://www.youtube.com/watch?v=UF8uR6Z6KLc', 'speakers' => ['Billy', 'Bob'], 'glossary' => ['Sandwich'] }
+        ],
+        'subtitle_languages' => ['es','it'],
+        'output_file_formats' => [Rev::CaptionOptions::OUTPUT_FILE_FORMATS[:subrip]]
+      }
+    }
+    assert_order_placement_success(expected_body)
+  end
+
+  after do
+    VCR.eject_cassette
+  end
+
+  private
+
+  def assert_order_placement_success(expected_body)
+    assert_requested(:post, /.*\/orders/, :times => 1) do |req|
+      req.headers['Content-Type'].must_equal 'application/json'
+      actual_body = JSON.load req.body
+      actual_body.must_equal expected_body
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,49 +1,47 @@
-require 'coveralls'
-Coveralls.wear!
-
-require_relative '../lib/rev-api'
-
-#dependencies
-require 'minitest/autorun'
-require 'webmock/minitest'
-require 'vcr'
-require 'turn'
-
-module MiniTest
-  class Spec
-    class << self
-      def xit(desc='anonymous')
-        it(name) { skip 'DISABLED' }
-      end
-    end
-  end
-end
-
-Turn.config do |c|
-  c.format = :outline
-  c.trace = false
-  c.natural = true
-end
-
-
-VCR.configure do |c|
-  c.cassette_library_dir = 'spec/fixtures/api_cassettes'
-  c.default_cassette_options = { :record => :once, :allow_unused_http_interactions => false,
-    :match_requests_on => [:method, :uri, :rev_headers] }
-  c.hook_into :webmock
-  c.ignore_hosts 'www.example.com' # used to stub requests manually, see http_client_spec
-
-  # http://ruby-doc.org/stdlib-2.0.0/libdoc/net/http/rdoc/Net/HTTP.html#label-Compression - we ignore 'Accept-Encoding'
-  c.register_request_matcher :rev_headers do |actual_request, expected_request|
-    actual_request.headers.delete 'Accept-Encoding'
-
-    # ignore specific version of a client recorded
-    actual_user_agent = actual_request.headers['User-Agent'].to_s.split('/').first
-    expected_user_agent = actual_request.headers['User-Agent'].to_s.split('/').first
-
-    actual_request.headers.delete 'User-Agent'
-    expected_request.headers.delete 'User-Agent'
-
-    actual_request.headers == expected_request.headers# && actual_user_agent == expected_user_agent
-  end
-end
+require_relative '../lib/rev-api'
+require_relative 'test_helpers.rb'
+
+#dependencies
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'vcr'
+require 'turn'
+
+module MiniTest
+  class Spec
+    class << self
+      def xit(desc='anonymous')
+        it(name) { skip 'DISABLED' }
+      end
+    end
+  end
+end
+
+Turn.config do |c|
+  c.format = :outline
+  c.trace = false
+  c.natural = true
+end
+
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/api_cassettes'
+  c.default_cassette_options = { :record => :once, :allow_unused_http_interactions => false,
+    :match_requests_on => [:method, :uri, :rev_headers] }
+  c.hook_into :webmock
+  c.ignore_hosts 'www.example.com' # used to stub requests manually, see http_client_spec
+
+  # http://ruby-doc.org/stdlib-2.0.0/libdoc/net/http/rdoc/Net/HTTP.html#label-Compression - we ignore 'Accept-Encoding'
+  c.register_request_matcher :rev_headers do |actual_request, expected_request|
+    actual_request.headers.delete 'Accept-Encoding'
+
+    # ignore specific version of a client recorded
+    actual_user_agent = actual_request.headers['User-Agent'].to_s.split('/').first
+    expected_user_agent = actual_request.headers['User-Agent'].to_s.split('/').first
+
+    actual_request.headers.delete 'User-Agent'
+    expected_request.headers.delete 'User-Agent'
+
+    actual_request.headers == expected_request.headers# && actual_user_agent == expected_user_agent
+  end
+end