cyclid-ui 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9814c8d110ccfe013e04cea146f6ff28b25ccd3c
+  data.tar.gz: f3501d1380185c9a772b61e3df0947031974fee2
+SHA512:
+  metadata.gz: f1ababb60d429b122929875c5b9299c5b75af95c9e50422ecadf694ad7938bb6a8c5de4ca7a4c1ee5044daa85280fcbb56880a0f673052a243489a940215ba15
+  data.tar.gz: 73792917cfe866677dc6a3960da9e8547627d87294727724b0e2a30874b9531ece5c668839d4a55fcdd79ccfb010b59fa51dcf2d0fd2664a640764540fd3e0d4

data/LICENSE

@@ -0,0 +1,178 @@
+                            Apache License
+                       Version 2.0, January 2004
+                    http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+  "License" shall mean the terms and conditions for use, reproduction,
+  and distribution as defined by Sections 1 through 9 of this document.
+
+  "Licensor" shall mean the copyright owner or entity authorized by
+  the copyright owner that is granting the License.
+
+  "Legal Entity" shall mean the union of the acting entity and all
+  other entities that control, are controlled by, or are under common
+  control with that entity. For the purposes of this definition,
+  "control" means (i) the power, direct or indirect, to cause the
+  direction or management of such entity, whether by contract or
+  otherwise, or (ii) ownership of fifty percent (50%) or more of the
+  outstanding shares, or (iii) beneficial ownership of such entity.
+
+  "You" (or "Your") shall mean an individual or Legal Entity
+  exercising permissions granted by this License.
+
+  "Source" form shall mean the preferred form for making modifications,
+  including but not limited to software source code, documentation
+  source, and configuration files.
+
+  "Object" form shall mean any form resulting from mechanical
+  transformation or translation of a Source form, including but
+  not limited to compiled object code, generated documentation,
+  and conversions to other media types.
+
+  "Work" shall mean the work of authorship, whether in Source or
+  Object form, made available under the License, as indicated by a
+  copyright notice that is included in or attached to the work
+  (an example is provided in the Appendix below).
+
+  "Derivative Works" shall mean any work, whether in Source or Object
+  form, that is based on (or derived from) the Work and for which the
+  editorial revisions, annotations, elaborations, or other modifications
+  represent, as a whole, an original work of authorship. For the purposes
+  of this License, Derivative Works shall not include works that remain
+  separable from, or merely link (or bind by name) to the interfaces of,
+  the Work and Derivative Works thereof.
+
+  "Contribution" shall mean any work of authorship, including
+  the original version of the Work and any modifications or additions
+  to that Work or Derivative Works thereof, that is intentionally
+  submitted to Licensor for inclusion in the Work by the copyright owner
+  or by an individual or Legal Entity authorized to submit on behalf of
+  the copyright owner. For the purposes of this definition, "submitted"
+  means any form of electronic, verbal, or written communication sent
+  to the Licensor or its representatives, including but not limited to
+  communication on electronic mailing lists, source code control systems,
+  and issue tracking systems that are managed by, or on behalf of, the
+  Licensor for the purpose of discussing and improving the Work, but
+  excluding communication that is conspicuously marked or otherwise
+  designated in writing by the copyright owner as "Not a Contribution."
+
+  "Contributor" shall mean Licensor and any individual or Legal Entity
+  on behalf of whom a Contribution has been received by Licensor and
+  subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+  this License, each Contributor hereby grants to You a perpetual,
+  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+  copyright license to reproduce, prepare Derivative Works of,
+  publicly display, publicly perform, sublicense, and distribute the
+  Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+  this License, each Contributor hereby grants to You a perpetual,
+  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+  (except as stated in this section) patent license to make, have made,
+  use, offer to sell, sell, import, and otherwise transfer the Work,
+  where such license applies only to those patent claims licensable
+  by such Contributor that are necessarily infringed by their
+  Contribution(s) alone or by combination of their Contribution(s)
+  with the Work to which such Contribution(s) was submitted. If You
+  institute patent litigation against any entity (including a
+  cross-claim or counterclaim in a lawsuit) alleging that the Work
+  or a Contribution incorporated within the Work constitutes direct
+  or contributory patent infringement, then any patent licenses
+  granted to You under this License for that Work shall terminate
+  as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+  Work or Derivative Works thereof in any medium, with or without
+  modifications, and in Source or Object form, provided that You
+  meet the following conditions:
+
+  (a) You must give any other recipients of the Work or
+      Derivative Works a copy of this License; and
+
+  (b) You must cause any modified files to carry prominent notices
+      stating that You changed the files; and
+
+  (c) You must retain, in the Source form of any Derivative Works
+      that You distribute, all copyright, patent, trademark, and
+      attribution notices from the Source form of the Work,
+      excluding those notices that do not pertain to any part of
+      the Derivative Works; and
+
+  (d) If the Work includes a "NOTICE" text file as part of its
+      distribution, then any Derivative Works that You distribute must
+      include a readable copy of the attribution notices contained
+      within such NOTICE file, excluding those notices that do not
+      pertain to any part of the Derivative Works, in at least one
+      of the following places: within a NOTICE text file distributed
+      as part of the Derivative Works; within the Source form or
+      documentation, if provided along with the Derivative Works; or,
+      within a display generated by the Derivative Works, if and
+      wherever such third-party notices normally appear. The contents
+      of the NOTICE file are for informational purposes only and
+      do not modify the License. You may add Your own attribution
+      notices within Derivative Works that You distribute, alongside
+      or as an addendum to the NOTICE text from the Work, provided
+      that such additional attribution notices cannot be construed
+      as modifying the License.
+
+  You may add Your own copyright statement to Your modifications and
+  may provide additional or different license terms and conditions
+  for use, reproduction, or distribution of Your modifications, or
+  for any such Derivative Works as a whole, provided Your use,
+  reproduction, and distribution of the Work otherwise complies with
+  the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+  any Contribution intentionally submitted for inclusion in the Work
+  by You to the Licensor shall be under the terms and conditions of
+  this License, without any additional terms or conditions.
+  Notwithstanding the above, nothing herein shall supersede or modify
+  the terms of any separate license agreement you may have executed
+  with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+  names, trademarks, service marks, or product names of the Licensor,
+  except as required for reasonable and customary use in describing the
+  origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+  agreed to in writing, Licensor provides the Work (and each
+  Contributor provides its Contributions) on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+  implied, including, without limitation, any warranties or conditions
+  of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+  PARTICULAR PURPOSE. You are solely responsible for determining the
+  appropriateness of using or redistributing the Work and assume any
+  risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+  whether in tort (including negligence), contract, or otherwise,
+  unless required by applicable law (such as deliberate and grossly
+  negligent acts) or agreed to in writing, shall any Contributor be
+  liable to You for damages, including any direct, indirect, special,
+  incidental, or consequential damages of any character arising as a
+  result of this License or out of the use or inability to use the
+  Work (including but not limited to damages for loss of goodwill,
+  work stoppage, computer failure or malfunction, or any and all
+  other commercial damages or losses), even if such Contributor
+  has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+  the Work or Derivative Works thereof, You may choose to offer,
+  and charge a fee for, acceptance of support, warranty, indemnity,
+  or other liability obligations and/or rights consistent with this
+  License. However, in accepting such obligations, You may act only
+  on Your own behalf and on Your sole responsibility, not on behalf
+  of any other Contributor, and only if You agree to indemnify,
+  defend, and hold each Contributor harmless for any liability
+  incurred by, or claims asserted against, such Contributor by reason
+  of your accepting any such warranty or additional liability.
+
+The Cyclid Logo and its derivatives are licensed under the Creative Commons
+Attribution-NonCommercial-NoDerivatives 4.0 International License. To view a
+copy of this license, visit http://creativecommons.org/licenses/by-nc-nd/4.0/.

