croesus 0.1.3

data/lib/croesus/identity_map.rb

@@ -0,0 +1,98 @@
+# 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
+  module IdentityMap
+    def self.enabled=(flag)
+      Thread.current[:identity_map_enabled] = flag
+    end
+
+    def self.enabled
+      Thread.current[:identity_map_enabled]
+    end
+
+    def self.enabled?
+      enabled == true
+    end
+
+    def self.repository
+      Thread.current[:identity_map] ||= {}
+    end
+
+    def self.clear
+      repository.clear
+    end
+
+    def self.include?(object)
+      repository.keys.include?(object.id)
+    end
+
+    def self.use
+      old, self.enabled = enabled, true
+
+      yield if block_given?
+    ensure
+      self.enabled = old
+      clear
+    end
+
+    def self.without
+      old, self.enabled = enabled, false
+
+      yield if block_given?
+    ensure
+      self.enabled = old
+    end
+
+    module ClassMethods
+      def get(id, options = nil)
+        get_from_identity_map(id) || super
+      end
+
+      def get_from_identity_map(id)
+        IdentityMap.repository[id] if IdentityMap.enabled?
+      end
+      private :get_from_identity_map
+
+      def load(id, attrs)
+        if IdentityMap.enabled? && instance = IdentityMap.repository[id]
+          instance
+        else
+          super.tap { |doc| doc.add_to_identity_map }
+        end
+      end
+    end
+
+    def save(options={})
+      super.tap { |result| add_to_identity_map if result }
+    end
+
+    def delete
+      super.tap { remove_from_identity_map }
+    end
+
+    def add_to_identity_map
+      IdentityMap.repository[id] = self if IdentityMap.enabled?
+    end
+
+    def remove_from_identity_map
+      IdentityMap.repository.delete(id) if IdentityMap.enabled?
+    end
+  end
+end

data/lib/croesus/platform.rb

@@ -0,0 +1,47 @@
+# 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 'rbconfig'
+
+# Gets the current Operating System.
+module OS
+  def self.windows?
+    windows = /cygwin|mswin|mingw|bccwin|wince|emx/i
+
+    (RbConfig::CONFIG['host_os'] =~ windows) != nil
+  end
+
+  def self.mac?
+    mac = /darwin|mac os/i
+
+    (RbConfig::CONFIG['host_os'] =~ mac) != nil
+  end
+
+  def self.unix?
+    unix = /solaris|bsd/i
+
+    (RbConfig::CONFIG['host_os'] =~ unix) != nil
+  end
+
+  def self.linux?
+    linux = /linux/i
+
+    (RbConfig::CONFIG['host_os'] =~ linux) != nil
+  end
+end

data/lib/croesus/querying.rb

@@ -0,0 +1,63 @@
+# 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
+  module Querying
+    module ClassMethods
+      def read(id, options = nil)
+        { id: id, options: options, model: self, hit: false }
+      end
+      alias_method :get, :read
+      alias_method :find, :read
+
+      def read!(id, options = nil)
+        read(id, options) || raise(NotFound.new(id))
+      end
+      alias_method :get!, :read!
+      alias_method :find!, :read!
+
+      def read_multiple(ids, options = nil)
+        { ids: ids, options: options, model: self, hits: 0, misses: 0 }
+      end
+      alias_method :get_multiple, :read_multiple
+      alias_method :find_multiple, :read_multiple
+
+      def key?(id, options = nil)
+        { id: id, options: options, model: self }
+      end
+      alias :has_key? :key?
+
+      def load(id, attrs)
+        attrs ||= {}
+        instance = constant_from_attrs(attrs).allocate
+        instance.initialize_from_database(attrs.update('id' => id))
+      end
+
+      def constant_from_attrs(attrs)
+        self if attrs.nil?
+        type = attrs[:type] || attrs['type']
+        self if type.nil?
+        type.constantize
+      rescue NameError
+        self
+      end
+      private :constant_from_attrs
+    end
+  end
+end

data/lib/croesus/resources/about.rb

@@ -0,0 +1,15 @@
+
+# Delphix Source API template
+
+Croesus::DSL.evaluate do
+  resource :about do
+    description  'Retrieve static system-wide properties.'
+    root         '/resources/json/delphix/about'
+
+    get '/resources/json/delphix/about' do
+      description 'Retrieve the specified PublicSystemInfo object.'
+      returns     Array
+      name        :list
+    end
+  end
+end

