[ckan-changes] commit/ckanext-storage: 2 new changesets

• Previous message: [ckan-changes] commit/ckan: John Lawrence Aspden: [authz][s]: fix broken test
• Next message: [ckan-changes] commit/ckanext-storage: rgrp: [doc][s]: improve doc of metadata api and do some tidying.
• Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]

2 new changesets in ckanext-storage:

http://bitbucket.org/okfn/ckanext-storage/changeset/749e16883f69/
changeset:   r24:749e16883f69
user:        rgrp
date:        2011-05-13 21:17:31
summary:     [doc][xs]: rename README to rst.
affected #:  2 files (1.0 KB)

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.rst	Fri May 13 20:17:31 2011 +0100
@@ -0,0 +1,43 @@
+This extension adds:
+
+  * Some new methods to the CKAN API for dealing with storage
+  * An /upload page to web interface for doing file uploads
+  
+It uses OFS to talk to the backing storage so can support anything that OFS
+supports including local filesytem, S3, Google Storage etc.
+
+In your config you need something like::
+
+   ckan.plugins = storage
+   # this is for google storage
+   ofs.impl = google
+   ofs.gs_access_key_id = GOOGCABCDASDASD
+   ofs.gs_secret_access_key = 134zsdfjkw4234addad
+
+Then there will some new API methods::
+
+     /api/storage/metadata/<bucket>/<label>
+     /api/storage/auth/{type}/<bucket>/<label>
+
+And a new upload page at /upload.
+
+Metadata API
+------------
+
+     /api/storage/metadata/<label>
+
+  * GET will return the metadata
+  * POST will add/update metadata
+  * PUT will replace metadata
+
+
+Auth API
+--------
+
+Get credentials for doing operations on storage (usually directly)::
+
+    /api/storage/auth/{request|form}/{label}
+
+Details in docstrings in ckanext/storage/controller.py or by visiting
+api/storage when running this extension.
+


--- a/README.txt	Fri Apr 29 20:16:16 2011 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,43 +0,0 @@
-This extension adds:
-
-  * Some new methods to the CKAN API for dealing with storage
-  * An /upload page to web interface for doing file uploads
-  
-It uses OFS to talk to the backing storage so can support anything that OFS
-supports including local filesytem, S3, Google Storage etc.
-
-In your config you need something like::
-
-   ckan.plugins = storage
-   # this is for google storage
-   ofs.impl = google
-   ofs.gs_access_key_id = GOOGCABCDASDASD
-   ofs.gs_secret_access_key = 134zsdfjkw4234addad
-
-Then there will some new API methods::
-
-     /api/storage/metadata/<bucket>/<label>
-     /api/storage/auth/{type}/<bucket>/<label>
-
-And a new upload page at /upload.
-
-Metadata API
-------------
-
-     /api/storage/metadata/<label>
-
-  * GET will return the metadata
-  * POST will add/update metadata
-  * PUT will replace metadata
-
-
-Auth API
---------
-
-Get credentials for doing operations on storage (usually directly)::
-
-    /api/storage/auth/{request|form}/{label}
-
-Details in docstrings in ckanext/storage/controller.py or by visiting
-api/storage when running this extension.
-


http://bitbucket.org/okfn/ckanext-storage/changeset/fc0080756c2e/
changeset:   r25:fc0080756c2e
user:        rgrp
date:        2011-05-13 21:58:08
summary:     [doc]: move all docs into README.rst and create sphinx docs at doc.
affected #:  4 files (8.0 KB)

--- a/README.rst	Fri May 13 20:17:31 2011 +0100
+++ b/README.rst	Fri May 13 20:58:08 2011 +0100
@@ -1,7 +1,11 @@
+======================
+CKAN Storage Extension
+======================
+
 This extension adds:
 
   * Some new methods to the CKAN API for dealing with storage
-  * An /upload page to web interface for doing file uploads
+  * A /storage/upload page to web interface for doing file uploads
   
 It uses OFS to talk to the backing storage so can support anything that OFS
 supports including local filesytem, S3, Google Storage etc.
@@ -13,31 +17,73 @@
    ofs.impl = google
    ofs.gs_access_key_id = GOOGCABCDASDASD
    ofs.gs_secret_access_key = 134zsdfjkw4234addad
+   ckanext.storage.bucket = the bucket to use for uploading
+   ckanext.storage.max_content_length = [optional] maximum content size for uploads (defaults to 50Mb)
 
