brat 0.1.1

data/lib/brat/client.rb

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

data/lib/brat/client/branches.rb

@@ -0,0 +1,79 @@
+class Brat::Client
+  # Defines methods related to repositories.
+  module Branches
+    # Gets a list of project repositiory branches.
+    #
+    # @example
+    #   Brat.branches(42)
+    #
+    # @param  [Integer] project The ID 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<Brat::ObjectifiedHash>]
+    def branches(project, options={})
+      get("/projects/#{project}/repository/branches", :query => options)
+    end
+    alias_method :repo_branches, :branches
+
+    # Gets information about a repository branch.
+    #
+    # @example
+    #   Brat.branch(3, 'api')
+    #   Brat.repo_branch(5, 'master')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] branch The name of the branch.
+    # @return [Brat::ObjectifiedHash]
+    def branch(project, branch)
+      get("/projects/#{project}/repository/branches/#{branch}")
+    end
+    
+    alias_method :repo_branch, :branch
+
+    # Protects a repository branch.
+    #
+    # @example
+    #   Brat.protect_branch(3, 'api')
+    #   Brat.repo_protect_branch(5, 'master')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] branch The name of the branch.
+    # @return [Brat::ObjectifiedHash]
+    def protect_branch(project, branch)
+      put("/projects/#{project}/repository/branches/#{branch}/protect")
+    end
+    alias_method :repo_protect_branch, :protect_branch
+
+    # Unprotects a repository branch.
+    #
+    # @example
+    #   Brat.unprotect_branch(3, 'api')
+    #   Brat.repo_unprotect_branch(5, 'master')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] branch The name of the branch.
+    # @return [Brat::ObjectifiedHash]
+    def unprotect_branch(project, branch)
+      put("/projects/#{project}/repository/branches/#{branch}/unprotect")
+    end
+    alias_method :repo_unprotect_branch, :unprotect_branch
+
+    # Creates a repository branch.  Requires Brat >= 6.8.x
+    #
+    # @example
+    #   Brat.create_branch(3, 'api')
+    #   Brat.repo_create_branch(5, 'master')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] branch The name of the new branch.
+    # @param  [String] ref Create branch from commit sha or existing branch
+    # @return [Brat::ObjectifiedHash]
+    def create_branch(project, branch, ref)
+      post("/projects/#{project}/repository/branches",:body => {:branch_name => branch, :ref => ref})
+    end
+    alias_method :repo_create_branch, :create_branch
+
+  end
+end
+

data/lib/brat/client/groups.rb

@@ -0,0 +1,88 @@
+class Brat::Client
+  # Defines methods related to groups.
+  module Groups
+    # Gets a list of groups.
+    #
+    # @example
+    #   Brat.groups
+    #   Brat.groups(:per_page => 40)
+    #
+    # @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<Brat::ObjectifiedHash>]
+    def groups(options={})
+      get("/groups", :query => options)
+    end
+
+    # Gets a single group.
+    #
+    # @example
+    #   Brat.group(42)
+    #
+    # @param  [Integer] id The ID of a group.
+    # @return [Brat::ObjectifiedHash]
+    def group(id)
+      get("/groups/#{id}")
+    end
+
+    # Creates a new group.
+    #
+    # @param  [String] name The name of a group.
+    # @param  [String] path The path of a group.
+    # @return [Brat::ObjectifiedHash] Information about created group.
+    def create_group(name, path)
+      body = {:name => name, :path => path}
+      post("/groups", :body => body)
+    end
+
+    # Get a list of group members.
+    #
+    # @example
+    #   Brat.group_members(1)
+    #   Brat.group_members(1, :per_page => 40)
+    #
+    # @param  [Integer] id The ID of a group.
+    # @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<Brat::ObjectifiedHash>]
+    def group_members(id, options={})
+      get("/groups/#{id}/members", :query => options)
+    end
+
+    # Adds a user to group.
+    #
+    # @example
+    #   Brat.add_group_member(1, 2, 40)
+    #
+    # @param  [Integer] team_id The group id to add a member to.
+    # @param  [Integer] user_id The user id of the user to add to the team.
+    # @param  [Integer] access_level Project access level.
+    # @return [Brat::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})
+    end
+
+    # Removes user from user group.
+    #
+    # @example
+    #   Brat.remove_group_member(1, 2)
+    #
+    # @param  [Integer] team_id The group ID.
+    # @param  [Integer] user_id The ID of a user.
+    # @return [Brat::ObjectifiedHash] Information about removed team member.
+    def remove_group_member(team_id, user_id)
+      delete("/groups/#{team_id}/members/#{user_id}")
+    end
+
+    # Transfers a project to a group
+    #
+    # @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)
+    end
+  end
+end

