gitlab 2.0.0

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,2 @@
+language: ruby
+rvm: 1.9.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2012 Nihad Abbasov / NARKOZ
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,64 @@
+# Gitlab
+
+Gitlab is a Ruby wrapper for the [GitLab API](https://github.com/gitlabhq/gitlabhq/tree/master/doc/api#gitlab-api).
+
+## Installation
+
+Install it from rubygems:
+
+```sh
+gem install gitlab
+```
+
+Or add to a Gemfile:
+
+```ruby
+gem 'gitlab'
+# gem 'gitlab', :git => 'git://github.com/NARKOZ/gitlab.git'
+```
+
+## Usage
+
+Configuration example:
+
+```ruby
+Gitlab.configure do |config|
+  config.endpoint       = 'https://example.net/api/v2' # 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)
+end
+```
+
+Usage examples:
+
+```ruby
+# set an API endpoint
+Gitlab.endpoint = 'http://example.net/api/v2'
+# => "http://example.net/api/v2"
+
+# set a user private token
+Gitlab.private_token = 'qEsq1pt6HJPaNciie3MG'
+# => "qEsq1pt6HJPaNciie3MG"
+
+# 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"}>]
+
+# initialize a new client
+g = Gitlab.client(:endpoint => 'https://api.example.com', :private_token => 'qEsq1pt6HJPaNciie3MG')
+# => #<Gitlab::Client:0x00000001e62408 @endpoint="https://api.example.com", @private_token="qEsq1pt6HJPaNciie3MG", @user_agent="Gitlab Ruby Gem 2.0.0">
+
+# get a user
+user = g.user
+# => #<Gitlab::ObjectifiedHash:0x00000002217990 @data={"id"=>1, "email"=>"john@example.com", "name"=>"John Smith", "bio"=>nil, "skype"=>"", "linkedin"=>"", "twitter"=>"john", "dark_scheme"=>false, "theme_id"=>1, "blocked"=>false, "created_at"=>"2012-09-17T09:41:56Z"}>
+
+# get a user's email
+user.email
+# => "john@example.com"
+```
+
+For more information, refer to [documentation](http://rubydoc.info/gems/gitlab/frames).
+
+## License
+
+Released under the BSD 2-clause license. See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern    = FileList['spec/**/*_spec.rb']
+  spec.rspec_opts = ['--color', '--format d']
+end
+
+task :default => :spec

data/gitlab.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gitlab/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "gitlab"
+  gem.version       = Gitlab::VERSION
+  gem.authors       = ["Nihad Abbasov"]
+  gem.email         = ["mail@narkoz.me"]
+  gem.description   = %q{Ruby client for GitLab API}
+  gem.summary       = %q{A Ruby wrapper for the GitLab API}
+  gem.homepage      = "https://github.com/narkoz/gitlab"
+
+  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 'httparty'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'webmock'
+end

data/lib/gitlab.rb

@@ -0,0 +1,29 @@
+require File.expand_path('../gitlab/version', __FILE__)
+require File.expand_path('../gitlab/objectified_hash', __FILE__)
+require File.expand_path('../gitlab/configuration', __FILE__)
+require File.expand_path('../gitlab/error', __FILE__)
+require File.expand_path('../gitlab/request', __FILE__)
+require File.expand_path('../gitlab/api', __FILE__)
+require File.expand_path('../gitlab/client', __FILE__)
+
+module Gitlab
+  extend Configuration
+
+  # Alias for Gitlab::Client.new
+  #
+  # @return [Gitlab::Client]
+  def self.client(options={})
+    Gitlab::Client.new(options)
+  end
+
+  # Delegate to Gitlab::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  # Delegate to Gitlab::Client
+  def self.respond_to?(method)
+    return client.respond_to?(method) || super
+  end
+end

data/lib/gitlab/api.rb

@@ -0,0 +1,17 @@
+module Gitlab
+  # @private
+  class API < Request
+    # @private
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API.
+    # @raise [Error:MissingCredentials]
+    def initialize(options={})
+      options = Gitlab.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+      set_request_defaults @endpoint, @private_token
+    end
+  end
+end

data/lib/gitlab/client.rb

@@ -0,0 +1,13 @@
+module Gitlab
+  # Wrapper for the Gitlab REST API.
+  class Client < API
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each{|f| require f}
+
+    include Gitlab::Client::Users
+    include Gitlab::Client::Issues
+    include Gitlab::Client::Milestones
+    include Gitlab::Client::Snippets
+    include Gitlab::Client::Projects
+    include Gitlab::Client::Repositories
+  end
+end

data/lib/gitlab/client/issues.rb

@@ -0,0 +1,69 @@
+class Gitlab::Client
+  # Defines methods related to issues.
+  module Issues
+    # Gets a list of user's issues.
+    # Will return a list of project's issues if project ID or code name passed.
+    #
+    # @example
+    #   Gitlab.issues
+    #   Gitlab.issues(5)
+    #   Gitlab.issues('gitlab', :per_page => 40)
+    #
+    # @param  [Integer, String] project The ID or code 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 issues(project=nil, options={})
+      if project.to_i.zero?
+        get("/issues", :query => options)
+      else
+        get("/projects/#{project}/issues", :query => options)
+      end
+    end
+
+    # Gets a single issue.
+    #
+    # @example
+    #   Gitlab.issue(5, 36)
+    #   Gitlab.issue('gitlab', 42)
+    #
+    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def issue(project, id)
+      get("/projects/#{project}/issues/#{id}")
+    end
+
+    # Creates a new issue.
+    #
+    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [String] title The title of an issue.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :description The description of an issue.
+    # @option options [Integer] :assignee_id The ID of a user to assign issue.
+    # @option options [Integer] :milestone_id The ID of a milestone to assign issue.
+    # @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)
+    end
+
+    # Updates an issue.
+    #
+    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :title The title of an issue.
+    # @option options [String] :description The description of an issue.
+    # @option options [Integer] :assignee_id The ID of a user to assign issue.
+    # @option options [Integer] :milestone_id The ID of a milestone to assign issue.
+    # @option options [String] :labels Comma-separated label names for an issue.
+    # @option options [Boolean] :closed The state of an issue (0 = false, 1 = true).
+    # @return [Gitlab::ObjectifiedHash] Information about updated issue.
+    def edit_issue(project, id, options={})
+      put("/projects/#{project}/issues/#{id}", :body => options)
+    end
+  end
+end

data/lib/gitlab/client/milestones.rb

@@ -0,0 +1,59 @@
+class Gitlab::Client
+  # Defines methods related to milestones.
+  module Milestones
+    # Gets a list of project's milestones.
+    #
+    # @example
+    #   Gitlab.milestones(5)
+    #   Gitlab.milestones('gitlab')
+    #
+    # @param  [Integer, String] project The ID or code 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 milestones(project, options={})
+      get("/projects/#{project}/milestones", :query => options)
+    end
+
+    # Gets a single milestone.
+    #
+    # @example
+    #   Gitlab.milestone(5, 36)
+    #   Gitlab.milestone('gitlab', 42)
+    #
+    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer] id The ID of a milestone.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def milestone(project, id)
+      get("/projects/#{project}/milestones/#{id}")
+    end
+
+    # Creates a new milestone.
+    #
+    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [String] title The title of a milestone.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :description The description of a milestone.
+    # @option options [String] :due_date The due date of a milestone.
+    # @return [Gitlab::ObjectifiedHash] Information about created milestone.
+    def create_milestone(project, title, options={})
+      body = {:title => title}.merge(options)
+      post("/projects/#{project}/milestones", :body => body)
+    end
+
+    # Updates a milestone.
+    #
+    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer] id The ID of a milestone.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :title The title of a milestone.
+    # @option options [String] :description The description of a milestone.
+    # @option options [String] :due_date The due date of a milestone.
+    # @option options [Boolean] :closed The state of a milestone (0 = false, 1 = true).
+    # @return [Gitlab::ObjectifiedHash] Information about updated milestone.
+    def edit_milestone(project, id, options={})
+      put("/projects/#{project}/milestones/#{id}", :body => options)
+    end
+  end
+end

