delphix_rb 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13023a01757e83dc91794bc757a79e93ccf5307f
-  data.tar.gz: d54f385a9686a0cdad0b5e139dc7b80d384e5de8
+  metadata.gz: 7350c64cf8d446bda6529be6aa7385bd399fce50
+  data.tar.gz: 2a8d077c2ee44e55bfca06da8714b795afd36ec7
 SHA512:
-  metadata.gz: f99321f8f6b734f43100a9af3a4f8bc4a9e1c15b80cf47cf05c6489bdb2bc174a2249d1d40b84987acb03ea927c2ce7543ef2588dfa0c7f4dbffb1d1ecc7a0e6
-  data.tar.gz: 6cf8be136611eacb0c120d7fcb21f92982abbcdff830095a24652bb9221cc37b7ec44161343eed50598ec547b2785434d7b1e4956e19871c81d01ceea9039cd2
+  metadata.gz: ce887be1591ee007c0be1b187e34648a2519f9ad0cd1d94526d7b46807dda4c49c524f4b8ff883e0a2cfc948271a3fda36414173fd8ef01f259ba4822b1ff378
+  data.tar.gz: d5527ab922eb63d2c5b62b62d98a29ad7a49ca925a3fdf67af0020540681753c0ccd290966a0c903f802f026110ec5d4b15ba6572db2aee56b772048c29575c6

data/Gemfile

@@ -1,9 +1,7 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
 
-# Add dependencies to develop your gem here.
+#gem 'excon', '~> 0.45.4'
+
 # Include everything needed to run rake, tests, features, etc.
 group :development do
   gem "shoulda", ">= 0"

data/Rakefile

@@ -21,7 +21,14 @@ Jeweler::Tasks.new do |gem|
   gem.description = %Q{Delphix Engine REST API}
   gem.email = "michael.kuehl@delphix.com"
   gem.authors = ["Michael Kuehl"]
+  
+  # exclude tests and examples
+  gem.files.exclude 'examples/*'
+  gem.files.exclude 'test/*'
+  
   # dependencies defined in Gemfile
+  gem.add_dependency 'excon', '~> 0.45.4'
+  
 end
 Jeweler::RubygemsDotOrgTasks.new
 

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/delphix_rb.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: delphix_rb 0.0.0 ruby lib
+# stub: delphix_rb 0.1.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "delphix_rb"
-  s.version = "0.0.0"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Michael Kuehl"]
-  s.date = "2016-01-12"
+  s.date = "2016-01-22"
   s.description = "Delphix Engine REST API"
   s.email = "michael.kuehl@delphix.com"
   s.extra_rdoc_files = [
@@ -28,9 +28,15 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "delphix_rb.gemspec",
-    "lib/delphix_rb.rb",
-    "test/helper.rb",
-    "test/test_delphix_rb.rb"
+    "lib/delphix.rb",
+    "lib/delphix/base.rb",
+    "lib/delphix/base_array.rb",
+    "lib/delphix/connection.rb",
+    "lib/delphix/environment.rb",
+    "lib/delphix/error.rb",
+    "lib/delphix/group.rb",
+    "lib/delphix/repository.rb",
+    "lib/delphix/util.rb"
   ]
   s.homepage = "http://github.com/mickuehl/delphix_rb"
   s.licenses = ["MIT"]
@@ -46,12 +52,14 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
       s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_runtime_dependency(%q<excon>, ["~> 0.45.4"])
     else
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, ["~> 1.0"])
       s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
       s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<excon>, ["~> 0.45.4"])
     end
   else
     s.add_dependency(%q<shoulda>, [">= 0"])
@@ -59,6 +67,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<bundler>, ["~> 1.0"])
     s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
     s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<excon>, ["~> 0.45.4"])
   end
 end
 

data/lib/delphix/base.rb

@@ -0,0 +1,53 @@
+
+module Delphix::Base
+  include Delphix::Error
+
+  attr_accessor :connection, :info, :details
+  
+  # The private new method accepts a connection and a hash
+  def initialize(connection, info={})
+    unless connection.is_a?(Delphix::Connection)
+      raise ArgumentError, "Expected a Delphix::Connection, got: #{connection}."
+    end
+    
+    @connection, @info = connection, info
+    @details = nil
+  end
+
+  def type
+    @info['type'] || 'unknown'
+  end
+  
+  def name
+    @info['name'] || ''
+  end
+  
+  def reference
+    @info['reference'] || ''
+  end
+    
+  def details
+    @details ||= refresh_details
+    @info = @details
+    @details
+  end
+
+  def refresh_details
+    # Placeholder. Subclasses need to implement this
+  end
+    
+  def to_s
+    "#{self.class.name}[#{type}, #{name}, #{reference}]"
+  end
+  
+  # a generic get method, used when there is not specialized method to invoke an API call
+  def get(endpoint, payload)
+    @connection.get( endpoint, {}, :body => payload)
+  end
+  
+  # a generic get method, used when there is not specialized method to invoke an API call
+  def post(endpoint, payload)
+    @connection.post( endpoint, {}, :body => payload)
+  end
+  
+end

