croesus 0.1.3

data/lib/croesus/core_ext/blank.rb

@@ -0,0 +1,123 @@
+# 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.
+#
+
+# Add #blank? and #present? methods to Object class.
+class Object
+  # Returns true if the object is nil or empty (if applicable)
+  #
+  #   [].blank?         #=>  true
+  #   [1].blank?        #=>  false
+  #   [nil].blank?      #=>  false
+  #
+  # @return [TrueClass, FalseClass]
+  #
+  def blank?
+    nil? || (respond_to?(:empty?) && empty?)
+  end
+
+  # Returns true if the object is NOT nil or empty
+  #
+  #   [].present?         #=>  false
+  #   [1].present?        #=>  true
+  #   [nil].present?      #=>  true
+  #
+  # @return [TrueClass, FalseClass]
+  #
+  def present?
+    !blank?
+  end
+end # class Object
+
+# Add #blank? method to NilClass class.
+class NilClass
+  # Nil is always blank
+  #
+  #   nil.blank?        #=>  true
+  #
+  # @return [TrueClass]
+  #
+  def blank?
+    true
+  end
+end # class NilClass
+
+# Add #blank? method to TrueClass class.
+class TrueClass
+  # True is never blank.
+  #
+  #   true.blank?       #=>  false
+  #
+  # @return [FalseClass]
+  #
+  def blank?
+    false
+  end
+end # class TrueClass
+
+# Add #blank? method to FalseClass class.
+class FalseClass
+  # False is always blank.
+  #
+  #   false.blank?      #=>  true
+  #
+  # @return [TrueClass]
+  #
+  def blank?
+    true
+  end
+end # class FalseClass
+
+# Add #blank? method to Hash class.
+class Hash
+  # A hash is blank if it's empty:
+  #
+  #   {}.blank?                # => true
+  #   { key: 'value' }.blank?  # => false
+  alias_method :blank?, :empty?
+end
+
+# Add #blank? method to String class.
+class String
+  # Strips out whitespace then tests if the string is empty.
+  #
+  #   "".blank?         #=>  true
+  #   "     ".blank?    #=>  true
+  #   " hey ho ".blank? #=>  false
+  #
+  # @return [TrueClass, FalseClass]
+  #
+  def blank?
+    strip.empty?
+  end
+end # class String
+
+# Add #blank? method to Numeric class.
+class Numeric
+  # Numerics are never blank
+  #
+  #   0.blank?          #=>  false
+  #   1.blank?          #=>  false
+  #   6.54321.blank?    #=>  false
+  #
+  # @return [FalseClass]
+  #
+  def blank?
+    false
+  end
+end # class Numeric

data/lib/croesus/core_ext/hash.rb

