gitlab 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88679bf87230b7d3d6bb8f0e96fb779967936216
-  data.tar.gz: 6c41b6c43280434257bc160aa38963ef50a4cc72
+  metadata.gz: e1eec826134f7f158d272a521a17b9c52462563b
+  data.tar.gz: ce91d8223ae73ab6194680ac023919beb6178286
 SHA512:
-  metadata.gz: ae58eefafd56dba8d8b87029c89972d036c479d3a3d15b6a7196e08495d9325de841a1860cb29151dd879aa05bee8fef1f340118d6309b520532804615b464d9
-  data.tar.gz: a96ddd98eebc816f295856c6996b1b29462c9a236d4a1d67b5c6259dc00e7f1b7b08bbf395c7bc69d1b8983e7be990ca2cda9a143c218f33dab3d3df8134731f
+  metadata.gz: 2c64f4ef7633db83324ccd32a14ee073a437339b40e9cf8c58a0691a558dc09a4a9f8b24cf68cb86ef5b6b25a49d8d110113e9d32c8988bf2dbf2b6d4e09a047
+  data.tar.gz: 34d73c1a2b04ffb4339dbfb634d73f0a337a0d8919b851808d967d3c06dcb7327a93b82786dac59a64b8d6b99e0815c1ddf522f8272570d5535593e7513f333f

data/README.md

@@ -28,18 +28,22 @@ Configuration example:
 
 ```ruby
 Gitlab.configure do |config|
-  config.endpoint       = 'https://example.net/api/v3' # API endpoint URL (required)
-  config.private_token  = 'qEsq1pt6HJPaNciie3MG'       # user's private token (required)
-  config.user_agent     = 'Custom User Agent'          # user agent, default to 'Gitlab Ruby Gem [version]' (optional)
+  config.endpoint       = 'https://example.net/api/v3' # API endpoint URL, default: ENV['GITLAB_API_ENDPOINT']
+  config.private_token  = 'qEsq1pt6HJPaNciie3MG'       # user's private 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/v2"
+# => "http://example.net/api/v3"
 
 # set a user private token
 Gitlab.private_token = 'qEsq1pt6HJPaNciie3MG'
@@ -92,6 +96,24 @@ gitlab user --only=id,username
 gitlab user --except=email,bio
 ```
 
+## 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
+```
+
 For more information, refer to [website](http://narkoz.github.io/gitlab).
 
 ## License

data/lib/gitlab/cli.rb

@@ -1,6 +1,7 @@
 require 'gitlab'
 require 'terminal-table/import'
 require_relative 'cli_helpers'
+require_relative 'shell'
 
 class Gitlab::CLI
   extend Helpers
@@ -23,8 +24,10 @@ class Gitlab::CLI
       puts "Gitlab Ruby Gem #{Gitlab::VERSION}"
     when '-v', '--version'
       puts "Gitlab Ruby Gem #{Gitlab::VERSION}"
+    when 'shell'
+      Gitlab::Shell.start
     else
-      unless Gitlab.actions.include?(cmd.to_sym)
+      unless valid_command?(cmd)
         puts "Unknown command. Run `gitlab help` for a list of available commands."
         exit(1)
       end
@@ -37,21 +40,8 @@ class Gitlab::CLI
 
       confirm_command(cmd)
 
-      begin
-        data = args.any? ? Gitlab.send(cmd, *command_args) : Gitlab.send(cmd)
-      rescue => e
-        puts e.message
-        exit(1)
-      end
-
-      case data
-      when Gitlab::ObjectifiedHash
-        puts single_record_table(data, cmd, args)
-      when Array
-        puts multiple_record_table(data, cmd, args)
-      else
-        puts data.inspect
-      end
+      data = gitlab_helper(cmd, command_args) { exit(1) }
+      output_table(cmd, args, data)
     end
   end
 end

data/lib/gitlab/cli_helpers.rb

@@ -25,6 +25,14 @@ class Gitlab::CLI
       end
     end
 
+    # Confirms command is valid.
+    #
+    # @return [Boolean]
+    def valid_command?(cmd)
+      command = cmd.is_a?(Symbol) ? cmd : cmd.to_sym
+      Gitlab.actions.include?(command)
+    end
+
     # Confirms command with a desctructive action.
     #
     # @return [String]
@@ -77,6 +85,20 @@ class Gitlab::CLI
       end
     end
 
+    # Decides which table to use.
+    #
+    # @return [String]
+    def output_table(cmd, args, data)
+      case data
+      when Gitlab::ObjectifiedHash
+        puts single_record_table(data, cmd, args)
+      when Array
+        puts multiple_record_table(data, cmd, args)
+      else
+        puts data.inspect
+      end
+    end
+
     # Table for a single record.
     #
     # @return [String]
@@ -137,5 +159,17 @@ class Gitlab::CLI
         end
       end
     end
+
+    # Helper function to call Gitlab commands with args.
+    def gitlab_helper(cmd, args=[])
+      begin
+        data = args.any? ? Gitlab.send(cmd, *args) : Gitlab.send(cmd)
+      rescue => e
+        puts e.message
+        yield if block_given?
+      end
+
+      data
+    end
   end
 end

data/lib/gitlab/client/projects.rb

@@ -31,6 +31,21 @@ class Gitlab::Client
       get("/projects/#{id}")
     end
 
+    # Gets a list of project events.
+    #
+    # @example
+    #   Gitlab.project_events(42)
+    #   Gitlab.project_events('gitlab')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @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 project_events(project, options={})
+      get("/projects/#{project}/events", :query => options)
+    end
+
     # Creates a new project.
     #
     # @example

data/lib/gitlab/client/repositories.rb

@@ -16,6 +16,20 @@ class Gitlab::Client
     end
     alias_method :repo_tags, :tags
 
+    # Creates a new project repository tag.
+    #
+    # @example
+    #   Gitlab.create_tag(42,'new_tag','master'))
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String]  tag_name The name of the new tag.
+    # @param  [String]  ref The ref (commit sha, branch name, or another tag) the tag will point to.
+    # @return [Gitlab::ObjectifiedHash]
+    def create_tag(project, tag_name, ref)
+      post("/projects/#{project}/repository/tags", body: {tag_name: tag_name, ref: ref})
+    end
+    alias_method :repo_create_tag, :create_tag
+
     # Gets a list of project commits.
     #
     # @example

data/lib/gitlab/help.rb

@@ -0,0 +1,44 @@
+require 'gitlab'
+require 'gitlab/cli_helpers'
+
+module Gitlab::Help
+  extend Gitlab::CLI::Helpers
+
+  def self.get_help(methods,cmd=nil)
+    help = ''
+
+    if cmd.nil? || cmd == 'help'
+      help = actions_table
+    else
+      ri_cmd = `which ri`.chomp
+
+      if $? == 0
+        namespace = methods.select {|m| m[:name] === cmd }.map {|m| m[:owner]+'.'+m[:name] }.shift
+
+        if namespace
+          begin
+            ri_output = `#{ri_cmd} -T #{namespace} 2>&1`.chomp
+
+            if $? == 0
+              ri_output.gsub!(/#{cmd}\((.*)\)/, cmd+' \1')
+              ri_output.gsub!(/Gitlab\./, 'gitlab> ')
+              ri_output.gsub!(/Gitlab\..+$/, '')
+              ri_output.gsub!(/\,/, '')
+              help = ri_output
+            else
+              help = "Ri docs not found for #{namespace}, please install the docs to use 'help'"
+            end
+          rescue => e
+            puts e.message
+          end
+        else
+          help = "Unknown command: #{cmd}"
+        end
+      else
+        help = "'ri' tool not found in your PATH, please install it to use the help."
+      end
+    end
+
+    puts help
+  end
+end

data/lib/gitlab/shell.rb

@@ -0,0 +1,49 @@
+require 'gitlab'
+require 'gitlab/help'
+require 'gitlab/cli_helpers'
+require 'readline'
+
+class Gitlab::Shell
+  extend Gitlab::CLI::Helpers
+
+  def self.start
+    actions = Gitlab.actions
+
+    comp = proc { |s| actions.map(&:to_s).grep(/^#{Regexp.escape(s)}/) }
+
+    Readline.completion_proc = comp
+    Readline.completion_append_character = ' '
+
+    client = Gitlab::Client.new(endpoint: '')
+
+    while buf = Readline.readline("gitlab> ", true)
+      next if buf.nil? || buf.empty?
+      buf = buf.split.map(&:chomp)
+      cmd = buf.shift
+      args = buf.count > 0 ? buf : []
+
+      if cmd == 'help'
+        methods = []
+
+        actions.each do |action|
+          methods << {
+            name: action.to_s,
+            owner: client.method(action).owner.to_s
+          }
+        end
+
+        args[0].nil? ? Gitlab::Help.get_help(methods) : Gitlab::Help.get_help(methods, args[0])
+        next
+      end
+
+      data = if actions.include?(cmd.to_sym)
+        confirm_command(cmd)
+        gitlab_helper(cmd, args)
+      else
+        "'#{cmd}' is not a valid command.  See the 'help' for a list of valid commands."
+      end
+
+      output_table(cmd, args, data)
+    end
+  end
+end

data/lib/gitlab/version.rb

@@ -1,3 +1,3 @@
 module Gitlab
-  VERSION = "3.1.0"
+  VERSION = "3.2.0"
 end

data/spec/fixtures/project_events.json

@@ -0,0 +1 @@
+[{"title":null,"project_id":2,"action_name":"opened","target_id":null,"target_type":null,"author_id":1,"data":{"before":"ac0c1aa3898d6dea54d7868ea6f9c45fd5e30c59","after":"66350dbb62a221bc619b665aef3e1e7d3b306747","ref":"refs/heads/master","user_id":1,"user_name":"Administrator","project_id":2,"repository":{"name":"gitlab-ci","url":"git@demo.gitlab.com:gitlab/gitlab-ci.git","description":"Continuous integration server for gitlabhq | Coordinator","homepage":"http://demo.gitlab.com/gitlab/gitlab-ci"},"commits":[{"id":"8cf469b039931bab37bbf025e6b69287ea3cfb0e","message":"Modify screenshot\n\nSigned-off-by: Dmitriy Zaporozhets \u003Cdummy@gmail.com\u003E","timestamp":"2014-05-20T10:34:27+00:00","url":"http://demo.gitlab.com/gitlab/gitlab-ci/commit/8cf469b039931bab37bbf025e6b69287ea3cfb0e","author":{"name":"Dummy","email":"dummy@gmail.com"}},{"id":"66350dbb62a221bc619b665aef3e1e7d3b306747","message":"Edit some code\n\nSigned-off-by: Dmitriy Zaporozhets \u003Cdummy@gmail.com\u003E","timestamp":"2014-05-20T10:35:15+00:00","url":"http://demo.gitlab.com/gitlab/gitlab-ci/commit/66350dbb62a221bc619b665aef3e1e7d3b306747","author":{"name":"Dummy","email":"dummy@gmail.com"}}],"total_commits_count":2},"target_title":null,"created_at":"2014-05-20T10:35:26.240Z"},{"title":null,"project_id":2,"action_name":"opened","target_id":2,"target_type":"MergeRequest","author_id":1,"data":null,"target_title":"    Morbi et cursus leo. Sed eget vestibulum sapien","created_at":"2014-05-20T10:24:11.917Z"}]

data/spec/fixtures/tag.json

@@ -0,0 +1 @@
+{"name": "v1.0.0","commit": {"id": "2695effb5807a22ff3d138d593fd856244e155e7","parents": [],"message": "Initial commit","authored_date": "2012-05-28T04:42:42-07:00","author_name": "John Smith","author email": "john@example.com","committer_name": "Jack Smith","committed_date": "2012-05-28T04:42:42-07:00","committer_email": "jack@example.com"},"protected": false}

data/spec/gitlab/client/issues_spec.rb

@@ -30,7 +30,7 @@ describe Gitlab::Client do
 
       it "should return an array of user's issues" do
         expect(@issues).to be_an Array
-        expect(@issues.first.closed).to be_false
+        expect(@issues.first.closed).to be_falsey
         expect(@issues.first.author.name).to eq("John Smith")
       end
     end

data/spec/gitlab/client/projects_spec.rb

@@ -34,6 +34,26 @@ describe Gitlab::Client do
     end
   end
 
+  describe ".project_events" do
+    before do
+      stub_get("/projects/2/events", "project_events")
+      @events = Gitlab.project_events(2)
+    end
+
+    it "should get the correct resource" do
+      expect(a_get("/projects/2/events")).to have_been_made
+    end
+
+    it "should return an array of events" do
+      expect(@events).to be_an Array
+      expect(@events.size).to eq(2)
+    end
+
+    it "should return the action name of the event" do
+      expect(@events.first.action_name).to eq("opened")
+    end
+  end
+
   describe ".create_project" do
     before do
       stub_post("/projects", "project")

data/spec/gitlab/client/repositories_spec.rb

@@ -2,6 +2,7 @@ require 'spec_helper'
 
 describe Gitlab::Client do
   it { should respond_to :repo_tags }
+  it { should respond_to :repo_create_tag }
   it { should respond_to :repo_branches }
   it { should respond_to :repo_branch }
   it { should respond_to :repo_commits }
@@ -24,6 +25,21 @@ describe Gitlab::Client do
     end
   end
 
+  describe ".create_tag" do
+    before do
+      stub_post("/projects/3/repository/tags", "tag")
+      @tag = Gitlab.create_tag(3, 'v1.0.0', '2695effb5807a22ff3d138d593fd856244e155e7')
+    end
+
+    it "should get the correct resource" do
+      expect(a_post("/projects/3/repository/tags")).to have_been_made
+    end
+
+    it "should return information about a new repository tag" do
+      expect(@tag.name).to eq("v1.0.0")
+    end
+  end
+
   describe ".commits" do
     before do
       stub_get("/projects/3/repository/commits", "project_commits").

data/spec/gitlab/objectified_hash_spec.rb

@@ -17,7 +17,7 @@ describe Gitlab::ObjectifiedHash do
     end
 
     it "should have an alias #to_h" do
-      expect(@oh.respond_to?(:to_h)).to be_true
+      expect(@oh.respond_to?(:to_h)).to be_truthy
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Nihad Abbasov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-22 00:00:00.000000000 Z
+date: 2014-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -114,8 +114,10 @@ files:
 - lib/gitlab/client/users.rb
 - lib/gitlab/configuration.rb
 - lib/gitlab/error.rb
+- lib/gitlab/help.rb
 - lib/gitlab/objectified_hash.rb
 - lib/gitlab/request.rb
+- lib/gitlab/shell.rb
 - lib/gitlab/version.rb
 - spec/fixtures/branch.json
 - spec/fixtures/branches.json
@@ -145,6 +147,7 @@ files:
 - spec/fixtures/project_commit_diff.json
 - spec/fixtures/project_commits.json
 - spec/fixtures/project_delete_key.json
+- spec/fixtures/project_events.json
 - spec/fixtures/project_for_user.json
 - spec/fixtures/project_fork_link.json
 - spec/fixtures/project_hook.json
@@ -161,6 +164,7 @@ files:
 - spec/fixtures/system_hook.json
 - spec/fixtures/system_hook_test.json
 - spec/fixtures/system_hooks.json
+- spec/fixtures/tag.json
 - spec/fixtures/team_member.json
 - spec/fixtures/team_members.json
 - spec/fixtures/unprotect_branch.json
@@ -235,6 +239,7 @@ test_files:
 - spec/fixtures/project_commit_diff.json
 - spec/fixtures/project_commits.json
 - spec/fixtures/project_delete_key.json
+- spec/fixtures/project_events.json
 - spec/fixtures/project_for_user.json
 - spec/fixtures/project_fork_link.json
 - spec/fixtures/project_hook.json
@@ -251,6 +256,7 @@ test_files:
 - spec/fixtures/system_hook.json
 - spec/fixtures/system_hook_test.json
 - spec/fixtures/system_hooks.json
+- spec/fixtures/tag.json
 - spec/fixtures/team_member.json
 - spec/fixtures/team_members.json
 - spec/fixtures/unprotect_branch.json