karotz 0.1.0 → 0.2.0

data/.gitignore

@@ -1,4 +1,5 @@
 *.gem
+*.zip
 .bundle
 Gemfile.lock
 pkg/*

data/.irbrc

@@ -7,4 +7,4 @@ Karotz::Configuration.configure do |config|
   config.secret     = ENV['KAROTZ_SECRET']
 end
 
-@client = Karotz::Client.new(Karotz::Client.start)
+@client = Karotz::Client.create

data/README.rdoc

@@ -2,6 +2,7 @@
 
 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.
 
@@ -13,8 +14,24 @@ Supported methods:
 * led
 * tts (text to speach)
 * multimedia
+* asr (automated speach recognition)
+* webcam
+* config
 
-Have a look at the whole api: http://dev.karotz.com/api/
+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
 

data/descriptor.xml

@@ -0,0 +1,21 @@
+<descriptor>
+  <version>0.0.3</version>
+  <accesses>
+    <access>tts</access>
+    <access>ears</access>
+    <access>led</access>
+    <access>multimedia</access>
+    <access>button</access>
+    <access>asr</access>
+    <access>webcam</access>
+    <access>rfid</access>
+    <access>http</access>
+    <access>file</access>
+    <access>serial</access>
+  </accesses>
+  <deployment>external</deployment>
+  <callback>http://ohrsome.heroku.com/karotz</callback>
+  <parameters>
+    <parameter key="showInstallUuid" value="true"/>
+  </parameters>
+</descriptor>

data/karotz.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.authors     = ["Peter Schröder"]
   s.email       = ["phoetmail@googlemail.com"]
   s.homepage    = "http://github.com/phoet/karotz"
-  s.description = s.summary     = %q{ruby bindings for karotz rest api}
+  s.description = s.summary = %q{ruby bindings for karotz rest api}
 
   s.rubyforge_project = "karotz"
 
@@ -24,9 +24,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency "webmock"
   s.add_development_dependency "vcr"
 
-  s.add_runtime_dependency "httpclient"
-  s.add_runtime_dependency "httpi"
-  s.add_runtime_dependency "crack"
+  s.add_runtime_dependency "httpclient",  "~> 2.2"
+  s.add_runtime_dependency "httpi",       "~> 0.9"
+  s.add_runtime_dependency "crack",       "~> 0.3"
 
   s.add_runtime_dependency('jruby-openssl') if RUBY_PLATFORM == 'java'
 end

data/lib/karotz/client.rb

@@ -58,13 +58,35 @@ module Karotz
       end
       alias :speak :tts
 
+      #============ASR================
+
+      def asr(interactive_id, params={})
+        request :asr, interactive_id, {:grammar => 'ruby', :lang => Language::ENGLISH}.merge(params)
+      end
+      alias :listen :asr
+
       #============MULTIMEDIA=========
 
       def multimedia(interactive_id, params={})
-        request :multimedia, interactive_id, {:action => :play, :url => "http://www.jimwalls.net/mp3/ATeam.mp3"}.merge(params)
+        request :multimedia, interactive_id, {:action => Karotz::Multimedia::PLAY, :url => "http://www.jimwalls.net/mp3/ATeam.mp3"}.merge(params)
       end
       alias :play :multimedia
 
+      #============WEBCAM=========
+
+      def webcam(interactive_id, params={})
+        request :webcam, interactive_id, {:action => :photo, :url => "https://picasaweb.google.com/data/feed/api/phoet6/default/albumid/default"}.merge(params)
+      end
+      alias :snap :webcam
+      alias :cam :webcam
+
+      #============CONFIG=========
+
+      def config(interactive_id)
+        answer = perform_request(:config, interactive_id)
+        answer["ConfigResponse"]
+      end
+
       #============LIFE_CYCLE=========
 
       def start
@@ -79,7 +101,7 @@ module Karotz
       end
 
       def stop(interactive_id, params={})
-        request :interactivemode, interactive_id, {:action => :stop}.merge(params)
+        request(:interactivemode, interactive_id, {:action => :stop}.merge(params))
       end
 
       def session # TODO multimedia-api is not blocking, so we need some whay to find out when we can kill the session properly
@@ -113,6 +135,11 @@ module Karotz
       private()
 
       def request(endpoint, interactive_id, params={})
+        answer = perform_request(endpoint, interactive_id, params)
+        raise "bad response from server" if answer["VoosMsg"].nil? || answer["VoosMsg"]["response"].nil? || answer["VoosMsg"]["response"]["code"] != "OK"
+      end
+
+      def perform_request(endpoint, interactive_id, params={})
         raise "interactive_id is needed!" unless interactive_id
         raise "endpoint is needed!" unless endpoint
         url = "#{API}#{endpoint}?#{create_query({ :interactiveid => interactive_id }.merge(params))}"
@@ -120,7 +147,7 @@ module Karotz
         response = HTTPI.get(url)
         answer = Crack::XML.parse(response.body)
         Configuration.logger.debug "answer was '#{answer}'"
-        raise "bad response from server" if answer["VoosMsg"].nil? || answer["VoosMsg"]["response"].nil? || answer["VoosMsg"]["response"]["code"] != "OK"
+        answer
       end
 
       def create_query(params)

data/lib/karotz/language.rb

@@ -3,5 +3,6 @@ module Karotz
     ENGLISH = :EN
     GERMAN  = :DE
     FRENCH  = :FR
+    SPANISH = :ES
   end
 end

data/lib/karotz/multimedia.rb

@@ -0,0 +1,15 @@
+module Karotz
+  class Multimedia
+    PLAY = :play
+    PAUSE = :pause
+    RESUME = :resume
+    STOP = :stop
+    PREVIOUS = :previous
+    NEXT = :next
+    RECORD = :record
+    ALL_SONG = :allsong
+    FOLDER = :folder
+    ARTIST = :artist
+    GENRE = :genre
+  end
+end

data/lib/karotz/version.rb

@@ -1,3 +1,3 @@
 module Karotz
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/karotz.rb

@@ -1,5 +1,6 @@
 require "karotz/version"
 require "karotz/configuration"
+require "karotz/multimedia"
 require "karotz/color"
 require "karotz/language"
 require "karotz/client"

data/spec/cassettes/karotz/client_automatic_speach_recognition_asr_should_listen_to_voice.yml

@@ -0,0 +1,18 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :get
+    uri: http://api.karotz.com:80/api/karotz/asr?grammar=ruby&interactiveid=61f280fd-88fc-469f-bded-fc2ead4152c4&lang=EN
+    body: 
+    headers: 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      content-length:
+      - '283'
+      connection:
+      - keep-alive
+    body: <VoosMsg><id>d7c49346-dc3a-4c32-ab18-95e1406967c7</id><correlationId>fa7690be-672e-4847-a7eb-4265be06e9a1</correlationId><interactiveId>61f280fd-88fc-469f-bded-fc2ead4152c4</interactiveId><callback>http://localhost:3000/karotz</callback><response><code>OK</code></response></VoosMsg>
+    http_version: '1.1'

data/spec/cassettes/karotz/client_config_should_retrieve_the_config.yml

@@ -0,0 +1,18 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :get
+    uri: http://api.karotz.com:80/api/karotz/config?interactiveid=2f72fe9f-9c0a-4949-b1e6-5a402f125536
+    body: 
+    headers: 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      content-length:
+      - '511'
+      connection:
+      - keep-alive
+    body: <ConfigResponse><config><interruptible>false</interruptible><awake>false</awake><name>config</name><uuid>SOME_UUID</uuid><params><key>awake</key><value>false</value></params><params><key>interruptible</key><value>false</value></params><params><key>permanentTriggerActivator</key><value>false</value></params><params><key>scheduledDateTriggerActivator</key><value>false</value></params><params><key>scheduledTriggerActivator</key><value>false</value></params></config></ConfigResponse>
+    http_version: '1.1'

data/spec/cassettes/karotz/client_webcam_should_take_a_picture_and_upload_it.yml

@@ -0,0 +1,18 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :get
+    uri: http://api.karotz.com:80/api/karotz/webcam?action=photo&interactiveid=aa36d0a0-fcbd-4095-955b-9a6d53c2e3fc&url=https://picasaweb.google.com/data/feed/api/phoet6/default/albumid/default
+    body: 
+    headers: 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      content-length:
+      - '286'
+      connection:
+      - keep-alive
+    body: <VoosMsg><id>bec92e1c-e412-4bce-93f6-d89336c4f7f1</id><correlationId>84e5b955-4676-4511-9c1d-5de8b86f4755</correlationId><interactiveId>aa36d0a0-fcbd-4095-955b-9a6d53c2e3fc</interactiveId><callback>http://localhost:3000/karotz</callback><response><code>OK</code></response></VoosMsg>
+    http_version: '1.1'

data/spec/karotz_spec.rb

@@ -45,8 +45,8 @@ module Karotz
 
       it "should look sad", :vcr => true do
         params = {
-          :left => 90,
-          :right => 90,
+          :left => 9,
+          :right => 9,
           :relative => false
         }
         Client.ears(@interactive_id, params)
@@ -76,7 +76,13 @@ module Karotz
 
     context "text to speach (tts)" do
       it "should say something", :vcr => true do
-        Client.tts(@interactive_id)
+        Client.speak(@interactive_id)
+      end
+    end
+
+    context "automatic speach recognition (asr)" do
+      it "should listen to voice", :vcr => true do
+        Client.listen(@interactive_id)
       end
     end
 
@@ -86,6 +92,34 @@ module Karotz
       end
     end
 
+    context "webcam" do
+      it "should take a picture and upload it", :vcr => true do
+        Client.snap(@interactive_id)
+      end
+    end
+
+    context "config" do
+      it "should retrieve the config", :vcr => true do
+        Client.config(@interactive_id).should eql(
+          {
+            "config" => {
+              "interruptible"=>"false",
+              "awake"=>"false",
+              "name"=>"config",
+              "uuid"=>"SOME_UUID",
+              "params"=>[
+                {"key"=>"awake", "value"=>"false"},
+                {"key"=>"interruptible", "value"=>"false"},
+                {"key"=>"permanentTriggerActivator", "value"=>"false"},
+                {"key"=>"scheduledDateTriggerActivator", "value"=>"false"},
+                {"key"=>"scheduledTriggerActivator", "value"=>"false"}
+              ]
+            }
+          }
+        )
+      end
+    end
+
     context "lifecycle" do
       before(:each) do
         Configuration.configure do |config|

data/spec/spec_helper.rb

@@ -26,7 +26,7 @@ RSpec.configure do |config|
     @api_key = ENV['KAROTZ_API_KEY']
     @secret = ENV['KAROTZ_SECRET']
     # retrieved via http://www.karotz.com/authentication/run/karotz/API_KEY
-    @interactive_id = "209301e8-05a6-47b4-b257-600eb62f7d25"
+    @interactive_id = "aa36d0a0-fcbd-4095-955b-9a6d53c2e3fc"
 
     HTTPI.log = false
     Karotz::Configuration.reset

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karotz
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-27 00:00:00.000000000 Z
+date: 2011-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2160175000 !ruby/object:Gem::Requirement
+  requirement: &2160174660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160175000
+  version_requirements: *2160174660
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2160174580 !ruby/object:Gem::Requirement
+  requirement: &2160174240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160174580
+  version_requirements: *2160174240
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &2160174160 !ruby/object:Gem::Requirement
+  requirement: &2160173820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160174160
+  version_requirements: *2160173820
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2160173740 !ruby/object:Gem::Requirement
+  requirement: &2160173400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160173740
+  version_requirements: *2160173400
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &2160173320 !ruby/object:Gem::Requirement
+  requirement: &2160189360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160173320
+  version_requirements: *2160189360
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &2160189280 !ruby/object:Gem::Requirement
+  requirement: &2160188940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,40 +76,40 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160189280
+  version_requirements: *2160188940
 - !ruby/object:Gem::Dependency
   name: httpclient
-  requirement: &2160188860 !ruby/object:Gem::Requirement
+  requirement: &2160188440 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
   type: :runtime
   prerelease: false
-  version_requirements: *2160188860
+  version_requirements: *2160188440
 - !ruby/object:Gem::Dependency
   name: httpi
-  requirement: &2160188440 !ruby/object:Gem::Requirement
+  requirement: &2160187940 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :runtime
   prerelease: false
-  version_requirements: *2160188440
+  version_requirements: *2160187940
 - !ruby/object:Gem::Dependency
   name: crack
-  requirement: &2160188020 !ruby/object:Gem::Requirement
+  requirement: &2160187480 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
   type: :runtime
   prerelease: false
-  version_requirements: *2160188020
+  version_requirements: *2160187480
 description: ruby bindings for karotz rest api
 email:
 - phoetmail@googlemail.com
@@ -127,14 +127,18 @@ files:
 - Guardfile
 - README.rdoc
 - Rakefile
+- descriptor.xml
 - karotz.gemspec
 - lib/karotz.rb
 - lib/karotz/client.rb
 - lib/karotz/color.rb
 - lib/karotz/configuration.rb
 - lib/karotz/language.rb
+- lib/karotz/multimedia.rb
 - lib/karotz/version.rb
+- spec/cassettes/karotz/client_automatic_speach_recognition_asr_should_listen_to_voice.yml
 - spec/cassettes/karotz/client_automatic_speach_recognition_asr_should_say_something.yml
+- spec/cassettes/karotz/client_config_should_retrieve_the_config.yml
 - spec/cassettes/karotz/client_ears_should_look_sad.yml
 - spec/cassettes/karotz/client_ears_should_make_the_bull.yml
 - spec/cassettes/karotz/client_ears_should_reset_the_ears.yml
@@ -148,6 +152,7 @@ files:
 - spec/cassettes/karotz/client_lifecycle_should_start_and_stop_the_interactivemode.yml
 - spec/cassettes/karotz/client_multimedia_should_play_mp3.yml
 - spec/cassettes/karotz/client_text_to_speach_tts_should_say_something.yml
+- spec/cassettes/karotz/client_webcam_should_take_a_picture_and_upload_it.yml
 - spec/karotz_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/phoet/karotz
@@ -175,7 +180,9 @@ signing_key:
 specification_version: 3
 summary: ruby bindings for karotz rest api
 test_files:
+- spec/cassettes/karotz/client_automatic_speach_recognition_asr_should_listen_to_voice.yml
 - spec/cassettes/karotz/client_automatic_speach_recognition_asr_should_say_something.yml
+- spec/cassettes/karotz/client_config_should_retrieve_the_config.yml
 - spec/cassettes/karotz/client_ears_should_look_sad.yml
 - spec/cassettes/karotz/client_ears_should_make_the_bull.yml
 - spec/cassettes/karotz/client_ears_should_reset_the_ears.yml
@@ -189,5 +196,6 @@ test_files:
 - spec/cassettes/karotz/client_lifecycle_should_start_and_stop_the_interactivemode.yml
 - spec/cassettes/karotz/client_multimedia_should_play_mp3.yml
 - spec/cassettes/karotz/client_text_to_speach_tts_should_say_something.yml
+- spec/cassettes/karotz/client_webcam_should_take_a_picture_and_upload_it.yml
 - spec/karotz_spec.rb
 - spec/spec_helper.rb