data/lib/brat/client/issues.rb

@@ -0,0 +1,92 @@
+class Brat::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 passed.
+    #
+    # @example
+    #   Brat.issues
+    #   Brat.issues(5)
+    #   Brat.issues(:per_page => 40)
+    #
+    # @param  [Integer] project The ID 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<Brat::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
+    #   Brat.issue(5, 42)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @return [Brat::ObjectifiedHash]
+    def issue(project, id)
+      get("/projects/#{project}/issues/#{id}")
+    end
+
+    # Creates a new issue.
+    #
+    # @param  [Integer] project The ID 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 [Brat::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] project The ID 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 [String] :state_event The state event of an issue ('close' or 'reopen').
+    # @return [Brat::ObjectifiedHash] Information about updated issue.
+    def edit_issue(project, id, options={})
+      put("/projects/#{project}/issues/#{id}", :body => options)
+    end
+
+    # Closes an issue.
+    #
+    # @example
+    #   Brat.close_issue(3, 42)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @return [Brat::ObjectifiedHash] Information about closed issue.
+    def close_issue(project, id)
+      put("/projects/#{project}/issues/#{id}", :body => {:state_event => 'close'})
+    end
+
+    # Reopens an issue.
+    #
+    # @example
+    #   Brat.reopen_issue(3, 42)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @return [Brat::ObjectifiedHash] Information about reopened issue.
+    def reopen_issue(project, id)
+      put("/projects/#{project}/issues/#{id}", :body => {:state_event => 'reopen'})
+    end
+  end
+end

data/lib/brat/client/merge_requests.rb

@@ -0,0 +1,107 @@
+class Brat::Client
+  # Defines methods related to merge requests.
+  module MergeRequests
+    # Gets a list of project merge requests.
+    #
+    # @example
+    #   Brat.merge_requests(5)
+    #   Brat.merge_requests(:per_page => 40)
+    #
+    # @param  [Integer] project The ID 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<Brat::ObjectifiedHash>]
+    def merge_requests(project, options={})
+      get("/projects/#{project}/merge_requests", :query => options)
+    end
+
+    # Gets a single merge request.
+    #
+    # @example
+    #   Brat.merge_request(5, 36)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of a merge request.
+    # @return <Brat::ObjectifiedHash]
+    def merge_request(project, id)
+      get("/projects/#{project}/merge_request/#{id}")
+    end
+
+    # Creates a merge request.
+    #
+    # @example
+    #   Brat.create_merge_request(5, 'New merge request',
+    #     :source_branch => 'source_branch', :target_branch => 'target_branch')
+    #   Brat.create_merge_request(5, 'New merge request',
+    #     :source_branch => 'source_branch', :target_branch => 'target_branch', :assignee_id => 42)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] title The title of a merge request.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :source_branch (required) The source branch name.
+    # @option options [String] :target_branch (required) The target branch name.
+    # @option options [Integer] :assignee_id (optional) The ID of a user to assign merge request.
+    # @return [Brat::ObjectifiedHash] Information about created merge request.
+    def create_merge_request(project, title, options={})
+      check_attributes!(options, [:source_branch, :target_branch])
+
+      body = {:title => title}.merge(options)
+      post("/projects/#{project}/merge_requests", :body => body)
+    end
+
+    # Updates a merge request.
+    #
+    # @example
+    #   Brat.update_merge_request(5, 42, :title => 'New title')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of a merge request.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :title The title of a merge request.
+    # @option options [String] :source_branch The source branch name.
+    # @option options [String] :target_branch The target branch name.
+    # @option options [Integer] :assignee_id The ID of a user to assign merge request.
+    # @option options [String] :state_event New state (close|reopen|merge).
+    # @return [Brat::ObjectifiedHash] Information about updated merge request.
+    def update_merge_request(project, id, options={})
+      put("/projects/#{project}/merge_request/#{id}", :body => options)
+    end
+
+    # Adds a comment to a merge request.
+    #
+    # @example
+    #   Brat.create_merge_request_comment(5, 1, "Awesome merge!")
+    #   Brat.create_merge_request_comment('brat', 1, "Awesome merge!")
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of a merge request.
+    # @param  [String] note The content of a comment.
+    # @return [Brat::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})
+    end
+
+    # Gets the comments on a merge request.
+    #
+    # @example
+    #   Brat.merge_request_comments(5, 1)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of a merge request.
+    # @return [Brat::ObjectifiedHash] The merge request's comments.
+    def merge_request_comments(project, id)
+      get("/projects/#{project}/merge_request/#{id}/comments")
+    end
+
+    private
+
+    def check_attributes!(options, attrs)
+      attrs.each do |attr|
+        unless options.has_key?(attr) || options.has_key?(attr.to_s)
+          raise Brat::Error::MissingAttributes.new("Missing '#{attr}' parameter")
+        end
+      end
+    end
+  end
+end

