rxg_client 0.0.2 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 68761d8e4d49bbe48b4371ea2d9d3c70cd3aac75
-  data.tar.gz: b45bc993937e321af2f95061985e0b2ae6ad1f1f
+SHA256:
+  metadata.gz: b1701747767676c3880b62220730a35f0f8f44c7e5a6300219e677f51699498c
+  data.tar.gz: ef34d6aca636d4bde2a0874e7377d87ba8fe088d984fb0d0033d969bdae710e9
 SHA512:
-  metadata.gz: 0892a54598001398d715d0c066812fb322155dec90dc93f8530cd80f8b397316894e955c4e79cc814cbc4786e17736499a1d5f5277f1cda46daec97c1f78a7aa
-  data.tar.gz: 4713ef391b5f1f65c2cf386b6b0a243be0541793a4f7f53dfc38a02d5133b65c96be27df88af48cbda7f6ba4543f6a1376c9c3bc8cb267d1e63013bc73472a99
+  metadata.gz: ede8e416e727eb38cb3f7b330bcb6c78972196bad4034076d74889ccc78f5b3e68bc647baf0865125a128a32a0bc04cacca687aed8a9ad479be642c4e2672198
+  data.tar.gz: cb7242e69c10248b585456fc5cc9c464bd7d6e1abad06e78f9a5beae7ba1056123b6d5904c4ed9ecb73a24a558fd9d9733a4e65b472bb4ad19ddfae9e9b5312e

data/lib/rxg_client.rb

@@ -1,44 +1,127 @@
 class RxgClient
-  require 'delegate'
   require 'httparty'
 
   include HTTParty
 
-  attr_accessor :api_key, :hostname, :request_format, :raise_exceptions
+  attr_accessor :api_key, :hostname, :base_uri, :fleet, :request_format,
+    :raise_exceptions, :verify_ssl, :auth_method, :default_timeout, :debug_output
 
   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, options = { })
-    # Valid options:
-    # :request_format   => :json or :xml
-    # :default_timeout  => timeout in seconds
-    # :raise_exceptions => true or false
-    # :verify_ssl       => true or 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
+  #  - base_uri: provide an alternative base_uri, either a full URL or just the
+  #      path to append to the hostname.
+  #      default uses the admin/scaffolds context to access the traditional API
+  def initialize(hostname, api_key, request_format: :json, default_timeout: 5,
+    raise_exceptions: false, verify_ssl: false, fleet: false, debug_output: nil,
+    base_uri: 'admin/scaffolds', auth_method: :headers)
 
     self.api_key = api_key
-    
-    self.request_format = options[:request_format] ? options[:request_format].to_sym : :json
-    self.class.format self.request_format
 
     self.hostname = hostname
-    self.class.base_uri "https://#{self.hostname}/admin/scaffolds"
-    
-    self.class.default_timeout options[:timeout] || 5
 
-    self.raise_exceptions = options[:raise_exceptions] || false
+    self.set_base_uri(base_uri)
 
-    if defined?(options[:verify_ssl])
-      self.class.default_options.update(verify: options[:verify_ssl])
+    self.fleet = fleet
+
+    self.default_timeout = default_timeout
+
+    self.raise_exceptions = raise_exceptions
+
+    self.verify_ssl = verify_ssl
+
+    self.debug_output = debug_output
+
+    self.request_format = request_format.to_sym
+
+    self.auth_method = auth_method
+
+  end
+
+
+  # change the active base_uri
+  def set_base_uri(base_uri)
+    if base_uri =~ /^https?:\/\//
+      self.base_uri = base_uri
+    else
+      self.base_uri = "https://#{self.hostname}/#{base_uri.delete_prefix('/')}"
+    end
+  end
+
+  # temporarily change the base_uri for the duration of the provided block, then
+  # change it back to its previous value
+  def with_base_uri(new_base_uri, &blk)
+    if block_given?
+      begin
+        old_uri = self.base_uri
+
+        set_base_uri(new_base_uri)
+
+        blk.call
+      ensure
+        set_base_uri(old_uri)
+      end
+    end
+  end
+
+
+
+  def default_header
+    @headers ||= begin
+      h = { 'Accept' => "application/#{self.request_format}" }
+      if self.fleet
+        h['fleetkey'] = self.api_key
+      elsif self.auth_method == :headers # compatible with rXg version 11.442 or later
+        h['apikey'] = self.api_key
+      end
+      h
     end
   end
 
-  def auth
-    {api_key: self.api_key}
+  def default_query
+    case self.auth_method
+    when :query
+      { api_key: self.api_key }
+    when :headers
+      { }
+    end
   end
 
+  %i(post get put patch delete).each do |http_method|
+    define_method(http_method) do |action, **args|
+      action = "/#{action.to_s.delete_prefix('/')}"
+      default_args = {
+        :headers      => self.default_header.merge(args.delete(:headers) || {}),
+        :query        => self.default_query.merge(args.delete(:query) || {}).presence,
+        :base_uri     => self.base_uri,
+        :timeout      => self.default_timeout,
+        :format       => self.request_format,
+        :debug_output => self.debug_output
+      }
+      response = self.class.send(http_method, action, **default_args.merge(args))
+      response.success? ? self.parse(response.body) : raise(response.message)
+    end
+  end
+
+
   def parse(body)
     return {success: true} if body == ""
     begin
@@ -47,7 +130,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
 
@@ -69,32 +152,31 @@ 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.success? ? self.parse(response.body) : raise(response.message)
+    self.post("/#{table}/create", body: {record: new_record})
   end
-  
+
   # list all records from the given table
   def list(table)
-    response = self.class.get("/#{table}/index.#{self.request_format}", {body: self.auth})
-    response.success? ? self.parse(response.body) : raise(response.message)
+    self.get("/#{table}")
+  end
+
+  def search(table, search_params)
+    self.post("/#{table}/index", body: search_params)
   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.success? ? self.parse(response.body) : raise(response.message)
+    self.get("/#{table}/show/#{id}")
   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.success? ? self.parse(response.body) : raise(response.message)
+    self.post("/#{table}/update/#{id}", body: {record: updated_record_hash})
   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.success? ? self.parse(response.body) : raise(response.message)
+    self.post("/#{table}/destroy/#{id}")
   end
 
   def execute(table, request)
@@ -106,8 +188,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.success? ? self.parse(response.body) : raise(response.message)
+    self.post("/#{table}/execute", body: {request: request})
   end
 
   private
@@ -129,12 +210,11 @@ class RxgClient
   end
 
   # 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|
+  # the block will be executed.
+  rescue_from StandardError, :create, :list, :show, :update, :destroy, :execute, :search do |exception, instance|
     puts exception.message
 
     raise exception if instance.raise_exceptions
   end
 
-  
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rxg_client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.1.1
 platform: ruby
 authors:
 - Lannar Dean
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-17 00:00:00.000000000 Z
+date: 2020-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -25,14 +25,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.10.0
 description: A simple CRUDE (Create, Read, Update, Delete, Execute) client to interface
-  with the RXG's API
+  with the rXg's API
 email: ldd@rgnets.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/rxg_client.rb
-homepage: https://github.com/moracca/rxg_client
+homepage: https://github.com/rgnets/rxg_client
 licenses:
 - MIT
 metadata: {}
@@ -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