transcribeme 1.0.0.alpha → 1.0.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 220bcd847b3e0b90afbbea5f779e59705c7952ea
-  data.tar.gz: c6e5d50a3297e6b5756bb5e8d0f0185a6d94b1dc
+  metadata.gz: 23b3a093592b85656762ec0032b8f3fa97ec6207
+  data.tar.gz: aa03e89273d1f655371f8b0010b7593aefead40a
 SHA512:
-  metadata.gz: a3ef2f1b18f139220c0096da77af39089707c4544afdda70dd03e854bdd4e8a46302ca108e2435960333b2c5221a7e48c9989eacbe5c9d5942e17d93f8edbc23
-  data.tar.gz: 6526240aafff85c06311693037ad10f3b5a8a09d285652cb53886f53426ad2e444e1b97a6c83d223dacc0a441f29a2130112faa09e32bf0381cc5ad1dd8e1401
+  metadata.gz: f48989a92f98d16306b82277a31922184a86b38bd77524a119d5eff4af61b2fb0c0d43fb1a828043432241515557e3acd9598f40adf8c5877de154d94ac13354
+  data.tar.gz: 2c8dd584070feff6d3bccc6d9abf09a92d205ca7eb19bf26fe72cfc0feabdf9a66c4facf7557b4eb6de6345bcee8cc33fdccfc5da41f0e0d0e66b8e854483a26

data/README.md

