croesus 0.1.3

data/lib/croesus/web_client/web_client.rb

@@ -0,0 +1,153 @@
+# 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
+  class WebClient
+    def self.request(method, url, headers, body, timeout, &callback)
+      request = Croesus::WebRequest.new(method, url, headers, body)
+
+      if callback
+        Thread.new do
+          callback.call(self.internal_request(request, timeout))
+        end
+      else
+        self.internal_request(request, timeout)
+      end
+    end
+
+    def self.internal_request(request, timeout)
+      HTTP_HEADERS.each { |key, value| request.add_header(key, value) }
+      response = nil
+
+      begin
+        case request.method
+        when :get
+          response = RestClient::Request.execute(
+            method: :get,
+            url:     request.url,
+            headers: request.headers,
+            timeout: timeout
+          )
+        when :post
+          response = RestClient::Request.execute(
+            method: :post,
+            url:     request.url,
+            payload: request.body,
+            headers: request.headers,
+            timeout: timeout
+          )
+        when :delete
+          response = RestClient::Request.execute(
+            method: :delete,
+            url:     request.url,
+            payload: request.body,
+            headers: request.headers,
+            timeout: timeout
+          )
+        end
+      rescue RestClient::RequestTimeout
+        raise 'Request Timeout'
+      rescue RestClient::Exception => e
+        response = e.response
+      end
+
+      Croesus::WebResponse.new(response)
+    end
+  end
+
+  def self.default_header(name, value)
+    @@default_headers[name] = value
+  end
+
+  def self.clear_default_headers
+    @@default_headers = {}
+  end
+
+  def self.timeout(seconds)
+    @@timeout = seconds
+  end
+
+  # Define the #get, #post, and #delete helper methods for sending HTTP
+  # requests to the Delphix engine. You shouldn't need to use these methods
+  # directly, but they can be useful for debugging.
+  #
+  # The following HTTP methods are supported by the Delphix Appliance:
+  #
+  #    GET - Retrieve data from the server where complex input is not needed.
+  #          All GET requests are guaranteed to be read-only, but not all
+  #          read-only requests are required to use GET. Simple input
+  #          (strings, number, boolean values) can be passed as query
+  #          parameters.
+  #   POST - Issue a read/write operation, or make a read-only call that
+  #          requires complex input. The optional body of the call is
+  #          expressed as JSON.
+  # DELETE - Delete an object on the system. For languages that don't provide
+  #          a native wrapper for DELETE, or for delete operations with
+  #          optional input, all delete operations can also be invoked as POST
+  #          to the same URL with /delete appended to it.
+  #
+  # Each method returns a hash that responds to #code, #headers, #body and
+  # #raw_body obtained from parsing the JSON object in the response body.
+  #
+  # @param url [String<URL>] url the url of where to send the request
+  # @param [Hash{Symbol => String}] parameters key-value data of the HTTP
+  # API request
+  # @param [Block] block block to execute when the request returns
+  # @return [Fixnum, #code] the response code from Delphix engine
+  # @return [Hash, #headers] headers, beautified with symbols and underscores
+  # @return [Hash, #body] body parsed response body where applicable (JSON
+  # responses are parsed to Objects/Associative Arrays)
+  # @return [Hash, #raw_body] raw_body un-parsed response body
+  #
+  # @api semipublic
+  [:get, :post, :delete].each do |method|
+    define_singleton_method(method) do |url, parameters = {}, &callback|
+      WebClient.request(method.to_sym, url, @@default_headers,
+        parameters.to_json, @@timeout, &callback)
+    end
+  end
+
+  # The most important part of the client functionality - namely, provides a
+  # set of tools and methods that make it possible to build RESTfully CRUD
+  # messages to and from the Delphix Engine.
+  module InstanceMethods
+
+    private #   P R O P R I E T À   P R I V A T A   Vietato L'accesso
+
+    # Returns the current api endpoint, if present.
+    #
+    # @return [nil, String] the current endpoint
+    def endpoint
+      nil
+    end
+  end
+
+  # Class level methods to let you configure your api client.
+  module ClassMethods
+
+    # When present, lets you specify the api for the given client.
+    #
+    # @param [String, nil] value the endpoint to use.
+    # @example Setting a string endpoint endpoint '/resources/json/delphix'
+    # @example Unsetting the string endpoint endpoint nil
+    def endpoint(value = nil)
+      define_method(:endpoint) { value }
+    end
+  end
+end

data/lib/croesus/web_client/web_request.rb

@@ -0,0 +1,77 @@
+# 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 'addressable/uri' unless defined?(Addressable)
+require 'base64'          unless defined?(Base64)
+
+module Croesus
+  class WebRequest
+    extend Croesus::Utils::ClassMethods
+    include Croesus::Utils
+
+    attr_reader :method, :url, :headers, :body, :all
+
+    def add_header(name, value)
+      @headers[name] = value
+    end
+
+    def initialize(method, url, headers = {}, body = nil)
+      @method = method
+
+      if (method == :get)
+        if body.is_a?(Hash) && body.length > 0
+          if url.include? "?"
+            url += "&"
+          else
+            url += "?"
+          end
+
+          uri = Addressable::URI.new
+          uri.query_values = body
+          url += uri.query
+        end
+      else
+         @body = body
+      end
+
+      unless url =~ URI.regexp
+        raise "Invalid URL: " + url
+      end
+
+      @url = url.gsub(/\s+/, '%20')
+
+      @headers = {
+        'Date'       => utc_httpdate,
+        'Request-ID' => request_id,
+      }
+
+      headers.each_pair {|key, value| @headers[key.downcase] = value }
+
+      Croesus.last_request = {
+        headers: @headers,
+        method: @method,
+        url: @url
+      }
+      begin
+        Croesus.last_request[:body] = JSON.parse(@body) if body.length > 2
+      rescue Exception
+      end
+    end
+  end
+end

data/lib/croesus/web_client/web_response.rb

