gitlab_cli 2.0.0

data/gitlab_cli.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gitlab_cli/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "gitlab_cli"
+  gem.version       = GitlabCli::VERSION
+  gem.authors       = ["Drew Blessing"]
+  gem.email         = ["drew.blessing@buckle.com"]
+  gem.description   = %q{Gitlab Command Line Tool}
+  gem.summary       = %q{Many people prefer to work from the CLI when possible. This tool aims to bring some of the GitLab functionality into the CLI to avoid repeated trips to the web UI}
+  gem.homepage      = "https://github.com/drewblessing/gitlab-cli"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency "thor", [">= 0.17.0", "<0.19"]
+  gem.add_runtime_dependency "json", "~> 1.7.7"
+  gem.add_runtime_dependency "rest-client", "~> 1.6.7"
+end

data/lib/gitlab_cli.rb

@@ -0,0 +1,36 @@
+require 'yaml'
+
+module GitlabCli
+  class << self
+    attr_accessor :ui
+  end
+  
+  autoload :Command,          'gitlab_cli/command'
+  autoload :Config,           'gitlab_cli/config'
+  autoload :Project,          'gitlab_cli/project'
+  autoload :Snippet,          'gitlab_cli/snippet'
+  autoload :User,             'gitlab_cli/user'
+  autoload :UI,               'gitlab_cli/ui'
+  autoload :Util,             'gitlab_cli/util'
+  autoload :Version,          'gitlab_cli/version'
+
+  GitlabCli.ui = STDOUT.tty? ? GitlabCli::UI::Color.new : GitlabCli::UI::Basic.new
+
+  CONFIG_PATH = '~/.gitlab.yml'
+  config = File.expand_path(CONFIG_PATH)
+  unless File.exist?(config)
+    File.open(File.expand_path(File.dirname(__FILE__) + "/../config.yml.sample", "r") )do |sample|
+      GitlabCli.ui.error "Could not find a config file. Create a config file, '#{CONFIG_PATH}', from the following sample config"
+      GitlabCli.ui.error "=" * 15 + " BEGIN (Do not copy this line) " + "=" * 15, :cyan
+      while (line = sample.gets)
+        GitlabCli.ui.error line, :white, false
+      end
+      GitlabCli.ui.error "=" * 15 + " END (Do not copy this line) " + "=" * 15, :cyan
+    end
+    exit(-1)
+  end
+  GitlabCli::Config.load(config)
+
+  # 3rd Party Gems
+  autoload :Shellwords,       'shellwords'
+end

data/lib/gitlab_cli/cli.rb

