xcskarel 0.0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc917e748937343f867741161f46519d733738b7
-  data.tar.gz: f328fc4bebedbbd58a5efc57c849e3cb7d2bd256
+  metadata.gz: 8554a8191907bcc3d6b14bde66f344d3d6e9bf2c
+  data.tar.gz: 132b062bb5c4ee7259cb4052cdf011160cc7af03
 SHA512:
-  metadata.gz: 060b26ec640e74de1bc6dbea08c6b62cb9d4d38451dadedad82d4acef05be5a6d136bc221df150c4ffba9b5594ba3d96209dd29656776b384ca841bed9627ca0
-  data.tar.gz: f1bb9596366e72848d97f833da51a380b9a8e422d092249fc3a5d7aaf0673f7b541089aa16033044faedf1797b144db77d3853853eedaea5037fc172a7c4cec1
+  metadata.gz: a0a88b3aec7d56c1ceac71cf936941a3f67a43362f9ac7090e230e69f7ab9dec3208c9ed323b194fc7beef611901881ae7d0732044983376f6adf8c0ec6e18ed
+  data.tar.gz: 40936af2da7f3212bb3fe90b7d6206d765038cefa503b603df63932b1799188878ea506653bbbaf15c95a19e022dd7f8606b9fd988c1e48c4afd3795944c647c

data/bin/xcskarel

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
+
+require 'xcskarel'
+require 'rubygems'
+require 'commander'
+
+XCSKarel.set_no_log(true)
+
+class XCSKarelApplication
+  include Commander::Methods
+
+  def add_xcs_options(c)
+    c.option '--host Hostname', '(required) Xcode Server\'s hostname or IP address'
+    c.option '--user Username', 'Xcode Server username'
+    c.option '--pass Password', 'Xcode Server password'
+  end
+
+  def create_server_from_options(options)
+    raise "No hostname was specified, please see `xcskarel --help`" unless options.host
+    XCSKarel::Server.new(options.host, options.user, options.pass)
+  end
+
+  def run
+    program :name, 'xcskarel'
+    program :version, XCSKarel::VERSION
+    program :description, 'Tool for managing your Xcode Server & Bot configurations'
+    program :help, 'Author', 'Honza Dvorsky <http://honzadvorsky.com>'
+    program :help, 'GitHub', 'https://github.com/czechboy0/xcskarel'
+
+    global_option('--verbose', 'Print internal logs') { XCSKarel.set_no_log(false) }
+    global_option('--no_pretty', 'Disables output JSON prettification')
+    global_option('--no_filter', 'Prints full JSON payload for objects instead of just filtering the important ones')
+
+    command :bots do |c|
+      c.syntax = 'xcskarel bots [options]'
+      c.description = 'Fetches all Bots found on the specified server'
+      c.example 'get all bot names & identifiers', 'xcskarel bots --hostname 127.0.0.1'
+      c.example 'get all bot metadata', 'xcskarel bots --no_filter --hostname 127.0.0.1'
+      add_xcs_options(c)
+      c.action do |args, options|
+        server = create_server_from_options(options)
+        all_bots = server.get_bots
+        unless options.no_filter
+          all_bots = XCSKarel.filter_array(all_bots, ['name', '_id'])
+        end
+        out = options.no_pretty ? JSON.generate(all_bots) : JSON.pretty_generate(all_bots)
+        puts out
+      end
+    end
+
+    command :integrations do |c|
+      c.syntax = 'xcskarel integrations [options]'
+      c.description = 'Fetches all Integrations for a specified Bot identifier'
+      c.example 'get all integration identifiers, numbers & results', 'xcskarel integrations --bot BOT_ID --hostname 127.0.0.1'
+      add_xcs_options(c)
+      c.option '--bot BOT_ID', '(required) Bot identifier'
+      c.action do |args, options|
+        raise "No Bot id was specified, please see `xcskarel integrations --help`" unless options.bot
+        server = create_server_from_options(options)
+        all_integrations = server.get_integrations(options.bot)
+        unless options.no_filter
+          all_integrations = XCSKarel.filter_array(all_integrations, ['number', '_id', 'currentStep', 'result'])
+        end
+        out = options.no_pretty ? JSON.generate(all_integrations) : JSON.pretty_generate(all_integrations)
+        puts out
+      end
+    end
+
+    run!
+  end
+end
+
+XCSKarelApplication.new.run
+
+
+
+

data/lib/karel/filter.rb

@@ -0,0 +1,28 @@
+
+require 'set'
+
+module XCSKarel
+  # returns a copy of the passed-in hash with only the provided keypaths kept
+  # e.g. "name" will keep the key "name" at the top level.
+  # TODO: support even nested keypaths
+  def self.filter_key_paths(hash, key_paths)
+    new_hash = Hash.new
+    keys = Set.new(key_paths)
+    hash.each do |k,v|
+      if keys.member?(k)
+        new_hash[k] = v
+      end
+    end
+    return new_hash
+  end
+
+  # filters each element
+  def self.filter_array(array, key_paths)
+    new_array = Array.new
+    keys = Set.new(key_paths)
+    array.each do |i|
+      new_array << filter_key_paths(i, key_paths)
+    end
+    return new_array
+  end
+end

data/lib/karel/log.rb