data/lib/croesus/resources/basic_methods.rb

@@ -0,0 +1,36 @@
+# 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::BasicMethods
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+  private_class_method :included
+
+  module ClassMethods
+
+    def url(ref: nil, filter: nil, action: nil)
+      url = @root
+      url = ref.nil?    ? url : "#{url}/#{ref}"
+      url = filter.nil? ? url : "#{url}/#{filter}"
+      url = action.nil? ? url : "#{url}/#{action}"
+      Croesus.api_url(url)
+    end
+  end
+end

data/lib/croesus/resources/connectivity.rb

@@ -0,0 +1,42 @@
+
+# Delphix Source API template
+
+Croesus::DSL.evaluate do
+  resource :connectivity do
+    description  'Tools to test connectivity of external resources.'
+    root         '/resources/json/delphix/connectivity'
+
+    post '/resources/json/delphix/connectivity/connector' do
+      description 'Tests whether the specified host is accessible over Delphix '  \
+                  'Connector protocol with the provided credentials. This '       \
+                  'operates independent of any other objects in the Delphix '     \
+                  'system. If the connection attempt is successful, then this '   \
+                  'API call will return no data. If there is a problem '          \
+                  'connecting to the host, an API error is returned.'
+      returns     Array
+      name        :connector
+    end
+
+    post '/resources/json/delphix/connectivity/jdbc' do
+      description 'Tests whether the specified database is accessible over JDBC ' \
+                  'with the provided credentials. This operates independent of '  \
+                  'any other objects in the Delphix system. If the connection '   \
+                  'attempt is successful, then this API call will return no '     \
+                  'data. If there is a problem connecting to the host, an API '   \
+                  'error is returned.'
+      returns     Array
+      name        :jdbc
+    end
+
+    post '/resources/json/delphix/connectivity/ssh' do
+      description 'Tests whether the specified host is accessible over SSH with ' \
+                  'the provided credentials. This operates independent of any '   \
+                  'other objects in the Delphix system. If the connection '       \
+                  'attempt is successful, then this API call will return no '     \
+                  'data. If there is a problem connecting to the host, an API '   \
+                  'error is returned.'
+      returns     Array
+      name        :ssh
+    end
+  end
+end

data/lib/croesus/resources/container.rb

@@ -0,0 +1,135 @@
+
+# Delphix Source API template
+
+Croesus::DSL.evaluate do
+  resource :container do
+    description  'A container holding data.'
+    root         '/resources/json/delphix/database'
+
+    get '/resources/json/delphix/database' do
+      description 'Returns a list of databases on the system or within a group.'
+      returns     Array
+      name        :list
+    end
+
+    get '/resources/json/delphix/database/{ref}' do
+      description 'Retrieve the specified Container object.'
+      returns     Object
+      name        :read
+    end
+
+    post '/resources/json/delphix/database/{ref}' do
+      description 'Update the specified Container object.'
+      input       String
+      name        :update
+    end
+
+    post '/resources/json/delphix/database/{ref}' do
+      description 'Delete the specified Container object.'
+      input       String
+      name        :delete
+    end
+
+    post '/resources/json/delphix/database/export' do
+      description 'Provision a physical database.'
+      input       String
+      name        :export
+    end
+
+    post '/resources/json/delphix/database/fileMapping' do
+      description 'Generate file mappings for a particular timeflow point and ' \
+                  'a set of rules.'
+      input       String
+      name        :fileMapping
+    end
+
+    post '/resources/json/delphix/database/link' do
+      description 'Links the database specified by link parameters.'
+      input       String
+      name        :link
+    end
+
+    post '/resources/json/delphix/database/provision' do
+      description 'Provisions the container specified by the provision ' \
+                  'parameters.'
+      input       String
+      name        :provision
+    end
+
+    post '/resources/json/delphix/database/validateXpp' do
+      description 'Validate the container for cross-platform provisioning.'
+      input       String
+      name        :validateXpp
+    end
+
+    post '/resources/json/delphix/database/xpp' do
+      description 'Provisions the container specified by the provision ' \
+                  'parameters to a different host platform.'
+      input       String
+      name        :xpp
+    end
+
+    post '/resources/json/delphix/database/{ref}/attachSource' do
+      description 'Attaches a database source to a previously detached container.'
+      input       String
+      name        :attachSource
+    end
+
+    post '/resources/json/delphix/database/{ref}/connectionInfo' do
+      description 'Returns the connection information for the source '\
+                  'associated with this container.'
+      input       String
+      name        :connectionInfo
+    end
+
+    post '/resources/json/delphix/database/{ref}/detachSource' do
+      description 'Detaches a linked source from a database.'
+      input       String
+      name        :detachSource
+    end
+
+    post '/resources/json/delphix/database/{ref}/refresh' do
+      description 'Refreshes a container.'
+      input       String
+      name        :refresh
+    end
+
+    post '/resources/json/delphix/database/{ref}/requestXppUpload' do
+      description 'Request upload for cross-platform provisioning. See ' \
+                  'UploadParameters for more information on how to upload files.'
+      input       String
+      name        :requestXppUpload
+    end
+
+    post '/resources/json/delphix/database/{ref}/rollback' do
+      description 'Rolls back a container.'
+      input       String
+      name        :rollback
+    end
+
+    post '/resources/json/delphix/database/{ref}/switchTimeflow' do
+      description 'Switch to the latest point on the specified TimeFlow.'
+      input       String
+      name        :switchTimeflow
+    end
+
+    post '/resources/json/delphix/database/{ref}/sync' do
+      description 'Performs SnapSync on a database.'
+      input       String
+      name        :sync
+    end
+
+    post '/resources/json/delphix/database/{ref}/testPerformanceModeDataLoss' do
+      description 'Test the effect of data loss as might be seen as a result ' \
+                  'of a Delphix Engine failure with performanceMode enabled.'
+      input       String
+      name        :testPerformanceModeDataLoss
+    end
+
+    get '/resources/json/delphix/database/{ref}/xppStatus' do
+      description 'Get the cross-platform provisioning status of this container.'
+      input       String
+      name        :xppStatus
+    end
+  end
+end

