gitlab 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bfad0b28f61c172f39cceece1d908d7bbd6a339dfd94bde1fd2fd91894947c4
-  data.tar.gz: 991192468932b419e0f7512ac0034a942a994fe09ab66372f195332e81fbc639
+  metadata.gz: 30a94ccf69dc023d9f587a3435ef3bfef5f26a7899016d259533aa6172238753
+  data.tar.gz: 2fd9974e617d7d1112739a299171f3a366c6d73a1fa77ed3b5c4aa62bcf80a72
 SHA512:
-  metadata.gz: 6c769c30e5072d68696fe7cc75747744aa6ff28a232f7084eb96cc78dbe4853a213d456a95d3a635197ef4a9473ddfd5fd7379654a6a1811c6b74b87f6c62a37
-  data.tar.gz: 48292a8b7dafad7fbaf577bcff3065b97beeb47610e68d513544f66f48881b0bd291cfa5110835a52d177927a6ee8a4acc8b0d8bb48d0b595951bc1a2b1032d8
+  metadata.gz: b3652cd0cda7d3d598b157dedb520f95fe5a49f04d9b1fdf0def379aadf4823e314c174ab25728185e57d4ea10e847327176dadc943c908837bddce411aa118f
+  data.tar.gz: 2744fa91f5066133130316451c01a7f0e9c03f2209fd4fa861f7cd005a8533c6aff6fe13b433c2adf7a310f1c911e2aa87d1f52395272286198025223fa2dd71

data/.dockerignore

@@ -0,0 +1,6 @@
+.git
+Gemfile.lock
+Dockerfile
+docker-compose.yml
+*.gem
+deploy

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
-  - 2.2
   - 2.3
   - 2.4
+  - 2.5
 before_install: gem update bundler
 
 matrix:

data/Dockerfile

@@ -0,0 +1,8 @@
+FROM ruby:2.5
+
+WORKDIR /app
+
+COPY . ./
+RUN bundle install
+
+CMD ["bin/console"]

data/README.md

