delphix 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3efeefeb0545619a8b648c907e865d2d3cad5789
-  data.tar.gz: 4b1321d0433c79bcd69017f69db71fb0508e618a
+  metadata.gz: c2512981cc4075fb95b65652f26273053d430dbd
+  data.tar.gz: 499f97d8cb56b7a58ea1ae68cbf716a5ff97a4b8
 SHA512:
-  metadata.gz: 7399351d1b85fdfe51a57f105dfc97e0ffa1619e5325ff8ce9f4a3b623de6a4c910e464691535e82520e15252ac6fd2e01c95bb067b6fb3303e7f9658c50138e
-  data.tar.gz: 19b29624f8cafe6a51d34b3ba95120aa2ac63d5d1019d9a31431b54e911185ea2c38b8ae9b6578a60895ffea57b10d7c4a3a8c14644d0d9592eab94f02ac8679
+  metadata.gz: 8f6572b368ce8cc4aa68907361417e08e6cf16e82849b723dce1a056d3e252a3d751e35b0cbf65bd349bd2b78fbead4dd37609be469ce05adb992076a79009f3
+  data.tar.gz: 372545bd4756bd75d25a680552a58272f7ffb8d32161556ca68d4f3047e211cfe1c66493ad873281f05be47dd0194a079457b39513e2a37e50e9d6f4037e2998

data/lib/delphix.rb

@@ -20,9 +20,9 @@
 require 'rest-client'
 require 'hashie'
 require_relative 'delphix/utils'
-require_relative 'delphix/web_client'
-require_relative 'delphix/web_request'
-require_relative 'delphix/web_response'
+require_relative 'delphix/client'
+require_relative 'delphix/request'
+require_relative 'delphix/response'
 require_relative 'delphix/version'
 
 # A library for supporting connections to the Delphix API. The module Delphix
@@ -52,9 +52,8 @@ module Delphix
 
   API_ENDPOINT = '/resources/json/delphix'
   HTTP_HEADERS = {
-    'Accept'       =>  'application/json; charset=UTF-8',
     'Content-Type' =>  'application/json; charset=UTF-8',
-    'User-Agent'   =>  'Delphix-Ruby-Client/1.0.0'
+    'User-Agent'   =>  'Delphix-Ruby-Client/' + Delphix::VERSION
   }
 
   # Default timeout value in seconds.
@@ -77,9 +76,6 @@ module Delphix
     #   @return [#body] parsed response body
     #   @return [#raw_body] un-parsed response body
     attr_accessor :session
-    # @!attribute [rw] api_version
-    #   @return [Hash] containing the major, minor and micro version numbers.
-    attr_accessor :api_version
     # @!attribute [rw] server
     #   @return [String] Delphix server address
     attr_accessor :server
@@ -89,11 +85,33 @@ module Delphix
     # @!attribute [rw] api_passwd
     #   @return [String] password for authentication
     attr_accessor :api_passwd
-    # @!attribute [rw] verbose
-    #   @return [Nothing] enables verbosity
-    attr_accessor :verbose
   end
 
+  # Defines custom setter that takes a string, splits on the `.` and setting
+  # the major, minor and micro versions.
+  #
+  # @param [String] name
+  #   Name of the setter
+  #
+  # @param [String] version
+  #   The version number, i.e. '1.2.3'
+  #
+  # @return [undefined]
+  #
+  def self.version_accessor(name, version = nil)
+    define_singleton_method("#{name}=") do |version|
+      instance_variable_set("@#{name}",
+        [:major, :minor, :micro].zip(version.split('.')).inject({}) {
+          |r, i| r[i[0]] = i[1]; r
+        }.merge(type: 'APIVersion')
+      )
+    end
+  end
+
+  # @!attribute [rw] api_version
+  #   @return [Hash] containing the major, minor and micro version numbers.
+  self.version_accessor :api_version
+
   # Returns the API endpoint for a given resource namespace by combining the
   # server address with the appropriate HTTP headers.
   #
