Merge branch 'grapify-settings-api' into 'master'

Grapify the settings API

See merge request !8336

doc/api/settings.md

@@ -79,6 +79,7 @@ PUT /application/settings
 | `enabled_git_access_protocol` | string | no | Enabled protocols for Git access. Allowed values are: `ssh`, `http`, and `nil` to allow both protocols. |
 | `koding_enabled` | boolean | no | Enable Koding integration. Default is `false`. |
 | `koding_url` | string | yes (if `koding_enabled` is `true`) |  The Koding instance URL for integration. |
+| `disabled_oauth_sign_in_sources` | Array of strings | no | Disabled OAuth sign-in sources |
 
 ```bash
 curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/application/settings?signup_enabled=false&default_project_visibility=1

lib/api/settings.rb

@@ -9,23 +9,117 @@ module API
       end
     end
 
-    # Get current applicaiton settings
-    #
-    # Example Request:
-    #   GET /application/settings
+    desc 'Get the current application settings' do
+      success Entities::ApplicationSetting
+    end
     get "application/settings" do
       present current_settings, with: Entities::ApplicationSetting
     end
 
-    # Modify application settings
-    #
-    # Example Request:
-    #   PUT /application/settings
+    desc 'Modify application settings' do
+      success Entities::ApplicationSetting
+    end
+    params do
+      optional :default_branch_protection, type: Integer, values: [0, 1, 2], desc: 'Determine if developers can push to master'
+      optional :default_project_visibility, type: Integer, values: Gitlab::VisibilityLevel.values, desc: 'The default project visibility'
+      optional :default_snippet_visibility, type: Integer, values: Gitlab::VisibilityLevel.values, desc: 'The default snippet visibility'
+      optional :default_group_visibility, type: Integer, values: Gitlab::VisibilityLevel.values, desc: 'The default group visibility'
+      optional :restricted_visibility_levels, type: Array[String], desc: 'Selected levels cannot be used by non-admin users for projects or snippets. If the public level is restricted, user profiles are only visible to logged in users.'
+      optional :import_sources, type: Array[String], values: %w[github bitbucket gitlab google_code fogbugz git gitlab_project],
+                                desc: 'Enabled sources for code import during project creation. OmniAuth must be configured for GitHub, Bitbucket, and GitLab.com'
+      optional :disabled_oauth_sign_in_sources, type: Array[String], desc: 'Disable certain OAuth sign-in sources'
+      optional :enabled_git_access_protocol, type: String, values: %w[ssh http nil], desc: 'Allow only the selected protocols to be used for Git access.'
+      optional :gravatar_enabled, type: Boolean, desc: 'Flag indicating if the Gravatar service is enabled'
+      optional :default_projects_limit, type: Integer, desc: 'The maximum number of personal projects'
+      optional :max_attachment_size, type: Integer, desc: 'Maximum attachment size in MB'
+      optional :session_expire_delay, type: Integer, desc: 'Session duration in minutes. GitLab restart is required to apply changes.'
+      optional :user_oauth_applications, type: Boolean, desc: 'Allow users to register any application to use GitLab as an OAuth provider'
+      optional :user_default_external, type: Boolean, desc: 'Newly registered users will by default be external'
+      optional :signup_enabled, type: Boolean, desc: 'Flag indicating if sign up is enabled'
+      optional :send_user_confirmation_email, type: Boolean, desc: 'Send confirmation email on sign-up'
+      optional :domain_whitelist, type: String, desc: 'ONLY users with e-mail addresses that match these domain(s) will be able to sign-up. Wildcards allowed. Use separate lines for multiple entries. Ex: domain.com, *.domain.com'
+      optional :domain_blacklist_enabled, type: Boolean, desc: 'Enable domain blacklist for sign ups'
+      given domain_blacklist_enabled: ->(val) { val } do
+        requires :domain_blacklist, type: String, desc: 'Users with e-mail addresses that match these domain(s) will NOT be able to sign-up. Wildcards allowed. Use separate lines for multiple entries. Ex: domain.com, *.domain.com'
+      end
+      optional :after_sign_up_text, type: String, desc: 'Text shown after sign up'
+      optional :signin_enabled, type: Boolean, desc: 'Flag indicating if sign in is enabled'
+      optional :require_two_factor_authentication, type: Boolean, desc: 'Require all users to setup Two-factor authentication'
+      given require_two_factor_authentication: ->(val) { val } do
+        requires :two_factor_grace_period, type: Integer, desc: 'Amount of time (in hours) that users are allowed to skip forced configuration of two-factor authentication'
+      end
+      optional :home_page_url, type: String, desc: 'We will redirect non-logged in users to this page'
+      optional :after_sign_out_path, type: String, desc: 'We will redirect users to this page after they sign out'
+      optional :sign_in_text, type: String, desc: 'The sign in text of the GitLab application'
+      optional :help_page_text, type: String, desc: 'Custom text displayed on the help page'
+      optional :shared_runners_enabled, type: Boolean, desc: 'Enable shared runners for new projects'
+      given shared_runners_enabled: ->(val) { val } do
+        requires :shared_runners_text, type: String, desc: 'Shared runners text '
+      end
+      optional :max_artifacts_size, type: Integer, desc: "Set the maximum file size each build's artifacts can have"
+      optional :container_registry_token_expire_delay, type: Integer, desc: 'Authorization token duration (minutes)'
+      optional :metrics_enabled, type: Boolean, desc: 'Enable the InfluxDB metrics'
+      given metrics_enabled: ->(val) { val } do
+        requires :metrics_host, type: String, desc: 'The InfluxDB host'
+        requires :metrics_port, type: Integer, desc: 'The UDP port to use for connecting to InfluxDB'
+        requires :metrics_pool_size, type: Integer, desc: 'The amount of InfluxDB connections to open'
+        requires :metrics_timeout, type: Integer, desc: 'The amount of seconds after which an InfluxDB connection will time out'
+        requires :metrics_method_call_threshold, type: Integer, desc: 'A method call is only tracked when it takes longer to complete than the given amount of milliseconds.'
+        requires :metrics_sample_interval, type: Integer, desc: 'The sampling interval in seconds'
+        requires :metrics_packet_size, type: Integer, desc: 'The amount of points to store in a single UDP packet'
+      end
+      optional :sidekiq_throttling_enabled, type: Boolean, desc: 'Enable Sidekiq Job Throttling'
+      given sidekiq_throttling_enabled: ->(val) { val } do
+        requires :sidekiq_throttling_queus, type: Array[String], desc: 'Choose which queues you wish to throttle'
+        requires :sidekiq_throttling_factor, type: Float, desc: 'The factor by which the queues should be throttled. A value between 0.0 and 1.0, exclusive.'
+      end
+      optional :recaptcha_enabled, type: Boolean, desc: 'Helps prevent bots from creating accounts'
+      given recaptcha_enabled: ->(val) { val } do
+        requires :recaptcha_site_key, type: String, desc: 'Generate site key at http://www.google.com/recaptcha'
+        requires :recaptcha_private_key, type: String, desc: 'Generate private key at http://www.google.com/recaptcha'
+      end
+      optional :akismet_enabled, type: Boolean, desc: 'Helps prevent bots from creating issues'
+      given akismet_enabled: ->(val) { val } do
+        requires :akismet_api_key, type: String, desc: 'Generate API key at http://www.akismet.com'
+      end
+      optional :admin_notification_email, type: String, desc: 'Abuse reports will be sent to this address if it is set. Abuse reports are always available in the admin area.'
+      optional :sentry_enabled, type: Boolean, desc: 'Sentry is an error reporting and logging tool which is currently not shipped with GitLab, get it here: https://getsentry.com'
+      given sentry_enabled: ->(val) { val } do
+        requires :sentry_dsn, type: String, desc: 'Sentry Data Source Name'
+      end
+      optional :repository_storage, type: String, desc: 'Storage paths for new projects'
+      optional :repository_checks_enabled, type: Boolean, desc: "GitLab will periodically run 'git fsck' in all project and wiki repositories to look for silent disk corruption issues."
+      optional :koding_enabled, type: Boolean, desc: 'Enable Koding'
+      given koding_enabled: ->(val) { val } do
+        requires :koding_url, type: String, desc: 'The Koding team URL'
+      end
+      optional :version_check_enabled, type: Boolean, desc: 'Let GitLab inform you when an update is available.'
+      optional :email_author_in_body, type: Boolean, desc: 'Some email servers do not support overriding the email sender name. Enable this option to include the name of the author of the issue, merge request or comment in the email body instead.'
+      optional :html_emails_enabled, type: Boolean, desc: 'By default GitLab sends emails in HTML and plain text formats so mail clients can choose what format to use. Disable this option if you only want to send emails in plain text format.'
+      optional :housekeeping_enabled, type: Boolean, desc: 'Enable automatic repository housekeeping (git repack, git gc)'
+      given housekeeping_enabled: ->(val) { val } do
+        requires :housekeeping_bitmaps_enabled, type: Boolean, desc: "Creating pack file bitmaps makes housekeeping take a little longer but bitmaps should accelerate 'git clone' performance."
+        requires :housekeeping_incremental_repack_period, type: Integer, desc: "Number of Git pushes after which an incremental 'git repack' is run."
+        requires :housekeeping_full_repack_period, type: Integer, desc: "Number of Git pushes after which a full 'git repack' is run."
+        requires :housekeeping_gc_period, type: Integer, desc: "Number of Git pushes after which 'git gc' is run."
+      end
+      at_least_one_of :default_branch_protection, :default_project_visibility, :default_snippet_visibility,
+                      :default_group_visibility, :restricted_visibility_levels, :import_sources,
+                      :enabled_git_access_protocol, :gravatar_enabled, :default_projects_limit,
+                      :max_attachment_size, :session_expire_delay, :disabled_oauth_sign_in_sources,
+                      :user_oauth_applications, :user_default_external, :signup_enabled,
+                      :send_user_confirmation_email, :domain_whitelist, :domain_blacklist_enabled,
+                      :after_sign_up_text, :signin_enabled, :require_two_factor_authentication,
+                      :home_page_url, :after_sign_out_path, :sign_in_text, :help_page_text,
+                      :shared_runners_enabled, :max_artifacts_size, :container_registry_token_expire_delay,
+                      :metrics_enabled, :sidekiq_throttling_enabled, :recaptcha_enabled,
+                      :akismet_enabled, :admin_notification_email, :sentry_enabled,
+                      :repository_storage, :repository_checks_enabled, :koding_enabled,
+                      :version_check_enabled, :email_author_in_body, :html_emails_enabled,
+                      :housekeeping_enabled
+    end
     put "application/settings" do
-      attributes = ["repository_storage"] + current_settings.attributes.keys - ["id"]
-      attrs = attributes_for_keys(attributes)
-
-      if current_settings.update_attributes(attrs)
+      if current_settings.update_attributes(declared_params(include_missing: false))
         present current_settings, with: Entities::ApplicationSetting
       else
         render_validation_error!(current_settings)

spec/requests/api/settings_spec.rb

@@ -44,8 +44,7 @@ describe API::Settings, 'Settings', api: true  do
         put api("/application/settings", admin), koding_enabled: true
 
         expect(response).to have_http_status(400)
-        expect(json_response['message']).to have_key('koding_url')
-        expect(json_response['message']['koding_url']).to include "can't be blank"
+        expect(json_response['error']).to eq('koding_url is missing')
       end
     end
   end