0.0
$Id: README.txt 204 2010-11-30 02:20:04Z pwilkins $
sm-transcript reads results of SLS processing and produces transcripts for
the SpokenMedia browser. For each file in the source folder whose extension
matches the source type, a file of destination type is created in the
destination folder. All of these parameters have default values.
Note: Examples of the commands you enter in the terminal are for *nix. The
command prompt in the examples is:
felix$ <command line>
If you are a Windows user, make the usual adjustments.
Requirements:
sm-transcript is written in Ruby and packaged as a RubyGem. Since Ruby is
not a compiled language, you will need to have Ruby installed on your
machine to run sm-transcript. You can determine if Ruby is installed by
typing "ruby -v" at a terminal prompt. It should return the version of
Ruby that is installed. If Ruby is not installed on your machine, navigate
to http://www.ruby-lang.org/ and follow the installation instructions.
sm-transcript was developed using Ruby 1.8. Other Ruby versions have not
been tested as of this release.
Installation:
You can get sm-transcript as either a RubyGem or as source from svn.
The preferred way to install this package is as a Rubygem. You can
download and install the gem with this command:
felix$ sudo gem install [--verbose] sm-transcript
This command downloads the most recent version of the gem from rubygems.org
and makes it active. Previous versions of the gem remain installed, but
are deactivated.
You must use "sudo" to properly install the gem. If you execute "gem
install" (omitting the "sudo") the gem is installed in your home gem
repository and it isn't in your path without additional configuration.
Note: You need sudo privileges to run the command as written. If you
can't sudo, then you can install it locally and will need some additional
configuration. Contact me (or your local Ruby wizard) for assistance.
The executable is now in your path.
You can cleanly uninstall the gem with this command:
felix$ sudo gem uninstall sm-transcript
If you have access to our svn repository, you are welcome to check out the
code. Be warned that the trunk tip is not necessarily stable. It changes
frequently as enhancements (and bug fixes) are added. (note that the
'smb_transcript' in the command line below is not a typo.)
svn co svn+ssh://svn.mit.edu/oeit-tsa/SMB/smb_transcript/trunk sm_transcript
build the gem by running this command from the directory you installed the
source. This is what it looks like on my machine:
felix$ rake gem
The gem will be built and put in ./pkg You can now use the gem
installation instructions above.
Using the App:
Run with no command line parameters, the app reads *.wrd files out of
./results and writes *.t1.html files to ./transcripts. These directories
are relative to where sm_transcript is called.
Note: destination files are overwritten without a warning prompt. If you
want to preserve an existing output file, rename it before running the app
again.
For example, run the app by navigating to the bin folder and enter
projects/sm_transcript/bin felix$ sm_transcript
This command run from this folder will read *.wrd files from bin/results
and write *-t1.html to bin/transcripts.
Usage: sm_transcript [options]
--srcdir PATH Read files from this folder (Default: ./results)
--destdir PATH Write files to this folder (Default: ./transcripts)
--srctype wrd | seg | txt | ttml | srt Kind of file to process (Default: wrd)
--desttype html | ttml | datajs | json Kind of file to output (Default: html)
-h, --help Show this message
There is a serious gotch'a in specifying the srctype parameter: it must
match the case of the file extension that you're processing. This means
that if the srt files that you are processing have the extension .SRT, then
you must specify the srctype as "SRT". Pretty lame, I know. I will update
the gem with a fix shortly. My apologies until then.
Troubleshooting:
sm-transcript requires additional gems to operate. The RubyGem
installation should install dependencies automatically, but when it
doesn't, you get an error that includes
... no such file to load -- builder (LoadError)
in the first few lines when you run sm-transcript, the problem is a
missing dependent gem. (the error above indicates that the Builder
gem is missing.) Try installing the missing gem. For the error above,
the command looks like this on my computer:
felix$ sudo gem install builder
See "Required Gems" below for more information.
A warning message such as:
"WARNING: Nokogiri was built against LibXML version 2.7.6,
but has dynamically loaded 2.7.7""
may be safely ignored.
If you continue to have trouble, feel free to contact me.
Upgrading:
You can easily upgrade by simply executing the same command you used to
install the gem. Running install again will add the newer version and make
it active. By default the most recent version is used, but older versions
are still available, simply inactive.
If are using svn, you should already know what to do.
Required Gems:
builder - create structured data, such as XML
extensions - added for the 'require_relative' command. (To get this
command in Ruby 1.8 you need to install this gem, for Ruby 1.9
the command is already part of the core.)
htmlentities - html parsing
json - create JSON structured data
nokogiri - xml parsing library
optparse - option parsing of command line
ostruct - open data structures
ppcommand - pp is a pretty printer. It is used only for debugging
rake - make for Ruby
rubygems - support for gems (shouldn't be needed for Ruby 1.9)
shoulda - enhancement for Test::Unit
This command installs gems on OSX and Linux:
felix$ sudo gem install <gem name>
I recommend running the following command to update to latest version of
rubygems before loading new gems.
felix$ sudo gem update --system
Unit Tests:
You may run all unit tests by navigating to the test folder and running
rake with no parameters (the default rake task runs all tests). On my
computer, it looks like this:
projects/sm_transcript/test felix$ rake
Release Notes:
Initial Version - runs under Ruby 1.8.x.
version 0.0.4 - fixes bug when processing .WRD files with CRLF line
endings.
version 0.0.5 - removed due to posting error
version 0.0.6 - added srctype of ttml and desttype of json, fixed bug where
beginning time of word was actually for previous word.
version 0.0.7 - added srt as srctype
version 0.0.8 - fixed bug that dropped last phrase from transcripts
version 1.0.0 - declared this version 1.0.0 to conform more closely with
gem numbering conventions. All tests run successfully.
To Do:
- specify individual files for processing rather than folders
- fix bug in srt processing: can't read Creole srt content.
- allow user to modify the "t1" file extension for addition languages of
the same transcript.
- update code to run under Ruby 1.9
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.0
Sinja is a Sinatra extension for quickly building RESTful,
{json:api}-compliant web services, leveraging the excellent
JSONAPI::Serializers gem for payload serialization. It enhances Sinatra's
DSL to enable resource-, relationship-, and role-centric API development,
and it configures Sinatra with the proper settings, MIME-types, filters,
conditions, and error-handling.
There are many parsing (deserializing), rendering (serializing), and other
"JSON API" libraries available for Ruby, but relatively few that attempt to
correctly implement the entire {json:api} server specification, including
routing, request header and query parameter checking, and relationship
side-loading. Sinja lets you focus on the business logic of your
applications without worrying about the specification, and without pulling
in a heavy framework like Rails. It's lightweight, ORM-agnostic, and
Ember.js-friendly!
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.0
RubyLess is an interpreter for "safe ruby". The idea is to transform some "unsafe" ruby code into safe, type checked ruby, eventually rewriting some variables or methods.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.0
ruby-contract provides support for describing and using types via unit-tests. It offers support for specifying contracts (Contract), method signature checks (Module#signature), automatic adaption between types (Kernel#adaption) and integration with the classic message- and class-based typing.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.0
Allows checking of reply content type with request accept types. Also allows contracting of downstream apps to supplying a single type.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.0
To get started check out the API Overview. Below is the documentation for each type of API call you can make. https://coinbase.com/api/doc
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.0
ALPHA Alert -- just uploaded initial release.
Linux inotify is a means to receive events describing file system activity (create, modify, delete, close, etc).
Sinotify was derived from aredridel's package (http://raa.ruby-lang.org/project/ruby-inotify/), with the addition of
Paul Boon's tweak for making the event_check thread more polite (see
http://www.mindbucket.com/2009/02/24/ruby-daemons-verifying-good-behavior/)
In sinotify, the classes Sinotify::PrimNotifier and Sinotify::PrimEvent provide a low level wrapper to inotify, with
the ability to establish 'watches' and then listen for inotify events using one of inotify's synchronous event loops,
and providing access to the events' masks (see 'man inotify' for details). Sinotify::PrimEvent class adds a little semantic sugar
to the event in to the form of 'etypes', which are just ruby symbols that describe the event mask. If the event has a
raw mask of (DELETE_SELF & IS_DIR), then the etypes array would be [:delete_self, :is_dir].
In addition to the 'straight' wrapper in inotify, sinotify provides an asynchronous implementation of the 'observer
pattern' for notification. In other words, Sinotify::Notifier listens in the background for inotify events, adapting
them into instances of Sinotify::Event as they come in and immediately placing them in a concurrent queue, from which
they are 'announced' to 'subscribers' of the event. [Sinotify uses the 'cosell' implementation of the Announcements
event notification framework, hence the terminology 'subscribe' and 'announce' rather then 'listen' and 'trigger' used
in the standard event observer pattern. See the 'cosell' package on github for details.]
A variety of 'knobs' are provided for controlling the behavior of the notifier: whether a watch should apply to a
single directory or should recurse into subdirectores, how fast it should broadcast queued events, etc (see
Sinotify::Notifier, and the example in the synopsis section below). An event 'spy' can also be setup to log all
Sinotify::PrimEvents and Sinotify::Events.
Sinotify::Event simplifies inotify's muddled event model, sending events only for those files/directories that have
changed. That's not to say you can't setup a notifier that recurses into subdirectories, just that any individual
event will apply to a single file, and not to its children. Also, event types are identified using words (in the form
of ruby :symbols) instead of inotify's event masks. See Sinotify::Event for more explanation.
The README for inotify:
http://www.kernel.org/pub/linux/kernel/people/rml/inotify/README
Selected quotes from the README for inotify:
* "Rumor is that the 'd' in 'dnotify' does not stand for 'directory' but for 'suck.'"
* "The 'i' in inotify does not stand for 'suck' but for 'inode' -- the logical
choice since inotify is inode-based."
(The 's' in 'sinotify' does in fact stand for 'suck.')
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.0
A Gem to get files Header, Footer, Type(via headers), create file checksum, check file checksum, Carving and ... .
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.0
Gem to parse Facebook ID's from various Facebook URL types. The five link types are: Status, Photo, Video, Link, Checkin.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.0
Checks for valid content type of excel files.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.0
QuacksLike is a module for RSpec to add matchers that test if an
object is fully duck-typed to pretend to be another class. This
kind of thing is really only necessary when passing such an
object as the return value in an API where you don't know
exactly how it will be consumed, but it needs to "quack like an
Array" or something. It does its job by checking every instance
method in the class that the target object needs to "quack like"
and makes sure the target both responds to that method name and
that the arity of the method is appropriate.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.0
Reliable contract definition, data validation, and type checking for Ruby.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.0
Objective-C style named parameters and type checking for Ruby.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.0
This gem with asks user input for there state name, then will prompt the use to type there city they would like to check the daily weather of."
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.0
A rich language which compiles to ruby. Including type annotations, type checking, macros, annotations, enums and more
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.0
isup is a command line utility to check if a site is up or down. Type 'isup -h' to see the help page.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.0
The strongtyping gem is a Ruby library that provides type checking and
method overloading.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.0
QuacksLike is a module for RSpec to add matchers that test if an object is fully duck-typed to pretend to be another class. This kind of thing is really only necessary when passing such an object as the return value in an API where you don't know exactly how it will be consumed, but it needs to "quack like an Array" or something. It does its job by checking every instance method in the class that the target object needs to "quack like" and makes sure the target both responds to that method name and that the arity of the method is appropriate.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.0
This is an experimental branch that implements a connection pool of
Net::HTTP objects instead of a connection/thread. C/T is fine if
you're only using your http threads to make connections but if you
use them in child threads then I suspect you will have a thread memory
leak. Also, I want to see if I get less connection resets if the
most recently used connection is always returned.
Also added a :force_retry option that if set to true will retry POST
requests as well as idempotent requests.
This branch is currently incompatible with the master branch in the
following ways:
* It doesn't allow you to recreate the Net::HTTP::Persistent object
on the fly. This is possible in the master version since all the
data is kept in thread local storage. For this version, you should
probably create a class instance of the object and use that in your
instance methods.
* It uses a hash in the initialize method. This was easier for me
as I use a HashWithIndifferentAccess created from a YAML file to
define my options. This should probably be modified to check the
arguments to achieve backwards compatibility.
* The method shutdown is unimplemented as I wasn't sure how I should
implement it and I don't need it as I do a graceful shutdown from
nginx to finish up my connections.
For connection issues, I completely recreate a new Net::HTTP instance.
I was running into an issue which I suspect is a JRuby bug where an
SSL connection that times out would leave the ssl context in a frozen
state which would then make that connection unusable so each time that
thread handled a connection a 500 error with the exception "TypeError:
can't modify frozen". I think Joseph West's fork resolves this issue
but I'm paranoid so I recreate the object.
Compatibility with the master version could probably be achieved by
creating a Strategy wrapper class for GenePool and a separate strategy
class with the connection/thread implementation.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.0
Methods for defining type-checked arrays and attributes
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity