Initial python 3 sdk for 3.4 API

Author: RachelTucker

.gitignore

@@ -0,0 +1,6 @@
+.idea/
+build/
+*.swp
+*.pyc
+*.py.bak
+*~

LICENSE.md

@@ -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 [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.

README.md

@@ -0,0 +1,81 @@
+Spectra S3 Python3 SDK
+--------------
+
+[![Apache V2 License](http://img.shields.io/badge/license-Apache%20V2-blue.svg)](https://github.com/SpectraLogic/ds3_python3_sdk/blob/master/LICENSE.md)
+
+An SDK conforming to the Spectra S3 [specification](https://developer.spectralogic.com/doc/ds3api/1.2/wwhelp/wwhimpl/js/html/wwhelp.htm) for Python 3.6
+
+Contact Us
+----------
+
+Join us at our [Google Groups](https://groups.google.com/d/forum/spectralogicds3-sdks) forum to ask questions, or see frequently asked questions.
+
+Installing
+----------
+
+To install the ds3_python3_sdk, either clone the latest code, or download a release bundle from [Releases](http://github.com/SpectraLogic/ds3_python3_sdk/releases).  Once the code has been download, cd into the bundle, and install it with `sudo python setup.py install`
+
+Once `setup.py` completes the ds3_python3_sdk should be installed and available to be imported into python scripts.
+
+Documentation
+-------------
+The documentation for the SDK can be found at [http://spectralogic.github.io/ds3_python3_sdk/sphinx/v3.0.0-beta/](http://spectralogic.github.io/ds3_python3_sdk/sphinx/v3.0.0-beta/)
+
+SDK
+---
+
+The SDK provides an interface for a user to add Spectra S3 functionality to their existing or new python application.  In order to take advantage of the SDK you need to import the `ds3` python package and module.  The following is an example that creates a Spectra S3 client from environment variables, creates a bucket, and lists all the buckets that are visible to the user.
+
+```python
+
+from ds3 import ds3
+
+client = ds3.createClientFromEnv()
+
+client.put_bucket(ds3.PutBucketRequest("TestBucket"))
+
+getServiceResponse = client.get_service(ds3.GetServiceRequest())
+
+for bucket in getServiceResponse.result['BucketList']:
+    print bucket['Name']
+```
+
+Ds3Client
+---------
+In the ds3_python3_sdk there are two ways that you can create a `Ds3Client` instance: environment variables, or manually.  `ds3.createClientFromEnv` will create a `Ds3Client` using the following environment variables:
+
+* `DS3_ENDPOINT` - The URL to the DS3 Endpoint
+* `DS3_ACCESS_KEY` - The DS3 access key
+* `DS3_SECRET_KEY` - The DS3 secret key
+* `http_proxy` - If set, the `Ds3Client` instance will proxy through this URL
+
+The `Ds3Client` instance can also be created manually in code with:
+
+```python
+
+from ds3 import ds3
+
+client = ds3.Ds3Client("endpoint", ds3.Credentials("access_key", "secret_key"))
+
+```
+
+The proxy URL can be passed in as the named parameter `proxy` to `Ds3Client()`.
+
+Putting Data
+------------
+
+To put data to a Spectra S3 appliance you have to do it inside of the context of what is called a Bulk Job.  Bulk Jobs allow the Spectra S3 appliance to plan how data should land to cache, and subsequently get written/read to/from tape.  The basic flow of every job is:
+
+* Generate the list of objects that will either be sent to or retrieved from Spectra S3
+* Send a bulk put/get to Spectra S3 to plan the job
+* The job will be split into multiple chunks.  An application must then get the available list of chunks that can be processed
+* For each chunk that can be processed, sent the object (this step can be done in parallel)
+* Repeat getting the list of available chunks until all chunks have been processed
+
+[An example of the above using the Python SDK for putting data] (samples/puttingData.py)
+
+[An example of getting data with the Python SDK] (samples/gettingData.py)
+
+[An example of using getService and getBucket to list all accessible buckets and objects] (samples/listAll.py)
+
+[An example of how give objects on the server a different name than what is on the filesystem, and how to delete objects by folder] (samples/renaming.py)

docker/Dockerfile

@@ -0,0 +1,16 @@
+FROM ubuntu:latest
+
+# Set the locale
+RUN locale-gen en_US.UTF-8
+ENV LANG='en_US.UTF-8' LANGUAGE='en_US:en' LC_ALL='en_US.UTF-8'
+
+# Combine all apt-get install commands or Docker will attempt to use cache
+RUN apt-get update && apt-get install -y \
+        git \
+        python \
+        python-dev \
+        vim
+
+ADD run_tests.sh /opt/
+
+ENTRYPOINT ["/opt/run_tests.sh"]

docker/README.md

@@ -0,0 +1,8 @@
+# ds3-python-docker
+A public docker file that has all the dependencies to build and develop the DS3 Python SDK
+
+To use this docker container, run the following command:
+
+`sudo docker run -it spectralogic/ds3_c_docker`
+
+This will start the container with an interactive bash shell which will allow you to clone the ds3_c_sdk and then build it.

docker/run_docker.rb

@@ -0,0 +1,74 @@
+require "faraday"
+require "json"
+
+ENV["DS3_ENDPOINT"] = ENV["DS3_ENDPOINT"] || "sm2u-11"
+
+# Has to be to https and not http.
+connection = Faraday.new(:url =>  "https://#{ENV["DS3_ENDPOINT"]}-mgmt.eng.sldomain.com",
+                                            # Don't worry about verifying the SSL certificate.
+                                            :ssl => { :verify => false }) do |conn|
+  conn.request(:basic_auth, "spectra", "spectra")
+  # User Ruby's net/http library
+  conn.adapter(:net_http)
+  # Setup for JSON requests and responses.
+  conn.headers = { "Accept" => "application/json",
+                   "Content-Type" => "application/json" }
+end
+
+# List all users
+response = connection.get("/api/users")
+# All GET responses are under a root "data"
+users = JSON.parse(response.body)["data"]
+
+spectra_user = {}
+users.each do | user_entry |
+  spectra_user = user_entry if user_entry["name"].eql?("Spectra")
+end
+
+# None of the "/api/users" responses include the S3 keys.  For that, you have to
+# make a separate "/api/ds3/keys" request which is setup to return an array
+# of DS3 authid/secretkey pairs in case we ever allow more than one pair per
+# user.
+response = connection.get("/api/ds3/keys?user_id=#{spectra_user["id"]}")
+spectra_user_keys = JSON.parse(response.body)["data"][0]
+abort("Spectra User Keys not found.") if spectra_user.keys.nil?
+
+ENV["DS3_ENDPOINT"] = "#{ENV['DS3_ENDPOINT']}.eng.sldomain.com"
+ENV["DS3_SECRET_KEY"] = spectra_user_keys["secret_key"]
+ENV["DS3_ACCESS_KEY"] = spectra_user_keys["auth_id"]
+puts "DS3_ENDPOINT #{ENV["DS3_ENDPOINT"]}"
+puts "DS3_SECRET_KEY #{ENV["DS3_SECRET_KEY"]}"
+puts "DS3_ACCESS_KEY #{ENV["DS3_ACCESS_KEY"]}"
+
+ENV["GIT_REPO"] = ENV["GIT_REPO"] || "https://github.com/SpectraLogic/ds3_python3_sdk.git"
+ENV["GIT_BRANCH"] = ENV["GIT_BRANCH"] || "3_4_0_autogen"
+puts "GIT_REPO #{ENV["GIT_REPO"] || "default"}"
+puts "GIT_BRANCH #{ENV["GIT_BRANCH"]}"
+
+ENV["DOCKER_REPO"] =  ENV["DOCKER_REPO"] || "spectralogic/ds3_python_docker_test:latest"
+puts "DOCKER_REPO #{ENV["DOCKER_REPO"]}"
+ 
+# Close the git repo
+puts `git clone #{ENV["GIT_REPO"]} --branch #{ENV["GIT_BRANCH"]} --single-branch`
+
+# Build latest docker image
+puts "docker build -t #{ENV['DOCKER_REPO']} ./ds3_python3_sdk/docker/"
+docker_build_output = `docker build -t #{ENV["DOCKER_REPO"]} ./ds3_python3_sdk/docker/`
+docker_build_status = $?
+puts docker_build_output
+puts "docker build status[#{docker_build_status}][#{docker_build_status.exitstatus}]"
+
+# Run the tests in the updated docker container
+puts "docker run -e DS3_ENDPOINT -e DS3_SECRET_KEY -e DS3_ACCESS_KEY -e GIT_REPO -e GIT_BRANCH --dns=10.1.0.9 #{ENV["DOCKER_REPO"]}"
+output = `docker run -e DS3_ENDPOINT -e DS3_SECRET_KEY -e DS3_ACCESS_KEY -e GIT_REPO -e GIT_BRANCH --dns=10.1.0.9 #{ENV["DOCKER_REPO"]}`
+
+docker_status = $?
+
+puts output
+puts "docker status[#{docker_status}][#{docker_status.exitstatus}]"
+
+
+# clean up git repo
+puts `rm -rf ds3_python3_sdk`
+
+exit docker_status.exitstatus