transcribeme 0.0.5.beta → 1.0.0.alpha

data/lib/transcribeme/version.rb

@@ -1,3 +1,4 @@
+# TranscribeMe namespace
 module TranscribeMe
-  VERSION = "0.0.5.beta"
+  VERSION = '1.0.0.alpha'
 end

data/spec/lib/api/client_spec.rb

@@ -2,15 +2,143 @@ require 'transcribeme'
 require 'spec_helper'
 
 describe TranscribeMe::API::Client do
-  
+
+  GUID_REGEX = /[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-(:?8|9|a|b)[a-f0-9]{3}-[a-f0-9]{12}/
+
   before :all do
-    VCR.use_cassette('new_session') do
-      @client = TranscribeMe::API::Client.new 
-    end
+    @client = TranscribeMe::API::Client.new
   end
 
-  it "should be valid" do
+  it 'assigns an instance to a variable' do
     @client.should_not be_nil
   end
 
+  describe 'initializing a session' do
+
+    before :each do
+      VCR.use_cassette('new_session') do
+        @client.initialize_session
+      end
+    end
+
+    it 'has a session id property' do
+      expect(@client.session_id).to_not be_nil
+    end
+
+    it 'uses the session id in the VCR fixture' do
+      expect(@client.session_id).to match GUID_REGEX
+      expect(@client.session_id).to_not be '00000000-0000-0000-0000-000000000000'
+    end
+
+    it 'has an expiry time that is in the future' do
+      @client.session_expiry_time.should > Time.now
+    end
+
+  end
+
+  describe 'logging in as a customer' do
+
+    context 'successfully' do
+
+      context 'before initializing a session' do
+
+        before :all do
+          @another_client = TranscribeMe::API::Client.new
+        end
+
+        it 'logs in with a valid username and password' do
+          VCR.use_cassette('successful_sign_in') do
+            @result = @another_client.sign_in('example@transcribeme.com', 'example')
+          end
+
+          expect(@result).to match GUID_REGEX
+          expect(@result).to_not be '00000000-0000-0000-0000-000000000000'
+        end
+
+      end
+
+      context 'after initializing a session' do
+
+        it 'logs in with a valid username and password' do
+          VCR.use_cassette('successful_sign_in_after_initialize_call') do
+            @client.initialize_session
+            @result = @client.sign_in('example@transcribeme.com', 'example')
+          end
+
+          expect(@result).to match GUID_REGEX
+          expect(@result).to_not be '00000000-0000-0000-0000-000000000000'
+        end
+
+      end
+
+    end
+
+    context 'unsuccessfully' do
+
+      it 'logs in with an invalid username and password' do
+        VCR.use_cassette('unsuccessful_sign_in') do
+          @another_client = TranscribeMe::API::Client.new
+
+          expect do 
+            @another_client.sign_in('invalid_example@transcribeme.com', 'invalid_example')
+          end.to raise_error "Provided credentials are invalid. Please check your login and password and try again."
+
+        end
+
+      end
+
+    end
+  end
+
+  describe 'getting a list of recordings' do
+
+    before :each do
+      VCR.use_cassette('list_of_recordings') do
+        @client.initialize_session
+        @client.sign_in('example@transcribeme.com', 'example')
+        @recordings = @client.get_recordings
+      end
+    end
+
+    it 'returns an array of recordings' do
+      expect(@recordings.class.to_s).to eq "Array"
+    end
+
+    describe 'recordings' do
+
+      before :each do
+        @recording = @recordings.first
+      end
+
+      it 'has properties' do
+        expect(@recording.keys).to eq [:date_created, :duration, :id, :name, :status]
+      end
+
+    end
+
+  end
+
+  describe 'get an upload url' do
+
+    before :each do
+      VCR.use_cassette('upload_url') do
+        @client.initialize_session
+        @client.sign_in('example@transcribeme.com', 'example')
+        @url = @client.get_upload_url
+      end
+    end
+
+    it 'produces an upload url on Windows Azure Blob storage' do
+      expect(@url).to start_with "https://transcribeme.blob.core.windows.net/recordings/"
+    end
+
+  end
+
+  describe 'upload a file' do
+
+
+    it 'uploads successfully'
+
+  end
+
 end

data/spec/spec_helper.rb

@@ -8,7 +8,7 @@
 require 'coveralls'
 Coveralls.wear!
 
-# The VCR gem uses yaml fixtures instead of live HTTP requests 
+# The VCR gem uses yaml fixtures instead of live HTTP requests
 require 'vcr'
 require 'webmock'
 

data/spec/support/cassettes/list_of_recordings.yml

@@ -0,0 +1,212 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://transcribeme-api.cloudapp.net/PortalAPI.svc?wsdl=wsdl0
+    body:
+      encoding: UTF-8
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - private
+      Content-Type:
+      - text/xml; charset=UTF-8
+      Server:
+      - Microsoft-IIS/7.0
+      X-Aspnet-Version:
+      - 4.0.30319
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Mon, 26 Aug 2013 01:11:42 GMT
+      Content-Length:
+      - '4961'
+      Connection:
+      - Keep-Alive
+    body:
+      encoding: UTF-8
+      string: <?xml version="1.0" encoding="utf-8"?><wsdl:definitions targetNamespace="http://tempuri.org/"
+        xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:wsx="http://schemas.xmlsoap.org/ws/2004/09/mex"
+        xmlns:wsa10="http://www.w3.org/2005/08/addressing" xmlns:tns="http://tempuri.org/"
+        xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
+        xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy" xmlns:wsap="http://schemas.xmlsoap.org/ws/2004/08/addressing/policy"
+        xmlns:msc="http://schemas.microsoft.com/ws/2005/12/wsdl/contract" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"
+        xmlns:wsam="http://www.w3.org/2007/05/addressing/metadata" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
+        xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:i0="http://TranscribeMe.API.Web"
+        xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"><wsdl:import
+        namespace="http://TranscribeMe.API.Web" location="http://transcribeme-api.cloudapp.net/PortalAPI.svc?wsdl"/><wsdl:types/><wsdl:binding
+        name="BasicHttpBinding_IPortalAPI" type="i0:IPortalAPI"><soap:binding transport="http://schemas.xmlsoap.org/soap/http"/><wsdl:operation
+        name="InitializeSession"><soap:operation soapAction="http://TranscribeMe.API.Web/IPortalAPI/InitializeSession"
+        style="document"/><wsdl:input><soap:body use="literal"/></wsdl:input><wsdl:output><soap:body
+        use="literal"/></wsdl:output></wsdl:operation><wsdl:operation name="SignUp"><soap:operation
+        soapAction="http://TranscribeMe.API.Web/IPortalAPI/SignUp" style="document"/><wsdl:input><soap:body
+        use="literal"/></wsdl:input><wsdl:output><soap:body use="literal"/></wsdl:output></wsdl:operation><wsdl:operation
+        name="SignIn"><soap:operation soapAction="http://TranscribeMe.API.Web/IPortalAPI/SignIn"
+        style="document"/><wsdl:input><soap:body use="literal"/></wsdl:input><wsdl:output><soap:body
+        use="literal"/></wsdl:output></wsdl:operation><wsdl:operation name="GetUploadUrl"><soap:operation
+        soapAction="http://TranscribeMe.API.Web/IPortalAPI/GetUploadUrl" style="document"/><wsdl:input><soap:body
+        use="literal"/></wsdl:input><wsdl:output><soap:body use="literal"/></wsdl:output></wsdl:operation><wsdl:operation
+        name="CommitUpload"><soap:operation soapAction="http://TranscribeMe.API.Web/IPortalAPI/CommitUpload"
+        style="document"/><wsdl:input><soap:body use="literal"/></wsdl:input><wsdl:output><soap:body
+        use="literal"/></wsdl:output></wsdl:operation><wsdl:operation name="TranscribeRecording"><soap:operation
+        soapAction="http://TranscribeMe.API.Web/IPortalAPI/TranscribeRecording" style="document"/><wsdl:input><soap:body
+        use="literal"/></wsdl:input><wsdl:output><soap:body use="literal"/></wsdl:output></wsdl:operation><wsdl:operation
+        name="GetRecordingInfo"><soap:operation soapAction="http://TranscribeMe.API.Web/IPortalAPI/GetRecordingInfo"
+        style="document"/><wsdl:input><soap:body use="literal"/></wsdl:input><wsdl:output><soap:body
+        use="literal"/></wsdl:output></wsdl:operation><wsdl:operation name="GetCustomerRecordings"><soap:operation
+        soapAction="http://TranscribeMe.API.Web/IPortalAPI/GetCustomerRecordings"
+        style="document"/><wsdl:input><soap:body use="literal"/></wsdl:input><wsdl:output><soap:body
+        use="literal"/></wsdl:output></wsdl:operation><wsdl:operation name="FinalizeSession"><soap:operation
+        soapAction="http://TranscribeMe.API.Web/IPortalAPI/FinalizeSession" style="document"/><wsdl:input><soap:body
+        use="literal"/></wsdl:input><wsdl:output><soap:body use="literal"/></wsdl:output></wsdl:operation><wsdl:operation
+        name="GetTranscription"><soap:operation soapAction="http://TranscribeMe.API.Web/IPortalAPI/GetTranscription"
+        style="document"/><wsdl:input><soap:body use="literal"/></wsdl:input><wsdl:output><soap:body
+        use="literal"/></wsdl:output></wsdl:operation><wsdl:operation name="GetTranscriptionLink"><soap:operation
+        soapAction="http://TranscribeMe.API.Web/IPortalAPI/GetTranscriptionLink" style="document"/><wsdl:input><soap:body
+        use="literal"/></wsdl:input><wsdl:output><soap:body use="literal"/></wsdl:output></wsdl:operation><wsdl:operation
+        name="TranscribeUsingPromoCode"><soap:operation soapAction="http://TranscribeMe.API.Web/IPortalAPI/TranscribeUsingPromoCode"
+        style="document"/><wsdl:input><soap:body use="literal"/></wsdl:input><wsdl:output><soap:body
+        use="literal"/></wsdl:output></wsdl:operation><wsdl:operation name="ResetPassword"><soap:operation
+        soapAction="http://TranscribeMe.API.Web/IPortalAPI/ResetPassword" style="document"/><wsdl:input><soap:body
+        use="literal"/></wsdl:input><wsdl:output><soap:body use="literal"/></wsdl:output></wsdl:operation><wsdl:operation
+        name="GetCustomerInfo"><soap:operation soapAction="http://TranscribeMe.API.Web/IPortalAPI/GetCustomerInfo"
+        style="document"/><wsdl:input><soap:body use="literal"/></wsdl:input><wsdl:output><soap:body
+        use="literal"/></wsdl:output></wsdl:operation></wsdl:binding></wsdl:definitions>
+    http_version: 
+  recorded_at: Mon, 26 Aug 2013 01:11:49 GMT
+- request:
+    method: post
+    uri: http://transcribeme-api.cloudapp.net/PortalAPI.svc
+    body:
+      encoding: UTF-8
+      string: <?xml version="1.0" encoding="UTF-8"?><env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:wsdl="http://TranscribeMe.API.Web"
+        xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"><env:Body><wsdl:InitializeSession></wsdl:InitializeSession></env:Body></env:Envelope>
+    headers:
+      Soapaction:
+      - '"http://TranscribeMe.API.Web/IPortalAPI/InitializeSession"'
+      Content-Type:
+      - text/xml;charset=UTF-8
+      Content-Length:
+      - '331'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - private
+      Content-Type:
+      - text/xml; charset=utf-8
+      Server:
+      - Microsoft-IIS/7.0
+      X-Aspnet-Version:
+      - 4.0.30319
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Mon, 26 Aug 2013 02:46:04 GMT
+      Content-Length:
+      - '272'
+      Connection:
+      - Keep-Alive
+    body:
+      encoding: UTF-8
+      string: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"><s:Body><InitializeSessionResponse
+        xmlns="http://TranscribeMe.API.Web"><InitializeSessionResult>2a7b3722-ddba-4a2e-a821-d4108d62faab</InitializeSessionResult></InitializeSessionResponse></s:Body></s:Envelope>
+    http_version: 
+  recorded_at: Mon, 26 Aug 2013 02:46:13 GMT
+- request:
+    method: post
+    uri: http://transcribeme-api.cloudapp.net/PortalAPI.svc
+    body:
+      encoding: UTF-8
+      string: <?xml version="1.0" encoding="UTF-8"?><env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:wsdl="http://TranscribeMe.API.Web"
+        xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"><env:Body><wsdl:SignIn><wsdl:sessionID>2a7b3722-ddba-4a2e-a821-d4108d62faab</wsdl:sessionID><wsdl:username>example@transcribeme.com</wsdl:username><wsdl:password>example</wsdl:password></wsdl:SignIn></env:Body></env:Envelope>
+    headers:
+      Soapaction:
+      - '"http://TranscribeMe.API.Web/IPortalAPI/SignIn"'
+      Content-Type:
+      - text/xml;charset=UTF-8
+      Content-Length:
+      - '471'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - private
+      Content-Type:
+      - text/xml; charset=utf-8
+      Server:
+      - Microsoft-IIS/7.0
+      X-Aspnet-Version:
+      - 4.0.30319
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Mon, 26 Aug 2013 02:46:06 GMT
+      Content-Length:
+      - '267'
+      Connection:
+      - Keep-Alive
+    body:
+      encoding: UTF-8
+      string: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"><s:Body><SignInResponse
+        xmlns="http://TranscribeMe.API.Web"><SignInResult>8abbbc90-357d-4135-9558-c6bd3d48cac1</SignInResult><errorCode>0</errorCode><errorMessage/></SignInResponse></s:Body></s:Envelope>
+    http_version: 
+  recorded_at: Mon, 26 Aug 2013 02:46:14 GMT
+- request:
+    method: post
+    uri: http://transcribeme-api.cloudapp.net/PortalAPI.svc
+    body:
+      encoding: UTF-8
+      string: <?xml version="1.0" encoding="UTF-8"?><env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:wsdl="http://TranscribeMe.API.Web"
+        xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"><env:Body><wsdl:GetCustomerRecordings><wsdl:sessionID>2a7b3722-ddba-4a2e-a821-d4108d62faab</wsdl:sessionID></wsdl:GetCustomerRecordings></env:Body></env:Envelope>
+    headers:
+      Soapaction:
+      - '"http://TranscribeMe.API.Web/IPortalAPI/GetCustomerRecordings"'
+      Content-Type:
+      - text/xml;charset=UTF-8
+      Content-Length:
+      - '408'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - private
+      Content-Type:
+      - text/xml; charset=utf-8
+      Server:
+      - Microsoft-IIS/7.0
+      X-Aspnet-Version:
+      - 4.0.30319
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Mon, 26 Aug 2013 02:46:18 GMT
+      Content-Length:
+      - '25176'
+      Connection:
+      - Keep-Alive
+    body:
+      encoding: UTF-8
+      string: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"><s:Body><GetCustomerRecordingsResponse
+        xmlns="http://TranscribeMe.API.Web"><GetCustomerRecordingsResult xmlns:a="http://schemas.datacontract.org/2004/07/TranscribeMe.API.Web"
+        xmlns:i="http://www.w3.org/2001/XMLSchema-instance"><a:RecordingInfo><a:DateCreated>2013-07-24T05:04:34.69</a:DateCreated><a:Duration>1411.76</a:Duration><a:ID>d4912ce7-b0f5-4ddb-b0f0-fdfc8e608eb9</a:ID><a:Name>DW_A0126
+        AS part 1.wav</a:Name><a:Status>50</a:Status></a:RecordingInfo><a:RecordingInfo><a:DateCreated>2013-02-27T20:43:50.5</a:DateCreated><a:Duration>3116.86</a:Duration><a:ID>b26a304e-c1c6-42e1-b841-3c402bd33ccf</a:ID><a:Name>D1
+        commisioning learning history 010.3ga</a:Name><a:Status>50</a:Status></a:RecordingInfo><a:RecordingInfo><a:DateCreated>2013-08-21T01:47:03.917</a:DateCreated><a:Duration>430.75</a:Duration><a:ID>c33aeaef-efa4-4b2a-89b3-b5a8294ea844</a:ID><a:Name>3.
+        Share and celebrate - three speakers.mp3</a:Name><a:Status>50</a:Status></a:RecordingInfo></GetCustomerRecordingsResult><errorCode>0</errorCode><errorMessage/></GetCustomerRecordingsResponse></s:Body></s:Envelope>
+    http_version: 
+  recorded_at: Mon, 26 Aug 2013 02:46:27 GMT
+recorded_with: VCR 2.5.0

data/spec/support/cassettes/new_session.yml

@@ -4,15 +4,9 @@ http_interactions:
     method: get
     uri: http://transcribeme-api.cloudapp.net/PortalAPI.svc?wsdl=wsdl0
     body:
-      encoding: US-ASCII
+      encoding: UTF-8
       string: ''
-    headers:
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-      Accept:
-      - '*/*'
-      User-Agent:
-      - Ruby
+    headers: {}
   response:
     status:
       code: 200
@@ -20,8 +14,6 @@ http_interactions:
     headers:
       Cache-Control:
       - private
-      Content-Length:
-      - '4961'
       Content-Type:
       - text/xml; charset=UTF-8
       Server:
@@ -31,7 +23,11 @@ http_interactions:
       X-Powered-By:
       - ASP.NET
       Date:
-      - Mon, 03 Jun 2013 12:24:02 GMT
+      - Mon, 26 Aug 2013 01:11:42 GMT
+      Content-Length:
+      - '4961'
+      Connection:
+      - Keep-Alive
     body:
       encoding: UTF-8
       string: <?xml version="1.0" encoding="utf-8"?><wsdl:definitions targetNamespace="http://tempuri.org/"
@@ -82,27 +78,22 @@ http_interactions:
         style="document"/><wsdl:input><soap:body use="literal"/></wsdl:input><wsdl:output><soap:body
         use="literal"/></wsdl:output></wsdl:operation></wsdl:binding></wsdl:definitions>
     http_version: 
-  recorded_at: Mon, 03 Jun 2013 12:24:01 GMT
+  recorded_at: Mon, 26 Aug 2013 01:11:49 GMT
 - request:
     method: post
     uri: http://transcribeme-api.cloudapp.net/PortalAPI.svc
     body:
       encoding: UTF-8
-      string: <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
-        xmlns:tns="http://TranscribeMe.API.Web"><soapenv:Body><tns:InitializeSession/></soapenv:Body></soapenv:Envelope>
+      string: <?xml version="1.0" encoding="UTF-8"?><env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:wsdl="http://TranscribeMe.API.Web"
+        xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"><env:Body><wsdl:InitializeSession></wsdl:InitializeSession></env:Body></env:Envelope>
     headers:
       Soapaction:
       - '"http://TranscribeMe.API.Web/IPortalAPI/InitializeSession"'
       Content-Type:
       - text/xml;charset=UTF-8
       Content-Length:
-      - '188'
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-      Accept:
-      - '*/*'
-      User-Agent:
-      - Ruby
+      - '331'
   response:
     status:
       code: 200
@@ -110,8 +101,6 @@ http_interactions:
     headers:
       Cache-Control:
       - private
-      Content-Length:
-      - '272'
       Content-Type:
       - text/xml; charset=utf-8
       Server:
@@ -121,11 +110,15 @@ http_interactions:
       X-Powered-By:
       - ASP.NET
       Date:
-      - Mon, 03 Jun 2013 12:24:03 GMT
+      - Mon, 26 Aug 2013 01:11:43 GMT
+      Content-Length:
+      - '272'
+      Connection:
+      - Keep-Alive
     body:
       encoding: UTF-8
       string: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"><s:Body><InitializeSessionResponse
-        xmlns="http://TranscribeMe.API.Web"><InitializeSessionResult>3ab295eb-ad02-4cef-90f0-fad5e294298e</InitializeSessionResult></InitializeSessionResponse></s:Body></s:Envelope>
+        xmlns="http://TranscribeMe.API.Web"><InitializeSessionResult>0aaef84b-d303-493c-83c4-c6b69b7ea667</InitializeSessionResult></InitializeSessionResponse></s:Body></s:Envelope>
     http_version: 
-  recorded_at: Mon, 03 Jun 2013 12:24:02 GMT
+  recorded_at: Mon, 26 Aug 2013 01:11:50 GMT
 recorded_with: VCR 2.5.0