data/lib/delphix/base_array.rb

@@ -0,0 +1,28 @@
+
+class Delphix::BaseArray < Array
+
+  def lookup_by_ref(ref)
+    return nil if self.size == 0
+    self.each do |o|
+      return o if o.reference == ref
+    end
+    return nil
+  end
+  
+  def lookup_by_name(name)
+    return nil if self.size == 0
+    self.each do |o|
+      return o if o.name == name
+    end
+    return nil
+  end
+  
+  def lookup_by_type(type)
+    return nil if self.size == 0
+    self.each do |o|
+      return o if o.type == type
+    end
+    return nil
+  end
+  
+end

data/lib/delphix/connection.rb

@@ -0,0 +1,105 @@
+# This class represents a Connection to a Delphix Engine. The Connection is
+# immutable in that once the url and options is set they cannot be changed.
+class Delphix::Connection
+  include Delphix::Error
+  
+  attr_reader :url, :options
+  
+  def initialize(url, opts)
+    case
+    when !url.is_a?(String)
+      raise ArgumentError, "Expected a String, got: '#{url}'"
+    when !opts.is_a?(Hash)
+      raise ArgumentError, "Expected a Hash, got: '#{opts}'"
+    else
+      @url, @options = url, opts
+      
+      # new HTTP client and session
+      @session = Excon.new(url, options)
+      @session_cookie = nil
+    end
+  end
+  
+  # The actual client that sends HTTP methods to the Delphix Engine.
+  def session
+    @session
+  end
+  
+  private :session
+  
+  # Send a request to the server
+  def request(*args, &block)
+    
+    request = compile_request_params(*args, &block)
+    
+    log_request(request) if Delphix.debug
+    
+    # execute the request and grao the session cookie if not already set
+    response = session.request(request)
+    @session_cookie ||= cookie?(response)
+    
+    log_response(response) if Delphix.debug
+    
+    return Delphix::Util.parse_json( response.body)
+    
+  rescue Excon::Errors::BadRequest => ex
+    raise ClientError, ex.response.body
+  rescue Excon::Errors::Unauthorized => ex
+    raise UnauthorizedError, ex.response.body
+  rescue Excon::Errors::NotFound => ex
+    raise NotFoundError, ex.response.body
+  rescue Excon::Errors::Conflict => ex
+    raise ConflictError, ex.response.body
+  rescue Excon::Errors::InternalServerError => ex
+    raise ServerError, ex.response.body
+  rescue Excon::Errors::Timeout => ex
+    raise TimeoutError, ex.message
+  end
+
+  # Delegate all HTTP methods to the #request.
+  [:get, :put, :post, :delete].each do |method|
+    define_method(method) { |*args, &block| request(method, *args, &block) }
+  end
+  
+  def log_request(request)
+    puts "#{[request[:method], request[:path], request[:body]]}" if Delphix.debug
+  end
+  
+  def log_response(response)
+    puts "#{[response.headers, response.body]}" if Delphix.debug
+  end
+  
+  def to_s
+    "Delphix::Connection { :url => #{url}, :options => #{options} }"
+  end
+
+private
+    
+  # Given an HTTP method, path, optional query, extra options, and block compiles a request.
+  def compile_request_params(http_method, path, query = nil, opts = nil, &block)
+    query ||= {}
+    opts ||= {}
+    headers = opts.delete(:headers) || {}
+    headers = { 'Cookie' => @session_cookie}.merge(headers) if @session_cookie
+    content_type = 'application/json'
+    user_agent = "Delphix/Delphix-API"
+    
+    {
+      :method        => http_method,
+      :path          => "#{path}",
+      :query         => query,
+      :headers       => { 'Content-Type' => content_type,
+                          'User-Agent'   => user_agent,
+                        }.merge(headers),
+      :expects       => (200..204).to_a << 304 << 403 << 500,
+      :idempotent    => http_method == :get,
+      :request_block => block
+    }.merge(opts).reject { |_, v| v.nil? }
+    
+  end
+  
+  def cookie?(response)
+    response.headers['Set-Cookie']
+  end
+
+end

data/lib/delphix/environment.rb

