rev-api 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14e7b466901b98e282283f61139dfb34d764c52d
-  data.tar.gz: b1a7fb9f134ec3c78da68fd82c8f692f9822671e
+  metadata.gz: 6a407cfdbb9c178eb15031d58450c8b23347752b
+  data.tar.gz: 501f22750ea803768a3435bfe0a3aa1522f0e524
 SHA512:
-  metadata.gz: c842b22e159268039b2213bc6a636b4380be363d1785b8c9e6151dc9a9dd6a6992a23521030a18cc6a11745db8aad91bedb0b8f834e31fc7d51f8c3de5d8b547
-  data.tar.gz: fa14905e34b1d6aa98b3237f935c51cd207d845f93ba7a53b9c4331952088678b71c01991b282f75d57a9740847014fc4331919c145678094e0caedc3a4b37e5
+  metadata.gz: 2b985c4ca7ace5413349e0c1b1fa60f64d75d04417f4ec5aa3cf2c001464febf562cdb7f79d1a40bb5ff95e98cde00a3bfcf14784e3ed3bf596afa5594e2f982
+  data.tar.gz: ec107853d7aa60aeaafdb19e790247b68831198c1dc04ecb055a0890ae3b7eaadfe255a8e113d9c395e35a776949348958516d0c66043a3d8a7758141017e6b8

data/.gitignore

@@ -15,6 +15,7 @@ test/tmp
 test/version_tmp
 tmp
 doc
+.coveralls.yml
 
 # YARD artifacts
 .yardoc

data/.ruby-version

@@ -1 +1 @@
-ruby-2.0.0
+2.0.0-p247

data/README.md

