croesus 0.1.3

data/lib/croesus/resources/source.rb

@@ -0,0 +1,86 @@
+
+# Delphix Source API template
+
+Croesus::DSL.evaluate do
+  resource :source do
+    description  'Sources represent external database instances outside the ' \
+                 'Delphix system. These can be linked sources (which pull '   \
+                 'data into Delphix from pre-existing databases) or virtual ' \
+                 'sources which export data from Delphix to arbitrary targets.'
+    root         '/resources/json/delphix/source'
+
+    get '/resources/json/delphix/source' do
+      description 'Lists sources on the system.'
+      returns     Array
+      name        :list
+    end
+
+    get '/resources/json/delphix/source/{ref}' do
+      description 'Retrieve the specified Source object.'
+      returns     Array
+      name        :read
+    end
+
+    post '/resources/json/delphix/source/{ref}' do
+      description 'Update the specified Source object.'
+      input       Hash
+      name        :update
+    end
+
+    post '/resources/json/delphix/source/{ref}/disable' do
+      description 'Disables the given source such that Delphix no longer '     \
+                  'interacts with the source. A disabled source has no data '  \
+                  'available on the target host, and therefore cannot be '     \
+                  'running. No monitoring is done for disabled sources.'
+      input       String
+      name        :disable
+    end
+
+    post '/resources/json/delphix/source/{ref}/enable' do
+      description 'Enables the given source, exporting any necessary data and '\
+                  'starting the source. Once enabled, the source will be '     \
+                  'monitored by Delphix regardless of whether it is currently '\
+                  'running, and the server will respond to changes in its '    \
+                  'status appropriately.'
+      input       Hash
+      name        :enable
+    end
+
+    post '/resources/json/delphix/source/{ref}/start' do
+      description 'Starts the given source. Only virtual sources can be '      \
+                  'started and stopped. A stopped source is equivalent to '    \
+                  'stopping the source through application-specific means, '   \
+                  'and a source can be started or stopped both through this '  \
+                  'interface as well as via the external application. A '      \
+                  'stopped source is still monitored for availability and '    \
+                  'policies can still run against a stopped source, if '       \
+                  'applicable. Linked sources cannot be stopped, only virtual '\
+                  'sources managed by the server can be started via this '     \
+                  'mechanism.'
+      input       String
+      name        :start
+    end
+
+    post '/resources/json/delphix/source/{ref}/stop' do
+      description 'Stops the given source. Only virtual sources can be '       \
+                  'started and stopped. A stopped source is equivalent to '    \
+                  'stopping the source through application-specific means, '   \
+                  'and a source can be started or stopped both through this '  \
+                  'interface as well as via the external application. A '      \
+                  'stopped source is still monitored for availability and '    \
+                  'policies can still run against a stopped source, if '       \
+                  'applicable. Linked sources cannot be stopped, only virtual '\
+                  'sources managed by the server can be stopped via this '     \
+                  'mechanism.'
+      input       String
+      name        :stop
+    end
+
+    post '/resources/json/delphix/source/{ref}/upgrade' do
+      description 'Upgrades the given source. This upgrade operation changes ' \
+                  'the repository of the source to a higher version repository.'
+      input       String
+      name        :upgrade
+    end
+  end
+end

data/lib/croesus/resources/source_config.rb

@@ -0,0 +1,54 @@
+
+# Delphix Source API template
+
+Croesus::DSL.evaluate do
+  resource :source_config do
+    description  'The source config represents the dynamically discovered ' \
+                 'attributes of a source.'
+    root         '/resources/json/delphix/sourceconfig'
+
+    get '/resources/json/delphix/sourceconfig' do
+      description 'Returns a list of source configs within the repository or ' \
+                  'the environment.'
+      returns     Array
+      name        :list
+    end
+
+    get '/resources/json/delphix/sourceconfig/{ref}' do
+      description 'Retrieve the specified SourceConfig object.'
+      returns     Object
+      name        :read
+    end
+
+    post '/resources/json/delphix/sourceconfig' do
+      description 'Create a new SourceConfig object.'
+      returns     String
+      name        :create
+    end
+
+    post '/resources/json/delphix/sourceconfig/{ref}' do
+      description 'Update the specified SourceConfig object.'
+      input       String
+      name        :update
+    end
+
+    delete '/resources/json/delphix/sourceconfig/{ref}' do
+      description 'Delete the specified SourceConfig object.'
+      input       String
+      name        :delete
+    end
+
+    delete '/resources/json/delphix/sourceconfig/{ref}/defaultType' do
+      description 'None available'
+      input       String
+      name        :defaultType
+    end
+
+    delete '/resources/json/delphix/sourceconfig/{ref}/validateCredentials' do
+      description 'Tests the validity of the supplied database credentials, ' \
+                  'returning an error if unable to connect to the database'
+      input       String
+      name        :defaultType
+    end
+  end
+end

