gitlab_cli 2.0.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp
+config.yml

data/CHANGELOG

@@ -0,0 +1,41 @@
+2013-05-12 Drew Blessing
+  * Issue 19: Utilize Thor actions
+  * Issue 25: Change from ~/.gitlab.yml to ~/.gitlab_cli.yml
+
+2013-05-09 Drew Blessing
+  * Pull Request 23: Add an user friendly message for 'config missing'. PR submitted by genewoo.
+  * Issue 24: Throw error when passing a invlid project id. Issue submitted by genewoo.
+
+2013-05-08 Drew Blessing
+  * Issue 13: Refactor to support a gitlab cli gem
+  * Issue 17: Create a config file in $HOME folder instead of using config.yml
+  * Issue 18: Refactor util class
+  * Issue 20: Add dependencies to gemspec
+  * Issue 21: Test across multiple OS's
+
+2013-04-24 Drew Blessing
+  * Issue 16: display_results_in_pager still defaults `true` in config class
+  * Version 1.1.1: Tag version 1.1.1
+
+2013-04-23 Drew Blessing
+  * Pull Request 14: Fix bug with project description. PR submitted by Jiwoong.
+  * Issue 9: Add `project info` command to README
+  * Issue 10: Test against 5.1
+  * Issue 11: `projects` command only shows 20 projects, no options to paginate. Issue submitted by weisjohn.
+  * Issue 15: Don't need to `inspect` snippet content.
+  * Version 1.1.0: Tag version 1.1.0 (No default behavior was altered. New features implemented)
+
+2013-04-22 Drew Blessing
+  * Issue 10: Test against Gitlab 5.1
+  * Version 1.0.0: Tag version 1.0.0
+
+2013-04-21  Drew Blessing
+  * Issue 3: Add option to save a snippet file locally
+  * Issue 4: Fix subcommand usage print out
+  * Issue 5: Improve examples in README
+  * Issue 6: Move project setup to top of README
+  * Issue 7: Improve error handling for times when Gitlab is not accessible
+  * Issue 8: Fix regression introduced in commit 4b5397dfce9af738156e8343dbca4bba56fc84d1
+
+2013-04-19  Drew Blessing 
+  * Initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gitlab_cli.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Drew Blessing
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+# _GitLab CLI Tool_
+
+_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. At this time the tool only allows interaction with snippets._
+
+## Version 2.0.0 
+
+This version contains breaking changes!!
+
+* Now packaged as a gem! 
+* Configuration file loaded from user's home directory - ~/.gitlab.yml
+* Easier to use within your Ruby scripts/applications (see "Use as a library")
+
+## GitLab Versions
+
+This tool has only been tested with the following versions of GitLab.  Some or all of the features may or may not work with other versions but they are not _officially_ supported.
+
+* 5.1.0
+* 5.0.x
+
+## Installation and Setup 
+
+_How do I get started?_ 
+
+Install from rubygems (Recommended)
+
+1. _`gem install gitlab_cli`_
+
+Install from the repo (requires rake and bundler).
+
+1. _Clone the repo._
+2. _`rake build`_
+3. _`rake install` (Requires root privileges)._
+
+You now have access to the `gitlab` command.
+
+_Required Gems_
+
+If you install from rubygems then you will not need to install these required gems yourself. The gem package manager will attempt to install the proper versions for you.
+
+1. thor >= 0.17.0 and < 0.19
+2. json >= 1.7.7 and < 1.8
+3. rest-client >= 1.6.7 and < 1.7
+
+Note for Linux users: You may need to install the `ruby-devel` package via YUM if you receive an error on install.  The error you would see is:
+
+```
+Building native extensions.  This could take a while...
+ ERROR: Failed to build gem native extension.
+
+/usr/bin/ruby extconf.rb
+mkmf.rb can't find header files for ruby at /usr/lib/ruby/ruby.h
+
+
+Gem files will remain installed in /usr/lib/ruby/gems/1.8/gems/json-1.7.7 for inspection.
+Results logged to /usr/lib/ruby/gems/1.8/gems/json-1.7.7/ext/json/ext/generator/gem_make.out
+```
+
+_How can I find the private token for my user?_
+
+Login to your GitLab web UI, go to 'My Profile', and select the 'Account' tab.  Copy the private token from the box and paste into your config.  
+
+_How can I add the repo bin path to my environment PATH variable?_
+
+Place it in your ~/.bash_profile file.  You should end up with something like this:
+`export PATH=$PATH:/path/to/gitlab-cli/repo/bin/`
+
+## How to use (Commands) 
+
+View a list of all the commands you can use to interact with Gitlab CLI, complete with examples.
+
+[Commands](doc/Commands.md)
+
+## Use as a library
+
+Now that Gitlab CLI is distributed as a gem it is increasingly easy to use in your Ruby scripts or applications.  Click the link below to see documentation on how to get started using Gitlab CLI as a library.
+
+[Use as a library](doc/Library.md)
+
+## Issues
+
+If you encounter issues with this project, please find help via one of these avenues.
+
+1. _IRC: #gitlab on Freenode - nick dblessing_
+2. _GitHub Issues: Open a new issue here on GitHub_
+
+## Contributing changes
+
+I welcome all contributions.  If you would like to include a new feature or bug fix, simply open a pull request and explain the problem or feature you contributed. I will review the contribution at that point.  If you want to discuss fixes or improvements before submitting a pull request, please find me on IRC #gitlab on Freenode or open a GitHub issue.
+
+## License
+See LICENSE file.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/gitlab

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'gitlab_cli/cli'
+
+GitlabCli::CLI.start

