cyclid-ui 0.1.0

data/app/cyclid_ui/controllers/base.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+# Copyright 2016 Liqwyd Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'sinatra/base'
+require 'sinatra/cookies'
+require 'sinatra/flash'
+require 'mustache'
+require 'mustache/sinatra'
+
+module Cyclid
+  module UI
+    module Controllers
+      # Base class for all Sinatra controllers
+      class Base < Sinatra::Base
+        register Mustache::Sinatra
+
+        set :mustache, templates: File.expand_path('../../templates/', __FILE__),
+
+                       views: File.expand_path('../../views/', __FILE__),
+
+                       namespace: Cyclid::UI
+
+        register Sinatra::Flash
+
+        helpers Sinatra::Cookies, Helpers, AuthHelpers
+      end
+    end
+  end
+end

data/app/cyclid_ui/controllers/health.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+# Copyright 2016 Liqwyd Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+require 'sinatra-health-check'
+require 'memcached'
+
+# Top level module for all of the core Cyclid code.
+module Cyclid
+  module UI
+    module Controllers
+      # Controller for all Health related API endpoints
+      class Health < Base
+        def initialize(_app)
+          super
+          @checker = SinatraHealthCheck::Checker.new(logger: Cyclid.logger,
+                                                     timeout: 0)
+
+          # Add internal health checks
+          @checker.systems[:memcache] = Cyclid::UI::Health::Memcache
+          @checker.systems[:api] = Cyclid::UI::Health::API
+        end
+
+        # Return either 200 (healthy) or 503 (unhealthy) based on the status of
+        # the healthchecks. This is intended to be used by things like load
+        # balancers and active monitors.
+        get '/health/status' do
+          @checker.healthy? ? 200 : 503
+        end
+
+        # Return verbose information on the status of the individual checks;
+        # note that this method always returns 200 with a message body, so it is
+        # not suitable for general health checks unless the caller intends to
+        # parse the message body for the health status.
+        get '/health/info' do
+          @checker.status.to_json
+        end
+      end
+    end
+
+    # Healthchecks
+    module Health
+      # Internal Memcache connection health check
+      module Memcache
+        # Check if Memcache is available
+        def self.status
+          connected = begin
+                        memcache = Memcached.new(Cyclid.config.memcached)
+                        memcache.stats
+                        true
+                      rescue Memcached::SomeErrorsWereReported
+                        false
+                      end
+
+          if connected
+            SinatraHealthCheck::Status.new(:ok, 'memcache connection is okay')
+          else
+            SinatraHealthCheck::Status.new(:warning, 'memcache is not available')
+          end
+        end
+      end
+
+      # Internal API connection health check
+      module API
+        # Check if we can connect to the Cyclid API
+        def self.status
+          connected = begin
+                        client = Client::Tilapia.new(auth: Client::AUTH_NONE,
+                                                     log_level: Logger::DEBUG,
+                                                     server: Cyclid.config.server_api.host,
+                                                     port: Cyclid.config.server_api.port)
+                        client.health_ping
+                      rescue
+                        false
+                      end
+
+          if connected
+            SinatraHealthCheck::Status.new(:ok, 'API connection is okay')
+          else
+            SinatraHealthCheck::Status.new(:error, 'API is not available')
+          end
+        end
+      end
+    end
+  end
+end

data/app/cyclid_ui/controllers/organization.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+# Copyright 2016 Liqwyd Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Cyclid
+  module UI
+    module Controllers
+      # Controller for Organization related endpoints (including Jobs)
+      class Organization < Base
+        get '/:name' do
+          authenticate!
+
+          # Build breadcrumbs
+          name = params[:name]
+
+          @crumbs = []
+          @crumbs << { 'name' => name.capitalize }
+
+          @organization = name
+          @linkback_url = "/#{name}"
+
+          api_server = Cyclid.config.client_api
+          @organization_url = "#{api_server}/organizations/#{params[:name]}"
+          @current_user = current_user
+
+          mustache :organization
+        end
+
+        get '/:name/job/:id' do
+          authenticate!
+
+          # Build breadcrumbs
+          name = params[:name]
+          id = params[:id]
+
+          @crumbs = []
+          @crumbs << { 'url' => "/#{name}", 'name' => name.capitalize }
+          @crumbs << { 'name' => "Job ##{id}" }
+
+          @organization = name
+          @linkback_url = "/#{name}"
+
+          api_server = Cyclid.config.client_api
+          @job_url = "#{api_server}/organizations/#{params[:name]}/jobs/#{params[:id]}"
+          @job_id = id
+          @current_user = current_user
+
+          mustache :job
+        end
+      end
+    end
+  end
+end

data/app/cyclid_ui/controllers/user.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+# Copyright 2016 Liqwyd Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Cyclid
+  module UI
+    module Controllers
+      # Sinatra controller for user related endpoints
+      class User < Base
+        get '/user/:username' do
+          authenticate!
+
+          # Build breadcrumbs
+          username = params[:username]
+
+          @crumbs = []
+          @crumbs << { 'name' => 'User' }
+          @crumbs << { 'url' => "/user/#{username}", 'name' => username }
+
+          @api_url = Cyclid.config.client_api
+          @user_url = "#{@api_url}/users/#{params[:username]}"
+          @current_user = current_user
+
+          mustache :user
+        end
+      end
+    end
+  end
+end