data/lib/gitlab/client/projects.rb

@@ -0,0 +1,155 @@
+class Gitlab::Client
+  # Defines methods related to projects.
+  module Projects
+    # Gets a list of projects owned by the authenticated user.
+    #
+    # @example
+    #   Gitlab.projects
+    #
+    # @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 projects(options={})
+      get("/projects", :query => options)
+    end
+
+    # Gets information about a project.
+    #
+    # @example
+    #   Gitlab.project(3)
+    #   Gitlab.project('gitlab')
+    #
+    # @param  [Integer, String] id The ID or code name of a project.
+    # @return [Gitlab::ObjectifiedHash]
+    def project(id)
+      get("/projects/#{id}")
+    end
+
+    # Creates a new project.
+    #
+    # @example
+    #   Gitlab.create_project('gitlab')
+    #   Gitlab.create_project('viking', :description => 'Awesome project')
+    #   Gitlab.create_project('Red', :wall_enabled => false)
+    #
+    # @param  [String] name The name of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :code The code name of a project.
+    # @option options [String] :path The path of a project.
+    # @option options [String] :description The description of a project.
+    # @option options [String] :default_branch The default branch of 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).
+    # @option options [Boolean] :merge_requests_enabled The merge requests functionality for a project (0 = false, 1 = true).
+    # @return [Gitlab::ObjectifiedHash] Information about created project.
+    def create_project(name, options={})
+      post("/projects", :body => {:name => name}.merge(options))
+    end
+
+    # Gets a list of project team members.
+    #
+    # @example
+    #   Gitlab.team_members(42)
+    #   Gitlab.team_members('gitlab')
+    #
+    # @param  [Integer, String] project The ID or code 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 team_members(project, options={})
+      get("/projects/#{project}/members", :query => options)
+    end
+
+    # Gets a project team member.
+    #
+    # @example
+    #   Gitlab.team_member('gitlab', 2)
+    #
+    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer] id The ID of a project team member.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def team_member(project, id)
+      get("/projects/#{project}/members/#{id}")
+    end
+
+    # Adds a user to project team.
+    #
+    # @example
+    #   Gitlab.add_team_member('gitlab', 2, 40)
+    #
+    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer] id The ID of a user.
+    # @param  [Integer] access_level The access level to project.
+    # @return [Array<Gitlab::ObjectifiedHash>] Information about added team member.
+    def add_team_member(project, id, access_level)
+      post("/projects/#{project}/members/#{id}", :body => {:access_level => access_level})
+    end
+
+    # Updates a team member's project access level.
+    #
+    # @example
+    #   Gitlab.team_members('gitlab', 3, 20)
+    #
+    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer] id The ID of a user.
+    # @param  [Integer] access_level The access level to project.
+    # @return [Array<Gitlab::ObjectifiedHash>] Information about updated team member.
+    def edit_team_member(project, id, access_level)
+      put("/projects/#{project}/members/#{id}", :body => {:access_level => access_level})
+    end
+
+    # Removes a user from project team.
+    #
+    # @example
+    #   Gitlab.remove_team_member('gitlab', 2)
+    #
+    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer] id The ID of a user.
+    # @return [Array<Gitlab::ObjectifiedHash>] Information about removed team member.
+    def remove_team_member(project, id)
+      delete("/projects/#{project}/members/#{id}")
+    end
+
+    # Gets a list of project hooks.
+    #
+    # @example
+    #   Gitlab.project_hooks(42)
+    #   Gitlab.project_hooks('gitlab')
+    #
+    # @param  [Integer, String] project The ID or code 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_hooks(project, options={})
+      get("/projects/#{project}/hooks", :query => options)
+    end
+
+    # Adds a new hook to the project.
+    #
+    # @example
+    #   Gitlab.project_hooks(42, 'https://api.example.net/v1/webhooks/ci')
+    #
+    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [String] url The hook URL.
+    # @return [Gitlab::ObjectifiedHash] Information about added hook.
+    def add_project_hook(project, url)
+      post("/projects/#{project}/hooks", :body => {:url => url})
+    end
+
+    # Deletes a hook from project.
+    #
+    # @example
+    #   Gitlab.delete_project_hook('gitlab', 4)
+    #
+    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [String] id The ID of the hook.
+    # @return [Gitlab::ObjectifiedHash] Information about deleted hook.
+    def delete_project_hook(project, id)
+      delete("/projects/#{project}/hooks/#{id}")
+    end
+  end
+end