data/README.md

@@ -0,0 +1,20 @@
+Cyclid-UI
+=========
+This is the web based user interface to the Cyclid CI server.
+
+# Getting started
+```
+$ rbenv install 2.3.0
+$ bundle install --path vendor/bundle
+```
+Cyclid-UI can optionally use Memcached for storing some user object data; if you choose to run a Memcached server on your local machine Cyclid-UI will connect by default on `localhost:11211`.
+
+Cyclid-UI requires a Cyclid API server that both it and the client (I.e. the web browser) can connect too. See the documentation for the Cyclid API server for information on how to install & configure Cyclid.
+
+You can start Cyclid-UI under Webrick with `bundle exec rake rackup` or you can run under Guard with `bundle exec rake guard`.
+
+# Testing
+
+RSpec tests are included. Run `bundle exec rake spec` to run the tests and generate a coverage report into the `coverage` directory. The tests do not affect any databases and external API calls are mocked.
+
+The Cyclid-UI source code is also expected to pass Rubocop; run `bundle exec rake rubocop` to lint the code.

data/app/cyclid_ui.rb

@@ -0,0 +1,124 @@
+# 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 'require_all'
+require 'logger'
+require 'warden'
+require 'memcached'
+require 'sinatra/flash'
+require 'rack/csrf'
+
+require_rel 'cyclid_ui/config'
+require_rel 'cyclid_ui/memcache'
+require_rel 'cyclid_ui/helpers'
+
+require_rel 'cyclid_ui/models'
+require_rel 'cyclid_ui/controllers'
+
+require_rel 'cyclid_ui/views'
+
+# Namespace for all Cyclid UI related code
+module Cyclid
+  class << self
+    attr_accessor :config, :logger
+
+    config_path = ENV['CYCLID_CONFIG'] || File.join(%w(/ etc cyclid config))
+    Cyclid.config = UI::Config.new(config_path)
+
+    begin
+      Cyclid.logger = if Cyclid.config.log.casecmp('stderr').zero?
+                        Logger.new(STDERR)
+                      else
+                        Logger.new(Cyclid.config.log)
+                      end
+    rescue StandardError => ex
+      abort "Failed to initialize: #{ex}"
+    end
+  end
+end
+
+module Cyclid
+  module UI
+    # Sinatra application
+    class App < Sinatra::Application
+      configure do
+        set sessions: true,
+            secure: production?,
+            expire_after: 31_557_600,
+            secret: ENV['SESSION_SECRET']
+      end
+
+      use Rack::Deflater
+      use Rack::Session::Cookie
+      use Rack::Csrf, raise: true,
+                      skip: ['POST:/login',
+                             'POST:/unauthenticated']
+
+      helpers Helpers
+
+      register Sinatra::Flash
+
+      # Configure Warden to authenticate
+      use Warden::Manager do |config|
+        config.serialize_into_session(&:username)
+        config.serialize_from_session do |username|
+          # Animal skins & flint knives...
+          token = env['rack.request.cookie_hash']['cyclid.token']
+          Models::User.get(username: username, token: token)
+        end
+
+        config.scope_defaults :default,
+                              strategies: [:session],
+                              action: '/unauthenticated'
+
+        config.failure_app = self
+      end
+
+      Warden::Strategies.add(:session) do
+        def valid?
+          session.key? :username
+        end
+
+        def authenticate!
+          username = session[:username]
+          # There are no Helpers in Wardentown
+          token = request.cookies['cyclid.token']
+
+          user = Models::User.get(username: username, token: token)
+
+          user.nil? ? fail!('invalid user') : success!(user)
+        end
+      end
+
+      Warden::Manager.before_failure do |env, _opts|
+        env['REQUEST_METHOD'] = 'POST'
+      end
+
+      post '/unauthenticated' do
+        # Stop Warden from calling this endpoint again in an endless loop when
+        # it sees the 401 response
+        env['warden'].custom_failure!
+        flash[:login_error] = 'Invalid username or password'
+        redirect to '/login'
+      end
+
+      # Register the other routes
+      use Controllers::Auth
+      use Controllers::Organization
+      use Controllers::User
+      use Controllers::Health
+    end
+  end
+end

