cyclid 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eff5a90aeccc36b649701ec2ec970f4dc1c11e9d
-  data.tar.gz: 103987b807c2b04930a68d96787d64cb3864b359
+  metadata.gz: 33d614a9893bc411011e194512153b90d56082a0
+  data.tar.gz: 0d607fd8d0892da8031255600cbd6703b42ffc5c
 SHA512:
-  metadata.gz: 802e3bce3fdd10e988997c282f635dda5cb81715bf6e0c6755bfc32ef1ef5491a424caa8d0cd1b03fee9befe18a5cd825e5ad053725b726070322e5d03dc19f4
-  data.tar.gz: 2562e60cf0591decaba4bb01ac515072695b3834cfd3c18c6589794655ea9cf0451d575bbbc006ae3f160d5a9e2fc6504ad2fa2b7c209fe528d9e54943518fda
+  metadata.gz: 90e8b58bb414d9116671741ce28d67106ac2075bda3a129a9a8775a555e30921d0455fa0c6ab10f50387952cdfb27e48c33ce9ea2f172c3384f90c954d0e47e2
+  data.tar.gz: d9b11717018b8f45f690fe2dd553603cfbaa59967cf65cb7e7ea1c9384f0f528e762440a1397c3eacf44c59184bc693ec17be594b683244a87d0a3b78c343af4

data/app/cyclid/controllers/organizations.rb

@@ -80,7 +80,7 @@ module Cyclid
             register Organizations::Jobs
           end
 
-          namespace '/configs/:type' do
+          namespace '/configs' do
             register Organizations::Configs
           end
 

data/app/cyclid/controllers/organizations/config.rb

@@ -25,6 +25,14 @@ module Cyclid
         # rubocop:disable Metrics/LineLength
         # @!group Organizations
 
+        # @!method get_organizations_organization_configs
+        # @overload GET /organizations/:organization/configs
+        # @macro rest
+        # @param [String] organization Name of the organization.
+        # Get the list of plugins which support per-organization configurations.
+        # @return The list of plugins.
+        # @return [404] The organization or plugin does not exist.
+
         # @!method get_organizations_organization_configs_type_plugin
         # @overload GET /organizations/:organization/configs/:type/:plugin
         # @macro rest
@@ -63,8 +71,21 @@ module Cyclid
           include Errors::HTTPErrors
           include Constants::JobStatus
 
+          # Return a list of plugins which have configs
+          app.get do
+            authorized_for!(params[:name], Operations::READ)
+
+            configs = []
+            Cyclid.plugins.all.each do |plugin|
+              configs << { type: plugin.human_name, name: plugin.name } \
+                if plugin.config?
+            end
+
+            return configs.to_json
+          end
+
           # Get the current configuration for the given plugin.
-          app.get '/:plugin' do
+          app.get '/:type/:plugin' do
             authorized_for!(params[:name], Operations::READ)
 
             org = Organization.find_by(name: params[:name])
@@ -96,7 +117,7 @@ module Cyclid
           end
 
           # Update the plugin configuration
-          app.put '/:plugin' do
+          app.put '/:type/:plugin' do
             authorized_for!(params[:name], Operations::ADMIN)
 
             payload = parse_request_body

data/app/cyclid/job/runner.rb

@@ -89,7 +89,7 @@ module Cyclid
 
             begin
               @builder.release(@transport, @build_host) if @build_host
-              @transport.close if @transport
+              @transport&.close
             rescue ::Net::SSH::Disconnect # rubocop:disable Lint/HandleExceptions
               # Ignored
             end

data/app/cyclid/log_buffer.rb

@@ -87,7 +87,7 @@ module Cyclid
         end
 
         # Write to web socket
-        @websocket.write data if @websocket
+        @websocket&.write data
       end
 
       # Non-destructively read any new data from the buffer

data/app/cyclid/plugins.rb

@@ -40,6 +40,11 @@ module Cyclid
             Cyclid.plugins.register(self)
           end
 