@@ -106,6 +124,11 @@ module Delphix
     'http://' + @server + resource
   end
 
+  # Initiate a session with the Delphix appliance, get our cookies for the
+  # duration of this exchange.
+  #
+  # @return [undefined]
+  #
   def self.session
     Delphix.default_header(:cookies, cookies)
     @session ||= login(@api_user, @api_passwd)

data/lib/delphix/{web_client.rb → client.rb}

@@ -18,9 +18,23 @@
 #
 
 module Delphix
-  class WebClient
+  class Client
+    include Delphix::Utils
+
+    # @param [Symnol] method
+    #   A valid HTTP verb `:get`, `:post`, or `:delete`.
+    #
+    # @param [String] url
+    #   The address or uri to send request.
+    #
+    # @param [String, Hash, Object] body
+    #   The request Body.
+    #
+    # @param [Proc] callback
+    #    Asychronous callback method to be invoked upon result.
+    #
     def self.request(method, url, headers, body, timeout, &callback)
-      request = Delphix::WebRequest.new(method, url, headers, body)
+      request = Delphix::Request.new(method, url, headers, body)
 
       if callback
         Thread.new do
@@ -67,12 +81,13 @@ module Delphix
         response = e.response
       end
 
-      Delphix::WebResponse.new(response)
+      Delphix::Response.new(response)
     end
   end
 
   # @param [String, Symbol] name
   #   A string or symbol used to identify the key portion of the HTTP headers.
+  #
   # @param [String, Symbol, Array] value
   #   A string, symbol or array containing the values of the HTTP header.
   #
@@ -99,66 +114,53 @@ module Delphix
     @@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.
+  # @!method 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.
+  #
+  #   @param [String] url, (address or uri) to send request.
+  #   @param [String, Hash, Object] body, the request body.
+  #   @param [Proc] callback, asychronous callback method, invoked upon result.
+  #
+  #   @return [Fixnum, #code] the response code from Delphix engine.
+  #   @return [Hash, #headers] The headers with keys as symbols.
+  #   @return [Hash, #body] body parsed response body where applicable.
+  #   @return [Hash, #raw_body] raw_body un-parsed response body.
+  #
+  # @!method 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.
+  #
+  #   @param [String] url, (address or uri) to send request.
+  #   @param [String, Hash, Object] body, the request body.
+  #   @param [Proc] callback, asychronous callback method, invoked upon result.
   #
-  # The following HTTP methods are supported by the Delphix Appliance:
+  #   @return [Fixnum, #code] the response code from Delphix engine.
+  #   @return [Hash, #headers] The headers with keys as symbols.
+  #   @return [Hash, #body] body parsed response body where applicable.
+  #   @return [Hash, #raw_body] raw_body un-parsed response body.
   #
-  #    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.
+  # @!method 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 [String] url, (address or uri) to send request.
+  #   @param [String, Hash, Object] body, the request body.
+  #   @param [Proc] callback, asychronous callback method, invoked upon result.
   #
-  # @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
+  #   @return [Fixnum, #code] the response code from Delphix engine.
+  #   @return [Hash, #headers] The headers with keys as symbols.
+  #   @return [Hash, #body] body parsed response body where applicable.
+  #   @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,
+      Client.request(method.to_sym, url, @@default_headers,
         parameters.to_json, @@timeout, &callback)
     end
   end
-
-  module InstanceMethods
-    private
-
-    # Returns the current api endpoint, if present.
-    #
-    # @return [nil, String] the current endpoint
-    def endpoint
-      nil
-    end
-  end
-
-  # @!classmethods
-  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/delphix/{web_request.rb → request.rb}

@@ -20,7 +20,7 @@
 require 'addressable/uri'
 
 module Delphix
-  class WebRequest
+  class Request
     include Delphix::Utils
 
     # @!attribute [r] method
