bixby-common 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53b5ec30f44a5f248d360a13d02bc46881e64f03
-  data.tar.gz: 4ad3d8400f6390ce4630a502e15e4fc9ca5d4507
+  metadata.gz: d655ba4c5a8200586b435768668f60b2e0a6809e
+  data.tar.gz: 5e9d2be246830d38aef93bd079257052145d52e6
 SHA512:
-  metadata.gz: db1b6968efb742cf556c6cfdeb4a0836a05869d5088abc126c5360d2e8d8494a209bd261d9bac3b5fdfb18fee17ce775b7d123bdd7a02149bd037970877726ef
-  data.tar.gz: 0ca4ee9520635bc97adea27f4c293b4a4797958a296eaf87d3d9d016618ff43c5db197522e99baf506cec46861001f4f5ec1233cc42787c9d79407084024fb2b
+  metadata.gz: 3ff9e4a9b966d0a40701ec04d8fcec8125b0d523126e6da6dcae414f5e72fc84b0a92d48e70b255e7f1c76723e45c1ea4f212cff4aa26f2e4f57c347e353b963
+  data.tar.gz: e53209d266c816916f4841a82f267494aaf3d115694eb730188d523697ab3280c450cb1a5458ffd5719b840ea6620dd4962acc67ee37c7c136ad3c8381587349

data/Gemfile

@@ -1,13 +1,12 @@
 source "https://rubygems.org"
 
 gem "faye-websocket"
-gem "api-auth", :git => "https://github.com/chetan/api_auth.git", :branch => "bixby"
 gem "multi_json"
-gem "httpi",        :git => "https://github.com/chetan/httpi.git",
-                    :branch => "chunked_responses"
-
+gem "httpi"
 gem "logging"
 
+gem "api-auth", :git => "https://github.com/chetan/api_auth.git", :branch => "bixby"
+
 group :development do
   gem "yard", "~> 0.8"
   gem "bundler", "~> 1.1"

data/Gemfile.lock

@@ -5,17 +5,9 @@ GIT
   specs:
     api-auth (1.0.3)
 
-GIT
-  remote: https://github.com/chetan/httpi.git
-  revision: f6e49303fee6778c714bcc556fa5f9247bc3a3f3
-  branch: chunked_responses
-  specs:
-    httpi (2.0.0)
-      rack
-
 GIT
   remote: https://github.com/chetan/jeweler.git
-  revision: 9b8b2376c79299b823a5e9aafae3d647df943b6f
+  revision: c83ba18b074e82415052e80499a770bff87bf944
   branch: bixby
   specs:
     jeweler (1.8.7)
@@ -98,6 +90,9 @@ GEM
     hirb (0.7.1)
     httpauth (0.2.0)
     httpclient (2.3.4.1)
+    httpi (2.1.0)
+      rack
+      rubyntlm (~> 0.3.2)
     jruby-openssl (0.8.8)
       bouncy-castle-java (>= 1.5.0147)
     json (1.8.0)
@@ -151,6 +146,7 @@ GEM
     rcov (1.0.0)
     rdoc (4.0.1)
       json (~> 1.4)
+    rubyntlm (0.3.4)
     safe_yaml (0.9.5)
     simplecov-console (0.1.1)
       colorize
@@ -182,7 +178,7 @@ DEPENDENCIES
   curb
   faye-websocket
   httpclient
-  httpi!
+  httpi
   jeweler!
   jruby-openssl
   json

data/Rakefile

@@ -19,6 +19,7 @@ Jeweler::Tasks.new do |gemspec|
   gemspec.email = "chetan@pixelcop.net"
   gemspec.homepage = "http://github.com/chetan/bixby-common"
   gemspec.authors = ["Chetan Sarva"]
+  gemspec.license = "MIT"
 end
 Jeweler::RubygemsDotOrgTasks.new
 

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/bixby-common.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "bixby-common"
-  s.version = "0.4.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chetan Sarva"]
-  s.date = "2013-08-24"
+  s.date = "2013-08-29"
   s.description = "Bixby Common files/libs"
   s.email = "chetan@pixelcop.net"
   s.extra_rdoc_files = [
@@ -45,6 +45,7 @@ Gem::Specification.new do |s|
     "lib/bixby-common/util/jsonify.rb",
     "lib/bixby-common/util/log.rb",
     "lib/bixby-common/util/log/filtering_layout.rb",
+    "lib/bixby-common/util/log/logger.rb",
     "lib/bixby-common/websocket/api_channel.rb",
     "lib/bixby-common/websocket/async_response.rb",
     "lib/bixby-common/websocket/client.rb",
@@ -65,6 +66,7 @@ Gem::Specification.new do |s|
     "test/util/log_test.rb"
   ]
   s.homepage = "http://github.com/chetan/bixby-common"