data/lib/croesus/resources/source_environment.rb

@@ -0,0 +1,58 @@
+
+# Delphix Source Environment DSL
+#
+Croesus::DSL.evaluate do
+  resource :source_environment do
+    description  'The generic source environment schema.'
+    root         '/resources/json/delphix/environment'
+
+    get '/resources/json/delphix/environment' do
+      description 'Returns the list of all source environments.'
+      returns     Array
+      name        :list
+    end
+
+    get '/resources/json/delphix/environment/{ref}' do
+      description 'Retrieve the specified SourceEnvironment object.'
+      returns     Object
+      name        :read
+    end
+
+    post '/resources/json/delphix/environment' do
+      description 'Create a new SourceEnvironment object.'
+      returns     String
+      name        :create
+    end
+
+    post '/resources/json/delphix/environment/{ref}' do
+      description 'Update the specified SourceEnvironment object.'
+      input       String
+      name        :update
+    end
+
+    delete '/resources/json/delphix/environment/{ref}' do
+      description 'Delete the specified SourceEnvironment object.'
+      input       String
+      name        :delete
+    end
+
+    post '/resources/json/delphix/environment/{ref}/disable' do
+      description 'Disables the given environment.'
+      input       String
+      name        :disable
+    end
+
+    post '/resources/json/delphix/environment/{ref}/enable' do
+      description 'Enables the given environment. This is only applicable for ' \
+                  'disabled environments.'
+      input       String
+      name        :enable
+    end
+
+    post '/resources/json/delphix/environment/{ref}/refresh' do
+      description 'Refreshes the given environment.'
+      input       String
+      name        :refresh
+    end
+  end
+end

data/lib/croesus/resources/source_repository.rb

@@ -0,0 +1,14 @@
+
+# Delphix Source API template
+
+Croesus::DSL.evaluate do
+  resource :source_repository do
+    description  'Source repositories are containers for SourceConfig objects. '\
+                 'Each Environment can contain any number of repositories, and '\
+                 'repositories can contain any number of source ' \
+                 'configurations. A repository typically corresponds to a ' \
+                 'database installation.'
+    root         '/resources/json/delphix/repository'
+
+  end
+end

data/lib/croesus/resources/system_info.rb

@@ -0,0 +1,21 @@
+
+# Delphix Source API template
+
+Croesus::DSL.evaluate do
+  resource :system_info do
+    description  'Retrieve system-wide properties and manage the state of ' \
+                 'the system.'
+    root         '/resources/json/delphix/system'
+
+    get '/resources/json/delphix/system' do
+      description 'Retrieve the specified SystemInfo object.'
+      returns     Array
+      name        :list
+    end
+
+    post '/resources/json/delphix/system' do
+      description 'Update the specified SystemInfo object.'
+      name        :update
+    end
+  end
+end

data/lib/croesus/resources/timeflow.rb

@@ -0,0 +1,40 @@
+
+# Delphix Source API template
+
+Croesus::DSL.evaluate do
+  resource :timeflow do
+    description  'Timeflows represent a single provisionable timeline within a '\
+                 'Database. The Delphix system currently only supports one '    \
+                 'timeflow per database, though this may expand in the future. '\
+                 'Each database has the notion of the `current` timeflow, '     \
+                 'either the timeflow being synced from an external source '    \
+                 '(for dSources) or the actively provisioned timeflow (for '    \
+                 'VDBs). With only one timeflow supported per database, the '   \
+                 'current timeflow is always the one and only timeflow for '    \
+                 'the database.'
+    root         '/resources/json/delphix/timeflow'
+
+    get '/resources/json/delphix/timeflow' do
+      description 'List Timeflow objects on the system.'
+      returns     Array
+      name        :list
+    end
+
+    get '/resources/json/delphix/timeflow/{ref}' do
+      description 'Retrieve the specified Timeflow object.'
+      returns     Array
+      name        :read
+    end
+
+    post '/resources/json/delphix/timeflow/{ref}/repair' do
+      description 'Manually fetch log files to repair a portion of a timeflow.'
+      name        :repair
+    end
+
+    post '/resources/json/delphix/timeflow/{ref}/timeflowRanges' do
+      description 'Fetches timeflow ranges in between the specified start and ' \
+                  'end locations.'
+      name        :timeflowRanges
+    end
+  end
+end

data/lib/croesus/resources/timeflow_snapshot.rb

@@ -0,0 +1,38 @@
+
+# Delphix Source API template
+
+Croesus::DSL.evaluate do
+  resource :timeflow do
+    description  'Timeflow snapshots represent a point in time within a '       \
+                 'Timeflow that is used as the base point for provisioning. A ' \
+                 'provisioning operation begins at a timeflow snapshot and '    \
+                 'performs additional operations to bring the database to the ' \
+                 'requested state. Snapshots themselves may or may not be '     \
+                 'provisionable, and can be associated with dSources or VDBs.'
+    root         '/resources/json/delphix/snapshot'
+
+    get '/resources/json/delphix/snapshot' do
+      description 'Returns a list of snapshots on the system or within a '      \
+                  'particular object. By default, all snapshots within the '    \
+                  'domain are listed.'
+      returns     Array
+      name        :list
+    end
+
+    get '/resources/json/delphix/snapshot/{ref}' do
+      description 'Retrieve the specified TimeflowSnapshot object.'
+      returns     Array
+      name        :read
+    end
+
+    post '/resources/json/delphix/snapshot/{ref}' do
+      description 'Update the specified TimeflowSnapshot object.'
+      name        :update
+    end
+
+    delete '/resources/json/delphix/snapshot/{ref}' do
+      description 'Delete the specified TimeflowSnapshot object.'
+      name        :delete
+    end
+  end
+end

data/lib/croesus/utils.rb

