Added all non-Java examples

Author: csiebler

.gitignore

@@ -0,0 +1,42 @@
+*.gem
+*.rbc
+.DS_Store
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/chargeback/*.csv
+
+## Java specific ignores
+.gradle/
+.settings/
+.classpath
+.project
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

README.md

@@ -0,0 +1,15 @@
+# StorageGRID Webscale Code Examples
+
+This repository contains short code examples on how to use NetApp StorageGRID Webscale's API endpoints (S3 and Swift).
+
+## Examples
+* S3 via Ruby (using AWS SDK for Ruby Version 2)
+* S3 via Python (using Boto 3)
+* S3 via Java (using AWS SDK for Java)
+* Swift via Python (using phyton-swiftclient)
+
+More will follow!
+
+## Compatibility
+All shown examples are compatible with StorageGRID Webscale 10.2 (GA Release). For older versions, please switch to the different branches.
+

s3-python/examples.py

@@ -0,0 +1,67 @@
+import boto3
+import boto3.session
+
+session = boto3.session.Session(profile_name='my_profile')
+endpoint = 'https://s3.mycompany.com:8082'
+
+'''
+Do not use this in production - disabling SSL verification is discouraged!
+When using a self-signed certificate, make sure to pass it into the constructor:
+
+s3 = session.resource(service_name='s3', endpoint_url=endpoint, verify='server_cert.pem')
+'''
+
+s3 = session.resource(service_name='s3', endpoint_url=endpoint, verify=False)
+client = s3.meta.client
+
+'''
+Bucket related operations
+'''
+
+# Create new bucket for S3 account
+s3.Bucket('my-bucket').create()
+
+# List all buckets for S3 account
+for bucket in s3.buckets.all():
+    print(bucket.name)
+
+# Delete bucket
+s3.Bucket('my-bucket').delete()
+
+'''
+Object related operations
+'''
+
+# Put a new object to a bucket
+obj = s3.Object('test', 'my-key')
+obj.put(Body='This is my object\'s data',
+        Metadata={'customerid': '1234', 'location': 'germany'},
+        ServerSideEncryption='AES256')
+
+# Put object directly from a file
+#obj.upload_file('source-file', ExtraArgs={'Metadata': {'customer_id': '42'}, 'ServerSideEncryption': 'AES256'})
+
+# Get an object directly to a file
+#obj.download_file('target-file')
+
+# Copy an existing object
+copied_obj = s3.Object('test', 'my-copied-key')
+copied_obj.copy_from(CopySource='/test/my-key')
+
+# Get object from bucket
+response = obj.get()
+data = response['Body'].read()
+metadata = response['Metadata']
+print("Data: %s // Metadata: %s" % (data, metadata))
+
+# List all objects for a bucket
+for obj in s3.Bucket('test').objects.all():
+    print(obj.key)
+
+# Generate a pre-signed URL (only possible via client, not directly via Object object)
+url = client.generate_presigned_url('get_object', {'Bucket': 'test', 'Key': 'my-key'}, ExpiresIn=3600)
+print("Pre-signed URL: %s" % (url))
+
+# Delete the object from its bucket
+obj.delete()
+

s3-ruby/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'aws-sdk', '~> 2'

s3-ruby/Gemfile.lock

@@ -0,0 +1,23 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aws-sdk (2.0.28)
+      aws-sdk-resources (= 2.0.28)
+    aws-sdk-core (2.0.28)
+      builder (~> 3.0)
+      jmespath (~> 1.0)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+    aws-sdk-resources (2.0.28)
+      aws-sdk-core (= 2.0.28)
+    builder (3.2.2)
+    jmespath (1.0.2)
+      multi_json (~> 1.0)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aws-sdk (~> 2)

s3-ruby/examples.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+require 'aws-sdk'
+
+endpoint = 'https://s3.mycompany.com:8082'
+credentials = Aws::SharedCredentials.new(profile_name: 'my_profile')
+
+# Notes on certificate usage with StorageGRID Webscale
+# ----------------------------------------------------
+# Set ssl_verfiy_peer to true if StorageGRID's certificate is CA-signed or if you want to use a self-signed certificate
+# If you use a self-signed certificate, set ssl_ca_bundle to the self-signed certificate
+
+client = Aws::S3::Client.new(region: 'us-east-1',
+    endpoint: endpoint,
+    credentials: credentials,
+    force_path_style: true,
+    ssl_verify_peer: false,
+    #ssl_ca_bundle: 'server_cert.crt'
+)
+
+# Use resource style access
+s3 = Aws::S3::Resource.new(client: client)
+
+# Bucket related operations
+# -------------------------
+
+# List buckets
+s3.buckets.each do |bucket|
+    puts "Bucket: #{bucket.name}"
+    puts " -> created: #{bucket.creation_date}"
+end
+
+# Create bucket
+s3.bucket('new-bucket').create
+
+# Delete bucket
+s3.bucket('new-bucket').delete
+
+# Object related operations
+# -------------------------
+
+# Create Object
+s3.bucket('test').object('my_object').put(
+    metadata: {
+        'mykey1' => 'myvalue1',
+        'mykey2' => 'myvalue2'
+    },
+    body: 'Hello, I\'m the object\'s data!',
+    # encrypt object if desired
+    server_side_encryption: 'AES256'
+)
+
+# Copy existing Object
+s3.bucket('test').object('copied_object').copy_from('test/my_object')
+
+# List objects
+s3.bucket('test').objects.each do |object|
+    puts "Object key: #{object.key}"
+    puts " -> Size: #{object.size} bytes"
+    puts " -> Last modified: #{object.last_modified}"
+end
+
+# Get object
+get_response = s3.bucket('test').object('my_object').get
+puts "Object content: #{get_response.body.string}"
+
+# Get only bytes 15 to 20 of the object
+get_response = s3.bucket('test').object('my_object').get({
+  range: "bytes=15-20"
+})
+puts "Object byte 15-20 content: #{get_response.body.string}"
+
+# Get object metadata and size
+metadata = s3.bucket('test').object('my_object').metadata
+size = s3.bucket('test').object('my_object').content_length
+puts "Object metadata: #{metadata}"
+puts "Object content length: #{size}"
+
+# Generate a pre-signed URL that is valid for one hour
+url = s3.bucket('test').object('my_object').presigned_url(:get, expires_in: 3600)
+puts url
+
+# Delete object
+s3.bucket('test').object('my_object')

swift-python/README.md

@@ -0,0 +1,5 @@
+# Prerequisites
+
+This examples requires swiftclient, which can be installed via:
+
+`sudo pip install python-swiftclient`

swift-python/examples.py

@@ -0,0 +1,67 @@
+import swiftclient
+
+username = '57347988074919328399:swiftadmin'
+password = 'supersecret'
+authurl = 'https://swift.mycompany.com:8083/auth/v1.0'
+
+swift = swiftclient.client.Connection(auth_version='1', user=username, key=password, insecure=True, authurl=authurl)
+
+'''
+If you are using self-signed certificates, you can use the following code:
+
+cacert = '/path/to/server/cert'
+swift = swiftclient.client.Connection(auth_version='1', user=username, key=password, cacert=cacert, authurl=authurl)
+'''
+
+container = 'test-container'
+obj_key = 'test-object'
+
+# Get authentication information
+print(swift.get_auth())
+
+# Create container
+swift.put_container(container)
+
+# List all containers and account information
+response = swift.get_account()
+account_info = response[0]
+containers = response[1]
+
+print "Bytes used by account: ", account_info['x-account-bytes-used']
+print "Number of containers in account: ", account_info['x-account-container-count']
+print "Number of objects in account: ", account_info['x-account-object-count']
+
+for c in containers:
+    name = c['name']
+    num_objects = c['count']
+    size = c['bytes']
+    print("Container name: %s (total: %s objects, %s bytes)" % (name, num_objects, size))
+
+# Get information of a single container
+response = swift.get_container(container)
+print "Container: ", response
+
+# Put object into container
+swift.put_object(container, obj_key,
+    contents='This is my object\'s content',
+    headers={'X-Object-Meta-CustomerID':'42',
+             'X-Object-Meta-Color':'red'})
+
+# List contents of a container
+for obj in swift.get_container(container)[1]:
+    print "Object key: ", obj['name']
+    print "Object size: ", obj['bytes']
+    print "Object last modified: ", obj['last_modified']
+
+# Get object from container
+response = swift.get_object(container, obj_key)
+object_headers = response[0]
+object_content = response[1]
+print "Object headers: ", object_headers
+print "Object content: ", object_content
+
+# Delete object
+swift.delete_object(container, obj_key)
+
+# Delete container
+swift.delete_container(container)