cyclid 0.2.0

data/app/cyclid/job/stage.rb

@@ -0,0 +1,67 @@
+# 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.
+
+# Top level module for the core Cyclid code.
+module Cyclid
+  # Module for the Cyclid API
+  module API
+    # Module for Cyclid Job related classes
+    module Job
+      # Non-AR model for Stages. Using a wrapper allows us to create an ad-hoc
+      # stage (I.e. one that is not stored in the database) or load a stage
+      # from the database and merge in over-rides without risking modifying
+      # the database object.
+      class StageView
+        attr_reader :name, :version, :steps
+        attr_accessor :on_success, :on_failure
+
+        def initialize(arg)
+          if arg.is_a? Cyclid::API::Stage
+            @name = arg.name
+            @version = arg.version
+            @steps = arg.steps.map(&:serializable_hash)
+          elsif arg.is_a? Hash
+            arg.symbolize_keys!
+
+            raise ArgumentError, 'name is required' unless arg.key? :name
+
+            @name = arg[:name]
+            @version = arg.fetch(:version, '1.0.0')
+
+            # Create & serialize Actions for each step
+            sequence = 1
+            @steps = arg[:steps].map do |step|
+              Cyclid.logger.debug "ad-hoc step=#{step}"
+
+              action_name = step['action']
+              plugin = Cyclid.plugins.find(action_name, Cyclid::API::Plugins::Action)
+
+              step_action = plugin.new(step)
+              raise ArgumentError if step_action.nil?
+
+              # Serialize the object into the Step and store it in the database.
+              action = Oj.dump(step_action)
+
+              step_definition = { sequence: sequence, action: action }
+              sequence += 1
+
+              step_definition
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/cyclid/log_buffer.rb

@@ -0,0 +1,104 @@
+# 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.
+
+# Top level module for the core Cyclid code.
+module Cyclid
+  # Module for the Cyclid API
+  module API
+    # Simple in-memory FIFO; inspired by StringIO but reads & writes maintain
+    # their own position. It's unlike a file enough to not be derived from IO.
+    class StringFIFO
+      def initialize
+        @buffer = String.new
+        @write_pos = 0
+        @read_pos = 0
+      end
+
+      # Append data to the buffer & update the write position
+      def write(data)
+        @buffer += data
+        @write_pos += data.length
+      end
+
+      # Read data from the buffer. If length is given, read at most length
+      # characters from the buffer or whatever is available, whichever is
+      # smaller.
+      #
+      # Completely non-blocking; if no data is available, returns an empty
+      # string.
+      def read(length = nil)
+        len = if length
+                [length, @write_pos].min
+              else
+                @write_pos
+              end
+        start = @read_pos
+        @read_pos += len
+
+        @buffer[start, len]
+      end
+
+      # Return the entire contents of the buffer
+      def string
+        @buffer
+      end
+
+      alias to_s string
+
+      # Reset the buffer, read & write positions
+      def clear
+        @buffer = ''
+        @write_pos = 0
+        @read_pos = 0
+      end
+    end
+
+    # Intelligent buffer which can be passed to plugins which need to collate
+    # output data from different commands during a job
+    class LogBuffer
+      def initialize(job_record = nil, websocket = nil)
+        @job_record = job_record
+        @websocket = websocket
+        @buffer = StringFIFO.new
+      end
+
+      # Append data to the log and send it on to any configured consumers
+      def write(data)
+        # Append the new data to log
+        @buffer.write data
+
+        # Update the Job Record, if there is one
+        if @job_record
+          # XXX: This will destroy the database. Find a better method.
+          @job_record.log = @buffer.string
+          @job_record.save!
+        end
+
+        # Write to web socket
+        @websocket.write data if @websocket
+      end
+
+      # Non-destructively read any new data from the buffer
+      def read(length = nil)
+        @buffer.read(length)
+      end
+
+      # Return a complete copy of the data from the buffer
+      def log
+        @buffer.string
+      end
+    end
+  end
+end

data/app/cyclid/models.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+# Load the models
+require_rel 'models/*.rb'

data/app/cyclid/models/job_record.rb

@@ -0,0 +1,25 @@
+# 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.
+
+# Top level module for the core Cyclid code.
+module Cyclid
+  # Module for the Cyclid API
+  module API
+    # Model for Users
+    class JobRecord < ActiveRecord::Base
+      Cyclid.logger.debug('In the JobRecod model')
+    end
+  end
+end

data/app/cyclid/models/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.
+
+# Top level module for the core Cyclid code.
+module Cyclid
+  # Module for the Cyclid API
+  module API
+    # Model for Organizations
+    class Organization < ActiveRecord::Base
+      Cyclid.logger.debug('In the Organization model')
+
+      class << self
+        # Return the collection of Organizations as an array of Hashes (instead
+        # of Organization objects)
+        def all_as_hash
+          all.to_a.map(&:serializable_hash)
+        end
+      end
+
+      validates :name, presence: true
+      validates :owner_email, presence: true
+
+      validates :rsa_private_key, presence: true
+      validates :rsa_public_key, presence: true
+      validates :salt, presence: true
+
+      validates_uniqueness_of :name
+
+      has_and_belongs_to_many :users,
+                              after_add: :add_user_org_perm,
+                              after_remove: :remove_user_org_perm
+
+      has_many :userpermissions
+      has_many :stages
+      has_many :job_records
+      has_many :plugin_configs
+
+      # Ensure that a set of Userpermissions exist when a User is added to
+      # this Organization
+      def add_user_org_perm(user)
+        Cyclid.logger.debug "Creating org. perm. for #{user.username}"
+        user.userpermissions << Userpermission.new(organization: self)
+      end
+
+      # Remove Userpermissions when a User is removed from this Organization
+      def remove_user_org_perm(user)
+        Cyclid.logger.debug "Destroying org. perm. for #{user.username}"
+        user.userpermissions.delete(Userpermission.find_by(organization: self))
+      end
+    end
+  end
+end

data/app/cyclid/models/plugin_config.rb

@@ -0,0 +1,25 @@
+# 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.
+
+# Top level module for the core Cyclid code.
+module Cyclid
+  # Module for the Cyclid API
+  module API
+    # Model for PluginConfigs
+    class PluginConfig < ActiveRecord::Base
+      belongs_to :organization
+    end
+  end
+end

data/app/cyclid/models/stage.rb

@@ -0,0 +1,42 @@
+# 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.
+
+# Top level module for the core Cyclid code.
+module Cyclid
+  # Module for the Cyclid API
+  module API
+    # Model for Stages
+    class Stage < ActiveRecord::Base
+      Cyclid.logger.debug('In the Stage model')
+
+      class << self
+        # Return the collection of Stages as an array of Hashes (instead
+        # of Stage objects)
+        def all_as_hash
+          all.to_a.map(&:serializable_hash)
+        end
+      end
+
+      validates :name, presence: true
+      validates :version, presence: true
+
+      validates_uniqueness_of :name, scope: :version
+      validates_format_of :version, with: /\A\d+.\d+.\d+.?\d*\z/
+
+      belongs_to :organization
+      has_many :steps
+    end
+  end
+end

data/app/cyclid/models/step.rb

@@ -0,0 +1,29 @@
+# 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.
+
+# Top level module for the core Cyclid code.
+module Cyclid
+  # Module for the Cyclid API
+  module API
+    # Model for Steps
+    class Step < ActiveRecord::Base
+      Cyclid.logger.debug('In the Step model')
+
+      validates :sequence, presence: true
+
+      belongs_to :stage
+    end
+  end
+end

data/app/cyclid/models/user.rb

@@ -0,0 +1,60 @@
+# 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 'bcrypt'
+
+# Top level module for the core Cyclid code.
+module Cyclid
+  # Module for the Cyclid API
+  module API
+    # Model for Users
+    class User < ActiveRecord::Base
+      Cyclid.logger.debug('In the User model')
+
+      class << self
+        # Return the collection of Users as an array of Hashes (instead
+        # of User objects)
+        def all_as_hash
+          all.to_a.map(&:serializable_hash)
+        end
+      end
+
+      validates :username, presence: true
+      validates :email, presence: true
+
+      validates_uniqueness_of :username
+
+      has_and_belongs_to_many :organizations
+      has_many :userpermissions
+      has_many :job_records
+
+      # Allow an unencryped password to be passed in via. new_password and
+      # ensure it is encrypted into password when the record is saved
+      attr_accessor :new_password
+
+      before_save :hash_new_password, if: :password_changed?
+
+      # Check if the new_password attribute has changed
+      def password_changed?
+        !@new_password.blank?
+      end
+
+      # Generate a BCrypt2 password from the plaintext
+      def hash_new_password
+        self.password = BCrypt::Password.create(@new_password)
+      end
+    end
+  end
+end

data/app/cyclid/models/user_permissions.rb

@@ -0,0 +1,28 @@
+# 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.
+
+# Top level module for the core Cyclid code.
+module Cyclid
+  # Module for the Cyclid API
+  module API
+    # Model for UserPermissions
+    class Userpermission < ActiveRecord::Base
+      Cyclid.logger.debug('In the Userpermission model')
+
+      belongs_to :user
+      belongs_to :organization
+    end
+  end
+end