rev-api 1.0.0

data/spec/fixtures/api_cassettes/unauthorized.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api-sandbox.rev.com/api/v1/orders?page=0
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - Rev welcome:trololo
+      User-Agent:
+      - RevOfficialRubySDK/1.0.0
+  response:
+    status:
+      code: 401
+      message: Unauthorized
+    headers:
+      Cache-Control:
+      - no-cache
+      Pragma:
+      - no-cache
+      Expires:
+      - '-1'
+      Server:
+      - Microsoft-IIS/8.0
+      Www-Authenticate:
+      - Rev
+      X-Miniprofiler-Ids:
+      - ! '["5b5d655c-3f79-4e76-8e24-c6e36b7170fb"]'
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Thu, 12 Sep 2013 18:38:00 GMT
+      Content-Length:
+      - '0'
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Thu, 12 Sep 2013 18:38:05 GMT
+recorded_with: VCR 2.5.0

data/spec/fixtures/api_cassettes/upload_input.yml

@@ -0,0 +1,130 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://www.revtrunk.com/api/v1/inputs
+    body:
+      encoding: US-ASCII
+      string: ! 'iVBORw0KGgoAAAANSUhEUgAAAHMAAAAyCAYAAABvR+QvAAAGtklEQVR42u2c
+
+        z2scZRjH9w9QMxFBPEhHm7Smoe2ANGnamAxWqEqR9SIKoiOoeJIRc/Ako0gR
+
+        L4N48eTQowcdCAgWU6dumzSpttOiF0+DB3+kye5E/Bk1Xd/ZPKNvJzu77/O+
+
+        z0w2dA9fFtLu7Mz7eZ+f7ztvpdlsVjqpcWiocF1YnD8Gev7C4kLtRs2vMTUl
+
+        tZa53iz721ugGe53B8t4Thl148OrIgBTZ6oyORKymUyqB5u/GmpMJshicphc
+
+        poApZGoqKoJreXDt5DfMHQ8TIIRMTRKN7zm1OnXgoaIfngOewg4AkiroGK6V
+
+        QjZ2BEx2EYsM4la52zXLvzz9ycOLC+dmwPIoLLkJgF0ArHe7BzahB9nEfg7G
+
+        IUhVnxh5tSiYUYEwE3m9EpPAihNr88H6KFx1MlmszG8locrvMi4mKUx2AaNg
+
+        kKmsXkw4EvfJuWcVqK+3LPGB/Xewz88Ex4QcZrUkmFGvZpCpLp6du33p3NkX
+
+        F766eApptR8n3//xsem72OfXiDHRqWE6JcFsgheo7BQxSFVwoZ1Ahovnv7iF
+
+        gdyFDFceecyEi5YF00YOqAGuyG5TBlUpyyCBjNlqk0TFS7Vg3/dPnbiV/b9v
+
+        EeMQr0wf1IqAGWBuAmKfKWnRjsDgpYlDjLhuCMA1JCiTk4FIoFrWykA+C38/
+
+        gyzbnmk1T5YWTkK81qhgqiQxHiFMkyCrjmEyiEyYKCeuO0Jlz9ynQ8lnfeK+
+
+        N5D3mBhPZXG+diJT07agSsOEAIy5kaxbc4hguiVmzqagpXe18uVHjjyNnWw/
+
+        PXr07kuzHw3kNDZaUGVhmsib0QqA6ZWcbEUUtfF3Lzx5JzIUNBtjw63yZf7K
+
+        5XcEalcTC9NGurCKIsysC7QLTLb8nIQK5Q7zVJ8YOY+8nxDKn/2IksfFwHQV
+
+        H85XsGwdPbPxUpl8uTBXJ0dPYu+lfmRkChIobFsxzIulKplstseqKbb0PMkE
+
+        R8XV+gTxXaZj1hq7pdrnLyk0/Y1uMGOFh/OQEPSMVcq6Z0MhYQsVQkI6gbEZ
+
+        d7x8/PDgN++/e49iL3gLUJWyxOEG01fMLm1FCwkkYaomUPise3zP461YeeZ0
+
+        QLQsp22BKZHJUpYJoUIGLQvTVIy3MuMVcM0Gn2oJrh1Mq2CIeQU8xsVGOa5O
+
+        NDzokslPqPCbia4zNa49eP/uTEswJgJqZ2E6BYM0OnRfsBMibblVkVYtm/wE
+
+        Ct9NQG7UD+99pU0r0CKCGWdhBgXC7NQSK2uVJltnyiZ7VSxIprkOvd2ICKjF
+
+        wwwb27NVJNiGWK1LTkZR95pC/IdpZfn4+O4OMF0SmFcue7KZLOVCdFQCyEAx
+
+        eTER7vU6KAH5V2Ns+GWBNVIKmEGZW0Xy1hrLcK+aYtvQEHSvqUX+3QJ5aOhD
+
+        wSU0CpjSW0V8iRrLKxFmCPdnEMVpEfe6wYH8g+mHpDlQIsxINpOVyeriNhZi
+
+        SLjrACYGv8uAX1QWWYR2kfftC7rVBOSfTL8xTSK2opC6WU8y/lmKDQPVJTdZ
+
+        YXdTiIJMLPJXptcQW1BcqlpTpiwJFLLCoEdgUiRd7UD+wjSL3E9EVZroKj1Z
+
+        2YHRFWJmlNm8xTcPUpcbgDXFHXYYUIHcyIC8xHQbAiRV08BrNQ1Wpw7cq+gq
+
+        XcXJUPYapkkEM60j15l+hok2itzhR/UOjL4Jc3L0mGKJUVWsOf0dBpN3r+sQ
+
+        I1eZnkC6V6pGe/W/Rnv96L4ZxcHRJAbEUEiithMm717XIWut18f3vokE6VA2
+
+        2P+HOTHynuK+H5lWoKP4fZXOEwXMdShBkvH4AAmSKk5u2bVXYbOqRrAPBhs3
+
+        7Tb1ZhGx01NccmsHM60lk4QnWJk+OIAA6VE11dvuAWqMDa8RNMyxy1h6zl4a
+
+        6j6tTtzcT2H+zlQTzVwh2QmIXhc0cnfnMZhXERA6dVhiQcvutO1fAxesaqVx
+
+        l43PmoRrT5OexCrfZhpAdHgoFqG9bjvcN9/k3XR7Pv8mLycf/r3bW8F69m1g
+
+        7vsO8o0vDazdRVhR2uazEM0FC+4vEoi9yfsjyablXYIQdaKMVWgDtOgBFb0m
+
+        vZdfBQSX6hBBtKhPG+kLBzEmgGinb4L1YZYLUYd4pgoxbHMOQh9mSRAtggw1
+
+        holglHWoU183Hl5BYYV+OyvswyzvHIOIwAIt/q3oPsxyYqBNcC5QCAmR0jkL
+
+        fZh412kTWF96FJuJtb4+THlwVYJDm/gj1gqteW96mAAtPUbNkwQXZ064NEXO
+
+        xuvDxMc0k4OVnnsXIGJcehRpamEOuFqzrNMqb0qYXExzEKpywE3qONarMP8F
+
+        PE/RzQd+eHkAAAAASUVORK5CYII=
+
+'
+    headers:
+      Accept:
+      - ! '*/*'
+      Content-Disposition:
+      - attachment; filename=sourcedocument.png
+      Content-Type:
+      - image/png
+      Content-Length:
+      - '1775'
+      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:
+      - urn:foxtranslate:inputmedia:SnVwbG9hZHMvMjAxMy0wOS0xNy9lMzk4MWIzNS0wNzM1LTRlMDAtODY1NC1jNWY4ZjE4MzdlMTIvc291cmNlZG9jdW1lbnQucG5n
+      Server:
+      - Microsoft-IIS/7.5
+      X-Miniprofiler-Ids:
+      - ! '["bda0d010-c658-4ff5-a201-4b1395adf2e6","5ef43220-60f5-458c-9ebb-864d8349345c"]'
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Tue, 17 Sep 2013 21:42:29 GMT
+      Content-Length:
+      - '0'
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Tue, 17 Sep 2013 21:42:29 GMT
+recorded_with: VCR 2.5.0

data/spec/fixtures/api_cassettes/upload_input_with_invalid_content_type.yml

@@ -0,0 +1,131 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://www.revtrunk.com/api/v1/inputs
+    body:
+      encoding: US-ASCII
+      string: ! 'iVBORw0KGgoAAAANSUhEUgAAAHMAAAAyCAYAAABvR+QvAAAGtklEQVR42u2c
+
+        z2scZRjH9w9QMxFBPEhHm7Smoe2ANGnamAxWqEqR9SIKoiOoeJIRc/Ako0gR
+
+        L4N48eTQowcdCAgWU6dumzSpttOiF0+DB3+kye5E/Bk1Xd/ZPKNvJzu77/O+
+
+        z0w2dA9fFtLu7Mz7eZ+f7ztvpdlsVjqpcWiocF1YnD8Gev7C4kLtRs2vMTUl
+
+        tZa53iz721ugGe53B8t4Thl148OrIgBTZ6oyORKymUyqB5u/GmpMJshicphc
+
+        poApZGoqKoJreXDt5DfMHQ8TIIRMTRKN7zm1OnXgoaIfngOewg4AkiroGK6V
+
+        QjZ2BEx2EYsM4la52zXLvzz9ycOLC+dmwPIoLLkJgF0ArHe7BzahB9nEfg7G
+
+        IUhVnxh5tSiYUYEwE3m9EpPAihNr88H6KFx1MlmszG8locrvMi4mKUx2AaNg
+
+        kKmsXkw4EvfJuWcVqK+3LPGB/Xewz88Ex4QcZrUkmFGvZpCpLp6du33p3NkX
+
+        F766eApptR8n3//xsem72OfXiDHRqWE6JcFsgheo7BQxSFVwoZ1Ahovnv7iF
+
+        gdyFDFceecyEi5YF00YOqAGuyG5TBlUpyyCBjNlqk0TFS7Vg3/dPnbiV/b9v
+
+        EeMQr0wf1IqAGWBuAmKfKWnRjsDgpYlDjLhuCMA1JCiTk4FIoFrWykA+C38/
+
+        gyzbnmk1T5YWTkK81qhgqiQxHiFMkyCrjmEyiEyYKCeuO0Jlz9ynQ8lnfeK+
+
+        N5D3mBhPZXG+diJT07agSsOEAIy5kaxbc4hguiVmzqagpXe18uVHjjyNnWw/
+
+        PXr07kuzHw3kNDZaUGVhmsib0QqA6ZWcbEUUtfF3Lzx5JzIUNBtjw63yZf7K
+
+        5XcEalcTC9NGurCKIsysC7QLTLb8nIQK5Q7zVJ8YOY+8nxDKn/2IksfFwHQV
+
+        H85XsGwdPbPxUpl8uTBXJ0dPYu+lfmRkChIobFsxzIulKplstseqKbb0PMkE
+
+        R8XV+gTxXaZj1hq7pdrnLyk0/Y1uMGOFh/OQEPSMVcq6Z0MhYQsVQkI6gbEZ
+
+        d7x8/PDgN++/e49iL3gLUJWyxOEG01fMLm1FCwkkYaomUPise3zP461YeeZ0
+
+        QLQsp22BKZHJUpYJoUIGLQvTVIy3MuMVcM0Gn2oJrh1Mq2CIeQU8xsVGOa5O
+
+        NDzokslPqPCbia4zNa49eP/uTEswJgJqZ2E6BYM0OnRfsBMibblVkVYtm/wE
+
+        Ct9NQG7UD+99pU0r0CKCGWdhBgXC7NQSK2uVJltnyiZ7VSxIprkOvd2ICKjF
+
+        wwwb27NVJNiGWK1LTkZR95pC/IdpZfn4+O4OMF0SmFcue7KZLOVCdFQCyEAx
+
+        eTER7vU6KAH5V2Ns+GWBNVIKmEGZW0Xy1hrLcK+aYtvQEHSvqUX+3QJ5aOhD
+
+        wSU0CpjSW0V8iRrLKxFmCPdnEMVpEfe6wYH8g+mHpDlQIsxINpOVyeriNhZi
+
+        SLjrACYGv8uAX1QWWYR2kfftC7rVBOSfTL8xTSK2opC6WU8y/lmKDQPVJTdZ
+
+        YXdTiIJMLPJXptcQW1BcqlpTpiwJFLLCoEdgUiRd7UD+wjSL3E9EVZroKj1Z
+
+        2YHRFWJmlNm8xTcPUpcbgDXFHXYYUIHcyIC8xHQbAiRV08BrNQ1Wpw7cq+gq
+
+        XcXJUPYapkkEM60j15l+hok2itzhR/UOjL4Jc3L0mGKJUVWsOf0dBpN3r+sQ
+
+        I1eZnkC6V6pGe/W/Rnv96L4ZxcHRJAbEUEiithMm717XIWut18f3vokE6VA2
+
+        2P+HOTHynuK+H5lWoKP4fZXOEwXMdShBkvH4AAmSKk5u2bVXYbOqRrAPBhs3
+
+        7Tb1ZhGx01NccmsHM60lk4QnWJk+OIAA6VE11dvuAWqMDa8RNMyxy1h6zl4a
+
+        6j6tTtzcT2H+zlQTzVwh2QmIXhc0cnfnMZhXERA6dVhiQcvutO1fAxesaqVx
+
+        l43PmoRrT5OexCrfZhpAdHgoFqG9bjvcN9/k3XR7Pv8mLycf/r3bW8F69m1g
+
+        7vsO8o0vDazdRVhR2uazEM0FC+4vEoi9yfsjyablXYIQdaKMVWgDtOgBFb0m
+
+        vZdfBQSX6hBBtKhPG+kLBzEmgGinb4L1YZYLUYd4pgoxbHMOQh9mSRAtggw1
+
+        holglHWoU183Hl5BYYV+OyvswyzvHIOIwAIt/q3oPsxyYqBNcC5QCAmR0jkL
+
+        fZh412kTWF96FJuJtb4+THlwVYJDm/gj1gqteW96mAAtPUbNkwQXZ064NEXO
+
+        xuvDxMc0k4OVnnsXIGJcehRpamEOuFqzrNMqb0qYXExzEKpywE3qONarMP8F
+
+        PE/RzQd+eHkAAAAASUVORK5CYII=
+
+'
+    headers:
+      Accept:
+      - ! '*/*'
+      Content-Disposition:
+      - attachment; filename=sourcedocument.png
+      Content-Type:
+      - trololo
+      Content-Length:
+      - '1775'
+      Authorization:
+      - Rev welcome:AAAAAu/YjZ3phXU5FsF35yIcgiA=
+      User-Agent:
+      - RevOfficialRubySDK/1.0.0
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Cache-Control:
+      - no-cache
+      Pragma:
+      - no-cache
+      Content-Type:
+      - application/json; charset=utf-8
+      Expires:
+      - '-1'
+      Server:
+      - Microsoft-IIS/7.5
+      X-Miniprofiler-Ids:
+      - ! '["898ff908-ed7d-4ba9-a7d4-1ef77477b595","9fe829e6-5487-4079-bc96-5c95abf1cf80","e7f8c536-dacd-4a4e-a594-e1660295c0f5","dabe1796-e497-463b-946e-bbedf84dddcb"]'
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Tue, 17 Sep 2013 21:25:06 GMT
+      Content-Length:
+      - '112'
+    body:
+      encoding: US-ASCII
+      string: ! '{"code":10001,"message":"The content-type explicitly specified in
+        the request is not supported for input media"}'
+    http_version: 
+  recorded_at: Tue, 17 Sep 2013 21:25:06 GMT
+recorded_with: VCR 2.5.0

data/spec/lib/rev/api_spec.rb

@@ -0,0 +1,24 @@
+require_relative '../../spec_helper'
+
+describe 'API Client' do
+  let(:client) { Rev.new('welcome', 'AAAAAu/YjZ3phXU5FsF35yIcgiA=', 'www.revtrunk.com') }
+
+  it 'must raise NotAuthorizedError on unauthorized HTTP response' do
+    VCR.insert_cassette 'unauthorized'
+
+    unauthorized_client = Rev.new('welcome', 'trololo', Rev::Api::SANDBOX_HOST)
+    action = lambda { unauthorized_client.get_orders_page }
+    action.must_raise Rev::NotAuthorizedError
+  end
+
+  it 'must raise NotFoundError on NotFound HTTP response' do
+    VCR.insert_cassette 'not_found_order'
+
+    action = lambda { client.get_order('trololo') }
+    action.must_raise Rev::NotFoundError
+  end
+
+  after do
+    VCR.eject_cassette
+  end
+end

data/spec/lib/rev/cancel_order_spec.rb

@@ -0,0 +1,25 @@
+require_relative '../../spec_helper'
+
+describe 'POST /orders/{order_num}/cancel' do
+  let(:client) { Rev.new('welcome', 'AAAAAu/YjZ3phXU5FsF35yIcgiA=', 'www.revtrunk.com') }
+
+  it 'must cancel order' do
+    VCR.insert_cassette 'cancel_order'
+
+    client.cancel_order('TC0166192942').must_equal true
+
+    assert_requested :post, /.*\/api\/v1\/orders\/TC0166192942\/cancel/, :times => 1,
+      :body => { :order_num => 'TC0166192942' }
+  end
+
+  it 'must raise ForbiddenError when cancellation is not allowed' do
+    VCR.insert_cassette 'cancel_order_not_allowed'
+
+    action = lambda { client.cancel_order('TC0367111289') }
+    action.must_raise Rev::ForbiddenError
+  end
+
+  after do
+    VCR.eject_cassette
+  end
+end