data/lib/croesus/resources/fault.rb

@@ -0,0 +1,38 @@
+
+# Delphix Source API template
+
+Croesus::DSL.evaluate do
+  resource :fault do
+    description  'A representation of a fault, with associated user object.'
+    root         '/resources/json/delphix/fault'
+
+    get '/resources/json/delphix/fault' do
+      description 'Returns the list of all the faults that match the given '    \
+                  'criteria.'
+      returns     Array
+      name        :list
+    end
+
+    get '/resources/json/delphix/fault/{ref}' do
+      description 'Retrieve the specified Fault object '      \
+                  'criteria.'
+      returns     Array
+      name        :read
+    end
+
+    post '/resources/json/delphix/fault/{ref}/resolve' do
+      description 'Marks the fault as resolved. The system will attempt to '      \
+                  'automatically detect cases where the fault has been resolved; '\
+                  'but this is not always possible and may only occur on '        \
+                  'periodic intervals. In these cases, the user can proactively ' \
+                  'mark the fault resolved. This does not change the underlying ' \
+                  'disposition of the fault - if the problem is still present '   \
+                  'the system may immediately diagnose the same problem again. '  \
+                  'This should only be used to notify the system of resolution '  \
+                  'after the underlying problem has been resolved.'
+                  'criteria.'
+      returns     Array
+      name        :resolve
+    end
+  end
+end

data/lib/croesus/resources/fault_effect.rb

@@ -0,0 +1,24 @@
+
+# Delphix Source API template
+
+Croesus::DSL.evaluate do
+  resource :fault_effect do
+    description  'An error affecting a user object whose root cause is a ' \
+                 'fault. A fault effect can only be resolved by resolving the ' \
+                 'fault which is its root cause.'
+    root         '/resources/json/delphix/fault/effect'
+
+    get '/resources/json/delphix/fault/effect' do
+      description 'Returns the list of all the fault effects that match the '     \
+                  'given criteria.'
+      returns     Array
+      name        :list
+    end
+
+    get '/resources/json/delphix/fault/effect/{ref}' do
+      description 'Retrieve the specified FaultEffect object.'
+      returns     Array
+      name        :read
+    end
+  end
+end

data/lib/croesus/resources/group.rb