data/app/cyclid_ui/config.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.
+
+require 'yaml'
+require 'uri'
+
+module Cyclid
+  module UI
+    # Cyclid UI configuration
+    class Config
+      attr_reader :memcached, :log, :server_api, :client_api
+
+      def initialize(path)
+        # Try to load the configuration file. If it can't be loaded, we'll
+        # fall back to defaults
+        begin
+          config = YAML.load_file(path)
+          manage = config['manage'] || {}
+        rescue Errno::ENOENT
+          # Cyclid.logger wont exist, yet
+          STDERR.puts "Config file #{path} not found: using defaults"
+          manage = {}
+        end
+
+        @memcached = manage['memcached'] || 'localhost:11211'
+        @log = manage['log'] || File.join(%w(/ var log cyclid manage))
+
+        # The api setting is flexible; the URL that the server uses to connect
+        # to the API, and the URL that the client uses, can be diferent. This
+        # may happen if E.g. the UI & API are running on the same machine but
+        # with the ports NAT'd from the outside so that the client sees port
+        # 8123 but the local port is 123, or where the API is behind a load
+        # balancer and you may wish to avoid the round-trip out and back in.
+        #
+        # If "api" is a string then it is used for both the server & client URL
+        # If "api" is an array then we select the client & server URLs
+        # separately
+        api = manage['api'] || 'http://localhost:8361'
+        if api.is_a? String
+          @server_api = URI(api)
+          @client_api = URI(api)
+        elsif api.is_a? Hash
+          @server_api = URI(api['server'])
+          @client_api = URI(api['client'])
+        end
+
+      rescue StandardError => ex
+        abort "Failed to load configuration file #{path}: #{ex}"
+      end
+    end
+  end
+end

