Refactor API classes. So api classes like Gitlab::Issues become API::Issues

Dmitriy Zaporozhets
1 parent e6224942
Showing 28 changed files with 68 additions and 68 deletions Show diff stats
app/controllers/application_controller.rb
config/routes.rb
lib/api.rb
lib/api/api.rb
lib/api/entities.rb
lib/api/groups.rb
lib/api/helpers.rb
lib/api/internal.rb
lib/api/issues.rb
lib/api/merge_requests.rb
lib/api/milestones.rb
lib/api/notes.rb
lib/api/projects.rb
lib/api/session.rb
lib/api/system_hooks.rb
lib/api/users.rb
spec/requests/api/groups_spec.rb
spec/requests/api/internal_spec.rb
spec/requests/api/issues_spec.rb
spec/requests/api/merge_requests_spec.rb
@@ -152,7 +152,7 @@ class ApplicationController &lt; ActionController::Base
  
   def add_gon_variables
     gon.default_issues_tracker = Project.issues_tracker.default_value
-    gon.api_version = Gitlab::API.version
+    gon.api_version = API::API.version
     gon.api_token = current_user.private_token if current_user
     gon.gravatar_url = request.ssl? ? Gitlab.config.gravatar.ssl_url : Gitlab.config.gravatar.plain_url
     gon.relative_url_root = Gitlab.config.gitlab.relative_url_root
 require 'sidekiq/web'
+require 'api/api'
  
 Gitlab::Application.routes.draw do
   #
@@ -7,9 +8,8 @@ Gitlab::Application.routes.draw do
   get 'search' => "search#show"
  
   # API
-  require 'api'
-  Gitlab::API.logger Rails.logger
-  mount Gitlab::API => '/api'
+  API::API.logger Rails.logger
+  mount API::API => '/api'
  
   constraint = lambda { |request| request.env["warden"].authenticate? and request.env['warden'].user.admin? }
   constraints constraint do
@@ -1,38 +0,0 @@
-Dir["#{Rails.root}/lib/api/*.rb"].each {|file| require file}
-
-module Gitlab
-  class API < Grape::API
-    version 'v3', using: :path
-
-    rescue_from ActiveRecord::RecordNotFound do
-      rack_response({'message' => '404 Not found'}.to_json, 404)
-    end
-
-    rescue_from :all do |exception|
-      # lifted from https://github.com/rails/rails/blob/master/actionpack/lib/action_dispatch/middleware/debug_exceptions.rb#L60
-      # why is this not wrapped in something reusable?
-      trace = exception.backtrace
-
-      message = "\n#{exception.class} (#{exception.message}):\n"
-      message << exception.annoted_source_code.to_s if exception.respond_to?(:annoted_source_code)
-      message << "  " << trace.join("\n  ")
-
-      API.logger.add Logger::FATAL, message
-      rack_response({'message' => '500 Internal Server Error'}, 500)
-    end
-
-    format :json
-    helpers APIHelpers
-
-    mount Groups
-    mount Users
-    mount Projects
-    mount Issues
-    mount Milestones
-    mount Session
-    mount MergeRequests
-    mount Notes
-    mount Internal
-    mount SystemHooks
-  end
-end
@@ -0,0 +1,38 @@
+Dir["#{Rails.root}/lib/api/*.rb"].each {|file| require file}
+
+module API
+  class API < Grape::API
+    version 'v3', using: :path
+
+    rescue_from ActiveRecord::RecordNotFound do
+      rack_response({'message' => '404 Not found'}.to_json, 404)
+    end
+
+    rescue_from :all do |exception|
+      # lifted from https://github.com/rails/rails/blob/master/actionpack/lib/action_dispatch/middleware/debug_exceptions.rb#L60
+      # why is this not wrapped in something reusable?
+      trace = exception.backtrace
+
+      message = "\n#{exception.class} (#{exception.message}):\n"
+      message << exception.annoted_source_code.to_s if exception.respond_to?(:annoted_source_code)
+      message << "  " << trace.join("\n  ")
+
+      API.logger.add Logger::FATAL, message
+      rack_response({'message' => '500 Internal Server Error'}, 500)
+    end
+
+    format :json
+    helpers APIHelpers
+
+    mount Groups
+    mount Users
+    mount Projects
+    mount Issues
+    mount Milestones
+    mount Session
+    mount MergeRequests
+    mount Notes
+    mount Internal
+    mount SystemHooks
+  end
+end
-module Gitlab
+module API
   module Entities
     class User < Grape::Entity
       expose :id, :username, :email, :name, :bio, :skype, :linkedin, :twitter,
-module Gitlab
+module API
   # groups API
   class Groups < Grape::API
     before { authenticate! }
