bixby-common 0.3.16 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53b5ec30f44a5f248d360a13d02bc46881e64f03
+  data.tar.gz: 4ad3d8400f6390ce4630a502e15e4fc9ca5d4507
+SHA512:
+  metadata.gz: db1b6968efb742cf556c6cfdeb4a0836a05869d5088abc126c5360d2e8d8494a209bd261d9bac3b5fdfb18fee17ce775b7d123bdd7a02149bd037970877726ef
+  data.tar.gz: 0ca4ee9520635bc97adea27f4c293b4a4797958a296eaf87d3d9d016618ff43c5db197522e99baf506cec46861001f4f5ec1233cc42787c9d79407084024fb2b

data/Gemfile

@@ -1,5 +1,7 @@
 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"

data/Gemfile.lock

@@ -1,3 +1,10 @@
+GIT
+  remote: https://github.com/chetan/api_auth.git
+  revision: 6d9351de901a51d6a386d547a8d32e23c4314550
+  branch: bixby
+  specs:
+    api-auth (1.0.3)
+
 GIT
   remote: https://github.com/chetan/httpi.git
   revision: f6e49303fee6778c714bcc556fa5f9247bc3a3f3
@@ -8,12 +15,16 @@ GIT
 
 GIT
   remote: https://github.com/chetan/jeweler.git
-  revision: 41062abfc55dc1f5775d6419c796fd1c8756fc7b
+  revision: 9b8b2376c79299b823a5e9aafae3d647df943b6f
   branch: bixby
   specs:
-    jeweler (1.8.4)
+    jeweler (1.8.7)
+      builder
       bundler (~> 1.0)
       git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
       rake
       rdoc
 
@@ -28,14 +39,14 @@ GIT
 
 GIT
   remote: https://github.com/chetan/test_guard.git
-  revision: bbc871053ca91021eea412122035a9427748f8a5
+  revision: 7d069b2d7e46fcbecd7a52966fda7d2d1945e2c9
   specs:
-    test_guard (0.2.0)
+    test_guard (0.2.1)
       awesome_print
       debugger
       debugger-pry
       growl
-      guard
+      listen
       simplecov
       simplecov-console
       single_test
@@ -48,6 +59,7 @@ GEM
     ansi (1.4.3)
     awesome_print (1.1.0)
     bouncy-castle-java (1.5.0147)
+    builder (3.2.2)
     coderay (1.0.9)
     colorize (0.5.8)
     columnize (0.3.6)
@@ -63,24 +75,36 @@ GEM
       debugger (~> 1)
       pry (>= 0.9.9)
     debugger-ruby_core_source (1.2.3)
+    eventmachine (1.0.3)
+    eventmachine (1.0.3-java)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    faye-websocket (0.6.3)
+      eventmachine (>= 0.12.0)
+      websocket-driver (>= 0.2.0)
     ffi (1.9.0)
     ffi (1.9.0-java)
-    formatador (0.2.4)
-    git (1.2.5)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
     growl (1.0.3)
-    guard (1.8.2)
-      formatador (>= 0.2.4)
-      listen (>= 1.0.0)
-      lumberjack (>= 1.0.2)
-      pry (>= 0.9.10)
-      thor (>= 0.14.6)
+    hashie (2.0.5)
+    highline (1.6.19)
     hirb (0.7.1)
+    httpauth (0.2.0)
     httpclient (2.3.4.1)
     jruby-openssl (0.8.8)
       bouncy-castle-java (>= 1.5.0147)
     json (1.8.0)
     json (1.8.0-java)
-    listen (1.2.3)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    listen (1.3.0)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
       rb-kqueue (>= 0.2)
@@ -88,13 +112,23 @@ GEM
     logging (1.8.1)
       little-plugger (>= 1.1.3)
       multi_json (>= 1.3.6)
-    lumberjack (1.0.4)
     metaclass (0.0.1)
     method_source (0.8.2)
     minitest (4.7.5)
     mocha (0.14.0)
       metaclass (~> 0.0.1)
     multi_json (1.7.9)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    nokogiri (1.5.10-java)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
     oj (2.1.4)
     pry (0.9.12.2)
       coderay (~> 1.0.5)
@@ -123,18 +157,19 @@ GEM
       hirb
       simplecov
     simplecov-html (0.7.1)
