bixby-client 0.1.1

data/lib/bixby-client/client.rb

@@ -0,0 +1,104 @@
+
+require "curb"
+require "httpi"
+require "api-auth"
+
+module Bixby
+
+  # Implements the Bixby client API
+  class Client
+
+    # Create a new Client
+    #
+    # @param [String] access_key
+    # @param [String] secret_key
+    def initialize(access_key, secret_key)
+      @access_key = access_key
+      @secret_key = secret_key
+    end
+
+    # Execute the given API request on the manager
+    #
+    # @param [String] operation  Name of operation
+    # @param [Array] params  Array of parameters; must ve valid JSON types
+    #
+    # @return [JsonResponse]
+    def exec(op, params)
+      exec_api(JsonRequest.new(op, params))
+    end
+
+    # Execute the given API download request
+    #
+    # @param [String] download_path     Absolute filename to download requested file to
+    # @param [String] operation  Name of operation
+    # @param [Array] params  Array of parameters; must ve valid JSON types
+    #
+    # @return [JsonResponse]
+    def exec_download(download_path, op, params)
+      exec_api_download(JsonRequest.new(op, params), download_path)
+    end
+
+    # Execute the given API request on the manager
+    #
+    # @param [JsonRequest] json_req
+    # @return [JsonResponse]
+    def exec_api(json_req)
+      begin
+        req = sign_request(json_req)
+        res = HTTPI.post(req).body
+        return JsonResponse.from_json(res)
+      rescue Curl::Err::CurlError => ex
+        return JsonResponse.new("fail", ex.message)
+      end
+    end
+
+    # Execute the given API download request
+    #
+    # @param [JsonRequest] json_req     Request to download a file
+    # @param [String] download_path     Absolute filename to download requested file to
+    # @return [JsonResponse]
+    def exec_api_download(json_req, download_path)
+      begin
+        req = sign_request(json_req)
+        File.open(download_path, "w") do |io|
+          req.on_body { |d| io << d; d.length }
+          HTTPI.post(req)
+        end
+        return JsonResponse.new("success")
+      rescue Curl::Err::CurlError => ex
+        return JsonResponse.new("fail", ex.message)
+      end
+    end
+
+
+    private
+
+    # Create a signed request
+    #
+    # @param [JsonRequest] json_req
+    #
+    # @return [HTTPI::Request]
+    def sign_request(json_req)
+      post = json_req.to_json
+      req = HTTPI::Request.new(:url => api_uri, :body => post)
+      req.headers["Content-Type"] = "application/json"
+
+      if crypto_enabled? and not @secret_key.nil? then
+        ApiAuth.sign!(req, @access_key, @secret_key)
+      end
+
+      return req
+    end
+
+    def api_uri
+      URI.join(Bixby.manager_uri, "/api").to_s
+    end
+
+    def crypto_enabled?
+      b = ENV["BIXBY_NOCRYPTO"]
+      !(b and %w{1 true yes}.include? b)
+    end
+
+  end # Client
+
+end # Bixby

data/lib/bixby-client/command.rb

@@ -0,0 +1,36 @@
+
+require "digest"
+require "fileutils"
+
+require "mixlib/shellout"
+
+module Bixby
+class Command
+
+  include Bixby::Log
+  include Bixby::PlatformUtil
+  include Bixby::ScriptUtil
+
+  def initialize()
+  end
+
+  # retrieve all loaded subclasses of this classs
+  #
+  # @return [Array<Class>] List of subclasses
+  def self.subclasses
+    @subclasses
+  end
+
+  private
+
+  def self.inherited(subclass)
+    if superclass.respond_to? :inherited
+      superclass.inherited(subclass)
+    end
+    @subclasses ||= []
+    @subclasses << subclass
+  end
+
+end # Command
+end # Bixby
+

data/lib/bixby-client/modules.rb

@@ -0,0 +1,4 @@
+
+require "bixby-client/modules/inventory"
+require "bixby-client/modules/metrics"
+require "bixby-client/modules/repository"

data/lib/bixby-client/modules/inventory.rb