+  s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = "2.0.3"
   s.summary = "Bixby Common"
@@ -74,10 +76,10 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<faye-websocket>, [">= 0"])
-      s.add_runtime_dependency(%q<api-auth>, [">= 0"])
       s.add_runtime_dependency(%q<multi_json>, [">= 0"])
       s.add_runtime_dependency(%q<httpi>, [">= 0"])
       s.add_runtime_dependency(%q<logging>, [">= 0"])
+      s.add_runtime_dependency(%q<api-auth>, [">= 0"])
       s.add_development_dependency(%q<yard>, ["~> 0.8"])
       s.add_development_dependency(%q<bundler>, ["~> 1.1"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
@@ -100,10 +102,10 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<jruby-openssl>, [">= 0"])
     else
       s.add_dependency(%q<faye-websocket>, [">= 0"])
-      s.add_dependency(%q<api-auth>, [">= 0"])
       s.add_dependency(%q<multi_json>, [">= 0"])
       s.add_dependency(%q<httpi>, [">= 0"])
       s.add_dependency(%q<logging>, [">= 0"])
+      s.add_dependency(%q<api-auth>, [">= 0"])
       s.add_dependency(%q<yard>, ["~> 0.8"])
       s.add_dependency(%q<bundler>, ["~> 1.1"])
       s.add_dependency(%q<jeweler>, [">= 0"])
@@ -127,10 +129,10 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<faye-websocket>, [">= 0"])
-    s.add_dependency(%q<api-auth>, [">= 0"])
     s.add_dependency(%q<multi_json>, [">= 0"])
     s.add_dependency(%q<httpi>, [">= 0"])
     s.add_dependency(%q<logging>, [">= 0"])
+    s.add_dependency(%q<api-auth>, [">= 0"])
     s.add_dependency(%q<yard>, ["~> 0.8"])
     s.add_dependency(%q<bundler>, ["~> 1.1"])
     s.add_dependency(%q<jeweler>, [">= 0"])

data/lib/bixby-common/util/debug.rb

@@ -15,5 +15,31 @@ module Bixby
       end
     end # :nocov:
 
+    # Pretty print a hash
+    #
+    # @example
+    #   {
+    #     content-md5   => "Rb0qo2Ae7KGcS5TDulOjYw==",
+    #     date          => "Thu, 29 Aug 2013 13:49:53 GMT",
+    #     authorization => "APIAuth c61ca57b8d7b3e95fba06a",
+    #   }
+    #
+    # @param [Hash] hash
+    # @return [String]
+    def self.pretty_hash(hash)
+      return "{}" if hash.empty?
+
+      s = [ "\n\t{" ]
+      l = hash.keys.max_by{ |k| k.length }.length + 1 # length of longest key so we can align values
+      hash.keys.each{ |k| s << ("  %s%s=> %s," % [k, " "*(l-k.length), hash[k].inspect]) }
+      s << "}"
+
+      return s.join("\n\t")
+    end
+
+    def self.indent_lines(str, indent="\t")
+      str.gsub(/\n/, "\n#{indent}")
+    end
+
   end # Debug
 end # Bixby

data/lib/bixby-common/util/log/logger.rb

@@ -0,0 +1,21 @@
+
+# Patch Logging::Logger so that :trace becomes an inherited flag
+
+module Logging
+  class Logger
+
+    # Override to pass trace flag from parent to child
+    def initialize( name )
+      case name
+      when String
+        raise(ArgumentError, "logger must have a name") if name.empty?
+      else raise(ArgumentError, "logger name must be a String") end
+
+      repo = ::Logging::Repository.instance
+      parent = repo.parent(name)
+      _setup(name, :parent => parent, :trace => parent.trace)
+    end
+
+  end
+end
+

data/lib/bixby-common/util/log.rb

@@ -2,6 +2,7 @@
 require "logging"
 
 require "bixby-common/util/log/filtering_layout"
+require "bixby-common/util/log/logger"
 
 module Bixby
 
@@ -40,7 +41,7 @@ module Bixby
       opts[:level] = :debug if ENV["BIXBY_DEBUG"]
       opts[:level] ||= :warn
 
-      pattern = opts.delete(:pattern) || '%.1l, [%d] %5l -- %c: %m\n'
+      pattern = opts.delete(:pattern) || '%.1l, [%d] %5l -- %c:%L: %m\n'
       layout = Logging.layouts.pattern(:pattern => pattern)
 
       opts[:filename] ||= Bixby.path("var", "bixby-agent.log")
@@ -79,6 +80,7 @@ module Bixby
 
       Logging::Logger.root.add_appenders("file")
       Logging::Logger.root.level = opts[:level]
+      Logging::Logger.root.trace = true
     end
 
   end # Log