data/spec/lib/rev/get_attachment_content_spec.rb

@@ -0,0 +1,79 @@
+require_relative '../../spec_helper'
+
+describe 'GET /attachments/{id}/content' do
+  let(:client) { Rev.new('welcome', 'AAAAAu/YjZ3phXU5FsF35yIcgiA=', 'www.revtrunk.com') }
+
+  filename = './spec/tmp_get_attachment_content'
+
+  before do
+    File.delete filename if File.file? filename # clean before
+  end
+
+  after do
+    File.delete filename if File.file? filename # clean after
+  end
+
+  describe 'success' do
+
+    describe 'must save binary content to file' do
+      it 'when no representation given' do
+        VCR.insert_cassette 'get_attachment_content'
+        # we just save mocked binary response body to file and check for existence
+        client.save_attachment_content('4QWoFrwBAAABAAAA', filename) # from order TC0380110305
+        File.file?(filename).must_equal true
+
+        assert_requested :get, /.*\/api\/v1\/attachments\/4QWoFrwBAAABAAAA\/content/, :times => 1
+      end
+
+      it 'using given correct representation' do
+        VCR.insert_cassette 'get_attachment_content_as_pdf'
+
+        client.save_attachment_content('4QWoFrwBAAABAAAA', filename, Rev::Attachment::REPRESENTATIONS[:pdf])
+        File.file?(filename).must_equal true
+        # we don't actually check whether it's PDF - we assume it is. We just supply headers as requested
+      end
+    end
+
+    it 'must specify Accept-Charset header for plain text' do
+      VCR.insert_cassette 'get_attachment_content_as_text'
+
+      client.save_attachment_content('4QWoFrwBAAABAAAA', filename, Rev::Attachment::REPRESENTATIONS[:txt])
+
+      assert_requested :get, /.*\/api\/v1\/attachments\/4QWoFrwBAAABAAAA\/content/, :times => 1 do |req|
+        req.headers['Accept-Charset'].must_equal 'utf-8'
+      end
+    end
+
+    it 'must specify Accept-Charset header for youtube transcript' do
+      VCR.insert_cassette 'get_attachment_content_as_youtube_transcript'
+
+      client.save_attachment_content('4QWoFrwBAAABAAAA', filename, Rev::Attachment::REPRESENTATIONS[:youtube])
+
+      assert_requested :get, /.*\/api\/v1\/attachments\/4QWoFrwBAAABAAAA\/content/, :times => 1 do |req|
+        req.headers['Accept-Charset'].must_equal 'utf-8'
+      end
+    end
+  end
+
+  it 'must raise NotFoundError when attachment id is invalid' do
+    VCR.insert_cassette 'get_attachment_content_with_invalid_id'
+
+    action = lambda { client.save_attachment_content('trololo', filename) }
+    action.must_raise Rev::NotFoundError
+  end
+
+  # requesting conversion from pdf to :docx from order TC0263917003
+  it 'must raise NotAcceptableError when requested representation is not supported by API' do
+    VCR.insert_cassette 'get_attachment_content_unacceptable_representation'
+
+    action = lambda { client.save_attachment_content('yw27D3gCAAABAAAA', filename,
+      Rev::Attachment::REPRESENTATIONS[:docx]) }
+    action.must_raise Rev::NotAcceptableError
+  end
+
+  after do
+    VCR.eject_cassette
+  end
+end
+
+

