invoracle 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b48f47f224c20458725773006013f46277f82d10
+  data.tar.gz: ac8fe16cb61a9c23afbc6bd4f6d49e6cb047860d
+SHA512:
+  metadata.gz: 954723ecc43678077287d44e3075b7bbdfc6af09407c1973040e9d741337b50ce9c0d8b715fd9f5e689b502b7698daa7a1a13abd2283d67061b90e591d147a89
+  data.tar.gz: f194155279830e9fb96cc17de425211df97cecac5a4735de3349ab74f222d48f79bcf9c2c46767a76adfb57aef2cb06b3b5353ae59426e5bad3fac627e539098

data/CHANGELOG

@@ -0,0 +1,3 @@
+= 0.0.1
+- Initial release
+- JsonDoc subclass for Invoracle::System

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014 John Wang
+ 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,84 @@
+= Invoracle
+
+Invoracle (short for Inventory Oracle), is the basis of a flexible inventory reporting system that can be used to build custom reports for managing large numbers of computer systems. It is designed to provide a basis of reporting for thousands of systems using a generic, extensible JSON schema.
+
+The Invoracle::System class is a subclass of the JsonDoc Ruby gem and adds a default JSON schema for computer systems to the functionality available in JsonDoc. It can be used as is or it can be further subclassed to add additional custom attributes.
+
+Primary use cases include use as a core document object that various parsers can leverage to populate a strict schema JSON document and to build reporting systems such as CSV/Excel reports.
+
+== Installation
+
+=== Gem Installation
+
+Download and install invoracle with the following:
+
+  gem install invoracle
+
+== Usage
+
+  require 'invoracle'
+
+  system = Invoracle::System.new()
+
+  schema = generic_system.dSchema
+
+  system.setAttr(:sSysFqdn, system_fqdn)
+
+  system_fqdn = system.getAttr(:sSysFqdn)
+  system_hash = system.asHash
+  system_json = system.asJson
+
+== Notes
+
+=== Default Schema
+
+To view the default schema, you can use pretty print the default schema using the dSchema accessor. The default schema uses Hungarian CamelCase (HCC) names which are described below. These names are still in development so please provide feedback.
+
+=== Schema Property Formats
+
+The default properties, which can be overridden, use a short form of "Hungarian CamelCase" where properties are prefixed with type abbreviations including ['a','d','f','i','j','s','x'] for:
+
+a = array
+d = dictionary / hash
+f = float / number
+h = html / string
+i = integer / number
+j = JSON / string
+s = string
+x = XML / string
+
+=== Subclassing
+
+To subclass this module, override the getDefaultSchema() method and add your own schema. To add a schema on to the default schema see the Usage section above.
+
+=== Schema Validation
+
+Schema validation is not provided in this version.
+
+== Links
+
+JSON
+
+http://www.json.org/
+
+JSON Schema
+
+http://json-schema.org/
+
+== Problems, Comments, Suggestions?
+
+All of the above are most welcome. mailto:johncwang@gmail.com
+
+== Credits
+
+John Wang - http://johnwang.com
+
+== License
+
+JsonDoc is available under an MIT-style license.
+
+:include: MIT-LICENSE 
+
+== Warranty
+
+This software is provided "as is" and without any express or implied warranties, including, without limitation, the implied warranties of merchantibility and fitness for a particular purpose.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the JsonDoc library.'
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/test_*.rb'
+  t.verbose = false
+end
+
+desc 'Generate RDoc documentation.'
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'jsondoc'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/invoracle.rb

@@ -0,0 +1,3 @@
+module Invoracle
+  autoload :System, 'invoracle/system'
+end

data/lib/invoracle/cluster.rb

@@ -0,0 +1,47 @@
+require 'invoracle/system'
+
+module Invoracle
+  class Cluster
+    attr_accessor :sCluUid
+    attr_accessor :dSystems
+
+    def initialize(sCluUid='')
+      @sCluUid  = sCluUid || ''
+      @dSystems = {}
+    end
+
+    def setSystem(oSystem=nil)
+      if ! oSystem.nil? && oSystem.is_a?( Invoracle::System )
+        sSysUid = oSystem.getAttr(:sSysUid)
+        if sSysUid.nil? || ! sSysUid
+          raise ArgumentError, "E_NO_SYSTEM_UID"
+        end
+        @dSystems[sSysUid] = oSystem
+      end
+    end
+
+    def getSystem(sSysUid=nil)
+      if ! sSysUid.nil? && sSysUid && @dSystems.has_key?( sSysUid )
+        return @dSystems[ sSysUid ]
+      end
+      return nil
+    end
+
+    def getOrCreateSystem(sSysUid=nil)
+      if ! sSysUid.nil? && sSysUid && @dSystems.has_key?( sSysUid )
+        return @dSystems[ sSysUid ]
+      end
+      oSystem = Invoracle::System.new()
+      oSystem.setAttr(:sSysUid,sSysUid)
+      return oSystem
+    end
+
+    def getOneSystem()
+      oSystem = nil
+      @dSystems.each do |sSysUid,oSystemThis|
+      	oSystem = oSystemThis
+      end
+      return oSystem
+    end
+  end
+end

data/lib/invoracle/system.rb

@@ -0,0 +1,80 @@
+require 'jsondoc'
+
+module Invoracle
+  class System < JsonDoc::Document
+    attr_accessor :dSchema
+    def initialize(dSchema=nil,bDefaultifyDoc=true,bIsStrict=true)
+      @dSchema        = dSchema || self.getDefaultSchema()
+      @bDefaultifyDoc = bDefaultifyDoc ? true : false
+      @bIsStrict      = bIsStrict      ? true : false
+      @dDocument      = self.getDefaultDocument()
+    end
+
+    def getDefaultSchema()
+      dSchema       =  {
+        :type       => 'system',
+        :properties => {
+          :sCluUid             => { :default => '', :type => 'string', :description => 'Cluster UID' },
+
+          :sSysUid             => { :default => '', :type => 'string', :description => 'System UID'  },
+          :sSysFqdn            => { :default => '', :type => 'string', :description => 'FQDN' },
+          :sSysIpAddress       => { :default => '', :type => 'string', :description => 'IP'   },
+
+          :aSysRoles           => { :default => [], :type => 'array' , :description => 'Roles' },
+          :dSysRoles           => { :default => {}, :type => 'object', :description => 'Roles' },
+          :sSysRoles           => { :default => '', :type => 'string', :description => 'Roles' },
+
+          :sDcUid              => { :default => '', :type => 'string', :description => 'DC'   },
+          :sDcCageCode         => { :default => '', :type => 'string', :description => 'Cage' },
+          :sDcRackCode         => { :default => '', :type => 'string', :description => 'Rack' },
+
+          :sMfgName            => { :default => '', :type => 'string', :description => 'Mfg Name'    },
+          :sMfgProductName     => { :default => '', :type => 'string', :description => 'Mfg Product' },
+
+          :sBiosVersion        => { :default => '', :type => 'string', :description => 'Bios' },
+
+          :sCpuModelName       => { :default => '', :type => 'string', :description => 'CPU Model' },
+          :iCpuMhz             => { :default => -1, :type => 'number', :description => 'CPU MHz'   },
+          :iCpuCount           => { :default => -1, :type => 'number', :description => 'CPU Count' },
+          :iCpuCoresCount      => { :default => -1, :type => 'number', :description => 'CPU Cores' },
+          :fCpuIdleAvg         => { :default => -1, :type => 'number', :description => 'CPU Idle'  },
+
+          :iDiskUsedKb         => { :default => -1, :type => 'number', :description => 'Dsk KB Used'  },
+          :fDiskUsedGb         => { :default => -1, :type => 'number', :description => 'Dsk GB Used'  },
+          :fDiskAvailableGb    => { :default => -1, :type => 'number', :description => 'Dsk GB Avail' },
+          :fDiskTotalGb        => { :default => -1, :type => 'number', :description => 'Dsk GB Total' },
+          :fDiskUtilMax        => { :default => -1, :type => 'number', :description => 'Dsk Util Max' },
+
+          :iIpmHasIpm          => { :default => -1, :type => 'number', :description => 'IPM Present' },
+          :sIpmType            => { :default => '', :type => 'string', :description => 'IPM Type'    },
+          :sIpmVersion         => { :default => '', :type => 'string', :description => 'IPM Version' },
+          :sIpmIpAddress       => { :default => '', :type => 'string', :description => 'IPM IP'      },
+          :sIpmMacAddress      => { :default => '', :type => 'string', :description => 'IPM MAC'     },
+
+          :sNetMacAddress      => { :default => '', :type => 'string', :description => 'MAC' },
+
+          :sOsName             => { :default => '', :type => 'string', :description => 'OS' },
+          :sOsVersion          => { :default => '', :type => 'string', :description => 'OS Version' },
+          :sOsKernelRelease    => { :default => '', :type => 'string', :description => 'OS Kernel'  },
+
+          :sRaidControllerName => { :default => '', :type => 'string', :description => 'RAID Controler'  },
+          :iRaidDrivesNumAll   => { :default => -1, :type => 'number', :description => 'RAID Drives All' },
+          :iRaidDrivesNumBad   => { :default => -1, :type => 'number', :description => 'RAID Drives Bad' },
+
+          :sVirType            => { :default => '', :type => 'string', :description => 'VM Type' },
+          :sVirHostFqdn        => { :default => '', :type => 'string', :description => 'VM Host FQDN' },
+          :iVirHostFqdnDiff    => { :default => -1, :type => 'number', :description => 'VM Host FQDN Diff' },
+          :iVirHostIsVmware    => { :default => -1, :type => 'number', :description => 'Is VMWare' },
+          :iVirHostIsKvm       => { :default => -1, :type => 'number', :description => 'Is KVM'    },
+          :iVirIsGuest         => { :default => -1, :type => 'number', :description => 'Is Guest'  },
+          :iVirIsHost          => { :default => -1, :type => 'number', :description => 'Is Host'   },
+          :sVirVmwareSwInfo    => { :default => '', :type => 'string', :description => 'VMware Info'  },
+
+          :sXDellSvcTag        => { :default => '', :type => 'string', :description => 'Svc Tag'  },
+          :sXSfIdAct           => { :default => '', :type => 'string', :description => 'SFID'     },
+        }
+      }
+      return dSchema
+    end
+  end
+end

data/test/test_setup.rb

@@ -0,0 +1,14 @@
+require 'test/unit'
+require 'invoracle'
+
+class InvoracleSystemTest < Test::Unit::TestCase
+  def testSetup
+
+    oSystem = Invoracle::System.new(nil,true,true)
+
+    oSystem.setAttr(:sSysFqdn,'demo.example.com')
+
+    assert_equal 'demo.example.com', oSystem.getAttr(:sSysFqdn)
+
+  end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: invoracle
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Wang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-01 00:00:00.000000000 Z
+dependencies: []
+description: A simple generic inventory system for managing computer systems.
+email: john@johnwang.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/invoracle.rb
+- lib/invoracle/cluster.rb
+- lib/invoracle/system.rb
+- test/test_setup.rb
+homepage: http://johnwang.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Inventory Oracle - inventory management system
+test_files: []