@@ -0,0 +1,94 @@
+require 'thor'
+require 'gitlab_cli'
+require 'gitlab_cli/version'
+
+module GitlabCli
+  class CLI < Thor
+    map "-v" => "version" 
+    map "--version" => "version"
+
+    desc "--version", "print version"
+    long_desc <<-D
+      Print the Gitlab CLI tool version
+    D
+    def version
+      GitlabCli.ui.info "Gitlab CLI version %s" % [GitlabCli::VERSION]
+    end
+
+    desc "projects [OPTIONS]", "list projects"
+    long_desc <<-D
+      Get a list of projects.  List will only include projects for which you have at least view privileges.\n
+    D
+    option :nopager, :desc => "Turn OFF pager output one time for this command", :required => false, :type => :boolean
+    option :pager, :desc => "Turn ON pager output one time for this command", :required => false, :type => :boolean
+    def projects
+      if options['pager'] && options['nopager']
+        GitlabCli.ui.error "Cannot specify --nopager and --pager options together. Choose one."
+        exit 1
+      end
+
+      projects = GitlabCli::Util::Projects.get_all
+      formatted_projects = ""
+      pager = ENV['pager'] || 'less'
+
+      projects.each do |p|
+        formatted_projects << "%s:\t%s\n" % [p.id, p.path_with_namespace]
+      end
+      
+      if ((GitlabCli::Config[:display_results_in_pager] && !options['nopager']) || options['pager'])
+        unless system("echo %s | %s" % [Shellwords.escape(formatted_projects), pager])
+          GitlabCli.ui.error "Problem displaying projects in pager"
+          exit 1
+        end
+      else 
+        GitlabCli.ui.info formatted_projects
+      end
+    end
+
+    desc "snippets [PROJECT] [OPTIONS]", "list snippets for a project"
+    long_desc <<-D
+      Get a list of snippets for a particular project. \n
+      
+      [PROJECT] may be specified as [NAMESPACE]/[PROJECT] or [PROJECT_ID].  Use 'gitlab projects' to see a list of projects with their namespace and id.\n
+    D
+    option :nopager, :desc => "Turn OFF pager output one time for this command", :required => false, :type => :boolean
+    option :pager, :desc => "Turn ON pager output one time for this command", :required => false, :type => :boolean
+    def snippets(project)
+      if options['pager'] && options['nopager']
+        GitlabCli.ui.error "Cannot specify --nopager and --pager options together. Choose one."
+        exit 1
+      end
+
+      snippets = GitlabCli::Util::Snippets.get_all(project)
+      formatted_snippets = ""
+      pager = ENV['pager'] || 'less'
+
+      snippets.each do |s|
+        formatted_snippets << "%s:\t%s - %s\n" % [s.id, s.title, s.file_name]
+      end
+      GitlabCli.ui.info "This project does not have any snippets.\n" if snippets.size == 0
+
+      if ((GitlabCli::Config[:display_results_in_pager] && !options['nopager']) || options['pager'])
+        unless system("echo %s | %s" % [Shellwords.escape(formatted_snippets), pager])
+          GitlabCli.ui.error "Problem displaying snippets in pager"
+          exit 1
+        end
+      else 
+        GitlabCli.ui.info formatted_snippets
+      end
+
+    end
+
+    desc "snippet [SUBCOMMAND]", "perform an action on a snippet"
+    long_desc <<-D
+      Perform an action on a snippet. To see available subcommands use 'gitlab snippet help.'
+    D
+    subcommand "snippet", GitlabCli::Command::Snippet
+
+    desc "project [SUBCOMMAND]", "perform an action on a project"
+    long_desc <<-D
+      Perform an action on a project. To see available subcommands use 'gitlab project help.' 
+    D
+    subcommand "project", GitlabCli::Command::Project
+  end
+end

data/lib/gitlab_cli/command.rb

@@ -0,0 +1,9 @@
+module GitlabCli
+  module Command
+    autoload :Project,             'gitlab_cli/command/project'
+    autoload :Snippet,             'gitlab_cli/command/snippet'
+
+    autoload :Time,                'time'
+  end
+end
+

data/lib/gitlab_cli/command/project.rb

@@ -0,0 +1,35 @@
+module GitlabCli
+  module Command
+    class Project < Thor
+      def self.banner(task, namespace = true, subcommand = true)
+        "#{basename} #{task.formatted_usage(self, true, subcommand)}"
+      end
+
+      ## INFO
+      desc "info [PROJECT]", "view detailed info for a project"
+      long_desc <<-D
+        View detailed information about a project.\n
+        [PROJECT] may be specified as [NAMESPACE]/[PROJECT] or [PROJECT_ID].  Use 'gitlab projects' to see a list of projects with their namespace and id.
+      D
+      def info(project)
+        project = GitlabCli::Util::Project.get(project)
+
+        ui = GitlabCli.ui
+
+        ui.info "Project ID: %s" % [project.id]
+        ui.info "Name: %s" % [project.name]
+        ui.info "Path w/ Namespace: %s" % [project.path_with_namespace]
+        ui.info "Project URL: %s" % [project.project_url]
+        ui.info "Description: %s" % [project.description.nil? || project.description.empty? ? "N/A" : project.description]
+        ui.info "Default Branch: %s" % [project.default_branch.nil? ? "N/A" : project.default_branch]
+        ui.info "Owner: %s <%s>" % [project.owner.name, project.owner.email]
+        ui.info "Public?: %s" % [project.public.to_s]
+        ui.info "Issues enabled?: %s" % [project.issues_enabled.to_s]
+        ui.info "Merge Requests enabled?: %s" % [project.merge_requests_enabled.to_s]
+        ui.info "Wall enabled?: %s" % [project.wall_enabled.to_s]
+        ui.info "Wiki enabled?: %s" % [project.wiki_enabled.to_s]
+        ui.info "Created at: %s" % [Time.parse(project.created_at)]
+      end
+    end
+  end
+end

data/lib/gitlab_cli/command/snippet.rb

