brat 0.1.1

data/lib/brat/client/projects.rb

@@ -0,0 +1,298 @@
+class Brat::Client
+  # Defines methods related to projects.
+  module Projects
+    # Gets a list of projects owned by the authenticated user.
+    #
+    # @example
+    #   Brat.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.
+    # @option options [String] :scope Scope of projects. 'owned' for list of projects owned by the authenticated user, 'all' to get all projects (admin only)
+    # @return [Array<Brat::ObjectifiedHash>]
+    def projects(options={})
+      if (options[:scope])
+        get("/projects/#{options[:scope]}", :query => options)
+      else
+        get("/projects", :query => options)
+      end
+    end
+
+    # Gets information about a project.
+    #
+    # @example
+    #   Brat.project(3)
+    #   Brat.project('brat')
+    #
+    # @param  [Integer, String] id The ID or name of a project.
+    # @return [Brat::ObjectifiedHash]
+    def project(id)
+      get("/projects/#{id}")
+    end
+
+    # Gets a list of project events.
+    #
+    # @example
+    #   Brat.project_events(42)
+    #   Brat.project_events('brat')
+    #
+    # @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<Brat::ObjectifiedHash>]
+    def project_events(project, options={})
+      get("/projects/#{project}/events", :query => options)
+    end
+
+    # Creates a new project.
+    #
+    # @example
+    #   Brat.create_project('brat')
+    #   Brat.create_project('viking', :description => 'Awesome project')
+    #   Brat.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] :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] :snippets_enabled The snippets 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).
+    # @option options [Boolean] :public The setting for making a project public (0 = false, 1 = true).
+    # @option options [Integer] :user_id The user/owner id of a project.
+    # @return [Brat::ObjectifiedHash] Information about created project.
+    def create_project(name, options={})
+      url = options[:user_id] ? "/projects/user/#{options[:user_id]}" : "/projects"
+      post(url, :body => {:name => name}.merge(options))
+    end
+
+    # Deletes a project.
+    #
+    # @example
+    #   Brat.delete_project(4)
+    #
+    # @param  [Integer, String] id The ID or name of a project.
+    # @return [Brat::ObjectifiedHash] Information about deleted project.
+    def delete_project(id)
+      delete("/projects/#{id}")
+    end
+
+    # Gets a list of project team members.
+    #
+    # @example
+    #   Brat.team_members(42)
+    #   Brat.team_members('brat')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :query The search query.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Brat::ObjectifiedHash>]
+    def team_members(project, options={})
+      get("/projects/#{project}/members", :query => options)
+    end
+
+    # Gets a project team member.
+    #
+    # @example
+    #   Brat.team_member('brat', 2)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a project team member.
+    # @return [Brat::ObjectifiedHash]
+    def team_member(project, id)
+      get("/projects/#{project}/members/#{id}")
+    end
+
+    # Adds a user to project team.
+    #
+    # @example
+    #   Brat.add_team_member('brat', 2, 40)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a user.
+    # @param  [Integer] access_level The access level to project.
+    # @param  [Hash] options A customizable set of options.
+    # @return [Brat::ObjectifiedHash] Information about added team member.
+    def add_team_member(project, id, access_level)
+      post("/projects/#{project}/members", :body => {:user_id => id, :access_level => access_level})
+    end
+
+    # Updates a team member's project access level.
+    #
+    # @example
+    #   Brat.edit_team_member('brat', 3, 20)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a user.
+    # @param  [Integer] access_level The access level to project.
+    # @param  [Hash] options A customizable set of options.
+    # @return [Array<Brat::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
+    #   Brat.remove_team_member('brat', 2)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a user.
+    # @param  [Hash] options A customizable set of options.
+    # @return [Brat::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
+    #   Brat.project_hooks(42)
+    #   Brat.project_hooks('brat')
+    #
+    # @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<Brat::ObjectifiedHash>]
+    def project_hooks(project, options={})
+      get("/projects/#{project}/hooks", :query => options)
+    end
+
+    # Gets a project hook.
+    #
+    # @example
+    #   Brat.project_hook(42, 5)
+    #   Brat.project_hook('brat', 5)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a hook.
+    # @return [Brat::ObjectifiedHash]
+    def project_hook(project, id)
+      get("/projects/#{project}/hooks/#{id}")
+    end
+
+    # Adds a new hook to the project.
+    #
+    # @example
+    #   Brat.add_project_hook(42, 'https://api.example.net/v1/webhooks/ci')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] url The hook URL.
+    # @param  [Hash] options Events list (`{push_events: true, merge_requests_events: false}`).
+    # @return [Brat::ObjectifiedHash] Information about added hook.
+    def add_project_hook(project, url, options = {})
+      available_events = [:push_events, :merge_requests_events, :issues_events]
+      passed_events = available_events.select { |event| options[event] }
+      events = Hash[passed_events.map { |event| [event, options[event]] }]
+
+      post("/projects/#{project}/hooks", :body => {:url => url}.merge(events))
+    end
+
+    # Updates a project hook URL.
+    #
+    # @example
+    #   Brat.edit_project_hook(42, 1, 'https://api.example.net/v1/webhooks/ci')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of the hook.
+    # @param  [String] url The hook URL.
+    # @return [Brat::ObjectifiedHash] Information about updated hook.
+    def edit_project_hook(project, id, url)
+      put("/projects/#{project}/hooks/#{id}", :body => {:url => url})
+    end
+
+    # Deletes a hook from project.
+    #
+    # @example
+    #   Brat.delete_project_hook('brat', 4)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] id The ID of the hook.
+    # @return [Brat::ObjectifiedHash] Information about deleted hook.
+    def delete_project_hook(project, id)
+      delete("/projects/#{project}/hooks/#{id}")
+    end
+
+    # Mark this project as forked from the other
+    #
+    # @example
+    #   Brat.make_forked(42, 24)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of the project it is forked from.
+    # @return [Brat::ObjectifiedHash] Information about the forked project.
+    def make_forked_from(project, id)
+      post("/projects/#{project}/fork/#{id}")
+    end
+
+    # Remove a forked_from relationship for a project.
+    #
+    # @example
+    #  Brat.remove_forked(42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] project The ID of the project it is forked from
+    # @return [Brat::ObjectifiedHash] Information about the forked project.
+    def remove_forked(project)
+      delete("/projects/#{project}/fork")
+    end
+
+    # Gets a project deploy keys.
+    #
+    # @example
+    #   Brat.deploy_keys(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 deploy_keys(project, options={})
+      get("/projects/#{project}/keys", :query => options)
+    end
+
+    # Gets a single project deploy key.
+    #
+    # @example
+    #   Brat.deploy_key(42, 1)
+    #
+    # @param  [Integer, String] project The ID of a project.
+    # @param  [Integer] id The ID of a deploy key.
+    # @return [Brat::ObjectifiedHash]
+    def deploy_key(project, id)
+      get("/projects/#{project}/keys/#{id}")
+    end
+
+    # Creates a new deploy key.
+    #
+    # @example
+    #   Brat.create_deploy_key(42, 'My Key', 'Key contents')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] title The title of a deploy key.
+    # @param  [String] key The content of a deploy key.
+    # @return [Brat::ObjectifiedHash] Information about created deploy key.
+    def create_deploy_key(project, title, key)
+      post("/projects/#{project}/keys", body: {title: title, key: key})
+    end
+
+    # Deletes a deploy key from project.
+    #
+    # @example
+    #   Brat.delete_deploy_key(42, 1)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of a deploy key.
+    # @return [Brat::ObjectifiedHash] Information about deleted deploy key.
+    def delete_deploy_key(project, id)
+      delete("/projects/#{project}/keys/#{id}")
+    end
+  end
+end

