gitlab 2.0.0 → 2.1.0

data/README.md

@@ -1,5 +1,7 @@
 # Gitlab
 
+[![Build Status](https://secure.travis-ci.org/NARKOZ/gitlab.png)](http://travis-ci.org/NARKOZ/gitlab)
+
 Gitlab is a Ruby wrapper for the [GitLab API](https://github.com/gitlabhq/gitlabhq/tree/master/doc/api#gitlab-api).
 
 ## Installation

data/lib/gitlab/client/issues.rb

@@ -65,5 +65,31 @@ class Gitlab::Client
     def edit_issue(project, id, options={})
       put("/projects/#{project}/issues/#{id}", :body => options)
     end
+
+    # Closes an issue.
+    #
+    # @example
+    #   Gitlab.close_issue(3, 42)
+    #   Gitlab.close_issue('gitlab', 42)
+    #
+    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @return [Gitlab::ObjectifiedHash] Information about closed issue.
+    def close_issue(project, id)
+      put("/projects/#{project}/issues/#{id}", :body => {:closed => 1})
+    end
+
+    # Reopens an issue.
+    #
+    # @example
+    #   Gitlab.reopen_issue(3, 42)
+    #   Gitlab.reopen_issue('gitlab', 42)
+    #
+    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @return [Gitlab::ObjectifiedHash] Information about reopened issue.
+    def reopen_issue(project, id)
+      put("/projects/#{project}/issues/#{id}", :body => {:closed => 0})
+    end
   end
 end

data/lib/gitlab/client/projects.rb

@@ -85,13 +85,13 @@ class Gitlab::Client
     # @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})
+      post("/projects/#{project}/members", :body => {:user_id => id, :access_level => access_level})
     end
 
     # Updates a team member's project access level.
     #
     # @example
-    #   Gitlab.team_members('gitlab', 3, 20)
+    #   Gitlab.edit_team_member('gitlab', 3, 20)
     #
     # @param  [Integer, String] project The ID or code name of a project.
     # @param  [Integer] id The ID of a user.
@@ -128,10 +128,23 @@ class Gitlab::Client
       get("/projects/#{project}/hooks", :query => options)
     end
 
+    # Gets a project hook.
+    #
+    # @example
+    #   Gitlab.project_hook(42, 5)
+    #   Gitlab.project_hook('gitlab', 5)
+    #
+    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer] id The ID of a hook.
+    # @return [Gitlab::ObjectifiedHash]
+    def project_hook(project, id)
+      get("/projects/#{project}/hooks/#{id}")
+    end
+
     # Adds a new hook to the project.
     #
     # @example
-    #   Gitlab.project_hooks(42, 'https://api.example.net/v1/webhooks/ci')
+    #   Gitlab.add_project_hook(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.
@@ -140,6 +153,19 @@ class Gitlab::Client
       post("/projects/#{project}/hooks", :body => {:url => url})
     end
 
+    # Updates a project hook URL.
+    #
+    # @example
+    #   Gitlab.edit_project_hook(42, 1, 'https://api.example.net/v1/webhooks/ci')
+    #
+    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer] id The ID of the hook.
+    # @param  [String] url The hook URL.
+    # @return [Gitlab::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

data/lib/gitlab/client/repositories.rb

@@ -15,7 +15,7 @@ class Gitlab::Client
     def tags(project, options={})
       get("/projects/#{project}/repository/tags", :query => options)
     end
-    alias :repo_tags :tags
+    alias_method :repo_tags, :tags
 
     # Gets a list of project repositiory branches.
     #
@@ -31,7 +31,7 @@ class Gitlab::Client
     def branches(project, options={})
       get("/projects/#{project}/repository/branches", :query => options)
     end
-    alias :repo_branches :branches
+    alias_method :repo_branches, :branches
 
     # Gets information about a repository branch.
     #
@@ -45,7 +45,7 @@ class Gitlab::Client
     def branch(project, branch)
       get("/projects/#{project}/repository/branches/#{branch}")
     end
-    alias :repo_branch :branch
+    alias_method :repo_branch, :branch
 
     # Gets a list of project commits.
     #
@@ -62,6 +62,6 @@ class Gitlab::Client
     def commits(project, options={})
       get("/projects/#{project}/repository/commits", :query => options)
     end
-    alias :repo_commits :commits
+    alias_method :repo_commits, :commits
   end
 end

data/lib/gitlab/client/snippets.rb

@@ -1,6 +1,21 @@
 class Gitlab::Client
   # Defines methods related to snippets.
   module Snippets
+    # Gets a list of project's snippets.
+    #
+    # @example
+    #   Gitlab.snippets(42)
+    #   Gitlab.snippets('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 [Gitlab::ObjectifiedHash]
+    def snippets(project, options={})
+      get("/projects/#{project}/snippets", :query => options)
+    end
+
     # Gets information about a snippet.
     #
     # @example

data/lib/gitlab/client/users.rb

@@ -27,6 +27,23 @@ class Gitlab::Client
       id.to_i.zero? ? get("/user") : get("/users/#{id}")
     end
 
+    # Creates a new user.
+    # Requires authentication from an admin account.
+    #
+    # @param  [String] email The email of a user.
+    # @param  [String] password The password of a user.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :name The name of a user. Defaults to email.
+    # @option options [String] :skype The skype of a user.
+    # @option options [String] :linkedin The linkedin of a user.
+    # @option options [String] :twitter The twitter of a user.
+    # @option options [Integer] :projects_limit The limit of projects for a user.
+    # @return [Gitlab::ObjectifiedHash] Information about created user.
+    def create_user(email, password, options={})
+      body = {:email => email, :password => password, :name => email}.merge(options)
+      post("/users", :body => body)
+    end
+
     # Creates a new user session.
     #
     # @example

data/lib/gitlab/request.rb

@@ -4,70 +4,77 @@ module Gitlab
   # @private
   class Request
     include HTTParty
-    format :json
+    format  :json
     headers 'Accept' => 'application/json'
-    parser  Proc.new {|body| make_objectified_hash(body)}
+    parser  Proc.new {|body| parse(body)}
 
-    # Parses the response body.
-    def self.make_objectified_hash(body)
-      begin
-        response = MultiJson.respond_to?(:adapter) ? MultiJson.load(body) : MultiJson.decode(body)
-      rescue MultiJson::DecodeError
-        raise Error::Parsing.new "Couldn't parse a response body"
-      end
+    # Converts the response body to an ObjectifiedHash.
+    def self.parse(body)
+      body = decode(body)
 
-      if response.is_a? Hash
-        ObjectifiedHash.new response
-      elsif response.is_a? Array
-        response.collect! {|e| ObjectifiedHash.new(e)}
+      if body.is_a? Hash
+        ObjectifiedHash.new body
+      elsif body.is_a? Array
+        body.collect! {|e| ObjectifiedHash.new(e)}
       else
         raise Error::Parsing.new "Couldn't parse a response body"
       end
     end
 
+    # Decodes a JSON response into Ruby object.
+    def self.decode(response)
+      begin
+        if MultiJson.respond_to?(:adapter)
+          MultiJson.load response
+        else
+          MultiJson.decode response
+        end
+      rescue MultiJson::DecodeError
+        raise Error::Parsing.new "The response is not a valid JSON"
+      end
+    end
+
     def get(path, options={})
-      validate_response self.class.get(path, options)
+      validate self.class.get(path, options)
     end
 
     def post(path, options={})
-      validate_response self.class.post(path, options)
+      validate self.class.post(path, options)
     end
 
     def put(path, options={})
-      validate_response self.class.put(path, options)
+      validate self.class.put(path, options)
     end
 
     def delete(path)
-      validate_response self.class.delete(path)
+      validate self.class.delete(path)
     end
 
-    def set_request_defaults(endpoint, private_token)
-      raise Error::MissingCredentials.new("Please set an endpoint") unless endpoint
-      raise Error::MissingCredentials.new("Please set a private_token") unless private_token
-
-      self.class.base_uri endpoint
-      self.class.default_params :private_token => private_token
-    end
-
-    def validate_response(response)
+    # Checks the response code for common errors.
+    # Returns parsed response for successful requests.
+    def validate(response)
+      message = "Server responsed with code #{response.code}"
       case response.code
-      when 400
-        raise Error::BadRequest.new "Server responsed with code #{response.code}"
-      when 401
-        raise Error::Unauthorized.new "Server responsed with code #{response.code}"
-      when 403
-        raise Error::Forbidden.new "Server responsed with code #{response.code}"
-      when 404
-        raise Error::NotFound.new "Server responsed with code #{response.code}"
-      when 500
-        raise Error::InternalServerError.new "Server responsed with code #{response.code}"
-      when 502
-        raise Error::BadGateway.new "Server responsed with code #{response.code}"
-      when 503
-        raise Error::ServiceUnavailable.new "Server responsed with code #{response.code}"
+      when 400; raise Error::BadRequest.new message
+      when 401; raise Error::Unauthorized.new message
+      when 403; raise Error::Forbidden.new message
+      when 404; raise Error::NotFound.new message
+      when 500; raise Error::InternalServerError.new message
+      when 502; raise Error::BadGateway.new message
+      when 503; raise Error::ServiceUnavailable.new message
       end
 
       response.parsed_response
     end
+
+    # Sets a base_uri and private_token parameter for requests.
+    # @raise [Error::MissingCredentials] if endpoint or private_token not set.
+    def set_request_defaults(endpoint, private_token)
+      raise Error::MissingCredentials.new("Please set an endpoint to API") unless endpoint
+      raise Error::MissingCredentials.new("Please set a private_token for user") unless private_token
+
+      self.class.base_uri endpoint
+      self.class.default_params :private_token => private_token
+    end
   end
 end

data/lib/gitlab/version.rb

@@ -1,3 +1,3 @@
 module Gitlab
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/spec/fixtures/snippets.json

@@ -0,0 +1 @@
+[{"id":1,"title":"Rails Console ActionMailer","file_name":"mailer_test.rb","author":{"id":1,"email":"john@example.com","name":"John Smith","blocked":false,"created_at":"2012-09-17T09:41:56Z"},"expires_at":"2012-09-24T00:00:00Z","updated_at":"2012-09-17T09:51:42Z","created_at":"2012-09-17T09:51:42Z"}]

data/spec/gitlab/client/issues_spec.rb

@@ -85,4 +85,38 @@ describe Gitlab::Client do
       @issue.assignee.name.should == "Jack Smith"
     end
   end
+
+  describe ".close_issue" do
+    before do
+      stub_put("/projects/3/issues/33", "issue")
+      @issue = Gitlab.close_issue(3, 33)
+    end
+
+    it "should get the correct resource" do
+      a_put("/projects/3/issues/33").
+        with(:body => {:closed => '1'}).should have_been_made
+    end
+
+    it "should return information about an closed issue" do
+      @issue.project_id.should == 3
+      @issue.assignee.name.should == "Jack Smith"
+    end
+  end
+
+  describe ".reopen_issue" do
+    before do
+      stub_put("/projects/3/issues/33", "issue")
+      @issue = Gitlab.reopen_issue(3, 33)
+    end
+
+    it "should get the correct resource" do
+      a_put("/projects/3/issues/33").
+        with(:body => {:closed => '0'}).should have_been_made
+    end
+
+    it "should return information about an reopened issue" do
+      @issue.project_id.should == 3
+      @issue.assignee.name.should == "Jack Smith"
+    end
+  end
 end

data/spec/gitlab/client/projects_spec.rb

@@ -83,13 +83,13 @@ describe Gitlab::Client do
 
   describe ".add_team_member" do
     before do
-      stub_post("/projects/3/members/1", "team_member")
+      stub_post("/projects/3/members", "team_member")
       @team_member = Gitlab.add_team_member(3, 1, 40)
     end
 
     it "should get the correct resource" do
-      a_post("/projects/3/members/1").
-        with(:body => {:access_level => '40'}).should have_been_made
+      a_post("/projects/3/members").
+        with(:body => {:user_id => '1', :access_level => '40'}).should have_been_made
     end
 
     it "should return information about an added team member" do
@@ -144,6 +144,21 @@ describe Gitlab::Client do
     end
   end
 
+  describe ".project_hook" do
+    before do
+      stub_get("/projects/1/hooks/1", "project_hook")
+      @hook = Gitlab.project_hook(1, 1)
+    end
+
+    it "should get the correct resource" do
+      a_get("/projects/1/hooks/1").should have_been_made
+    end
+
+    it "should return information about a hook" do
+      @hook.url.should == "https://api.example.net/v1/webhooks/ci"
+    end
+  end
+
   describe ".add_project_hook" do
     before do
       stub_post("/projects/1/hooks", "project_hook")
@@ -160,6 +175,22 @@ describe Gitlab::Client do
     end
   end
 
+  describe ".edit_project_hook" do
+    before do
+      stub_put("/projects/1/hooks/1", "project_hook")
+      @hook = Gitlab.edit_project_hook(1, 1, "https://api.example.net/v1/webhooks/ci")
+    end
+
+    it "should get the correct resource" do
+      body = {:url => "https://api.example.net/v1/webhooks/ci"}
+      a_put("/projects/1/hooks/1").with(:body => body).should have_been_made
+    end
+
+    it "should return information about an edited hook" do
+      @hook.url.should == "https://api.example.net/v1/webhooks/ci"
+    end
+  end
+
   describe ".delete_project_hook" do
     before do
       stub_delete("/projects/1/hooks/1", "project_hook")

data/spec/gitlab/client/repositories_spec.rb

@@ -65,7 +65,7 @@ describe Gitlab::Client do
         with(:query => {:ref_name => "api"}).should have_been_made
     end
 
-    it "should return an array of respository commits" do
+    it "should return an array of repository commits" do
       @commits.should be_an Array
       @commits.first.id.should == "f7dd067490fe57505f7226c3b54d3127d2f7fd46"
     end

data/spec/gitlab/client/snippets_spec.rb

@@ -1,6 +1,22 @@
 require 'spec_helper'
 
 describe Gitlab::Client do
+  describe ".snippets" do
+    before do
+      stub_get("/projects/3/snippets", "snippets")
+      @snippets = Gitlab.snippets(3)
+    end
+
+    it "should get the correct resource" do
+      a_get("/projects/3/snippets").should have_been_made
+    end
+
+    it "should return an array of project's snippets" do
+      @snippets.should be_an Array
+      @snippets.first.file_name.should == "mailer_test.rb"
+    end
+  end
+
   describe ".snippet" do
     before do
       stub_get("/projects/3/snippets/1", "snippet")

data/spec/gitlab/client/users_spec.rb

@@ -49,6 +49,22 @@ describe Gitlab::Client do
     end
   end
 
+  describe ".create_user" do
+    before do
+      stub_post("/users", "user")
+      @user = Gitlab.create_user("email", "pass")
+    end
+
+    it "should get the correct resource" do
+      body = {:email => "email", :password => "pass", :name => "email"}
+      a_post("/users").with(:body => body).should have_been_made
+    end
+
+    it "should return information about a created user" do
+      @user.email.should == "john@example.com"
+    end
+  end
+
   describe ".session" do
     before do
       stub_post("/session", "session")
@@ -99,11 +115,11 @@ describe Gitlab::Client do
   describe ".create_ssh_key" do
     before do
       stub_post("/user/keys", "key")
-      @key = Gitlab.create_ssh_key('title', 'body')
+      @key = Gitlab.create_ssh_key("title", "body")
     end
 
     it "should get the correct resource" do
-      body = {:title => 'title', :key => 'body'}
+      body = {:title => "title", :key => "body"}
       a_post("/user/keys").with(:body => body).should have_been_made
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-21 00:00:00.000000000 Z
+date: 2012-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -120,6 +120,7 @@ files:
 - spec/fixtures/projects.json
 - spec/fixtures/session.json
 - spec/fixtures/snippet.json
+- spec/fixtures/snippets.json
 - spec/fixtures/team_member.json
 - spec/fixtures/team_members.json
 - spec/fixtures/user.json
@@ -146,7 +147,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -751626136500933347
+      hash: 2246136145939191408
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -155,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -751626136500933347
+      hash: 2246136145939191408
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -180,6 +181,7 @@ test_files:
 - spec/fixtures/projects.json
 - spec/fixtures/session.json
 - spec/fixtures/snippet.json
+- spec/fixtures/snippets.json
 - spec/fixtures/team_member.json
 - spec/fixtures/team_members.json
 - spec/fixtures/user.json