@@ -2,7 +2,6 @@
 [![Build Status](https://secure.travis-ci.org/revdotcom/rev-ruby-sdk.png?branch=master)](https://secure.travis-ci.org/revdotcom/rev-ruby-sdk)
 [![Dependency Status](https://gemnasium.com/revdotcom/rev-ruby-sdk.png?travis)](https://gemnasium.com/revdotcom/rev-ruby-sdk)
 [![Code Climate](https://codeclimate.com/github/revdotcom/rev-ruby-sdk.png)](https://codeclimate.com/github/revdotcom/rev-ruby-sdk)
-[![Coverage Status](https://coveralls.io/repos/revdotcom/rev-ruby-sdk/badge.png)](https://coveralls.io/r/revdotcom/rev-ruby-sdk)
 
 [Reference](https://www.rev.com/api/docs) | [RDocs](http://rubydoc.info/github/revdotcom/rev-ruby-sdk/master/frames)
 

data/lib/rev-api.rb

@@ -3,7 +3,7 @@ require 'httparty'
 # These three are the only classes that should be accessed directly
 require 'rev-api/api'
 
-module Rev 
+module Rev
   class << self
     # Alias for Rev::Api.new
     #
@@ -23,4 +23,4 @@ module Rev
       new.respond_to?(method, include_private) || super(method, include_private)
     end
   end
-end
+end

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

@@ -6,6 +6,12 @@ module Rev
   # You can also supply reference number, customer comment, and whether standard turnaround time is not required
   #
   # @note https://www.rev.com/api/ordersposttranscription, https://www.rev.com/api/orderspostcaption
+
+  GLOSSARY_ENTRIES_LIMIT = 1000
+  GLOSSARY_ENTRY_LENGTH_LIMIT = 255
+  SPEAKER_ENTRIES_LIMIT = 100
+  SPEAKER_ENTRY_LENGTH_LIMIT = 15
+
   class OrderRequest < ApiSerializable
     # see {Rev::Payment}
     attr_reader :payment
@@ -111,6 +117,17 @@ module Rev
     #        - :timestamps => true/false
     def initialize(inputs, info = {})
       super inputs, info
+      options_validation(inputs)
+    end
+
+    private
+
+    def options_validation(inputs)
+      inputs.each { |input|
+        input.validate_glossary
+        input.validate_speakers
+        input.validate_accents
+      }
     end
   end
 
@@ -144,6 +161,7 @@ module Rev
     def initialize(inputs, info = {})
       super(inputs, info)
       raise(ArgumentError, "invalid format(s)") unless validate_output_formats(info[:output_file_formats])
+      options_validation(inputs)
     end
 
     private
@@ -151,6 +169,13 @@ module Rev
     def validate_output_formats(formats)
       formats.nil? || formats.select{|f| !OUTPUT_FILE_FORMATS.has_value?(f) }.empty?
     end
+
+    def options_validation(inputs)
+      inputs.each { |input|
+        input.validate_glossary
+        input.validate_speakers
+      }
+    end
   end
 
   # Input for order (aka source file)
@@ -169,6 +194,63 @@ module Rev
 
     # External URL, if sources wasn't POSTed as input (YouTube, Vimeo, Dropbox, etc)
     attr_reader :external_link
+
+    # Optional, list of glossary entries.
+    attr_reader :glossary
+
+    # Optional, list of speaker names.
+    attr_reader :speakers
+
+    # Optional, list of accents.
+    attr_reader :accents
+
+    SUPPORTED_ACCENTS = {
+      :american_neutral => 'AmericanNeutral',
+      :american_southern => 'AmericanSouthern',
+      :asian => 'Asian',
+      :australian => 'Australian',
+      :british => 'British',
+      :indian => 'Indian',
+      :other => 'Other',
+      :unknown => 'Unknown'
+    }
+
+    def validate_glossary
+      if glossary
+        if glossary.length > GLOSSARY_ENTRIES_LIMIT
+          raise(ArgumentError, "Glossary must not exceed #{GLOSSARY_ENTRIES_LIMIT} entries")
+        end
+        glossary.each { |term|
+          if term.length > GLOSSARY_ENTRY_LENGTH_LIMIT
+            raise(ArgumentError, "Glossary entries cannot exceed #{GLOSSARY_ENTRY_LENGTH_LIMIT} characters")
+          end
+        }
+      end
+    end
+
+    def validate_speakers
+      if speakers
+        if speakers.length > SPEAKER_ENTRIES_LIMIT
+          raise(ArgumentError, "Speaker list must not exceed #{SPEAKER_ENTRIES_LIMIT} entries")
+        end
+        speakers.each { |speaker|
+          if speaker.length > SPEAKER_ENTRY_LENGTH_LIMIT
+            raise(ArgumentError, "Speaker name cannot exceed #{SPEAKER_ENTRY_LENGTH_LIMIT} characters")
+          end
+        }
+      end
+    end
+
+    def validate_accents
+      if accents
+        if accents.length > SUPPORTED_ACCENTS.length
+          raise(ArgumentError, "Length of accents list cannot exceed number of supported accents.")
+        end
+        if accents.any?{ |accent| !Rev::Input::SUPPORTED_ACCENTS.has_value?(accent) }
+          raise(ArgumentError, 'Unsupported accent provided')
+        end
+      end
+    end
   end
 
   # Notification Info. Optionally you may request that an HTTP post be made to a url of your choice when the order enters

data/lib/rev-api/version.rb

@@ -1,3 +1,3 @@
 module Rev
-  VERSION = '2.2.1'
+  VERSION = '2.3.0'
 end

data/rev-api.gemspec

@@ -25,10 +25,9 @@ Gem::Specification.new do |s|
   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('yard', '~> 0.9.14')
   s.add_development_dependency('redcarpet', '~> 3.3')
   s.add_development_dependency('rubygems-tasks', '~> 0')
-  s.add_development_dependency('coveralls', '~> 0.8')
 
   s.has_rdoc = 'yard'
 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,57 @@ 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 '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,14 +114,46 @@ 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];
     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

data/spec/lib/rev/post_order_spec.rb

@@ -16,12 +16,12 @@ describe 'POST /orders' do
   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')
+      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')
+    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) }
@@ -50,8 +50,8 @@ describe 'POST /orders' do
       '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 }
+          { '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
@@ -77,8 +77,8 @@ describe 'POST /orders' do
         '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 }
+                { '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
@@ -114,7 +114,7 @@ describe 'POST /orders' do
       'non_standard_tat_guarantee' => false,
       'caption_options' => {
         'inputs'=> [
-          { 'video_length_seconds' => 900, 'external_link' => 'http://www.youtube.com/watch?v=UF8uR6Z6KLc' }
+          { '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]]
       }
@@ -137,7 +137,7 @@ describe 'POST /orders' do
       'non_standard_tat_guarantee' => false,
       'caption_options' => {
         'inputs'=> [
-          { 'video_length_seconds' => 900, 'external_link' => 'http://www.youtube.com/watch?v=UF8uR6Z6KLc' }
+          { '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]]

data/spec/spec_helper.rb

@@ -1,7 +1,5 @@
-require 'coveralls'
-Coveralls.wear!
-
 require_relative '../lib/rev-api'
+require_relative 'test_helpers.rb'
 
 #dependencies
 require 'minitest/autorun'

data/spec/test_helpers.rb

@@ -0,0 +1,5 @@
+require_relative '../lib/rev-api'
+
+def create_input(options = {})
+  [Rev::Input.new(options)]
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rev-api
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Rev.com, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-16 00:00:00.000000000 Z
+date: 2018-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -116,14 +116,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.14
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.14
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -152,20 +152,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.8'
 description: Communicate with Rev.com API using plain Ruby objects without bothering
   about HTTP
 email: api@rev.com
@@ -173,7 +159,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .coveralls.yml
 - .gitignore
 - .ruby-gemset
 - .ruby-version
@@ -232,6 +217,7 @@ files:
 - spec/lib/rev/post_inputs_spec.rb
 - spec/lib/rev/post_order_spec.rb
 - spec/spec_helper.rb
+- spec/test_helpers.rb
 - spec/tmp_get_attachment_content
 homepage: https://www.rev.com/api
 licenses:
@@ -254,8 +240,50 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for Rev.com API
-test_files: []
+test_files:
+- spec/fixtures/api_cassettes/cancel_order.yml
+- spec/fixtures/api_cassettes/cancel_order_not_allowed.yml
+- spec/fixtures/api_cassettes/get_attachment_content.yml
+- spec/fixtures/api_cassettes/get_attachment_content_as_pdf.yml
+- spec/fixtures/api_cassettes/get_attachment_content_as_text.yml
+- spec/fixtures/api_cassettes/get_attachment_content_as_youtube_transcript.yml
+- spec/fixtures/api_cassettes/get_attachment_content_unacceptable_representation.yml
+- spec/fixtures/api_cassettes/get_attachment_content_with_invalid_id.yml
+- spec/fixtures/api_cassettes/get_attachment_metadata.yml
+- spec/fixtures/api_cassettes/get_attachment_with_invalid_id.yml
+- spec/fixtures/api_cassettes/get_orders.yml
+- spec/fixtures/api_cassettes/get_orders_with_clientRef.yml
+- spec/fixtures/api_cassettes/get_tc_order.yml
+- spec/fixtures/api_cassettes/get_third_page_of_orders.yml
+- spec/fixtures/api_cassettes/link_input.yml
+- spec/fixtures/api_cassettes/link_input_with_all_attributes.yml
+- spec/fixtures/api_cassettes/link_input_with_spaces_in_filename.yml
+- spec/fixtures/api_cassettes/not_found_order.yml
+- spec/fixtures/api_cassettes/submit_cp_order.yml
+- spec/fixtures/api_cassettes/submit_su_order.yml
+- spec/fixtures/api_cassettes/submit_tc_order_with_account_balance.yml
+- spec/fixtures/api_cassettes/submit_tc_order_with_invalid_request.yml
+- spec/fixtures/api_cassettes/submit_tc_order_without_specifying_payment.yml
+- spec/fixtures/api_cassettes/unauthorized.yml
+- spec/fixtures/api_cassettes/upload_input.yml
+- spec/fixtures/api_cassettes/upload_input_with_invalid_content_type.yml
+- 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
+- spec/test_helpers.rb
+- spec/tmp_get_attachment_content

data/.coveralls.yml

@@ -1,2 +0,0 @@
-service_name: travis-pro
-repo_token: sxagPJJLWdT4EPbWoaCHvarBQMCxbfCym