oraclecloud 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 114f5803f4c77b8c23858167d333564ced2961d0
+  data.tar.gz: 958dad16f17017b1210ce926f224b59619fff360
+SHA512:
+  metadata.gz: 337eebb3ff3423dc93cceb7481896a08e20bb21fca8f6b387da4a0bc80cb917bf3458ff574909ddf4a4438139f03da2948f3f67dc5656234bed3af406cccf01d
+  data.tar.gz: be3492b4887cfebc5f4542ec254a091cae1aadf998e4ac3aa31f00b71df5ea0bc6885d1322b983b5423b993461f0775d4eb60619eb74f05e741ec04e8c16071c

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/.rubocop.yml

@@ -0,0 +1,12 @@
+Metrics/AbcSize:
+  Max: 30
+Metrics/LineLength:
+  Max: 150
+Metrics/MethodLength:
+  Max: 30
+Style/Documentation:
+  Enabled: false
+Style/SignalException:
+  Enabled: false
+Style/SpaceInsideBrackets:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# oraclecloud client gem CHANGELOG
+
+## v1.0.0 (2015-10-15)
+* Initial release
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 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 2015 Chef Software, Inc.
+
+   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,208 @@
+# Oracle Cloud API Client
+
+`oracle-cloud` is a RubyGem for interacting with the Oracle Cloud REST API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'oraclecloud'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install oraclecloud
+
+## Usage
+
+First, load in the gem.
+
+```ruby
+require 'oraclecloud'
+=> true
+```
+
+Then, set up your client object.
+
+```ruby
+client = OracleCloud::Client.new(username: 'user@domain.io', password: 'supersecret', identity_domain: 'mydomain', api_url: 'https://some-api-endpoint.compute.us6.oraclecloud.com')
+=> #<OracleCloud::Client:0x000000034c0df8 ... >
+```
+
+### Instances
+
+To list all instances:
+
+```ruby
+client.instances.all
+=> [#<OracleCloud::Instance:0x007fd6e4080710
+  @asset_data=
+...
+```
+
+Once you have an instance, you can get additional information about it:
+
+```ruby
+
+instance.hostname
+=> "c799e7.compute-mydomain.oraclecloud.internal."
+
+instance.ip_address
+=> "10.1.1.1"
+
+instance.public_ip_addresses
+=> ["1.2.3.4"]
+
+instance.shape
+=> "oc1m"
+
+instance.state
+=> "running"
+
+instance.vcable_id
+=> "/Compute-mydomain/user@domain.io/7a46361a-4e69-41ec-bf4f-84d22a2eeab0"
+
+instance.image
+=> "/oracle/public/oel_6.6_20GB_x11_RD"
+```
+
+### Creating Instances
+
+To create an instance, you must create an orchestration which controls that instance.  An orchestration can start multiple instances.
+
+First, build an instance request for each instance you wish to start:
+
+```ruby
+instance1 = client.instance_request(shape: 'oc1m', imagelist: '/oracle/public/oel_6.6_20GB_x11_RD', name: 'test1', sshkeys: ["/path/to/sshkey"], public_ip: :pool)
+=> #<OracleCloud::InstanceRequest:0x007fdf0d286880 ...>
+```
+
+See the Shapes and Imagelists sections for help on determining your shape and imagelist options.
+
+Then, build an orchestration:
+
+```ruby
+orchestration = client.orchestrations.create(name: 'test1', description: 'my first orchestration', instances: [ instance1 ])
+=> #<OracleCloud::Orchestration:0x007fdf0a342880
+```
+
+You will see that the orchestration is not yet started, so go ahead and start it!
+
+```ruby
+orchestration.status
+=> "stopped"
+
+orchestration.start
+=> {"relationships"=>[],
+ "status"=>"starting",
+...
+```
+
+You can refresh the orchestration status.  Once it's started, your instances should be available.
+
+```ruby
+orchestration.refresh && orchestration.status
+=> "starting"
+
+orchestration.refresh && orchestration.status
+=> "ready"
+
+instance = orchestration.instances.first
+=> #<OracleCloud::Instance:0x007fff0b478aa8 ...>
+
+instance.state
+=> "running"
+
+instance.public_ip_addresses
+=> ["1.2.3.4"]
+```
+
+### Shapes
+
+You can list all available shapes using the `client.shapes.all` method:
+
+```ruby
+client.shapes.all
+=> [#<OracleCloud::Shape:0x007f823b9cb5e8
+  @shape_data=
+   {"nds_iops_limit"=>0,
+    "ram"=>122880,
+    "cpus"=>16.0,
+    "uri"=>"https://some-api-endpoint.compute.us6.oraclecloud.com/shape/oc4m",
+    "io"=>800,
+    "name"=>"oc4m"}>,
+ #<OracleCloud::Shape:0x007f823b9cb5c0
+  @shape_data=
+   {"nds_iops_limit"=>0,
+    "ram"=>122880,
+    "cpus"=>32.0,
+    "uri"=>"https://some-api-endpoint.compute.us6.oraclecloud.com/shape/oc7",
+    "io"=>1000,
+    "name"=>"oc7"}>,
+...
+```
+
+This returns an array of OracleCloud::Shape objects which you can interrogate as needed:
+
+```ruby
+client.shapes.all.map { |shape| shape.name }.sort
+=> ["oc1m", "oc2m", "oc3", "oc3m", "oc4", "oc4m", "oc5", "oc5m", "oc6", "oc7"]
+```
+
+### Imagelists
+
+You can list all available imagelists using the `client.imagelists.all` method:
+
+```ruby
+client.imagelists.all
+=> [#<OracleCloud::ImageList:0x007f823ed69b48
+  @imagelist_data=
+   {"default"=>1,
+    "description"=>"\"OEL 6.4 20 GB image\"",
+    "entries"=>
+     [{"attributes"=>{},
+       "version"=>1,
+       "machineimages"=>["/oracle/public/oel_6.4_20GB_x11_RD"],
+       "uri"=>
+...
+```
+
+This returns an array of OracleCloud::ImageList objects which you can interrogateas needed:
+
+```ruby
+client.imagelists.all.map { |imagelist| imagelist.name }.sort
+=> ["/oracle/public/oel_6.4_20GB_x11_RD", "/oracle/public/oel_6.4_5GB_RD", "/oracle/public/oel_6.6_20GB_x11_RD"]
+```
+
+## License and Authors
+
+Author:: Chef Partner Engineering (<partnereng@chef.io>)
+
+Copyright:: Copyright (c) 2015 Chef Software, Inc.
+
+License:: Apache License, Version 2.0
+
+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.
+
+## Contributing
+
+1. Fork it ( https://github.com/chef-partners/oracle-cloud-client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request