gitlab_ci 0.1.3

data/README.md

@@ -0,0 +1,2 @@
+gitlab_ci
+============

data/Rakefile

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler/setup'
+rescue LoadError => e
+  abort e.message
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :test    => :spec
+task :default => :spec

data/gitlab_ci.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gitlab/ci/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "gitlab_ci"
+  gem.version       = GitlabCi::VERSION
+  gem.summary       = %q{Gitlab is a Ruby wrapper and CLI for the GitLab API}
+  gem.description   = %q{Gitlab is a Ruby wrapper and CLI for the [GitLab-CI API](https://gitlab.com/gitlab-org/gitlab-ee/tree/master/doc/ci/api).}
+  gem.license       = "MIT"
+  gem.authors       = ["Christo De Lange"]
+  gem.email         = "rubygems@dldinternet.com"
+  gem.homepage      = "http://github.com/dldinternet/gitlab_ci"
+
+  gem.files         = `git ls-files`.split($/)
+
+  `git submodule --quiet foreach --recursive pwd`.split($/).each do |submodule|
+    submodule.sub!("#{Dir.pwd}/",'')
+
+    Dir.chdir(submodule) do
+      `git ls-files`.split($/).map do |subpath|
+        gem.files << File.join(submodule,subpath)
+      end
+    end
+  end
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'gitlab', '~> 3.6', '>= 3.6.2'
+
+  gem.add_development_dependency 'bundler', '~> 1.10'
+  gem.add_development_dependency 'rake', '~> 10.0'
+  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+end

data/lib/gitlab/ci.rb

@@ -0,0 +1,42 @@
+require 'gitlab/ci/version'
+require 'gitlab'
+require 'terminal-table/import'
+require 'gitlab/configuration'
+require 'gitlab/ci/client'
+
+module Gitlab
+	module CI
+		extend Configuration
+
+		# Alias for Gitlab::Client.new
+		#
+		# @return [Gitlab::Client]
+		def self.client(options={})
+			Gitlab::Client.new(options)
+		end
+
+		# Delegate to Gitlab::Client
+		def self.method_missing(method, *args, &block)
+			return super unless client.respond_to?(method)
+			client.send(method, *args, &block)
+		end
+
+		# Delegate to Gitlab::Client
+		def self.respond_to?(method)
+			client.respond_to?(method) || super
+		end
+
+		# Delegate to HTTParty.http_proxy
+		def self.http_proxy(address=nil, port=nil, username=nil, password=nil)
+			Gitlab::Request.http_proxy(address, port, username, password)
+		end
+
+		# Returns an unsorted array of available client methods.
+		#
+		# @return [Array<Symbol>]
+		def self.actions
+			hidden = /endpoint|private_token|auth_token|user_agent|sudo|get|post|put|\Adelete\z|validate|set_request_defaults|httparty/
+			(Gitlab::CI::Client.instance_methods - Object.methods).reject { |e| e[hidden] }
+		end
+	end
+end

data/lib/gitlab/ci/cli.rb

@@ -0,0 +1,90 @@
+require 'gitlab'
+require 'gitlab/ci/help'
+require 'gitlab/ci/cli_helpers'
+
+module Gitlab
+	module CI
+		class CLI
+			extend Helpers
+
+			# Starts a new CLI session.
+			#
+			# @example
+			#   Gitlab::CLI.start(['help'])
+			#   Gitlab::CLI.start(['help', 'issues'])
+			#
+			# @param [Array] args The command and it's optional arguments.
+			def self.start(args)
+				command = args.shift.strip rescue 'help'
+				run(command, args)
+			end
+
+			# Processes a CLI command and outputs a result to the stream (stdout).
+			#
+			# @example
+			#   Gitlab::CLI.run('help')
+			#   Gitlab::CLI.run('help', ['issues'])
+			#
+			# @param [String] cmd The name of a command.
+			# @param [Array] args The optional arguments for a command.
+			# @return [nil]
+			def self.run(cmd, args=[])
+				case cmd
+				when 'help'
+					puts help(args.shift) { |out| out.gsub!(/Gitlab\./, 'gitlab ') }
+				when 'info'
+					endpoint = Gitlab.endpoint ? Gitlab.endpoint : 'not set'
+					private_token = Gitlab.private_token ? Gitlab.private_token : 'not set'
+					puts "Gitlab endpoint is #{endpoint}"
+					puts "Gitlab private token is #{private_token}"
+					puts "Ruby Version is #{RUBY_VERSION}"
+					puts "Gitlab Ruby Gem #{Gitlab::VERSION}"
+				when '-v', '--version'
+					puts "Gitlab Ruby Gem #{Gitlab::VERSION}"
+				when 'shell'
+					Gitlab::Shell.start
+				else
+					if args.include? '--json'
+						@json_output = true
+						args.delete '--json'
+					end
+
+					unless valid_command?(cmd)
+						puts "Unknown command. Run `gitlab help` for a list of available commands."
+						exit(1)
+					end
+
+					if args.any? && (args.last.start_with?('--only=') || args.last.start_with?('--except='))
+						command_args = args[0..-2]
+					else
+						command_args = args
+					end
+
+					begin
+						command_args.map! { |arg| symbolize_keys(yaml_load(arg)) }
+					rescue => e
+						puts e.message
+						exit 1
+					end
+
+					confirm_command(cmd)
+
+					data = gitlab_helper(cmd, command_args) { exit(1) }
+
+					render_output(cmd, args, data)
+				end
+			end
+
+			# Helper method that checks whether we want to get the output as json
+			# @return [nil]
+			def self.render_output(cmd, args, data)
+				if @json_output
+					output_json(cmd, args, data)
+				else
+					output_table(cmd, args, data)
+				end
+			end
+		end
+
+	end
+end

data/lib/gitlab/ci/cli_helpers.rb

@@ -0,0 +1,50 @@
+require 'yaml'
+require 'json'
+require 'gitlab/cli_helpers'
+
+module Gitlab
+  module CI
+    class CLI
+      # Defines methods related to CLI output and formatting.
+      module Helpers
+        include Gitlab::CLI::Helpers
+        extend Gitlab::CI::CLI::Helpers
+
+        # Returns actions available to CLI & Shell
+        #
+        # @return [Array]
+        def actions
+          @actions ||= Gitlab::CI.actions
+        end
+
+        # Returns Gitlab::Client instance
+        #
+        # @return [Gitlab::Client]
+        def client
+          @client ||= Gitlab::CI::Client.new(endpoint: (Gitlab.endpoint || ''))
+        end
+
+        # Confirms command is valid.
+        #
+        # @return [Boolean]
+        def valid_command?(cmd)
+          command = cmd.is_a?(Symbol) ? cmd : cmd.to_sym
+          Gitlab::CI.actions.include?(command)
+        end
+
+        # Gets defined help for a specific command/action.
+        #
+        # @return [String]
+        def help(cmd=nil, &block)
+          if cmd.nil? || Gitlab::CI::Help.help_map.key?(cmd)
+            Gitlab::CI::Help.actions_table(cmd)
+          else
+            Gitlab::CI::Help.get_help(cmd, &block)
+          end
+        end
+
+      end
+    end
+  end
+
+end

data/lib/gitlab/ci/client.rb

@@ -0,0 +1,13 @@
+module Gitlab
+  module CI
+    # Wrapper for the Gitlab REST API.
+    class Client < API
+      Dir[File.expand_path('../client/*.rb', __FILE__)].each { |f| require f }
+
+			include Gitlab::CI::Client::Builds
+			include Gitlab::CI::Client::Commits
+      include Gitlab::CI::Client::Projects
+			include Gitlab::CI::Client::Runners
+		end
+  end
+end

data/lib/gitlab/ci/client/builds.rb

@@ -0,0 +1,34 @@
+class Gitlab::CI::Client
+  # Defines methods related to builds.
+  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/builds.md
+  module Builds
+    # Runs oldest pending build by runner
+    #
+    # @example
+    #   Gitlab.register_build('7a14d63e4b1af83171f4eb3d4a5246')
+    #
+    # @param  [String] token (required) - The unique token of runner
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def register_build(token)
+      post("/builds/register", body: { token: token })
+    end
+
+    # Update details of an existing build
+    #
+    # @example
+    #   Gitlab.update_build(5)
+    #
+    # @param  [Integer,String] id (required) - The ID of a project
+    # @param  [String] state (optional) - The state of a build
+    # @param  [String] trace (optional) - The trace of a build
+    # @return <Gitlab::ObjectifiedHash]
+    def update_build(id, state=nil, trace=nil)
+      if state or trace
+        put("/builds/#{id}", body: { state: state, trace: trace })
+			else
+				"{}"
+      end
+    end
+
+  end
+end

data/lib/gitlab/ci/client/commits.rb

@@ -0,0 +1,44 @@
+class Gitlab::CI::Client
+  # Defines methods related to repository commits.
+  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/commits.md
+  module Commits
+    # Get list of commits per project
+    #
+    # @example
+    #   Gitlab.commits('viking')
+    #   Gitlab.repo_commits('gitlab', :ref_name => 'api')
+    #
+    # @param  [Integer, String] project_id (required) - The ID of a project
+    # @param  [String] project_token (required) - Project token
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def commits(project, token)
+      get("/commits", body: { project_id: project, project_token: token })
+    end
+
+    # Inform GitLab CI about new commit you want it to build.
+    #
+    # @example
+    #   Gitlab.commit(14, '6104942438c14ec7bd21c6cd5bd995272b3faff6', hash)
+    #   Gitlab.repo_commit(3, 'ed899a2f4b50b4370feeea94676502b42383c746', hash)
+    #
+    # @param  [Integer] project_id (required) - The ID of a project
+    # @param  [Integer] project_token (requires) - Project token
+    # @param  [Hash] data The commit data.
+    # Parameters:
+    #   id (required) - The ID of a project
+    #   sha (required) - The commit hash
+    #   note (required) - Text of comment
+    #   path (optional) - The file path
+    #   line (optional) - The line number
+    #   line_type (optional) - The type of line (new or old)
+    # @return [Gitlab::ObjectifiedHash]
+    def commit(project, token, data)
+      post("/commits", body: data.merge({ project_id: project, project_token: token }))
+    end
+    alias_method :create_commit, :commit
+
+  end
+end

data/lib/gitlab/ci/client/projects.rb

@@ -0,0 +1,98 @@
+class Gitlab::CI::Client
+  # Defines methods related to projects.
+  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/projects.md
+  module Projects
+    # Lists all projects that the authenticated user has access to.
+    #
+    # @example
+    #   Gitlab::CI.projects
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @option options [String] :scope Scope of projects. 'owned' for list of projects owned by the authenticated user, 'all' to get all projects (admin only)
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def projects(options={})
+      if options[:scope]
+        get("/projects/#{options[:scope]}", query: options)
+      else
+        get("/projects", query: options)
+      end
+    end
+
+    # Returns information about a single project for which the user is authorized.
+    #
+    # @example
+    #   Gitlab::CI.project(3)
+    #   Gitlab::CI.project('gitlab')
+    #
+    # @param  [Integer, String] id The ID of the GitLab CI project
+    # @return [Gitlab::ObjectifiedHash]
+    def project(id)
+      get("/projects/#{id}")
+    end
+
+    # Creates a GitLab CI project using GitLab project details.
+    #
+    # @example
+    #   Gitlab::CI.create_project('gitlab')
+    #   Gitlab::CI.create_project('viking', :description => 'Awesome project')
+    #   Gitlab::CI.create_project('Red', :wall_enabled => false)
+    #
+    # @param  [String] name (required) - The name of the project
+    # @param  [String] gitlab_id (required) - The ID of the project on the GitLab instance
+    # @param  [String] default_ref (optional) - The branch to run on (default to master)
+    # @return [Gitlab::ObjectifiedHash] Information about created project.
+    def create_project(name, id, ref='master')
+      url = "/projects"
+      post(url, body: { name: name, gitlab_id: id, default_ref: ref })
+    end
+
+    # Updates a GitLab CI project using GitLab project details that the authenticated user has access to.
+    #
+    # @example
+    #   Gitlab::CI.edit_project(4, "name", "branch")
+    #
+    # @param  [String] name - The name of the project
+    # @param  [String] default_ref - The branch to run on (default to master)
+    # @return [Gitlab::ObjectifiedHash] Information about deleted project.
+    def edit_project(id, name, ref='master')
+      put("/projects/#{id}", body: { name: name, gitlab_id: id, default_ref: ref })
+    end
+
+    # Removes a GitLab CI project that the authenticated user has access to.
+    #
+    # @example
+    #   Gitlab::CI.delete_project(4)
+    #
+    # @param  [Integer, String] id (required) - The ID of the GitLab CI project
+    # @return [Gitlab::ObjectifiedHash] Information about deleted project.
+    def delete_project(id)
+      delete("/projects/#{id}")
+    end
+
+    # Links a runner to a project so that it can make builds (only via authorized user).
+    #
+    # @example
+    #   Gitlab::CI.link_project_to_runner(4,5)
+    #
+    # @param  [Integer, String] id (required) - The ID of the GitLab CI project
+    # @param  [Integer, String] runner_id (required) - The ID of the GitLab CI runner
+    # @return [Gitlab::ObjectifiedHash] Information about deleted project.
+    def link_project_to_runner(id,runner)
+      post("/projects/#{id}/runners/#{runner}", body: { id: id, runner_id: runner })
+    end
+
+    # Removes a runner from a project so that it can not make builds (only via authorized user).
+    #
+    # @example
+    #   Gitlab::CI.remove_project_from_runner(4,5)
+    #
+    # @param  [Integer, String] id (required) - The ID of the GitLab CI project
+    # @param  [Integer, String] runner_id (required) - The ID of the GitLab CI runner
+    # @return [Gitlab::ObjectifiedHash] Information about deleted project.
+    def remove_project_from_runner(id,runner)
+      delete("/projects/#{id}/runners/#{runner}")
+    end
+  end
+end