@@ -0,0 +1,134 @@
+module GitlabCli
+  module Command
+    class Snippet < Thor
+  map "save" => "download"
+
+  def self.banner(task, namespace = true, subcommand = true)
+    "#{basename} #{task.formatted_usage(self, true, subcommand)}"
+  end
+  
+  # ADD
+  desc "add [PROJECT] [FILE] [OPTIONS]", "add a snippet"
+  long_desc <<-D
+    Add a snippet to a project.  You may specify a file to create a snippet from or you may pipe content from cat.
+    [PROJECT] may be specified as [NAMESPACE]/[PROJECT] or [PROJECT_ID].  Use 'gitlab projects' to see a list of projects with their namespace and id.
+   
+    $ gitlab snippet add namespace/project file1.txt
+
+    $ cat file1.txt | gitlab snippet add namespace/project
+  D
+  option :title, :desc => "The title to use for the new snippet", :required => true, :type => :string, :aliases => ["-t"]
+  option :file_name, :desc => "A file name for this snippet", :required => true, :type => :string, :aliases => ["-n", "-f"]  
+  def add(project, file=nil)
+    snippet = GitlabCli::Util::Snippet.create(project, options['title'], options['file_name'], file)
+
+    GitlabCli.ui.success "Snippet created."
+    GitlabCli.ui.info "ID: %s" % [snippet.id]
+    GitlabCli.ui.info "URL: %s" % [snippet.view_url]
+  end 
+
+  ## VIEW
+  desc "view [PROJECT] [SNIPPET_ID]", "view a snippet"
+  long_desc <<-D
+    View the content of a snippet. Content will be displayed in the default pager or in "less."
+
+    [PROJECT] may be specified as [NAMESPACE]/[PROJECT] or [PROJECT_ID].  Use 'gitlab projects' to see a list of projects with their namespace and id. [SNIPPET_ID] must be specified as the id of the snippet.  Use 'gitlab snippets [PROJECT]' command to view the snippets available for a project.
+
+    $ gitlab snippet view namespace/project 6
+
+    $ gitlab snippet view 10 6
+  D
+  def view(project, snippet)
+    snippet = GitlabCli::Util::Snippet.view(project, snippet)    
+
+    pager = ENV['pager'] || 'less'
+
+    unless system("echo %s | %s" % [Shellwords.escape(snippet), pager])
+      GitlabCli.ui.error "Problem displaying snippet"
+      exit 1
+    end
+  end
+
+  ## EDIT
+  desc "edit [PROJECT] [SNIPPET_ID]", "edit a snippet"
+  long_desc <<-D
+    Edit a snippet. Snippet will open in your default text editor or in "vi." 
+
+    [PROJECT] may be specified as [NAMESPACE]/[PROJECT] or [PROJECT_ID].  Use 'gitlab projects' to see a list of projects with their namespace and id. [SNIPPET_ID] must be specified as the id of the snippet.  Use 'gitlab snippets [PROJECT]' command to view the snippets available for a project.
+
+    $ gitlab snippet edit namespace/project 6
+
+    $ gitlab snippet edit 10 6
+  D
+  def edit(project, snippet)
+    snippet_obj = GitlabCli::Util::Snippet.get(project, snippet)
+    snippet_code = GitlabCli::Util::Snippet.view(project, snippet)
+
+    editor = ENV['editor'] || 'vi'
+
+    temp_file_path = "/tmp/snippet.%s" % [rand]
+    File.open(temp_file_path, 'w') { |file| file.write(snippet_code) }
+
+    system("vi %s" % [temp_file_path])
+
+    snippet_code = File.read(temp_file_path)
+
+    snippet = GitlabCli::Util::Snippet.update(project, snippet_obj, snippet_code)
+    GitlabCli.ui.success "Snippet updated."
+    GitlabCli.ui.info "URL: %s" % [snippet.view_url]
+  end
+
+  ## DELETE
+  desc "delete [PROJECT] [SNIPPET_ID]", "delete a snippet"
+  long_desc <<-D
+    Delete a snippet. \n
+    [PROJECT] may be specified as [NAMESPACE]/[PROJECT] or [PROJECT_ID].  Use 'gitlab projects' to see a list of projects with their namespace and id. [SNIPPET_ID] must be specified as the id of the snippet.  Use 'gitlab snippets [PROJECT]' command to view the snippets available for a project.
+
+    $ gitlab snippet delete namespace/project 6
+
+    $ gitlab snippet delete 10 6
+  D
+   option :yes, :desc => "Delete without asking for confirmation", :required => false, :type => :boolean, :aliases => ["-y"]  
+  def delete(project, snippet)
+    response = GitlabCli.ui.yes? "Are you sure you want to delete this snippet? (Yes\\No)" unless options['yes']
+    exit unless options['yes'] || response
+
+    snippet = GitlabCli::Util::Snippet.delete(project, snippet)
+
+    GitlabCli.ui.success "Successfully deleted the snippet."
+  end
+
+  ## INFO
+  desc "info [PROJECT] [SNIPPET_ID]", "view detailed info for a snippet"
+  long_desc <<-D
+    View detailed information about a snippet.\n
+    [PROJECT] may be specified as [NAMESPACE]/[PROJECT] or [PROJECT_ID].  Use 'gitlab projects' to see a list of projects with their namespace and id. [SNIPPET_ID] must be specified as the id of the snippet.  Use 'gitlab snippets [PROJECT]' command to view the snippets available for a project.
+  D
+  def info(project, snippet)
+    snippet = GitlabCli::Util::Snippet.get(project, snippet)
+
+    ui = GitlabCli.ui
+
+    ui.info "Snippet ID: %s" % [snippet.id]
+    ui.info "Title: %s" % [snippet.title]
+    ui.info "File Name: %s" % [snippet.file_name]
+    ui.info "Author: %s <%s>" % [snippet.author.name, snippet.author.email]
+    ui.info "Created at: %s" % [Time.parse(snippet.created_at)]
+    ui.info "Updated at: %s" % [Time.parse(snippet.updated_at)]
+    ui.info "Expires at: %s" % [snippet.expires_at.nil? ? "Never" : Time.parse(snippet.expires_at)]
+  end
+
+  ## DOWNLOAD
+  desc "download|save [PROJECT] [SNIPPET_ID] [FILE]", "download/save a snippet locally"
+  long_desc <<-D
+    Download/Save the contents of a snippet in a local file\n
+    [PROJECT] may be specified as [NAMESPACE]/[PROJECT] or [PROJECT_ID].  Use 'gitlab projects' to see a list of projects with their namespace and id. [SNIPPET_ID] must be specified as the id of the snippet.  Use 'gitlab snippets [PROJECT]' command to view the snippets available for a project.
+  D
+  def download(project, snippet, file_path)
+    snippet = GitlabCli::Util::Snippet.download(project, snippet, file_path)
+
+    GitlabCli.ui.success "Snippet file saved successfully.\n"
+  end
+end
+end
+end

