karotz 0.0.4 → 0.1.0

data/.irbrc

@@ -0,0 +1,10 @@
+$:.unshift 'lib'
+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']
+end
+
+@client = Karotz::Client.new(Karotz::Client.start)

data/README.rdoc

@@ -7,13 +7,38 @@ This gem is still in early development.
 
 == Docs
 
-Right now, please have a look at the specs for usage examples.
-
 Supported methods:
 
 * ears
 * led
-
-== Todos
-
-* add color mixing method for RGB usage
+* tts (text to speach)
+* multimedia
+
+Have a look at the whole api: http://dev.karotz.com/api/
+
+== 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']
+  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

data/lib/karotz/client.rb

@@ -6,6 +6,7 @@ require 'crack'
 
 module Karotz
   class Client
+    attr_accessor :interactive_id
 
     def initialize(interactive_id)
       @interactive_id = interactive_id
@@ -27,7 +28,7 @@ module Karotz
     API = "http://api.karotz.com/api/karotz/"
     DIGEST  = OpenSSL::Digest::Digest.new('sha1')
 
-    class << self
+    class << self # TODO add the rest of the API calls
 
       #==========EARS=================
 
@@ -37,55 +38,64 @@ module Karotz
 
       #============LED================
 
-      def led(interactive_id, params={:action => :pulse, :color => Color::BLUE, :period => 3000, :pulse => 500})
-        request :led, interactive_id, params
+      def led(interactive_id, params={})
+        request :led, interactive_id, {:action => :pulse, :color => Color::BLUE, :period => 3000, :pulse => 500}.merge(params)
       end
+      alias :pulse :led
 
-      def fade(interactive_id, params={:color => Color::BLUE, :period => 3000})
-        request :led, interactive_id, {:action => :fade}.merge(params)
+      def fade(interactive_id, params={})
+        request :led, interactive_id, {:action => :fade, :color => Color::BLUE, :period => 3000}.merge(params)
       end
 
-      def light(interactive_id, params={:color => Color::BLUE})
-        request :led, interactive_id, {:action => :light}.merge(params)
+      def light(interactive_id, params={})
+        request :led, interactive_id, {:action => :light, :color => Color::BLUE}.merge(params)
       end
 
       #============TTS================
 
-      def tts(interactive_id, params={:action => :speak, :text => "test", :lang => Language::ENGLISH})
-        request :tts, interactive_id, params
+      def tts(interactive_id, params={})
+        request :tts, interactive_id, {:action => :speak, :text => "test", :lang => Language::ENGLISH}.merge(params)
       end
       alias :speak :tts
 
       #============MULTIMEDIA=========
 
-      def multimedia(interactive_id, params={:action => :play, :url => "http://www.jimwalls.net/mp3/ATeam.mp3"})
-        request :multimedia, interactive_id, params
+      def multimedia(interactive_id, params={})
+        request :multimedia, interactive_id, {:action => :play, :url => "http://www.jimwalls.net/mp3/ATeam.mp3"}.merge(params)
       end
       alias :play :multimedia
 
       #============LIFE_CYCLE=========
 
       def start
+        Configuration.validate_credentials!
         url = start_url(Configuration.install_id, Configuration.api_key, Configuration.secret)
+        Configuration.logger.debug "calling karotz api with url '#{url}'"
         response = HTTPI.get(url)
         answer = Crack::XML.parse(response.body)
+        Configuration.logger.debug "answer was '#{answer}'"
         raise "could not retrieve interactive_id" if answer["VoosMsg"].nil? || answer["VoosMsg"]["interactiveMode"].nil? || answer["VoosMsg"]["interactiveMode"]["interactiveId"].nil?
         answer["VoosMsg"]["interactiveMode"]["interactiveId"]
       end
 
-      def stop(interactive_id, params={:action => :stop})
-        request :interactivemode, interactive_id, params
+      def stop(interactive_id, params={})
+        request :interactivemode, interactive_id, {:action => :stop}.merge(params)
       end
 
-      def session
-        interactive_id = start
-        yield(new(interactive_id))
+      def session # TODO multimedia-api is not blocking, so we need some whay to find out when we can kill the session properly
+        client = create
+        yield(client)
       ensure
-        stop(interactive_id)
+        stop(client.interactive_id) if client
       end
 
       #===========HELPERS================
 
