Giter VIP home page Giter VIP logo

transcribeme's Introduction

TranscribeMe gem

Build Status Gem Version Dependency Status Coverage Status Code Climate

Description

This gem is a Ruby wrapper for the TranscribeMe SOAP API, built on Savon, and includes some extra dangly bits for uploading to Windows Azure Blob storage.

This gem wants to make it easy for you. It tries, at least. If you call the 'sign_in' method before initializing a session then we all know you meant to. We'll jump right in there and initialize it for you.

Prerequisites

This gem relies on FFMPEG for determining the duration of audio (and video) files. The TranscribeMe SOAP API leaves it as the client's responsibility for determining the duration of files being uploaded.

Installation

Add this line to your application's Gemfile:

gem 'transcribeme'

And then execute:

$ bundle

Or install it yourself as:

$ gem install transcribeme

Usage

See USAGE.md

Documentation

Documentation follows Tomdoc and is generated by YARD

The documentation can be browsed online

Changelog

Version 1.00

Initial stable release

Version 1.0.1

Bug fix -

Roadmap

Version 1.1.0

  • Set up Travis-CI and document supported Ruby versions

  • Investigate Windows Azure Blob storage file upload

  • Include Excon for Windows Azure Blob storage

  • Base64 decrypt transcription results

  • Document SOAP calls and error messages

  • Complete YARD documentation

  • Refactor the recordings array into an object with .completed .in_progress and .ready_for_transcription methods

  • Exceptions for error handling

  • Modelling Recording objects, particularly better describing recording status

  • Reduce gem size through reducing spec support files (download as needed during specs, gitignored?)

Version 1.2.0

  • Implement the customer sign up API

  • Implement the customer reset password

Version 2.0.0

  • Breaking changes planned: Refactor DSL around recordings to be more OO

Version 2.1.0

  • Create a CLI interface

RubyMotion

  • 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.

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

transcribeme's People

Contributors

tuttinator avatar

Watchers

 avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.