veyor 0.1.0

data/lib/veyor.rb

@@ -0,0 +1,206 @@
+require "veyor/version"
+require "veyor/request"
+require 'veyor/utils'
+require 'rexml/document'
+require 'rexml/xpath'
+
+# @!macro veyor_params
+#   @param account [String] An Appveyor account name
+#   @param project [String] An Appveyor project name
+#   @param verbose [Boolean] Print request headers to stdout. Default: false
+
+# @!macro history_params
+#   @param limit [Fixnum] Records per page
+#   @param start_build [String] Build version to start at
+#   @param branch [String] Branch name
+
+# @!macro veyor_options
+#   @param options [Hash] Hash of options for configuring the request, passed on to Faraday.new
+#     - timeout [Fixnum] open/read timeout Integer in seconds
+#     - open_timeout [Fixnum] read timeout Integer in seconds
+#     - proxy [Hash] hash of proxy options
+#       - uri [String] Proxy Server URI
+#       - user [String] Proxy server username
+#       - password [String] Proxy server password
+#     - params_encoder [Hash] not sure what this is
+#     - bind [Hash] A hash with host and port values
+#     - boundary [String] of the boundary value
+#     - oauth [Hash] A hash with OAuth details
+
+##
+# `Veyor` - The top level module for using methods
+# to access veyor APIs
+#
+# The following methods are provided:
+# * `Veyor.project` - get project by name, branch, or build version
+# * `Veyor.projects` - get all projects
+# * `Veyor.project_history` - get project history
+# * `Veyor.project_deployments` - get project deployments
+# * `Veyor.project_settings` - get project settings
+# * `Veyor.build_start` - start a build
+# * `Veyor.build_cancel` - cancel a build
+#
+# More will be added in future `veyor` versions
+#
+# @see https://www.appVeyor.com/docs/api/ for
+# detailed description of the Appveyor API
+
+module Veyor
+  extend Configuration
+
+  define_setting :account_name, ENV['APPVEYOR_ACCOUNT_NAME']
+  define_setting :account_token, ENV['APPVEYOR_API_TOKEN']
+  define_setting :base_url, "https://ci.appVeyor.com"
+
+  ##
+  # Fetch projects
+  #
+  # @!macro veyor_options
+  # @param verbose [Boolean] Print request headers to stdout. Default: false
+  # @return [Array] An array of hashes
+  #
+  # @example
+  #      require 'veyor'
+  #      Veyor.projects()
+  def self.projects(options: nil, verbose: false)
+    route = prep_route('projects', nil, nil, nil, nil)
+    Request.new(route, nil, nil, options, verbose).get
+  end
+
+  ##
+  # Get a single project - gets the latest build
+  #
+  # @!macro veyor_options
+  # @!macro veyor_params
+  # @param branch [String] Branch name
+  # @param version [String] Project version
+  # @return [Array] An array of hashes
+  #
+  # @example
+  #      require 'veyor'
+  #      # if account_name already set up
+  #      Veyor.project(project: 'cowsay')
+  #
+  #      # if not, or to fetch a project not under your account
+  #      Veyor.project(account: 'sckott', project: 'cowsay')
+  #
+  #      # get by branch
+  #      Veyor.project(project: 'cowsay', branch: 'changeback')
+  #
+  #      # get by version
+  #      Veyor.project(project: 'cowsay', version: '1.0.692')
+  def self.project(account: nil, project: nil, branch: nil,
+    version: nil, options: nil, verbose: false)
+
+    route = prep_route('projects', get_account(account), project, branch, version)
+    Request.new(route, nil, nil, options, verbose).get
+  end
+
+  ##
+  # Get project history
+  #
+  # @!macro veyor_options
+  # @!macro veyor_params
+  # @!macro history_params
+  # @return [Array] An array of hashes
+  #
+  # @example
+  #      require 'veyor'
+  #      # get project history
+  #      x = Veyor.project_history(project: 'cowsay')
+  #      x['builds'].collect { |x| x['status'] }
+  #
+  #      # limit results
+  #      Veyor.project_history(project: 'cowsay', limit: 3)
+  #
+  #      # start by a certain build version
+  #      Veyor.project_history(project: 'cowsay', start_build: 2872582)
+  #
+  #      # get by branch
+  #      Veyor.project_history(project: 'cowsay', branch: 'changeback')
+  def self.project_history(account: nil, project: nil, limit: 10,
+    start_build: nil, branch: nil, options: nil, verbose: false)
+
+    route = sprintf('/projects/%s/%s/history', get_account(account), project)
+    args = prep_args(limit, start_build, branch)
+    Request.new(route, args, nil, options, verbose).get
+  end
+
+  ##
+  # Get project deployments
+  #
+  # @!macro veyor_options
+  # @!macro veyor_params
+  # @return [Array] An array of hashes
+  #
+  # @example
+  #      require 'veyor'
+  #      # get project history
+  #      x = Veyor.project_deployments(project: 'cowsay')
+  #      x['deployments']
+  def self.project_deployments(account: nil, project: nil, options: nil, verbose: false)
+    route = sprintf('/projects/%s/%s/deployments', get_account(account), project)
+    Request.new(route, nil, nil, options, verbose).get
+  end
+
+  ##
+  # Get project settings
+  #
+  # @!macro veyor_options
+  # @!macro veyor_params
+  # @param yaml [Boolean] Return yaml version of project settings. Default: false
+  # @return [Array] An array of hashes
+  #
+  # @example
+  #      require 'veyor'
+  #      # get project history
+  #      x = Veyor.project_settings(project: 'cowsay')
+  #      x['settings']
+  #      x['settings']['configuration']
+  #      # get yaml data
+  #      x = Veyor.project_settings(project: 'cowsay', yaml: true)
+  def self.project_settings(account: nil, project: nil, yaml: false, options: nil, verbose: false)
+    route = sprintf('/projects/%s/%s/settings', get_account(account), project)
+    if yaml
+      route = route + '/yaml'
+    end
+    Request.new(route, nil, nil, options, verbose).get
+  end
+
+  ##
+  # Start build of branch of most recent commit
+  #
+  # @!macro veyor_options
+  # @!macro veyor_params
+  # @param branch [String] Branch name
+  # @return [Array] An array of hashes
+  #
+  # @example
+  #      require 'veyor'
+  #      # start a build
+  #      x = Veyor.build_start(project: 'cowsay')
+  def self.build_start(account: nil, project:, branch: 'master', options: nil, verbose: false)
+    body = { :accountName => get_account(account),
+      :projectSlug => project, :branch => branch }
+    Request.new('builds', nil, body, options, verbose).post
+  end
+
+  ##
+  # Cancel a build
+  #
+  # @!macro veyor_options
+  # @!macro veyor_params
+  # @param version [String] Project version
+  # @return [Array] An array of hashes
+  #
+  # @example
+  #      require 'veyor'
+  #      # start a build
+  #      x = Veyor.build_start(project: 'cowsay')
+  #      x = Veyor.build_cancel(project: 'cowsay', version: '1.0.697')
+  def self.build_cancel(account: nil, project:, version:, options: nil, verbose: false)
+    route = sprintf('/builds/%s/%s/%s', get_account(account), project, version)
+    Request.new(route, nil, nil, options, verbose).delete
+  end
+
+end