-module Gitlab
+module API
   module APIHelpers
     def current_user
       @current_user ||= User.find_by_authentication_token(params[:private_token] || env["HTTP_PRIVATE_TOKEN"])
-module Gitlab
+module API
   # Internal access API
   class Internal < Grape::API
     namespace 'internal' do
@@ -58,7 +58,7 @@ module Gitlab
  
       get "/check" do
         {
-          api_version: Gitlab::API.version,
+          api_version: API.version,
           gitlab_version: Gitlab::VERSION,
           gitlab_rev: Gitlab::REVISION,
         }
-module Gitlab
+module API
   # Issues API
   class Issues < Grape::API
     before { authenticate! }
-module Gitlab
+module API
   # MergeRequest API
   class MergeRequests < Grape::API
     before { authenticate! }
-module Gitlab
+module API
   # Milestones API
   class Milestones < Grape::API
     before { authenticate! }
-module Gitlab
+module API
   # Notes API
   class Notes < Grape::API
     before { authenticate! }
-module Gitlab
+module API
   # Projects API
   class Projects < Grape::API
     before { authenticate! }
-module Gitlab
+module API
   # Users API
   class Session < Grape::API
     # Login to get token
-module Gitlab
+module API
   # Hooks API
   class SystemHooks < Grape::API
     before {
-module Gitlab
+module API
   # Users API
   class Users < Grape::API
     before { authenticate! }
 require 'spec_helper'
  
-describe Gitlab::API do
+describe API::API do
   include ApiHelpers
  
   let(:user1)  { create(:user) }
 require 'spec_helper'
  
-describe Gitlab::API do
+describe API::API do
   include ApiHelpers
  
   let(:user) { create(:user) }
@@ -12,7 +12,7 @@ describe Gitlab::API do
       get api("/internal/check")
  
       response.status.should == 200
-      json_response['api_version'].should == Gitlab::API.version
+      json_response['api_version'].should == API::API.version
     end
   end
  
 require 'spec_helper'
  
-describe Gitlab::API do
+describe API::API do
   include ApiHelpers
  
   let(:user) { create(:user) }
 require "spec_helper"
  
-describe Gitlab::API do
+describe API::API do
   include ApiHelpers
  
   let(:user) { create(:user ) }
 require 'spec_helper'
  
-describe Gitlab::API do
+describe API::API do
   include ApiHelpers
   before(:each) { enable_observers }
  
 require 'spec_helper'
  
-describe Gitlab::API do
+describe API::API do
   include ApiHelpers
  
   let(:user) { create(:user) }
 require 'spec_helper'
  
-describe Gitlab::API do
+describe API::API do
   include ApiHelpers
   before(:each) { enable_observers }
  
 require 'spec_helper'
  
-describe Gitlab::API do
+describe API::API do
   include ApiHelpers
  
   let(:user) { create(:user) }
 require 'spec_helper'
  
-describe Gitlab::API do
+describe API::API do
   include ApiHelpers
  
   let(:user) { create(:user) }
 require 'spec_helper'
  
-describe Gitlab::API do
+describe API::API do
   include ApiHelpers
  
   let(:user)  { create(:user) }
@@ -7,7 +7,7 @@ describe SearchController, &quot;routing&quot; do
   end
 end
  
-# gitlab_api /api         Gitlab::API
+# gitlab_api /api         API::API
 #     resque /info/resque Resque::Server
 #            /:path       Grack
 describe "Mounted Apps", "routing" do
@@ -18,7 +18,7 @@ module ApiHelpers
   #
   # Returns the relative path to the requested API resource
   def api(path, user = nil)
-    "/api/#{Gitlab::API.version}#{path}" +
+    "/api/#{API::API.version}#{path}" +
  
       # Normalize query string
       (path.index('?') ? '' : '?') +
...	...	@@ -152,7 +152,7 @@ class ApplicationController < ActionController::Base
152	152
153	153	def add_gon_variables
154	154	gon.default_issues_tracker = Project.issues_tracker.default_value
155		- gon.api_version = Gitlab::API.version
	155	+ gon.api_version = API::API.version
156	156	gon.api_token = current_user.private_token if current_user
157	157	gon.gravatar_url = request.ssl? ? Gitlab.config.gravatar.ssl_url : Gitlab.config.gravatar.plain_url
158	158	gon.relative_url_root = Gitlab.config.gitlab.relative_url_root
...	...
1	1	require 'sidekiq/web'
	2	+require 'api/api'
2	3
3	4	Gitlab::Application.routes.draw do
4	5	#
...	...	@@ -7,9 +8,8 @@ Gitlab::Application.routes.draw do
7	8	get 'search' => "search#show"
8	9
9	10	# API
10		- require 'api'
11		- Gitlab::API.logger Rails.logger
12		- mount Gitlab::API => '/api'
	11	+ API::API.logger Rails.logger
	12	+ mount API::API => '/api'
13	13
14	14	constraint = lambda { \|request\| request.env["warden"].authenticate? and request.env['warden'].user.admin? }
15	15	constraints constraint do
...	...
...	...	@@ -1,38 +0,0 @@
1		-Dir["#{Rails.root}/lib/api/*.rb"].each {\|file\| require file}
2		-
3		-module Gitlab
4		- class API < Grape::API
5		- version 'v3', using: :path
6		-
7		- rescue_from ActiveRecord::RecordNotFound do
8		- rack_response({'message' => '404 Not found'}.to_json, 404)
9		- end
10		-
11		- rescue_from :all do \|exception\|
12		- # lifted from https://github.com/rails/rails/blob/master/actionpack/lib/action_dispatch/middleware/debug_exceptions.rb#L60
13		- # why is this not wrapped in something reusable?
14		- trace = exception.backtrace
15		-
16		- message = "\n#{exception.class} (#{exception.message}):\n"
17		- message << exception.annoted_source_code.to_s if exception.respond_to?(:annoted_source_code)
18		- message << " " << trace.join("\n ")
19		-
20		- API.logger.add Logger::FATAL, message
21		- rack_response({'message' => '500 Internal Server Error'}, 500)
22		- end
23		-
24		- format :json
25		- helpers APIHelpers
26		-
27		- mount Groups
28		- mount Users
29		- mount Projects
30		- mount Issues
31		- mount Milestones
32		- mount Session
33		- mount MergeRequests
34		- mount Notes
35		- mount Internal
36		- mount SystemHooks
37		- end
38		-end
...	...	@@ -0,0 +1,38 @@
	1	+Dir["#{Rails.root}/lib/api/*.rb"].each {\|file\| require file}
	2	+
	3	+module API
	4	+ class API < Grape::API
	5	+ version 'v3', using: :path
	6	+
	7	+ rescue_from ActiveRecord::RecordNotFound do
	8	+ rack_response({'message' => '404 Not found'}.to_json, 404)
	9	+ end
	10	+
	11	+ rescue_from :all do \|exception\|
	12	+ # lifted from https://github.com/rails/rails/blob/master/actionpack/lib/action_dispatch/middleware/debug_exceptions.rb#L60
	13	+ # why is this not wrapped in something reusable?
	14	+ trace = exception.backtrace
	15	+
	16	+ message = "\n#{exception.class} (#{exception.message}):\n"
	17	+ message << exception.annoted_source_code.to_s if exception.respond_to?(:annoted_source_code)
	18	+ message << " " << trace.join("\n ")
	19	+
	20	+ API.logger.add Logger::FATAL, message
	21	+ rack_response({'message' => '500 Internal Server Error'}, 500)
	22	+ end
	23	+
	24	+ format :json
	25	+ helpers APIHelpers
	26	+
	27	+ mount Groups
	28	+ mount Users
	29	+ mount Projects
	30	+ mount Issues
	31	+ mount Milestones
	32	+ mount Session
	33	+ mount MergeRequests
	34	+ mount Notes
	35	+ mount Internal
	36	+ mount SystemHooks
	37	+ end
	38	+end
...	...
1		-module Gitlab
	1	+module API
2	2	module Entities
3	3	class User < Grape::Entity
4	4	expose :id, :username, :email, :name, :bio, :skype, :linkedin, :twitter,
...	...
1		-module Gitlab
	1	+module API
2	2	# groups API
3	3	class Groups < Grape::API
4	4	before { authenticate! }
...	...
1		-module Gitlab
	1	+module API
2	2	module APIHelpers
3	3	def current_user
4	4	@current_user \|\|= User.find_by_authentication_token(params[:private_token] \|\| env["HTTP_PRIVATE_TOKEN"])
...	...
1		-module Gitlab
	1	+module API
2	2	# Internal access API
3	3	class Internal < Grape::API
4	4	namespace 'internal' do
...	...	@@ -58,7 +58,7 @@ module Gitlab
58	58
59	59	get "/check" do
60	60	{
61		- api_version: Gitlab::API.version,
	61	+ api_version: API.version,
62	62	gitlab_version: Gitlab::VERSION,
63	63	gitlab_rev: Gitlab::REVISION,
64	64	}
...	...
1		-module Gitlab
	1	+module API
2	2	# Issues API
3	3	class Issues < Grape::API
4	4	before { authenticate! }
...	...
1		-module Gitlab
	1	+module API
2	2	# MergeRequest API
3	3	class MergeRequests < Grape::API
4	4	before { authenticate! }
...	...