@@ -36,7 +36,100 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To get a file transcribed with this gem, this is the workflow:
+
+- Sign in as a Customer
+- Upload a file
+- Submit for transcription (possibly with a Promocode)
+
+
+#### Signing in
+
+To create a new instance of the API client
+
+    client = TranscribeMe::API::Client.new
+
+API Sessions have a lifetime of 1 hour. When we sign in as a user an API session will be created if it is either no longer valid or not yet initialized.
+
+    client.sign_in 'example@transcribeme.com', 'example'
+
+GUIDs are prolific. Your session id is a GUID, and will be available in `client.session_id` but the result of signing in will return your Customer ID. Don't worry, you won't need this.
+
+#### Getting a list of recordings
+
+To get your recordings, call the `get_recordings` method:
+
+    recordings = client.get_recordings
+
+This will return an array of hashes. These hashes have the following keys: `:date_created`, `:duration`, `:id`, `:name` and `:status`.
+
+TODO: Status is currently slightly cryptic, and this will improve.
+
+    "10" # => Ready for transcription
+    "40" # => In Progress
+    "50" # => Complete
+
+using `Array#select` you can filter for recordings that are in progress, complete or ready for transcription. This will be refactored post 1.0.0.
+
+Array#select examples:
+
+    completed   = recordings.select {|x| x[:status] == "50"}
+    in_progress = recordings.select {|x| x[:status] == "40"}
+    ready       = recordings.select {|x| x[:status] == "10"}
+
+#### Uploading recordings
+
+###### Prerequisites
+
+NOTE: This piece of functionality (and actually only this) relies on FFMPEG and the `streamio-ffmpeg` Ruby gem, unless you explicitly state the duration of the audio in an options hash.
+
+On Ubuntu:
+
+    sudo apt-get install ffmpeg
+
+(or your Linux package manager to install the ffmpeg package)
+
+On Mac:
+
+Get [Homebrew](http://brew.sh/) and then
+
+    brew install ffmpeg
+
+
+Not yet tested on Windows environments. Feel free to send feedback / advice on an FFMPEG alternative.
+
+
+RubyMotion - this gem uses synchronous connections, and other stuff making it inappropriate. A RubyMotion-specific gem is in the works.
+
+###### Actually uploading files
+
+    client.upload 'my_cool_file.mp3'
+
+That's pretty easy, right?
+
+Or you can also include a second argument, to overwrite the defaults.
+
+      # options   - a Hash with these keys:
+      #             :multiple_speakers  - Boolean (default is true)
+      #             :duration           - Float
+      #             :description        - String
+
+    client.upload 'my_cool_file.mp3', { duration: 12345.12, multiple_speakers: false, description: "Yo!" }
+
+This can take some time, as it first uses [Excon](http://excon.io/) to upload to Windows Azure Blob Storage, using the URL asked provided by the API. Once the upload to Windows Azure completes, it sends a SOAP request to the API to confirm the file name and details. The recording is then in the initial state - Status 10, Ready for Transcription.
+
+The return value is the response hash, which includes the Recording ID. This Recording ID is a GUID, and you may want to hold on to it. It will be available in the list of recordings.
+
+#### Submitting recordings for transcription
+
+If you have used the [web interface](https://portal.transcribeme.com) to set up payment you can use the transcribe_recording method like so:
+
+    client.transcribe_recording '5e38e162-3e05-4f4d-82c1-010a34891fd8'
+
+or if you have a promo code:
+
+    client.transcribe_recording_using_promocode '5e38e162-3e05-4f4d-82c1-010a34891fd8', 'MyPromoCodeRules'
+
 
 ## Documentation
 
@@ -48,29 +141,36 @@ The documentation can be [browsed online](http://rubydoc.info/github/tuttinator/
 
 Version 1.0.0 stable
 
-- [   ] Write specs
-- [ x ] Set up Travis-CI and document supported Ruby versions
-- [ x ] Investigate Windows Azure Blob storage file upload
-- [ x ] Include Excon for Windows Azure Blob storage
-- [ x ] Base64 decrypt transcription results
-- [   ] Document SOAP calls and error messages
-- [   ] Complete YARD documentation
-- [   ] Include option (default)
-- [   ] Validations for GUIDs 
-- [   ] Exceptions for error handling (about 50%)
-- [   ] Modelling Recording objects, particularly better describing recording status
+- [ ] Write specs
+- [x] Set up Travis-CI and document supported Ruby versions
+- [x] Investigate Windows Azure Blob storage file upload
+- [x] Include Excon for Windows Azure Blob storage
+- [x] Base64 decrypt transcription results
+- [ ] Document SOAP calls and error messages
+- [ ] Complete YARD documentation
+- [ ] Include option (default)
+- [ ] Validations for GUIDs 
+- [ ] Exceptions for error handling (about 50%)
+- [ ] Modelling Recording objects, particularly better describing recording status
+- [ ] Reduce gem size through reducing spec support files (download as needed during specs, gitignored?)
+- [ ] Implement the customer sign up API
+- [ ] Implement the customer reset password
 
 Version 1.1.0
 
-- [   ] Create a CLI interface
+- [ ] Refactor the recordings array into an object with `#completed` `#in_progress` and `#ready` instance methods
+
+Version 1.2.0
+
+- [ ] Create a CLI interface
 
 RubyMotion
 
-- [   ] A RubyMotion fork (transcribeme-motion), wrapped in BubbleWrap's HTTP DSL (watch this space)
+- [ ] A RubyMotion fork (transcribeme-motion), wrapped in BubbleWrap's HTTP DSL (watch this space)
 
 REST API Wrapper
 
-- [   ] A Sinatra RESTful wrapper around the SOAP operations for your own personal REST API middleman, with JSON-ic magic at your fingertips. JSON was always my favourite Argonaut.
+- [ ] A Sinatra RESTful wrapper around the SOAP operations for your own personal REST API middleman, with JSON-ic magic at your fingertips. JSON was always my favourite Argonaut.
 
 ## Contributing
 

data/lib/transcribeme/api/client.rb

@@ -163,7 +163,7 @@ module TranscribeMe
       def transcribe_recording_using_promocode(recording_id, promocode)
         # initialize_session unless @session.try :valid?
         
-        response = @savon.call :transcribe_recording_using_promocode, 
+        response = @savon.call :transcribe_using_promo_code, 
                                message: { 'wsdl:sessionID'   => @session_id, 
                                           'wsdl:recordingId' => recording_id,
                                           'wsdl:promoCode'   => promocode }

data/lib/transcribeme/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: transcribeme
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha
+  version: 1.0.0.beta
 platform: ruby
 authors:
 - Tuttinator
@@ -31,7 +31,7 @@ cert_chain:
   /qqRTsuOOmPoaNtB4XnGMXyHOzOhAvurliPCtBFlkWAH0RvDt29O9ZcwRhInvr83
   S4meqecZ62/XH48iGccggmMPiTi8zQ==
   -----END CERTIFICATE-----
-date: 2013-09-01 00:00:00.000000000 Z
+date: 2013-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon