fog-softlayer 0.0.5 → 0.0.7

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjY5ZGRiZWQ0NGZlNTRjMTJmZjNjYTU5ODU4MGI3ZTA4NjQxM2M5Mg==
+    OWE5Yjc5YjM3MzM5ZmQxMGQ1ZjIzMmE0OWQ5YmVhNWJhNDFmNDAwNQ==
   data.tar.gz: !binary |-
-    ODkzYmYxMWZjODc1OWViZjdiMjNiMjgyMjk0ZWZjYTVkOTcwMzE4MQ==
+    ZDY5YTQyZTkzZGM1NjhkMGIyYThmMTYwNTM0MzY4NTczY2UxNDU3ZQ==
 SHA512:
   metadata.gz: !binary |-
-    OGYyYTkxMTMwOWMzMGY1ZWQyMDZiMDVjM2JlZGY2ZGFkMDQ2NDA2ZWY0Njk4
-    YTFjNDFhMDYxMzMxMjdjZTM3MmZiNzY4NTliMTg0NjFlYzMyZjM3ZDQ3MzM3
-    ZDI0YWI5ODBmNDZkNWI4MzJjMzY5OGE4MmFhNGE0Nzg3MWQyZTc=
+    MDlmN2Q2YWM4N2I3YzNhZmUzNzM3ZmNhOTJhNmYwZjM1Y2E1MzdmMTFjOTY4
+    NzVmY2RlMjkyODQxYWNlOWRmNzcyMDhlMDdhZjNjYjE0YWQ0N2YyODFmNGU5
+    Yzk5MGI1MDMxMGEzYzQ2ODhlZmQwYjRiZWI2MjYzZGU1YjA1MWU=
   data.tar.gz: !binary |-
-    MDE5OWJmNTQ3YjQyZGNlMTljYTFlMzcwNWEyODJkYmFmOTI3MmI2NzVkMjNi
-    ZjgzMDhlMGQzMmJmNzc0N2ZjOGQ0YWI0NjAyOTVkZDdhM2Y5NWJkMGRhMGRk
-    MmIyNDI2YzQyMjIyYzNkNjU4NTg3MTdiYjQ5MzcwN2EzOWI3NGU=
+    OTU4ZGU1OTU5Y2Q5MGUxYjg4NjYzODc1Mzk1YTk1Nzg1YTkwOThmNjAxYjMw
+    MzczMTdkNGY2ZDdmZTUzZTNhNjZhMTc4M2ZlMTcwM2M4MmYzMGNjNTNhZGI0
+    ZmZmMzQ1ZTlkYTRiYzExNjBhYTFjMWQwMDliMWYyMTVmZDM3M2Y=

data/.travis.yml

@@ -0,0 +1,37 @@
+language: ruby
+
+script: bundle exec rake travis
+
+matrix:
+  fast_finish: true
+  include:
+    - rvm: 1.8.7
+      gemfile: gemfiles/Gemfile-ruby-1.8.7
+    - rvm: 1.9.3
+      gemfile: Gemfile
+    - rvm: 2.0.0
+      gemfile: Gemfile
+    - rvm: 2.1.0
+      gemfile: Gemfile
+    - rvm: 2.1.1
+      gemfile: Gemfile
+      env: COVERAGE=true
+    - rvm: 2.1.1
+      gemfile: gemfiles/Gemfile-edge
+    - rvm: jruby-18mode
+      gemfile: gemfiles/Gemfile-ruby-1.8.7
+    - rvm: jruby-19mode
+      gemfile: Gemfile
+    - rvm: jruby-head
+      gemfile: Gemfile
+
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: 1.8.7
+
+notifications:
+  email:
+    - matt.eldridge@us.ibm.com
+
+before_install:
+  - gem update --system #  todo: workaround for https://github.com/rubygems/rubygems/pull/763

data/CONTRIBUTING.md