+          # Does this plugin support configuration data?
+          def config?
+            false
+          end
+
           # Get the configuration for the given org
           def get_config(org)
             # If the organization was passed by name, convert it into an Organization object
@@ -123,3 +128,8 @@ module Cyclid
 end
 
 require_rel 'plugins/*.rb'
+
+# Load all plugins from Gems
+Gem.find_files('cyclid/plugins/**/*.rb').each do |path|
+  require path
+end

data/app/cyclid/plugins/action/email.rb

@@ -157,6 +157,11 @@ module Cyclid
 
         # Static methods for handling plugin config data
         class << self
+          # This plugin has configuration data
+          def config?
+            true
+          end
+
           # Update the plugin configuration
           def update_config(current, new)
             current.merge! new
@@ -194,7 +199,7 @@ module Cyclid
                         description: 'SMTP server username',
                         default: nil }
             schema << { name: 'password',
-                        type: 'string',
+                        type: 'password',
                         description: 'SMTP server password',
                         default: nil }
 

data/app/cyclid/plugins/action/slack.rb

@@ -99,6 +99,11 @@ module Cyclid
 
         # Static methods for handling plugin config data
         class << self
+          # This plugin has configuration data
+          def config?
+            true
+          end
+
           # Update the plugin configuration
           def update_config(current, new)
             current.merge! new

data/app/cyclid/plugins/api.rb

@@ -26,64 +26,43 @@ module Cyclid
         class Controller < Module
           attr_reader :plugin_methods
 
-          def initialize(methods = nil)
+          def initialize(methods = nil, custom_routes = [])
             @plugin_methods = methods
+
+            # Provide default routes for the four basic HTTP verbs; for most
+            # plugins they only need to implement the matching method for the
+            # verb(s) they'll respond too.
+            default_routes = [{ verb: :get, path: nil, func: 'get' },
+                              { verb: :post, path: nil, func: 'post' },
+                              { verb: :put, path: nil, func: 'put' },
+                              { verb: :delete, path: nil, func: 'delete' }]
+
+            # ...but more complex plugins can add additional routes with their
+            # own paths & methods, if required.
+            @routes = default_routes.concat custom_routes
           end
 
           # Sinatra callback
           def registered(app)
             include Errors::HTTPErrors
 
-            app.get do
-              Cyclid.logger.debug 'ApiExtension::Controller::get'
-
-              org = Organization.find_by(name: params[:name])
-              halt_with_json_response(404, INVALID_ORG, 'organization does not exist') \
-                if org.nil?
-
-              config = controller_plugin.get_config(org)
-
-              get(http_headers(request.env), config['config'])
-            end
-
-            app.post do
-              Cyclid.logger.debug 'ApiExtension::Controller::post'
+            @routes.each do |route|
+              verb = route[:verb]
+              path = route[:path]
+              func = route[:func]
 
-              payload = parse_request_body
+              app.send(verb, path) do
+                Cyclid.logger.debug "ApiExtension::Controller::#{verb} #{path}"
 
-              org = Organization.find_by(name: params[:name])
-              halt_with_json_response(404, INVALID_ORG, 'organization does not exist') \
-                if org.nil?
+                org = Organization.find_by(name: params[:name])
+                halt_with_json_response(404, INVALID_ORG, 'organization does not exist') \
+                  if org.nil?
 
-              config = controller_plugin.get_config(org)
+                config = controller_plugin.get_config(org)
 
-              post(payload, http_headers(request.env), config['config'])
-            end
-
-            app.put do
-              Cyclid.logger.debug 'ApiExtension::Controller::put'
-
-              payload = parse_request_body
-
-              org = Organization.find_by(name: params[:name])
-              halt_with_json_response(404, INVALID_ORG, 'organization does not exist') \
-                if org.nil?
-
-              config = controller_plugin.get_config(org)
-
-              put(payload, http_headers(request.env), config['config'])
-            end
-
-            app.delete do
-              Cyclid.logger.debug 'ApiExtension::Controller::delete'
-
-              org = Organization.find_by(name: params[:name])
-              halt_with_json_response(404, INVALID_ORG, 'organization does not exist') \
-                if org.nil?
-
-              config = controller_plugin.get_config(org)
-
-              delete(http_headers(request.env), config['config'])
+                meth = method(func)
+                meth.call(http_headers(request.env), config['config'])
+              end
             end
 
             app.helpers do
@@ -107,13 +86,13 @@ module Cyclid
           end
 
           # POST callback
-          def post(_data, _headers, _config)
+          def post(_headers, _config)
             authorize('post')
             return_failure(405, 'not implemented')
           end
 
           # PUT callback
-          def put(_data, _headers, _config)
+          def put(_headers, _config)
             authorize('put')
             return_failure(405, 'not implemented')
           end
@@ -173,6 +152,20 @@ module Cyclid
 
             return http_headers
           end
+
+          # Return the current organization name
+          def organization_name
+            params[:name]
+          end
+
+          # Find & return the Organization model
+          def retrieve_organization(name = nil)
+            name ||= organization_name
+            org = Organization.find_by(name: name)
+            halt_with_json_response(404, INVALID_ORG, 'organization does not exist') \
+              if org.nil?
+            return org
+          end
         end
       end
 

data/app/cyclid/plugins/api/github.rb

@@ -14,7 +14,6 @@
 # limitations under the License.
 
 require_rel 'github/methods'
-require_rel 'github/status'
 require_rel 'github/callback'
 
 # Top level module for the core Cyclid code.
@@ -25,12 +24,20 @@ module Cyclid
     module Plugins
       # API extension for Github hooks
       class Github < Api
-        # Return an instance of the Github API controller
-        def self.controller
-          return ApiExtension::Controller.new(ApiExtension::GithubMethods)
-        end
-
         class << self
+          # Return an instance of the Github API controller
+          def controller
+            routes = [{ verb: :get, path: '/oauth/request', func: 'oauth_request' },
+                      { verb: :get, path: '/oauth/callback', func: 'oauth_callback' }]
+
+            return ApiExtension::Controller.new(ApiExtension::GithubMethods, routes)
+          end
+
+          # This plugin has configuration data
+          def config?
+            true
+          end
+
           # Merge the given config into the current config & validate
           def update_config(config, new)
             Cyclid.logger.debug "config=#{config} new=#{new}"
@@ -70,11 +77,14 @@ module Cyclid
               config['repository_tokens'] = merged
             end
 
-            if new.key? 'hmac_secret'
-              Cyclid.logger.debug 'updating HMAC secret'
-              config['hmac_secret'] = new['hmac_secret']
+            if new.key? 'oauth_token'
+              Cyclid.logger.debug 'updating OAuth token'
+              config['oauth_token'] = new['oauth_token']
             end
 
+            # Remove any old keys
+            config.delete 'hmac_secret' if config.key? 'hmac_secret'
+
             return config
           end
 
@@ -82,7 +92,7 @@ module Cyclid
           def default_config
             config = {}
             config['repository_tokens'] = []
-            config['hmac_secret'] = nil
+            config['oauth_token'] = nil
 
             return config
           end
@@ -92,13 +102,16 @@ module Cyclid
             schema = []
             schema << { name: 'repository_tokens',
                         type: 'hash-list',
-                        description: 'Repository OAuth tokens',
+                        description: 'Individual repository personal OAuth tokens',
                         default: [] }
