gitlab-akerl 4.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gitlab.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2012-2015 Nihad Abbasov <mail@narkoz.me>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,192 @@
+## Fork info
+
+This is a fork of the upstream gitlab gem to cut a new release, as the latest upstream release doesn't support Ruby 2.4.0. The only changes I've made:
+
+* Settings Gitlab::VERSION to 4.0.0
+* Updating badge icons to not point to upstream project
+* Set gemspec name to "gitlab-akerl"
+* Added a .prospectus file to track deps
+
+# Gitlab
+
+[![Gem Version](https://img.shields.io/gem/v/basiccache.svg)](https://rubygems.org/gems/basiccache)
+[![Dependency Status](https://img.shields.io/gemnasium/akerl/basiccache.svg)](https://gemnasium.com/akerl/basiccache)
+[![License](https://img.shields.io/badge/license-BSD-green.svg)](https://github.com/akerl/gitlab/blob/master/LICENSE.txt)
+
+[website](http://narkoz.github.io/gitlab) |
+[documentation](http://rubydoc.info/gems/gitlab/frames) |
+[gitlab-live](https://github.com/NARKOZ/gitlab-live)
+
+Gitlab is a Ruby wrapper and CLI for the [GitLab API](https://docs.gitlab.com/ce/api/README.html) for Ruby 2.0+.
+
+## Installation
+
+Install it from rubygems:
+
+```sh
+gem install gitlab
+```
+
+Or add to a Gemfile:
+
+```ruby
+gem 'gitlab'
+# gem 'gitlab', github: 'NARKOZ/gitlab'
+```
+
+## Usage
+
+Configuration example:
+
+```ruby
+Gitlab.configure do |config|
+  config.endpoint       = 'https://example.net/api/v3' # API endpoint URL, default: ENV['GITLAB_API_ENDPOINT']
+  config.private_token  = 'qEsq1pt6HJPaNciie3MG'       # user's private token or OAuth2 access token, default: ENV['GITLAB_API_PRIVATE_TOKEN']
+  # Optional
+  # config.user_agent   = 'Custom User Agent'          # user agent, default: 'Gitlab Ruby Gem [version]'
+  # config.sudo         = 'user'                       # username for sudo mode, default: nil
+end
+```
+
+(Note: If you are using GitLab.com's hosted service, your endpoint will be `https://gitlab.com/api/v3`)
+
+Usage examples:
+
+```ruby
+# set an API endpoint
+Gitlab.endpoint = 'http://example.net/api/v3'
+# => "http://example.net/api/v3"
+
+# set a user private token
+Gitlab.private_token = 'qEsq1pt6HJPaNciie3MG'
+# => "qEsq1pt6HJPaNciie3MG"
+
+# configure a proxy server
+Gitlab.http_proxy('proxyhost', 8888)
+# proxy server w/ basic auth
+Gitlab.http_proxy('proxyhost', 8888, 'proxyuser', 'strongpasswordhere')
+
+# list projects
+Gitlab.projects(per_page: 5)
+# => [#<Gitlab::ObjectifiedHash:0x000000023326e0 @data={"id"=>1, "code"=>"brute", "name"=>"Brute", "description"=>nil, "path"=>"brute", "default_branch"=>nil, "owner"=>#<Gitlab::ObjectifiedHash:0x00000002331600 @data={"id"=>1, "email"=>"john@example.com", "name"=>"John Smith", "blocked"=>false, "created_at"=>"2012-09-17T09:41:56Z"}>, "private"=>true, "issues_enabled"=>true, "merge_requests_enabled"=>true, "wall_enabled"=>true, "wiki_enabled"=>true, "created_at"=>"2012-09-17T09:41:56Z"}>, #<Gitlab::ObjectifiedHash:0x000000023450d8 @data={"id"=>2, "code"=>"mozart", "name"=>"Mozart", "description"=>nil, "path"=>"mozart", "default_branch"=>nil, "owner"=>#<Gitlab::ObjectifiedHash:0x00000002344ca0 @data={"id"=>1, "email"=>"john@example.com", "name"=>"John Smith", "blocked"=>false, "created_at"=>"2012-09-17T09:41:56Z"}>, "private"=>true, "issues_enabled"=>true, "merge_requests_enabled"=>true, "wall_enabled"=>true, "wiki_enabled"=>true, "created_at"=>"2012-09-17T09:41:57Z"}>, #<Gitlab::ObjectifiedHash:0x00000002344958 @data={"id"=>3, "code"=>"gitlab", "name"=>"Gitlab", "description"=>nil, "path"=>"gitlab", "default_branch"=>nil, "owner"=>#<Gitlab::ObjectifiedHash:0x000000023447a0 @data={"id"=>1, "email"=>"john@example.com", "name"=>"John Smith", "blocked"=>false, "created_at"=>"2012-09-17T09:41:56Z"}>, "private"=>true, "issues_enabled"=>true, "merge_requests_enabled"=>true, "wall_enabled"=>true, "wiki_enabled"=>true, "created_at"=>"2012-09-17T09:41:58Z"}>]
+
+# initialize a new client
+g = Gitlab.client(endpoint: 'https://api.example.com', private_token: 'qEsq1pt6HJPaNciie3MG')
+# => #<Gitlab::Client:0x00000001e62408 @endpoint="https://api.example.com", @private_token="qEsq1pt6HJPaNciie3MG", @user_agent="Gitlab Ruby Gem 2.0.0">
+
+# get a user
+user = g.user
+# => #<Gitlab::ObjectifiedHash:0x00000002217990 @data={"id"=>1, "email"=>"john@example.com", "name"=>"John Smith", "bio"=>nil, "skype"=>"", "linkedin"=>"", "twitter"=>"john", "dark_scheme"=>false, "theme_id"=>1, "blocked"=>false, "created_at"=>"2012-09-17T09:41:56Z"}>
+
+# get a user's email
+user.email
+# => "john@example.com"
+
+# set a sudo mode to perform API calls as another user
+Gitlab.sudo = 'other_user'
+# => "other_user"
+
+# disable a sudo mode
+Gitlab.sudo = nil
+# => nil
+
+# a paginated response
+projects = Gitlab.projects(per_page: 5)
+
+# check existence of the next page
+projects.has_next_page?
+
+# retrieve the next page
+projects.next_page
+
+# iterate all projects
+projects.auto_paginate do |project|
+  # do something
+end
+
+# retrieve all projects as an array
+projects.auto_paginate
+```
+
+For more information, refer to [documentation](http://rubydoc.info/gems/gitlab/frames).
+
+## CLI
+
+It is possible to use this gem as a command line interface to gitlab. In order to make that work you need to set a few environment variables:
+```sh
+export GITLAB_API_ENDPOINT=https://gitlab.yourcompany.com/api/v3
+export GITLAB_API_PRIVATE_TOKEN=<your private token from /profile/account>
+# This one is optional and can be used to set any HTTParty option you may need
+# using YAML hash syntax. For example, this is how you would disable SSL
+# verification (useful if using a self-signed cert).
+export GITLAB_API_HTTPARTY_OPTIONS="{verify: false}"
+```
+
+Usage:
+
+When you want to know which CLI commands are supported, take a look at the client [commands implemented in this gem](http://www.rubydoc.info/gems/gitlab/3.4.0/Gitlab/Client). Any of those methods can be called as a command by passing the parameters of the commands as parameters of the CLI.
+
+Usage examples:
+
+```sh
+# list users
+# see: http://www.rubydoc.info/gems/gitlab/3.4.0/Gitlab/Client/Users#users-instance_method
+gitlab users
+
+# get current user
+# see: http://www.rubydoc.info/gems/gitlab/3.4.0/Gitlab/Client/Users#user-instance_method
+gitlab user
+
+# get a user
+# see: http://www.rubydoc.info/gems/gitlab/3.4.0/Gitlab/Client/Users#user-instance_method
+gitlab user 2
+
+# filter output
+gitlab user --only=id,username
+
+gitlab user --except=email,bio
+
+# get a user and render result as json
+gitlab user 2 --json
+
+# passing options hash to a command (use YAML)
+# see: http://www.rubydoc.info/gems/gitlab/3.4.0/Gitlab/Client/MergeRequests#create_merge_request-instance_method
+gitlab create_merge_request 4 "New merge request" "{source_branch: 'new_branch', target_branch: 'master', assignee_id: 42}"
+
+```
+
+## CLI Shell
+
+Usage examples:
+
+```sh
+# start shell session
+gitlab shell
+
+# list available commands
+gitlab> help
+
+# list groups
+gitlab> groups
+
+# protect a branch
+gitlab> protect_branch 1 master
+
+# passing options hash to a command (use YAML)
+gitlab> create_merge_request 4 "New merge request" "{source_branch: 'new_branch', target_branch: 'master', assignee_id: 42}"
+```
+
+Web version is available at https://gitlab-live.herokuapp.com  
+For more information, refer to [website](http://narkoz.github.io/gitlab).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+For more information see [CONTRIBUTING.md](https://github.com/NARKOZ/gitlab/blob/master/CONTRIBUTING.md).
+
+## License
+
+Released under the BSD 2-clause license. See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern    = FileList['spec/**/*_spec.rb']
+  spec.rspec_opts = ['--color', '--format d']
+end
+
+task default: :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+# ENV['GITLAB_API_ENDPOINT'] = ''
+# ENV['GITLAB_API_PRIVATE_TOKEN'] = ''
+
+require 'bundler/setup'
+require 'gitlab'
+require 'pry'
+
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install &&
+  echo 'NOTE: You may need to set GITLAB_API_ENDPOINT and GITLAB_API_PRIVATE_TOKEN environment variables.'

data/exe/gitlab

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'gitlab/cli'
+
+Gitlab::CLI.start(ARGV)

data/gitlab-akerl.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gitlab/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "gitlab-akerl"
+  gem.version       = Gitlab::VERSION
+  gem.authors       = ["Nihad Abbasov"]
+  gem.email         = ["mail@narkoz.me"]
+  gem.description   = %q{Ruby client and CLI for GitLab API}
+  gem.summary       = %q{A Ruby wrapper and CLI for the GitLab API}
+  gem.homepage      = "https://github.com/narkoz/gitlab"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.bindir        = "exe"
+  gem.executables   = gem.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.license       = "BSD"
+
+  gem.required_ruby_version = ">= 2.0.0"
+
+  gem.add_runtime_dependency 'httparty', '~> 0.14.0'
+  gem.add_runtime_dependency 'terminal-table', '1.7.1'
+
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'webmock'
+end

data/lib/gitlab.rb

@@ -0,0 +1,45 @@
+require 'gitlab/version'
+require 'gitlab/objectified_hash'
+require 'gitlab/configuration'
+require 'gitlab/error'
+require 'gitlab/page_links'
+require 'gitlab/paginated_response'
+require 'gitlab/file_response'
+require 'gitlab/request'
+require 'gitlab/api'
+require 'gitlab/client'
+
+module Gitlab
+  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 respond_to_missing?(method_name, include_private = false)
+    client.respond_to?(method_name) || 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::Client.instance_methods - Object.methods).reject { |e| e[hidden] }
+  end
+end

data/lib/gitlab/api.rb

@@ -0,0 +1,19 @@
+module Gitlab
+  # @private
+  class API < Request
+    # @private
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
+    # @private
+    alias_method :auth_token=, :private_token=
+
+    # Creates a new API.
+    # @raise [Error:MissingCredentials]
+    def initialize(options={})
+      options = Gitlab.options.merge(options)
+      (Configuration::VALID_OPTIONS_KEYS + [:auth_token]).each do |key|
+        send("#{key}=", options[key]) if options[key]
+      end
+      set_request_defaults(@sudo)
+    end
+  end
+end

data/lib/gitlab/cli.rb

@@ -0,0 +1,89 @@
+require 'gitlab'
+require 'terminal-table/import'
+require_relative 'cli_helpers'
+require_relative 'shell'
+
+class Gitlab::CLI
+  extend Helpers
+
+  # If set to true, JSON will be rendered as output
+  @render_json = false
+
+  # 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