Changelog.markdown

Changelog for diaspy, unofficial DIASPORA* interface for Python

This changelog file follows few rules:

• rem: indicates removed features,
• new: indicates new features,
• upd: indicates updated features,
• dep: indicates deprecated features,

Deprecation means that in the next version feature will be removed.

Also, after every version there should be a brief note describing possible problems with migrating to it from older versions and usage of new features.

Users can always read the manual and dcumentation to make themselves more knowledgeable and are encouraged to do so. They only need to remember that documentation is usually more up-to-date than manual and if conflicts appear they should follow the order:

docstrings -> docs/ -> manual/

---

Known issues

• bug: diaspy has problems/can't connect to pods using SNI (this is an issue with requests/urllib3/python),

---

Version 0.6.0

In this release some bugs due to Diaspora changes where adressed, it also contains some new functionality. Also if BeautifulSoup4 is installed it will use it instead of the regex solution where possible. Also some manual adjustments.

IMPORTANT: python-dateutil is a requirement now.

Note: In this version indentation changed from spaces to tabs.

• upd: diaspy.people.User()'s fetchguid() method can now be called with a parameter (bool), if set False it won't fetch the stream but only userdata, default it still does.,

• upd: diaspy.people.User() has new methods getPhotos() and deletePhoto(),

• upd: Aspect id is now removed from diaspy.people.User() object when removed,

• upd: diaspy.people.Contacts() it's get() method has the page parameter now,

• upd: It is now optional to automatic fetch contacts for diaspy.people.Contacts(), default it won't,

• upd: diaspy.models.Notification()'s who() method now return whole guids instead of partial guids,

• upd: Update diaspy.models.Post() it's interaction data after liked,

• upd: diaspy.connection.Connection()'s getUserData() method will now set the Connection() object it's self._userdata,

• upd: Posts obtained by diaspy.streams.Generic() are now fetched once instead of twice,

• upd: tests.py,

• fix: Streams seemed to miss posts on more() method, should be fixed now. Also a new dependency: dateutil,

• fix: Fixes diaspy.streams.Generic()'s more() and update() methods and adds id to posts,

• fix: diaspy.streams.Aspect() its filter() method,

• fix: diaspy.models.Notification()'s who() method it's regex pattern didn't always match, now it should,

• fix: diaspy.models.Aspect() its addUser() method did cause CSRF errors,

• fix: diaspy.people.User() its getHCard(),

• new: diaspy.errors.SearchError() and diaspy.errors.TagError(),

• new: update() and more() methods for diaspy.notifications.Notifications,

• new: removeAspect() method in diaspy.models.Aspect(),

• new: diaspy.models.Comments() class,

• new: diaspy.models.Conversation() has new methods messages() and update_messages(), it is also posible to call len() and iterate over the object,

• new: diaspy.models.Post()'s comments object is now a Comments() object instead of a dict (parsed json),

• new: diaspy.models.Post() has some new methods: vote_poll(), hide(), mute(), subscribe() and unsubscribe(),

• new: It is now possible to set diaspy.people.User() it's data manual by the data parameter,

• new: diaspy.people.Contacts() has new methods add() and remove() wich can add/remove a user to/from an aspect,

• new: Added BeautifulSoup4 (optional) support where possible instead of regex, kept regex as fallback,

• new: diaspy.connection.Connection().podswitch() has now a optional param login with as default set to True, if False it will only set the data and does not call login(),

• rem: _obtain() from diaspy.streams.Outer(), it was the same as _obtain() in diaspy.streams.Generic(),

• rem: diaspy.models.Post() its update() method since it is deprecated for a while now,

• rem: backtime parameter removed from diaspy.streams.Generic.more(),

• rem: protocol parameter removed from diaspy.people.User().fetchhandle().

---

Version 0.5.0.1

This is a hotfix release. Plain 0.5.0 lost compatibility with older versions of Diaspora* due to a trivial assignment-related bug.

---

Version 0.5.0