data/lib/veyor/error.rb

@@ -0,0 +1,22 @@
+module Veyor
+  # Custom error class for rescuing from all Veyor errors
+  class Error < StandardError; end
+
+  # Raised when Crossref returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when Crossref returns the HTTP status code 404
+  class NotFound < Error; end
+
+  # Raised when Crossref returns the HTTP status code 500
+  class InternalServerError < Error; end
+
+  # Raised when Crossref returns the HTTP status code 502
+  class BadGateway < Error; end
+
+  # Raised when Crossref returns the HTTP status code 503
+  class ServiceUnavailable < Error; end
+
+  # Raised when Crossref returns the HTTP status code 504
+  class GatewayTimeout < Error; end
+end

data/lib/veyor/faraday.rb

@@ -0,0 +1,71 @@
+require 'faraday'
+require 'multi_json'
+
+# @private
+module FaradayMiddleware
+  # @private
+  class RaiseHttpException < Faraday::Middleware
+    def call(env)
+      @app.call(env).on_complete do |response|
+        case response[:status].to_i
+        when 400
+          raise Veyor::BadRequest, error_message_400(response)
+        when 404
+          raise Veyor::NotFound, error_message_400(response)
+        when 500
+          raise Veyor::InternalServerError, error_message_500(response, "Something is technically wrong.")
+        when 502
+          raise Veyor::BadGateway, error_message_500(response, "The server returned an invalid or incomplete response.")
+        when 503
+          raise Veyor::ServiceUnavailable, error_message_500(response, "Crossref is rate limiting your requests.")
+        when 504
+          raise Veyor::GatewayTimeout, error_message_500(response, "504 Gateway Time-out")
+        end
+      end
+    end
+
+    def initialize(app)
+      super app
+      @parser = nil
+    end
+
+    private
+
+    def error_message_400(response)
+      "\n   #{response[:method].to_s.upcase} #{response[:url].to_s}\n   Status #{response[:status]}#{error_body(response[:body])}"
+    end
+
+    def error_body(body)
+      if not body.nil? and not body.empty? and body.kind_of?(String)
+        if is_json?(body)
+          body = ::MultiJson.load(body)
+          if body['message'].nil?
+            body = nil
+          elseif body['message'].length == 1
+            body = body['message']
+          else
+            body = body['message'].collect { |x| x['message'] }.join('; ')
+          end
+        end
+      end
+
+      if body.nil?
+        nil
+      else
+        ": #{body}"
+      end
+    end
+
+    def error_message_500(response, body=nil)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{[response[:status].to_s + ':', body].compact.join(' ')}"
+    end
+
+    def is_json?(string)
+      MultiJson.load(string)
+      return true
+    rescue MultiJson::ParseError => e
+      return false
+    end
+
+  end
+end

