profitbricks-sdk-ruby 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 88564c16a72d5c7f34ff57cc42d36a7c537ec773
+  data.tar.gz: 432dc5325b1ae8ae51a35b44d55dbfda9086d0da
+SHA512:
+  metadata.gz: b5ed7daa438cab92a5d9af03e96813675aa487efd2b193cd9ac23414fbba7cea92eed8969b2ca94d19f890cd09e7a6611920db15274063f29a9631841ab28b30
+  data.tar.gz: b476a9dd9a227e27d3c7a958e8f1e0dc0e6986ebf8bffd5c1528649500579d5e0a04ac5747396b0faac05ddbf23aaba168fed89133e9a8ee1eea26e9101de7cf

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.DS_Store
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+vendor
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in profitbricks-sdk-ruby.gemspec
+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 ProfitBricks GmbH
+
+   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,44 @@
+# ProfitBricks
+
+ProfitBricks SDK for Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'profitbricks-sdk-ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install profitbricks-sdk-ruby
+
+## Documentation and Support
+
+* A guide and reference documentation can be found in the repo docs/ directory.
+* [ProfitBricks SDK for Ruby](https://devops.profitbricks.com/libraries/profitbricks-sdk-ruby/) guide.
+* [ProfitBricks REST API](https://devops.profitbricks.com/api/rest/) documentation.
+* Ask a question or discuss at [ProfitBricks DevOps Central](https://devops.profitbricks.com/community).
+* Report an [issue here](https://github.com/profitbricks/profitbricks-sdk-ruby/issues).
+
+## Testing
+
+Please note that the unit tests will create and destroy live resources under
+the account specified and you will be responsible for any charges incurred.
+Proceed with caution.
+
+Add the ProfitBricks API credentials to the `spec/spec_helper.rb` file and
+run the following command.
+
+    $ rspec spec
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/profitbricks-sdk-ruby/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

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/docs/guide.md

@@ -0,0 +1,223 @@
+[ProfitBricks SDK for Ruby](https://github.com/profitbricks/profitbricks-sdk-ruby) is a Ruby library used for interacting with the ProfitBricks platform over the REST API.
+
+This guide will show you how to programmatically use the ProfitBricks library to perform common management tasks also available through the ProfitBricks Data Center Designer.
+
+## Table of Contents
+
+* [Concepts](#concepts)
+* [Getting Started](#getting-started)
+* [Installation](#installation)
+* [Authentication](#authentication)
+* [Configuration](#configuration)
+* [How To: Create a Data Center](#how-to-create-a-data-center)
+* [How To: Delete a Data Center](#how-to-delete-a-data-center)
+* [How To: Create a Server](#how-to-create-a-server)
+* [How To: List Available Disk and ISO Images](#how-to-list-available-disk-and-iso-images)
+* [How To: Create a Storage Volume](#how-to-create-a-storage-volume)
+* [How To: Update Cores, Memory, and Disk](#how-to-update-cores-memory-and-disk)
+* [How To: Attach and Detach a Storage Volume](#how-to-attach-and-detach-a-storage-volume)
+* [How To: List Servers, Volumes, and Data Centers](#how-to-list-servers-volumes-and-data-centers)
+* [How To: Reserve IP Blocks and Create a LAN](#how-to-reserve-ip-blocks-and-create-a-lan)
+* [How To: Create Additional Network Interfaces](#how-to-create-additional-network-interfaces)
+* [Additional Documentation and Support](#additional-documentation-and-support)
+
+--------------
+
+## Concepts
+
+The ProfitBricks SDK library wraps the [ProfitBricks REST API](/api/rest/) and provides a number of helper methods. All API operations are performed over SSL and authenticated using your ProfitBricks Data Center Designer credentials. The API can be accessed within an instance running in ProfitBricks or directly over the Internet from any application that can send an HTTPS request and receive an HTTPS response.
+
+## Getting Started
+
+Before you begin, you will need to [sign-up](https://www.profitbricks.com/signup) for a ProfitBricks account. The credentials you create during sign-up process will be used to authenticate against the API.
+ 
+### Installation
+
+The ProfitBricks SDK for Ruby is available as a gem. The latest stable version can be installed using the gem command syntax:
+
+    gem install profitbricks-sdk-ruby
+
+### Authentication
+
+Once installed, the gem can now be loaded within Ruby.
+
+    require 'profitbricks'
+
+The connection and authentication config must first be specified before the library can connect to the ProfitBricks REST API. These are specified using the configuration method.
+
+    ProfitBricks.configure do |config|
+      config.username = 'username'
+      config.password = 'password'
+    end
+
+**Caution:** You will want to ensure you follow security best practices when using credentials within your code.
+
+### Configuration
+
+Here is a list and brief description of available configuration parameters:
+
+* ```url``` - URL of the ProfitBricks REST API, default: "https://api.profitbricks.com"
+* ```username``` - ProfitBricks username (required)
+* ```password``` - ProfitBricks password (required)
+* ```path_prefix``` - REST URI path, default: "/rest/"
+* ```headers``` - Custom HTTP request headers
+* ```global_classes``` - Disable (flatten) ProfitBricks class namespace; set to false to avoid name conflicts, default: true
+* ```timeout``` - Timeout value for wait_for() method, default 60 seconds
+* ```interval``` - Polling interval value for wait_for() method, default: 3 seconds
+* ```debug``` - Enable or disable Excon debugging, default: false
+
+Example usage:
+
+    ProfitBricks.configure do |config|
+      config.username = 'username'
+      config.password = 'password'
+      config.url = 'https://api.profitbricks.com'
+      config.path_prefix = '/rest/'
+      config.timeout = 120
+      config.interval = 1
+    end
+
+## How To: Create a Data Center
+
+ProfitBricks introduces the concept of Virtual Data Centers. These are logically separated from one another and allow you to have a self-contained environment for all servers, volumes, networking, snapshots, and so forth. The goal is to give you the same experience as you would have if you were running your own physical data center.
+
+Unless you plan to manage an existing ProfitBricks environment, the first step will typically involve choosing the location for a new virtual data center. A list of locations can be obtained with Location class and the desired location assigned to a variable for later reference.
+
+    Location.list.each { |location| puts "#{location.id} - #{location.properties['name']}" }
+    location = Location.get('us/las')
+
+And now the data center can be created. 
+
+    datacenter = Datacenter.create(name: 'datacenter1', description: 'My New Datacenter', location: location.id)
+    datacenter.wait_for { ready? }
+
+The ```wait_for``` server object method will wait until the request status is done before continuing. This is useful when chaining requests together that are dependent on one another.
+
+## How To: Delete a Data Center
+
+You will want to exercise a bit of caution here. Removing a data center will **destroy** all objects contained within that data center -- servers, volumes, snapshots, and so on. The objects -- once removed -- will be unrecoverable. 
+
+The code to remove a data center is as follows. This example assumes you want to remove a data center named 'datacenter1': 
+
+    name = 'datacenter1'
+     
+    datacenter = Datacenter.list.find { |datacenter| dc.properties['name'] = name }
+    
+    datacenter.delete
+
+The data center can also be retrieved and removed by the UUID.
+
+    datacenter = Datacenter.get('6ff3153b-2ecc-45b4-8d70-aa8ea9a285e3')
+    
+    datacenter.delete
+
+## How To: Create a Server
+
+The following example shows you how to create a new server in the virtual data center created above:
+
+    server = datacenter.create_server(name: 'server1', description: 'My New Server', cores: 4, ram: 4096)
+    server.wait_for { ready? }
+
+One of the unique features of the ProfitBricks platform when compared with the other providers is that it allows you to define your own settings for cores, memory, and disk size without being tied to a particular size.
+
+## How To: List Available Disk and ISO Images
+
+A list of disk and ISO images are available from ProfitBricks for immediate use. These can be easily viewed and selected with the following code.
+
+    Image.list
+    
+    image = Image.list.find { |image| image.name =~ /CentOS-6/ && image.type == "HDD" && image.region == "us/las" }
+
+Make sure the image you retrieve is in the same location as the virtual data center.
+
+## How To: Create a Storage Volume
+
+ProfitBricks allows for the creation of multiple storage volumes that can be attached and detached as needed. It is useful to attach an image when creating a storage volume. The storage size is in gigabytes (GB).
+ 
+    volume = datacenter.create_volume(name: 'My New Volume, size: 40, image: image.id)
+    
+    volume.wait_for { ready? }
+
+## How To: Update Cores, Memory, and Disk
+
+ProfitBricks allows users to dynamically update cores, memory, and disk independently of each other. This removes the restriction of needing to upgrade to the next size available size to receive an increase in memory. You can now simply increase the instances memory keeping your costs in-line with your resource needs.
+
+**Note:** The memory parameter value must be a multiple of 256, e.g. 256, 512, 768, 1024, and so forth.
+
+The following code illustrates how you can update cores and memory: 
+
+    server.update(cores: 6, ram: 10240 }
+    sever.wait_for { ready? }
+    
+The server object may need to be refreshed in order to show the new configuration.
+
+    server.reload
+
+ This is how you would update the storage volume size: 
+ 
+    volume.update(size: 100)
+    volume.wait_for { ready? }
+
+## How To: Attach and Detach a Storage Volume
+
+ProfitBricks allows for the creation of multiple storage volumes. You can detach and reattach these on the fly. This allows for various scenarios such as re-attaching a failed OS disk to another server for possible recovery or moving a volume to another location and bringing it online. 
+
+The following illustrates how you would attach and detach a volume from a server:
+
+    volume.attach(server.id)
+    
+    volume.wait_for { ready? }
+    
+    volume.detach(server.id)
+
+## How To: List Servers, Volumes, LANs, NICs, and Data Centers
+
+The library provides standard functions for retrieving a list of volumes, servers, network interfaces (NICs), and LANs. 
+
+The following code illustrates how to list various resources under a specific data center.
+
+    Datacenter.list
+    datacenter = Datacenter.get('7ff3153b-2ecc-45b4-8d70-aa6ea9a23d5e4')
+    
+    datacenter.list_volumes
+    datacenter.list_servers
+    datacenter.list_lans
+
+To list the volumes and NICs attached to a specific server:
+
+    server = datacenter.get_server('4bf3153b-2ecc-45b4-8d70-aa8ea9a285e3')
+    
+    server.list_volumes
+    server.list_nics
+
+## How To: Reserve IP Blocks and Create a LAN
+
+The IP block size (number of IP addresses) and location are required to reserve an IP block:
+
+    ipblock = IPBlock.reserve(location: 'us/las', size: 5)
+
+A LAN must be created within a data center.
+    
+    lan = datacenter.create_lan(name: 'My LAN')
+    lan.wait_for { ready? }
+
+The LAN can be enabled for public Internet access if necessary.
+
+    lan.update(public: true)
+
+## How To: Create Additional Network Interfaces
+
+The ProfitBricks platform supports adding multiple NICs to a server. These NICs can be used to create different, segmented networks on the platform.
+
+The sample below shows you how to add a second NIC to an existing server and LAN:
+
+    nic = server.create_nic(name: 'nic2', lan: lan.id, ips: ['10.2.2.3','10.2.3.4'])
+    nic.wait_for { ready? }
+
+## Additional Documentation and Support
+
+Further documentation can be found in the project repository on GitHub.
+
+    [https://github.com/StackPointCloud/profitbricks-sdk-ruby](https://github.com/StackPointCloud/profitbricks-sdk-ruby)
+
+Questions and discussions can be directed to [ProfitBricks DevOps Central](https://devops.profitbricks.com/) site.