Adds support for Stocator driver (swift2d).

Author: Adam Cox

CHANGES.rst

@@ -1,3 +1,8 @@
+0.0.1b0 (2016-03-17)
+====================
+
+- [NEW] Added support for Stocator driver to connect to Swift Object Stores
+
 0.0.1a1 (2016-03-02)
 ====================
 

README.md

@@ -4,6 +4,8 @@ Use this when trying to access data on either a Softlayer or Bluemix ObjectStore
 
 
 ### Bluemix
+
+#### Using Swift Driver
 ```python
 import ibmos2spark as os2s
 
@@ -26,8 +28,35 @@ bmos = os2s.bluemix(sc, credentials)  #sc is the SparkContext instance
 data = sc.textFile(bmos.url(container_name, file_name))
 ```
 
+#### Using Stocator (Swift2d) Driver
+
+```python
+import ibmos2spark as os2s
+
+#To obtain these credentials in IBM Spark, click the "insert to code" 
+#button below your data source found on the panel to the right of your notebook.
+
+credentials = {
+  'auth_url': 'https://identity.open.softlayer.com',  #your URL might be different
+  'project_id': 'sssssssss',
+  'region': 'dallas',
+  'user_id': 'uuuuuuuuuuu',
+  'username': 'uuuuuuuuuuu',
+  'password': 'ppppppppppp',
+}
+
+credentials['name'] = 'my_bluemix_os'  #you can give any name you like
+
+bmos = os2s.bluemix2d(sc, credentials)  #sc is the SparkContext instance
+
+data = sc.textFile(bmos.url(container_name, file_name))
+```
+
 
 ### Softlayer
+
+#### Using Swift Driver
+
 ```python
 import ibmos2spark as os2s
 
@@ -41,3 +70,17 @@ slos = os2s.softlayer(sc, "my_softlayer_os", auth_url, username, password)
 data = sc.textFile(slos.url(container_name, file_name))
 ```
 
+#### Using Stocator (Swift2d) Driver
+
+```python
+import ibmos2spark as os2s
+
+#you need to know the credentials to your Softlayer ObjectStore.
+
+#sc is the SparkContext instance
+#you can give any name you like
+
+slos = os2s.softlayer2d(sc, "my_softlayer_os", auth_url, tenant, username, password)
+
+data = sc.textFile(slos.url(container_name, file_name))
+```

ibmOS2Spark/osconfig.py

@@ -20,6 +20,9 @@
 def swifturl(name, container_name, object_name):
   return 'swift://{}.{}/{}'.format(container_name, name, object_name)
 
+def swifturl2d(name, container_name, object_name):
+  return 'swift2d://{}.{}/{}'.format(container_name, name, object_name)
+
 class softlayer(object):
 
   def __init__(self, sparkcontext, name, auth_url, username, password):
@@ -47,7 +50,36 @@ def __init__(self, sparkcontext, name, auth_url, username, password):
 
   def url(self, container_name, object_name):
     return swifturl(self.name, container_name, object_name)
-    
+
+class softlayer2d(object):
+
+  def __init__(self, sparkcontext, name, auth_url, tenant, username, password):
+    '''
+    sparkcontext is a SparkContext object.
+    name is a string that can be anything other than an empty string.
+    auth_url, username and password are string credentials for your
+    Softlayer Objectstore
+
+    '''
+    self.name = name
+
+    prefix = "fs.swift2d.service." + name 
+    hconf = sparkcontext._jsc.hadoopConfiguration()
+    hconf.set(prefix + ".auth.url", auth_url)
+    hconf.set(prefix + ".username", username)
+    hconf.set(prefix + ".tenant", tenant)
+    hconf.set(prefix + ".auth.endpoint.prefix", "endpoints")
+    hconf.set(prefix + ".auth.method", "swiftauth")
+    hconf.setInt(prefix + ".http.port", 8080)
+    hconf.set(prefix + ".apikey", password)
+    hconf.setBoolean(prefix + ".public", True) 
+    hconf.set(prefix + ".use.get.auth", "true")
+    hconf.setBoolean(prefix + ".location-aware", False)
+    hconf.set(prefix + ".password", password)
+
+  def url(self, container_name, object_name):
+    return swifturl2d(self.name, container_name, object_name)
+
 class bluemix(object):
 
   def __init__(self, sparkcontext, credentials):
@@ -84,3 +116,40 @@ def __init__(self, sparkcontext, credentials):
   def url(self, container_name, object_name):
     return swifturl(self.name, container_name, object_name)
 
+class bluemix2d(object):
+
+  def __init__(self, sparkcontext, credentials):
+    '''
+    sparkcontext is a SparkContext object.
+
+    credentials is a dictionary with the following required keys:
+      name
+      auth_url
+      project_id
+      user_id
+      password
+      region
+
+    When using this from a IBM Spark service instance that
+    is configured to connect to particular Bluemix object store
+    instances, the values for these credentials can be obtained 
+    by clicking on the 'insert to code' link just below a data
+    source. 
+    '''
+    self.name = credentials['name']
+
+
+    prefix = "fs.swift2d.service." + credentials['name'] 
+    hconf = sparkcontext._jsc.hadoopConfiguration()
+    hconf.set(prefix + ".auth.url", credentials['auth_url']+'/v3/auth/tokens')
+    hconf.set(prefix + ".auth.endpoint.prefix", "endpoints")
+    hconf.set(prefix + ".auth.method","keystoneV3 ")
+    hconf.set(prefix + ".tenant", credentials['project_id'])
+    hconf.set(prefix + ".username", credentials['user_id'])
+    hconf.set(prefix + ".password", credentials['password'])
+    hconf.setInt(prefix + ".http.port", 8080)
+    hconf.set(prefix + ".region", credentials['region'])
+    hconf.setBoolean(prefix + ".public", True)
+
+  def url(self, container_name, object_name):
+    return swifturl2d(self.name, container_name, object_name)

setup.py

@@ -27,7 +27,7 @@
     'include_package_data': True,
     'install_requires': [],
     'name': 'ibmos2spark',
-    'version': '0.0.1a1',
+    'version': '0.0.1b0',
     'author': 'gadamc',
     'author_email': '[email protected]',
     'url': 'https://github.com/gadamc/ibmos2spark',