@@ -0,0 +1,185 @@
+# 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.
+#
+
+class Hash
+  # Returns a compacted copy (contains no key/value pairs having
+  # nil? values)
+  #
+  # @example
+  #     hash = { a: 100, b: nil, c: false, d: '' }
+  #     hash.compact # => { a: 100, c: false, d: '' }
+  #     hash         # => { a: 100, b: nil, c: false, d: '' }
+  #
+  # @return [Hash]
+  #
+  def compact
+    select { |_, value| !value.nil? }
+  end
+
+  # Returns a new hash with all keys converted using the block operation.
+  #
+  # @example
+  #     hash = { name: 'Tiggy', age: '15' }
+  #
+  #     hash.transform_keys{ |key| key.to_s.upcase }
+  #                 # => { "AGE" => "15", "NAME" => "Tiggy" }
+  #
+  # @return [Hash]
+  #
+  def transform_keys
+    enum_for(:transform_keys) unless block_given?
+    result = self.class.new
+    each_key do |key|
+      result[yield(key)] = self[key]
+    end
+    result
+  end
+
+  # Returns a new hash, recursively converting all keys by the
+  # block operation.
+  #
+  # @return [Hash]
+  #
+  def recursively_transform_keys(&block)
+    _recursively_transform_keys_in_object(self, &block)
+  end
+
+  # Returns a new hash with all keys downcased and converted
+  # to symbols.
+  #
+  # @return [Hash]
+  #
+  def normalize_keys
+    transform_keys { |key| key.downcase.to_sym rescue key }
+  end
+
+  # Returns a new Hash, recursively downcasing and converting all
+  # keys to symbols.
+  #
+  # @return [Hash]
+  #
+  def recursively_normalize_keys
+    recursively_transform_keys { |key| key.downcase.to_sym rescue key }
+  end
+
+  # Returns a new hash with all keys converted to symbols.
+  #
+  # @return [Hash]
+  #
+  def symbolize_keys
+    transform_keys { |key| key.to_sym rescue key }
+  end
+
+  # Returns a new Hash, recursively converting all keys to symbols.
+  #
+  # @return [Hash]
+  #
+  def recursively_symbolize_keys
+    recursively_transform_keys { |key| key.to_sym rescue key }
+  end
+
+  # Returns a new hash with all keys converted to strings.
+  #
+  # @return [Hash]
+  #
+  def stringify_keys
+    transform_keys { |key| key.to_s rescue key }
+  end
+
+  # Returns a new Hash, recursively converting all keys to strings.
+  #
+  # @return [Hash]
+  #
+  def recursively_stringify_key
+    recursively_transform_keys { |key| key.to_s rescue key }
+  end
+
+  # Returns a new hash with all keys converted to strings and the
+  # first letter capitalized.
+  #
+  # @return [Hash]
+  #
+  def capitalize_keys
+    transform_keys { |key| key.Upcase.to_s.capitalize rescue key }
+  end
+
+  # Returns a new Hash, recursively converting all keys to strings
+  # and the first letter capitalized.
+  #
+  # @return [Hash]
+  #
+  def recursively_capitalize_key
+    recursively_transform_keys { |key| key.to_s.capitalize rescue key }
+  end
+
+  class UndefinedPathError < StandardError; end
+  # Recursively searchs a nested datastructure for a key and returns
+  # the value. If a block is provided its value will be returned if
+  # the key does not exist
+  #
+  # @example
+  #     options = { server: { location: { row: { rack: 34 } } } }
+  #     options.recursive_fetch :server, :location, :row, :rack
+  #                 # => 34
+  #     options.recursive_fetch(:non_existent_key) { 'default' }
+  #                 # => "default"
+  #
+  # @return [Hash, Array, String] value for key
+  #
+  def recursive_fetch(*args, &block)
+    args.reduce(self) do |obj, arg|
+      begin
+        arg = Integer(arg) if obj.is_a? Array
+        obj.fetch(arg)
+      rescue ArgumentError, IndexError, NoMethodError => e
+        break block.call(arg) if block
+        raise UndefinedPathError, "Could not fetch path (#{args.join(' > ')}) at #{arg}", e.backtrace
+      end
+    end
+  end
+
+  def recursive_merge(other)
+    hash = self.dup
+    other.each do |key, value|
+      myval = self[key]
+      if value.is_a?(Hash) && myval.is_a?(Hash)
+        hash[key] = myval.recursive_merge(value)
+      else
+        hash[key] = value
+      end
+    end
+    hash
+  end
+
+  private #   P R O P R I E T À   P R I V A T A   divieto di accesso
+
+  # support methods for recursively transforming nested hashes and arrays
+  def _recursively_transform_keys_in_object(object, &block)
+    case object
+    when Hash
+      object.each_with_object({}) do |(key, value), result|
+        result[yield(key)] = _recursively_transform_keys_in_object(value, &block)
+      end
+    when Array
+      object.map { |e| _recursively_transform_keys_in_object(e, &block) }
+    else
+      object
+    end
+  end
+end

data/lib/croesus/dsl/dsl.rb

@@ -0,0 +1,35 @@
+# 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 DSL
+    def self.evaluate(&block)
+      raise 'You need a block to build!' unless block_given?
+      DSL.new(&block)
+    end
+
+    def initialize(&block)
+      instance_eval(&block)
+    end
+
+    def resource(resource_name, &block)
+      Croesus::ResourceDSL.new(resource_name, &block)
+    end
+  end
+end

data/lib/croesus/dsl/helpers.rb

@@ -0,0 +1,43 @@
+# 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::DSLHelpers
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+  private_class_method :included
+
+  module ClassMethods
+    def setter(*method_names)
+      method_names.each do |name|
+        send :define_method, name do |data|
+          instance_variable_set "@#{name}".to_sym, data
+        end
+      end
+    end
+
+    def varags_setter(*method_names)
+      method_names.each do |name|
+        send :define_method, name do |*data|
+          instance_variable_set "@#{name}".to_sym, data
+        end
+      end
+    end
+  end
+end

data/lib/croesus/dsl/mod_factory.rb