@@ -0,0 +1,70 @@
+# 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 'json'
+
+module Croesus
+  class WebResponse
+    include Croesus::Utils
+    include ::Net::HTTPHeader
+
+    attr_reader :code, :raw_body, :body, :headers, :cookies
+
+    def initialize(response)
+      @code = response.code;
+      @headers = response.headers
+      @raw_body = response
+      @body = @raw_body
+      @cookies = response.cookies
+
+      Croesus.last_response = {
+        code: response.code,
+        headers: response.headers,
+        body: JSON.parse(response.body),
+        cookies: response.cookies,
+        description: response.description
+      }.recursively_normalize_keys
+
+      begin
+        @body = JSON.parse(@raw_body)
+      rescue Exception
+      end
+    end
+
+    def ==(other)
+      @headers == other
+    end
+
+    def inspect
+      @headers.inspect
+    end
+
+    def method_missing(name, *args, &block)
+      if @headers.respond_to?(name)
+        @headers.send(name, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to?(method)
+      super || @headers.respond_to?(method)
+    end
+  end
+end

data/lib/croesus.rb

@@ -0,0 +1,250 @@
+# 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.
+#
+
+# Debuging hook 'n' stow
+require 'ap'
+
+# Croesus Ruby bindings
+require 'rest-client'
+require 'command_line_reporter'
+
+# Core Ruby Extentions
+require 'croesus/core_ext/blank'
+require 'croesus/core_ext/hash'
+
+# Version
+require 'croesus/version'
+
+# Base
+require 'croesus/utils'
+require 'croesus/platform'
+require 'croesus/querying'
+require 'croesus/attribute'
+require 'croesus/attributes'
+require 'croesus/validations'
+require 'croesus/identity_map'
+
+# DSL
+require 'croesus/dsl/dsl'
+require 'croesus/dsl/helpers'
+require 'croesus/dsl/mod_factory'
+require 'croesus/dsl/resource_dsl'
+require 'croesus/dsl/route_dsl'
+
+# Resources
+require 'croesus/resources/basic_methods'
+require 'croesus/resources/about'
+require 'croesus/resources/connectivity'
+require 'croesus/resources/container'
+require 'croesus/resources/fault'
+require 'croesus/resources/fault_effect'
+require 'croesus/resources/group'
+require 'croesus/resources/host'
+require 'croesus/resources/job'
+require 'croesus/resources/namespace'
+require 'croesus/resources/policy'
+require 'croesus/resources/source'
+require 'croesus/resources/source_config'
+require 'croesus/resources/source_environment'
+require 'croesus/resources/source_repository'
+require 'croesus/resources/system_info'
+require 'croesus/resources/timeflow'
+require 'croesus/resources/timeflow_snapshot'
+
+# Web CLient
+require 'croesus/web_client/web_client'
+require 'croesus/web_client/web_request'
+require 'croesus/web_client/web_response'
+
+# A library for supporting connections to the Delphix API.
+#
+module Croesus
+  extend Utils::ClassMethods
+  include IdentityMap
+  include Querying
+  include Utils
+
+  NotFound             = Class.new StandardError
+  APIError             = Class.new StandardError
+  CoercionError        = Class.new StandardError
+  ValidationError      = Class.new StandardError
+  ConfigurationError   = Class.new StandardError
+  InvalidStateError    = Class.new StandardError
+  InvalidMethodError   = Class.new StandardError
+  InvalidArgumentCount = Class.new StandardError
+
+  API_VERSION          = { type: 'APIVersion', major: 1, minor: 3, micro: 0 }
+
+  API_ENDPOINT         = '/resources/json/delphix'
+
+  HTTP_HEADERS         = {
+    'Accept'           =>  'application/json; charset=UTF-8',
+    'Content-Type'     =>  'application/json; charset=UTF-8',
+    'User-Agent'       =>  "Croesus/#{Croesus::VERSION} " \
+                           "(#{RUBY_ENGINE}/#{RUBY_PLATFORM} " \
+                           "#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL})"
+  }
+
+  @@timeout = 10
+  @@default_headers = {}
+
+  # Represents an undefined parameter used by auto-generated option methods
+  Undefined = Object.new.freeze
+
+  class << self
+    # @!attribute [rw] last_request
+    #   @return [Hash] retruns the last request
+    attr_accessor :last_request
+
+    # @!attribute [rw] last_response
+    #   @return [Hash] retruns the last response
+    attr_accessor :last_response
+
+    # @!attribute [rw] session
+    #   @return [Hash] retruns current session state
+    #   @return [#code] the response code from Delphix engine
+    #   @return [#headers] beautified with symbols and underscores
+    #   @return [#body] parsed response body
+    #   @return [#raw_body] un-parsed response body
+    attr_accessor :session
+
+    # @!attribute [rw] server
+    #   @return [String] Delphix server address
+    attr_accessor :server
+
+    # @!attribute [rw] api_user
+    #   @return [String] username to authenticate with
+    attr_accessor :api_user
+
+    # @!attribute [rw] api_passwd
+    #   @return [String] password for authentication
+    attr_accessor :api_passwd
+
+    # @!attribute [rw] verbose
+    #   @return [Nothing] enables verbosity
+    attr_accessor :verbose
+  end
+
+  @inheritance ||= 'not implemented'
+  Croesus::IdentityMap.enabled = true
+
+  # Returns the API endpoint for a given resource namespace by combining the
+  # server address with the appropriate HTTP headers.
+  #
+  # @param resource [Resource] namespace
+  #
+  # @return [URL] return the URL for the API endpoint
+  #
+  # @api public
+  def self.api_url(resource = nil)
+    'http://' + @server + resource
+  end
+
+  def self.session
+    Croesus.default_header(:cookies, cookies)
+    @session ||= login(@api_user, @api_passwd)
+  end
+
+  # Establish a session with the Delphix engine and return an identifier
+  # through browser cookies. This session will be reused in subsequent calls,
+  # the same session credentials and state are preserved without requiring a
+  # re-authentication call. Sessions do not persisit between incovations.
+  #
+  # @return [Hash] cookies
+  #   containing the new session cookies
+  #
+  # @api public
+  def self.cookies
+    @resp ||= Croesus.post session_url,
+      { type: 'APISession', version: API_VERSION }
+    @resp.cookies
+  end
+
+  # Authenticates the session so that API calls can be made. Only supports basic
+  # password authentication.
+  #
+  # @param [String] user
+  #   user name to authenticate with
+  # @param [String] passwd
+  #   password to authenticate with
+  #
+  # @return [Fixnum, #code]
+  #   the response code from Delphix engine
+  # @return [Hash, #headers]
+  #   headers, beautified with symbols and underscores
+  # @return [Hash, #body] body
+  #   parsed response body where applicable (JSON responses are parsed to
+  #   Objects/Associative Arrays)
+  # @return [Hash, #raw_body] raw_body
+  #   un-parsed response body
+  #
+  # @api public
+  def self.login(user = @api_user, passwd = @api_passwd)
+    Croesus.post login_url,
+      { type: 'LoginRequest', username: user, password: passwd }
+  end
+
+  # Provides a wraper around getting the URL for the resource by using the
+  # resource_url shorthand.
+  #
+  # @return [URL] return the API URL for the given resource.
+  #
+  # @api public
+  [:session, :login, :environment, :alert, :database, :source].each do |name|
+    define_singleton_method(name.to_s + '_url') do
+      api_url( '/resources/json/delphix/' + name.to_s)
+    end
+  end
+
+  def self.validate(*args)
+    Base.validate(*args)
+  end
+
+  def self.optional(validation)
+    Validations::Optional.new(validation)
+  end
+
+  def self.many(validation)
+    Validations::Many.new(validation)
+  end
+
+  # @!visibility private
+  def self.to_s
+    "<#{self.class.name}:#{self.name}:#{object_id} @session=#{@session}>"
+  end
+  alias :inspect :to_s
+
+  # Hooks into the mixin process to add Croesus components to the given parent
+  # automatically.
+  #
+  # @param [Class] parent the object this is being mixed into
+  def self.included(parent)
+    parent.class_eval do
+      include InstanceMethods
+      extend  ClassMethods
+      "<#{self.class.name}:#{self.name}:#{object_id} @session=#{@session}>"
+    end
+  end
+  private_class_method :included
+
+  # From where forth do ye descend!
+  def descendants
+    ObjectSpace.each_object(::Class).select {|klass| klass < self }
+  end
+end