@@ -0,0 +1,40 @@
+require 'logger'
+require 'colored'
+
+module XCSKarel
+
+  @@NO_LOG = false
+
+  def self.set_no_log(no_log)
+    @@NO_LOG = no_log
+  end
+
+  def self.log
+
+    @@log ||= Logger.new($stdout)
+
+    @@log.formatter = proc do |severity, datetime, progname, msg|
+
+      unless @@NO_LOG
+        string = "#{severity} [#{datetime.strftime('%Y-%m-%d %H:%M:%S.%2N')}]: "
+        second = "#{msg}\n"
+
+        if severity == "DEBUG"
+          string = string.magenta
+        elsif severity == "INFO"
+          string = string.white
+        elsif severity == "WARN"
+          string = string.yellow
+        elsif severity == "ERROR"
+          string = string.red
+        elsif severity == "FATAL"
+          string = string.red.bold
+        end
+
+        [string, second].join("")
+      end
+      
+    end
+    @@log
+  end
+end

data/lib/karel/server.rb

@@ -0,0 +1,90 @@
+require 'excon'
+require 'pry'
+require 'karel/log'
+require 'json'
+require 'base64'
+
+module XCSKarel
+
+  class Server
+
+    attr_reader :host
+    attr_reader :user
+    attr_reader :pass
+    attr_reader :port
+
+    def initialize(host, user=nil, pass=nil, allow_self_signed=true)
+      @port = 20343
+      @host = validate_host(host)
+      @user = user
+      @pass = pass
+      validate_connection(allow_self_signed)
+    end
+
+    def get_bots
+      response = get_endpoint('/bots')
+      raise "You are unauthorized to access data on #{@host}, please check that you're passing in a correct username and password.".red if response.status == 401
+      raise "Failed to fetch Bots from Xcode Server at #{@host}, response: #{response.status}: #{response.body}.".red if response.status != 200
+      JSON.parse(response.body)['results']
+    end
+
+    def get_integrations(bot_id)
+      response = get_endpoint("/bots/#{bot_id}/integrations?limit=10")
+      raise "Failed to fetch Integrations for Bot #{bot_id} from Xcode Server at #{@host}, response: #{response.status}: #{response.body}".red if response.status != 200
+      JSON.parse(response.body)['results']
+    end
+
+    def headers
+      headers = {
+        'user-agent' => 'xcskarel', # XCS wants user agent. for some API calls. not for others. sigh.
+        'X-XCSAPIVersion' => 6 # XCS API version with this API, currently 6 with Xcode 7 Beta 6.
+      }
+
+      if @user && @pass
+        userpass = "#{@user}:#{@pass}"
+        headers['Authorization'] = "Basic #{Base64.strict_encode64(userpass)}"
+      end
+
+      return headers
+    end
+
+    def get_endpoint(endpoint)
+      url = url_for_endpoint(endpoint)
+      headers = self.headers || {}
+      response = Excon.get(url, :headers => headers)
+      XCSKarel.log.debug "GET endpoint #{endpoint} => #{url} => Response #{response.data[:status_line].gsub("\n", "")}"
+      return response
+    end
+
+    private
+
+    def url_for_endpoint(endpoint)
+      "#{@host}:#{@port}/api#{endpoint}"
+    end
+
+    def validate_host(host)
+      comps = host.split(":")
+      raise "Scheme must be unspecified or https, nothing else" if comps.count > 1 && comps[0] != 'https'
+      host_with_https = comps.count > 1 ? host : "https://#{host}"
+      return host_with_https
+    end
+
+    def validate_connection(allow_self_signed)
+
+      # check for allowing self-signed certs
+      Excon.defaults[:ssl_verify_peer] = !allow_self_signed
+
+      # TODO: logout/login to validate user/pass
+
+      # try to connect to the host
+      begin
+        response = get_endpoint("/ping")
+      rescue Exception => e
+        raise "Failed to validate - #{e}.\nPlease make sure your Xcode Server is up and running at #{host}".red
+      else
+        raise "Failed to validate - Endpoint at \"#{url}\" responded with #{response.data[:status_line]}".red if response.status != 204
+        XCSKarel.log.info "Validation of host #{@host} succeeded.".green
+      end
+    end
+  end
+end

data/lib/karel/version.rb

@@ -0,0 +1,3 @@
+module XCSKarel
+  VERSION = '0.2'
+end

data/lib/xcskarel.rb

@@ -1,6 +1,5 @@
 
-class XCSKarel
-	def self.hi
-		puts "Hello"
-	end
-end
+require 'karel/server'
+require 'karel/version'
+require 'karel/log'
+require 'karel/filter'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xcskarel
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: '0.2'
 platform: ruby
 authors:
 - Honza Dvorsky
@@ -9,15 +9,120 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2015-08-26 00:00:00.000000000 Z
-dependencies: []
-description: Tool for managing your Xcode Bot configurations
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.45.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.45.4
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.3.5
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Tool for managing your Xcode Server & Bot configurations from the command
+  line
 email: http://honzadvorsky.com
-executables: []
+executables:
+- xcskarel
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/xcskarel
+- lib/karel/filter.rb
+- lib/karel/log.rb
+- lib/karel/server.rb
+- lib/karel/version.rb
 - lib/xcskarel.rb
-homepage: http://rubygems.org/gems/xcskarel
+homepage: http://github.com/czechboy0/xcskarel
 licenses:
 - MIT
 metadata: {}
@@ -29,7 +134,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -40,6 +145,6 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Manage Xcode Bot configurations
+summary: Manage your Xcode Server & Bots from the command line
 test_files: []
 has_rdoc: