karotz 0.3.0 → 0.4.0

data/README.rdoc

@@ -40,6 +40,7 @@ via Bundler:
     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
@@ -59,3 +60,19 @@ via Bundler:
   karotz.ears
   [...]
   karotz.stop
+
+== Railtie
+
+The gem comes with two example Rake tasks, that are automatically included into your Rails application:
+
+  rake karotz:build:failed
+  rake karotz:build:normal
+
+Both Tasks are examples of how you could use your Karotz in a CI system like Jenkins.
+
+== License
+
+"THE BEER-WARE LICENSE" (Revision 42):
+ps@nofail.de[mailto:ps@nofail.de] 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

data/lib/karotz/client.rb

@@ -25,9 +25,6 @@ module Karotz
       self.class.respond_to?(meth) || super
     end
 
-    API = "http://api.karotz.com/api/karotz/"
-    DIGEST  = OpenSSL::Digest::Digest.new('sha1')
-
     class << self
 
       #==========EARS=================
@@ -101,7 +98,7 @@ module Karotz
         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)
+        response = 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?
@@ -137,10 +134,10 @@ module Karotz
           'timestamp'   => timestamp,
         }
         query   = create_query(params)
-        hmac    = OpenSSL::HMAC.digest(DIGEST, secret, query)
+        hmac    = OpenSSL::HMAC.digest(Configuration.digest, secret, query)
         encoded = Base64.encode64(hmac).chomp
         signed  = CGI.escape(encoded)
-        "#{API}start?#{query}&signature=#{signed}"
+        "#{Configuration.endpoint}start?#{query}&signature=#{signed}"
       end
 
       private()
@@ -150,12 +147,18 @@ module Karotz
         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={})
+      def get(url)
+        request = HTTPI::Request.new(url)
+        request.proxy = Configuration.proxy if Configuration.proxy
+        HTTPI.get request
+      end
+
+      def perform_request(action, 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))}"
+        raise "action is needed!" unless action
+        url = "#{Configuration.endpoint}#{action}?#{create_query({ :interactiveid => interactive_id }.merge(params))}"
         Configuration.logger.debug "calling karotz api with url '#{url}'"
-        response = HTTPI.get(url)
+        response = get(url)
         answer = Crack::XML.parse(response.body)
         Configuration.logger.debug "answer was '#{answer}'"
         answer

data/lib/karotz/configuration.rb

@@ -5,7 +5,8 @@ module Karotz
     class << self
 
       attr_accessor :install_id, :api_key, :secret
-      attr_accessor :logger
+      attr_accessor :endpoint, :proxy
+      attr_accessor :logger, :digest
 
       def configure(options={})
         init_config
@@ -36,11 +37,14 @@ module Karotz
 
       def init_config(force=false)
         return if @init && !force
-        @init          = true
-        @secret        = ''
-        @api_key       = ''
-        @install_id    = ''
-        @logger        = Logger.new(STDERR)
+        @init       = true
+        @secret     = ''
+        @api_key    = ''
+        @install_id = ''
+        @proxy      = nil
+        @logger     = Logger.new(STDERR)
+        @endpoint   = "http://api.karotz.com/api/karotz/"
+        @digest     = OpenSSL::Digest::Digest.new('sha1')
       end
     end
   end

data/lib/karotz/rails/karotz.rake

@@ -23,6 +23,7 @@ namespace :karotz do
         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
     end
   end

data/lib/karotz/version.rb

@@ -1,3 +1,3 @@
 module Karotz
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/cassettes/proxied.yml