@@ -28,6 +28,12 @@ gem 'gitlab'
 # gem 'gitlab', github: 'NARKOZ/gitlab'
 ```
 
+Mac OS users can install using Homebrew:
+
+```sh
+brew install gitlab-gem
+```
+
 ## Usage
 
 Configuration example:
@@ -175,6 +181,64 @@ For more information, refer to [website](http://narkoz.github.io/gitlab).
 
 ## Development
 
+### With a dockerized Gitlab instance
+
+```shell
+docker-compose up -d gitlab # Will start the gitlab instance in the background (approx. 3 minutes)
+```
+
+After a while, your Gitlab instance will be accessible on http://localhost:3000.
+
+Once you have set your new root password, you can login with the root user.
+
+You can now setup a personal access token here: http://localhost:3000/profile/personal_access_tokens
+
+Once you have your token, set the variables to the correct values in the `docker.env` file.
+
+Then, launch the tool:
+
+```shell
+docker-compose run app
+```
+
+```ruby
+Gitlab.users
+=> [#<Gitlab::ObjectifiedHash:47231290771040 {hash: {"id"=>1, "name"=>"Administrator", "username"=>"root", ...]
+```
+
+To launch the specs,
+
+```shell
+docker-compose run app rake spec
+```
+
+#### Want to use Gitlab Enterprise?
+
+Just change the image from `gitlab/gitlab-ce:latest` to `gitlab/gitlab-ee:latest` in the `docker-compose.yml` file.
+
+### With an external Gitlab instance
+
+First, set the variables to the correct values in the `docker.env` file.
+
+Then, launch the tool:
+
+```shell
+docker-compose run app
+```
+
+```ruby
+Gitlab.users
+=> [#<Gitlab::ObjectifiedHash:47231290771040 {hash: {"id"=>1, "name"=>"Administrator", "username"=>"root", ...]
+```
+
+To launch the specs,
+
+```shell
+docker-compose run app rake spec
+```
+
+### Without Docker
+
 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.

data/docker-compose.yml

@@ -0,0 +1,19 @@
+# For more information, see https://docs.gitlab.com/omnibus/docker/README.html#install-gitlab-using-docker-compose
+version: '3'
+services:
+  app:
+    build: .
+    volumes:
+      - ./:/app
+    env_file: docker.env
+
+  gitlab:
+    image: 'gitlab/gitlab-ce:latest'
+    restart: always
+    hostname: 'gitlab.example.com'
+    environment:
+      GITLAB_OMNIBUS_CONFIG: |
+        external_url 'http://gitlab.example.com:3000'
+        # Add any other gitlab.rb configuration here, each on its own line
+    ports:
+      - 3000:3000

data/docker.env

@@ -0,0 +1,2 @@
+GITLAB_API_ENDPOINT=http://gitlab:3000/api/v4
+GITLAB_API_PRIVATE_TOKEN=j3CLYZMg_dsTPpCR2HWf

data/gitlab.gemspec

@@ -5,8 +5,8 @@ require 'gitlab/version'
 Gem::Specification.new do |gem|
   gem.name          = 'gitlab'
   gem.version       = Gitlab::VERSION
-  gem.authors       = ['Nihad Abbasov']
-  gem.email         = ['mail@narkoz.me']
+  gem.authors       = ['Nihad Abbasov', 'Sean Edge']
+  gem.email         = ['mail@narkoz.me', 'asedge@gmail.com']
   gem.description   = 'Ruby client and CLI for GitLab API'
   gem.summary       = 'A Ruby wrapper and CLI for the GitLab API'
   gem.homepage      = 'https://github.com/narkoz/gitlab'
@@ -20,8 +20,8 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = '>= 2.0.0'
 
-  gem.add_runtime_dependency 'httparty'
-  gem.add_runtime_dependency 'terminal-table'
+  gem.add_runtime_dependency 'httparty', '>= 0.14.0'
+  gem.add_runtime_dependency 'terminal-table', '>= 1.5.1'
 
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'rake'

data/lib/gitlab/client.rb

@@ -4,6 +4,7 @@ module Gitlab
     Dir[File.expand_path('../client/*.rb', __FILE__)].each { |f| require f }
 
     # Please keep in alphabetical order
+    include AccessRequests
     include AwardEmojis
     include Boards
     include Branches
@@ -12,6 +13,8 @@ module Gitlab
     include Commits
     include Deployments
     include Environments
+    include Events
+    include GroupMilestones
     include Groups
     include Issues
     include Jobs
@@ -29,6 +32,7 @@ module Gitlab
     include RepositoryFiles
     include Runners
     include Services
+    include Sidekiq
     include Snippets
     include SystemHooks
     include Tags

data/lib/gitlab/client/access_requests.rb

@@ -0,0 +1,94 @@
+class Gitlab::Client
+  # Defines methods related to Award Emojis.
+  # @see https://docs.gitlab.com/ce/api/access_requests.html
+  module AccessRequests
+    # Gets a list of access requests for a project viewable by the authenticated user.
+    #
+    # @example
+    #   Gitlab.project_access_requests(1)
+    #
+    # @param  [Integer, String] :project(required) The ID or name of a project.
+    # @return [Array<Gitlab::ObjectifiedHash>] List of project access requests
+    def project_access_requests(project)
+      get("/projects/#{url_encode project}/access_requests")
+    end
+    # Gets a list of access requests for a group viewable by the authenticated user.
+    #
+    # @example
+    #   Gitlab.group_access_requests(1)
+    #
+    # @param  [Integer, String] :group(required) The ID or name of a group.
+    # @return [Array<Gitlab::ObjectifiedHash>] List of group access requests
+    def group_access_requests(group)
+      get("/groups/#{url_encode group}/access_requests")
+    end
+    # Requests access for the authenticated user to a project.
+    #
+    # @example
+    #    Gitlab.request_project_access(1)
+    #
+    # @param  [Integer, String] :project(required) The ID or name of a project.
+    # @return <Gitlab::ObjectifiedHash] Information about the requested project access
+    def request_project_access(project)
+      post("/projects/#{url_encode project}/access_requests")
+    end
+    # Requests access for the authenticated user to a group.
+    #
+    # @example
+    #    Gitlab.request_group_access(1)
+    #
+    # @param  [Integer, String] :group(required) The ID or name of a group.
+    # @return <Gitlab::ObjectifiedHash] Information about the requested group access
+    def request_group_access(group)
+      post("/groups/#{url_encode group}/access_requests")
+    end
+    # Approves a project access request for the given user.
+    #
+    # @example
+    #    Gitlab.approve_project_access_request(1, 1)
+    #    Gitlab.approve_project_access_request(1, 1, {access_level: '30'})
+    #
+    # @param  [Integer, String] :project(required) The ID or name of a project.
+    # @param  [Integer] :user_id(required) The user ID of the access requester
+    # @option options [Integer] :access_level(optional) A valid access level (defaults: 30, developer access level)
+    # @return <Gitlab::ObjectifiedHash] Information about the approved project access request
+    def approve_project_access_request(project, user_id, options = {})
+      put("/projects/#{url_encode project}/access_requests/#{user_id}/approve", body: options)
+    end
+    # Approves a group access request for the given user.
+    #
+    # @example
+    #    Gitlab.approve_group_access_request(1, 1)
+    #    Gitlab.approve_group_access_request(1, 1, {access_level: '30'})
+    #
+    # @param  [Integer, String] :group(required) The ID or name of a group.
+    # @param  [Integer] :user_id(required) The user ID of the access requester
+    # @option options [Integer] :access_level(optional) A valid access level (defaults: 30, developer access level)
+    # @return <Gitlab::ObjectifiedHash] Information about the approved group access request
+    def approve_group_access_request(group, user_id, options = {})
+      put("/groups/#{url_encode group}/access_requests/#{user_id}/approve", body: options)
+    end
+    # Denies a project access request for the given user.
+    #
+    # @example
+    #    Gitlab.deny_project_access_request(1, 1)
+    #
+    # @param  [Integer, String] :project(required) The ID or name of a project.
+    # @param  [Integer] :user_id(required) The user ID of the access requester
+    # @return [void] This API call returns an empty response body.
+    def deny_project_access_request(project, user_id)
+      delete("/projects/#{url_encode project}/access_requests/#{user_id}")
+    end
+    # Denies a group access request for the given user.
+    #
+    # @example
+    #    Gitlab.deny_group_access_request(1, 1)
+    #
+    # @param  [Integer, String] :group(required) The ID or name of a group.
+    # @param  [Integer] :user_id(required) The user ID of the access requester
+    # @return [void] This API call returns an empty response body.
+    def deny_group_access_request(group, user_id)
+      delete("/groups/#{url_encode group}/access_requests/#{user_id}")
+    end
+  end
+end

data/lib/gitlab/client/branches.rb

@@ -68,15 +68,15 @@ class Gitlab::Client
     # Creates a repository branch.  Requires Gitlab >= 6.8.x
     #
     # @example
-    #   Gitlab.create_branch(3, 'api')
-    #   Gitlab.repo_create_branch(5, 'master')
+    #   Gitlab.create_branch(3, 'api', 'feat/new-api')
+    #   Gitlab.repo_create_branch(5, 'master', 'develop')
     #
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] branch The name of the new branch.
     # @param  [String] ref Create branch from commit sha or existing branch
     # @return [Gitlab::ObjectifiedHash] Details about the branch
     def create_branch(project, branch, ref)
-      post("/projects/#{url_encode project}/repository/branches", body: { branch: branch, ref: ref })
+      post("/projects/#{url_encode project}/repository/branches", query: { branch: branch, ref: ref })
     end
     alias_method :repo_create_branch, :create_branch
 

data/lib/gitlab/client/commits.rb

@@ -142,5 +142,23 @@ class Gitlab::Client
       }.merge(options)
       post("/projects/#{url_encode project}/repository/commits", body: payload)
     end
+
+    # Gets a list of merge requests for a commit.
+    #
+    # @see https://docs.gitlab.com/ce/api/commits.html#list-merge-requests-associated-with-a-commit
+    # Introduced in Gitlab 10.7
+    #
+    # @example
+    #   Gitlab.commit_merge_requests(5, 'c9f9662a9b1116c838b523ed64c6abdb4aae4b8b')
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [String] sha The commit hash.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def commit_merge_requests(project, commit, options={})
+      get("/projects/#{url_encode project}/repository/commits/#{commit}/merge_requests", query: options)
+    end
+    alias_method :repo_commit_merge_requests, :commit_merge_requests
   end
 end

data/lib/gitlab/client/events.rb

@@ -0,0 +1,58 @@
+class Gitlab::Client
+  # Defines methods related to events.
+  # @see https://docs.gitlab.com/ce/api/events.html
+  module Events
+    # Gets a list of authenticated user's events
+    #
+    # @example
+    #   Gitlab.events()
+    #   Gitlab.events({ action: 'created', target_type: 'issue' })
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :action Only events of specific action type
+    # @option options [String] :target_type Only events of specific target type
+    # @option options [String] :before Only events created before YYYY-MM-DD
+    # @option options [String] :after Only events created after YYYY-MM-DD
+    # @option options [String] :sort Sort by created_at either 'asc' or 'desc'
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def events(options={})
+      get('/events', query: options)
+    end
+
+    # Gets a list of user contribution events
+    #
+    # @example
+    #   Gitlab.user_events(1)
+    #   Gitlab.user_events(1, { action: created})
+    #
+    # @param  [Integer, String] user The ID or username of user
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :action Only events of specific action type
+    # @option options [String] :target_type Only events of specific target type
+    # @option options [String] :before Only events created before YYYY-MM-DD
+    # @option options [String] :after Only events created after YYYY-MM-DD
+    # @option options [String] :sort Sort by created_at either 'asc' or 'desc'
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def user_events(user, options={})
+      get("/users/#{url_encode user}/events", query: options)
+    end
+
+    # Gets a list of visible project events
+    #
+    # @example
+    #   Gitlab.project_events(1)
+    #   Gitlab.project_events(1, { action: created })
+    #
+    # @param  [Integer] project The ID of project
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :action Only events of specific action type
+    # @option options [String] :target_type Only events of specific target type
+    # @option options [String] :before Only events created before YYYY-MM-DD
+    # @option options [String] :after Only events created after YYYY-MM-DD
+    # @option options [String] :sort Sort by created_at either 'asc' or 'desc'
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def project_events(project, options={})
+      get("/#{url_encode project}/events", query: options)
+    end
+  end
+end

data/lib/gitlab/client/group_milestones.rb

@@ -0,0 +1,93 @@
+class Gitlab::Client
+  # Defines methods related to group milestones.
+  # @see https://docs.gitlab.com/ee/api/group_milestones.html
+  module GroupMilestones
+    # Gets a list of a group's milestones.
+    #
+    # @example
+    #   Gitlab.group_milestones(5)
+    #
+    # @param  [Integer, String] id The ID or name of a group.
+    # @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 group_milestones(id, options={})
+      get("/groups/#{url_encode id}/milestones", query: options)
+    end
+
+    # Gets a single group milestone.
+    #
+    # @example
+    #   Gitlab.group_milestone(5, 36)
+    #
+    # @param  [Integer, String] id The ID or name of a group.
+    # @param  [Integer] milestone_id The ID of a milestone.
+    # @return [Gitlab::ObjectifiedHash]
+    def group_milestone(id, milestone_id)
+      get("/groups/#{url_encode id}/milestones/#{milestone_id}")
+    end
+
+    # Creates a new group milestone.
+    #
+    # @example
+    #   Gitlab.create_group_milestone(5, 'v1.0')
+    #
+    # @param  [Integer, String] id The ID or name of a group.
+    # @param  [String] title The title of a milestone.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :description The description of a milestone.
+    # @option options [String] :due_date The due date of a milestone.
+    # @return [Gitlab::ObjectifiedHash] Information about created milestone.
+    def create_group_milestone(id, title, options={})
+      body = { title: title }.merge(options)
+      post("/groups/#{url_encode id}/milestones", body: body)
+    end
+
+    # Updates a group milestone.
+    #
+    # @example
+    #   Gitlab.edit_group_milestone(5, 2, { state_event: 'activate' })
+    #
+    # @param  [Integer, String] id The ID or name of a group.
+    # @param  [Integer] milestone_id The ID of a milestone.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :title The title of a milestone.
+    # @option options [String] :description The description of a milestone.
+    # @option options [String] :due_date The due date of a milestone.
+    # @option options [String] :state_event The state of a milestone ('close' or 'activate').
+    # @return [Gitlab::ObjectifiedHash] Information about updated milestone.
+    def edit_group_milestone(id, milestone_id, options={})
+      put("/groups/#{url_encode id}/milestones/#{milestone_id}", body: options)
+    end
+
+    # Gets the issues of a given group milestone.
+    #
+    # @example
+    #   Gitlab.group_milestone_issues(5, 2)
+    #
+    # @param  [Integer, String] id The ID or name of a group.
+    # @param  [Integer, String] milestone_id The ID of a milestone.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def group_milestone_issues(id, milestone_id, options={})
+      get("/groups/#{url_encode id}/milestones/#{milestone_id}/issues", query: options)
+    end
+
+    # Gets the merge_requests of a given group milestone.
+    #
+    # @example
+    #   Gitlab.group_milestone_merge_requests(5, 2)
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [Integer, String] milestone_id The ID of a milestone.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def group_milestone_merge_requests(id, milestone_id, options={})
+      get("/groups/#{url_encode id}/milestones/#{milestone_id}/merge_requests", query: options)
+    end
+  end
+end
+