rxg_client 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 68761d8e4d49bbe48b4371ea2d9d3c70cd3aac75
+  data.tar.gz: b45bc993937e321af2f95061985e0b2ae6ad1f1f
+SHA512:
+  metadata.gz: 0892a54598001398d715d0c066812fb322155dec90dc93f8530cd80f8b397316894e955c4e79cc814cbc4786e17736499a1d5f5277f1cda46daec97c1f78a7aa
+  data.tar.gz: 4713ef391b5f1f65c2cf386b6b0a243be0541793a4f7f53dfc38a02d5133b65c96be27df88af48cbda7f6ba4543f6a1376c9c3bc8cb267d1e63013bc73472a99

data/lib/rxg_client.rb

@@ -0,0 +1,140 @@
+class RxgClient
+  require 'delegate'
+  require 'httparty'
+
+  include HTTParty
+
+  attr_accessor :api_key, :hostname, :request_format, :raise_exceptions
+
+  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
+
+    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
+
+    if defined?(options[:verify_ssl])
+      self.class.default_options.update(verify: options[:verify_ssl])
+    end
+  end
+
+  def auth
+    {api_key: self.api_key}
+  end
+
+  def parse(body)
+    return {success: true} if body == ""
+    begin
+      case self.request_format
+      when :json
+        result = JSON.parse(body)
+      when :xml
+        result = Hash.from_xml(body)
+      else 
+        raise "Request format should be one of: :json, :xml"
+      end
+
+      if result.is_a?(Array)
+        result = result.map do |hash|
+          # symbolize keys
+          hash.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+        end
+      elsif result.is_a?(Hash)
+        # symbolize keys
+        result = result.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+      end
+
+    rescue JSON::ParserError => e
+      return body
+    end
+
+  end
+
+  # 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)
+  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)
+  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)
+  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)
+  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)
+  end
+
+  def execute(table, request)
+    # executes an arbitrary method on given scaffold
+    # The "request" hash parameters:
+    #   record_name - The "name" attribute of the desired record, if any. Not required if calling a class method or if record_id is present.
+    #   record_id - The id of the desired record, if any. Not required if calling a class method or if record_name is present.
+    #   method_name - The name of the desired class or instance method to be run against the model.
+    #   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)
+  end
+
+  private
+
+  # define a unified exception handler for some methods
+  def self.rescue_from exception, *meths, &handler
+    meths.each do |meth|
+      # store the previous implementation
+      old = instance_method(meth)
+      # wrap it
+      define_method(meth) do |*args|
+        begin
+          old.bind(self).call(*args)
+        rescue exception => e
+          handler.call(e, self)
+        end
+      end
+    end
+  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|
+    puts exception.message
+
+    raise exception if instance.raise_exceptions
+  end
+
+  
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: rxg_client
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Lannar Dean
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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
+email: ldd@rgnets.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rxg_client.rb
+homepage: https://github.com/moracca/rxg_client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: RXG API Client
+test_files: []