@@ -0,0 +1,26 @@
+---
+- !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=37b67bee-b480-44e9-84fe-8c711b09fe78&once=1502266272712&signature=DYh/pt3G//CENw9A5nyp3lsjaMY=&timestamp=1326123132
+    body: 
+    headers:
+      date:
+      - Mon, 09 Jan 2012 15:32:12 GMT
+      host:
+      - api.karotz.com
+      via:
+      - 1.1 ernst.local:9000
+      accept-encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      content-length:
+      - '540'
+      connection:
+      - keep-alive
+    body: <VoosMsg><id>eb9cacc6-8ad4-4ea9-8f72-8be3d2995a37</id><recipient>2addc8ff97e59fe4616021094db393d5</recipient><interactiveMode><action>START</action><interactiveId>f72ad94a-6424-4f8e-9b19-e3aad56f0b65</interactiveId><configId>b800bdca-482c-455c-8b9c-581ac7f2b1ec</configId><access>asr</access><access>button</access><access>ears</access><access>file</access><access>http</access><access>led</access><access>multimedia</access><access>rfid</access><access>serial</access><access>tts</access><access>webcam</access></interactiveMode></VoosMsg>
+    http_version: '1.1'

data/spec/cassettes/proxy/should_work_with_a_proxy.yml

@@ -0,0 +1,24 @@
+---
+- !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=37b67bee-b480-44e9-84fe-8c711b09fe78&once=1502266272712&signature=DYh/pt3G//CENw9A5nyp3lsjaMY=&timestamp=1326123132
+    body: 
+    headers: 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      proxy-connection:
+      - close
+      content-length:
+      - '540'
+      via:
+      - 1.1 ernst.local:9000
+      server:
+      - WEBrick/1.3.1 (Ruby/1.9.3/2011-10-30)
+      date:
+      - Mon, 09 Jan 2012 15:32:25 GMT
+    body: <VoosMsg><id>eb9cacc6-8ad4-4ea9-8f72-8be3d2995a37</id><recipient>2addc8ff97e59fe4616021094db393d5</recipient><interactiveMode><action>START</action><interactiveId>f72ad94a-6424-4f8e-9b19-e3aad56f0b65</interactiveId><configId>b800bdca-482c-455c-8b9c-581ac7f2b1ec</configId><access>asr</access><access>button</access><access>ears</access><access>file</access><access>http</access><access>led</access><access>multimedia</access><access>rfid</access><access>serial</access><access>tts</access><access>webcam</access></interactiveMode></VoosMsg>
+    http_version: '1.1'

data/spec/{karotz_spec.rb → client_spec.rb}

@@ -1,27 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 module Karotz
-  describe Configuration do
-    it "should be initialized with defaults" do
-      Configuration.install_id.should be_empty
-      Configuration.api_key.should be_empty
-      Configuration.secret.should be_empty
-      Configuration.logger.should_not be_nil
-    end
-
-    it "should configure with a hash" do
-      Configuration.configure :api_key => 'some-key'
-      Configuration.api_key.should eql('some-key')
-    end
-
-    it "should be initializable with a block" do
-      Configuration.configure do |conf|
-        conf.install_id = 'some-id'
-      end
-      Configuration.install_id.should eql('some-id')
-    end
-  end
-
   describe Client do
     it "should create a signed url" do
       args = ['INSTALL_ID', 'API_KEY', 'SECRET', '7112317', '1324833464']

data/spec/configuration_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+module Karotz
+  describe Configuration do
+    it "should be initialized with defaults" do
+      Configuration.install_id.should be_empty
+      Configuration.api_key.should be_empty
+      Configuration.secret.should be_empty
+      Configuration.logger.should_not be_nil
+    end
+
+    it "should configure with a hash" do
+      Configuration.configure :api_key => 'some-key'
+      Configuration.api_key.should eql('some-key')
+    end
+
+    it "should be initializable with a block" do
+      Configuration.configure do |conf|
+        conf.install_id = 'some-id'
+      end
+      Configuration.install_id.should eql('some-id')
+    end
+  end
+end

data/spec/proxy_spec.rb

