croesus 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22d33e6e4cdd37db74378da89f2bd2f175e1ae71
+  data.tar.gz: fa8287cacf9e7742238a1544184e4e5e96303bc7
+SHA512:
+  metadata.gz: c2c7847b85e88e2ead476f02f467a913b8d1fb9bfe0b06e958091490cc2b2817661c0f5c694d42ac6964792e656665c71d5cca757658ebce27ffbcfdbe22833c
+  data.tar.gz: 7c97d5ace4c3263da5c4bc834df5720d910a6f01547e03f1b2aa3483d8eaf67633220a023380f01c34339689feca1111142308801ab8a2c352600dc0a770aa02

data/.gitignore

@@ -0,0 +1,121 @@
+# Created by https://www.gitignore.io
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+
+### TextMate ###
+*.tmproj
+*.tmproject
+tmtags
+
+
+### SublimeText ###
+# cache files for sublime text
+*.tmlanguage.cache
+*.tmPreferences.cache
+*.stTheme.cache
+
+# workspace files are user-specific
+*.sublime-workspace
+
+# project files should be checked into the repository, unless a significant
+# proportion of contributors will probably not be using SublimeText
+# *.sublime-project
+
+# sftp configuration file
+sftp-config.json
+
+
+### Tags ###
+# Ignore tags created by etags, ctags, gtags (GNU global) and cscope
+TAGS
+!TAGS/
+tags
+!tags/
+gtags.files
+GTAGS
+GRTAGS
+GPATH
+cscope.files
+cscope.out
+cscope.in.out
+cscope.po.out
+
+
+
+### vim ###
+[._]*.s[a-w][a-z]
+[._]s[a-w][a-z]
+*.un~
+Session.vim
+.netrwhist
+*~
+
+
+### Emacs ###
+# -*- mode: gitignore; -*-
+*~
+\#*\#
+/.emacs.desktop
+/.emacs.desktop.lock
+*.elc
+auto-save-list
+tramp
+.\#*
+
+# Org-mode
+.org-id-locations
+*_archive
+
+# flymake-mode
+*_flymake.*
+
+# eshell files
+/eshell/history
+/eshell/lastdir
+
+# elpa packages
+/elpa/
+
+# reftex files
+*.rel
+
+# AUCTeX auto folder
+/auto/
+
+SCRATCH
+Gemfile.lock

data/.ruby-version

@@ -0,0 +1 @@
+2.1.3

data/API_operation.txt