@@ -0,0 +1,66 @@
+
+require 'delphix/base_array'
+require 'delphix/repository'
+
+class Delphix::Environment
+  include Delphix::Base
+  
+  def initialize(reference)
+    @connection = Delphix.connection
+    @info = { 'reference' => reference }
+    @details = nil
+  end
+  
+  def repositories
+    repos = Delphix::BaseArray.new
+    result = get('/resources/json/delphix/repository', nil)['result']
+    result.each do |o|
+      repos << Delphix::Repository.new(connection, o) if o['environment'] == reference
+    end
+    repos
+  end
+  
+  def refresh_details
+    @details = get("/resources/json/delphix/environment/#{reference}", nil)['result']
+  end
+  
+  def self.create(name, address, port, toolkit_path, username, password)
+    body = {
+      :type => 'HostEnvironmentCreateParameters',
+      :primaryUser => {
+        :type => 'EnvironmentUser',
+        :name => username,
+        :credential => {
+          :type => 'PasswordCredential',
+          :password => password
+        }
+      },
+      :hostEnvironment => {
+        :type => 'UnixHostEnvironment',
+        :name => name
+      },
+      :hostParameters => {
+        :type => 'UnixHostCreateParameters',
+        :host => {
+          :type => 'UnixHost',
+          :address => address,
+          :sshPort => port,
+          :toolkitPath => toolkit_path
+        }
+      }
+    }
+    response = Delphix.post('/resources/json/delphix/environment', body.to_json)
+    
+    ref = response['result']
+    job = response['job']
+    
+    # create a new skeleton group object
+    env = Delphix::Environment.new ref
+    
+    # refresh the object from the DE
+    env.details
+    
+    env
+  end
+  
+end

data/lib/delphix/error.rb

@@ -0,0 +1,39 @@
+# This module holds the Errors for the gem.
+
+module Delphix::Error
+
+  # The default error. It's never actually raised, but can be used to catch all
+  # gem-specific errors that are thrown as they all subclass from this.
+  class DelphixError < StandardError
+  end
+
+  # Raised when invalid arguments are passed to a method.
+  class ArgumentError < DelphixError; end
+
+  # Raised when a request returns a 400.
+  class ClientError < DelphixError; end
+
+  # Raised when a request returns a 401.
+  class UnauthorizedError < DelphixError; end
+
+  # Raised when a request returns a 404.
+  class NotFoundError < DelphixError; end
+
+  # Raised when a request returns a 500.
+  class ServerError < DelphixError; end
+
+  # Raised when there is an unexpected response code / body.
+  class UnexpectedResponseError < DelphixError; end
+
+  # Raised when there is an incompatible version of Delphix.
+  class VersionError < DelphixError; end
+
+  # Raised when a request times out.
+  class TimeoutError < DelphixError; end
+
+  # Raised when login fails.
+  class AuthenticationError < DelphixError; end
+
+  # Raised when an IO action fails.
+  class IOError < DelphixError; end
+end

data/lib/delphix/group.rb

@@ -0,0 +1,31 @@
+
+class Delphix::Group
+  include Delphix::Base
+  
+  def initialize(reference)
+    @connection = Delphix.connection
+    @info = { 'reference' => reference }
+    @details = nil
+  end
+  
+  def refresh_details
+    @details = get("/resources/json/delphix/group/#{reference}", nil)['result']
+  end
+  
+  def self.create(name)
+    body = {
+      :type => 'Group',
+      :name => name
+    }
+    ref = Delphix.post('/resources/json/delphix/group', body.to_json)['result']
+    
+    # create a new skeleton group object
+    group = Delphix::Group.new ref
+    
+    # refresh the object from the DE
+    group.details
+    
+    group
+  end
+  
+end

data/lib/delphix/repository.rb

@@ -0,0 +1,9 @@
+
+class Delphix::Repository
+  include Delphix::Base
+  
+  def refresh_details
+    @details = get("/resources/json/delphix/repository/#{reference}", nil)['result']
+  end
+    
+end

data/lib/delphix/util.rb

@@ -0,0 +1,20 @@
+# This module holds shared logic that doesn't really belong anywhere else in the gem.
+
+module Delphix::Util
+  include Delphix::Error
+
+  module_function
+  
+  def parse_json(body)
+    JSON.parse(body) unless body.nil? || body.empty? || (body == 'null')
+  rescue JSON::ParserError => ex
+    raise UnexpectedResponseError, ex.message
+  end
+  
+  def pretty_print_json(body)
+    JSON.pretty_generate( JSON.parse( body))
+  end
+  
+  module_function :parse_json, :pretty_print_json
+  
+end

data/lib/delphix.rb

@@ -0,0 +1,146 @@
+  
+require 'json'
+require 'excon'
+
+module Delphix
+  
+  require 'delphix/error'
+  require 'delphix/util'
+  require 'delphix/connection'
+  require 'delphix/base'
+  require 'delphix/base_array'
+  require 'delphix/environment'
+  require 'delphix/group'
+  require 'delphix/repository'
+  
+  def authenticate!(username,password)
+    case
+    when !username.is_a?(String)
+      raise ArgumentError, "Expected a String, got: '#{username}'"
+    when !password.is_a?(String)
+      raise ArgumentError, "Expected a String, got: '#{password}'"
+    else
+      @username, @password = username, password
+    end
+    
+    reset_connection!
+    
+    # create a session
+    session = { 
+      :type => 'APISession',
+      :version => {
+        :type => 'APIVersion', # Delphix Engine 4.3.1.x and above
+        :major => 1,
+        :minor => 6,
+        :micro => 0
+      }
+    }
+    post('/resources/json/delphix/session', session.to_json)
+    
+    # authenticate the session
+    auth = {
+      :type => 'LoginRequest',
+      :username => username,
+      :password => password
+    }
+    post('/resources/json/delphix/login', auth.to_json)
+    
+  end
+    
+  def environments
+    envs = BaseArray.new
+    result = get('/resources/json/delphix/environment', nil)['result']
+    result.each do |o|
+      envs << Environment.new(connection, o)
+    end
+    envs
+  end
+  
+  def groups
+    groups = BaseArray.new
+    result = get('/resources/json/delphix/group', nil)['result']
+    result.each do |o|
+      groups << Group.new(connection, o)
+    end
+    groups
+  end
+  
+  def repositories
+    repos = BaseArray.new
+    result = get('/resources/json/delphix/repository', nil)['result']
+    result.each do |o|
+      repos << Repository.new(connection, o)
+    end
+    repos
+  end
+  
+  def targets
+  end
+  
+  def sources
+  end
+  
+  # a generic get method, used when there is not specialized method to invoke an API call
+  def get(endpoint, payload)
+    connection.get( endpoint, {}, :body => payload)
+  end
+  
+  # a generic get method, used when there is not specialized method to invoke an API call
+  def post(endpoint, payload)
+    connection.post( endpoint, {}, :body => payload)
+  end
+  
+  def url
+    @url ||= env_url
+    @url
+  end
+
+  def url=(new_url)
+    @url = new_url
+    reset_connection!
+  end
+
+  def options
+    @options ||= env_options
+  end
+  
+  def options=(new_options)
+    @options = env_options.merge(new_options || {})
+    reset_connection!
+  end
+
+  def connection
+    @connection ||= Connection.new(url, options)
+  end
+
+  def reset_connection!
+    @connection = nil
+  end
+  
+  def debug
+    @debug || false
+  end
+  
+  def debug=(new_value) 
+    @debug = new_value
+  end
+  
+private
+  
+  def env_url
+    ENV['DELPHIX_URL'] || default_url
+  end
+  
+  def default_url
+    'http://localhost'
+  end
+  
+  def env_options
+    {}
+  end
+  
+  module_function :get, :post, :environments, :groups, :repositories, :targets, :sources,
+    :authenticate!, :url, :url=, :options, :options=, :connection, :reset_connection!, :debug, :debug=,
+    :env_url, :default_url, :env_options
+         
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delphix_rb
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Michael Kuehl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-12 00:00:00.000000000 Z
+date: 2016-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.45.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.45.4
 description: Delphix Engine REST API
 email: michael.kuehl@delphix.com
 executables: []
@@ -97,9 +111,15 @@ files:
 - Rakefile
 - VERSION
 - delphix_rb.gemspec
-- lib/delphix_rb.rb
-- test/helper.rb
-- test/test_delphix_rb.rb
+- lib/delphix.rb
+- lib/delphix/base.rb
+- lib/delphix/base_array.rb
+- lib/delphix/connection.rb
+- lib/delphix/environment.rb
+- lib/delphix/error.rb
+- lib/delphix/group.rb
+- lib/delphix/repository.rb
+- lib/delphix/util.rb
 homepage: http://github.com/mickuehl/delphix_rb
 licenses:
 - MIT

data/test/helper.rb

@@ -1,34 +0,0 @@
-require 'simplecov'
-
-module SimpleCov::Configuration
-  def clean_filters
-    @filters = []
-  end
-end
-
-SimpleCov.configure do
-  clean_filters
-  load_adapter 'test_frameworks'
-end
-
-ENV["COVERAGE"] && SimpleCov.start do
-  add_filter "/.rvm/"
-end
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'delphix_rb'
-
-class Test::Unit::TestCase
-end

data/test/test_delphix_rb.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestDelphixRb < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end