xclarity_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bec6fd97900c5de80ebf9aa4395914dd492b9c31
+  data.tar.gz: 36c48bd89f5c8c9b0668176349c233d69c486b53
+SHA512:
+  metadata.gz: 483fe96ee7d3880cef60f475f9a66dc31bbbe23afbaa8a3835a2210819fb41fe3d5ea8359ee0d91ceea53acfc5861505f1ef70522484fa9c09bed549a1dab8e4
+  data.tar.gz: 4846f857d9d63251f98dcb2b3b3913402e578fa6ede0bf02f67229a5e6af05594e1c493c39f67eff86736f407aaf980972a07646212c97ff00bba67e50c452cb

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at jcheal@redhat.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xclarity_client.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,51 @@
+# XClarity Client
+
+[![Build Status](https://travis-ci.org/juliancheal/xclarity_client.svg)](https://travis-ci.org/juliancheal/xclarity_client)
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/xclarity_client`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xclarity_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xclarity_client
+
+## Usage
+
+To get basic information from the virtual appliance
+
+```ruby
+require 'xclarity_client'
+
+conf = XClarityClient::Configuration.new(
+  :username => 'admin',
+  :password => 'pass',
+  :host     => 'http://example.com'
+)
+
+virtual_appliance = XClarityClient::VirtualApplianceManagement.new(conf)
+
+puts virtual_appliance.configuration_settings
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/juliancheal/xclarity_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "xclarity_client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/mock_server.ru

@@ -0,0 +1,11 @@
+require 'xclarity_client'
+require 'apib/mock_server'
+
+base_url = "http://localhost:9292"
+blueprints = ""
+Dir.glob('docs/apib/*.apib') do |blueprint|
+  blueprints << File.open(blueprint).read
+end
+
+app = Apib::MockServer.new(base_url, blueprints)
+run app

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docs/apib/aicc.apib

@@ -0,0 +1,344 @@
+FORMAT: 1A
+
+# Lenovo XClarity Management Console API
+
+# GET /aicc
+
++ Response 200 (application/json)
+
+  {
+   "appliance": {
+      "build": "110",
+      "date": "2015-09-15_10-25-16",
+      "name": "LXCA - 10.240.61.98",
+      "runlevel": 3,
+      "status": "Normal",
+      "uuid": "bef3e2c3-a689-4734-aa79-2a21f21e8b97",
+      "version": "1.1.0"
+   },
+   "appliance_states": [{
+      "description": "Halt the appliance",
+      "runlevel": 0
+   },
+   {
+      "description": "Reboot the appliance",
+      "runlevel": 6
+   }],
+   "date": {
+      "date_time": "September 18, 2015 8:45:54 AM EST",
+      "parts": {
+         "yyyy": 2015,
+         "mm": 9,
+         "dd": 18,
+         "hours": 8,
+         "mins": 45
+         "secs": 54,
+      },
+      "timezone": "Eastern Standard Time",
+      "timezones": [{
+         "daylight_saves": 0,
+         "display_name": "GMT-12:00",
+         "id": "Etc/GMT+12",
+         "offset": -43200000,
+         "uses_daylight": false,
+         "utc_offset_raw": -43200000,
+         "utc_offset_w_dst": -43200000
+      },
+      {
+         "daylight_saves": 0,
+         "display_name": "Eastern Standard Time",
+         "id": "America/Grand_Turk",
+         "offset": -14400000,
+         "uses_daylight": false,
+         "utc_offset_raw": -18000000,
+         "utc_offset_w_dst": -14400000
+      }],
+      "timezone_id": "America/Cayman",
+      "uses_daylight": true,
+      "utc_offset": -18000000,
+      "utc_offset_raw": -18000000,
+      "utc_offset_w_dst": -18000000
+   }
+   "network_interfaces": [{
+      "id": "eth0",
+      "ip_addresses": [{
+         "assign_method": "static",
+         "ip": "fe80:0:0:0:200:ff:fe00:10%2",
+         "ip_linklocal": "true",
+         "prefix_length": 64,
+         "version": 6
+      },
+      {
+         "assign_method": "static",
+         "ip": "10.240.61.98",
+         "ip_linklocal": "false",
+         "prefix_length": 22,
+         "version": 4
+      }],
+      "mac_address": "00:00:00:00:00:10",
+      "role": ["management", "osdeployment"]
+   }],
+   "ntp": {
+      "servers": [{
+         "authenticated": false,
+         "server": "us.pool.ntp.org",
+         "version": 1,
+         "v3_key": "",
+         "v3_key_index": 0,
+         "v3_key_type": ""
+      }]
+   },
+   "services": [{
+      "id": "core",
+      "initd": "xhmc-core",
+      "pid": 52706,
+      "state": 0
+   },
+   {
+      "id": "watchdog",
+      "initd": "sympl-watchdog",
+      "pid": 52517,
+      "state": 0
+   }],
+   "service_states": [{
+      "description": "Service is running",
+      "state": 0
+   },
+   {
+      "description": "Special purpose state used to trigger restart through REST",
+      "state": 191
+   }],
+   "subscriptions": [{
+      "id": 1,
+      "monitor_uri": "/aicc",
+      "uri": "/ntpNotification"
+   },
+   {
+      "id": 3,
+      "monitor_uri": "",
+      "uri": "/osdeployment/rest/internal/event/aicc"
+   }],
+  }
+
+# PUT /aicc
+
++ Response 200 (application/json)
+
++ Response 400
+
+# GET /aicc/network/ipdisable
+
++ Response 200 (application/json)
+
+  {
+   "ip_status": [{
+      "ip_disable": 0,
+      "ip_version": 4
+   },
+   {
+      "ip_disable": 0,
+      "ip_version": 6
+   }]
+  }
+
++ Response 404
+
+# PUT /aicc/network/ipdisable
+
++ Response 200 (application/json)
+
++ Response 400
+
+# GET /aicc/network/host
+
++ Response 200 (application/json)
+
+  {
+      "dns_servers": [{
+          "ip": "192.168.3.1",
+          "priority": 1
+      },
+      {
+          "ip": "9.0.128.50",
+          "priority": 2
+      },
+      {
+          "ip": "9.0.130.50",
+          "priority": 3
+      },
+      {
+          "ip": "192.168.129.1",
+          "priority": 4
+      }],
+      "domain_name": "(none),"
+      "hostname": "localhost",
+      "proxy": {
+          "enabled": true,
+          "ip": "1.1.1.1",
+          "password": "password",
+          "port": 11,
+          "userid": "userid"
+      }
+  }
+
+# PUT /aicc/network/host
+
++ Response 200 (application/json)
+
+  {
+      "dns_servers": [{
+          "ip": "192.168.3.1",
+          "priority": 1
+      },
+      {
+          "ip": "9.0.128.50",
+          "priority": 2
+      },
+      {
+          "ip": "9.0.130.50",
+          "priority": 3
+      },
+      {
+          "ip": "192.168.129.1",
+          "priority": 4
+      }],
+      "domain_name": "(none),"
+      "hostname": "localhost",
+      "proxy": {
+          "enabled": true,
+          "ip": "1.1.1.1",
+          "password": "password",
+          "port": 11,
+          "userid": "userid"
+      }
+  }
+
++ Response 400
+
+# GET /aicc/network/interfaces/{interface}
+
++ Parameters
+    + interface - ID of the network interface.
+
++ Response 200 (application/json)
+
+  [{
+     "id": "eth0",
+     "ip_addresses": [{
+        "assign_method": "static",
+        "ip": "fe80:0:0:0:20c:29ff:fec3:af6b%2",
+        "ip_linklocal": "true",
+        "prefix_length": 64,
+        "version": 6
+     },
+     {
+        "assign_method": "static",
+        "ip": "10.240.70.20",
+        "ip_linklocal": "false",
+        "prefix_length": 23,
+        "version": 4
+     }],
+     "mac_address": "00:0C:29:C3:AF:6B",
+     "role": ["management", "osdeployment"]
+  }]
+
++ Response 400
+
+# PUT /aicc/network/interfaces/{interface}
+
++ Response 200 (application/json)
++ Response 400
++ Response 401
++ Response 403
++ Response 404
++ Response 409
++ Response 500
+
+# GET /aicc/network/routes
+
++ Response 200 (application/json)
+
+# PUT /aicc/network/routes
+
++ Response 200 (application/json)
+
+  {
+    "routes": [{
+        "dev": "eth0",
+        "destination": "100.10.10.10",
+        "ip_version": 4,
+        "nexthop": "192.168.56.1",
+        "prefix_len": 32
+    },
+    {
+        "dev": "eth0",
+        "destination": "10.10.10.0",
+        "ip_version": 4,
+        "nexthop": "192.168.56.1",
+        "prefix_len": 24
+    },
+    {
+        "ip_version": 4,
+        "nexthop": "10.0.3.2",
+        "prefix_len": 0
+    },
+    {
+        "dev": "eth1",
+        "destination": "2001:db7:1::",
+        "ip_version": 6,
+        "nexthop": "2002:97b:c2bb:83d:5054:ff:fe2c:eefe",
+        "prefix_len": 64
+    },
+    {
+        "dev": "eth1",
+        "destination": "2002:97b:face:83d:5054:ff:fe2c:eefe",
+        "ip_version": 6,
+        "nexthop": "2002:97b:c2bb:83d:5054:ff:fe2c:eefe",
+        "prefix_len": 128
+    }]
+  }
+
++ Response 400
+
+# GET /aicc/subscriptions
+
++ Response 200 (application/json)
+
+  [{
+     "id": 1,
+     "monitor_uri": "/aicc/network/interfaces",
+     "submonitor_uri": "",
+     "uri": "/osdeployment/rest/internal/event/aicc"
+  },
+  {
+     "id": 2,
+     "monitor_uri": "/aicc",
+     "submonitor_uri": "/ntp",
+     "uri": "/ntpNotification"
+  },
+  {
+     "id": 3,
+     "monitor_uri": "/aicc/network/interfaces",
+     "submonitor_uri": "",
+     "uri": "/netchangenotsec"
+  }]
+
++ Response 400
+
+# PUT /aicc/subscriptions
+
++ Response 200 (application/json)
++ Response 400
++ Response 409
+
+# DELETE /aicc/subscriptions/{id}
+
++ Response 200 (application/json)
+
++ Response 404
+
+# GET /aicc/subscriptions/{id}
+
++ Response 200 (application/json)
+
++ Response 400