@@ -0,0 +1,57 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'webrick'
+require 'webrick/httpproxy'
+require 'thread' # for ::Mutex used in VCR middleware
+
+module WEBrick
+  class VCRProxyServer < HTTPProxyServer
+    def initialize(*)
+      super
+      @mutex = Mutex.new
+      trap('INT') { shutdown }
+    end
+
+    def service(*args)
+      @mutex.synchronize do
+        VCR.use_cassette('proxied') do
+          super(*args) # XXX: for some reason super (with no args) does not work
+        end
+      end
+    end
+  end
+end
+
+unless RUBY_PLATFORM == 'java'
+  module Karotz
+    describe "proxy" do
+      before :all do
+        @pid = fork do
+          STDERR.reopen('/dev/null', 'a')
+          WEBrick::VCRProxyServer.new(:Port => 9000).start
+        end
+
+        begin
+          TCPSocket.open('localhost', 9000).close
+        rescue Errno::ECONNREFUSED
+          retry
+        end
+      end
+
+      before(:each) do
+        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      = 'http://localhost:9000'
+        end
+      end
+
+      it "should work with a proxy", :vcr => true do
+        Client.create.tap do |it|
+          it.interactive_id.should_not be_nil
+        end
+      end
+    end
+  end
+end

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 = "aa36d0a0-fcbd-4095-955b-9a6d53c2e3fc"
+    @interactive_id = "f3065573-913f-417f-8171-4524f7863cff"
 
     HTTPI.log = false
     Karotz::Configuration.reset

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karotz
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-30 00:00:00.000000000 Z
+date: 2012-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2151815860 !ruby/object:Gem::Requirement
+  requirement: &2151815380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151815860
+  version_requirements: *2151815380
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2151814740 !ruby/object:Gem::Requirement
+  requirement: &2151814460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151814740
+  version_requirements: *2151814460
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2151814020 !ruby/object:Gem::Requirement
+  requirement: &2151813700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151814020
+  version_requirements: *2151813700
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &2151829460 !ruby/object:Gem::Requirement
+  requirement: &2151828300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151829460
+  version_requirements: *2151828300
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2151827220 !ruby/object:Gem::Requirement
+  requirement: &2151826840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151827220
+  version_requirements: *2151826840
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &2151826380 !ruby/object:Gem::Requirement
+  requirement: &2151826000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151826380
+  version_requirements: *2151826000
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &2151825580 !ruby/object:Gem::Requirement
+  requirement: &2151825200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151825580
+  version_requirements: *2151825200
 - !ruby/object:Gem::Dependency
   name: httpclient
-  requirement: &2151824520 !ruby/object:Gem::Requirement
+  requirement: &2151824360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: '2.2'
   type: :runtime
   prerelease: false
-  version_requirements: *2151824520
+  version_requirements: *2151824360
 - !ruby/object:Gem::Dependency
   name: httpi
-  requirement: &2151823960 !ruby/object:Gem::Requirement
+  requirement: &2151823800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +109,10 @@ dependencies:
         version: '0.9'
   type: :runtime
   prerelease: false
-  version_requirements: *2151823960
+  version_requirements: *2151823800
 - !ruby/object:Gem::Dependency
   name: crack
-  requirement: &2151823440 !ruby/object:Gem::Requirement
+  requirement: &2151822880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,7 +120,7 @@ dependencies:
         version: '0.3'
   type: :runtime
   prerelease: false
-  version_requirements: *2151823440
+  version_requirements: *2151822880
 description: ruby bindings for karotz rest api
 email:
 - phoetmail@googlemail.com
@@ -166,7 +166,11 @@ files:
 - 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/cassettes/proxied.yml
+- spec/cassettes/proxy/should_work_with_a_proxy.yml
+- spec/client_spec.rb
+- spec/configuration_spec.rb
+- spec/proxy_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/phoet/karotz
 licenses: []
@@ -210,5 +214,9 @@ test_files:
 - 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/cassettes/proxied.yml
+- spec/cassettes/proxy/should_work_with_a_proxy.yml
+- spec/client_spec.rb
+- spec/configuration_spec.rb
+- spec/proxy_spec.rb
 - spec/spec_helper.rb