data/app/cyclid_ui/helpers.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+# Copyright 2016 Liqwyd Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Cyclid
+  module UI
+    # Various helper methods for Sinatra controllers
+    module Helpers
+      # Raw CSRF token
+      def csrf_token(rack_env)
+        Rack::Csrf.csrf_token(rack_env)
+      end
+
+      # CSRF HTML forms tag
+      def csrf_tag(rack_env)
+        Rack::Csrf.csrf_tag(rack_env)
+      end
+
+      # Standard unauthenticated 401 message
+      def halt_with_401
+        flash[:login_error] = 'Invalid username or password'
+        halt 401, flash.now[:login_error]
+      end
+    end
+
+    # Sinatra Warden AuthN/AuthZ helpers
+    module AuthHelpers
+      # Return the current Warden scope
+      def warden
+        env['warden']
+      end
+
+      # Call the Warden authenticate! method
+      def authenticate!
+        warden.authenticate!
+      end
+
+      # Current User object from the session
+      def current_user
+        warden.user
+      end
+    end
+  end
+end

data/app/cyclid_ui/memcache.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+# Modified from https://gist.github.com/mralex/956592
+#
+# Original licensed under MIT: https://github.com/gioext/sinatra-memcache
+require 'memcached'
+
+module Cyclid
+  module UI
+    # Simple Memcache caching layer on top of the Memcached client. Keys are
+    # retrieved or set via. the cache method; if the key exists it is returned,
+    # if the key does not exist the given block is called and its output is
+    # stored in Memcached.
+    class Memcache
+      attr_reader :client, :server, :expiry
+
+      def initialize(args)
+        @server = args[:server]
+        @expiry = args[:expiry] || 3600
+      end
+
+      def cache(key)
+        begin
+          output = memcached.get(key)
+        rescue Memcached::NotFound
+          output = yield
+          memcached.set(key, output, @expiry)
+        end
+        output
+      end
+
+      def expire(key)
+        memcached.delete key
+        true
+      rescue Memcached::NotFound
+        false
+      end
+
+      private
+
+      def memcached
+        @client ||= Memcached.new(@server)
+      end
+    end
+  end
+end

data/app/cyclid_ui/models/user.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+# Copyright 2016 Liqwyd Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Cyclid
+  module UI
+    module Models
+      # A User object. This is really no more than a simple wrapper around the
+      # Cyclid user data that is returned from the API, with the added layer
+      # of Memecached caching of the object to avoid API calls.
+      class User
+        attr_reader :username, :email, :organizations, :id
+
+        def initialize(args = {})
+          @username = args['username'] || nil
+          @email = args['email'] || nil
+          @organizations = args['organizations'] || []
+          @id = args['id'] || nil
+        end
+
+        def to_hash
+          { 'username' => @username,
+            'email' => @email,
+            'organizations' => @organizations,
+            'id' => @id }
+        end
+
+        # Try to find the user object in Memcached; if it does not exist,
+        # fallback to the API. If the API returns the user data, it will be
+        # cached into Memcache for future use.
+        #
+        # If we have to fall back to the API we assume that the username is
+        # valid and either the HTTP Basic password or an API token are available
+        # and valid.
+        def self.get(args)
+          username = args[:username] || args['username']
+          memcache = Memcache.new(server: Cyclid.config.memcached)
+
+          user_data = begin
+                        memcache.cache username do
+                          user_fetch(args)
+                        end
+                      rescue Memcached::ServerIsMarkedDead => ex
+                        Cyclid.logger.fatal "cannot connect to memcached: #{ex}"
+                        # Fall back to a direct API connection
+                        user_fetch(args)
+                      end
+
+          new(user_data)
+        end
+
+        def self.user_fetch(args)
+          username = args[:username] || args['username']
+          password = args[:password] || args['password']
+          token = args[:token] || args['token']
+
+          auth_method = token.nil? ? Client::AUTH_BASIC : Client::AUTH_TOKEN
+
+          user_data = nil
+          begin
+            Cyclid.logger.debug "api=#{Cyclid.config.server_api.inspect}"
+            client = Client::Tilapia.new(auth: auth_method,
+                                         server: Cyclid.config.server_api.host,
+                                         port: Cyclid.config.server_api.port,
+                                         username: username,
+                                         password: password,
+                                         token: token)
+            user_data = client.user_get(username)
+            Cyclid.logger.debug "got #{user_data}"
+          rescue StandardError => ex
+            Cyclid.logger.fatal "failed to get user details: #{ex}"
+            raise ex
+          end
+
+          user_data
+        end
+      end
+    end
+  end
+end

data/app/cyclid_ui/templates/footer.mustache

@@ -0,0 +1,8 @@
+<div id="footer">
+  <div class="container">
+    <div class="row">
+      <div class="col-md-2"><p class="text-left">&copy;2016 Cyclid</p></div>
+      <div class="col-md-1 col-md-offset-9"><a class="text-right" href="http://cyclid.io">cyclid.io</a></div>
+    </div>
+  </div>
+</div>