gitlab 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1eec826134f7f158d272a521a17b9c52462563b
-  data.tar.gz: ce91d8223ae73ab6194680ac023919beb6178286
+  metadata.gz: 6dc7a38a2ba00b6ea3f0305b57d4f5209ba03511
+  data.tar.gz: ba2dcfd5474bd971f26a8baa0ae3949128ca6a5d
 SHA512:
-  metadata.gz: 2c64f4ef7633db83324ccd32a14ee073a437339b40e9cf8c58a0691a558dc09a4a9f8b24cf68cb86ef5b6b25a49d8d110113e9d32c8988bf2dbf2b6d4e09a047
-  data.tar.gz: 34d73c1a2b04ffb4339dbfb634d73f0a337a0d8919b851808d967d3c06dcb7327a93b82786dac59a64b8d6b99e0815c1ddf522f8272570d5535593e7513f333f
+  metadata.gz: 1e9eebbb77c15cad4a5b030061177e8c7ea898b57896f63fb8608ac8fa2812623eb12f5e5d2d3fa1f607945946821a03e040571cd3331478bdde29fc5796f974
+  data.tar.gz: f90b16ae0d5fbce51044534b4751ff272b492d501a9bd63dfa7e31b8395f1e9166d541266ccaa58fc8e64f6cadf1d5639d0b0e1afd4fdb35a403018c35b5b65a

data/CONTRIBUTING.md

@@ -0,0 +1,195 @@
+# Contributing to Gitlab
+
+Please take a moment to review this document in order to make the contribution
+process easy and effective for everyone involved!
+
+## Using the issue tracker
+
+You can use the issues tracker for:
+
+* [bug reports](#bug-reports)
+* [feature requests](#feature-requests)
+* [submitting pull requests](#pull-requests)
+
+Use [Stackoverflow](http://stackoverflow.com/) for questions and personal support requests.
+
+## Bug reports
+
+A bug is a _demonstrable problem_ that is caused by the code in the repository.
+Good bug reports are extremely helpful - thank you!
+
+Guidelines for bug reports:
+
+1. **Use the GitHub issue search** — check if the issue has already been
+   reported.
+
+2. **Check if the issue has been fixed** — try to reproduce it using the
+   `master` branch in the repository.
+
+3. **Isolate and report the problem** — ideally create a reduced test
+   case.
+
+Please try to be as detailed as possible in your report. Include information about
+your Ruby, Gitlab client and GitLab instance versions. Please provide steps to
+reproduce the issue as well as the outcome you were expecting! All these details
+will help developers to fix any potential bugs.
+
+Example:
+
+> Short and descriptive example bug report title
+>
+> A summary of the issue and the environment in which it occurs. If suitable,
+> include the steps required to reproduce the bug.
+>
+> 1. This is the first step
+> 2. This is the second step
+> 3. Further steps, etc.
+>
+> Any other information you want to share that is relevant to the issue being
+> reported. This might include the lines of code that you have identified as
+> causing the bug, and potential solutions (and your opinions on their
+> merits).
+
+## Feature requests
+
+Feature requests are welcome. But take a moment to find out whether your idea
+fits with the scope and aims of the project. It's up to *you* to make a strong
+case to convince the community of the merits of this feature.
+Please provide as much detail and context as possible.
+
+## Contributing Documentation
+
+Code documentation has a special convention: it uses [YARD](http://yardoc.org/)
+formatting and the first paragraph is considered to be a short summary.
+
+For methods say what it will do. For example write something like:
+
+```ruby
+# Reverses the contents of a String or IO object.
+#
+# @param [String, #read] contents the contents to reverse
+# @return [String] the contents reversed lexically
+def reverse(contents)
+  contents = contents.read if contents.respond_to? :read
+  contents.reverse
+end
+```
+
+For classes, modules say what it is. For example write something like:
+
+```ruby
+# Defines methods related to groups.
+module Groups
+```
+
+Keep in mind that the documentation notes might show up in a summary somewhere,
+long texts in the documentation notes create very ugly summaries. As a rule of thumb
+anything longer than 80 characters is too long.
+
+Try to keep unnecessary details out of the first paragraph, it's only there to
+give a user a quick idea of what the documented "thing" does/is. The rest of the
+documentation notes can contain the details, for example parameters and what
+is returned.
+
+If possible include examples. For example:
+
+```ruby
+# Gets information about a project.
+#
+# @example
+#   Gitlab.project(3)
+#   Gitlab.project('gitlab')
+#
+# @param  [Integer, String] id The ID or name of a project.
+# @return [Gitlab::ObjectifiedHash]
+def project(id)
+```
+
+This makes it easy to test the examples so that they don't go stale and examples
+are often a great help in explaining what a method does.
+
+## Pull requests
+
+Good pull requests - patches, improvements, new features - are a fantastic
+help. They should remain focused in scope and avoid containing unrelated
+commits.
+
+**IMPORTANT**: By submitting a patch, you agree that your work will be
+licensed under the license used by the project.
+
+If you have any large pull request in mind (e.g. implementing features,
+refactoring code, etc), **please ask first** otherwise you risk spending
+a lot of time working on something that the project's developers might
+not want to merge into the project.
+
+Please adhere to the coding conventions in the project (indentation,
+accurate comments, etc.) and don't forget to add your own tests and
+documentation. When working with git, we recommend the following process
+in order to craft an excellent pull request:
+
+1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your fork,
+   and configure the remotes:
+
+   ```sh
+   # Clone your fork of the repo into the current directory
+   git clone https://github.com/<your-username>/gitlab
+   # Navigate to the newly cloned directory
+   cd gitlab
+   # Assign the original repo to a remote called "upstream"
+   git remote add upstream https://github.com/NARKOZ/gitlab
+   ```
+
+2. If you cloned a while ago, get the latest changes from upstream:
+
+   ```bash
+   git checkout master
+   git pull upstream master
+   ```
+
+3. Create a new topic branch (off of `master`) to contain your feature, change,
+   or fix.
+
+   **IMPORTANT**: Making changes in `master` is discouraged. You should always
+   keep your local `master` in sync with upstream `master` and make your
+   changes in topic branches.
+
+   ```sh
+   git checkout -b <topic-branch-name>
+   ```
+
+4. Commit your changes in logical chunks. Keep your commit messages organized,
+   with a short description in the first line and more detailed information on
+   the following lines. Feel free to use Git's
+   [interactive rebase](https://help.github.com/articles/about-git-rebase/)
+   feature to tidy up your commits before making them public.
+
+5. Make sure all the tests are still passing.
+
+   ```sh
+   rake
+   ```
+
+6. Push your topic branch up to your fork:
+
+   ```sh
+   git push origin <topic-branch-name>
+   ```
+
+7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
+    with a clear title and description.
+
+8. If you haven't updated your pull request for a while, you should consider
+   rebasing on master and resolving any conflicts.
+
+   **IMPORTANT**: _Never ever_ merge upstream `master` into your branches. You
+   should always `git rebase` on `master` to bring your changes up to date when
+   necessary.
+
+   ```sh
+   git checkout master
+   git pull upstream master
+   git checkout <your-topic-branch>
+   git rebase master
+   ```
+
+Thank you for your contributions!

data/README.md

@@ -49,6 +49,11 @@ Gitlab.endpoint = 'http://example.net/api/v3'
 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"}>]
@@ -94,6 +99,10 @@ gitlab user 2
 gitlab user --only=id,username
 
 gitlab user --except=email,bio
+
+# how to pass options hash to a command (use YAML)
+gitlab create_merge_request 4 "I'm creating a new merge request." "{source_branch: 'new_branch', target_branch: 'master', assignee_id: 42}"
+
 ```
 
 ## CLI Shell
@@ -112,6 +121,9 @@ gitlab> groups
 
 # protect a branch
 gitlab> protect_branch 1 master
+
+# how to pass options hash to a command (use YAML)
+gitlab> create_merge_request 4 "I'm creating a new merge request." "{source_branch: 'new_branch', target_branch: 'master', assignee_id: 42}"
 ```
 
 For more information, refer to [website](http://narkoz.github.io/gitlab).

data/lib/gitlab.rb

@@ -27,6 +27,11 @@ module Gitlab
     return 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>]

data/lib/gitlab/cli.rb

@@ -38,6 +38,12 @@ class Gitlab::CLI
         command_args = args
       end
 
+      begin
+        yaml_load_and_symbolize_hash!(command_args)
+      rescue
+        exit 1
+      end
+
       confirm_command(cmd)
 
       data = gitlab_helper(cmd, command_args) { exit(1) }

data/lib/gitlab/cli_helpers.rb

@@ -1,3 +1,4 @@
+require 'yaml'
 class Gitlab::CLI
   # Defines methods related to CLI output and formatting.
   module Helpers
@@ -7,7 +8,7 @@ class Gitlab::CLI
     #
     # @return [Array]
     def required_fields(args)
-      if args.any? && args.last.start_with?('--only=')
+      if args.any? && args.last.is_a?(String) && args.last.start_with?('--only=')
         args.last.gsub('--only=', '').split(',')
       else
         []
@@ -18,7 +19,7 @@ class Gitlab::CLI
     #
     # @return [Array]
     def excluded_fields(args)
-      if args.any? && args.last.start_with?('--except=')
+      if args.any? && args.last.is_a?(String) && args.last.start_with?('--except=')
         args.last.gsub('--except=', '').split(',')
       else
         []
@@ -45,7 +46,7 @@ class Gitlab::CLI
           puts 'Command aborted.'
           exit(1)
         end
-      end
+      end 
     end
 
     # Table with available commands.
@@ -171,5 +172,41 @@ class Gitlab::CLI
 
       data
     end
+
+    # Convert a hash (recursively) to use symbol hash keys
+    # @return [Hash]
+    def symbolize_keys(hash)
+      if hash.is_a?(Hash)
+        hash = hash.each_with_object({}) do |(key, value), newhash|
+          begin
+            newhash[key.to_sym] = symbolize_keys(value)
+          rescue NoMethodError
+            puts "error: cannot convert hash key to symbol: #{arg}"
+            raise
+          end
+        end
+      end
+
+      hash
+    end
+
+    # Run YAML::load on each arg and symbolize hash keys if found.
+    # @return [Array]
+    def yaml_load_and_symbolize_hash!(args)
+      args.map! do |arg|
+        begin
+          arg = YAML::load(arg)
+
+          if arg.is_a?(Hash)
+            arg = symbolize_keys(arg)
+          end
+        rescue Psych::SyntaxError
+          puts "error: Argument is not valid YAML syntax: #{arg}"
+          raise
+        end
+
+        arg
+      end
+    end
   end
 end

data/lib/gitlab/client.rb

@@ -14,5 +14,6 @@ module Gitlab
     include Snippets
     include SystemHooks
     include Users
+    include Labels
   end
 end

data/lib/gitlab/client/labels.rb

@@ -0,0 +1,55 @@
+class Gitlab::Client
+  module Labels
+    # Gets a list of project's labels.
+    #
+    # @example
+    #   Gitlab.labels(5)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def labels(project)
+      get("/projects/#{project}/labels")
+    end
+
+    # Creates a new label.
+    #
+    # @example
+    #   Gitlab.create_label(42, "Backlog", '#DD10AA')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @option [String] name The name of a label.
+    # @option [String] color The color of a label.
+    # @return [Gitlab::ObjectifiedHash] Information about created label.
+    def create_label(project, name, color)
+      post("/projects/#{project}/labels", :body => { :name => name, :color => color})
+    end
+
+    # Updates a label.
+    #
+    # @example
+    #   Gitlab.edit_label(42, "Backlog", :new_name => 'TODO')
+    #   Gitlab.edit_label(42, "Backlog", :new_name => 'TODO', :color => '#DD10AA')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] name The name of a label.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :new_name The new name of a label.
+    # @option options [String] :color The color of a label.
+    # @return [Gitlab::ObjectifiedHash] Information about updated label.
+    def edit_label(project, name, options={})
+      put("/projects/#{project}/labels", :body => options.merge({:name => name}))
+    end
+
+    # Deletes a label.
+    #
+    # @example
+    #   Gitlab.delete_label(2, 'Backlog')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] name The name of a label.
+    # @return [Gitlab::ObjectifiedHash] Information about deleted label.
+    def delete_label(project, name)
+      delete("/projects/#{project}/labels", :body => {:name => name} )
+    end
+  end
+end

data/lib/gitlab/client/merge_requests.rb

@@ -68,6 +68,20 @@ class Gitlab::Client
       put("/projects/#{project}/merge_request/#{id}", :body => options)
     end
 
+    # Accepts a merge request.
+    #
+    # @example
+    #   Gitlab.accept_merge_request(5, 42, :merge_commit_message => 'Nice!')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of a merge request.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :merge_commit_message Custom merge commit message
+    # @return [Gitlab::ObjectifiedHash] Information about updated merge request.
+    def accept_merge_request(project, id, options={})
+      put("/projects/#{project}/merge_request/#{id}/merge", :body => options)
+    end
+
     # Adds a comment to a merge request.
     #
     # @example
@@ -86,12 +100,16 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.merge_request_comments(5, 1)
+    #   Gitlab.merge_request_comments(5, 1, :per_page =>10, :page => 2)
     #
     # @param  [Integer] project The ID of a project.
     # @param  [Integer] id The ID of a merge request.
+    # @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 [Gitlab::ObjectifiedHash] The merge request's comments.
-    def merge_request_comments(project, id)
-      get("/projects/#{project}/merge_request/#{id}/comments")
+    def merge_request_comments(project, id, options={})
+      get("/projects/#{project}/merge_request/#{id}/comments", :query => options)
     end
 
     private

data/lib/gitlab/client/projects.rb

@@ -57,6 +57,8 @@ class Gitlab::Client
     # @param  [Hash] options A customizable set of options.
     # @option options [String] :description The description of a project.
     # @option options [String] :default_branch The default branch of a project.
+    # @option options [String] :group_id The group in which to create a project.
+    # @option options [String] :namespace_id The namespace in which to create a project.
     # @option options [Boolean] :wiki_enabled The wiki integration for a project (0 = false, 1 = true).
     # @option options [Boolean] :wall_enabled The wall functionality for a project (0 = false, 1 = true).
     # @option options [Boolean] :issues_enabled The issues integration for a project (0 = false, 1 = true).
@@ -185,14 +187,15 @@ class Gitlab::Client
     #
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] url The hook URL.
-    # @param  [Hash] options Events list (`{push_events: true, merge_requests_events: false}`).
+    # @param  [Hash] options A customizable set of options.
+    # @param  option [Boolean] :push_events Trigger hook on push events (0 = false, 1 = true)
+    # @param  option [Boolean] :issues_events Trigger hook on issues events (0 = false, 1 = true)
+    # @param  option [Boolean] :merge_requests_events Trigger hook on merge_requests events (0 = false, 1 = true)
+    # @param  option [Boolean] :tag_push_events Trigger hook on push_tag events (0 = false, 1 = true)
     # @return [Gitlab::ObjectifiedHash] Information about added hook.
-    def add_project_hook(project, url, options = {})
-      available_events = [:push_events, :merge_requests_events, :issues_events]
-      passed_events = available_events.select { |event| options[event] }
-      events = Hash[passed_events.map { |event| [event, options[event]] }]
-
-      post("/projects/#{project}/hooks", :body => {:url => url}.merge(events))
+    def add_project_hook(project, url, options={})
+      body = {:url => url}.merge(options)
+      post("/projects/#{project}/hooks", :body => body)
     end
 
     # Updates a project hook URL.
@@ -203,9 +206,15 @@ class Gitlab::Client
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [Integer] id The ID of the hook.
     # @param  [String] url The hook URL.
+    # @param  [Hash] options A customizable set of options.
+    # @param  option [Boolean] :push_events Trigger hook on push events (0 = false, 1 = true)
+    # @param  option [Boolean] :issues_events Trigger hook on issues events (0 = false, 1 = true)
+    # @param  option [Boolean] :merge_requests_events Trigger hook on merge_requests events (0 = false, 1 = true)
+    # @param  option [Boolean] :tag_push_events Trigger hook on push_tag events (0 = false, 1 = true)
     # @return [Gitlab::ObjectifiedHash] Information about updated hook.
-    def edit_project_hook(project, id, url)
-      put("/projects/#{project}/hooks/#{id}", :body => {:url => url})
+    def edit_project_hook(project, id, url, options={})
+      body = {:url => url}.merge(options)
+      put("/projects/#{project}/hooks/#{id}", :body => body)
     end
 
     # Deletes a hook from project.