speaker_text 1.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Derrick Parkhurst
+
+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,77 @@
+SpeakerText Gem
+===============
+
+  A gem to automate transcription of audio and video media using the [SpeakerText service](http://speakertext.com) 
+and [SpeakerText API](http://speakertext.com/api).
+
+Overview
+--------
+  
+  Audio and video media hosted on the Internet are not well indexed by search engines and thus not easily 
+searchable. For a fee, the SpeakerText.com service produces text transcripts of audio and video content that 
+is available on the Internet (on a private website or a media hosting service such as YouTube). These text 
+transcripts can be used to augment media, thus making them searchable and indexed by search engines. Using
+the SpeakerText video player, the trascripts can also be used as subtitles increasing access of audio and 
+video media to hearing impared individuals.
+
+Requires
+--------
+
+* A SpeakerText account and API key
+* Credits purchased through the [SpeakerText website](http://speakertext.com)
+* [HTTParty gem](http://github.com/jnunemaker/httparty)
+* [UUIDTools gem](http://github.com/sporkmonger/uuidtools)
+* Ruby >= 1.9.2
+
+Usage Examples
+--------------
+
+Install
+
+    gem install speakertext
+
+Initialize the API with a key
+
+    require 'speaker_text'
+    st = SpeakerText.new(your_api_key)
+
+Submit a media file URL for transcription
+
+    success, transcript_id = st.transcribe(url: public_url_of_media_file)
+
+Submit a media file hosted on a platform (e.g., YouTube, Vimeo, SoundCloud)
+
+    status, transcript_id = st.transcribe(platform: 'youtube', id: youtube_video_id)
+
+Check the status of the transcription process
+
+    success, status = st.transcript_status(id: transcript_id)
+
+Request the completed transcripts
+
+    success, content = st.transcript(id: transcript_id)
+
+See also the [examples](https://github.com/thirtysixthspan/speakertext/tree/master/examples)
+
+
+License
+-------
+Copyright (c) 2011 Derrick Parkhurst (derrick.parkhurst@gmail.com)
+
+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/examples/fetch_transcript.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+require 'speaker_text'
+
+if ARGV.size<1
+  puts "#{$0} [SpeakerText Transcript ID]"
+  exit
+end
+
+id = ARGV[0]
+puts "Fetching SpeakerText transcript ID #{id}"
+
+config_file = 'speakertext.yaml'
+if File.exist?(config_file)
+  config = YAML::load(File.open(config_file))
+else
+  puts "Failed to load #{config_file}"
+  exit
+end
+
+if !config.include?('api_key') || config['api_key']==''
+  puts "You must provide an api_key in #{config_file}"
+  exit
+end
+
+st = SpeakerText.new(config['api_key'])
+success, content = st.fetch_xml_transcript(id: id)
+if success
+  filename = "#{id}.xml"
+  File.open(filename, 'w') do |file|
+    file.write(content)
+  end
+  puts "Success: saved transcript to #{filename}"
+else
+  puts "Error: #{content}"
+end
+
+
+

data/examples/speakertext.yaml

@@ -0,0 +1 @@
+api_key: 

data/examples/transcribe_video.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require 'speaker_text'
+
+if ARGV.size<1
+  puts "#{$0} [Public URL of audio of video file]"
+  exit
+end
+
+url = ARGV[0]
+puts "Uploading #{url} to SpeakerText for transcription"
+
+config_file = 'speakertext.yaml'
+if File.exist?(config_file)
+  config = YAML::load(File.open(config_file))
+else
+  puts "Failed to load #{config_file}"
+  exit
+end
+
+if !config.include?('api_key') || config['api_key']==''
+  puts "You must provide an api_key in #{config_file}"
+  exit
+end
+
+st = SpeakerText.new(config['api_key'])
+success, transcript_id = st.transcribe(url: url)
+if success
+  puts "Success: Transcript ID is #{transcript_id}"
+else
+  puts "Error: #{transcript_id}"
+end

data/examples/transcribe_youtube_video.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require 'speaker_text'
+
+if ARGV.size<1
+  puts "#{$0} [YouTube Video ID]"
+  exit
+end
+
+video_id = ARGV[0]
+puts "Uploading to SpeakerText from YouTube. Video ID #{video_id}"
+
+config_file = 'speakertext.yaml'
+if File.exist?(config_file)
+  config = YAML::load(File.open(config_file))
+else
+  puts "Failed to load #{config_file}"
+  exit
+end
+
+if !config.include?('api_key') || config['api_key']==''
+  puts "You must provide an api_key in #{config_file}"
+  exit
+end
+
+st = SpeakerText.new(config['api_key'])
+status, transcript_id = st.transcribe(platform: 'youtube', id: video_id)
+if status
+  puts "Success: Transcript ID is #{transcript_id}"
+else
+  puts "Error: #{transcript_id}"
+end
+

data/lib/speaker_text.rb

@@ -0,0 +1,138 @@
+require 'httparty'
+require 'uuidtools'
+require 'json'
+
+class SpeakerText
+  include HTTParty
+  base_uri "https://api.speakertext.com/v1"
+  VERSION = '1.0.0'
+  
+  def initialize(api_key)
+    self.class.basic_auth api_key,'x' 
+    @verbose=false
+  end
+
+  def verbose
+    @verbose=true
+  end
+  
+  def generate_id()
+    UUIDTools::UUID.random_create.to_s
+  end
+
+  def remote_file_exists(url)
+    response = HTTParty.head(url)
+    return true if response.code == 200
+    false
+  end
+
+  def submit_transcription_request(query)
+    puts query if @verbose
+    response = self.class.post("/transcripts", :query => query)
+    return [false, "Unauthorized: API key is incorrect"] if response.code==401
+    return [false, "SpeakerText Internal Error"] if response.code==500
+
+    fields = JSON.parse response.body
+
+    return [false, fields['message']] if response.code != 201
+    return [true, fields['transcript_ids'][0]]
+  end
+
+  def transcribe_platform(args)
+    puts "Transcribe Platform" if @verbose
+    platform = args[:platform]
+    source_id = args[:id]
+    return [false, "Source id from #{platform} required"] unless source_id && source_id!=''
+    source_annotation = args[:annotation] || ''
+
+    sources = {:platform => platform, 
+               :video_id => source_id, 
+               :annotation => source_annotation
+              }
+
+    query = {}
+    query[:sources] = sources.to_json
+    query[:pingback_url] = args[:pingback_url] if args.include?(:pingback_url) 
+    submit_transcription_request(query)
+  end
+
+  def transcribe_url(args)
+    puts "Transcribe URL" if @verbose
+    url = args[:url]
+    return [false, "Cannot access remote file #{url}."] if !remote_file_exists(url)
+    source_id = args[:id] || generate_id()
+    source_title = args[:title] || File.basename(url)
+    source_thumbnail_url = args[:thumb_url] || ''
+    return [false, "Cannot access remote thumbnail file #{url}."] if args.include?(:thumb_url) && 
+                                                           args[:thumb_url]!='' && 
+                                                           !remote_file_exists(thumb_url)
+    source_annotation = args[:annotation] || ''
+
+    sources = {:url => url, 
+               :ref_id => source_id, 
+               :title => source_title,
+               :thumb_url => source_thumbnail_url,
+               :annotation => source_annotation
+              }
+
+    query = {}
+    query[:sources] = sources.to_json
+    query[:pingback_url] = args[:pingback_url] if args.include?(:pingback_url) 
+    submit_transcription_request(query)
+  end
+
+  def transcribe(args)
+    return transcribe_url(args) if args.include?(:url)
+    return transcribe_platform(args) if args.include?(:platform)
+    "Missing arguments to transcribe request"
+  end
+
+  def transcript(args)
+    id = args[:id]
+    return [false, 'transcript id required'] unless id && id!=''
+
+    format = args[:format] || 'xml'
+ 
+    response = self.class.get("/transcripts/#{id}", :query => { format: format })
+    return [false, "Unauthorized: API key is incorrect"] if response.code==401
+    return [false, "SpeakerText Internal Error"] if response.code==500
+
+    fields = JSON.parse response.body
+ 
+    return [false, fields['message']] if response.code != 200
+    return [false, fields['status']] if fields['content']==''
+    return [true, fields['content']]
+  end
+
+  def fetch_transcript(args)
+    transcript(args)
+  end
+
+  def fetch_xml_transcript(args)
+    args.merge(format: 'xml')
+    transcript(args)
+  end
+
+  def fetch_text_transcript(args)
+    args.merge(format: 'txt')
+    transcript(args)
+  end
+
+  def fetch_html_transcript(args)
+    args.merge(format: 'html')
+    transcript(args)
+  end
+
+  def transcript_status(args)
+    id = args[:id]
+ 
+    response = self.class.get("/transcripts/#{id}")
+    return [false, "SpeakerText Internal Error"] if response.code==500
+
+    fields = JSON.parse response.body
+
+    return [false, fields['message']] if response.code != 200
+    return [true, fields['status']]
+  end
+
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: speaker_text
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Derrick Parkhurst
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-24 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: uuidtools
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.1.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.8.1
+  type: :runtime
+  version_requirements: *id002
+description: A gem to automate transcription of audio and video media using the SpeakerText.com service.
+email: derrick.parkhurst@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/speaker_text.rb
+- examples/transcribe_video.rb
+- examples/transcribe_youtube_video.rb
+- examples/speakertext.yaml
+- examples/fetch_transcript.rb
+- LICENSE
+- README.md
+homepage: http://github.com/thritysixthspan/speakertext
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: SpeakerText API Wrapper Gem
+test_files: []
+