transcribeme 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 617a97dd3dbf3606b2fdff37f48c040c25ade8ee
+  data.tar.gz: 0038ad97d7466081fa1be3155e99441bb9638719
+SHA512:
+  metadata.gz: 8277614f960e31d80009ee1dfc21c470f9fbe7fbb65284021778d6c5dc833fdf98e9a324c43742e3309a1f9928930c7804af46c2007daadb255f4628f4c8abd2
+  data.tar.gz: 00a829a9c64ea49f7b658b321d8f0172fa2237fb5cd05d43e8836c765402358810f0a8ece9cb1909cdbf194b3f56da7f95dfa1319574d6a124934ff7ccbc532c

data/.gitignore

@@ -0,0 +1,18 @@
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in transcribeme-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Caleb Tutty
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# TranscribeMe gem
+
+[![Dependency Status](https://gemnasium.com/tuttinator/transcribeme.png)](https://gemnasium.com/tuttinator/transcribeme)
+
+This gem is a Ruby wrapper for the TranscribeMe SOAP API, built on Savon
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'transcribeme'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install transcribeme
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/transcribeme/api/check_transcription_ready.rb

@@ -0,0 +1,29 @@
+module TranscribeMe
+  module API
+    class CheckTranscriptionReady
+      def initialize(session_id, recording_id, client)
+        @session_id, @recording_id, @client = session_id, recording_id, client
+      end
+
+      def check!
+        response = @client.call :check_transcription_ready, xml: xml
+        response.body[:check_transcription_ready_response][:check_transcription_ready_result]
+      end
+
+      private
+
+      def xml
+        xml = Builder::XmlMarkup.new.tag!(*SOAP_ENVELOPE) do |xml|
+          xml.tag!("soapenv:Body") do |xml|
+            xml.tag!("#{NAMESPACE_IDENTIFIER}:CheckTranscriptionReady") do |xml|
+              xml.tag!("#{NAMESPACE_IDENTIFIER}:sessionID") { |xml| xml.text! @session_id }
+              xml.tag!("#{NAMESPACE_IDENTIFIER}:recId") { |xml| xml.text! @recording_id }
+            end
+          end
+        end
+      end
+      
+    end
+
+  end
+end

data/lib/transcribeme/api/client.rb

@@ -0,0 +1,57 @@
+module TranscribeMe
+  module API
+
+    class Client
+
+      attr_reader :client
+      
+      def initialize
+        @client = Savon.client(wsdl: WSDL, endpoint: ENDPOINT, namespace: NAMESPACE, namespace_identifier: NAMESPACE_IDENTIFIER)
+        initialize_session!
+      end
+
+
+      def initialize_session!
+        @session = Session.new(@client)
+        @session.create_on_server!
+      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!
+      end
+
+      def get_recordings
+        raise "Login first!" unless @customer_login_id
+        @recordings = Recordings.new(@session.session_id, @client).get_list!
+      end
+
+      def submit_recording(recording)
+        initialize_session! unless @session.try :valid?
+        Submission.new(@session.session_id, recording, @client).submit!
+      end
+
+      def submit_recording_with_promocode(recording, promocode)
+        initialize_session! unless @session.try :valid?
+        SubmissionWithPromocode.new(@session.session_id, recording, promocode, @client).submit!
+      end
+
+      def get_status(recording_id)
+        raise "Login first!" unless @customer_login_id
+        CheckTranscriptionReady.new(@session.session_id, recording_id, @client).check!
+      end
+
+      def get_upload_url
+        raise "Login first!" unless @customer_login_id
+        UploadUrl.new(@session.session_id, @client).retrieve!
+      end
+
+      def logout!
+        raise "Login first!" unless @customer_login_id
+        FinalizeSession.new(@session.session_id, @client).submit!
+      end
+
+    end
+
+  end
+end

data/lib/transcribeme/api/customer_login.rb

@@ -0,0 +1,33 @@
+module TranscribeMe
+  module API
+
+    class CustomerLogin
+
+      attr_reader :customer_id
+
+      def initialize(session_id, username, password, client)
+        @session_id, @username, @password, @client = session_id, username, password, client
+      end
+
+      def login_on_server!
+        response = @client.call :sign_in, xml: xml
+        @customer_id = response.body[:sign_in_response][:sign_in_result]
+      end
+
+      private
+
+      def xml
+        xml = Builder::XmlMarkup.new.tag!(*SOAP_ENVELOPE) do |xml|
+          xml.tag!("soapenv:Body") do |xml|
+            xml.tag!("#{NAMESPACE_IDENTIFIER}:SignIn") do |xml|
+              xml.tag!("#{NAMESPACE_IDENTIFIER}:sessionID") { |xml| xml.text! @session_id }
+              xml.tag!("#{NAMESPACE_IDENTIFIER}:username")  { |xml| xml.text! @username }
+              xml.tag!("#{NAMESPACE_IDENTIFIER}:password")  { |xml| xml.text! @password }
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/transcribeme/api/finalize_session.rb

@@ -0,0 +1,30 @@
+module TranscribeMe
+  module API
+
+    class FinalizeSession
+
+      def initialize(session_id, client)
+        @session_id, @client = session_id, client
+      end
+
+      def submit!
+        response = @client.call :finalize_session, xml: xml
+        response.body[:finalize_session_response][:finalize_session_result]
+      end
+
+      private
+
+      def xml
+        xml = Builder::XmlMarkup.new.tag!(*SOAP_ENVELOPE) do |xml|
+          xml.tag!("soapenv:Body") do |xml|
+            xml.tag!("#{NAMESPACE_IDENTIFIER}:FinalizeSession") do |xml|
+              xml.tag!("#{NAMESPACE_IDENTIFIER}:sessionID") { |xml| xml.text! @session_id }
+            end
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/lib/transcribeme/api/recordings.rb

@@ -0,0 +1,32 @@
+module TranscribeMe
+  module API
+
+    class Recordings
+
+      attr_reader :list
+
+      def initialize(session_id, client)
+        @session_id, @client = session_id, client
+      end
+
+      def get_list!
+        response = @client.call :get_customer_recordings, xml: xml
+        @list = response.body[:get_customer_recordings_response][:get_customer_recordings_result][:recording_info]
+      end
+
+      private
+
+      def xml
+        xml = Builder::XmlMarkup.new.tag!(*SOAP_ENVELOPE) do |xml|
+          xml.tag!("soapenv:Body") do |xml|
+            xml.tag!("#{NAMESPACE_IDENTIFIER}:GetCustomerRecordings") do |xml|
+              xml.tag!("#{NAMESPACE_IDENTIFIER}:sessionID") { |xml| xml.text! @session_id }
+            end
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/lib/transcribeme/api/session.rb

@@ -0,0 +1,35 @@
+module TranscribeMe
+  module API
+
+    class Session
+
+      attr_reader :session_id
+
+      def initialize(client)
+        @client = client
+      end
+
+      def create_on_server!
+        response = @client.call :initialize_session, xml: xml
+        @session_expiry_time = 1.hour.from_now
+        @session_id = response.body[:initialize_session_response][:initialize_session_result]
+      end
+
+      def valid?
+        Time.now < @session_expiry_time
+      end
+
+      private
+
+      def xml
+        xml = Builder::XmlMarkup.new.tag!(*SOAP_ENVELOPE) do |xml|
+          xml.tag!("soapenv:Body") do |xml|
+            xml.tag!("#{NAMESPACE_IDENTIFIER}:InitializeSession")
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/lib/transcribeme/api/submission.rb

@@ -0,0 +1,31 @@
+module TranscribeMe
+  module API
+
+    class Submission
+
+      def initialize(session_id, recording_id, client)
+        @session_id, @recording_id, @client = session_id, recording_id, client
+      end
+
+      def submit!
+        response = @client.call :transcribe_recording, xml: xml
+        response.body[:transcribe_recording_response][:transcribe_recording_result]
+      end
+
+      private
+
+      def xml
+        xml = Builder::XmlMarkup.new.tag!(*SOAP_ENVELOPE) do |xml|
+          xml.tag!("soapenv:Body") do |xml|
+            xml.tag!("#{NAMESPACE_IDENTIFIER}:TranscribeRecording") do |xml|
+              xml.tag!("#{NAMESPACE_IDENTIFIER}:sessionID") { |xml| xml.text! @session_id }
+              xml.tag!("#{NAMESPACE_IDENTIFIER}:recordingID") { |xml| xml.text! @recording_id }
+            end
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/lib/transcribeme/api/submission_with_promocode.rb

@@ -0,0 +1,32 @@
+module TranscribeMe
+  module API
+
+    class SubmissionWithPromocode
+
+      def initialize(session_id, recording_id, promocode, client)
+        @session_id, @recording_id, @promocode, @client = session_id, recording_id, promocode, client
+      end
+
+      def submit!
+        response = @client.call :transcribe_recording, xml: xml
+        response.body[:transcribe_recording_response][:transcribe_recording_result]
+      end
+
+      private
+
+      def xml
+        xml = Builder::XmlMarkup.new.tag!(*SOAP_ENVELOPE) do |xml|
+          xml.tag!("soapenv:Body") do |xml|
+            xml.tag!("#{NAMESPACE_IDENTIFIER}:TranscribeRecording") do |xml|
+              xml.tag!("#{NAMESPACE_IDENTIFIER}:sessionID") { |xml| xml.text! @session_id }
+              xml.tag!("#{NAMESPACE_IDENTIFIER}:recordingID") { |xml| xml.text! @recording_id }
+              xml.tag!("#{NAMESPACE_IDENTIFIER}:promocode") { |xml| xml.text! @promocode }
+            end
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/lib/transcribeme/api/upload_url.rb

@@ -0,0 +1,30 @@
+module TranscribeMe
+  module API
+
+    class UploadUrl
+      
+      def initialize(session_id, client)
+        @session_id, @client = session_id, client
+      end
+
+      def retrieve!
+        response = @client.call :get_upload_url, xml: xml
+        @list = response.body[:get_upload_url_response][:get_upload_url_result]
+      end
+
+      private
+
+      def xml
+        xml = Builder::XmlMarkup.new.tag!(*SOAP_ENVELOPE) do |xml|
+          xml.tag!("soapenv:Body") do |xml|
+            xml.tag!("#{NAMESPACE_IDENTIFIER}:GetUploadUrl") do |xml|
+              xml.tag!("#{NAMESPACE_IDENTIFIER}:sessionID") { |xml| xml.text! @session_id }
+            end
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/lib/transcribeme/transcribeme.rb

@@ -0,0 +1,23 @@
+require 'transcribeme/version'
+
+module TranscribeMe
+  module API
+
+      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
+
+      SOAP_ENVELOPE = ["soapenv:Envelope", { "xmlns:soapenv" => "http://schemas.xmlsoap.org/soap/envelope/", "xmlns:#{NAMESPACE_IDENTIFIER}" => NAMESPACE }]
+    
+  end
+end
+
+
+require 'transcribeme/api/customer_login'
+require 'transcribeme/api/session'
+require 'transcribeme/api/recordings'
+require 'transcribeme/api/submission'
+require 'transcribeme/api/submission_with_promocode'
+require 'transcribeme/api/check_transcription_ready'
+require 'transcribeme/api/upload_url'

data/lib/transcribeme/version.rb

@@ -0,0 +1,3 @@
+module TranscribeMe
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/transcribeme.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'transcribeme/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "transcribeme"
+  spec.version       = TranscribeMe::VERSION
+  spec.authors       = ["Tuttinator"]
+  spec.email         = ["caleb@prettymint.co.nz"]
+  spec.description   = %q{This gem is a Ruby wrapper for the TranscribeMe SOAP API, built on Savon}
+  spec.summary       = %q{Ruby wrapper around the TranscribeMe SOAP API}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'savon', '~> 2.2'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "vcr"
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: transcribeme
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tuttinator
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: yard
+  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: rspec
+  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: vcr
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/transcribeme/api/check_transcription_ready.rb
+- lib/transcribeme/api/client.rb
+- lib/transcribeme/api/customer_login.rb
+- lib/transcribeme/api/finalize_session.rb
+- lib/transcribeme/api/recordings.rb
+- lib/transcribeme/api/session.rb
+- lib/transcribeme/api/submission.rb
+- lib/transcribeme/api/submission_with_promocode.rb
+- lib/transcribeme/api/upload_url.rb
+- lib/transcribeme/transcribeme.rb
+- lib/transcribeme/version.rb
+- spec/spec_helper.rb
+- transcribeme.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper around the TranscribeMe SOAP API
+test_files:
+- spec/spec_helper.rb
+has_rdoc: