https://github.com/phoet/karotz

ruby bindings for the karotz rest api
https://github.com/phoet/karotz

Last synced: 10 days ago
JSON representation

ruby bindings for the karotz rest api

• Host: GitHub
• URL: https://github.com/phoet/karotz
• Owner: phoet
• Created: 2011-12-25T20:47:02.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2013-08-11T20:06:43.000Z (about 11 years ago)
• Last Synced: 2024-05-01T22:35:54.616Z (6 months ago)
• Language: Ruby
• Homepage:
• Size: 408 KB
• Stars: 12
• Watchers: 4
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.rdoc
  • Changelog: CHANGELOG.rdoc

Awesome Lists containing this project

README

        
== Info

Status: http://stillmaintained.com/phoet/karotz.png

Build: http://travis-ci.org/phoet/karotz.png

Dependencies: http://gemnasium.com/phoet/karotz.png

This gem is still in early development.

== Docs

Supported methods:

* ears

* led

* tts (text to speech)

* multimedia

* asr (automated speach recognition)

* webcam

* config

Have a look at the whole api: http://dev.karotz.com/api

Read the HOW-TO: http://www.dzone.com/links/karotz_ruby_love.html

== Installation

  gem install karotz

via Bundler:

  # Gemfile

  gem "karotz"

  

  bundle install

== Examples

  require 'karotz'

  Karotz::Configuration.configure do |config|

    config.install_id = ENV['KAROTZ_INSTALL_ID']

    config.api_key    = ENV['KAROTZ_API_KEY']

    config.secret     = ENV['KAROTZ_SECRET']

    config.proxy      = ENV['KAROTZ_PROXY']

  end

  

  # bare

  interactive_id = Karotz::Client.start

  Karotz::Client.ears interactive_id

  [...]

  Karotz::Client.stop(interactive_id)

  

  # using a session

  Karotz::Client.session do |karotz|

    karotz.ears

    [...]

  end

  

  # using a client

  karotz = Karotz::Client.create

  karotz.ears

  [...]

  karotz.stop

== Changes

See CHANGELOG file.

== License

"THE BEER-WARE LICENSE" (Revision 42):

[email protected][mailto:[email protected]] wrote this file. As long as you retain this notice you

can do whatever you want with this stuff. If we meet some day, and you think

this stuff is worth it, you can buy me a beer in return Peter Schröder