transcribeme 0.0.3.alpha1 → 0.0.4.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: def2cf443e24d4e61e15678022c1ee591aa6c4de
-  data.tar.gz: f73b8211b1af70faaad3b3ff603545a44c3c4e8d
+  metadata.gz: 6f3677a1a5c04841b6cc3791282ec6d0c49facd3
+  data.tar.gz: 53558735a3b6341a1ea83f40a2b04ba32d8794d2
 SHA512:
-  metadata.gz: 3cc80a8ae73f40c2de94e6c0421c927b2b0537f8a82ccbed54bdca0ea73da80ce7c0b2e4e72b0f6e1d59e3331a7d0eeae2eada0a311254200eced0f1d6a4f91a
-  data.tar.gz: 127fea1b4508e7da45c4094428fa28b5eebb5c83f69ab8489ca66975f2ac0dbc0eeff4988f59ed1c917b497abd1ec76b0971b3165ed66ca6bf078d0510c4a32f
+  metadata.gz: d6e880756eb0f10f1199533d58e0e0eca2767d63bfe1f158e3c8ec99d6b66ed82b1f46dcc72a1b1c94b2e00036e9a6da6a5556464fb451ad6136e9ec99f46b06
+  data.tar.gz: 15a3f345edbd2b4d8403f44a3db05ece40ad0367e0fe2dce23ab85edb895487aba1cb27de730f9833fe28cfb0c76a8c3bdbdad026c91d796b90b826bccdcf5c0

checksums.yaml.gz.sig