-    single_test (0.5.2)
-      rake (> 0.9)
+    single_test (0.6.0)
+      rake
     slop (3.4.6)
     spoon (0.0.4)
       ffi
     test-unit (2.5.5)
-    thor (0.18.1)
     turn (0.9.6)
       ansi
     webmock (1.13.0)
       addressable (>= 2.2.7)
       crack (>= 0.3.2)
+    websocket-driver (0.2.3)
+    websocket-driver (0.2.3-java)
     yard (0.8.7)
 
 PLATFORMS
@@ -142,8 +177,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  api-auth!
   bundler (~> 1.1)
   curb
+  faye-websocket
   httpclient
   httpi!
   jeweler!

data/Rakefile

@@ -47,8 +47,7 @@ end
 task :default => :test
 
 begin
-  require 'single_test'
-  SingleTest.load_tasks
+  require 'single_test/tasks'
 
 rescue LoadError
   warn "single_test not available"

data/VERSION

@@ -1 +1 @@
-0.3.16
+0.4.0

data/bixby-common.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "bixby-common"
-  s.version = "0.3.16"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chetan Sarva"]
-  s.date = "2013-08-13"
+  s.date = "2013-08-24"
   s.description = "Bixby Common files/libs"
   s.email = "chetan@pixelcop.net"
   s.extra_rdoc_files = [
@@ -24,8 +24,13 @@ Gem::Specification.new do |s|
     "VERSION",
     "bixby-common.gemspec",
     "lib/bixby-common.rb",
+    "lib/bixby-common/api/api_channel.rb",
+    "lib/bixby-common/api/encrypted_json_request.rb",
+    "lib/bixby-common/api/http_channel.rb",
     "lib/bixby-common/api/json_request.rb",
     "lib/bixby-common/api/json_response.rb",
+    "lib/bixby-common/api/rpc_handler.rb",
+    "lib/bixby-common/api/signed_json_request.rb",
     "lib/bixby-common/bixby.rb",
     "lib/bixby-common/command_response.rb",
     "lib/bixby-common/command_spec.rb",
@@ -40,6 +45,12 @@ 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/websocket/api_channel.rb",
+    "lib/bixby-common/websocket/async_response.rb",
+    "lib/bixby-common/websocket/client.rb",
+    "lib/bixby-common/websocket/message.rb",
+    "lib/bixby-common/websocket/request.rb",
+    "lib/bixby-common/websocket/response.rb",
     "test/bixby_common_test.rb",
     "test/command_response_test.rb",
     "test/command_spec_test.rb",
@@ -55,13 +66,15 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/chetan/bixby-common"
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.25"
+  s.rubygems_version = "2.0.3"
   s.summary = "Bixby Common"
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     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"])
@@ -86,6 +99,8 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<curb>, [">= 0"])
       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"])
@@ -111,6 +126,8 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<jruby-openssl>, [">= 0"])
     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"])

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

@@ -0,0 +1,20 @@
+
+module Bixby
+
+  class APIChannel
+
+    include Bixby::Log
+    extend  Bixby::Log
+
+    # Execute the given request
+    #
+    # @param [JsonRequest] json_request
+    #
+    # @return [JsonResponse] response
+    def execute(json_request)
+      raise NotImplementedError
+    end
+
+  end
+
+end

data/lib/bixby-common/api/encrypted_json_request.rb

@@ -0,0 +1,19 @@
+
+module Bixby
+  class EncryptedJsonRequest < JsonRequest
+
+    def initialize(json_request, private_key, public_key, uuid="master")
+      self.operation = json_request.operation
+      self.params = json_request.params
+
+      # encrypt
+      data = json_request.to_json
+      @body = Bixby::CryptoUtil.encrypt(data, uuid, public_key, private_key)
+    end
+
+    def to_wire
+      @body
+    end
+
+  end
+end

data/lib/bixby-common/api/http_channel.rb

@@ -0,0 +1,72 @@
+
+module Bixby
+
+  class HttpChannel < Bixby::APIChannel
+
+    def initialize(uri)
+      @uri = uri
+    end
+
+    # Execute the given request
+    #
+    # @param [JsonRequest] json_request
+    #
+    # @return [JsonResponse] response
+    def execute(json_request)
+      execute_internal(json_request)
+    end
+
+
+    # Execute a download request
+    # NOTE: This method is only available on the HTTP Channel.
+    #
+    # @param [JsonRequest] json_request
+    # @param [Block] block
+    #
+    # @return [JsonResponse] response
+    def execute_download(json_request, &block)
+      execute_internal(json_request, &block)
+    end
+
+
+    private
+
+    # Execute the request, optionally passing a block to handle the response
+    #
+    # @param [JsonRequest] json_request
+    # @param [Block] block
+    #
+    # @return [JsonResponse] response
+    def execute_internal(json_request, &block)
+
+      req = HTTPI::Request.new(:url => @uri, :body => json_request.to_wire)
+
+      # add in extra headers if we have a SignedJsonRequest (or anything which has additional headers)
+      if json_request.respond_to? :headers then
+        req.headers.merge!(json_request.headers)
+      end
+
+      if not req.headers.include? "Content-Type" then
+        # add content-type if not set
+        # may be set when creating a signed request
+        req.headers["Content-Type"] = "application/json"
+      end
+
+      if block then
+        # execute request with block
+        req.on_body(&block)
+        HTTPI.post(req)
+        return JsonResponse.new("success")
+
+      else
+        # execute normal req, and return parsed response
+        res = HTTPI.post(req).body
+        return JsonResponse.from_json(res)
+      end
+
+
+    end
+
+
+  end
+end

data/lib/bixby-common/api/json_request.rb

@@ -32,5 +32,9 @@ class JsonRequest
     s.join("\n")
   end # :nocov:
 
+  def to_wire
+    MultiJson.dump(self)
+  end
+
 end # JsonRequest
 end # Bixby

data/lib/bixby-common/api/json_response.rb

@@ -78,6 +78,10 @@ class JsonResponse
     s.join("\n")
   end # :nocov:
 
+  def to_wire
+    MultiJson.dump(self)
+  end
+
 end # JsonResponse
 
 end # Bixby

data/lib/bixby-common/api/rpc_handler.rb

@@ -0,0 +1,35 @@
+
+module Bixby
+  class RpcHandler
+
+    # Handle a request
+    #
+    # @param [JsonRequest] request
+    #
+    # @return [JsonResponse] response
+    def handle(request)
+      raise NotImplementedError
+    end
+
+    # Channel connect event
+    #
+    # NOTE: only used by WebSocket channels and generally only implemented by
+    #       the server-side.
+    #
+    # @param [Bixby::JsonRequest] json_req
+    # @param [Bixby::APIChannel] api
+    def connect(json_req, api)
+      # no-op
+    end
+
+    # Channel disconnection event
+    # NOTE: only used by WebSocket channels and generally only implemented by
+    #       the server-side.
+    #
+    # @param [Bixby::APIChannel] api
+    def disconnect(api)
+      # no-op
+    end
+
+  end
+end

data/lib/bixby-common/api/signed_json_request.rb

@@ -0,0 +1,38 @@
+
+module Bixby
+  class SignedJsonRequest < JsonRequest
+
+    attr_accessor :headers
+
+    def initialize(json_request, access_key=nil, secret_key=nil)
+      @operation = json_request.operation
+      @params = json_request.params
+      @access_key = access_key
+      @secret_key = secret_key
+      @headers = {}
+    end
+
+    # api-auth requires a path
+    def path
+      "/api"
+    end
+
+    def body=(str)
+      @body = str
+    end
+
+    def body
+      if @body.nil? then
+        hash = { :operation => operation, :params => params }
+        @body = MultiJson.dump(hash)
+      end
+      return @body
+    end
+
+    def to_wire
+      ApiAuth.sign!(self, @access_key, @secret_key)
+      body
+    end
+
+  end
+end

data/lib/bixby-common/command_spec.rb

@@ -14,7 +14,7 @@ class CommandSpec
 
   # Create new CommandSpec
   #
-  # @params [Hash] params  Hash of attributes to initialize with
+  # @param [Hash] params  Hash of attributes to initialize with
   def initialize(params = nil)
     return if params.nil? or params.empty?
     params.each{ |k,v| self.send("#{k}=", v) if self.respond_to? "#{k}=" }

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

@@ -46,6 +46,27 @@ module Bixby
       opts[:filename] ||= Bixby.path("var", "bixby-agent.log")
       FileUtils.mkdir_p(File.dirname(opts[:filename]))
 