+      def create
+        interactive_id = start
+        new(interactive_id)
+      end
+
       def start_url(install_id, api_key, secret, once=rand(99999999999999), timestamp=Time.now.to_i)
         params = {
           'installid'   => install_id,
@@ -106,9 +116,11 @@ module Karotz
         raise "interactive_id is needed!" unless interactive_id
         raise "endpoint is needed!" unless endpoint
         url = "#{API}#{endpoint}?#{create_query({ :interactiveid => interactive_id }.merge(params))}"
+        Configuration.logger.debug "calling karotz api with url '#{url}'"
         response = HTTPI.get(url)
         answer = Crack::XML.parse(response.body)
-        raise "bad response from server" unless answer["VoosMsg"]["response"]["code"] == "OK"
+        Configuration.logger.debug "answer was '#{answer}'"
+        raise "bad response from server" if answer["VoosMsg"].nil? || answer["VoosMsg"]["response"].nil? || answer["VoosMsg"]["response"]["code"] != "OK"
       end
 
       def create_query(params)

data/lib/karotz/color.rb

@@ -10,5 +10,7 @@ module Karotz
     RED     = "FF0000"
     YELLOW  = "75FF00"
     WHITE   = "4FFF68"
+
+    # TODO add color mixing method for RGB usage
   end
 end

data/lib/karotz/configuration.rb

@@ -1,3 +1,5 @@
+require 'logger'
+
 module Karotz
   class Configuration
     class << self
@@ -26,7 +28,7 @@ module Karotz
       end
 
       def blank?(key)
-        val = self.send :key
+        val = self.send key
         val.nil? || val.empty?
       end
 

data/lib/karotz/version.rb

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

data/spec/cassettes/karotz/client_lifecycle_should_create_a_client_with_a_interactive_id.yml

@@ -0,0 +1,18 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :get
+    uri: http://api.karotz.com:80/api/karotz/start?apikey=7afdd4b7-3bc8-4469-bda2-1d8bc1e218a0&installid=68e0a42b-aca3-49aa-9dc2-85a8f141e8c5&once=31070003985075&signature=Vo4ukPmZg7lB/3PkBWLXulkT/ss=&timestamp=1324980926
+    body: 
+    headers: 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      content-length:
+      - '388'
+      connection:
+      - keep-alive
+    body: <VoosMsg><id>6eaff778-ca04-435d-8d14-517757ebe99b</id><recipient>2addc8ff97e59fe4616021094db393d5</recipient><interactiveMode><action>START</action><interactiveId>e014174e-069b-4518-b8ea-d82184ae7c77</interactiveId><configId>941894ed-d048-42f6-ab68-fbe95abaa157</configId><access>ears</access><access>led</access><access>multimedia</access><access>tts</access></interactiveMode></VoosMsg>
+    http_version: '1.1'

data/spec/karotz_spec.rb

@@ -30,7 +30,6 @@ module Karotz
     end
 
     context "ears" do
-
       it "should wiggle the ears", :vcr => true do
         Client.ears(@interactive_id)
       end
@@ -63,7 +62,7 @@ module Karotz
 
     context "led" do
       it "should pulse", :vcr => true do
-        Client.led(@interactive_id)
+        Client.pulse(@interactive_id)
       end
 
       it "should fade", :vcr => true do
@@ -96,6 +95,12 @@ module Karotz
         end
       end
 
+      it "should create a client with a interactive_id", :vcr => true do
+        Client.create.tap do |it|
+          it.interactive_id.should_not be_nil
+        end
+      end
+
       it "should start and stop the interactiveMode", :vcr => true do
         interactive_id = Client.start
         interactive_id.should_not be_empty
@@ -108,6 +113,5 @@ module Karotz
         end
       end
     end
-
   end
 end

data/spec/spec_helper.rb

@@ -22,15 +22,15 @@ RSpec.configure do |config|
   end
 
   config.before :each do
-    HTTPI.log = false
-
     @install_id = ENV['KAROTZ_INSTALL_ID']
     @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"
 
+    HTTPI.log = false
     Karotz::Configuration.reset
+    Karotz::Configuration.logger.level = Logger::WARN
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karotz
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-26 00:00:00.000000000 Z
+date: 2011-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2156300460 !ruby/object:Gem::Requirement
+  requirement: &2160175000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156300460
+  version_requirements: *2160175000
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156300040 !ruby/object:Gem::Requirement
+  requirement: &2160174580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156300040
+  version_requirements: *2160174580
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &2156299620 !ruby/object:Gem::Requirement
+  requirement: &2160174160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156299620
+  version_requirements: *2160174160
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2156299200 !ruby/object:Gem::Requirement
+  requirement: &2160173740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156299200
+  version_requirements: *2160173740
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &2156298780 !ruby/object:Gem::Requirement
+  requirement: &2160173320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156298780
+  version_requirements: *2160173320
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &2156298360 !ruby/object:Gem::Requirement
+  requirement: &2160189280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156298360
+  version_requirements: *2160189280
 - !ruby/object:Gem::Dependency
   name: httpclient
-  requirement: &2156314320 !ruby/object:Gem::Requirement
+  requirement: &2160188860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156314320
+  version_requirements: *2160188860
 - !ruby/object:Gem::Dependency
   name: httpi
-  requirement: &2156313900 !ruby/object:Gem::Requirement
+  requirement: &2160188440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156313900
+  version_requirements: *2160188440
 - !ruby/object:Gem::Dependency
   name: crack
-  requirement: &2156313480 !ruby/object:Gem::Requirement
+  requirement: &2160188020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +109,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156313480
+  version_requirements: *2160188020
 description: ruby bindings for karotz rest api
 email:
 - phoetmail@googlemail.com
@@ -119,6 +119,7 @@ extra_rdoc_files: []
 files:
 - .document
 - .gitignore
+- .irbrc
 - .rvmrc
 - .specfile
 - .travis.yml
@@ -142,6 +143,7 @@ files:
 - spec/cassettes/karotz/client_led_should_fade.yml
 - spec/cassettes/karotz/client_led_should_light.yml
 - spec/cassettes/karotz/client_led_should_pulse.yml
+- spec/cassettes/karotz/client_lifecycle_should_create_a_client_with_a_interactive_id.yml
 - spec/cassettes/karotz/client_lifecycle_should_do_something_in_a_block.yml
 - spec/cassettes/karotz/client_lifecycle_should_start_and_stop_the_interactivemode.yml
 - spec/cassettes/karotz/client_multimedia_should_play_mp3.yml
@@ -182,6 +184,7 @@ test_files:
 - spec/cassettes/karotz/client_led_should_fade.yml
 - spec/cassettes/karotz/client_led_should_light.yml
 - spec/cassettes/karotz/client_led_should_pulse.yml
+- spec/cassettes/karotz/client_lifecycle_should_create_a_client_with_a_interactive_id.yml
 - spec/cassettes/karotz/client_lifecycle_should_do_something_in_a_block.yml
 - spec/cassettes/karotz/client_lifecycle_should_start_and_stop_the_interactivemode.yml
 - spec/cassettes/karotz/client_multimedia_should_play_mp3.yml