@@ -49,17 +49,24 @@ module Delphix
       @headers[name] = value
     end
 
+    # @param [Symnol] method
+    #   A valid HTTP verb `GET`, `POST`, `PUT`, `PATCH` or `DELETE`.
+    #
+    # @param [String] url
+    #   Endpoint (address or uri) to send request.
+    #
+    # @param [String, Hash, Object] body
+    #   The request Body.
+    #
+    # @param [Proc] callback
+    #    Asychronous callback method to be invoked upon result.
+    #
     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
-
+      if method == :get
+        if body.respond_to?(:keys) && body.respond_to?(:[]) && body.length > 0
+          url += url.include?('?') ? '&' : '?'
           uri = Addressable::URI.new
           uri.query_values = body
           url += uri.query
@@ -68,24 +75,15 @@ module Delphix
         @body = body
       end
 
-      unless url =~ URI.regexp
-        raise 'Invalid URL: ' + url
+      if url =~ URI.regexp
+        @url = url.gsub(/\s+/, '%20')
+      else
+        raise "Invalid URL: #{url}"
       end
 
-      @url = url.gsub(/\s+/, '%20')
-
-      @headers = {
-        'Date'       => utc_httpdate,
-        'Request-ID' => request_id
-      }
-
+      @headers = { 'Date' => utc_httpdate, 'Request-ID' => request_id }
       headers.each_pair { |key, value| @headers[key.downcase] = value }
-
-      Delphix.last_request = {
-        headers: @headers,
-        method: @method,
-        url: @url
-      }
+      Delphix.last_request = { headers: @headers, method: @method, url: @url }
       begin
         Delphix.last_request[:body] = JSON.parse(@body) if body.length > 2
       rescue Exception

data/lib/delphix/{web_response.rb → response.rb}

@@ -20,7 +20,7 @@
 require 'json'
 
 module Delphix
-  class WebResponse
+  class Response
     # @!attribute [r] code
     #   The HTTP response code from Delphix engine.
     #   @return [#code]

data/lib/delphix/utils.rb

@@ -38,76 +38,3 @@ module Delphix
     end
   end
 end
-
-class Hash
-  # A hash is blank if it's empty:
-  #
-  # @example
-  #   {}.blank?                # => true
-  #   { key: 'value' }.blank?  # => false
-  #
-  # @api public
-  alias_method :blank?, :empty?
-
-  # 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 using the block operation.
-  #
-  # @example
-  #   hash = { name: 'Tigie', age: '15' }
-  #   hash.transform_keys{ |key| key.to_s.upcase }
-  #     # => { "AGE" => "15", "NAME" => "Tigie" }
-  #
-  # @return [Hash]
-  #
-  # @api public
-  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
-
-  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, val), result|
-        result[yield(key)] = _recursively_transform_keys_in_object(val, &block)
-      end
-    when Array
-      object.map { |e| _recursively_transform_keys_in_object(e, &block) }
-    else
-      object
-    end
-  end
-end

data/lib/delphix/version.rb

@@ -26,8 +26,8 @@ module Delphix
   # Contains information about this gem's version
   module Version
     MAJOR = 0
-    MINOR = 3
-    PATCH = 4
+    MINOR = 4
+    PATCH = 0
 
     # Returns a version string by joining MAJOR, MINOR, and PATCH with '.'
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delphix
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Stefano Harding
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-07 00:00:00.000000000 Z
+date: 2015-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hoodie
@@ -139,11 +139,11 @@ files:
 - Rakefile
 - delphix.gemspec
 - lib/delphix.rb
+- lib/delphix/client.rb
+- lib/delphix/request.rb
+- lib/delphix/response.rb
 - lib/delphix/utils.rb
 - lib/delphix/version.rb
-- lib/delphix/web_client.rb
-- lib/delphix/web_request.rb
-- lib/delphix/web_response.rb
 homepage: https://github.com/riddopic/delphix
 licenses:
 - Apache 2.0