data/spec/lib/rev/get_attachment_metadata_spec.rb

@@ -0,0 +1,33 @@
+require_relative '../../spec_helper'
+
+describe 'GET /attachments/{id}' do
+  let(:client) { Rev.new('welcome', 'AAAAAu/YjZ3phXU5FsF35yIcgiA=', 'www.revtrunk.com') }
+
+  it 'must retrieve metadata' do
+    VCR.insert_cassette 'get_attachment_metadata'
+
+    attachment = client.get_attachment_metadata('LufnCVQCAAAAAAAA')
+
+    assert_requested :get, /.*\/api\/v1\/attachments\/LufnCVQCAAAAAAAA/, :times => 1
+
+    attachment.id.must_equal 'LufnCVQCAAAAAAAA'
+    attachment.name.must_equal 'How can I find success in life.mp4'
+    attachment.kind.must_equal 'media'
+    attachment.audio_length.must_equal 5
+    attachment.links.must_be_instance_of Array
+    attachment.links.size.must_equal 1
+    attachment.links.first.rel.must_equal 'content'
+    attachment.links.first.href.must_equal 'https://www.revtrunk.com/api/v1/attachments/LufnCVQCAAAAAAAA/content'
+  end
+
+  it 'must raise NotFoundError when attachment id is invalid' do
+    VCR.insert_cassette 'get_attachment_with_invalid_id'
+
+    action = lambda { client.get_attachment_metadata('trololo') }
+    action.must_raise Rev::NotFoundError
+  end
+
+  after do
+    VCR.eject_cassette
+  end
+end