@@ -0,0 +1,30 @@
+# Contributing to fog-softlayer
+
+We are happy to accept contributions to fog-softlayer.  Please follow the guidelines below.  
+
+* Sign our contributor agreement (CLA) You can find the [CLA here](./docs/cla-individual.pdf).
+
+* If you're contributing on behalf of your employer we'll need a signed copy of our corporate contributor agreement (CCLA) as well.  You can find the [CCLA here](./docs/cla-corporate.pdf).
+    
+* Fork the repo, make your changes, and open a pull request.
+
+## Issue Tracking
+
+You can file tickets to describe the bug you'd like to fix or feature you'd
+like to add on the [fog-softlayer project](https://github.com/softlayer/fog-softlayer/issues) on github.
+
+## Testing Instructions
+
+To run tests, run the following Ruby tool commands from the root of your local copy of
+fog-softlayer:
+
+    bundle install
+    bundle exec rake travis
+    
+**All tests must pass** before your contribution can be merged. Thus it's a good idea
+to execute the tests without your change to be sure you understand how to run
+them, as well as after to validate that you've avoided regressions.
+
+All but the most trivial changes should include **at least one unit test case** to exercise the
+new / changed code; please add tests to your pull request in this common case.
+

data/README.md

@@ -1,4 +1,7 @@
-# SoftLayer Cloud module for fog (The Ruby cloud services library)
+### `fog-softlayer` - SoftLayer module for fog (The Ruby cloud services library).
+[![Gem Version](https://badge.fury.io/rb/fog-softlayer.png)](http://badge.fury.io/rb/knife-softlayer)
+[![Build Status](https://api.travis-ci.org/softlayer/fog-softlayer.svg)](https://travis-ci.org/softlayer/knife-softlayer)
+[![Dependency Status](https://gemnasium.com/softlayer/fog-softlayer.svg)](https://gemnasium.com/softlayer/knife-softlayer)
 
 This gem is a module for the `fog` gem that allows you to manage resources in
 the SoftLayer Cloud.
@@ -15,7 +18,7 @@ Additional services coming soon:
 * Image
 * Network
 
-## Installation
+#### Installation
 
 Add this line to your application's Gemfile:
 
@@ -29,7 +32,7 @@ Or install it yourself as:
 
     $ gem install fog-softlayer
 
-## Usage
+#### Usage
 
 Please see the following references for instructions using the main `fog` gem
 and its modules:
@@ -38,11 +41,11 @@ and its modules:
 * http://fog.io/
 * http://rubydoc.info/gems/fog/
 
-## Contributing
+#### Contributing
 
 `fog` modules are kept within the main repo.
 
-1. Fork it ( http://github.com/fog/fog/fork )
+1. Fork it ( http://github.com/softlayer/fog-softlayer/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`)

data/docs/cla-corporate.md

@@ -0,0 +1,133 @@
+ 
+#### International Business Machines, Inc.
+#####Software Grant and Corporate Contributor License Agreement ("Agreement")
+
+http://www.github.org/softlayer/fog-softlayer/
+
+
+Thank you for your interest in IBM’s fog-softlayer project (“the
+Project"). In order to clarify the intellectual property license granted with Contributions from any person or entity, IBM must have a Contributor License Agreement (CLA) on file that has been signed by each Contributor, indicating agreement to the license terms
+below. This license is for your protection as a Contributor as well
+as the protection of IBM and its users; it does not change your rights to use your own Contributions for any other purpose.
+
+This version of the Agreement allows an entity (the "Corporation") to submit Contributions to the Project, to authorize Contributions 
+submitted by its designated employees to the Project, and to grant 
+copyright and patent licenses thereto 
+   
+If you have not already done so, please complete and sign, then scan and email a pdf file of this Agreement to pjackson@softlayer.com. 
+
+
+
+Please read this document carefully before signing and keep a copy for your records.
+
+Corporation name:    ________________________________________________
+      
+Corporation address: ________________________________________________                     
+
+Point of Contact:    ________________________________________________
+
+E-Mail:              ________________________________________________
+
+Telephone:           _____________________ 
+      
+
+You accept and agree to the following terms and conditions for Your
+present and future Contributions submitted to the Project. Except 
+for the license granted herein to IBM and recipients of software distributed by IBM, You reserve all right, title, and interest in and to Your Contributions.
+
+1. Definitions.
+
+   "You" (or "Your") shall mean the copyright owner or legal entity
+   authorized by the copyright owner that is making this Agreement
+   with IBM. For legal entities, the entity making a Contribution and    
+   all other entities that control, are controlled by, or are under 
+   common control with that entity are considered to be a single    
+   Contributor. 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.
+
+   "Contribution" shall mean the code, documentation or other original
+   works of authorship expressly identified in Schedule B, as well as
+   any original work of authorship, including any modifications or    
+additions to an existing work, that is intentionally submitted by You to IBM for inclusion in, or documentation of, the Project managed by IBM (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to IBM 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, IBM for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution."
+
+2. Grant of Copyright License. Subject to the terms and conditions
+   of this Agreement, You hereby grant to IBM and to
+   recipients of software distributed by IBM 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
+   Your Contributions and such derivative works.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this Agreement, You hereby grant to IBM and to recipients
+   of software distributed by IBM 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 You that are necessarily infringed by Your Contribution(s)
+   alone or by combination of Your Contribution(s) with the Work to
+   which such Contribution(s) were submitted. If any entity institutes
+   patent litigation against You or any other entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that your
+   Contribution, or the Work to which you have contributed, constitutes
+   direct or contributory patent infringement, then any patent licenses
+   granted to that entity under this Agreement for that Contribution or
+   Work shall terminate as of the date such litigation is filed.
+
+4. You represent that You are legally entitled to grant the above
+   license. You represent further that each employee of the
+   Corporation designated on Schedule A below (or in a subsequent
+   written modification to that Schedule) is authorized to submit
+   Contributions on behalf of the Corporation.
+
+5. You represent that each of Your Contributions is Your original
+   creation (see section 7 for submissions on behalf of others).
+
+6. You are not expected to provide support for Your Contributions,
+   except to the extent You desire to provide support. You may provide
+   support for free, for a fee, or not at all. Unless required by
+   applicable law or agreed to in writing, You provide Your
+   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.
+
+7. Should You wish to submit work that is not Your original creation,
+   You may submit it to IBM separately from any
+   Contribution, identifying the complete details of its source and
+   of any license or other restriction (including, but not limited
+   to, related patents, trademarks, and license agreements) of which
+   you are personally aware, and conspicuously marking the work as
+   "Submitted on behalf of a third-party: [named here]".
+
+8. It is your responsibility to notify IBM when any change
+   is required to the list of designated employees authorized to submit
+   Contributions on behalf of the Corporation, or to the Corporation's
+   Point of Contact with IBM.
+
+
+
+Please sign: __________________________________ Date: _______________
+
+Title:       __________________________________
+
+Corporation: __________________________________
+
+
+Schedule A
+
+   [Initial list of designated employees.  NB: authorization is not
+    tied to particular Contributions.]
+
+
+
+
+Schedule B
+
+   [Identification of optional concurrent software grant.  Would be
+    left blank or omitted if there is no concurrent software grant.]
+

data/docs/cla-individual.md

@@ -0,0 +1,84 @@
+#### International Business Machines, Inc. (IBM)
+#####Individual Contributor License Agreement ("Agreement")
+            
+http://www.github.com/softlayer/fog-softlayer
+
+Thank you for your interest in the fog-softlayer project ("the Project").
+
+In order to clarify the intellectual property license granted with Contributions from any person or entity, IBM must have a Contributor License Agreement ("CLA") on file that has been signed by each Contributor, indicating agreement to the license terms below. This license is for your protection as a Contributor as well as the protection of IBM and its customers; it does not change your rights to use your own Contributions for any other purpose.
+
+If you have not already done so, please complete and sign, then scan and email a pdf file of this Agreement to pjackson@softlayer.com
+
+Please read this document carefully before signing and keep a copy for your records.
+
+  Full name: ______________________________________________________
+
+  (optional) Public name: _________________________________________
+
+  Mailing Address: ________________________________________________                
+
+  Country:   ______________________________________________________
+
+  Telephone: ______________________________________________________
+
+  E-Mail:    ______________________________________________________
+
+
+You accept and agree to the following terms and conditions for Your present and future Contributions submitted to the Project. Except for the license granted herein to IBM and recipients of software distributed by IBM, You reserve all right, title, and interest in and to Your Contributions.
+
+1. Definitions.
+
+   "You" (or "Your") shall mean the copyright owner or legal entity
+   authorized by the copyright owner that is making this Agreement
+with IBM. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. 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.
+
+   "Contribution" shall mean any original work of authorship,
+   including any modifications or additions to an existing work, that
+   is intentionally submitted by You to the Project for inclusion
+in, or documentation of, the Project (”the Work”). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Project 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 Project for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution."
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this Agreement, You hereby grant to IBM and to recipients of software distributed by IBM 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 Your Contributions and such derivative works.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this Agreement, You hereby grant to IBM and to recipients of software distributed by IBM 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 to which Your Contribution(s) were submitted, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.
+
+4. You represent that you are legally entitled to grant the above
+   license. If your employer(s) has rights to intellectual property
+   that you create that includes your Contributions, you represent
+   that you have received permission to make Contributions on behalf
+   of that employer, that your employer has waived such rights for
+   your Contributions to the Project, or that your employer has
+   executed a separate Corporate CLA with IBM.
+
+5. You represent that each of Your Contributions is Your original
+   creation (see section 7 for submissions on behalf of others).  You
+   represent that Your Contribution submissions include complete
+   details of any third-party license or other restriction (including,
+   but not limited to, related patents and trademarks) of which you
+   are personally aware and which are associated with any part of Your
+   Contributions.
+
+6. You are not expected to provide support for Your Contributions,
+   except to the extent You desire to provide support. You may provide
+   support for free, for a fee, or not at all. Unless required by
+   applicable law or agreed to in writing, You provide Your
+   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.
+
+7. Should You wish to submit work that is not Your original creation,
+   You may submit it to the Project separately from any
+   Contribution, identifying the complete details of its source and of
+   any license or other restriction (including, but not limited to,
+   related patents, trademarks, and license agreements) of which you
+   are personally aware, and conspicuously marking the work as
+   "Submitted on behalf of a third-party: [named here]".
+
+8. You agree to notify IBM of any facts or circumstances of
+   which you become aware that would make these representations
+   inaccurate in any respect.
+
+Please sign: __________________________________ Date: ________________
+

data/examples/storage.md

@@ -0,0 +1,107 @@
+### Storage Examples
+
+These examples all assume you have `~/.fog` which contains the following
+
+
+   ```yaml  
+   :softlayer_username: example-username
+   :softlayer_api_key: 1a1a1a1a1a1a1a1a1a11a1a1a1a1a1a1a1a1a1 
+   :softlayer_cluster: cluster # currently supported clusters are dal05, sng01, ams01
+  ```
+
+#### Create a connection to SoftLayer Object Storage
+
+```ruby
+	require 'fog/softlayer'
+	@sl = Fog::Storage[:softlayer]
+```
+
+#### Use the Models
+1. List directories/containers.
+
+   ```ruby
+    dirs = @sl.directories
+    dirs.size # the number of directories      
+   ```
+1. Create a directory/container.
+
+  ```ruby
+  	@sl.directories.create(:key => 'a-container')
+  ```
+
+1. Get a directory/container
+
+  ```ruby
+  	dir = @sl.directories.get('a-container')
+  	dir.key  # => 'a-container'
+  ```
+
+
+1. Create a new file/object
+
+  ```ruby
+  	dir = @sl.directories.get('a-container')
+  	# Pass a string.
+  	dir.files.create(:key => 'data.txt', :body => 'The quick brown fox jumps over the lazy dog.")
+  	# From a file.
+  	dir.files.create(:key => 'file-data.txt', :body => File.open('/path/to/file-data.txt')
+  ```
+
+
+1. Get an existing file/object
+
+  ```ruby
+  	dir = @sl.directories.get('a-container')
+  	file = dir.files.get('data.txt')
+  	file.body # => 'The quick brown fox jumps over the lazy dog.'
+  ```
+
+
+
+1. Copy a file/object
+
+  ```ruby
+  	file  = @sl.directories.get('a-container').files.get('data.txt')
+  	copy = file.copy('a-container', 'copy-of-data.txt')
+  	copy.body # => 'The quick brown fox jumps over the lazy dog.'
+  ```
+
+
+
+1. List the files in a directory/container
+
+  ```ruby
+   @sl.directories.get('a-container').files
+   # => [
+   #    <Fog::Storage::Softlayer::File
+   #  key="a-container/data.txt",
+   #  content_length=43,
+   #  content_type="text/plain",
+   #  content_disposition=nil,
+   #  etag="a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
+   #  last_modified=1970-00-00 00:00:00 -0000,
+   #  access_control_allow_origin=nil,
+   #  origin=nil
+   #  >
+   # ...
+  ```
+
+1. Get a signed [temporary] url for a file/object
+
+	```ruby
+	  file = @sl.directories.get('a-container').files.get('data.txt')
+	  file.url(Time.now + 300) # url expires in 5 minutes
+	```
+	
+1. Delete files/objects from a directory/container.
+
+	```ruby
+		dir = @sl.directories('a-container')
+		dir.files.get('data.txt').destroy
+		dir.files.get('file-data.txt').destroy
+		dir.files.get('copy-of-data.txt').destroy
+		# Must destroy all files/objects before destroying container.
+		dir.destroy
+	```
+	
+