data/lib/brat/client/repositories.rb

@@ -0,0 +1,78 @@
+class Brat::Client
+  # Defines methods related to repositories.
+  module Repositories
+    # Gets a list of project repository tags.
+    #
+    # @example
+    #   Brat.tags(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 tags(project, options={})
+      get("/projects/#{project}/repository/tags", :query => options)
+    end
+    alias_method :repo_tags, :tags
+
+    # Creates a new project repository tag.
+    #
+    # @example
+    #   Brat.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 [Brat::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
+    #   Brat.commits('viking')
+    #   Brat.repo_commits('brat', :ref_name => 'api')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :ref_name The branch or tag name of a project repository.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Brat::ObjectifiedHash>]
+    def commits(project, options={})
+      get("/projects/#{project}/repository/commits", :query => options)
+    end
+    alias_method :repo_commits, :commits
+
+    # Gets a specific commit identified by the commit hash or name of a branch or tag.
+    #
+    # @example
+    #   Brat.commit(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6')
+    #   Brat.repo_commit(3, 'ed899a2f4b50b4370feeea94676502b42383c746')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] sha The commit hash or name of a repository branch or tag
+    # @return [Brat::ObjectifiedHash]
+    def commit(project, sha)
+      get("/projects/#{project}/repository/commits/#{sha}")
+    end
+    alias_method :repo_commit, :commit
+
+    # Get the diff of a commit in a project.
+    #
+    # @example
+    #   Brat.commit_diff(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6')
+    #   Brat.repo_commit_diff(3, 'ed899a2f4b50b4370feeea94676502b42383c746')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] sha The name of a repository branch or tag or if not given the default branch.
+    # @return [Brat::ObjectifiedHash]
+    def commit_diff(project, sha)
+      get("/projects/#{project}/repository/commits/#{sha}/diff") 
+    end
+    alias_method :repo_commit_diff, :commit_diff
+  end
+end