@@ -0,0 +1,191 @@
+# 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.
+#
+
+# Registry for anonymous methods, not so anonymous now are you!
+#
+module Croesus::AnonoMod
+
+  @registry = {}
+
+  def self.registry
+    @registry
+  end
+
+  def self.register(resource_name, mod)
+    registry[resource_name] = mod
+  end
+end
+
+# Mysteries abound, dynamic box of factory creation for API resources.
+#
+module Croesus::ModFactory
+  include Croesus::Utils
+
+  def initialize(name, mod = Module.new)
+    @mod = mod
+    @name = name
+    Croesus::AnonoMod.register(name, @mod)
+    assemble_module
+    @mod
+  end
+
+  # Sets the description the Delphix Resource.
+  #
+  # @param [String] description
+  #   the description of the API resource
+  #
+  # @return [Nil]
+  #
+  # @api public
+  def add_description(description)
+    @mod.instance_variable_set(:@description, description)
+    @mod.define_singleton_method(:description) { @description }
+  end
+
+  # Sets the root endpoint for the resource.
+  #
+  # @param [String] root
+  #   the root endpoint for the resource
+  #
+  # @return [Nil]
+  #
+  # @api public
+  def add_root_endpoint(root)
+    @mod.instance_variable_set(:@root, root)
+    @mod.define_singleton_method(:root) { @root }
+  end
+
+  def add_method(dsl_object)
+    raw = dsl_object.to_hash
+    name = raw[:name]
+    verb = raw[:verb]
+    @mod.methods[name] = raw[:description]
+    @mod.singleton_class.send(:alias_method, name, "api_#{verb.downcase}")
+    define_help
+  end
+
+  private #   P R O P R I E T À   P R I V A T A   Vietato L'accesso
+
+  # Internal: Define methods to handle a verb.
+  #
+  # verbs - A list of verbs to define methods for.
+  #
+  # Examples
+  #
+  #   define_verbs :get, :post
+  #
+  # Returns nil.
+  def define_verbs(*verbs)
+    verbs.each do |verb|
+      define_verb(verb)
+      define_api_verb(verb)
+    end
+  end
+
+  # Internal: Defines a method to handle HTTP requests with the passed in
+  # verb.
+  #
+  # verb - Symbol name of the verb (e.g. :get).
+  #
+  # Examples
+  #
+  #   define_verb :get
+  #   # => get 'http://server.xyz/path'
+  #
+  # Returns nil.
+  def define_verb(verb)
+    @mod.define_singleton_method(verb.to_sym) do |*args, &block|
+      class_eval "Croesus.#{verb}"
+    end
+  end
+
+  # Internal: Defines a method to handle HTTP requests with the passed in
+  # verb to a api endpoint.
+  #
+  # verb - Symbol name of the verb (e.g. :get).
+  #
+  # Examples
+  #
+  #   define_api_verb :get
+  #   # => api_get '/resources/json/delphix/environment'
+  #
+  # Returns nil.
+  def define_api_verb(verb)
+    @mod.define_singleton_method("api_#{verb}") do |*args, &block|
+      class_eval "Croesus.#{verb}(url(*args)).body"
+    end
+  end
+
+  def define_help
+    @mod.define_singleton_method :help do
+      puts
+      dyno_width = terminal_dimensions[0] - 32
+      header title: "Available commands for #{@delphix_object}",
+        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 'Method Name', width: 18, align: 'left', padding: 0
+          column "Description (http://#{Croesus.server}/api/#" \
+            "#{@delphix_object.downcase})",
+            width: dyno_width, align: 'left', padding: 0
+        end
+        (@methods.keys).sort.each.with_index(1) do |method, i|
+          row do
+            column '%02d' % i
+            column method
+            column @methods[method.to_sym]
+          end
+        end
+      end
+      puts @description
+    end
+  end
+
+  def assemble_module
+    add_included_hook
+    add_instance_variables
+    be_polite_and_debuggable
+    define_verbs('get', 'post', 'delete')
+  end
+
+  def add_included_hook
+    @mod.send :include, Croesus::BasicMethods
+    @mod.send :include, CommandLineReporter
+    @mod.send :include, Croesus::Utils
+  end
+
+  def add_instance_variables
+    @mod.instance_variable_set(:@delphix_object, classify(@name))
+    @mod.define_singleton_method(:delphix_object) { @delphix_object }
+
+    @mod.instance_variable_set(:@methods, {})
+    @mod.define_singleton_method(:methods) { @methods }
+  end
+
+  def be_polite_and_debuggable
+    @mod.define_singleton_method :to_s do
+      "<#{self.class.name}:#{self.name}:#{object_id}>"
+    end
+
+    @mod.define_singleton_method :inspect do
+      "<#{self.class.name}:#{self.name}:#{object_id} #{instance_variables}>"
+    end
+  end
+end

data/lib/croesus/dsl/resource_dsl.rb

@@ -0,0 +1,59 @@
+# 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 ResourceDSL
+    include Croesus::DSLHelpers
+    include Croesus::ModFactory
+
+    setter :description, :root
+    varags_setter
+
+    def initialize(name, &block)
+      Croesus::ModFactory.instance_method(:initialize).bind(self).call(name)
+      instance_eval(&block)
+      @description ||= description
+      @root ||= root
+      add_description(@description)
+      add_root_endpoint(@root)
+    end
+
+    # 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.
+    def get(path,     &block) route 'GET',     path, &block end
+    def post(path,    &block) route 'POST',    path, &block end
+    def delete(path,  &block) route 'DELETE',  path, &block end
+
+    def route(verb, path, &block)
+      add_method(Croesus::RouteDSL.new(verb, path, &block))
+    end
+  end
+end

data/lib/croesus/dsl/route_dsl.rb

@@ -0,0 +1,42 @@
+# 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 RouteDSL
+    include Croesus::DSLHelpers
+
+    setter :name, :verb, :path, :description, :input, :returns
+    varags_setter
+
+    def initialize(verb, path, &block)
+      instance_eval(&block)
+      @name        ||= name
+      @verb          = verb
+      @path          = path
+      @input       ||= nil
+      @returns     ||= nil
+      @description ||= description
+    end
+
+    def to_hash
+      { name: @name, verb: @verb, path: @path, input: @input,
+        returns: @returns, description: @description }
+    end
+  end
+end