@@ -1 +1 @@
-�JG���i1|�ߴ�.����U�ϴ��������+��5?�W��^db��y���n��-�7�Yl^�KO�M���U��v���Y��>�u�c�mf�zR�J�W⇞�H3^��#�P���J=����vp�^�$�ŏq�(e��sU��be~�q�����D����;�egds��@�z�ļ�4�{\#M\���Ry���٨5�&#�2�����d1�- "}��~����u~Iq(i�	gd౸��
;ֆ4c
+Cc6`^
g�,�'����M̄�;zg@��miZ�Y��x���cm��_�޻]�h�ss]'ţ�s�l��F]�������o�rR�9�1hn�-V@8�~�@o'l�&����������Q&.��[�(q:GT�>S$h�T�i\_�-I��Lq�E!HR�G�9kwOB���BZv���w�g����ߚ,��~V�`(��PK������f�P��Fe��X���?

data/.gitignore

@@ -16,3 +16,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.ruby-gemset
+.ruby-version

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in transcribeme-api.gemspec
 gemspec
+
+
+group :development, :tools do
+  gem 'pry'
+end

data/README.md

@@ -1,6 +1,10 @@
 # TranscribeMe gem
-
+[![Build Status](https://travis-ci.org/tuttinator/transcribeme.png?branch=master)](https://travis-ci.org/tuttinator/transcribeme)
+[![Gem Version](https://badge.fury.io/rb/transcribeme.png)](http://badge.fury.io/rb/transcribeme)
 [![Dependency Status](https://gemnasium.com/tuttinator/transcribeme.png)](https://gemnasium.com/tuttinator/transcribeme)
+[![Coverage Status](https://coveralls.io/repos/tuttinator/transcribeme/badge.png)](https://coveralls.io/r/tuttinator/transcribeme)
+[![Code Climate](https://codeclimate.com/github/tuttinator/transcribeme.png)](https://codeclimate.com/github/tuttinator/transcribeme)
+
 
 This gem is a Ruby wrapper for the TranscribeMe SOAP API, built on Savon
 

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/USAGE.md

@@ -0,0 +1,27 @@
+### Design decisions
+
+Interact directly with API calls like this:
+
+    client = TranscribeMe::API::Client.new
+
+    client.login_as_customer({username: "customer@transcribeme.com", password: PASSWORD})
+    client.recordings # => [List of recording instances...]
+
+    client.get_recording(recording_id) # => <Recording:0x007fc69e49f0b8>
+
+    client.submit_recording(recording_id) # => true or false
+
+Or interact through a customer object
+
+    customer = Customer.new(username: "customer@transcribeme.com", password: PASSWORD)
+  
+  or
+    customer = {username: "customer@transcribeme.com", password: PASSWORD}
+  
+  or
+    customer = Struct.new(:username, :password)
+  
+
+  client.login_as_customer(customer) 
+  either a hash, or a duck-typed object which either responds to [:username] and [:password] or #username and #password
+

data/lib/transcribeme.rb

@@ -6,14 +6,28 @@ module TranscribeMe
       WSDL = "http://transcribeme-api.cloudapp.net/PortalAPI.svc?wsdl=wsdl0"
       ENDPOINT = "http://transcribeme-api.cloudapp.net/PortalAPI.svc"
       NAMESPACE = "http://TranscribeMe.API.Web"
-      NAMESPACE_IDENTIFIER = :tns # any indentifier can be used
+      NAMESPACE_IDENTIFIER = :tns # any identifier can be used
 
       SOAP_ENVELOPE = ["soapenv:Envelope", { "xmlns:soapenv" => "http://schemas.xmlsoap.org/soap/envelope/", "xmlns:#{NAMESPACE_IDENTIFIER}" => NAMESPACE }]
+
+      def self.construct_xml(soap_method, options = {})
+        Builder::XmlMarkup.new.tag!(*SOAP_ENVELOPE) do |xml|
+          xml.tag!("soapenv:Body") do |xml|
+            xml.tag!("#{NAMESPACE_IDENTIFIER}:#{soap_method}") do |xml|
+              options.each do |key, value|
+                xml.tag!("#{NAMESPACE_IDENTIFIER}:#{key}") { |xml| xml.text! value }
+              end
+            end
+          end
+        end
+      end
     
   end
 end
 
+require 'savon'
 
+require 'transcribeme/api/client'
 require 'transcribeme/api/customer_login'
 require 'transcribeme/api/session'
 require 'transcribeme/api/recordings'

data/lib/transcribeme/api/client.rb

@@ -3,54 +3,81 @@ module TranscribeMe
 
     class Client
 
-      attr_reader :client
+      attr_accessor :session_id
+      attr_reader :savon, :session_expiry_time
       
       def initialize
-        @client = Savon.client(wsdl: WSDL, endpoint: ENDPOINT, namespace: NAMESPACE, namespace_identifier: NAMESPACE_IDENTIFIER)
-        initialize_session!
+        @savon = ::Savon.client(wsdl: WSDL, endpoint: ENDPOINT, namespace: NAMESPACE, soap_version: 1)
       end
 
-
       def initialize_session!
-        @session = Session.new(@client)
-        @session.create_on_server!
+        response = @savon.call :initialize_session
+        # Without ActiveSupport
+        #   1.hour.from_now is 3600 seconds from Time.now
+        @session_expiry_time = Time.now + 3600
+        @session_id = response.body[:initialize_session_response][:initialize_session_result]
       end
 
       def login_with(username, password)
-        initialize_session! unless @session.try :valid?
-        @customer_login_id = CustomerLogin.new(@session.session_id, username, password, @client).login_on_server!
+        
+        initialize_session! unless session_valid?
+
+        response = @savon.call  :sign_in, 
+                                message: {  "wsdl:sessionID"  => @session_id, 
+                                            "wsdl:username"   =>  username, 
+                                            "wsdl:password"   =>  password }
+
+        @customer_login_id = response.body[:sign_in_response][:sign_in_result]
+
       end
 
       def get_recordings
         raise "Login first!" unless @customer_login_id
-        @recordings = Recordings.new(@session.session_id, @client).get_list!
+
+        response = @savon.call  :get_customer_recordings, 
+                                message: {  "wsdl:sessionID" => session_id }
+
+        @recordings = response.body[:get_customer_recordings_response][:get_customer_recordings_result][:recording_info]                                
+      end
+
+      def get_upload_url
+        raise "Login first!" unless @customer_login_id
+
+        response = @savon.call  :get_upload_url, 
+                                message: {  "wsdl:sessionID" => @session_id }
+                                
+        @upload_url = response.body[:get_upload_url_response][:get_upload_url_result] 
+
       end
 
       def submit_recording(recording)
         initialize_session! unless @session.try :valid?
-        Submission.new(@session.session_id, recording, @client).submit!
+        Submission.new(@session.session_id, recording, @savon).submit!
       end
 
       def submit_recording_with_promocode(recording, promocode)
         initialize_session! unless @session.try :valid?
-        SubmissionWithPromocode.new(@session.session_id, recording, promocode, @client).submit!
+        SubmissionWithPromocode.new(@session.session_id, recording, promocode, @savon).submit!
       end
 
       def get_status(recording_id)
         raise "Login first!" unless @customer_login_id
-        CheckTranscriptionReady.new(@session.session_id, recording_id, @client).check!
+        CheckTranscriptionReady.new(@session.session_id, recording_id, @savon).check!
       end
 
-      def get_upload_url
+      def logout!
         raise "Login first!" unless @customer_login_id
-        UploadUrl.new(@session.session_id, @client).retrieve!
+        FinalizeSession.new(@session.session_id, @savon).submit!
       end
 
-      def logout!
-        raise "Login first!" unless @customer_login_id
-        FinalizeSession.new(@session.session_id, @client).submit!
+      private
+
+      def session_valid?
+        @session_expiry_time > Time.now
       end
 
+      
+
     end
 
   end

data/lib/transcribeme/api/session.rb

@@ -11,7 +11,9 @@ module TranscribeMe
 
       def create_on_server!
         response = @client.call :initialize_session, xml: xml
-        @session_expiry_time = 1.hour.from_now
+        # Without ActiveSupport
+        #   1.hour.from_now is 3600 seconds from Time.now
+        @session_expiry_time = Time.now + 3600
         @session_id = response.body[:initialize_session_response][:initialize_session_result]
       end
 

data/lib/transcribeme/customer.rb

@@ -0,0 +1,5 @@
+module TranscribeMe
+  class Customer
+    
+  end
+end

data/lib/transcribeme/recording.rb

@@ -0,0 +1,5 @@
+module TranscribeMe
+  class Recording
+
+  end
+end

data/lib/transcribeme/transcription.rb

@@ -0,0 +1,5 @@
+module TranscribeMe
+  class Transcription
+
+  end
+end

data/lib/transcribeme/version.rb

@@ -1,3 +1,3 @@
 module TranscribeMe
-  VERSION = "0.0.3.alpha1"
+  VERSION = "0.0.4.beta1"
 end

data/spec/lib/api/client_spec.rb

@@ -0,0 +1,16 @@
+require 'transcribeme'
+require 'spec_helper'
+
+describe TranscribeMe::API::Client do
+  
+  before :all do
+    VCR.use_cassette('new_session') do
+      @client = TranscribeMe::API::Client.new 
+    end
+  end
+
+  it "should be valid" do
+    @client.should_not be_nil
+  end
+
+end

data/spec/spec_helper.rb

@@ -4,6 +4,19 @@
 # loaded once.
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'coveralls'
+Coveralls.wear!
+
+# The VCR gem uses yaml fixtures instead of live HTTP requests 
+require 'vcr'
+require 'webmock'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/support/cassettes'
+  c.hook_into :webmock
+end
+
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true

data/spec/support/cassettes/new_session.yml

@@ -0,0 +1,131 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://transcribeme-api.cloudapp.net/PortalAPI.svc?wsdl=wsdl0
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - private
+      Content-Length:
+      - '4961'
+      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, 03 Jun 2013 12:24:02 GMT
+    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, 03 Jun 2013 12:24:01 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>
+    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
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - private
+      Content-Length:
+      - '272'
+      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, 03 Jun 2013 12:24:03 GMT
+    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>
+    http_version: 
+  recorded_at: Mon, 03 Jun 2013 12:24:02 GMT
+recorded_with: VCR 2.5.0

data/transcribeme.gemspec

@@ -25,4 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "yard"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "coveralls"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: transcribeme
 version: !ruby/object:Gem::Version
-  version: 0.0.3.alpha1
+  version: 0.0.4.beta1
 platform: ruby
 authors:
 - Tuttinator
@@ -31,7 +31,7 @@ cert_chain:
   /qqRTsuOOmPoaNtB4XnGMXyHOzOhAvurliPCtBFlkWAH0RvDt29O9ZcwRhInvr83
   S4meqecZ62/XH48iGccggmMPiTi8zQ==
   -----END CERTIFICATE-----
-date: 2013-06-03 00:00:00.000000000 Z
+date: 2013-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -117,6 +117,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This gem is a Ruby wrapper for the TranscribeMe SOAP API, built on Savon
 email:
 - caleb@prettymint.co.nz
@@ -124,12 +152,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .coveralls.yml
 - .gitignore
 - .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- USAGE.md
 - lib/transcribeme.rb
 - lib/transcribeme/api/check_transcription_ready.rb
 - lib/transcribeme/api/client.rb
@@ -140,8 +170,13 @@ files:
 - lib/transcribeme/api/submission.rb
 - lib/transcribeme/api/submission_with_promocode.rb
 - lib/transcribeme/api/upload_url.rb
+- lib/transcribeme/customer.rb
+- lib/transcribeme/recording.rb
+- lib/transcribeme/transcription.rb
 - lib/transcribeme/version.rb
+- spec/lib/api/client_spec.rb
 - spec/spec_helper.rb
+- spec/support/cassettes/new_session.yml
 - transcribeme.gemspec
 homepage: http://tuttinator.github.io/transcribeme/
 licenses:
@@ -168,5 +203,7 @@ signing_key:
 specification_version: 4
 summary: Ruby wrapper around the TranscribeMe SOAP API
 test_files:
+- spec/lib/api/client_spec.rb
 - spec/spec_helper.rb
+- spec/support/cassettes/new_session.yml
 has_rdoc: