gitlab 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2242783ef61cde9b3be8c6fad965bfbeb98aaa4
-  data.tar.gz: 01c567c9524d1e9ca20a0c0798d9b72fbe618f47
+  metadata.gz: f71b98abae4830188738c95c3c90310473de96a7
+  data.tar.gz: 64134f58cbba17afe03218750cea381d37865f93
 SHA512:
-  metadata.gz: 350d4ff66a74e000d55127271d526c77fbb56889d54b52e3c4f683c210f3c9ea62a763b706086070e1b0ff7cc02293fdc303ddd841c29cd51c4f79f1036f5e77
-  data.tar.gz: 4ca42fbb5fd028381944d77b016167e2471f013393b59030ee7ed3f5c700cf791af9ae43a542f45f7f769550003e64017fa6dde079c3e683dc3314718f6c32ea
+  metadata.gz: f1e92645b84ff2e71918812296ce9b70ae67215b2c5919b901fc49de1f5c587c7dbacdb194b9091228a065fe30917b23cadfc3b4c5ea7fcc6659765b2581db6b
+  data.tar.gz: 97d106205c7a38c8e51469e133fa7209b8c0e3fe69f43dbe928df7ed16bb5e202674c35e05a072ef8cddc112fb73c7d7df65fbc0e5757410979752e1da901abd

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 ## Change Log
 
