rev-api 2.2.1 → 2.5.0

data/spec/lib/rev/http_client_spec.rb

@@ -1,32 +1,32 @@
-require_relative '../../spec_helper'
-
-describe Rev::HttpClient do
-  it 'must support predefined production host' do
-    client = Rev::HttpClient.new('foo', 'bar', Rev::Api::PRODUCTION_HOST)
-    Rev::HttpClient.base_uri.must_equal 'https://www.rev.com/api/v1'
-  end
-
-  it 'must support predefined sandbox host' do
-    client = Rev::HttpClient.new('foo', 'bar', Rev::Api::SANDBOX_HOST)
-    Rev::HttpClient.base_uri.must_equal 'https://api-sandbox.rev.com/api/v1'
-  end
-
-  it 'must support custom host for development purposes' do
-    client = Rev::HttpClient.new('foo', 'bar', 'localhost')
-    Rev::HttpClient.base_uri.must_equal 'https://localhost/api/v1'
-  end
-
-  it 'must include authorization and User-Agent headers for any request' do
-    host = 'www.example.com'
-    stub_request(:any, /www\.example\.com\/.*/)
-
-    client = Rev::HttpClient.new('foo', 'bar', host)
-    response = client.get('/orders')
-
-    assert_requested :get, "https://#{host}/api/v1/orders", :headers => {
-      'Authorization' => "Rev foo:bar",
-      'User-Agent' => Rev::HttpClient::USER_AGENT
-    }
-  end
-end
-
+require_relative '../../spec_helper'
+
+describe Rev::HttpClient do
+  it 'must support predefined production host' do
+    client = Rev::HttpClient.new('foo', 'bar', Rev::Api::PRODUCTION_HOST)
+    Rev::HttpClient.base_uri.must_equal 'https://www.rev.com/api/v1'
+  end
+
+  it 'must support predefined sandbox host' do
+    client = Rev::HttpClient.new('foo', 'bar', Rev::Api::SANDBOX_HOST)
+    Rev::HttpClient.base_uri.must_equal 'https://api-sandbox.rev.com/api/v1'
+  end
+
+  it 'must support custom host for development purposes' do
+    client = Rev::HttpClient.new('foo', 'bar', 'localhost')
+    Rev::HttpClient.base_uri.must_equal 'https://localhost/api/v1'
+  end
+
+  it 'must include authorization and User-Agent headers for any request' do
+    host = 'www.example.com'
+    stub_request(:any, /www\.example\.com\/.*/)
+
+    client = Rev::HttpClient.new('foo', 'bar', host)
+    response = client.get('/orders')
+
+    assert_requested :get, "https://#{host}/api/v1/orders", :headers => {
+      'Authorization' => "Rev foo:bar",
+      'User-Agent' => Rev::HttpClient::USER_AGENT
+    }
+  end
+end
+

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

@@ -1,5 +1,11 @@
 require_relative '../../../spec_helper'
 
+GLOSSARY_ENTRIES_LIMIT_TEST = 1000
+GLOSSARY_ENTRY_LENGTH_LIMIT_TEST = 255
+SPEAKER_ENTRIES_LIMIT_TEST = 100
+SPEAKER_ENTRY_LENGTH_LIMIT_TEST = 15
+SUPPORTED_ACCENTS_COUNT = 8
+
 describe 'OrderRequest' do
 
   it 'defaults to standard TAT guarantee' do
@@ -41,19 +47,92 @@ describe 'OrderRequest' do
 
   describe 'TranscriptionOptions' do
     it 'is InputOptions' do
-      options = Rev::TranscriptionOptions.new([{}], {})
+      inputs = create_input()
+      options = Rev::TranscriptionOptions.new(inputs, {})
       options.must_be_kind_of Rev::InputOptions
     end
