rxg_client 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e7faddbac99675ec4042eb40ac013e70aa005c98
-  data.tar.gz: 36edf972b42b8012e37b6dc04b828952bbe1e074
+SHA256:
+  metadata.gz: aa8f8c7ab1ddb93d7980df022f69b4c27724b8a7bad078077f266dd8e8988da4
+  data.tar.gz: 20cb8f51c71a2e8064ef238272b42531111f89e6a385cca9da485aefde080375
 SHA512:
-  metadata.gz: b1626b8e2375bb84512059f249caaf7bd3b386be98c18f69ca49378b43a2ebc7aeaae4cfd2d2f092e108a734e74554ac2d2cb9ad3dbdd29707b08efbb14ee8f7
-  data.tar.gz: be0004f6d585196a0f6d61e99001f79cdb020114130b581ccd786f622bcc97396222e59bd5d944d6bfd3d047cbc22124dcf3cfdddce508c8ff59de14fe7edffc
+  metadata.gz: a73d0b3014384505a07678155f7a34d4649531957bf7ff22014dab0227e6b800715e21c5d54b96c5c4500fcd0a5141ffd4d2f37b53c77e2e8c4bb0a84659a49e
+  data.tar.gz: fe53a906dd991b1a5347e0bf7a2c5412e6728449dc1a99d7a0797b37bf538262340f05ec5aa3e8943cc8bb7aa553b1d2f1b3d9d20aac15d34f174c0789ab4830

data/lib/rxg_client.rb

@@ -1,35 +1,65 @@
 class RxgClient
-  require 'delegate'
   require 'httparty'
 
   include HTTParty
 
-  attr_accessor :api_key, :hostname, :request_format, :raise_exceptions
+  attr_accessor :api_key, :hostname, :request_format, :raise_exceptions, :auth
 
   def request_format= (requested_format)
     raise HTTParty::UnsupportedFormat unless [ :json, :xml ].include?(requested_format.to_sym)
     @request_format = requested_format
   end
 
-  def initialize(hostname, api_key, request_format: :json, default_timeout: 5, raise_exceptions: false, verify_ssl: false)
+  # The following options can be configured when initializing the client:
+  #  - default_timeout: the amount of time in seconds to wait for a response.
+  #      default is 5
+  #  - raise_exceptions: true or false.
+  #      default is true
+  #  - verify_ssl: true or false.
+  #      default is true
+  #      If using an IP, must be false.
+  #  - fleet: pass true if authentication should use the 'fleetkey' header
+  #      instead of apikey.
+  #      default is false
+  #  - auth_method: must be one of: :headers, :query
+  #      default is :headers
+  #      If fleet is true, headers will always be used
+  #  - debug: pass a logger or $stdout to have debug_output logged, or nil to disable.
+  #      default is nil
+  def initialize(hostname, api_key, request_format: :json, default_timeout: 5,
+    raise_exceptions: false, verify_ssl: false, fleet: false, debug: nil,
+    auth_method: :headers)
 
     self.api_key = api_key
-    
+
     self.request_format = request_format.to_sym
     self.class.format self.request_format
 
     self.hostname = hostname
     self.class.base_uri "https://#{self.hostname}/admin/scaffolds"
-    
+
     self.class.default_timeout default_timeout
 
     self.raise_exceptions = raise_exceptions
 
     self.class.default_options.update(verify: verify_ssl)
-  end
 
-  def auth
-    {api_key: self.api_key}
+    self.class.debug_output debug
+
+    case auth_method
+    when :headers # compatible with rXg version 11.442 or later
+      if fleet
+        self.class.headers { 'fleetkey' => self.api_key }
+      else
+        self.class.headers { 'api_key' => self.api_key }
+      end
+    when :query
+      if fleet
+        self.class.headers { 'fleetkey' => self.api_key }
+      else
+        self.class.default_params { 'api_key' => self.api_key }
+      end
+    end
   end
 
   def parse(body)
@@ -40,7 +70,7 @@ class RxgClient
         result = JSON.parse(body)
       when :xml
         result = Hash.from_xml(body)
-      else 
+      else
         raise "Request format should be one of: :json, :xml"
       end
 
@@ -62,31 +92,36 @@ class RxgClient
 
   # create a record in the given table with the attributes provided in new_record
   def create(table, new_record)
-    response = self.class.post("/#{table}/create/index.#{self.request_format}", { body: {record: new_record}.merge(self.auth) })
+    response = self.class.post("/#{table}/create/index.#{self.request_format}", body: {record: new_record})
     response.success? ? self.parse(response.body) : raise(response.message)
   end
-  
+
   # list all records from the given table
   def list(table)
-    response = self.class.get("/#{table}/index.#{self.request_format}", {body: self.auth})
+    response = self.class.get("/#{table}/index.#{self.request_format}")
+    response.success? ? self.parse(response.body) : raise(response.message)
+  end
+
+  def search(table, search_params)
+    response = self.class.post("/#{table}/index.#{self.request_format}", body: search_params)
     response.success? ? self.parse(response.body) : raise(response.message)
   end
 
   # return the record from the given table having the given id
   def show(table, id)
-    response = self.class.get("/#{table}/show/#{id}.#{self.request_format}", {body: self.auth})
+    response = self.class.get("/#{table}/show/#{id}.#{self.request_format}")
     response.success? ? self.parse(response.body) : raise(response.message)
   end
 
   # update a record from the given table, having the given id, with the updated attributes provided in updated_record_hash
   def update(table, id, updated_record_hash)
-    response = self.class.post("/#{table}/update/#{id}.#{self.request_format}", {body: {record: updated_record_hash}.merge(self.auth)})
+    response = self.class.post("/#{table}/update/#{id}.#{self.request_format}", body: {record: updated_record_hash})
     response.success? ? self.parse(response.body) : raise(response.message)
   end
 
   # destroy a record from the given table having the given id
   def destroy(table, id)
-    response = self.class.post("/#{table}/destroy/#{id}.#{self.request_format}", {body: self.auth})
+    response = self.class.post("/#{table}/destroy/#{id}.#{self.request_format}")
     response.success? ? self.parse(response.body) : raise(response.message)
   end
 
@@ -99,7 +134,7 @@ class RxgClient
     #   method_args - A serialized Array or Hash of the argument(s) expected by the method.
     # example method call:
     #   node.execute("shared_credential_groups", {record_id: 7, method_name: "make_login_session", method_args:["192.168.20.111", "00:00:00:00:00:05", "test", 1]})
-    response = self.class.post("/#{table}/execute.#{self.request_format}", {query: self.auth, body: {request: request}})
+    response = self.class.post("/#{table}/execute.#{self.request_format}", body: {request: request})
     response.success? ? self.parse(response.body) : raise(response.message)
   end
 
@@ -123,7 +158,7 @@ class RxgClient
 
   # The listed methods will be rescued from all StandardError exceptions, and the code within
   # the block will be executed.  
-  rescue_from StandardError, :create, :list, :show, :update, :destroy, :execute do |exception, instance|
+  rescue_from StandardError, :create, :list, :show, :update, :destroy, :execute, :search do |exception, instance|
     puts exception.message
 
     raise exception if instance.raise_exceptions

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rxg_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Lannar Dean
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-18 00:00:00.000000000 Z
+date: 2020-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -51,8 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: RXG API Client