Sha256: 851db0b9b4e81172ff2ed304d96f0e1b8dbda18a2fd5439fcad7a3d65801f735

Contents?: true

Size: 1.36 KB

Versions: 11

Compression:

Stored size: 1.36 KB

Contents

# 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 Plugins
    module Plugins
      # Base class for Action plugins
      class Action < Base
        def initialize(args = {})
        end

        # Return the 'human' name for the plugin type
        def self.human_name
          'action'
        end

        # Provide any additional run-time data, such as the transport &
        # context, that the plugin will require for perform() but didn't get
        # during initialize.
        def prepare(args = {})
          @transport = args[:transport]
          @ctx = args[:ctx]
        end

        # Run the Action.
        def perform(log)
        end
      end
    end
  end
end

require_rel 'action/*.rb'

Version data entries

11 entries across 11 versions & 1 rubygems

Version Path
cyclid-0.4.0 app/cyclid/plugins/action.rb
cyclid-0.3.3 app/cyclid/plugins/action.rb
cyclid-0.3.2 app/cyclid/plugins/action.rb
cyclid-0.3.1 app/cyclid/plugins/action.rb
cyclid-0.3.0 app/cyclid/plugins/action.rb
cyclid-0.2.5 app/cyclid/plugins/action.rb
cyclid-0.2.4 app/cyclid/plugins/action.rb
cyclid-0.2.3 app/cyclid/plugins/action.rb
cyclid-0.2.2 app/cyclid/plugins/action.rb
cyclid-0.2.1 app/cyclid/plugins/action.rb
cyclid-0.2.0 app/cyclid/plugins/action.rb