@@ -0,0 +1,37 @@
+
+# Delphix Source API template
+
+Croesus::DSL.evaluate do
+  resource :group do
+    description  'Database group.'
+    root         '/resources/json/delphix/group'
+
+    get '/resources/json/delphix/group' do
+      description 'List Group objects on the system.'
+      returns     Array
+      name        :list
+    end
+
+    get '/resources/json/delphix/group/{ref}' do
+      description 'Retrieve the specified Group object.'
+      returns     Array
+      name        :read
+    end
+
+    post '/resources/json/delphix/group' do
+      description 'Create a new Group object.'
+      name        :create
+    end
+
+    post '/resources/json/delphix/group/{ref}' do
+      description 'Update the specified Group object.'
+      name        :update
+    end
+
+    delete '/resources/json/delphix/group/{ref}' do
+      description 'Deletes the specified group. Any databases within the group '\
+                  'must be deleted first, otherwise this will fail.'
+      name        :delete
+    end
+  end
+end

data/lib/croesus/resources/host.rb

@@ -0,0 +1,26 @@
+
+# Delphix Source API template
+
+Croesus::DSL.evaluate do
+  resource :host do
+    description  'The representation of a host object.'
+    root         '/resources/json/delphix/host'
+
+    get '/resources/json/delphix/host' do
+      description 'Returns the list of all hosts in the system.'
+      returns     Array
+      name        :list
+    end
+
+    get '/resources/json/delphix/host/{ref}' do
+      description 'Retrieve the specified Host object.'
+      returns     Array
+      name        :read
+    end
+
+    post '/resources/json/delphix/host/{ref}' do
+      description 'Update the specified Host object.'
+      name        :update
+    end
+  end
+end

data/lib/croesus/resources/job.rb

@@ -0,0 +1,27 @@
+
+# Delphix Source API template
+
+Croesus::DSL.evaluate do
+  resource :job do
+    description  'Represents a job object.'
+    root         '/resources/json/delphix/job'
+
+    get '/resources/json/delphix/job' do
+      description 'Returns a list of jobs in the system. Jobs are listed in '   \
+                  'start time order.'
+      returns     Array
+      name        :list
+    end
+
+    get '/resources/json/delphix/job/{ref}' do
+      description 'Retrieve the specified Job object.'
+      returns     Array
+      name        :read
+    end
+
+    post '/resources/json/delphix/job/{ref}' do
+      description 'Update the specified Job object.'
+      name        :update
+    end
+  end
+end

data/lib/croesus/resources/namespace.rb

@@ -0,0 +1,39 @@
+
+# Delphix Source API template
+
+Croesus::DSL.evaluate do
+  resource :namespace do
+    description  'Objects within namespaces are always read-only. Attempts to ' \
+                 'modify those objects, or perform read-write operations using '\
+                 'them, will fail. When a namespace is failed over '\
+                 '(activated), all objects become read-write (assuming there '  \
+                 'are no conflicts in terms of names or shared resources) and ' \
+                 'it is no longer possible to receive subsequent replication '  \
+                 'updates.'
+    root         '/resources/json/delphix/namespace'
+
+    get '/resources/json/delphix/namespace' do
+      description 'List Namespace objects on the system.'
+      returns     Array
+      name        :list
+    end
+
+    get '/resources/json/delphix/namespace/{ref}' do
+      description 'Retrieve the specified Namespace object.'
+      returns     Array
+      name        :read
+    end
+
+    post '/resources/json/delphix/namespace/{ref}' do
+      description 'Update the specified Namespace object.'
+      name        :update
+    end
+
+    delete '/resources/json/delphix/namespace/{ref}' do
+      description 'Deletes a namespace and all of the objects contained within '\
+                  'it. This will cause all of the objects in the namespace to ' \
+                  'be permanently removed.'
+      name        :delete
+    end
+  end
+end

data/lib/croesus/resources/policy.rb

@@ -0,0 +1,38 @@
+
+# Delphix Source API template
+
+Croesus::DSL.evaluate do
+  resource :policy do
+    description  'The base policy type.'
+    root         '/resources/json/delphix/policy'
+
+
+    get '/resources/json/delphix/policy' do
+      description 'Returns a list of policies in the domain.'
+      returns     Array
+      name        :list
+    end
+
+    get '/resources/json/delphix/policy/{ref}' do
+      description 'Retrieve the specified Policy object.'
+      returns     Array
+      name        :read
+    end
+
+    post '/resources/json/delphix/policy' do
+      description 'Creates a new policy, subject to restrictions (see docs).'
+      name        :create
+    end
+
+    post '/resources/json/delphix/policy/{ref}' do
+      description 'Update the specified Policy object.'
+      name        :update
+    end
+
+    delete '/resources/json/delphix/policy/{ref}' do
+      description 'Deletes the specified policy, subject to restrictions '\
+                  '(see docs).'
+      name        :delete
+    end
+  end
+end