data/lib/bixby-common/websocket/api_channel.rb

@@ -36,10 +36,12 @@ module Bixby
       # @param [JsonRequest] json_request
       #
       # @return [String] request id
-      def execute_async(json_request)
+      def execute_async(json_request, &block)
+        logger.debug { "execute_async:\n#{json_request.to_s}" }
+
         request = Request.new(json_request)
         id = request.id
-        @responses[id] = AsyncResponse.new(id)
+        @responses[id] = AsyncResponse.new(id, &block)
 
         EM.next_tick {
           ws.send(request.to_wire)
@@ -67,8 +69,6 @@ module Bixby
 
       # Open
       def open(event)
-        # TODO extract Agent ID, if Agent
-        logger.debug "new channel opened"
         @connected = true
       end
 
@@ -77,7 +77,6 @@ module Bixby
       # Can be fired either due to disconnection or failure to connect
       def close(event)
         if @connected then
-          logger.debug "client disconnected"
           @connected = false
           @handler.new(nil).disconnect(self)
         end
@@ -87,12 +86,14 @@ module Bixby
       #
       # Fired whenever a message is received on the channel
       def message(event)
-        logger.debug "got a message:\n#{event.data}"
         req = Message.from_wire(event.data)
+        logger.debug { "new '#{req.type}' message" }
 
         if req.type == "rpc" then
           # Execute the requested method and return the result
-          json_response = @handler.new(req).handle(req.json_request)
+          json_req = req.json_request
+          logger.debug { json_req.to_s }
+          json_response = @handler.new(req).handle(json_req)
 
           # result = { :type => "rpc_result", :id => req.id, :data => json_response }
           # ws.send(MultiJson.dump(result))
@@ -100,7 +101,9 @@ module Bixby
 
         elsif req.type == "rpc_result" then
           # Pass the result back to the caller
-          @responses[req.id].response = JsonResponse.from_json(req.body)
+          res = req.json_response
+          logger.debug { res.to_s }
+          @responses[req.id].response = res
 
         elsif req.type == "connect" then
           @handler.new(req).connect(req.json_request, self)

data/lib/bixby-common/websocket/async_response.rb

@@ -4,20 +4,30 @@ require 'thread'
 module Bixby
   module WebSocket
 
-    # Asynchronously receive a response via WebSocket channel
+    # Asynchronously receive a response via some channel
     class AsyncResponse
 
       attr_reader :id
 
-      def initialize(id)
+      # Create a new AsyncResponse. Optionally pass a callback block which will
+      # be fired when the response is set.
+      #
+      # @param [String] id
+      #
+      # @yieldparam [JsonResponse] response
+      #
+      # @return [AsyncResponse]
+      def initialize(id, &block)
         @id = id
+        @block = block
         @mutex = Mutex.new
         @cond = ConditionVariable.new
         @response = nil
         @completed = false
       end
 
-      # Set the response and signal any blocking threads
+      # Set the response and signal any blocking threads. Triggers callback, if
+      # one was set.
       #
       # @param [Object] obj       result of request, usually a JsonResponse
       def response=(obj)
@@ -26,6 +36,10 @@ module Bixby
           @response = obj
           @cond.signal
         }
+
+        if not @block.nil? then
+          @block.call(@response)
+        end
       end
 
       # Has the request completed?

data/lib/bixby-common/websocket/message.rb

@@ -42,6 +42,19 @@ module Bixby
         @body
       end
 
+      # Convert object to String, useful for debugging
+      #
+      # @return [String]
+      def to_s # :nocov:
+        s = []
+        s << "#{self.class}:#{self.object_id}"
+        s << "  id:       #{self.id}"
+        s << "  type:     #{self.type}"
+        s << "  headers:  " + Debug.pretty_hash(self.headers)
+        s << "  body:     " + Debug.pretty_hash(MultiJson.load(self.body))
+        s.join("\n")
+      end # :nocov:
+
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bixby-common
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Chetan Sarva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-24 00:00:00.000000000 Z
+date: 2013-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye-websocket
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: api-auth
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: httpi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: httpi
+  name: logging
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: logging
+  name: api-auth
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -396,6 +396,7 @@ files:
 - lib/bixby-common/util/jsonify.rb
 - lib/bixby-common/util/log.rb
 - lib/bixby-common/util/log/filtering_layout.rb
+- lib/bixby-common/util/log/logger.rb
 - lib/bixby-common/websocket/api_channel.rb
 - lib/bixby-common/websocket/async_response.rb
 - lib/bixby-common/websocket/client.rb
@@ -415,7 +416,8 @@ files:
 - test/util/jsonify_test.rb
 - test/util/log_test.rb
 homepage: http://github.com/chetan/bixby-common
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []