xclarity_client 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8d0229ded440c49c74f1d9c49aeacd576fd4fdf
-  data.tar.gz: 6f45928c7b0d1062589ac258f1f50bd630d25886
+  metadata.gz: 714241cc9417ae4ab27aab39a98b1b1618f154fc
+  data.tar.gz: a73d88ab737024ee116444c4927ba503e7c427e0
 SHA512:
-  metadata.gz: 05cc0ad9dca0c17e7455f7413ad5627c87f77a1caf7219caebf486c781353e03602276706a42531a81a6d185f622d9cef7702f6f066e5deea7139c6cca267aca
-  data.tar.gz: 7dd67d6bfd62e8ab7a12e52f3e868970eb15be68873ba56e6a33810586c175bc472e5a4b2654fc9769e36bc190a3139c6cacbcafd5d84060033373c57cbcf28d
+  metadata.gz: 40844b7e6df453eb351141f13ca950becdafa967807524c03df999b2cdda2fd8c9ee03b48f92434765a002ee8a761ac1bcf2d47c5b011ac1b791f01024981b4d
+  data.tar.gz: 6db55eecaaf8a2d5764df2da2b1b58e7d5d8937445115803efb29274752035f49927dd58a99621726a9d4e92c122272f23ec27295b351f3dcc2a5d3b582b55b3

data/.codeclimate.yml

@@ -0,0 +1,41 @@
+---
+exclude_paths:
+- ".git/"
+- "**.gif"
+- "**.html"
+- "**.json"
+- "**.png"
+- "**.svg"
+- "**.xml"
+- "**.yaml"
+- "**.yml"
+- "bin/"
+- "coverage/"
+- "spec/"
+engines:
+  brakeman:
+    enabled: false
+  bundler-audit:
+    enabled: false
+  csslint:
+    enabled: false
+  duplication:
+    enabled: true
+    config:
+      concurrency: 1
+      languages:
+      - ruby
+  eslint:
+    enabled: false
+  fixme:
+    enabled: false
+  markdownlint:
+    enabled: false
+  rubocop:
+    enabled: true
+    config: '.rubocop_cc.yml'
+ratings:
+  paths:
+  - Gemfile.lock
+  - "**.rake"
+  - "**.rb"

data/.rubocop_base.yml