+      # configure stdout appender (used in debug modes, etc)
+      Logging.color_scheme( 'bright',
+        :levels => {
+          :info  => :green,
+          :warn  => :yellow,
+          :error => :red,
+          :fatal => [:white, :on_red]
+        },
+        :date => :blue,
+        :logger => :cyan,
+        :message => :magenta
+      )
+      Logging.appenders.stdout( 'stdout',
+        :auto_flushing => true,
+        :layout => Logging.layouts.pattern(
+          :pattern => pattern,
+          :color_scheme => 'bright'
+        )
+      )
+
+      # configure rolling file appender
       options = {
         :keep          => 7,
         :roll_by       => 'date',
@@ -54,7 +75,6 @@ module Bixby
         :auto_flushing => true,
         :layout        => layout
       }.merge(opts)
-
       Logging.appenders.rolling_file("file", options)
 
       Logging::Logger.root.add_appenders("file")

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

@@ -0,0 +1,114 @@
+
+require "bixby-common/websocket/async_response"
+require "api-auth"
+
+module Bixby
+  module WebSocket
+
+    # WebSocket API channel
+    #
+    # Implements a simple request/response interface over a WebSocket channel.
+    # Requests can be sent in either direction, in a sync or async manner.
+    class APIChannel < Bixby::APIChannel
+
+      attr_reader :ws
+
+      def initialize(ws, handler)
+        @ws = ws
+        @handler = handler
+        @responses = {}
+        @connected = false
+      end
+
+      # Perform RPC
+
+      # Execute the given request (synchronously)
+      #
+      # @param [JsonRequest] json_request
+      #
+      # @return [JsonResponse] response
+      def execute(json_request)
+        fetch_response( execute_async(json_request) )
+      end
+
+      # Execute the given request (asynchronously)
+      #
+      # @param [JsonRequest] json_request
+      #
+      # @return [String] request id
+      def execute_async(json_request)
+        request = Request.new(json_request)
+        id = request.id
+        @responses[id] = AsyncResponse.new(id)
+
+        EM.next_tick {
+          ws.send(request.to_wire)
+        }
+        id
+      end
+
+      # Fetch the response for the given request
+      #
+      # @param [String] request id
+      #
+      # @return [JsonResponse]
+      def fetch_response(id)
+        res = @responses[id].response
+        @responses.delete(id)
+        res
+      end
+
+
+      # Handle channel events
+
+      def connected?
+        @connected
+      end
+
+      # Open
+      def open(event)
+        # TODO extract Agent ID, if Agent
+        logger.debug "new channel opened"
+        @connected = true
+      end
+
+      # Close
+      #
+      # 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
+      end
+
+      # Message
+      #
+      # 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)
+
+        if req.type == "rpc" then
+          # Execute the requested method and return the result
+          json_response = @handler.new(req).handle(req.json_request)
+
+          # result = { :type => "rpc_result", :id => req.id, :data => json_response }
+          # ws.send(MultiJson.dump(result))
+          ws.send(Response.new(json_response, req.id).to_wire)
+
+        elsif req.type == "rpc_result" then
+          # Pass the result back to the caller
+          @responses[req.id].response = JsonResponse.from_json(req.body)
+
+        elsif req.type == "connect" then
+          @handler.new(req).connect(req.json_request, self)
+
+        end
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,50 @@
+
+require 'thread'
+
+module Bixby
+  module WebSocket
+
+    # Asynchronously receive a response via WebSocket channel
+    class AsyncResponse
+
+      attr_reader :id
+
+      def initialize(id)
+        @id = id
+        @mutex = Mutex.new
+        @cond = ConditionVariable.new
+        @response = nil
+        @completed = false
+      end
+
+      # Set the response and signal any blocking threads
+      #
+      # @param [Object] obj       result of request, usually a JsonResponse
+      def response=(obj)
+        @mutex.synchronize {
+          @completed = true
+          @response = obj
+          @cond.signal
+        }
+      end
+
+      # Has the request completed?
+      #
+      # @return [Boolean] true if completed
+      def completed?
+        @completed
+      end
+
+      # Retrieve the response, blocking until it is available
+      #
+      # @return [Object] response data
+      def response
+        return @response if @completed
+        @mutex.synchronize { @cond.wait(@mutex) }
+        return @response
+      end
+
+    end
+
+  end
+end