+
+    it 'has correct info attributes' do
+      inputs = create_input()
+      options = Rev::TranscriptionOptions.new(inputs, {})
+      options.must_respond_to :output_file_formats
+      options.must_respond_to :verbatim
+      options.must_respond_to :timestamps
+    end
+
+    it 'has output file formats hash' do
+      Rev::TranscriptionOptions::OUTPUT_FILE_FORMATS[:ms_word].must_equal 'MS Word'
+      Rev::TranscriptionOptions::OUTPUT_FILE_FORMATS[:json].must_equal 'JSON'
+      Rev::TranscriptionOptions::OUTPUT_FILE_FORMATS[:text].must_equal 'Text'
+      Rev::TranscriptionOptions::OUTPUT_FILE_FORMATS[:pdf].must_equal 'Pdf'
+    end
+
+    it 'rejects invalid output file format' do
+      inputs = create_input()
+      proc { Rev::TranscriptionOptions.new(inputs, { :output_file_formats => ['invalid'] }) }.must_raise ArgumentError
+    end
+
+    it 'accepts all valid output file formats' do
+      inputs = create_input()
+      order = Rev::TranscriptionOptions.new(inputs, { :output_file_formats => [
+        Rev::TranscriptionOptions::OUTPUT_FILE_FORMATS[:ms_word],
+        Rev::TranscriptionOptions::OUTPUT_FILE_FORMATS[:json],
+        Rev::TranscriptionOptions::OUTPUT_FILE_FORMATS[:text],
+        Rev::TranscriptionOptions::OUTPUT_FILE_FORMATS[:pdf]
+      ] })
+      order.output_file_formats.length.must_equal 4
+      order.output_file_formats[0].must_equal Rev::TranscriptionOptions::OUTPUT_FILE_FORMATS[:ms_word]
+      order.output_file_formats[1].must_equal Rev::TranscriptionOptions::OUTPUT_FILE_FORMATS[:json]
+      order.output_file_formats[2].must_equal Rev::TranscriptionOptions::OUTPUT_FILE_FORMATS[:text]
+      order.output_file_formats[3].must_equal Rev::TranscriptionOptions::OUTPUT_FILE_FORMATS[:pdf]
+    end
+
+    it 'rejects glossary of invalid size' do
+      oversize_glossary = ['testing']*(GLOSSARY_ENTRIES_LIMIT_TEST + 1)
+      inputs = create_input(glossary: oversize_glossary)
+      proc { Rev::TranscriptionOptions.new(inputs) }.must_raise ArgumentError
+    end
+
+    it 'rejects glossary if any terms are too long' do
+      oversize_glossary_term = "A" * (GLOSSARY_ENTRY_LENGTH_LIMIT_TEST + 1)
+      inputs = create_input(glossary: [oversize_glossary_term])
+      proc { Rev::TranscriptionOptions.new(inputs) }.must_raise ArgumentError
+    end
+
+    it 'rejects speaker list of invalid size' do
+      oversize_speakers = ['testing']*(SPEAKER_ENTRIES_LIMIT_TEST + 1)
+      inputs = create_input(speakers: oversize_speakers)
+      proc { Rev::TranscriptionOptions.new(inputs) }.must_raise ArgumentError
+    end
+
+    it 'rejects speaker names if name is too long' do
+      oversize_speaker_name = "A" * (SPEAKER_ENTRY_LENGTH_LIMIT_TEST + 1)
+      inputs = create_input(speakers: [oversize_speaker_name])
+      proc { Rev::TranscriptionOptions.new(inputs) }.must_raise ArgumentError
+    end
+
+    it 'rejects invalid accents' do
+      inputs = create_input(accents: ['invalid'])
+      proc { Rev::TranscriptionOptions.new(inputs) }.must_raise ArgumentError
+    end
+
+    it 'rejects accents when theres more listed than supported' do
+      accents = [Rev::Input::SUPPORTED_ACCENTS[:american_neutral]]*(SUPPORTED_ACCENTS_COUNT + 1)
+      inputs = create_input(accents: accents)
+      proc { Rev::TranscriptionOptions.new(inputs) }.must_raise ArgumentError
+    end
   end
 
   describe 'CaptionOptions' do
     it 'is InputOptions' do
-      options = Rev::CaptionOptions.new([{}], {})
+      inputs = create_input()
+      options = Rev::CaptionOptions.new(inputs, {})
       options.must_be_kind_of Rev::InputOptions
     end
 
     it 'has output file formats attribute' do
-      options = Rev::CaptionOptions.new([{}], {})
+      inputs = create_input()
+      options = Rev::CaptionOptions.new(inputs, {})
       options.must_respond_to :output_file_formats
     end
 
@@ -70,20 +149,52 @@ describe 'OrderRequest' do
     end
 
     it 'rejects unknowns file formats' do
-      proc { Rev::CaptionOptions.new([{}], { :output_file_formats => ['invalid'] }) }.must_raise ArgumentError
+      inputs = create_input()
+      proc { Rev::CaptionOptions.new(inputs, { :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]] })
+      inputs = create_input()
+      order = Rev::CaptionOptions.new(inputs, { :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];
+      order.output_file_formats[0].must_equal Rev::CaptionOptions::OUTPUT_FILE_FORMATS[:scc]
+    end
+
+    it 'rejects glossary of invalid size' do
+      oversize_glossary = []
+      for x in 0..GLOSSARY_ENTRIES_LIMIT_TEST do
+        oversize_glossary << 'testing'
+      end
+      inputs = create_input(glossary: oversize_glossary)
+      proc { Rev::CaptionOptions.new(inputs) }.must_raise ArgumentError
+    end
+
+    it 'rejects glossary if any terms are too long' do
+      oversize_glossary_term = "A" * (GLOSSARY_ENTRY_LENGTH_LIMIT_TEST + 1)
+      inputs = create_input(glossary: [oversize_glossary_term])
+      proc { Rev::CaptionOptions.new(inputs) }.must_raise ArgumentError
+    end
+
+    it 'rejects speaker names of invalid size' do
+      oversize_speakers = []
+      for x in 0..SPEAKER_ENTRIES_LIMIT_TEST do
+        oversize_speakers << 'testing'
+      end
+      inputs = create_input(speakers: oversize_speakers)
+      proc { Rev::CaptionOptions.new(inputs) }.must_raise ArgumentError
+    end
+
+    it 'rejects speaker names if name is too long' do
+      oversize_speaker_name = "A" * (SPEAKER_ENTRY_LENGTH_LIMIT_TEST + 1)
+      inputs = create_input(speakers: [oversize_speaker_name])
+      proc { Rev::CaptionOptions.new(inputs) }.must_raise ArgumentError
     end
   end # CaptionOptions
 
   describe 'Notification' do
-    it 'Defaults level' do
-      notification = Rev::Notification.new('http://example.com/')
-      notification.level.must_equal Rev::Notification::LEVELS[:final_only]
-    end
-  end # Notification
+    it 'Defaults level' do
+      notification = Rev::Notification.new('http://example.com/')
+      notification.level.must_equal Rev::Notification::LEVELS[:final_only]
+    end
+  end # Notification
 end

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

@@ -1,58 +1,58 @@
-require_relative '../../../spec_helper'
-
-describe 'Order' do
-  let(:cp_order) { 
-    Rev::Order.new (
-      { 'attachments' => { },
-        'comments' => {},
-        'caption' => { 'total_length_seconds' => 300 }
-      }
-    )
-  }
-  
-  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_seconds' do
-      info = Rev::CaptionInfo.new({})
-      assert_respond_to info, 'total_length_seconds'
-    end
-  end # CaptionInfo
-end
-
+require_relative '../../../spec_helper'
+
+describe 'Order' do
+  let(:cp_order) { 
+    Rev::Order.new (
+      { 'attachments' => { },
+        'comments' => {},
+        'caption' => { 'total_length_seconds' => 300 }
+      }
+    )
+  }
+  
+  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_seconds' do
+      info = Rev::CaptionInfo.new({})
+      assert_respond_to info, 'total_length_seconds'
+    end
+  end # CaptionInfo
+end
+

data/spec/lib/rev/post_inputs_spec.rb

@@ -1,94 +1,94 @@
-require_relative '../../spec_helper'
-
-describe 'POST /inputs' do
-  let(:client) { Rev.new('welcome', 'AAAAAu/YjZ3phXU5FsF35yIcgiA=', 'www.revtrunk.com') }
-
-  it 'must link external file with explicit content-type and file' do
-    VCR.insert_cassette 'link_input_with_all_attributes'
-
-    link = 'https://www.rev.com/content/img/rev/rev_logo_colored_top.png'
-    filename = 'sourcedocument.png'
-    content_type = 'image/png'
-    new_input_location = client.create_input_from_link(link, filename, content_type)
-
-    new_input_location.must_match 'urn:rev:inputmedia:'
-    expected_body = {
-      'url' => link,
-      'filename' => filename,
-      'content_type' => content_type
-    }
-    assert_requested(:post, /.*\/inputs/, :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
-
-  it 'must quote the filename' do
-    VCR.insert_cassette 'link_input_with_spaces_in_filename'
-
-    link = 'https://s3-us-west-2.amazonaws.com/public-rev/transcript/Rev Transcript File.docx'
-    filename = 'Rev Transcript File.docx'
-    content_type = 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
-    new_input_location = client.create_input_from_link(link, filename, content_type)
-
-    new_input_location.must_match 'urn:rev:inputmedia:'
-    expected_body = {
-      'url' => link,
-      'filename' => filename,
-      'content_type' => content_type
-    }
-    assert_requested(:post, /.*\/inputs/, :times => 1) do |req|
-      actual_body = JSON.load req.body
-      actual_body.must_equal expected_body
-    end
-  end
-
-  it 'must link external file without content-type and filename' do
-    VCR.insert_cassette 'link_input'
-
-    link = 'https://www.rev.com/content/img/rev/rev_logo_colored_top.png'
-    new_input_location = client.create_input_from_link(link)
-
-    new_input_location.must_match 'urn:rev:inputmedia:'
-    expected_body = { 'url' => link }
-    assert_requested(:post, /.*\/inputs/, :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
-
-  it 'must upload source file directly' do
-    VCR.insert_cassette 'upload_input'
-
-    filename = './spec/fixtures/sourcedocument.png'
-    content_type = 'image/png'
-
-    new_input_location = client.upload_input(filename, content_type)
-
-    new_input_location.must_match 'urn:rev:inputmedia:'
-    expected_body = File.read(filename)
-    assert_requested(:post, /.*\/inputs/, :times => 1) do |req|
-      req.headers['Content-Type'].must_equal content_type
-      req.headers['Content-Disposition'].must_equal 'attachment; filename="sourcedocument.png"'
-      req.body.must_equal expected_body
-    end
-  end
-
-  it 'must raise BadRequestError on failure' do
-    VCR.insert_cassette 'upload_input_with_invalid_content_type'
-
-    filename = './spec/fixtures/sourcedocument.png'
-    content_type = 'trololo'
-
-    action = lambda { client.upload_input(filename, content_type) }
-    exception = action.must_raise Rev::BadRequestError
-    exception.message.must_match '10001: The content-type explicitly specified in the request is not supported for input media'
-    exception.code.must_equal Rev::InputRequestErrorCodes::UNSUPPORTED_CONTENT_TYPE
-  end
-
-  after do
-    VCR.eject_cassette
-  end
-end
+require_relative '../../spec_helper'
+
+describe 'POST /inputs' do
+  let(:client) { Rev.new('welcome', 'AAAAAu/YjZ3phXU5FsF35yIcgiA=', 'www.revtrunk.com') }
+
+  it 'must link external file with explicit content-type and file' do
+    VCR.insert_cassette 'link_input_with_all_attributes'
+
+    link = 'https://www.rev.com/content/img/rev/rev_logo_colored_top.png'
+    filename = 'sourcedocument.png'
+    content_type = 'image/png'
+    new_input_location = client.create_input_from_link(link, filename, content_type)
+
+    new_input_location.must_match 'urn:rev:inputmedia:'
+    expected_body = {
+      'url' => link,
+      'filename' => filename,
+      'content_type' => content_type
+    }
+    assert_requested(:post, /.*\/inputs/, :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
+
+  it 'must quote the filename' do
+    VCR.insert_cassette 'link_input_with_spaces_in_filename'
+
+    link = 'https://s3-us-west-2.amazonaws.com/public-rev/transcript/Rev Transcript File.docx'
+    filename = 'Rev Transcript File.docx'
+    content_type = 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
+    new_input_location = client.create_input_from_link(link, filename, content_type)
+
+    new_input_location.must_match 'urn:rev:inputmedia:'
+    expected_body = {
+      'url' => link,
+      'filename' => filename,
+      'content_type' => content_type
+    }
+    assert_requested(:post, /.*\/inputs/, :times => 1) do |req|
+      actual_body = JSON.load req.body
+      actual_body.must_equal expected_body
+    end
+  end
+
+  it 'must link external file without content-type and filename' do
+    VCR.insert_cassette 'link_input'
+
+    link = 'https://www.rev.com/content/img/rev/rev_logo_colored_top.png'
+    new_input_location = client.create_input_from_link(link)
+
+    new_input_location.must_match 'urn:rev:inputmedia:'
+    expected_body = { 'url' => link }
+    assert_requested(:post, /.*\/inputs/, :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
+
+  it 'must upload source file directly' do
+    VCR.insert_cassette 'upload_input'
+
+    filename = './spec/fixtures/sourcedocument.png'
+    content_type = 'image/png'
+
+    new_input_location = client.upload_input(filename, content_type)
+
+    new_input_location.must_match 'urn:rev:inputmedia:'
+    expected_body = File.read(filename)
+    assert_requested(:post, /.*\/inputs/, :times => 1) do |req|
+      req.headers['Content-Type'].must_equal content_type
+      req.headers['Content-Disposition'].must_equal 'attachment; filename="sourcedocument.png"'
+      req.body.must_equal expected_body
+    end
+  end
+
+  it 'must raise BadRequestError on failure' do
+    VCR.insert_cassette 'upload_input_with_invalid_content_type'
+
+    filename = './spec/fixtures/sourcedocument.png'
+    content_type = 'trololo'
+
+    action = lambda { client.upload_input(filename, content_type) }
+    exception = action.must_raise Rev::BadRequestError
+    exception.message.must_match '10001: The content-type explicitly specified in the request is not supported for input media'
+    exception.code.must_equal Rev::InputRequestErrorCodes::UNSUPPORTED_CONTENT_TYPE
+  end
+
+  after do
+    VCR.eject_cassette
+  end
+end