data/lib/gitlab_cli/config.rb

@@ -0,0 +1,31 @@
+module GitlabCli
+  class Config
+    class << self
+      def load(source)
+        @config = {:gitlab_url => nil,:private_token => nil,:display_results_in_pager => false}
+
+        if source.is_a?(String)
+          raise "Config file #{source} not found" unless File.exist?(source)
+  
+          config = YAML.load_file(source)
+          @config.merge! config if config
+
+        elsif source.is_a?(Hash)
+          @config.merge! source
+        end
+      end
+
+      def include?(key)
+        @config.include?(key)
+      end
+
+      def [](key)
+        @config[key]
+      end
+
+      def to_yaml
+        @config.to_yaml
+      end
+    end
+  end
+end

data/lib/gitlab_cli/project.rb

@@ -0,0 +1,35 @@
+module GitlabCli
+  class Project
+    attr_accessor :id, :name, :description, :default_branch, :public, :path, :path_with_namespace, :issues_enabled, :merge_requests_enabled, :wall_enabled, :wiki_enabled, :created_at, :project_url, :owner
+
+    def initialize(id, name, description, default_branch, public, path, path_with_namespace, issues_enabled, merge_requests_enabled, wall_enabled, wiki_enabled, created_at, owner=nil)
+      @id = id
+      @name = name
+      @description = description
+      @default_branch = default_branch
+      @public = public
+      @path = path
+      @path_with_namespace = path_with_namespace
+      @issues_enabled = issues_enabled
+      @merge_requests_enabled = merge_requests_enabled
+      @wall_enabled = wall_enabled 
+      @wiki_enabled = wiki_enabled
+      @created_at = created_at
+      @project_url = get_project_url
+
+      @owner = owner.class == 'Gitlab::User' || owner.nil? ? owner : parse_owner(owner)
+    end
+
+    private
+    def get_project_url
+      URI.join(GitlabCli::Config[:gitlab_url],@path_with_namespace)
+    end    
+
+    private
+    def parse_owner(owner)
+      GitlabCli::User.new(owner['id'],owner['username'],owner['email'],owner['name'],owner['blocked'],owner['created_at'])
+    end
+    
+  end
+end
+

data/lib/gitlab_cli/snippet.rb

@@ -0,0 +1,31 @@
+module GitlabCli
+  class Snippet
+    attr_accessor :id, :title, :file_name, :expires_at, :updated_at, :created_at, :project_id, :view_url, :author
+
+    def initialize(id, title, file_name, expires_at, updated_at, created_at, project_id, author=nil)
+      @id = id
+      @title = title
+      @file_name = file_name
+      @expires_at = expires_at
+      @updated_at = updated_at
+      @created_at = created_at
+
+      @project_id = project_id
+      @view_url = get_view_url
+
+      @author = author.class == 'Gitlab::User' || author.nil? ? author : parse_author(author)
+    end
+
+    private
+    def get_view_url
+      project_path_with_namespace = GitlabCli::Util::Project.get_project_path_with_namespace(@project_id)
+      URI.join(GitlabCli::Config[:gitlab_url],"%s/snippets/%s" % [project_path_with_namespace,@id.to_s])
+    end
+
+    private
+    def parse_author(author)
+      GitlabCli::User.new(author['id'],author['username'],author['email'],author['name'],author['blocked'],author['created_at'])
+    end
+  end
+end
+

data/lib/gitlab_cli/ui.rb

@@ -0,0 +1,98 @@
+require 'thor/shell/basic'
+require 'thor/shell/color'
+
+## Concepts borrowed from Vagrant UI class.
+
+module GitlabCli
+  module UI
+    class Interface
+      #[:ask, :warn, :error, :info, :success].each do |method|
+      #  define_method(method) do |message, *opts|
+      #    # Log normal console messages
+      #    @logger.info { "#{method}: #{message}" }
+      #  end
+      #end
+    end
+
+    class Basic < Interface
+      def initialize
+        #super
+        
+        @shell = Thor::Shell::Basic.new
+      end
+      
+      # Use some light meta-programming to create the various methods to
+      # output text to the UI. These all delegate the real functionality
+      # to `say`.
+      [:info, :warn, :error, :success].each do |method|
+        class_eval <<-CODE
+          def #{method}(message)
+            #super(message)
+            @shell.say(message)
+          end
+        CODE
+      end
+
+      def ask(message, opts=nil)
+        #super(message)
+
+        # We can't ask questions when the output isn't a TTY.
+        #raise Errors::UIExpectsTTY if !$stdin.tty? && !Vagrant::Util::Platform.cygwin?
+
+        # Setup the options so that the new line is suppressed
+        #opts ||= {}
+        #opts[:new_line] = false if !opts.has_key?(:new_line)
+        #opts[:prefix]   = false if !opts.has_key?(:prefix)
+
+        # Output the data
+        #@shell.ask(:info, message, opts)
+
+        # Get the results and chomp off the newline. We do a logical OR
+        # here because `gets` can return a nil, for example in the case
+        # that ctrl-D is pressed on the input.
+        @shell.ask message
+      end
+
+      def yes?(message, color=nil)
+        @shell.yes? message, color
+      end
+    end
+
+    class Color < Basic 
+      def initialize
+        #super
+        
+        @shell = Thor::Shell::Color.new
+      end
+
+      # Terminal colors
+      COLORS = {
+        :clear  => "\e[0m",
+        :red    => "\e[31m",
+        :green  => "\e[32m",
+        :yellow => "\e[33m"
+      }
+
+      # Mapping between type of message and the color to output
+      COLOR_MAP = {
+        :info    => nil,
+        :warn    => :yellow,
+        :error   => :red,
+        :success => :green
+      }
+
+      # Use some light meta-programming to create the various methods to
+      # output text to the UI. These all delegate the real functionality
+      # to `say`.
+      [:info, :warn, :error, :success].each do |method|
+        class_eval <<-CODE
+          def #{method}(message,color=nil,force_new_line = (message.to_s !~ /( |\t)\Z/))
+            say_color = color.nil? ? COLOR_MAP[:#{method}] : color
+            #super(message)
+            @shell.say(message,say_color,force_new_line)
+          end
+        CODE
+      end
+    end
+  end
+end