data/lib/veyor/helpers/configuration.rb

@@ -0,0 +1,26 @@
+# taken from: https://viget.com/extend/easy-gem-configuration-variables-with-defaults
+module Configuration
+
+  def configuration
+    yield self
+  end
+
+  def define_setting(name, default = nil)
+    class_variable_set("@@#{name}", default)
+    define_class_method "#{name}=" do |value|
+      class_variable_set("@@#{name}", value)
+    end
+    define_class_method name do
+      class_variable_get("@@#{name}")
+    end
+  end
+
+  private
+
+  def define_class_method(name, &block)
+    (class << self; self; end).instance_eval do
+      define_method name, &block
+    end
+  end
+
+end

data/lib/veyor/request.rb

@@ -0,0 +1,105 @@
+require "faraday"
+require 'faraday_middleware'
+require "multi_json"
+
+require 'veyor/faraday'
+require "veyor/error"
+require 'veyor/utils'
+require 'veyor/helpers/configuration'
+
+##
+# veyor::Request
+#
+# Class to perform HTTP requests to the Appveyor API
+module Veyor
+  class Request #:nodoc:
+
+    attr_accessor :route
+    attr_accessor :args
+    attr_accessor :body
+    attr_accessor :options
+    attr_accessor :verbose
+
+    def initialize(route, args, body, options, verbose)
+      self.route   = route
+      self.args    = args
+      self.body    = body
+      self.options = options
+      self.verbose = verbose
+
+      self.perform
+    end
+
+    def get
+      res = _veyor_get(self.route, self.args)
+      return parse_result(res)
+    end
+
+    def post
+      res = _veyor_post(self.route, self.body)
+      return parse_result(res)
+    end
+
+    def delete
+      return _veyor_delete(self.route).status
+    end
+
+    def perform
+      if self.args.nil?
+        self.args = {}
+      end
+
+      if verbose
+        $conn = Faraday.new(:url => Veyor.base_url, :request => options) do |f|
+          f.request :url_encoded
+          f.response :logger
+          f.adapter  Faraday.default_adapter
+          # f.use FaradayMiddleware::RaiseHttpException
+        end
+      else
+        $conn = Faraday.new(:url => Veyor.base_url, :request => options) do |f|
+          f.request :url_encoded
+          f.adapter  Faraday.default_adapter
+          # f.use FaradayMiddleware::RaiseHttpException
+        end
+      end
+
+      $conn.headers[:user_agent] = make_ua
+      $conn.headers["X-USER-AGENT"] = make_ua
+    end
+
+    def _veyor_get(route, opts)
+      $conn.get do |req|
+        req.url '/api/' + route
+        req.params = opts
+        req.headers["Content-Type"] = "application/json"
+        req.headers["Authorization"] = "Bearer " + Veyor.account_token
+      end
+    end
+
+    def _veyor_post(route, body)
+      $conn.post do |req|
+        req.url '/api/' + route
+        req.body = MultiJson.dump(body)
+        req.headers["Content-Type"] = "application/json"
+        req.headers["Authorization"] = "Bearer " + Veyor.account_token
+      end
+    end
+
+    def _veyor_delete(route)
+      $conn.delete do |req|
+        req.url '/api/' + route
+        req.headers["Authorization"] = "Bearer " + Veyor.account_token
+      end
+    end
+
+    def parse_result(z)
+      if z.headers['content-type'].match('json').nil?
+        return z.body
+      else
+        return MultiJson.load(z.body)
+      end
+    end
+
+  end
+end

data/lib/veyor/utils.rb

@@ -0,0 +1,32 @@
+def make_ua
+	requa = 'Faraday/v' + Faraday::VERSION
+  habua = 'Veyor/v' + Veyor::VERSION
+  return requa + ' ' + habua
+end
+
+def prep_args(limit, start_build, branch)
+	args = { recordsNumber: limit, startBuildId: start_build, branch: branch }
+  opts = args.delete_if { |k, v| v.nil? }
+  return opts
+end
+
+def get_account(x)
+	if x.nil?
+	  x = Veyor.account_name
+	  if x.nil?
+	  	raise 'no account name found - one must be supplied'
+	  end
+	end
+	return x
+end
+
+def prep_route(route, account, project, branch, version)
+  if branch.nil? && version.nil?
+    route = sprintf('%s/%s/%s', route, account, project)
+  elsif !branch.nil? && version.nil?
+    route = sprintf('%s/%s/%s/branch/%s', route, account, project, branch)
+  elsif branch.nil? && !version.nil?
+    route = sprintf('%s/%s/%s/build/%s', route, account, project, version)
+  end
+  return route
+end