rev-api 1.0.0

data/spec/lib/rev/get_order_spec.rb

@@ -0,0 +1,68 @@
+require_relative '../../spec_helper'
+
+describe 'GET /orders/{order_num}' do
+  let(:client) { Rev.new('welcome', 'AAAAAu/YjZ3phXU5FsF35yIcgiA=', 'www.revtrunk.com') }
+
+  describe 'Transcription' do
+    before do
+      VCR.insert_cassette 'get_tc_order'
+    end
+
+    it 'must get an order by given order number' do
+      client.get_order('TC0233908691').wont_be_nil
+
+      assert_requested :get, /.*\/api\/v1\/orders\/TC0233908691/, :times => 1
+    end
+
+    describe 'loaded order' do
+      let(:order) { client.get_order('TC0233908691') }
+
+      it 'must have basic attributes' do
+        order.order_number.must_equal 'TC0233908691'
+        order.price.must_equal 10.0
+        order.status.must_equal 'Finding Transcriptionist'
+        order.client_ref.must_equal 'XC123'
+      end
+
+      it 'must have comments' do
+        order.comments.size.must_equal 1
+        order.comments.first.by.must_equal 'Admin Admin'
+        order.comments.first.text.must_be_empty
+        order.comments.first.timestamp.day.must_equal 6
+        order.comments.first.timestamp.month.must_equal 9
+        order.comments.first.timestamp.year.must_equal 2013
+      end
+
+      it 'must have attachments' do
+        order.attachments.size.must_equal 1
+        order.attachments.first.kind.must_equal 'media'
+      end
+
+      it 'must have transcription info' do
+        order.transcription.total_length.must_equal 10
+        order.transcription.verbatim.must_equal false
+        order.transcription.timestamps.must_equal false
+      end
+    end
+  end
+
+  describe 'Translation' do
+    before do
+      VCR.insert_cassette 'get_tr_order'
+    end
+
+    describe 'loaded order' do
+      let(:order) { client.get_order('TR0116711100') }
+
+      it 'must have translation info' do
+        order.translation.total_word_count.must_equal 2
+        order.translation.source_language_code.must_equal 'cs'
+        order.translation.destination_language_code.must_equal 'en'
+      end
+    end
+  end
+
+  after do
+    VCR.eject_cassette
+  end
+end

data/spec/lib/rev/get_orders_spec.rb

@@ -0,0 +1,39 @@
+require_relative '../../spec_helper'
+
+describe 'GET /orders' do
+  let(:client) { Rev.new('welcome', 'AAAAAu/YjZ3phXU5FsF35yIcgiA=', 'www.revtrunk.com') }
+
+  describe 'GET /orders without page number' do
+    it 'must get first page of existing orders' do
+      VCR.insert_cassette 'get_orders'
+
+      page = client.get_orders_page
+
+      assert_requested :get, /.*\/api\/v1\/orders\?page=0/, :times => 1
+
+      page.orders.must_be_instance_of Array
+      page.results_per_page.must_equal 8
+      page.orders.size.must_equal 8
+      page.page.must_equal 0
+      page.total_count.must_equal 77
+    end
+  end
+
+  describe 'GET /orders?page={pagenum}' do
+    it 'must load any page' do
+      VCR.insert_cassette 'get_third_page_of_orders'
+
+      page = client.get_orders_page(2)
+
+      assert_requested :get, /.*\/api\/v1\/orders\?page=2/, :times => 1
+
+      page.orders.size.must_equal 8
+      page.page.must_equal 2
+      page.orders.first.order_number.must_equal 'TC0229215557'
+    end
+  end
+
+  after do
+    VCR.eject_cassette
+  end
+end

data/spec/lib/rev/http_client_spec.rb

@@ -0,0 +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, host)
+
+    client = Rev::HttpClient.new('foo', 'bar', host)
+    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/post_inputs_spec.rb

@@ -0,0 +1,75 @@
+require_relative '../../spec_helper'
+require 'base64'
+
+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 = 'http://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:foxtranslate:inputmedia:'
+    expected_body = {
+      'url' => link,
+      'filename' => filename,
+      'content_type' => content_type
+    }
+    assert_requested(:post, /.*\/inputs/, :times => 1) do |req|
+      req.headers['Content-Type'] == 'application/json'
+      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 = 'http://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:foxtranslate:inputmedia:'
+    expected_body = { 'url' => link }
+    assert_requested(:post, /.*\/inputs/, :times => 1) do |req|
+      req.headers['Content-Type'] == '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:foxtranslate:inputmedia:'
+    expected_body = File.read(filename)
+    assert_requested(:post, /.*\/inputs/, :times => 1) do |req|
+      req.headers['Content-Type'] == content_type
+      req.headers['Content-Disposition'] == '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

data/spec/lib/rev/post_order_spec.rb

@@ -0,0 +1,207 @@
+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(:credit_card) { Rev::CreditCard.new(
+    :number => '4111111111111111',
+    :expiration_month => 9,
+    :expiration_year => 2023,
+    :cardholder => 'Joe Smith',
+    :billing_address => billing_address
+  )}
+  let(:cc_payment) { Rev::Payment.new(Rev::Payment::TYPES[:credit_card], credit_card) }
+  let(:saved_cc_payment) { Rev::Payment.new(Rev::Payment::TYPES[:credit_card], :saved_id => 1) }
+  let(:balance_payment) { Rev::Payment.new(Rev::Payment::TYPES[:balance]) }
+  let(:transcription_inputs) {
+      inputs = []
+      inputs << Rev::Input.new(:external_link => 'http://www.youtube.com/watch?v=UF8uR6Z6KLc')
+      inputs << Rev::Input.new(:audio_length => 15, :external_link => 'https://vimeo.com/7976699')
+  }
+  let(:translation_inputs) {
+    inputs = []
+    inputs << Rev::Input.new(:word_length => 1000, :uri => 'urn:foxtranslate:inputmedia:SnVwbG9hZHMvMjAxMy0wOS0xNy9lMzk4MWIzNS0wNzM1LTRlMDAtODY1NC1jNWY4ZjE4MzdlMTIvc291cmNlZG9jdW1lbnQucG5n')
+  }
+  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') }
+
+  it 'must submit order using Credit Card including all attributes' do
+    VCR.insert_cassette 'submit_tc_order_with_cc_and_all_attributes'
+
+    request = Rev::OrderRequest.new(
+      cc_payment,
+      :transcription_options => transcription_options,
+      :client_ref => 'XB432423',
+      :comment => 'Please work quickly',
+      :notification => Rev::Notification.new('http://www.example.com', Rev::Notification::LEVELS[:detailed])
+    )
+
+    new_order_num = client.submit_order(request)
+
+    new_order_num.must_equal 'TC0520815415'
+    expected_body = {
+      'payment' => {
+        'type' => 'CreditCard',
+        'credit_card' => {
+          'number' => '4111111111111111',
+          'expiration_month' => 9,
+          'expiration_year' => 2023,
+          'cardholder' => 'Joe Smith',
+          'billing_address' => {
+            'street' => '123 Pine Lane',
+            'street2' => 'Apt D',
+            'city' => 'MyTown',
+            'state' => 'MN',
+            'zip' => '12345',
+            'country_alpha2' => 'US'
+          }
+        }
+      },
+      'transcription_options' => {
+        'inputs'=> [
+          { 'external_link' => 'http://www.youtube.com/watch?v=UF8uR6Z6KLc' },
+          { 'audio_length' => 15, 'external_link' => 'https://vimeo.com/7976699' }
+        ],
+        'verbatim' => true,
+        'timestamps' => true
+      },
+      'client_ref' => 'XB432423',
+      'comment' => 'Please work quickly',
+      'notification' => {
+        'url' => 'http://www.example.com',
+        'level' => 'Detailed'
+      }
+    }
+    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
+
+  it 'must place order using saved credit card' do
+    VCR.insert_cassette 'submit_tc_order_with_saved_cc'
+
+    request = Rev::OrderRequest.new(
+      saved_cc_payment,
+      :transcription_options => transcription_options
+    )
+
+    new_order_num = client.submit_order(request)
+
+    new_order_num.must_equal 'TC0370955571'
+    expected_body = {
+      'payment' => {
+        'type' => 'CreditCard',
+        'credit_card' => {
+          'saved_id' => 1
+        }
+      },
+      'transcription_options' => {
+        'inputs' => [
+          { 'external_link' => 'http://www.youtube.com/watch?v=UF8uR6Z6KLc' },
+          { 'external_link' => 'https://vimeo.com/7976699', 'audio_length'=>15 }
+        ],
+        'verbatim'=>true,
+        'timestamps'=>true
+      }
+    }
+    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
+
+  it 'must place order using account balance' do
+    VCR.insert_cassette 'submit_tc_order_with_account_balance'
+
+    request = Rev::OrderRequest.new(
+      balance_payment,
+      :transcription_options => transcription_options
+    )
+
+    new_order_num = client.submit_order(request)
+
+    new_order_num.must_equal 'TC0406615008'
+    expected_body = {
+      'payment' => {
+        'type' => 'AccountBalance'
+      },
+      'transcription_options' => {
+        'inputs' => [
+          { 'external_link' => 'http://www.youtube.com/watch?v=UF8uR6Z6KLc' },
+          { 'external_link' => 'https://vimeo.com/7976699', 'audio_length' => 15 }
+        ],
+        'verbatim' => true,
+        'timestamps' => true
+      }
+    }
+    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
+
+  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(
+      balance_payment
+    )
+
+    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 translation options' do
+    VCR.insert_cassette 'submit_tr_order'
+
+    request = Rev::OrderRequest.new(
+      balance_payment,
+      :translation_options => translation_options
+    )
+
+    new_order_num = client.submit_order(request)
+
+    new_order_num.must_equal 'TR0235803277'
+    expected_body = {
+      'payment' => {
+        'type' => 'AccountBalance'
+      },
+      'translation_options' => {
+        'inputs'=> [
+          { 'word_length' => 1000, 'uri' => 'urn:foxtranslate:inputmedia:SnVwbG9hZHMvMjAxMy0wOS0xNy9lMzk4MWIzNS0wNzM1LTRlMDAtODY1NC1jNWY4ZjE4MzdlMTIvc291cmNlZG9jdW1lbnQucG5n' },
+        ],
+        'source_language_code' => 'es',
+        'destination_language_code' => 'en'
+      }
+    }
+    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
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+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, :headers] }
+  c.hook_into :webmock
+  c.ignore_hosts 'www.example.com' # used to stub requests manually, see http_client_spec
+end