Release 0.5.0 This release fixes a bug that arose with Diaspora* 0.5.0 update which changed the way how the CSRF tokens have been embedded in HTML code. This required minor fix to the CSRF-extracting regex.

Not much besides. Fixed a typo or two.

---

Version 0.4.3:

• new: people.User().fetchprofile() will issue a warning when user cannot be found on current pod,

• new: settings.Profile is now loaded during initialization (can be switched off),

• fix: fixed a bug in __repr__() method in people.User() object,

---

Version 0.4.2 (2013-12-19):

This version has some small incompatibilities with 0.4.1 so read Changelog carefully.

• new: diaspy.people.User._fetchstream() method,

• new: diaspy.people.Me() object representing current user,

• new: **kwargs added to diaspy.streams.Generic.json() methdo to give developers control over the creation of JSON,

• new: .getHCard() method added to diaspy.people.User(),

• upd: diaspy.connection.Connection.login() modifies connection object in-place and returns it (this allows more fluent API),

• upd: diaspy.connection.Connection.login() no longer returns status code (if login was unsuccessful it'll raise an exception),

• upd: diaspy.connection.Connection._login() no longer returns status code (if login was unsuccessful it'll raise an exception),

• upd: better error message in diaspy.models.Post().__init__(),

• upd: data variable in diaspy.models.Post() renamed to _data to indicate that it's considered private,

• upd: after deleting a post Activity stream is purged instead of being refilled (this preserves state of stream which is not reset to last 15 posts),

• upd: filterByIDs() method in Aspects stream renamed to filter(),

• rem: diaspy.connection.Connection.getUserInfo() moved to diaspy.connection.Connection.getUserData(),

• rem: fetch parameter removed from diaspy.connection.Connection.getUserData(),

• dep: max_time parameter in diaspy.streams.*.more() method is deprecated,

• fix: this release should fix the bug which prevented diaspy from working with some pods (e.g. diasp.eu and joindiaspora.com),

---

Version 0.4.1 (2013-09-12):

Login and authentication procedure backend received major changes in this version. There are no longer username and password variables in Connection object. Instead, credentials are stored (together with the token) in single variable _login_data. This is preserved until you call login() at which point credentials are erased and only token is left -- it can be obtained by calling repr(Connection).

Also, this release is compatible with DIASPORA* 0.2.0.0 but should still support pods running on older versions.

And the test suite was updated. Yay!

• new: diaspy.errors.SettingsError.

• upd: diaspy.settings.Account.setEmail() can now raise SettingsError when request fails,

• upd: diaspy.settings.Account.getEmail() will now return empty string instead of raising an exception if cannot fetch mail,

• upd: improved language fetching in diaspy.settings.Account.getLanguages().

• rem: diaspy/client.py is removed,

0.4.1-rc.3 (2013-09-08):

• new: diaspy.settings.Profile.load() method for loading profile information,
• new: diaspy.settings.Profile.update() method for updating profile information,
• new: diaspy.settings.Profile.setName() method,
• new: diaspy.settings.Profile.setBio() method,
• new: diaspy.settings.Profile.setLocation() method,
• new: diaspy.settings.Profile.setTags() method,
• new: diaspy.settings.Profile.setGender() method,
• new: diaspy.settings.Profile.setBirthDate() method,
• new: diaspy.settings.Profile.setSearchable() method,
• new: diaspy.settings.Profile.setNSFW() method,

0.4.1-rc.2 (2013-09-06):

• new: diaspy.search.Search.tags() method for getting tag suggestions,

• new: diaspy.settings.Profile.getName() method,

• new: diaspy.settings.Profile.getBio() method,

• new: diaspy.settings.Profile.getLocation() method,

• new: diaspy.settings.Profile.getTags() method,

• new: diaspy.settings.Profile.getGender() method,

• new: diaspy.settings.Profile.getBirthDate() method,

• new: diaspy.settings.Profile.isSearchable() method,

• new: diaspy.settings.Profile.isNSFW() method,

• new: provider_display_name parameter in diaspy.streams.Stream.post() (thanks @svbergerem),

• upd: remeber_me parameter in diaspy.connection.Connection.login(),

• upd: you must supply username and password parameters on init of diaspy.connection.Connection,

• upd: you must update your testconf.py (new fields are required for settings tests),

• upd: diaspy.settings.Settings renamed to diaspy.settings.Account,

• rem: username and password parameters removed from diaspy.connection.Connection.login() must be supplied on init,

0.4.1-rc.1 (2013-09-02):

• new: __getitem__() in diaspy.models.Post,

• new: __dict__() in diaspy.models.Post,

• new: guid argument in diaspy.models.Post.__init__(),

• new: json() method in diaspy.streams.Generic adds the possibility to export streams to JSON,

• new: full() method in diaspy.streams.Generic will try to fetch full stream (containing all posts),

• new: setEmail() method in diaspy.settings.Settings,

• new: setLanguage() method in diaspy.settings.Settings,

• new: downloadPhotos() method in diaspy.settings.Settings,

• new: backtime argument in more() method in diaspy.streams.Generic,

• new: DiaspyError will be raised when connection is created with empty password and/or username,

• new: getSessionToken() method in diaspy.connection.Connection returns string from _diaspora_session cookie,

• new: direct parameter in diaspy.connection.Connection().get() allowing to disable pod expansion,

• upd: if Post() is created with fetched comments, data will also be fetched as a dependency,

• upd: id argument type is now int (diaspy.models.Post.__init__()),

• upd: Search().lookup_user() renamed to Search().lookupUser(),

• upd: diaspy.messages renamed to diaspy.conversations (but will be accessible under both names for this and next release),

• upd: LoginError moved to diaspy.errors,

• upd: TokenError moved to diaspy.errors,

• upd: diaspy.connection.Connection.podswitch() gained two new positional arguments: username and password,

• upd: aspect_id renamed to id in diaspy.streams.Aspects().remove(),

• fix: fixed some bugs in regular expressions used by diaspy internals (html tag removal, so you get nicer notifications),

• fix: fixed authentication issues,

---

Version 0.4.0 (2013-08-20):

This release is not backwards compatible with 0.3.x line! You'll have to check your code for corrections. Also, this release if first to officially released fork version.

• dep: diaspy.client is officially deprecated (will be removed in 0.4.1),

• upd: diaspy.conversations renamed to diaspy.messages,

• udp: diaspy.conversations.Conversation moved to diaspy.models,

• new: diaspy.messages.Mailbox() object representing diaspora* mailbox,

---

Version 0.3.2 (2013-08-20):

• upd: diaspy.connection.getUserData() raises DiaspyError when it cannot find user data,

• rem: diaspy.client.Client must be explicitly imported,

---

Version 0.3.1 (2013-07-12):

• upd: diaspy.people.sephandle() raises InvalidHandleError instead of UserError

• upd: models.Post()._fetch() renamed to _fetchdata() (because of new _fetchcomments() method)

• new: models.Comment() object: wrapper for comments, not to be created manually

• new: comments parameter in models.Post: defines whether to fetch post's commets

• new: connection.Connection has new parameter in __init__(): it's schema

• new: author() method in models.Post()

The new parameter in connection.Connection is useful when operating with handles. As handle does not contain schema (http, https, etc.) _setlogin() would raise an unhandled exception -- requests.exceptions.MissingSchema. Now, however, Connection will catch the exception, add missing schema and try once more. This parameter is provided to give programmers ability to manipulate it.

Also, now you can pass just pod.example.com as pod parameter. Less typing!

When it comes to posts, we are now able to fetch comments.

---

Version 0.3.0 (2013-07-07):

First edition of Changelog for diaspy. Developers should update their code as version 0.3.0 may not be fully backwards compatible depending on how the code is written. If you always pass named arguments and do not rely on their order you can, at least in theory, not worry about this update.

Version 0.3.0 introduces few new features, fixes several bugs and brings a bit of redesign and refactoring od diaspy's code.