README.md in ecircle-0.1.0 vs README.md in ecircle-0.1.1
- old
+ new
@@ -10,74 +10,33 @@
The API coverage is far from complete, however as far as I can see the most useful / frequent methods are covered.
The existing API methods can be considered stable and are used in production.
-Features
--------------
-
-###Synchronous API
-
-The following methods are implemented:
-
-* createMember
-* createOrUpdateGroup
-* createOrUpdateUserByEmail
-* deleteGroup
-* deleteMember
-* logon (only for debugging purposes)
-* logout
-* sendParametrizedSingleMessageToUser
-
-See the [online API documentation](http://rubydoc.info/github/troessner/ecircle/master/frames) for details on arguments and return values
-
-###Asnchronous API
-
-Since the asynchronous API is neither documented by ecircle nor intuitive at all, you're on your own. Jump to the examples section and good luck.
-
-To do
--------------
-
-* Fix TODOs in source code
-* Implement missing API methods:
- * deleteUser
- * deleteUserByEmail
- * lookupGroups
-* Write specs
-
-
Installation
-------------
Either as a gem:
gem install ecircle
or via Bundler by adding it to your Gemfile.
-
Configuration
-------------
Ecircle.configure do |config|
config.user = 'your@user.com'
config.sync_realm = 'http://your.realm.com'
config.password = 'your_password'
end
-
The reason for the unusual configuration setting "sync_realm" is that there is also an asynchronous ecircle API with a different realm.
-Logon
+Response handling
-------------
-The ecircle gem does the session handling for you, there is no need to logon explicitly.
-Session tokens will be re-used to keep the number of session related traffic to a minimum.
-
-Response
--------------
-
The ecircle gem will always return a wrapped response for all API methods, except for the logon method (see examples below or the API doc).
The wrapped response object is just a neat abstraction to hide Ecircle's horrible, horrible error handling from you and provides several methods for doing so.
The most usefull (and self-explanatory) would be:
@@ -85,18 +44,43 @@
* success?
* error_message
* fault_code
* ecircle_id IF the API returns an ID an success, e.g. for create_member and create_or_update_user_by_email
* convenience methods which depend on your (failed request), e.g.:
- * member_does_not_exist? (relevant for create_member requests)
- * TODO Explain all convenience methods.
+ * member_does_not_exist? (delete_member requests)
+ * message_id_does_not_exist? (send_parametrized_message_to_user requests)
+ * no_such_group? (create_member requests)
+ * no_such_user? (create_member_requests)
For details see [here](http://rubydoc.info/github/troessner/ecircle/master/Ecircle/WrappedResponse)
-Examples
+Features
-------------
+###Synchronous API
+
+The following methods are implemented:
+
+* createMember
+* createOrUpdateGroup
+* createOrUpdateUserByEmail
+* deleteGroup
+* deleteMember
+* logon (only for debugging purposes)
+* logout
+* sendParametrizedSingleMessageToUser
+
+See the [online API documentation](http://rubydoc.info/github/troessner/ecircle/master/frames) for details on arguments and return values
+
+###Asnchronous API
+
+Since the asynchronous API is neither documented by ecircle nor intuitive at all, you're on your own. Jump to the examples section and good luck.
+
+
+Using ecircle
+-------------
+
### Synchronous API
# Given you have called Ecircle.configure appropriatly...
# 1.) Create a user
@@ -152,9 +136,24 @@
:text => 'Newsletter text content',
:html => 'Newsletter html content'
}
Ecircle::JobPackage.send_async_message_to_group @options
+
+To do
+-------------
+
+* Implement missing API methods:
+ * deleteUser
+ * deleteUserByEmail
+ * lookupGroups
+* Write specs
+
+Logon
+-------------
+
+The ecircle gem does the session handling for you, there is no need to logon explicitly.
+Session tokens will be re-used to keep the number of session related traffic to a minimum.
Documentation
-------------
* [Online API Documentation](http://rubydoc.info/github/troessner/ecircle/master/frames)