@@ -0,0 +1,211 @@
+AllCops:
+  TargetRubyVersion: 2.3
+Layout/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+Layout/ExtraSpacing:
+  AutoCorrect: true
+Layout/SpaceBeforeFirstArg:
+  Enabled: false
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+Lint/DefEndAlignment:
+  AutoCorrect: true
+Lint/EndAlignment:
+  AutoCorrect: true
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/BlockNesting:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: true
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: true
+Metrics/MethodLength:
+  Enabled: true
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: true
+Metrics/PerceivedComplexity:
+  Enabled: false
+Performance/Casecmp:
+  Enabled: true
+Rails:
+  Enabled: true
+Rails/FindEach:
+  Enabled: false
+Rails/ReadWriteAttribute:
+  AutoCorrect: false
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/ClassCheck:
+  EnforcedStyle: kind_of?
+Style/CollectionMethods:
+  PreferredMethods:
+    find: detect
+    find_all: select
+    map: collect
+    reduce: inject
+Style/Documentation:
+  Enabled: true
+Style/DoubleNegation:
+  Enabled: true
+Style/EmptyMethod:
+  Enabled: true
+Style/Encoding:
+  Enabled: false
+Style/FormatString:
+  EnforcedStyle: percent
+Style/FormatStringToken:
+  EnforcedStyle: template
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/GuardClause:
+  Enabled: true
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+Style/IfUnlessModifier:
+  Enabled: true
+Style/MethodCallWithArgsParentheses:
+  Exclude:
+    - Gemfile
+    - spec/**/*
+  Enabled: true
+  IgnoredMethods:
+    # Ruby
+    - alias_method
+    - attr_accessor
+    - attr_reader
+    - attr_writer
+    - exit
+    - extend
+    - gem
+    - include
+    - load
+    - module_function
+    - pp
+    - prepend
+    - print
+    - private
+    - private_class_method
+    - private_constant
+    - puts
+    - raise
+    - require
+    - sleep
+    - throw
+    - yield
+    # Rails
+    - accepts_nested_attributes_for
+    - add_column
+    - add_index
+    - after_action
+    - after_commit
+    - after_create
+    - after_create_commit
+    - after_destroy
+    - after_destroy
+    - after_destroy_commit
+    - after_initialize
+    - after_save
+    - after_save
+    - after_update
+    - after_update_commit
+    - alias_attribute
+    - around_destroy
+    - autoload
+    - before_action
+    - before_create
+    - before_destroy
+    - before_save
+    - before_update
+    - before_validation
+    - belongs_to
+    - bigint
+    - boolean
+    - cattr_accessor
+    - cattr_reader
+    - cattr_writer
+    - change_column
+    - class_attribute
+    - create_table
+    - datetime
+    - decimal
+    - delegate
+    - drop_table
+    - has_and_belongs_to_many
+    - has_many
+    - has_one
+    - head
+    - identified_by
+    - integer
+    - mattr_accessor
+    - remove_column
+    - remove_index
+    - rename_column
+    - render
+    - require_dependency
+    - require_relative
+    - respond_to
+    - scope
+    - serialize
+    - skip_before_action
+    - string
+    - text
+    - validate
+    - validates
+    # Rake
+    - desc
+    - task
+Style/NumericLiterals:
+  AutoCorrect: false
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%i': ()
+    '%I': ()
+    '%w': ()
+    '%W': ()
+Style/PerlBackrefs:
+  Enabled: false
+Style/ParallelAssignment:
+  Enabled: false
+Style/RedundantReturn:
+  AllowMultipleReturnValues: true
+Style/RegexpLiteral:
+  Enabled: false
+Style/RescueModifier:
+  AutoCorrect: false
+Style/SignalException:
+  EnforcedStyle: only_raise
+Style/SingleLineBlockParams:
+  Enabled: false
+Style/SingleLineMethods:
+  AllowIfMethodIsEmpty: false
+Style/GlobalVars:
+  AllowedVariables:
+    - $lxca_log
+Style/SpecialGlobalVars:
+  AutoCorrect: false
+Style/StringLiterals:
+  Enabled: true
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+Style/TrailingCommaInArguments:
+  Enabled: false
+Style/TrailingCommaInLiteral:
+  Enabled: false
+Style/TrailingUnderscoreVariable:
+  Enabled: false
+Style/TrivialAccessors:
+  AllowPredicates: true
+Style/WhileUntilModifier:
+  Enabled: true
+Style/WordArray:
+  AutoCorrect: true

data/.rubocop_cc.yml

@@ -0,0 +1,2 @@
+inherit_from:
+- .rubocop_base.yml

data/.travis.yml

@@ -1,5 +1,5 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.2.4
+  - 2.3.6
 before_install: gem install bundler -v 1.11.2

data/docs/apib/compliance_policies.apib

@@ -0,0 +1,214 @@
+FORMAT: 1A
+
+# XClarity compliancePolicies
+
+# get details of all policies
+
+## GET /compliancePolicies
++ Response 200
+{
+   "policies":[{
+      "description":"DEV ONLY",
+      "id":"1427930734934",
+      "inUse":"true",
+      "filterType":"all",
+      "lastModified":"2015-04-01 16:25:34",
+      "name":"DEFAULT-2015-04-01",
+      "updateRule":"",
+      "userDefined":"no"
+   },
+   {"updateRule":"",
+      "description":"ddddd",
+      "id":"1428397839104",
+      "inUse":"false",
+      "filterType":"managed",
+      "lastModified":"This policy was created by USERID on 2015-04-07 05:10:39",
+      "name":"aaaa",
+      "updateRule":"",
+      "userDefined":"yes"
+   }]
+}
++ Response 400
++ Response 401
++ Response 404
++ Response 409
++ Response 500
+
+# retrieve the persisted compare result for servers to which a compliance policy is assigned.
+
+## GET /compliancePolicies/persistedResult
++ Response 200
+{
+   "all": [{
+      "chassis": "FBEF740B178F4EFAA846E7225EE256DC",
+      "cmms": [{
+         "deviceCompliant": "no",
+         "message": [],
+         "policyName": "",
+         "supported": "true",
+         "targetFirmware": [],
+         "uuid": "387E51D69EC311E0A4C8E87E4D6C0479"
+      }],
+      "switches": [{
+         "deviceCompliant": "no",
+         "message": [],
+         "policyName": "DEFAULT-2015-04-25",
+         "supported": "true",
+         "targetFirmware": [{
+            "build": "0802",
+            "category": "Switches",
+            "compliant": "no",
+            "componentID": "1B33D6C57ECB04C14567A897DC604900",
+            "componentName": "IO Module 02",
+            "date": "2015-04-22",
+            "fixid": "lnvgy_fw_scsw_si4093-8.2.1.0_anyos_noarch",
+            "level": "higher",
+            "packageExistence": "yes",
+            "reason": "The installed version is down level than the version defined in compliance policy.",
+            "versionList": ["8.2.1.0"]
+         }],
+         "uuid": "1B33D6C57ECB04C14567A897DC604900"
+      }],
+      "xITEs": [{
+         "deviceCompliant": "no",
+         "message": [],
+         "policyName": "",
+         "supported": "true",
+         "targetFirmware": [],
+         "uuid": "69BDF8912E5211E4998B40F2E99033F0"
+      }],
+   "message": []
+   },
+   {
+      "racklist": [{
+         "deviceCompliant": "no",
+         "message": [],
+         "policyName": "",
+         "targetFirmware": [],
+         "uuid": "C29379AA380E11E39DF3000AF7256714"
+      }]
+   },
+   {
+      "rackswitchlist": [{
+         "deviceCompliant": "",
+         "message": [],
+         "policyName": "",
+         "targetFirmware": [],
+         "uuid": "242CFF20453641238D2B8FEDFB0F056F"
+      }]
+   },
+   {
+      "storagelist": [{
+         "deviceCompliant": "",
+         "message": [],
+         "policyName": "",
+         "targetFirmware": [],
+         "uuid": "208000C0FF25E476"
+      }]
+   }]
+}
++ Response 400
++ Response 401
++ Response 404
++ Response 409
++ Response 500
+
+# determine whether devices are compliant with the assigned compliance policy using the job or task ID that was returned when the compliance policy was assigned
+
+## GET /compliancePolicies/compareResult?jobid=1
++ Response 200
+{
+    "jobid": "1",
+    "percentage": 100,
+    "result": [{
+        "endpointCompliant": "no",
+        "message": [],
+        "status": "finished",
+        "targetFirmware": [{
+            "build": "0708",
+            "category": "Switches",
+            "compliant": "no",
+            "componentID": "A3F8482B012B32188E68375DD5FF40EE",
+            "componentName": "Demo - 00004X4093",
+            "date": "2015-02-13",
+            "fixid": "fw_scsw_en4093r-7.8.9.0_anyos_noarch",
+            "level": "higher",
+            "packageExistence": "yes",
+            "reason":"The installed version is down level than the version defined in compliance policy.",
+            "versionList": ["7.8.9.0"]
+        }],
+        "taskid": "0",
+        "uuid": "A3F8482B012B32188E68375DD5FF40EE"
+    }],
+    "status": "finished"
+}
++ Response 400
++ Response 401
++ Response 404
++ Response 409
++ Response 500
+
+# retrieve information about firmware that is applicable to each managed device.
+ 
+## GET /compliancePolicies/applicableFirmware
++ Response 200
+{
+   "componentTypes": [{
+      "applicableFirmware": [{
+         "available": [{
+            "buildNum": "TCOO15M",
+            "buildType": "development",
+            "fixid": "lnvgy_fw_imm2_tcoo15m-2.50_anyos_noarch",
+            "name": "Integrated Management Module 2 (IMM2) Update",
+            "releasedate": "2016-01-09",
+            "softwareIDList": ["IMM2-Backup"],
+            "version": "2.50",
+            "versionList": ["2.50"]
+         }],
+         "category": "IMM2-Backup",
+         "installedVersion": "1.95",
+         "name": "IMM2 (Backup)"
+      }],
+      "machineType": "5463",
+      "uuid": "208C0140DF7F11D4AE0FF3F3F3797979"
+   }]
+}
++ Response 400
++ Response 401
++ Response 404
++ Response 409
++ Response 500
+
+# delete one or more compliance policies.
+
+## DELETE /compliancePolicies
++ Response 200
+
++ Response 400
++ Response 401
++ Response 404
++ Response 409
++ Response 500
+
+# assign a compliance policy to one or more devices and to return the 
+# job ID and task IDs for monitoring the status of the job and tasks.
+
+## POST /compliancePolicies/compareResult
++ Response 200
+{
+    "errorDetail": [],
+    "errorMessage": "",
+    "message": [{
+        "tasks": [{
+            "taskid": 0,
+            "uuid": "A3F8482B012B32188E68375DD5FF40EE"
+        }],
+        "jobid": 14
+    }],
+    "status": "success"
+}
++ Response 400
++ Response 401
++ Response 404
++ Response 409
++ Response 500