-Then there will some new API methods::
 
-     /api/storage/metadata/<bucket>/<label>
-     /api/storage/auth/{type}/<bucket>/<label>
+Upload Web Interface
+====================
 
-And a new upload page at /upload.
+There will be a new upload page at /storage/upload. 
 
 Metadata API
-------------
+============
 
-     /api/storage/metadata/<label>
+     /api/storage/metadata/{label}
 
   * GET will return the metadata
   * POST will add/update metadata
   * PUT will replace metadata
 
+Metadata is a json dict like:
 
 Auth API
---------
+========
 
-Get credentials for doing operations on storage (usually directly)::
+Get credentials for doing operations on storage directly.
 
-    /api/storage/auth/{request|form}/{label}
 
-Details in docstrings in ckanext/storage/controller.py or by visiting
-api/storage when running this extension.
+/api/storage/auth/request/{label}
+---------------------------------
 
+Provide authentication information for a request so a client can
+interact with backend storage directly::
+
+    :param label: label.
+    :param kwargs: sent either via query string for GET or json-encoded
+        dict for POST). Interpreted as http headers for request plus an
+        (optional) method parameter (being the HTTP method).
+
+        Examples of headers are:
+
+            Content-Type
+            Content-Encoding (optional)
+            Content-Length
+            Content-MD5
+            Expect (should be '100-Continue')
+
+    :return: is a json hash containing various attributes including a
+    headers dictionary containing an Authorization field which is good for
+    15m.
+
+/api/storage/auth/form/{label}
+------------------------------
+
+Provide fields for a form upload to storage including authentication::
+
+    :param label: label.
+    :param kwargs: sent either via query string for GET or json-encoded
+        dict for POST. Possible key values are as for arguments to this
+        underlying method:
+        http://boto.cloudhackers.com/ref/s3.html?highlight=s3#boto.s3.connection.S3Connection.build_post_form_args
+
+    :return: json-encoded dictionary with action parameter and fields list.
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+


--- a/ckanext/storage/controller.py	Fri May 13 20:17:31 2011 +0100
+++ b/ckanext/storage/controller.py	Fri May 13 20:58:08 2011 +0100
@@ -247,16 +247,7 @@
 
 
 class StorageController(BaseController):
-    '''Upload to storage service (at the moment Google Developer storage.
-
-    Required config:
-
-    * ofs.gs_access_key_id
-    * ofs.gs_secret_access_key
-    * ofs.gs_bucket [optional]: the bucket to use for uploading (defaults to
-      ckan)
-    * ckanext.upload.max_content_length [optional]: maximum content size for
-      uploads (defaults to 50Mb)
+    '''Upload to storage backend.
     '''
     ofs = get_ofs()
 
@@ -270,7 +261,7 @@
         authorize(method, BUCKET, label, c.userobj, self.ofs)
 
         content_length_range = int(
-                config.get('ckanext.upload.max_content_length',
+                config.get('ckanext.storage.max_content_length',
                     50000000))
         success_action_redirect = h.url_for('storage_upload_success', qualified=True,
                 bucket=BUCKET, label=label)


--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/conf.py	Fri May 13 20:58:08 2011 +0100
@@ -0,0 +1,194 @@
+# -*- coding: utf-8 -*-
+#
+# CKAN Storage Extension documentation build configuration file, created by
+# sphinx-quickstart on Fri May 13 20:30:37 2011.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.append(os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'CKAN Storage Extension'
+copyright = u'2011, CKAN (Open Knowledge Foundation)'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '1.0'
+# The full version, including alpha/beta/rc tags.
+release = '1.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = []
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_use_modindex = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'CKANStorageExtensiondoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'CKANStorageExtension.tex', u'CKAN Storage Extension Documentation',
+   u'CKAN (Open Knowledge Foundation)', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True


--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/index.rst	Fri May 13 20:58:08 2011 +0100
@@ -0,0 +1,1 @@
+../README.rst
\ No newline at end of file

Repository URL: https://bitbucket.org/okfn/ckanext-storage/

--

This is a commit notification from bitbucket.org. You are receiving
this because you have the service enabled, addressing the recipient of
this email.

• Previous message: [ckan-changes] commit/ckan: John Lawrence Aspden: [authz][s]: fix broken test
• Next message: [ckan-changes] commit/ckanext-storage: rgrp: [doc][s]: improve doc of metadata api and do some tidying.
• Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]