@@ -0,0 +1,23 @@
+
+module Bixby
+  module Inventory
+
+    # Register an agent with the manager
+    #
+    # @param [String] uuid
+    # @param [String] public_key
+    # @param [String] hostname
+    # @param [FixNum] port
+    # @param [String] tenant      Name of the tenant
+    # @param [String] password    Password for registering an Agent with the server
+    #
+    # @return [JsonResponse]
+    def self.register_agent(uuid, public_key, hostname, port, tenant, password)
+      # TODO these params should probably be a keyed hash instead
+      params = [ uuid, public_key, hostname, port, tenant, password ]
+      req = JsonRequest.new("inventory:register_agent", params)
+      return Bixby::Client.new(nil, nil).exec_api(req)
+    end
+
+  end # Inventory
+end # Bixby

data/lib/bixby-client/modules/metrics.rb

@@ -0,0 +1,43 @@
+
+module Bixby
+  module Metrics
+
+    # Store the results of one or more Checks. Each result may contain multiple metrics.
+    #
+    # Fires the :put_check_result hook on completion, passing results as the only param.
+    #
+    # @param [Array<Hash>] results              An array of results from one or more checks
+    # @option results [Fixnum] :check_id
+    # @option results [String] :key             base key name
+    # @option results [String] :status          OK, WARNING, CRITICAL, UNKNOWN, TIMEOUT
+    # @option results [Fixnum] :timestamp
+    # @option results [Array]  :metrics
+    #   * [Hash] :metrics                       key/value pairs
+    #   * [Hash] :metadata                      key/value pairs
+    # @option results [Array<String>] :errors   list of errors, if any
+    #
+    # @return [void]
+    #
+    # Example input:
+    #
+    #    {
+    #      "status"    => "OK",
+    #      "timestamp" => 1329775841,
+    #      "key"       => "hardware.storage.disk",
+    #      "check_id"  => "77",
+    #      "metrics" => [
+    #        {
+    #          "metrics"  => { "size"=>297, "used"=>202, "free"=>94, "usage"=>69 },
+    #          "metadata" => { "mount"=>"/", "type"=>"hfs" }
+    #        }
+    #      ],
+    #      "errors"=>[]
+    #    }
+    #
+    def self.put_check_result(results)
+      req = JsonRequest.new("metrics:put_check_result", [ results ])
+      return Bixby.client.exec_api(req)
+    end
+
+  end # Metrics
+end # Bixby

data/lib/bixby-client/modules/repository.rb

@@ -0,0 +1,63 @@
+
+module Bixby
+  module Repository
+
+    # Retrieve a file listing for the given Bundle
+    #
+    # @param [CommandSpec] cmd      CommandSpec representing the Bundle to list
+    #
+    # @return [Array<Hash>]
+    #   * file [String] Relative path of file
+    #   * digest [String] SHA256 digest of file
+    def self.list_files(cmd)
+      req = JsonRequest.new("provisioning:list_files", cmd.to_hash)
+      res = Bixby.client.exec_api(req)
+      return res.data
+    end
+
+    # Download athe given list of files
+    #
+    # @param [CommandSpec] cmd    CommandSpec representing the Bundle to which the files belong
+    # @param [Hash] files         Hash, returned from #list_files
+    def self.download_files(cmd, files)
+      return if files.nil? or files.empty?
+
+      local_path = cmd.bundle_dir
+      digest = cmd.load_digest
+      files.each do |f|
+
+        fetch = true
+        if not digest then
+          fetch = true
+        elsif df = digest["files"].find{ |h| h["file"] == f["file"] } then
+          # compare digest w/ stored one if we have it
+          fetch = (df["digest"] != f["digest"])
+        else
+          fetch = true
+        end
+
+        next if not fetch
+
+        params = cmd.to_hash
+        params.delete(:digest)
+
+        filename = File.join(local_path, f['file'])
+        path = File.dirname(filename)
+        if not File.exist? path then
+          FileUtils.mkdir_p(path)
+        end
+
+        req = JsonRequest.new("provisioning:fetch_file", [ params, f['file'] ])
+        Bixby.client.exec_api_download(req, filename)
+        if f['file'] =~ /^bin/ then
+          # correct permissions for executables
+          FileUtils.chmod(0755, filename)
+        end
+      end # files.each
+
+      cmd.update_digest
+    end
+
+
+  end
+end