@@ -0,0 +1,262 @@
+# encoding: UTF-8
+#
+# Author: Stefano Harding <riddopic@gmail.com>
+#
+# Copyright (C) 2014 Stefano Harding
+#
+# 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 'securerandom'
+require 'time'
+
+module Croesus::Utils
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+  private_class_method :included
+
+  module ClassMethods
+    def callable(call_her)
+      call_her.respond_to?(:call) ? call_her : lambda { call_her }
+    end
+
+    def camelize(underscored_word)
+      underscored_word.to_s.gsub(/(?:^|_)(.)/) { $1.upcase }
+    end
+
+    def classify(table_name)
+      camelize singularize(table_name.to_s.sub(/.*\./, ''))
+    end
+
+    def class_name
+      demodulize(self.class)
+    end
+
+    def caller_name
+      caller_locations(2, 1).first.label
+    end
+
+    def demodulize(class_name_in_module)
+      class_name_in_module.to_s.sub(/^.*::/, '')
+    end
+
+    def pluralize(word)
+      word.to_s.sub(/([^s])$/, '\1s')
+    end
+
+    def singularize(word)
+      word.to_s.sub(/s$/, '').sub(/ie$/, 'y')
+    end
+
+    def underscore(camel_cased_word)
+      word = camel_cased_word.to_s.dup
+      word.gsub!(/::/, '/')
+      word.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+      word.tr! '-', '_'
+      word.downcase!
+      word
+    end
+
+    # Return the date and time in "HTTP-date" format as defined by RFC 7231.
+    #
+    # @return [Date,Time] in "HTTP-date" format
+    def utc_httpdate
+      Time.now.utc.httpdate
+    end
+
+    def request_id
+      SecureRandom.uuid
+    end
+
+    def twenty_four_hours_ago
+      Time.now - ( 60 * 60 * 24)
+    end
+
+    def verify_options(accepted, actual) # @private
+      return unless debug || $DEBUG
+      unless (act=Set[*actual.keys]).subset?(acc=Set[*accepted])
+        raise Croesus::Errors::UnknownOption,
+          "\nDetected unknown option(s): #{(act - acc).to_a.inspect}\n" <<
+          "Accepted options are: #{accepted.inspect}"
+      end
+      yield if block_given?
+    end
+  end # module ClassMethods
+
+  def callable(call_her)
+    call_her.respond_to?(:call) ? call_her : lambda { call_her }
+  end
+
+  def camelize(underscored_word)
+    underscored_word.to_s.gsub(/(?:^|_)(.)/) { $1.upcase }
+  end
+
+  def classify(table_name)
+    camelize singularize(table_name.to_s.sub(/.*\./, ''))
+  end
+
+  def class_name
+    demodulize(self.class)
+  end
+
+  def caller_name
+    caller_locations(2, 1).first.label
+  end
+
+  def demodulize(class_name_in_module)
+    class_name_in_module.to_s.sub(/^.*::/, '')
+  end
+
+  def pluralize(word)
+    word.to_s.sub(/([^s])$/, '\1s')
+  end
+
+  def singularize(word)
+    word.to_s.sub(/s$/, '').sub(/ie$/, 'y')
+  end
+
+  def underscore(camel_cased_word)
+    word = camel_cased_word.to_s.dup
+    word.gsub!(/::/, '/')
+    word.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+    word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+    word.tr! '-', '_'
+    word.downcase!
+    word
+  end
+
+  # Return the date and time in "HTTP-date" format as defined by RFC 7231.
+  #
+  # @return [Date,Time] in "HTTP-date" format
+  def utc_httpdate
+    Time.now.utc.httpdate
+  end
+
+  def request_id
+    SecureRandom.uuid
+  end
+
+  def twenty_four_hours_ago
+    Time.now - ( 60 * 60 * 24)
+  end
+
+  def verify_options(accepted, actual) # @private
+    return unless debug || $DEBUG
+    unless (act=Set[*actual.keys]).subset?(acc=Set[*accepted])
+      raise Croesus::Errors::UnknownOption,
+        "\nDetected unknown option(s): #{(act - acc).to_a.inspect}\n" <<
+        "Accepted options are: #{accepted.inspect}"
+    end
+    yield if block_given?
+  end
+
+  # Returns the columns and lines of the current tty.
+  #
+  # @return [Integer]
+  #   number of columns and lines of tty, returns [0, 0] if no tty is present.
+  #
+  # @api public
+  def terminal_dimensions
+    [0, 0] unless  STDOUT.tty?
+    [80, 40] if OS.windows?
+
+    if ENV['COLUMNS'] && ENV['LINES']
+      [ENV['COLUMNS'].to_i, ENV['LINES'].to_i]
+    elsif ENV['TERM'] && command_in_path?('tput')
+      [`tput cols`.to_i, `tput lines`.to_i]
+    elsif command_in_path?('stty')
+      `stty size`.scan(/\d+/).map {|s| s.to_i }
+    else
+      [0, 0]
+    end
+  rescue
+    [0, 0]
+  end
+
+  # Checks in PATH returns true if the command is found
+  def command_in_path?(command)
+    found = ENV['PATH'].split(File::PATH_SEPARATOR).map do |p|
+      File.exist?(File.join(p, command))
+    end
+    found.include?(true)
+  end
+
+  # Runs a code block, and retries it when an exception occurs. Should the
+  # number of retries be reached without success, the last exception will be
+  # raised.
+  #
+  # @param opts [Hash{Symbol => Value}]
+  # @option opts [Fixnum] :tries
+  #   number of attempts to retry before raising the last exception
+  # @option opts [Fixnum] :sleep
+  #   number of seconds to wait between retries, use lambda to exponentially
+  #   increasing delay between retries
+  # @option opts [Array(Exception)] :on
+  #   the type of exception(s) to catch and retry on
+  # @option opts [Regex] :matching
+  #   match based on the exception message
+  # @option opts [Block] :ensure
+  #   ensure a block of code is executed, regardless of whether an exception
+  #   is raised
+  #
+  # @return [Block]
+  #
+  def retrier(opts = {}, &block)
+    defaults = {
+      tries:    2,
+      sleep:    1,
+      on:       StandardError,
+      matching: /.*/,
+      :ensure => Proc.new {}
+    }
+
+    check_for_invalid_options(opts, defaults)
+    defaults.merge!(opts)
+
+    return if defaults[:tries] == 0
+
+    on_exception, tries = [defaults[:on]].flatten, defaults[:tries]
+    retries = 0
+    retry_exception = nil
+
+    begin
+      yield retries, retry_exception
+    rescue *on_exception => exception
+      raise unless exception.message =~ defaults[:matching]
+      raise if retries+1 >= defaults[:tries]
+
+      # Interrupt Exception could be raised while sleeping
+      begin
+        sleep defaults[:sleep].respond_to?(:call) ?
+          defaults[:sleep].call(retries) : defaults[:sleep]
+      rescue *on_exception
+      end
+
+      retries += 1
+      retry_exception = exception
+      retry
+    ensure
+      defaults[:ensure].call(retries)
+    end
+  end
+
+  private #   P R O P R I E T À   P R I V A T A   Vietato L'accesso
+
+  def check_for_invalid_options(custom_options, defaults)
+    invalid_options = defaults.merge(custom_options).keys - defaults.keys
+    raise ArgumentError.new('[Retrier] Invalid options: ' \
+      "#{invalid_options.join(", ")}") unless invalid_options.empty?
+  end
+end

data/lib/croesus/validations/many.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+#
+# Author: Stefano Harding <riddopic@gmail.com>
+#
+# Copyright (C) 2014 Stefano Harding
+#
+# 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 Croesus::Validations
+  class Many
+    attr_reader :validation
+    def initialize(validation)
+      @validation = validation
+    end
+  end
+end

data/lib/croesus/validations/optional.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+#
+# Author: Stefano Harding <riddopic@gmail.com>
+#
+# Copyright (C) 2014 Stefano Harding
+#
+# 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 Croesus::Validations
+  class Optional
+    attr_reader :validation
+    def initialize(validation)
+      @validation = validation
+    end
+  end
+end