Voicebase Client Ruby

This is a Ruby client to the VoiceBase API Version 1.x, see API documentation, and 2.x. Some portions of this gem were derived from voicebase-client-ruby.

Installation

Add this line to your application's Gemfile:

gem'voicebase-client-ruby',github: "usertesting/voicebase-client-ruby"

And then execute:

$ bundle

This gem is compatible with Ruby versions:

• 2.0.x
• 2.1.x
• 2.2.x
• 2.3.x

Usage

VoiceBase API V1.x:

An example to authenticate with v1 and upload a video file.

require'voicebase'client=VoiceBase::Client.new({api_version: "1.1",auth_key: "my-voicebase-key",auth_secret: "my-voicebase-secret",})client.upload_media({media_url: "http://my.media-example.com/media1.mp4",title: "My fancy media",transcription_type: 'machine',external_id: 'abcd1234',machine_ready_callback: "http://my.example.com/success",error_callback: "http://my.example.com/error"})response=client.get_transcript(external_id: 'abcd1234'format: "json")ifresponse.success?transcript_json=JSON.parse(response.transcript)end

For VoiceBase API V2.x:

require'voicebase'client=VoiceBase::Client.new({api_version: "2.0",auth_key: "my-voicebase-key",auth_secret: "my-voicebase-secret",})client.upload_media({media_url: "http://my.media-example.com/media1.mp4",configuration: {transcripts: {engine: "premium"},publish: {callbacks: [{url: "https://example.org/callback",method: "POST",include: ["transcripts","keywords","topics","metadata"]}]}}})client.get_transcript({media_id: "3b5c78e2-868c-4ce7-a0db-087a02db4042"},{'Accept'=>'text/srt'})
...

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install.

To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/usertesting/voicebase-client-ruby.