data/lib/bixby-client/patch/shellout.rb

@@ -0,0 +1,16 @@
+
+require "mixlib/shellout"
+
+module Mixlib
+  class ShellOut
+
+    def success?
+      exitstatus == 0
+    end
+
+    def fail?
+      ! success?
+    end
+
+  end
+end

data/lib/bixby-client/platform_util.rb

@@ -0,0 +1,25 @@
+
+module Bixby
+module PlatformUtil
+
+  def uname
+    RUBY_PLATFORM
+  end
+
+  def osx?
+    uname =~ /darwin/
+  end
+  alias :darwin? :osx?
+  alias :mac? :osx?
+
+  def linux?
+    uname =~ /linux/
+  end
+
+  def win?
+
+  end
+  alias :windows? :win?
+
+end # PlatformUtil
+end # Bixby

data/lib/bixby-client/script.rb

@@ -0,0 +1,18 @@
+
+require "bixby-client"
+require "fileutils"
+require "mixlib/shellout"
+
+Bixby::Log.setup_logger()
+
+class Object
+  include Bixby::PlatformUtil
+  include Bixby::ScriptUtil
+  include Bixby::Log
+
+  # override to create logger based on script name
+  def log
+    @log ||= Logging.logger[File.basename($0)]
+  end
+
+end

data/lib/bixby-client/script_util.rb

@@ -0,0 +1,73 @@
+
+require "bixby-client/patch/shellout"
+
+module Bixby
+
+  module ScriptUtil
+
+    module UseBundle
+
+      # Load the libraries for the given bundle. Searches all available
+      # repositories.
+      def use_bundle(name)
+        repos = Dir.glob(File.join(Bixby.repo_path, "*"))
+        repos.each do |repo|
+          next if not File.directory? repo
+
+          lib = File.join(repo, name, "lib")
+          $: << lib
+          if File.directory? lib then
+            Dir.glob(File.join(lib, "*.rb")).each{ |f| require f }
+          end
+        end
+      end
+    end
+
+    include UseBundle
+
+    # Reads JSON data from STDIN
+    #
+    # @return [Object] data found on STDIN (can be Hash, Array, String, etc)
+    def get_json_input
+      input = read_stdin()
+      input.strip! if input
+      (input.nil? or input.empty?) ? {} : MultiJson.load(input)
+    end
+
+    # Read all available data on STDIN without blocking
+    # (i.e., if no data is available, none will be returned)
+    #
+    # @return [String] data
+    def read_stdin
+      buff = []
+      while true do
+        begin
+          buff << STDIN.read_nonblock(64000)
+        rescue
+          break
+        end
+      end
+      return buff.join('')
+    end
+
+    # Simple wrapper around Mixlib::ShellOut
+    #
+    # @param [Array] args
+    #
+    # @return [Mixlib::ShellOut]
+    def systemu(*args)
+      cmd = Mixlib::ShellOut.new(*args)
+      cmd.run_command
+      cmd
+    end
+
+  end # ScriptUtil
+end # Bixby
+
+module Bixby
+  extend Bixby::ScriptUtil::UseBundle
+end
+
+class Object
+  include Bixby::ScriptUtil::UseBundle
+end

data/tasks/jeweler.rake

@@ -0,0 +1,15 @@
+
+require 'jeweler'
+
+Jeweler::Tasks.new do |gemspec|
+  gemspec.name        = "bixby-client"
+  gemspec.summary     = "Bixby Client"
+  gemspec.description = "Bixby Client"
+  gemspec.email       = "chetan@pixelcop.net"
+  gemspec.homepage    = "http://github.com/chetan/bixby-client"
+  gemspec.authors     = ["Chetan Sarva"]
+
+  gemspec.executables = %w{ bixby }
+
+end
+Jeweler::RubygemsDotOrgTasks.new

data/tasks/test.rake

@@ -0,0 +1,16 @@
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+end
+
+task :default => :test
+
+begin
+  require 'single_test'
+  SingleTest.load_tasks
+
+rescue LoadError
+  warn "single_test not available"
+end