-### upcoming (26/11/2015)
+### 3.6.0 (11/12/2015)
+
+- Improved output of the CLI help (@thomasdarimont)
+- Added `search_projects` alias for `project_search` method
+- Added pagination and auto pagination support (@nanofi)
+
+### 3.5.0 (26/11/2015)
 - [a4f2150](https://github.com/NARKOZ/gitlab/commit/a4f21504a7288caace5b7433b49f49dc31e32b30) Add support for namespaces endpoint
 - [3ad81a1](https://github.com/NARKOZ/gitlab/commit/3ad81a19a10b35ea422c0abcf08e6d03a325f4cd) Add missing "@" in doc. (@asedge)
 - [fc34acb](https://github.com/NARKOZ/gitlab/commit/fc34acb6b475bb2555e4b035c11fdf42b3db4085) Add Gitlab::Client::Commits and rearrange methods and tests related to commits. (@asedge)

data/README.md

@@ -82,6 +82,23 @@ Gitlab.sudo = '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).

data/Rakefile

@@ -6,4 +6,4 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.rspec_opts = ['--color', '--format d']
 end
 
-task :default => :spec
+task default: :spec

data/exe/gitlab

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$:.unshift File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
 require 'gitlab/cli'
 

data/lib/gitlab.rb

@@ -2,6 +2,8 @@ require 'gitlab/version'
 require 'gitlab/objectified_hash'
 require 'gitlab/configuration'
 require 'gitlab/error'
+require 'gitlab/page_links'
+require 'gitlab/paginated_response'
 require 'gitlab/request'
 require 'gitlab/api'
 require 'gitlab/client'
@@ -24,11 +26,11 @@ module Gitlab
 
   # Delegate to Gitlab::Client
   def self.respond_to?(method)
-    return client.respond_to?(method) || super
+    client.respond_to?(method) || super
   end
 
   # Delegate to HTTParty.http_proxy
-  def self.http_proxy(address = nil, port = nil, username = nil, password = nil)
+  def self.http_proxy(address=nil, port=nil, username=nil, password=nil)
     Gitlab::Request.http_proxy(address, port, username, password)
   end
 
@@ -37,6 +39,6 @@ module Gitlab
   # @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]}
+    (Gitlab::Client.instance_methods - Object.methods).reject { |e| e[hidden] }
   end
 end

data/lib/gitlab/cli.rb

@@ -79,7 +79,7 @@ class Gitlab::CLI
 
   # Helper method that checks whether we want to get the output as json
   # @return [nil]
-  def self.render_output(cmd,args,data)
+  def self.render_output(cmd, args, data)
     if @json_output
       output_json(cmd, args, data)
     else

data/lib/gitlab/cli_helpers.rb

@@ -1,7 +1,6 @@
 require 'yaml'
 require 'json'
 
-
 class Gitlab::CLI
   # Defines methods related to CLI output and formatting.
   module Helpers
@@ -75,14 +74,14 @@ class Gitlab::CLI
           puts 'Command aborted.'
           exit(1)
         end
-      end 
+      end
     end
 
     # Gets defined help for a specific command/action.
     #
     # @return [String]
-    def help(cmd = nil, &block)
-      if cmd.nil? or Gitlab::Help.help_map.has_key?(cmd)
+    def help(cmd=nil, &block)
+      if cmd.nil? || Gitlab::Help.help_map.key?(cmd)
         Gitlab::Help.actions_table(cmd)
       else
         Gitlab::Help.get_help(cmd, &block)
@@ -96,7 +95,7 @@ class Gitlab::CLI
         puts record_table([data], cmd, args)
       when Array
         puts record_table(data, cmd, args)
-      else  # probably just an error msg
+      else # probably just an error msg
         puts data
       end
     end
@@ -106,12 +105,12 @@ class Gitlab::CLI
         puts '{}'
       else
         hash_result = case data
-          when Gitlab::ObjectifiedHash
-            record_hash([data], cmd, args, true)
-          when Array
-            record_hash(data, cmd, args)
-          else
-            { :cmd => cmd, :data => data, :args => args }
+                      when Gitlab::ObjectifiedHash
+                        record_hash([data], cmd, args, true)
+                      when Array
+                        record_hash(data, cmd, args)
+                      else
+                        { cmd: cmd, data: data, args: args }
         end
         puts JSON.pretty_generate(hash_result)
       end
@@ -156,7 +155,7 @@ class Gitlab::CLI
     # @param  [Array]  args         Options passed to the API call
     # @param  [bool]   single_value If set to true, a single result should be returned
     # @return [Hash]   Result hash
-    def record_hash(data, cmd, args, single_value = false)
+    def record_hash(data, cmd, args, single_value=false)
       if data.empty?
         result = nil
       else
@@ -167,12 +166,12 @@ class Gitlab::CLI
 
           keys.each do |key|
             case hash[key]
-              when Hash
-                row[key] = 'Hash'
-              when nil
-                row[key] = nil
-              else
-                row[key] = hash[key]
+            when Hash
+              row[key] = 'Hash'
+            when nil
+              row[key] = nil
+            else
+              row[key] = hash[key]
             end
           end
 
@@ -182,23 +181,22 @@ class Gitlab::CLI
       end
 
       {
-        :cmd => "Gitlab.#{cmd} #{args.join(', ')}".strip,
-        :result => result
+        cmd: "Gitlab.#{cmd} #{args.join(', ')}".strip,
+        result: result
       }
-
     end
 
     # Helper function to get rows and keys from data returned from API call
     def get_keys(args, data)
       arr = data.map(&:to_h)
       keys = arr.first.keys.sort { |x, y| x.to_s <=> y.to_s }
-      keys = keys & required_fields(args) if required_fields(args).any?
-      keys = keys - excluded_fields(args)
-      return arr, keys
+      keys &= required_fields(args) if required_fields(args).any?
+      keys -= excluded_fields(args)
+      [arr, keys]
     end
 
     # Helper function to call Gitlab commands with args.
-    def gitlab_helper(cmd, args = [])
+    def gitlab_helper(cmd, args=[])
       begin
         data = args.any? ? Gitlab.send(cmd, *args) : Gitlab.send(cmd)
       rescue => e
@@ -228,7 +226,7 @@ class Gitlab::CLI
     # YAML::load on a single argument
     def yaml_load(arg)
       begin
-        yaml = YAML::load(arg)
+        yaml = YAML.load(arg)
       rescue Psych::SyntaxError
         raise "error: Argument is not valid YAML syntax: #{arg}"
       end

data/lib/gitlab/client.rb

@@ -1,7 +1,7 @@
 module Gitlab
   # Wrapper for the Gitlab REST API.
   class Client < API
-    Dir[File.expand_path('../client/*.rb', __FILE__)].each {|f| require f}
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each { |f| require f }
 
     include Branches
     include Commits

data/lib/gitlab/client/branches.rb

@@ -13,7 +13,7 @@ class Gitlab::Client
     # @option options [Integer] :per_page The number of results per page.
     # @return [Array<Gitlab::ObjectifiedHash>]
     def branches(project, options={})
-      get("/projects/#{project}/repository/branches", :query => options)
+      get("/projects/#{project}/repository/branches", query: options)
     end
     alias_method :repo_branches, :branches
 
@@ -29,7 +29,6 @@ class Gitlab::Client
     def branch(project, branch)
       get("/projects/#{project}/repository/branches/#{branch}")
     end
-
     alias_method :repo_branch, :branch
 
     # Protects a repository branch.
@@ -71,7 +70,7 @@ class Gitlab::Client
     # @param  [String] ref Create branch from commit sha or existing branch
     # @return [Gitlab::ObjectifiedHash]
     def create_branch(project, branch, ref)
-      post("/projects/#{project}/repository/branches",:body => {:branch_name => branch, :ref => ref})
+      post("/projects/#{project}/repository/branches", body: { branch_name: branch, ref: ref })
     end
     alias_method :repo_create_branch, :create_branch
 
@@ -88,7 +87,5 @@ class Gitlab::Client
       delete("/projects/#{project}/repository/branches/#{branch}")
     end
     alias_method :repo_delete_branch, :delete_branch
-
   end
 end
-

data/lib/gitlab/client/commits.rb

@@ -15,7 +15,7 @@ class Gitlab::Client
     # @option options [Integer] :per_page The number of results per page.
     # @return [Array<Gitlab::ObjectifiedHash>]
     def commits(project, options={})
-      get("/projects/#{project}/repository/commits", :query => options)
+      get("/projects/#{project}/repository/commits", query: options)
     end
     alias_method :repo_commits, :commits
 
@@ -58,7 +58,7 @@ class Gitlab::Client
     # @option options [Integer] :per_page The number of results per page.
     # @return [Array<Gitlab::ObjectifiedHash>]
     def commit_comments(project, commit, options={})
-      get("/projects/#{project}/repository/commits/#{commit}/comments", :query => options)
+      get("/projects/#{project}/repository/commits/#{commit}/comments", query: options)
     end
     alias_method :repo_commit_comments, :commit_comments
 
@@ -76,7 +76,7 @@ class Gitlab::Client
     # @option options [String] :line_type The line type (new or old).
     # @return [Gitlab::ObjectifiedHash] Information about created comment.
     def create_commit_comment(project, commit, note, options={})
-      post("/projects/#{project}/repository/commits/#{commit}/comments", :body => options.merge(:note => note))
+      post("/projects/#{project}/repository/commits/#{commit}/comments", body: options.merge(note: note))
     end
     alias_method :repo_create_commit_comment, :create_commit_comment
 
@@ -94,7 +94,7 @@ class Gitlab::Client
     # @option options [String] :stage Filter by stage
     # @option options [String] :name Filer by status name, eg. jenkins
     # @option options [Boolean] :all The flag to return all statuses, not only latest ones
-    def commit_status(id, sha, options = {})
+    def commit_status(id, sha, options={})
       get("/projects/#{id}/repository/commits/#{sha}/statuses", query: options)
     end
     alias_method :repo_commit_status, :commit_status
@@ -113,7 +113,7 @@ class Gitlab::Client
     # @option options [String] :ref The ref (branch or tag) to which the status refers
     # @option options [String] :name Filer by status name, eg. jenkins
     # @option options [String] :target_url The target URL to associate with this status
-    def update_commit_status(id, sha, state, options = {})
+    def update_commit_status(id, sha, state, options={})
       post("/projects/#{id}/statuses/#{sha}", query: options.merge(state: state))
     end
     alias_method :repo_update_commit_status, :update_commit_status

data/lib/gitlab/client/groups.rb

@@ -13,7 +13,7 @@ class Gitlab::Client
     # @option options [Integer] :per_page The number of results per page.
     # @return [Array<Gitlab::ObjectifiedHash>]
     def groups(options={})
-      get("/groups", :query => options)
+      get("/groups", query: options)
     end
 
     # Gets a single group.
@@ -37,8 +37,8 @@ class Gitlab::Client
     # @param  [String] path The path of a group.
     # @return [Gitlab::ObjectifiedHash] Information about created group.
     def create_group(name, path, options={})
-      body = {:name => name, :path => path}.merge(options)
-      post("/groups", :body => body)
+      body = { name: name, path: path }.merge(options)
+      post("/groups", body: body)
     end
 
     # Get a list of group members.
@@ -53,7 +53,7 @@ class Gitlab::Client
     # @option options [Integer] :per_page The number of results per page.
     # @return [Array<Gitlab::ObjectifiedHash>]
     def group_members(id, options={})
-      get("/groups/#{id}/members", :query => options)
+      get("/groups/#{id}/members", query: options)
     end
 
     # Adds a user to group.
@@ -66,7 +66,7 @@ class Gitlab::Client
     # @param  [Integer] access_level Project access level.
     # @return [Gitlab::ObjectifiedHash] Information about added team member.
     def add_group_member(team_id, user_id, access_level)
-      post("/groups/#{team_id}/members", :body => {:user_id => user_id, :access_level => access_level})
+      post("/groups/#{team_id}/members", body: { user_id: user_id, access_level: access_level })
     end
 
     # Removes user from user group.
@@ -89,8 +89,8 @@ class Gitlab::Client
     # @param  [Integer] id The ID of a group.
     # @param  [Integer] project_id The ID of a project.
     def transfer_project_to_group(id, project_id)
-      body = {:id => id, :project_id => project_id}
-      post("/groups/#{id}/projects/#{project_id}", :body => body)
+      body = { id: id, project_id: project_id }
+      post("/groups/#{id}/projects/#{project_id}", body: body)
     end
 
     # Search for groups by name
@@ -105,8 +105,7 @@ class Gitlab::Client
     # @return [Array<Gitlab::ObjectifiedHash>]
     def group_search(search, options={})
       options[:search] = search
-      get("/groups", :query => options)
+      get("/groups", query: options)
     end
-
   end
 end

data/lib/gitlab/client/issues.rb

@@ -17,9 +17,9 @@ class Gitlab::Client
     # @return [Array<Gitlab::ObjectifiedHash>]
     def issues(project=nil, options={})
       if project.to_i.zero?
-        get("/issues", :query => options)
+        get("/issues", query: options)
       else
-        get("/projects/#{project}/issues", :query => options)
+        get("/projects/#{project}/issues", query: options)
       end
     end
 
@@ -50,8 +50,8 @@ class Gitlab::Client
     # @option options [String] :labels Comma-separated label names for an issue.
     # @return [Gitlab::ObjectifiedHash] Information about created issue.
     def create_issue(project, title, options={})
-      body = {:title => title}.merge(options)
-      post("/projects/#{project}/issues", :body => body)
+      body = { title: title }.merge(options)
+      post("/projects/#{project}/issues", body: body)
     end
 
     # Updates an issue.
@@ -70,7 +70,7 @@ class Gitlab::Client
     # @option options [String] :state_event The state event of an issue ('close' or 'reopen').
     # @return [Gitlab::ObjectifiedHash] Information about updated issue.
     def edit_issue(project, id, options={})
-      put("/projects/#{project}/issues/#{id}", :body => options)
+      put("/projects/#{project}/issues/#{id}", body: options)
     end
 
     # Closes an issue.
@@ -82,7 +82,7 @@ class Gitlab::Client
     # @param  [Integer] id The ID of an issue.
     # @return [Gitlab::ObjectifiedHash] Information about closed issue.
     def close_issue(project, id)
-      put("/projects/#{project}/issues/#{id}", :body => {:state_event => 'close'})
+      put("/projects/#{project}/issues/#{id}", body: { state_event: 'close' })
     end
 
     # Reopens an issue.
@@ -94,7 +94,7 @@ class Gitlab::Client
     # @param  [Integer] id The ID of an issue.
     # @return [Gitlab::ObjectifiedHash] Information about reopened issue.
     def reopen_issue(project, id)
-      put("/projects/#{project}/issues/#{id}", :body => {:state_event => 'reopen'})
+      put("/projects/#{project}/issues/#{id}", body: { state_event: 'reopen' })
     end
   end
 end

data/lib/gitlab/client/labels.rb

@@ -23,7 +23,7 @@ class Gitlab::Client
     # @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})
+      post("/projects/#{project}/labels", body: { name: name, color: color })
     end
 
     # Updates a label.
@@ -39,7 +39,7 @@ class Gitlab::Client
     # @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}))
+      put("/projects/#{project}/labels", body: options.merge(name: name))
     end
 
     # Deletes a label.
@@ -51,7 +51,7 @@ class Gitlab::Client
     # @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} )
+      delete("/projects/#{project}/labels", body: { name: name })
     end
   end
 end

data/lib/gitlab/client/merge_requests.rb

@@ -14,7 +14,7 @@ class Gitlab::Client
     # @option options [Integer] :per_page The number of results per page.
     # @return [Array<Gitlab::ObjectifiedHash>]
     def merge_requests(project, options={})
-      get("/projects/#{project}/merge_requests", :query => options)
+      get("/projects/#{project}/merge_requests", query: options)
     end
 
     # Gets a single merge request.
@@ -46,8 +46,8 @@ class Gitlab::Client
     # @option options [Integer] :target_project_id (optional) The target project ID.
     # @return [Gitlab::ObjectifiedHash] Information about created merge request.
     def create_merge_request(project, title, options={})
-      body = {:title => title}.merge(options)
-      post("/projects/#{project}/merge_requests", :body => body)
+      body = { title: title }.merge(options)
+      post("/projects/#{project}/merge_requests", body: body)
     end
 
     # Updates a merge request.
@@ -65,7 +65,7 @@ class Gitlab::Client
     # @option options [String] :state_event New state (close|reopen|merge).
     # @return [Gitlab::ObjectifiedHash] Information about updated merge request.
     def update_merge_request(project, id, options={})
-      put("/projects/#{project}/merge_request/#{id}", :body => options)
+      put("/projects/#{project}/merge_request/#{id}", body: options)
     end
 
     # Accepts a merge request.
@@ -79,7 +79,7 @@ class Gitlab::Client
     # @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)
+      put("/projects/#{project}/merge_request/#{id}/merge", body: options)
     end
 
     # Adds a comment to a merge request.
@@ -93,7 +93,7 @@ class Gitlab::Client
     # @param  [String] note The content of a comment.
     # @return [Gitlab::ObjectifiedHash] Information about created merge request comment.
     def create_merge_request_comment(project, id, note)
-      post("/projects/#{project}/merge_request/#{id}/comments", :body => {:note => note})
+      post("/projects/#{project}/merge_request/#{id}/comments", body: { note: note })
     end
 
     # Gets the comments on a merge request.
@@ -109,7 +109,7 @@ class Gitlab::Client
     # @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, options={})
-      get("/projects/#{project}/merge_request/#{id}/comments", :query => options)
+      get("/projects/#{project}/merge_request/#{id}/comments", query: options)
     end
 
     # Gets the changes of a merge request.