@@ -0,0 +1,197 @@
+
+
+# Operation | Description
+# ----------|----------------------------------------------------------------|
+#   create  | Create a new instance of the object type from the root static  |
+#           | context. Not all objects can be created in this simplified     |
+#           | fashion. Databases, for example, are created through the link  |
+#           | and provision commands.                                        |
+# ----------|----------------------------------------------------------------|
+#   delete  | Deletes an object that has been selected. Not all objects can  |
+#           | be deleted.                                                    |
+# ----------|----------------------------------------------------------------|
+#    get    | Display all or some of the properties of an object after       |
+#           | selecting it.                                                  |
+# ----------|----------------------------------------------------------------|
+#    list   | For a given object type (represented by a static context such  |
+#           | as database), list the objects on the system, optionally       |
+#           | constrained by some set of attributes. Some objects are global |
+#           | to the system and do not support this operation.               |
+# ----------|----------------------------------------------------------------|
+#   select  | Select a particular object by name to get properties or        |
+#           | perform an operation on the object. See the “Delphix Objects”  |
+#           | section for more information on object naming.                 |
+# ----------|----------------------------------------------------------------|
+#   update  | Enter a command context to change one or more properties of an |
+#           | object after selecting. Not all objects support this operation,|
+#           | and only properties that can be edited are shown when in the   |
+#           | update command context.                                        |
+# ----------|----------------------------------------------------------------|
+
+Environment Components
+An environment is the root of the representation of external state that manages
+database instances. An environment could be a single host (UnixHostEnvironment)
+or an Oracle cluster (OracleClusterEnvironment). Environments exist to contain
+repositories, and each environment may have any number of repositories
+associated with it. A repository is the entity that contains database instances.
+Repositories are typically installation directories (OracleInstall) within an
+environment. Within each repository of any number of SourceConfig objects, which
+represent known database instances. The source config exists independent of
+Delphix, and could represent a possible dSource (in which case there is no
+associated database object), or could be managed entirely by Delphix (for VDBs).
+The source config contains intrinsic properties of the database instance, while
+the source (described below) contains information specific to Delphix and only
+exists when the source config is linked to a dSource or VDB.
+
+Most environment objects are created through the act of discovery. By specifying
+a host, Delphix will attempt to automatically discover all environments,
+repositories, and source configs. These objects can also be added manually after
+the fact in cases where discovery fails.
+
+The environment hierarchy can be represented this way:
+
+         |-------------------------------|
+         |          Environment          |
+         |-------------------------------|
+         |      UnixHostEnvironment      |
+         |-------------------------------|
+                        |
+                        |
+         |-------------------------------|
+         |        SourceRepository       |
+         |-------------------------------|
+         |        OracleInstall          |
+         |-------------------------------|
+                        |
+                        |
+         |-------------------------------|
+         |        SourceConfig           |
+         |-------------------------------|
+         |       OracleSIConfig          |
+         |-------------------------------|
+
+
+The generic type is listed in the top portion of each box, with an example of
+the Oracle single instance objects in the lower portion of each box. Each of
+these objects can contain multiple child objects with it.
+
+Database Components
+The core of all databases within Delphix is the Container that contains all the
+physical data associated with the database, whether it is a dSource or VDB.
+Within each container is a Timeflow, which represents a single timeline of
+change within the database history. Currently, a container can only have one
+timeflow, though this limitation may be relaxed in a future release. Within a
+timeflow are two important object: TimeflowSnapshot objects and TimeflowRange
+objects. Timeflow ranges represent the provisionable ranges within the history
+of the timeflow, while timeflow snapshot represent a point at which at snapshot
+was taken and therefore more likely to provision in a short amount of time. The
+resulting data hierarchy can be represented this way:
+
+        |-------------------------------|
+        |           Container           |
+        |-------------------------------|
+        |    OracleDatabaseContainer    |
+        |-------------------------------|
+                       |
+                       |
+        |-------------------------------|
+        |          Timeflow             |
+        |-------------------------------|
+        |        OracleTimeflow         |
+        |-------------------------------|
+                       |
+                       |
+        |-------------------------------|
+        |       TimeflowSnapshot        |
+        |-------------------------------|
+        |        OracleSnapshot         |
+        |-------------------------------|
+
+
+Each container may be associated with a Source. A source is the Delphix
+representation of an external database when it is associated with a container,
+and contains information specific to managing that source. Not all source
+configs within an environment have a source associated with them (as is the case
+with linkable databases), but all sources must have a source config. Containers
+may have no sources associated with them if they are unlined; sources can be
+manually attached at a later point. Currently, each container can have at most
+once source associated with it, though this may change in a future release.
+
+
+Properties
+                   |
+currentTimeflow    | A reference to the currently active timeflow for this
+                   | container.
+                   | Type: REFERENCE TO "Timeflow"
+-------------------|------------------------------------------------------------
+description        | Optional user-provided description for the container.
+                   | Type: STRING
+                   | Constraints:
+                   | Max Length: 1024
+                   | Create: optional
+                   | Update: optional
+-------------------|------------------------------------------------------------
+group              | A reference to the group containing this container.
+                   | Type: REFERENCE TO "Group"
+                   | Constraints:
+                   | Create: required
+-------------------|------------------------------------------------------------
+masked             | Whether this container has the masked bit set.
+                   | Type: boolean
+                   | Constraints:
+                   | Create: optional
+                   | Update: optional
+-------------------|------------------------------------------------------------
+performanceMode    | Users can enable Performance Mode to improve performance of
+                   | write operations to their databases. If Performance Mode is
+                   | enabled, data consistency is guaranteed, but there might
+				   | be small amount of data loss in the case of Delphix Engine
+                   | failure.
+                   |
+                   | Each time a Delphix Engine is restarted (whether caused by
+                   | a failure or not), all virtual databases with Performance
+				   | Mode enabled will be shutdown and restarted automatically.
+                   | Type: boolean
+                   | Constraints:
+                   | Create: optional
+                   | Update: optional
+-------------------|------------------------------------------------------------
+provisionContainer | A reference to the container this container was provisioned
+                   | from.
+                   | Type: REFERENCE TO "Container"
+-------------------|------------------------------------------------------------
+
+
+
+
+performanceMode
+Users can enable Performance Mode to improve performance of write operations to their databases. If Performance Mode is enabled, data consistency is guaranteed, but there might be a small amount of data loss in the case of Delphix Engine failure.
+
+Each time a Delphix Engine is restarted (whether caused by a failure or not), all virtual databases with Performance Mode enabled will be shutdown and restarted automatically.
+
+Type: boolean
+Constraints:
+Create: optional
+Update: optional
+provisionContainer
+A reference to the container this container was provisioned from.
+
+Type: Reference to Container
+runtime
+Runtime properties of this container.
+
+Type: DBContainerRuntime
+
+
+
+
+
+
+
+
+
+
+
+
+
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,146 @@
+SOURCE
+# ==============================================================================
+#
+# 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.
+#
+# Sources are attached to Container (database) objects, which hold the actual
+# data for the source. Every source has a SourceConfig object associated with
+# it, though not all source configs have associated sources. The source config
+# tracks information that is intrinsic to the external database, independent of
+# whether it is incorporated into the Delphix system is any way. Both linked
+# and virtual sources share the same config for a particular database type
+# (though it may differ, for example, between Oracle single instance and RAC).
+# Source configs without a source exist for externally-controlled
+# (link-capable) databases, while source configs for virtual sources are
+# created as needed and managed by Delphix. The hierarchy of objects is:
+#
+# * Source
+# * SourceConfig
+# * SourceRepository
+# * SourceEnvironment
+#
+# Sources can have SourceRuntime properties that are not stored with the
+# persistent representation of the object, but pulled on demand from the
+# running database instance. These runtime properties therefore may not always
+# be available, and cannot be manipulated via Delphix.
+#
+#    TypedObject
+#        |__PersistentObject
+#             |__UserObject
+#                  |__Source
+#                       |              -----\
+#                       |__PgSQLSource       \
+#                       |__OracleSource       \ ______ [ Known Subclasses ]
+#                       |__MSSqlSource        /
+#                       |__AppDataSource     /
+#                                      -----/
+#
+#
+module Croesus::API
+  # P R O P E R T I E S
+  #
+  # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+  # config            | Reference to the configuration for the source.
+  #                   | Type: Reference to SourceConfig.
+  #                   | Constraints:
+  #                   | Create: optional
+  #
+  # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+  # container         | Reference to the container being fed by this source,
+  #                   | if any.
+  #                   | Type: Reference to Container
+  #
+  # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+  # description       | A user-provided description of the source.
+  #                   | Type: string
+  #
+  # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+  # enabled           | Flag indicating whether the source is enabled.
+  #                   | Type: boolean
+  #
+  # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+  # runtime           | Runtime properties of this source.
+  #                   | Type: SourceRuntime
+  #
+  # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+  # staging           | Flag indicating whether the source is used as a staging
+  #                   | source for pre-provisioning. Staging sources are
+  #                   | managed by the Delphix system.
+  #                   | Type: boolean
+  #
+  # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+  # status            | Status of this source.
+  #                   | Type: boolean
+  #                   | Constraints:
+  #                   | Acceptable values: DEFAULT, PENDING_UPGRADE
+  #
+  # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+  # virtual           | Flag indicating whether the source is managed by the
+  #                   | Delphix system.
+  #                   | Type: boolean
+  #
+  #
+  # I N H E R I T E D   P R O P E R T I E S
+  #
+  # Object Type: UserObject
+  # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+  # name              | Object name
+  #                   | Type: objectName
+  #                   | Constraints:
+  #                   | Max Length: 256
+  #                   | Create: optional
+  #                   | Update: optional
+  #
+  # Object Type: PersistentObject
+  # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+  # namespace         | Alternate namespace for this object, for replicated and
+  #                   | restored objects.
+  #                   | Type: Reference to Namespace
+  #
+  # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+  # reference         | Object reference.
+  #                   | Type: Reference to PersistentObject
+  #
+  # Object Type: TypedObject
+  # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+  # type              | Object type.
+  #                   | Type: type
+  #                   | Constraints:
+  #                   | Required: true
+  #
+  # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+  #
+  class Source
+    # S T A N D A R D   O P E R A T I O N S
+    #
+    # List
+    # @note GET /resources/json/delphix/source
+    # Lists sources on the system, optionally list only.
+    #
+    # @param [String] source
+    # @option source database    List sources associated with the given
+    #                            container reference.
+    #                            Type: Reference to Container.
+    # @option source environment List sources associated with the given source
+    #                            environment reference.
+    #                            Type: Reference to SourceEnvironment.
+    # @option source repository  List sources associated with the given source
+    #                            repository reference.
+    #                            Type: Reference to SourceEnvironment
+    #
+    # @return [Array(Source)] Array of Type: Source
+    #
+    # @api public
+    def self.list(source = nil)
+      Croesus.get(filter_url(source))
+    end
+  end
+end
+
+
+
+
+

data/Rakefile

@@ -0,0 +1,26 @@
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'yard'
+
+desc 'Run tests'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run Rubocop on the gem'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+  task.fail_on_error = true
+end
+
+YARD::Config.load_plugin 'redcarpet-ext'
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['**/*.rb', '-', 'README.md', 'CHANGELOG.md', 'LICENSE.txt']
+  t.options = ['--markup-provider=redcarpet', '--markup=markdown']
+end
+
+desc 'Build documentation'
+task doc: [:yard]
+
+task default: [:spec, :rubocop, :build, :install]
+

data/bin/console_cmd.rb

@@ -0,0 +1,133 @@
+#!/usr/bin/env ruby
+#
+# 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.
+#
+$: << File.dirname(__FILE__) + '/../lib'
+
+require 'pry'
+require 'croesus'
+require 'command_line_reporter'
+
+include CommandLineReporter
+include Croesus::Utils
+
+# add ability to reload console
+def reload
+  reload_msg = '# Reloading the console...'
+  files = $LOADED_FEATURES.select { |feat| feat =~ /\/croesus\// }
+  files.each { |file| load file }
+  puts CodeRay.scan(reload_msg, :ruby).term
+  exec($0)
+end
+
+# Construct a custom Pry prompt proc.
+#
+# @param char [String] prompt character
+# @return [proc] a prompt proc
+# @api private
+def prompt(char)
+  proc { |target_self, nest_level, pry|
+    [
+      "[#{pry.input_array.size}] ",
+      "Cc^(#{Pry.view_clip(target_self.class)})",
+      "#{":#{nest_level}" unless nest_level.zero?}#{char} "
+    ].join
+  }
+end
+
+def menu
+  resources ||= []
+  Croesus::AnonoMod.registry.each do |key, value|
+    resources << key
+  end
+  puts
+  dyno_width = terminal_dimensions[0] - 32
+  header title: 'Welcome to the Delphix Engine Ruby Rumble in the Jungle!',
+    align: 'center', width: terminal_dimensions[0]
+  table border: true do
+    row header: true, color: 'red'  do
+      column 'Num', width: 3, align: 'right', color: 'blue', padding: 0
+      column 'Resource Name', width: 18, align: 'left', padding: 0
+      column "Description (http://#{Croesus.server}/api/json/delphix.json)",
+        width: dyno_width, align: 'left', padding: 0
+    end
+    resources.sort.each.with_index(1) do |resource, i|
+      row do
+        column '%02d' % i
+        column classify(resource)
+        column Croesus::AnonoMod.registry[resource].description
+      end
+    end
+  end
+  footer title: 'For help on a resource try help resource name'
+end
+
+def define_resource_methods
+  Croesus::AnonoMod.registry.each do |key, value|
+    # define_method(key) { Croesus::AnonoMod.registry[key.to_sym] }
+    define_method(key) do |*args|
+      Croesus::AnonoMod.registry[key.to_sym].send :"#{args}"
+    end
+  end
+end
+
+def define_resource_methods
+  Croesus::AnonoMod.registry.each do |key, value|
+    # define_method(key) { Croesus::AnonoMod.registry[key.to_sym] }
+    define_method(key) do |*args|
+      puts "Croesus::AnonoMod.registry[#{key.to_sym}] send #{args}"
+      # Croesus::AnonoMod.registry[key.to_sym].send :"#{args}"
+    end
+  end
+end
+
+def delphix_json_api
+  Croesus.get "http://#{Croesus.server}/api/json/delphix.json"
+end
+
+# Setup and connect
+# Croesus.server     = ''
+# Croesus.api_user   = ''
+# Croesus.api_passwd = ''
+# Croesus.verbose    = true
+# Croesus.session.body
+
+welcome = <<eos
+      ______                  ______     ____
+    .~      ~. |`````````,  .~      ~.  |                        ..'''' |         |             ..''''
+   |           |'''|'''''  |          | |______               .''       |         |          .''
+   |           |    `.     |          | |                  ..'          |         |       ..'
+    `.______.' |      `.    `.______.'  |___________ ....''             `._______.' ....''
+
+
+eos
+puts CodeRay.scan(welcome, :ruby).term
+define_resource_methods
+menu
+puts
+puts 'Use `exit` to quit the live session.'
+puts 'Use `q` to jump out of displaying a large output.'
+puts 'Use `reload` to reload a session.'
+puts
+puts 'Type menu at anytime to see the menu.'
+puts
+Pry.start(@config, :prompt => [prompt(' >> '), prompt("*")])
+Pry.start
+
+

data/croesus.gemspec

@@ -0,0 +1,39 @@
+# encoding: UTF-8
+
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'croesus/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'croesus'
+  s.version     = Croesus::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.date        = Time.now.strftime("%Y-%m-%d")
+  s.summary     = 'Council with the Delphic oracle, King of Lydia'
+  s.description = 'Ruby REST client for Delphix virtual database appliance'
+  s.authors     = ['Stefano Harding']
+  s.email       = 'riddopic@gmail.com'
+  s.homepage    = 'https://github.com/riddopic/croesus'
+  s.license     = 'Apache 2.0'
+
+  s.files       = `git ls-files`.split
+  s.test_files  = `git ls-files spec/*`.split
+
+  s.add_dependency 'awesome_print'
+  s.add_dependency 'command_line_reporter'
+  s.add_dependency 'addressable',                    '>= 2.3.6'
+  s.add_dependency 'rest-client',                    '>= 1.6.7'
+  s.add_dependency 'json',                           '>= 1.8.1'
+
+  s.add_development_dependency 'yard',               '>= 0.8.6'
+  s.add_development_dependency 'github-markup',      '>= 1.3.0'
+  s.add_development_dependency 'redcarpet',          '>= 3.2.0'
+  s.add_development_dependency 'yard-redcarpet-ext', '>= 0.0.3'
+  s.add_development_dependency 'rubocop',            '>= 0.26.0'
+  s.add_development_dependency 'rake',               '>= 10.3.2'
+  s.add_development_dependency 'coveralls',          '>= 0.7.1'
+  s.add_development_dependency 'rspec',              '>= 3.1.0'
+  s.add_development_dependency 'fuubar',             '>= 2.0.0'
+  s.add_development_dependency 'timecop',            '>= 0.7.1'
+end