data/lib/brat/client/milestones.rb

@@ -0,0 +1,57 @@
+class Brat::Client
+  # Defines methods related to milestones.
+  module Milestones
+    # Gets a list of project's milestones.
+    #
+    # @example
+    #   Brat.milestones(5)
+    #
+    # @param  [Integer] project The ID 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<Brat::ObjectifiedHash>]
+    def milestones(project, options={})
+      get("/projects/#{project}/milestones", :query => options)
+    end
+
+    # Gets a single milestone.
+    #
+    # @example
+    #   Brat.milestone(5, 36)
+    #
+    # @param  [Integer, String] project The ID of a project.
+    # @param  [Integer] id The ID of a milestone.
+    # @return [Brat::ObjectifiedHash]
+    def milestone(project, id)
+      get("/projects/#{project}/milestones/#{id}")
+    end
+
+    # Creates a new milestone.
+    #
+    # @param  [Integer] project The ID 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 [Brat::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] project The ID 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 [String] :state_event The state of a milestone ('close' or 'activate').
+    # @return [Brat::ObjectifiedHash] Information about updated milestone.
+    def edit_milestone(project, id, options={})
+      put("/projects/#{project}/milestones/#{id}", :body => options)
+    end
+  end
+end

data/lib/brat/client/notes.rb

@@ -0,0 +1,106 @@
+class Brat::Client
+  # Defines methods related to notes.
+  module Notes
+    # Gets a list of projects notes.
+    #
+    # @example
+    #   Brat.notes(5)
+    #
+    # @param [Integer] project The ID of a project.
+    # @return [Array<Brat::ObjectifiedHash>]
+    def notes(project)
+      get("/projects/#{project}/notes")
+    end
+
+    # Gets a list of notes for a issue.
+    #
+    # @example
+    #   Brat.issue_notes(5, 10)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] issue The ID of an issue.
+    # @return [Array<Brat::ObjectifiedHash>]
+    def issue_notes(project, issue)
+      get("/projects/#{project}/issues/#{issue}/notes")
+    end
+
+    # Gets a list of notes for a snippet.
+    #
+    # @example
+    #   Brat.snippet_notes(5, 1)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] snippet The ID of a snippet.
+    # @return [Array<Brat::ObjectifiedHash>]
+    def snippet_notes(project, snippet)
+      get("/projects/#{project}/snippets/#{snippet}/notes")
+    end
+
+    # Gets a single wall note.
+    #
+    # @example
+    #   Brat.note(5, 15)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] id The ID of a note.
+    # @return [Brat::ObjectifiedHash]
+    def note(project, id)
+      get("/projects/#{project}/notes/#{id}")
+    end
+
+    # Gets a single issue note.
+    #
+    # @example
+    #   Brat.issue_note(5, 10, 1)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] issue The ID of an issue.
+    # @param [Integer] id The ID of a note.
+    # @return [Brat::ObjectifiedHash]
+    def issue_note(project, issue, id)
+      get("/projects/#{project}/issues/#{issue}/notes/#{id}")
+    end
+
+    # Gets a single snippet note.
+    #
+    # @example
+    #   Brat.snippet_note(5, 11, 3)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] snippet The ID of a snippet.
+    # @param [Integer] id The ID of an note.
+    # @return [Brat::ObjectifiedHash]
+    def snippet_note(project, snippet, id)
+      get("/projects/#{project}/snippets/#{snippet}/notes/#{id}")
+    end
+
+    # Creates a new wall note.
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] body The body of a note.
+    # @return [Brat::ObjectifiedHash] Information about created note.
+    def create_note(project, body)
+      post("/projects/#{project}/notes", :body => {:body => body})
+    end
+
+    # Creates a new issue note.
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] issue The ID of an issue.
+    # @param  [String] body The body of a note.
+    # @return [Brat::ObjectifiedHash] Information about created note.
+    def create_issue_note(project, issue, body)
+      post("/projects/#{project}/issues/#{issue}/notes", :body => {:body => body})
+    end
+
+    # Creates a new snippet note.
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] snippet The ID of a snippet.
+    # @param  [String] body The body of a note.
+    # @return [Brat::ObjectifiedHash] Information about created note.
+    def create_snippet_note(project, snippet, body)
+      post("/projects/#{project}/snippets/#{snippet}/notes", :body => {:body => body})
+    end
+  end
+end