Release 0.4.4

Author: mkrogemann

Changelog.md

@@ -1,3 +1,9 @@
+Version 0.4.4 - released 2017-01-08
+-------------
+
+- Improved authentication handling: You can now add basic auth credentials to db properties, eliminating need to authenticate each function call. Thanks to @leifg
+- This change makes a number of authenticated functions redundant. These functions have been deprecated and will be removed in release version 0.5
+
 Version 0.4.3 - released 2016-12-21
 -------------
 

README.md

@@ -30,8 +30,7 @@ The connector also offers functions to manage users and admins. These functions
 have been implemented to support testing of authentication and most users will
 probably manage users through different tools.
 
-Basic access authentication (basic auth) is currently the only supported
-authentication scheme.
+HTTP Basic access authentication (Basic auth) is currently the only supported authentication scheme.
 
 ## Supported platforms
 
@@ -45,7 +44,7 @@ The module is [available in Hex](https://hex.pm/packages/couchdb_connector), the
 
 ```Elixir
 def deps do
-  [{:couchdb_connector, "~> 0.4.3"}]
+  [{:couchdb_connector, "~> 0.4.4"}]
 end
 ```
 
@@ -65,6 +64,16 @@ For the subsequent steps, let's assume that we work in iex and that we define th
 db_props = %{protocol: "http", hostname: "localhost", database: "couchdb_connector_dev", port: 5984}
 ```
 
+### Authentication
+
+HTTP Basic authentication was first introduced in release version 0.3. Some versions and improvements later, the current best practice is to put the Basic auth credentials into the database properties like so:
+
+```Elixir
+db_props = %{protocol: "http", hostname: "localhost", database: "couchdb_connector_dev", port: 5984, user: "username", password: "secret"}
+```
+
+Support for this configuration feature has been introduced in release version 0.4.4. It relieves users from having to add the credentials to each authenticated function call. Authentication can now be dealt with once and in one place only.
+
 ### Create a database
 
 ```Elixir
@@ -254,8 +263,6 @@ The response would look similar to this:
      "rev" => "2-7b2f4edf07..."}}}
 ```
 
-Basic authentication is also supported for this update API.
-
 ### Delete a document
 
 In order to delete a document, you have to pass in its current revision, the same way that you saw above for the update calls.
@@ -272,12 +279,6 @@ You should see a response like this:
 "{\"ok\":true,\"id\":\"42\",\"rev\":\"2-9b2e3bcc3752a3...\"}\n"
 ```
 
-Basic authentication information need to be put in the database properties:
-
-```Elixir
-db_props = %{protocol: "http", hostname: "localhost", database: "couchdb_connector_dev", port: 5984, user: "admin", password: "secret"}
-```
-
 ### Delete a document — Response wrapped in a Map
 
 Since release 0.4.2, there is also an implementation of the delete functionality in place that wraps the resopnse in a Map. It is located in the top level module Couchdb.Connector and its API is identical to the JSON/String version:

mix.exs

@@ -4,7 +4,7 @@ defmodule Couchdb.Connector.Mixfile do
   def project do
     [
       app: :couchdb_connector,
-      version: "0.4.3",
+      version: "0.4.4",
       elixir: "~> 1.2",
       build_embedded: Mix.env == :prod,
       start_permanent: Mix.env == :prod,