data/lib/brat/client/snippets.rb

@@ -0,0 +1,86 @@
+class Brat::Client
+  # Defines methods related to snippets.
+  module Snippets
+    # Gets a list of project's snippets.
+    #
+    # @example
+    #   Brat.snippets(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 [Brat::ObjectifiedHash]
+    def snippets(project, options={})
+      get("/projects/#{project}/snippets", :query => options)
+    end
+
+    # Gets information about a snippet.
+    #
+    # @example
+    #   Brat.snippet(2, 14)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of a snippet.
+    # @return [Brat::ObjectifiedHash]
+    def snippet(project, id)
+      get("/projects/#{project}/snippets/#{id}")
+    end
+
+    # Creates a new snippet.
+    #
+    # @example
+    #   Brat.create_snippet(42, {:title => 'REST', :file_name => 'api.rb', :code => 'some code'})
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :title (required) The title of a snippet.
+    # @option options [String] :file_name (required) The name of a snippet file.
+    # @option options [String] :code (required) The content of a snippet.
+    # @option options [String] :lifetime (optional) The expiration date of a snippet.
+    # @return [Brat::ObjectifiedHash] Information about created snippet.
+    def create_snippet(project, options={})
+      check_attributes!(options, [:title, :file_name, :code])
+      post("/projects/#{project}/snippets", :body => options)
+    end
+
+    # Updates a snippet.
+    #
+    # @example
+    #   Brat.edit_snippet(42, 34, :file_name => 'README.txt')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of a snippet.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :title The title of a snippet.
+    # @option options [String] :file_name The name of a snippet file.
+    # @option options [String] :code The content of a snippet.
+    # @option options [String] :lifetime The expiration date of a snippet.
+    # @return [Brat::ObjectifiedHash] Information about updated snippet.
+    def edit_snippet(project, id, options={})
+      put("/projects/#{project}/snippets/#{id}", :body => options)
+    end
+
+    # Deletes a snippet.
+    #
+    # @example
+    #   Brat.delete_snippet(2, 14)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of a snippet.
+    # @return [Brat::ObjectifiedHash] Information about deleted snippet.
+    def delete_snippet(project, id)
+      delete("/projects/#{project}/snippets/#{id}")
+    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