data/config.yml.sample

@@ -0,0 +1,11 @@
+---
+:gitlab_url: https://gitlab.example.com
+
+# Found in My Profile -> Account -> Private token
+:private_token: super_secret_key_from_gitlab
+
+# Whether or not to display potentially lengthy
+# results in the system pager (i.e. 'less').  
+# Default: false (to maintain original behavior)
+# Recommended setting: true
+:display_results_in_pager: false

data/doc/Classes.md

@@ -0,0 +1,39 @@
+## Util Classes and Methods
+
+The 'util' classes are what you should use to interact with Gitlab CLI as a library. 
+
+### _Projects_
+
+GitlabCLI::Util::Projects
+
+\#get_all - Returns an array of Project objects.
+
+### _Project_
+
+GitlabCLI::Util::Project
+
+\#get(project) - When given a project ID/full path with namespace, returns a Project object.
+
+\#get_project_path_with_namespace(project_id) - When given a project ID, returns the full path with namespace.
+
+### _Snippets_
+
+GitlabCLI::Utils::Snippets
+
+\#get_all(project) - When given a project ID/full path with namespace, returns an array of Snippet objects.
+
+### _Snippet_
+
+GitlabCLI::Util::Snippet
+
+\#get(project, snippet) - When given a project ID/full path with namespace and a snippet ID, returns a Snippet object.
+
+\#create(project, title, file_name, code) - When given a project ID/full path with namespace, title, file name string, and code body, creates a snippet and returns a Snippet object.
+
+\#view(project, snippet) - When given a project ID/full path with namespace and a snippet ID, returns raw snippet content.
+
+\#update(project, snippet, content) - When given a project ID/full path with namespace, snippet ID, and code body, updates a snippet\'s content and returns a Snippet object.
+
+\#delete(project, snippet) - When given a project ID/full path with namespace and a snippet ID, deletes a snippet.
+
+\#download(project, snippet, file_path) - When given a project ID/full path with namespace, snippet ID, and a local file path, saves a snippet\'s content to the specified file.

data/doc/Commands.md

@@ -0,0 +1,142 @@
+## Commands
+Note: All command results are subject to user authorization.  For example, if the command says it will return all projects it will return all projects...that the user is able to see.
+
+Note2: Anywhere you see [PROJECT] you can either specify the full namespace/project name for the project or you can provide the project ID.  Both can be obtained by running the first command below.
+
+### _List all projects_
+
+Usage: `gitlab projects [OPTIONS]`
+
+Options: `--nopager`, `--pager` to turn paging off or on one time (See note below example output)
+
+Example output:
+```
+3:	globalproject1
+4:	namespace1/project2
+6:	namespace1/project3
+11:	namespace2/project1
+13:	user1/project1
+```
+
+Note: As of v1.1.0, this command can output in the system pager or `less` to improve readability when many results are shown. Set configuration `display_results_in_pager` command to `true` to enable this functionality.
+Use --nopager or --pager to temporarily turn paging off or on respectively.  These options effectively overrides the true/false setting for `display_results_in_pager` configuration setting.
+
+### _View detailed information about a project_
+
+Usage: `gitlab project info [PROJECT]`
+
+Example output:
+```
+Project ID: 3
+Name: My Project
+Path w/ Namespace: namespace1/myproject
+Project URL: https://gitlab.example.com/namespace1/myproject
+Description: This is my awesome repo!
+Default Branch: master
+Owner: Drew Blessing <drew.blessing@example.com>
+Public?: false
+Issues enabled?: false
+Merge Requests enabled?: true
+Wall enabled?: false
+Wiki enabled?: false
+Created at: Mon Apr 01 18:42:38 UTC 2013
+
+```
+
+### _List all snippets for a project_
+
+Usage: `gitlab snippets [PROJECT] [OPTIONS]`
+
+Using project ID: `gitlab snippets 13`
+
+Using project full namespace/project format: `gitlab snippets user1/project1`
+
+Options: `--nopager`, `--pager` to turn paging off or on one time (See note below example output)
+
+Example output:
+```
+2:  Title - Filename
+16:	README - README.md
+```
+
+Note: As of v1.1.0, this command can output in the system pager or `less` to improve readability when many results are shown. Set configuration `display_results_in_pager` command to `true` to enable this functionality.
+Use --nopager or --pager to temporarily turn paging off or on respectively.  These options effectively overrides the true/false setting for `display_results_in_pager` configuration setting.
+
+### _View a snippet (Uses default pager or "less")_
+
+Usage: `gitlab snippet view [PROJECT] [SNIPPET_ID]`
+
+Using project ID: `gitlab snippet view 13 16`
+
+Using project full namespace/project format: `gitlab snippet view user1/project1 16`
+
+### _Edit a snippet (Users default editor or "vi")_
+
+Usage: `gitlab snippet edit [PROJECT] [SNIPPET_ID]`
+
+Using project ID: `gitlab snippet edit 13 16`
+
+Using project full namespace/project format: `gitlab snippet edit user1/project1 16`
+
+Example output:
+```
+Snippet updated.
+ URL: https://gitlab.example.com/user1/project1/snippets/16
+```
+
+### _View detailed information about a snippet_
+
+Usage :`gitlab snippet info [PROJECT] [SNIPPET_ID]`
+
+Using project ID: `gitlab snippet info 13 16`
+
+Using project full namespace/project format: `gitlab snippet info user1/project1 16`
+
+Example output:
+```
+Snippet ID: 16
+Title: README
+File Name: README.md
+Author: John Doe <john.doe@example.com>
+Created at: Fri Apr 19 01:11:08 UTC 2013
+Updated at: Fri Apr 19 01:11:08 UTC 2013
+Expires at: Never
+```
+
+### _Add a snippet_
+
+Usage 1: `gitlab snippet add [PROJECT] [FILE] -t [TITLE] -n [FILE_NAME]`
+
+Usage 2: `cat [FILE] | gitlab snippet add [PROJECT] -t [TITLE] -n [FILE_NAME]`
+
+Using project ID: `gitlab snippet add 13 16 /path/to/file -t "Awesome title" -n file.txt`
+
+Using project full namespace/project format: `gitlab snippet add user1/project1 16 /path/to/file -t "Awesome title" -n file.txt``
+
+Example output:
+```
+Snippet created.
+ID: 20
+URL: https://gitlab.example.com/user1/project1/snippets/20
+```
+
+### _Delete a snippet (Asks for confirmation)_
+Use -y flag to bypass confirmation. Use at your own risk.
+
+Usage: `gitlab snippet delete [PROJECT] [SNIPPET_ID]`
+
+Using project ID: `gitlab snippet delete 13 16`
+
+Using project full namespace/project format: `gitlab snippet delete user1/project1 16`
+
+### _Save a snippet to your local filesystem_
+Note: The "save" subcommand is an alias of "download." Both have the same effect.
+
+Usage 1: `gitlab snippet download [PROJECT] [SNIPPET_ID] [FILE]`
+
+Usage 2: `gitlab snippet save [PROJECT] [SNIPPET_ID] [FILE]`
+
+Using project ID: `gitlab snippet save 13 16 /path/for/new/file`
+
+Using project full namespace/project format: `gitlab snippet download user1/project1 16 /path/for/new/file`
+

data/doc/Library.md

@@ -0,0 +1,35 @@
+## Use as a library
+
+First, require 'gitlab_cli'. 
+
+`require 'gitlab_cli'`
+
+Next, call the appropriate class and method within Gitlab CLI.  You will probably want to stick with calling the Util classes.  They will return objects with all the pertinent information. Below are a few examples of how you may use Gitlab CLI.  For a complete list of classes, methods and objects, please check out the links below.
+
+* [Util Classes and Methods](Classes.md)
+* [Objects](Objects.md)
+
+### _Get all projects in Gitlab_ 
+Returns an array of Project objects
+
+`projects = GitlabCli::Util::Projects.get_all`
+
+Then you can loop through and access any of the Project attributes.
+
+```
+projects.each do |project|
+  puts project.name
+end
+```
+
+### _Get a specific snippet_
+Assumes you know the project id/full namespace and snippet id
+
+`snippet = GitlabCli::Util::Snippet.get(3, 19)`
+
+`snippet = GitlabCli::Util::Snippet.get("namespace/project_name", 19)`
+
+Then you can access any of the Snippet attributes.
+
+`puts snippet.title`
+

data/doc/Objects.md

@@ -0,0 +1,53 @@
+## Objects
+
+### _Project_
+
+GitlabCLI::Project
+
+Attributes:
+
+* id - The numerical ID of the project
+* name - The name of the project
+* description - A long description of the project
+* default_branch - The default branch to display in the interface
+* public - Is the project public? True/False
+* path - The short path for the project
+* path_with_namespace - The full path with namespace for the project
+* issues_enabled - Can issues be created? True/False
+* merge_requests_enabled - Accept merge requests for the project? True/False
+* wall_enabled - Is the wall enabled? True/False
+* wiki_enabled - Is the wiki enabled? True/False
+* created_at - The date/time the project was created
+* project_url - The URL to the project
+* owner - The owner of the project (returns a User object)
+
+### _Snippet_
+
+GitlabCLI::Snippet
+
+* id - The numerical ID of the snippet
+* title - The title of the snippet
+* file_name - The file name for the snippet
+* expires_at - The date/time the snippet is set to expire
+* updated_at - The date/time the snippet was last updated
+* created_at - The date/time the snippet was first created
+* project_id - The ID of the project it is in
+* view_url - The URL to the snippet
+* author - The author of the snippet (returns a User object)
+
+### _User_
+
+GitlabCLI::User
+
+* id - The numerical ID of the user
+* username - The short username of the user
+* email - The email address of the user
+* name - The user\'s full name
+* blocked - Is the user prevented from logging in? True/False
+* created_at - The date/time the user was first created
+* bio - The user\'s bio
+* skype - The user\'s Skype account
+* linkedin - The user\'s LinkedIn account
+* twitter - The user\'s Twitter account
+* extern_uid - The external UID for the user, if the provider is not GitLab
+* provider - The user\'s provider, GitLab/LDAP/OmniAuth