-            schema << { name: 'hmac_secret',
-                        type: 'string',
-                        description: 'Github HMAC signing secret',
+            schema << { name: 'oauth_token',
+                        type: 'password',
+                        description: 'Organization Github OAuth token',
                         default: nil }
-
+            schema << { name: 'oauth_request',
+                        type: 'link-relative',
+                        description: 'Authorize with Github',
+                        default: '/oauth/request' }
             return schema
           end
         end

data/app/cyclid/plugins/api/github/README.md

@@ -0,0 +1,62 @@
+Github API plugin
+---
+
+This is the Github API plugin for Cyclid. It adds API end points which support Github OAuth authentication and webhook events:
+
+| Verb | Path | Notes |
+| --- | --- | --- |
+| **GET** | / |Github webhook callback. |
+| **GET** | /oauth/request | Start the OAuth authorization process. |
+| **GET** | /oauth/callback | The OUth authorization calback. |
+
+# OAuth
+
+Initiate the Github OAuth "Web" flow with a GET to the /oauth/request endpoint. This will cause a redirect to Github where the user can authorise the OAuth request.
+
+When the request has been authorised the user will be redirected back to the /oauth/callback endpoint, which in turn will then redirect to the Cyclid UI.
+
+# Server Configuration
+
+The server-side configuration for this plugin is:
+
+```
+    github:
+      client_id: <Github OAuth client ID>
+      client_secret: <Github OAuth client secret>
+      api_url: <This API>
+      ui_url: <Cyclid UI instance attached to this API>
+```
+The `client_id` and `client_secret` can be obtained from Github when you [register Cyclid as an application](https://github.com/settings/applications/new) and should be provided here to enable OAuth authorization flow.
+
+The `api_url` should be the publically resolvable name of the Cyclid API server, and the `ui_url` should be the publically resolvable name of a Cyclid UI server which is configured to use the API server. These URLs are both used to generate appropriate redirects during the OAuth authorization process.
+
+Note that the `api_url` provided must match the "Authorization callback URL" setting you provide to Github when you register Cyclid as an application; this includes both the scheme (http: or https:) and any port number (Cyclid by default uses port 8361). So for example:
+
+```
+api_url: https://cyclid.example.com:8361
+```
+
+# Plugin configuration
+
+The per-organization plugin configuration is:
+
+```
+Individual repository personal OAuth tokens
+	None
+Organization Github OAuth token: abcdef123456789
+```
+
+The individual repository OAuth tokens can be used to provide a privately generated OAuth token for a single repository. OAuth tokens are matched by the repository URL.
+
+The organization OAuth token is the token normally generated via. the normal Github OAuth authorization process. This is the token which will be used by default.
+
+# Webhook events
+
+The plugin currently supports the following webhook events:
+
+* ping
+* status
+* pull_request
+* push
+
+The `ping` and `status` events return immediatly with a 200 response. The `pull_request` and `push` events may cause a new job to be submitted, if a Cyclid job file can be found in the repository which generated the event.

data/app/cyclid/plugins/api/github/callback.rb

@@ -13,6 +13,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'octokit'
+
 # Top level module for the core Cyclid code.
 module Cyclid
   # Module for the Cyclid API
@@ -24,9 +26,16 @@ module Cyclid
         # Notifier callback for Github. Updates the external Github Pull
         # Request status as the job progresses.
         class GithubCallback < Plugins::Notifier::Callback
-          def initialize(statuses, auth_token)
-            @statuses = statuses
+          def initialize(auth_token, repo, sha, linkback_url)
             @auth_token = auth_token
+            @repo = repo
+            @sha = sha
+            @linkback_url = linkback_url
+          end
+
+          # Return or create an Octokit client
+          def client
+            @client ||= Octokit::Client.new(access_token: @auth_token)
           end
 
           # Job status has changed
@@ -45,7 +54,10 @@ module Cyclid
               return false
             end
 
-            GithubStatus.set_status(@statuses, @auth_token, state, message)
+            target_url = "#{@linkback_url}/job/#{job_id}"
+            client.create_status(@repo, @sha, state, context: 'Cyclid',
+                                                     target_url: target_url,
+                                                     description: message)
           end
 
           # Job has completed
@@ -57,7 +69,10 @@ module Cyclid
               state = 'failure'
               message = "Job ##{job_id} failed."
             end
-            GithubStatus.set_status(@statuses, @auth_token, state, message)
+            target_url = "#{@linkback_url}/job/#{job_id}"
+            client.create_status(@repo, @sha, state, context: 'Cyclid',
+                                                     target_url: target_url,
+                                                     description: message)
           end
         end
       end