Extract commits API to separate file

Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>

app/views/help/_api_layout.html.haml

@@ -5,7 +5,7 @@
         %i.icon-angle-left
         Back to help
     %ul.nav.nav-pills.nav-stacked
-      - %w(README projects project_snippets repositories repository_files deploy_keys users groups session issues milestones merge_requests notes system_hooks).each do |file|
+      - %w(README projects project_snippets repositories repository_files commits deploy_keys users groups session issues milestones merge_requests notes system_hooks).each do |file|
         %li{class: file == @category ? 'active' : nil}
           = link_to file.titleize, help_api_file_path(file)
 

doc/api/README.md

@@ -128,6 +128,7 @@ But when you want to create a link to web page - use  `http:://host/project/issu
 + [Project Snippets](project_snippets.md)
 + [Repositories](repositories.md)
 + [Repository Files](repository_files.md)
++ [Commits](commits.md)
 + [Merge Requests](merge_requests.md)
 + [Issues](issues.md)
 + [Milestones](milestones.md)

doc/api/commits.md

+# Commits API
+
+## List repository commits
+
+Get a list of repository commits in a project.
+
+```
+GET /projects/:id/repository/commits
+```
+
+Parameters:
+
++ `id` (required) - The ID of a project
++ `ref_name` (optional) - The name of a repository branch or tag or if not given the default branch
+
+```json
+[
+  {
+    "id": "ed899a2f4b50b4370feeea94676502b42383c746",
+    "short_id": "ed899a2f4b5",
+    "title": "Replace sanitize with escape once",
+    "author_name": "Dmitriy Zaporozhets",
+    "author_email": "dzaporozhets@sphereconsultinginc.com",
+    "created_at": "2012-09-20T11:50:22+03:00"
+  },
+  {
+    "id": "6104942438c14ec7bd21c6cd5bd995272b3faff6",
+    "short_id": "6104942438c",
+    "title": "Sanitize for network graph",
+    "author_name": "randx",
+    "author_email": "dmitriy.zaporozhets@gmail.com",
+    "created_at": "2012-09-20T09:06:12+03:00"
+  }
+]
+```
+
+## Get a single commit
+
+Get a specific commit identified by the commit hash or name of a branch or tag.
+
+```
+GET /projects/:id/repository/commits/:sha
+```
+
+Parameters:
+
++ `id` (required) - The ID of a project
++ `sha` (required) - The commit hash or name of a repository branch or tag
+
+```json
+{
+  "id": "6104942438c14ec7bd21c6cd5bd995272b3faff6",
+  "short_id": "6104942438c",
+  "title": "Sanitize for network graph",
+  "author_name": "randx",
+  "author_email": "dmitriy.zaporozhets@gmail.com",
+  "created_at": "2012-09-20T09:06:12+03:00",
+  "committed_date": "2012-09-20T09:06:12+03:00",
+  "authored_date": "2012-09-20T09:06:12+03:00",
+  "parent_ids" : [
+      "ae1d9fb46aa2b07ee9836d49862ec4e2c46fbbba"
+   ]
+}
+```
+
+
+## Get the diff of a commit
+
+Get the diff of a commit in a project.
+
+```
+GET /projects/:id/repository/commits/:sha/diff
+```
+
+Parameters:
+
++ `id` (required) - The ID of a project
++ `sha` (required) - The name of a repository branch or tag or if not given the default branch
+
+```json
+[
+  {
+    "diff": "--- a/doc/update/5.4-to-6.0.md\n+++ b/doc/update/5.4-to-6.0.md\n@@ -71,6 +71,8 @@\n sudo -u git -H bundle exec rake migrate_keys RAILS_ENV=production\n sudo -u git -H bundle exec rake migrate_inline_notes RAILS_ENV=production\n \n+sudo -u git -H bundle exec rake assets:precompile RAILS_ENV=production\n+\n ```\n \n ### 6. Update config files",
+    "new_path": "doc/update/5.4-to-6.0.md",
+    "old_path": "doc/update/5.4-to-6.0.md",
+    "a_mode": null,
+    "b_mode": "100644",
+    "new_file": false,
+    "renamed_file": false,
+    "deleted_file": false
+  }
+]
+```
+
+

doc/api/repositories.md

@@ -204,99 +204,6 @@ Parameters:
 ]
 ```
 
-
-## List repository commits
-
-Get a list of repository commits in a project.
-
-```
-GET /projects/:id/repository/commits
-```
-
-Parameters:
-
-+ `id` (required) - The ID of a project
-+ `ref_name` (optional) - The name of a repository branch or tag or if not given the default branch
-
-```json
-[
-  {
-    "id": "ed899a2f4b50b4370feeea94676502b42383c746",
-    "short_id": "ed899a2f4b5",
-    "title": "Replace sanitize with escape once",
-    "author_name": "Dmitriy Zaporozhets",
-    "author_email": "dzaporozhets@sphereconsultinginc.com",
-    "created_at": "2012-09-20T11:50:22+03:00"
-  },
-  {
-    "id": "6104942438c14ec7bd21c6cd5bd995272b3faff6",
-    "short_id": "6104942438c",
-    "title": "Sanitize for network graph",
-    "author_name": "randx",
-    "author_email": "dmitriy.zaporozhets@gmail.com",
-    "created_at": "2012-09-20T09:06:12+03:00"
-  }
-]
-```
-
-## Get a single commit
-
-Get a specific commit identified by the commit hash or name of a branch or tag.
-
-```
-GET /projects/:id/repository/commits/:sha
-```
-
-Parameters:
-
-+ `id` (required) - The ID of a project
-+ `sha` (required) - The commit hash or name of a repository branch or tag
-
-```json
-{
-  "id": "6104942438c14ec7bd21c6cd5bd995272b3faff6",
-  "short_id": "6104942438c",
-  "title": "Sanitize for network graph",
-  "author_name": "randx",
-  "author_email": "dmitriy.zaporozhets@gmail.com",
-  "created_at": "2012-09-20T09:06:12+03:00",
-  "committed_date": "2012-09-20T09:06:12+03:00",
-  "authored_date": "2012-09-20T09:06:12+03:00",
-  "parent_ids" : [
-      "ae1d9fb46aa2b07ee9836d49862ec4e2c46fbbba"
-   ]
-}
-```
-
-
-## Get the diff of a commit
-
-Get the diff of a commit in a project.
-
-```
-GET /projects/:id/repository/commits/:sha/diff
-```
-
-Parameters:
-
-+ `id` (required) - The ID of a project
-+ `sha` (required) - The name of a repository branch or tag or if not given the default branch
-
-```json
-[
-  {
-    "diff": "--- a/doc/update/5.4-to-6.0.md\n+++ b/doc/update/5.4-to-6.0.md\n@@ -71,6 +71,8 @@\n sudo -u git -H bundle exec rake migrate_keys RAILS_ENV=production\n sudo -u git -H bundle exec rake migrate_inline_notes RAILS_ENV=production\n \n+sudo -u git -H bundle exec rake assets:precompile RAILS_ENV=production\n+\n ```\n \n ### 6. Update config files",
-    "new_path": "doc/update/5.4-to-6.0.md",
-    "old_path": "doc/update/5.4-to-6.0.md",
-    "a_mode": null,
-    "b_mode": "100644",
-    "new_file": false,
-    "renamed_file": false,
-    "deleted_file": false
-  }
-]
-```
-
 ## List repository tree
 
 Get a list of repository files and directories in a project.

lib/api/api.rb

@@ -40,6 +40,7 @@ module API
     mount ProjectHooks
     mount Services
     mount Files
+    mount Commits
     mount Namespaces
   end
 end

lib/api/commits.rb

+require 'mime/types'
+
+module API
+  # Projects API
+  class Commits < Grape::API
+    before { authenticate! }
+    before { authorize! :download_code, user_project }
+
+    resource :projects do
+      helpers do
+        def handle_project_member_errors(errors)
+          if errors[:project_access].any?
+            error!(errors[:project_access], 422)
+          end
+          not_found!
+        end
+      end
+
+      # Get a project repository commits
+      #
+      # Parameters:
+      #   id (required) - The ID of a project
+      #   ref_name (optional) - The name of a repository branch or tag, if not given the default branch is used
+      # Example Request:
+      #   GET /projects/:id/repository/commits
+      get ":id/repository/commits" do
+        page = (params[:page] || 0).to_i
+        per_page = (params[:per_page] || 20).to_i
+        ref = params[:ref_name] || user_project.try(:default_branch) || 'master'
+
+        commits = user_project.repository.commits(ref, nil, per_page, page * per_page)
+        present commits, with: Entities::RepoCommit
+      end
+
+      # Get a specific commit of a project
+      #
+      # Parameters:
+      #   id (required) - The ID of a project
+      #   sha (required) - The commit hash or name of a repository branch or tag
+      # Example Request:
+      #   GET /projects/:id/repository/commits/:sha
+      get ":id/repository/commits/:sha" do
+        sha = params[:sha]
+        commit = user_project.repository.commit(sha)
+        not_found! "Commit" unless commit
+        present commit, with: Entities::RepoCommitDetail
+      end
+
+      # Get the diff for a specific commit of a project
+      #
+      # Parameters:
+      #   id (required) - The ID of a project
+      #   sha (required) - The commit or branch name
+      # Example Request:
+      #   GET /projects/:id/repository/commits/:sha/diff
+      get ":id/repository/commits/:sha/diff" do
+        sha = params[:sha]
+        commit = user_project.repository.commit(sha)
+        not_found! "Commit" unless commit
+        commit.diffs
+      end
+    end
+  end
+end

lib/api/repositories.rb

@@ -85,50 +85,6 @@ module API
         present user_project.repo.tags.sort_by(&:name).reverse, with: Entities::RepoObject, project: user_project
       end
 
-      # Get a project repository commits
-      #
-      # Parameters:
-      #   id (required) - The ID of a project
-      #   ref_name (optional) - The name of a repository branch or tag, if not given the default branch is used
-      # Example Request:
-      #   GET /projects/:id/repository/commits
-      get ":id/repository/commits" do
-        page = (params[:page] || 0).to_i
-        per_page = (params[:per_page] || 20).to_i
-        ref = params[:ref_name] || user_project.try(:default_branch) || 'master'
-
-        commits = user_project.repository.commits(ref, nil, per_page, page * per_page)
-        present commits, with: Entities::RepoCommit
-      end
-
-      # Get a specific commit of a project
-      #
-      # Parameters:
-      #   id (required) - The ID of a project
-      #   sha (required) - The commit hash or name of a repository branch or tag
-      # Example Request:
-      #   GET /projects/:id/repository/commits/:sha
-      get ":id/repository/commits/:sha" do
-        sha = params[:sha]
-        commit = user_project.repository.commit(sha)
-        not_found! "Commit" unless commit
-        present commit, with: Entities::RepoCommitDetail
-      end
-
-      # Get the diff for a specific commit of a project
-      #
-      # Parameters:
-      #   id (required) - The ID of a project
-      #   sha (required) - The commit or branch name
-      # Example Request:
-      #   GET /projects/:id/repository/commits/:sha/diff
-      get ":id/repository/commits/:sha/diff" do
-        sha = params[:sha]
-        commit = user_project.repository.commit(sha)
-        not_found! "Commit" unless commit
-        commit.diffs
-      end
-
       # Get a project repository tree
       #
       # Parameters:

spec/requests/api/commits_spec.rb

+require 'spec_helper'
+require 'mime/types'
+
+describe API::API do
+  include ApiHelpers
+  before(:each) { enable_observers }
+  after(:each) {disable_observers}
+
+  let(:user) { create(:user) }
+  let(:user2) { create(:user) }
+  let!(:project) { create(:project, creator_id: user.id) }
+  let!(:master) { create(:users_project, user: user, project: project, project_access: UsersProject::MASTER) }
+  let!(:guest) { create(:users_project, user: user2, project: project, project_access: UsersProject::GUEST) }
+
+  before { project.team << [user, :reporter] }
+
+  describe "GET /projects/:id/repository/commits" do
+    context "authorized user" do
+      before { project.team << [user2, :reporter] }
+
+      it "should return project commits" do
+        get api("/projects/#{project.id}/repository/commits", user)
+        response.status.should == 200
+
+        json_response.should be_an Array
+        json_response.first['id'].should == project.repository.commit.id
+      end
+    end
+
+    context "unauthorized user" do
+      it "should not return project commits" do
+        get api("/projects/#{project.id}/repository/commits")
+        response.status.should == 401
+      end
+    end
+  end
+
+  describe "GET /projects:id/repository/commits/:sha" do
+    context "authorized user" do
+      it "should return a commit by sha" do
+        get api("/projects/#{project.id}/repository/commits/#{project.repository.commit.id}", user)
+        response.status.should == 200
+        json_response['id'].should == project.repository.commit.id
+        json_response['title'].should == project.repository.commit.title
+      end
+
+      it "should return a 404 error if not found" do
+        get api("/projects/#{project.id}/repository/commits/invalid_sha", user)
+        response.status.should == 404
+      end
+    end
+
+    context "unauthorized user" do
+      it "should not return the selected commit" do
+        get api("/projects/#{project.id}/repository/commits/#{project.repository.commit.id}")
+        response.status.should == 401
+      end
+    end
+  end
+
+  describe "GET /projects:id/repository/commits/:sha/diff" do
+    context "authorized user" do
+      before { project.team << [user2, :reporter] }
+
+      it "should return the diff of the selected commit" do
+        get api("/projects/#{project.id}/repository/commits/#{project.repository.commit.id}/diff", user)
+        response.status.should == 200
+
+        json_response.should be_an Array
+        json_response.length.should >= 1
+        json_response.first.keys.should include "diff"
+      end
+
+      it "should return a 404 error if invalid commit" do
+        get api("/projects/#{project.id}/repository/commits/invalid_sha/diff", user)
+        response.status.should == 404
+      end
+    end
+
+    context "unauthorized user" do
+      it "should not return the diff of the selected commit" do
+        get api("/projects/#{project.id}/repository/commits/#{project.repository.commit.id}/diff")
+        response.status.should == 401
+      end
+    end
+  end
+end

spec/requests/api/repositories_spec.rb

@@ -103,77 +103,6 @@ describe API::API do
     end
   end
 
-  describe "GET /projects/:id/repository/commits" do
-    context "authorized user" do
-      before { project.team << [user2, :reporter] }
-
-      it "should return project commits" do
-        get api("/projects/#{project.id}/repository/commits", user)
-        response.status.should == 200
-
-        json_response.should be_an Array
-        json_response.first['id'].should == project.repository.commit.id
-      end
-    end
-
-    context "unauthorized user" do
-      it "should not return project commits" do
-        get api("/projects/#{project.id}/repository/commits")
-        response.status.should == 401
-      end
-    end
-  end
-
-  describe "GET /projects:id/repository/commits/:sha" do
-    context "authorized user" do
-      it "should return a commit by sha" do
-        get api("/projects/#{project.id}/repository/commits/#{project.repository.commit.id}", user)
-        response.status.should == 200
-        json_response['id'].should == project.repository.commit.id
-        json_response['title'].should == project.repository.commit.title
-      end
-
-      it "should return a 404 error if not found" do
-        get api("/projects/#{project.id}/repository/commits/invalid_sha", user)
-        response.status.should == 404
-      end
-    end
-
-    context "unauthorized user" do
-      it "should not return the selected commit" do
-        get api("/projects/#{project.id}/repository/commits/#{project.repository.commit.id}")
-        response.status.should == 401
-      end
-    end
-  end
-
-  describe "GET /projects:id/repository/commits/:sha/diff" do
-    context "authorized user" do
-      before { project.team << [user2, :reporter] }
-
-      it "should return the diff of the selected commit" do
-        get api("/projects/#{project.id}/repository/commits/#{project.repository.commit.id}/diff", user)
-        response.status.should == 200
-
-        json_response.should be_an Array
-        json_response.length.should >= 1
-        json_response.first.keys.should include "diff"
-      end
-
-      it "should return a 404 error if invalid commit" do
-        get api("/projects/#{project.id}/repository/commits/invalid_sha/diff", user)
-        response.status.should == 404
-      end
-    end
-
-    context "unauthorized user" do
-      it "should not return the diff of the selected commit" do
-        get api("/projects/#{project.id}/repository/commits/#{project.repository.commit.id}/diff")
-        response.status.should == 401
-      end
-    end
-  end
-
   describe "GET /projects/:id/repository/tree" do
     context "authorized user" do
       before { project.team << [user2, :reporter] }