prepare release 0.1.0

CHANGES.txt

@@ -2,13 +2,20 @@
 CHANGES for craterl
 ===================
 
-Unreleased
-==========
+2014/12/02 0.1.0
+================
 
- - support for downloading blobs, base64 encoded to stdout or to a file.
-   api is
+ - execute requests in the calling process, no supervising.
+   This is the job of the application using craterl
+
+ - support for sql bulk operations
+
+ - creating many clients per erlang node is possible
+   using a variant of ``craterl:new()``
 
-.. code-block:: erlang
+ - support for putting, deleting blobs and to check for existence
+
+ - support for downloading blobs, base64 encoded to stdout or to a file.
 
-    craterl:blob_get(BlobTable, HexDigest).
-    craterl:blob_get_to_file(BlobTable, HexDigest, FilePath).
+ - support for executing arbitrary sql requests with or without parameters
+   (pure erlang terms)

devtools/create_tag.sh

@@ -0,0 +1,84 @@
+#!/bin/bash
+
+
+# Licensed to CRATE Technology GmbH ("Crate") under one or more contributor
+# license agreements.  See the NOTICE file distributed with this work for
+# additional information regarding copyright ownership.  Crate licenses
+# this file to you 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.
+#
+# However, if you have executed another commercial license agreement
+# with Crate these terms will supersede the license and you may use the
+# software solely pursuant to the terms of the relevant commercial agreement.
+
+# Info: Be aware from where you are invoking this script due to relative paths.
+#       For example, 'gradlew' has to be in the same directory as where you are
+#       invoking this script from.
+#       E.g.: ../crate>./devtools/create_tag.sh
+
+# check if everything is committed
+CLEAN=`git status -s`
+if [ ! -z "$CLEAN" ]
+then
+   echo "Working directory not clean. Please commit all changes before tagging"
+   echo "Aborting."
+   exit -1
+fi
+
+echo "Fetching origin..."
+git fetch origin > /dev/null
+
+# get current branc
+BRANCH=`git branch | grep "^*" | cut -d " " -f 2`
+echo "Current branch is $BRANCH."
+
+# check if BRANCH == origin/BRANCH
+LOCAL_COMMIT=`git show --format="%H" $BRANCH`
+ORIGIN_COMMIT=`git show --format="%H" origin/$BRANCH`
+
+if [ "$LOCAL_COMMIT" != "$ORIGIN_COMMIT" ]
+then
+   echo "Local $BRANCH is not up to date. "
+   echo "Aborting."
+   exit -1
+fi
+
+# check for version
+if [ "x$VERSION" == "x" ]
+then
+    echo "VERSION not set. abort."
+    exit 1
+fi
+
+# check if tag to create has already been created
+EXISTS=`git tag | grep $VERSION`
+
+if [ "$VERSION" == "$EXISTS" ]
+then
+   echo "Revision $VERSION already tagged."
+   echo "Aborting."
+   exit -1
+fi
+
+# check if VERSION is in head of CHANGES.txt
+REV_NOTE=`grep "[0-9/]\{10\} $VERSION" CHANGES.txt`
+if [ -z "$REV_NOTE" ]
+then
+    echo "No notes for revision $VERSION found in CHANGES.txt"
+    echo "Aborting."
+    exit -1
+fi
+
+echo "Creating tag $VERSION..."
+git tag -a "$VERSION" -m "Tag release for revision $VERSION"
+git push --tags
+echo "Done."

doc/README.md

@@ -1,6 +1,33 @@
 
 
-# The craterl application #
+# craterl, a client library for Crate #
+
+Copyright (c) (C) 2014, CRATE Technology GmbH
+
+Licensed to CRATE Technology GmbH ("Crate") under one or more contributor
+license agreements. See the NOTICE file distributed with this work for
+additional information regarding copyright ownership. Crate licenses
+this file to you 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.
+
+However, if you have executed another commercial license agreement
+with Crate these terms will supersede the license and you may use the
+software solely pursuant to the terms of the relevant commercial agreement.
+
+
+__Version:__ 0.1.0
+
+__Authors:__ Matthias Wahl ([`[email protected]`](mailto:[email protected])), Peter Sabaini ([`[email protected]`](mailto:[email protected])).
+Craterl is the erlang client for the crate datastore.
 
 
 ## Modules ##

doc/overview.edoc

@@ -0,0 +1,29 @@
+@author Matthias Wahl <[email protected]>
+@author Peter Sabaini <[email protected]>
+@copyright (C) 2014, CRATE Technology GmbH
+
+Licensed to CRATE Technology GmbH ("Crate") under one or more contributor
+license agreements. See the NOTICE file distributed with this work for
+additional information regarding copyright ownership. Crate licenses
+this file to you 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.
+
+However, if you have executed another commercial license agreement
+with Crate these terms will supersede the license and you may use the
+software solely pursuant to the terms of the relevant commercial agreement.
+
+@version 0.1.0
+@title craterl, a client library for Crate
+
+@doc
+
+Craterl is the erlang client for the crate datastore.

src/craterl.app.src

@@ -1,9 +1,19 @@
 {application, craterl,
  [
-  {description, "erlang client for crate data"},
-  {vsn, "0.0.1"},
+  {description, "erlang client for crate"},
+  {vsn, "0.1.0"},
   {registered, []},
-  {modules, []},
+  {modules, [
+    bin_to_hex,
+    craterl,
+    craterl_blob,
+    craterl_config,
+    craterl_gen_server,
+    craterl_hash,
+    craterl_sql,
+    craterl_sup,
+    craterl_url
+  ]},
   {applications, [
                   kernel,
                   stdlib,