data/app/cyclid_ui/controllers/auth.rb

@@ -0,0 +1,102 @@
+# 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 'json'
+require 'cyclid/client'
+
+module Cyclid
+  module UI
+    module Controllers
+      # Controller for authentication related endpoints
+      class Auth < Base
+        get '/login' do
+          @message = flash[:login_error]
+          mustache :login, layout: false
+        end
+
+        post '/login' do
+          username = params[:username]
+          password = params[:password]
+
+          # Use the username & password to authenticate against the API; if
+          # successful, it will return a JWT that can be used to authenticate
+          # future requests
+          begin
+            Cyclid.logger.debug "api=#{Cyclid.config.server_api}"
+            client = Client::Tilapia.new(auth: Client::AUTH_BASIC,
+                                         log_level: Logger::DEBUG,
+                                         server: Cyclid.config.server_api.host,
+                                         port: Cyclid.config.server_api.port,
+                                         username: username,
+                                         password: password)
+            token_data = client.token_get(username)
+            Cyclid.logger.debug "got #{token_data}"
+          rescue StandardError => ex
+            Cyclid.logger.fatal "failed to get a token: #{ex}"
+            halt_with_401
+          end
+
+          # At this point the user has authenticated successfully; get the user
+          # information; the User model will cache it automatically.
+          user = Models::User.get(username: username, password: password)
+          Cyclid.logger.debug "user=#{user.to_hash}"
+
+          # Store the username in the session
+          session[:username] = username
+
+          # Return the JWT cookie to the client as a cookie
+          response.set_cookie('cyclid.token',
+                              value: token_data['token'],
+                              expires: Time.now + 21_600_000, # +6 hours
+                              path: '/',
+                              http_only: false) # Must be available for AJAX
+
+          # Pick the first organization from the users membership and
+          # redirect; if the user doesn't belong to any organizations,
+          # redirect them to their user page
+          initial_page = if user.organizations.empty?
+                           "/user/#{username}"
+                         else
+                           user.organizations.first
+                         end
+
+          redirect to initial_page
+        end
+
+        # Log out:
+        #
+        # 1. Delete the cached user object from Memcached
+        # 2. Clear the session data
+        # 3. Delete the API token cookie
+        get '/logout' do
+          authenticate!
+
+          memcache = Memcache.new(server: Cyclid.config.memcached)
+          begin
+            memcache.expire(current_user.username)
+          rescue Memcached::ServerIsMarkedDead => ex
+            Cyclid.logger.fatal "cannot connect to memcached: #{ex}"
+            # If Memcache is down there is nothing to expire
+          end
+
+          warden.logout
+          cookies.delete 'cyclid.token'
+
+          redirect to '/login'
+        end
+      end
+    end
+  end
+end