Khorosjx

******
**Release Date: 2021-09-23**

Added
=====

Primary Modules
---------------
Additions to the :doc:`primary modules <primary-modules>`.

* Added the :py:func:`khorosjx.core.ensure_absolute_url` function.

Supporting Modules
------------------
Additions to the :doc:`supporting modules <supporting-modules>`.

* Added the :py:exc:`khorosjx.errors.exceptions.MissingBaseUrlError` exception class.

Changed
=======

Primary Modules
---------------
Changes to the :doc:`primary modules <primary-modules>`.

* Added the ``return_url`` parameter to the :py:func:`khorosjx.core.set_base_url`
function to determine if the base URL should be returned by the function.
* The following functions were updated to leverage the
:py:func:`khorosjx.core.ensure_absolute_url` function:
* :py:func:`khorosjx.core.get_request_with_retries`
* :py:func:`khorosjx.core._api_request_with_payload`
* :py:func:`khorosjx.core.post_request_with_retries`
* :py:func:`khorosjx.core.put_request_with_retries`
* :py:func:`khorosjx.core.delete`

|

******

******
**Release Date: 2021-09-22**

Added
=====

Primary Modules
---------------
Additions to the :doc:`primary modules <primary-modules>`.

* Added the :py:func:`khorosjx.places.base.retrieve_connection_info` function.
* Added the :py:func:`khorosjx.places.blogs.retrieve_connection_info` function.

Changed
=======

Primary Modules
---------------
Changes to the :doc:`primary modules <primary-modules>`.

* Refactored the following functions to be more pythonic and to avoid depending on
a try/except block, and to define the related global variables at the module level:
* :py:func:`khorosjx.core.verify_connection`
* :py:func:`khorosjx.admin.verify_core_connection`
* :py:func:`khorosjx.content.base.verify_core_connection`
* :py:func:`khorosjx.content.docs.verify_core_connection`
* :py:func:`khorosjx.content.events.verify_core_connection`
* :py:func:`khorosjx.content.ideas.verify_core_connection`
* :py:func:`khorosjx.content.threads.verify_core_connection`
* :py:func:`khorosjx.content.videos.verify_core_connection`
* :py:func:`khorosjx.groups.verify_core_connection`
* :py:func:`khorosjx.news.verify_core_connection`
* :py:func:`khorosjx.places.base.verify_core_connection`
* :py:func:`khorosjx.places.blogs.verify_core_connection`
* :py:func:`khorosjx.places.spaces.verify_core_connection`
* :py:func:`khorosjx.users.verify_core_connection`
* Refactored the following functions to be more efficient and removed one of the
exception references in the docstring:
* :py:func:`khorosjx.admin.retrieve_connection_info`
* :py:func:`khorosjx.content.base.retrieve_connection_info`
* :py:func:`khorosjx.content.docs.retrieve_connection_info`
* :py:func:`khorosjx.content.events.retrieve_connection_info`
* :py:func:`khorosjx.content.ideas.retrieve_connection_info`
* :py:func:`khorosjx.content.threads.retrieve_connection_info`
* :py:func:`khorosjx.content.videos.retrieve_connection_info`
* :py:func:`khorosjx.groups.retrieve_connection_info`
* :py:func:`khorosjx.news.retrieve_connection_info`
* :py:func:`khorosjx.users.retrieve_connection_info`
* Refactored the following functions to be more efficient:
* :py:func:`khorosjx.core.get_query_url`
* :py:func:`khorosjx.core.get_request_with_retries`
* :py:func:`khorosjx.core.get_api_version`
* :py:func:`khorosjx.groups.check_user_membership`
* :py:func:`khorosjx.groups.add_user_to_group`
* :py:func:`khorosjx.news.get_subscriber_groups`
* :py:func:`khorosjx.places.base.get_places_list_from_file`
* :py:func:`khorosjx.users.get_json_field`
* :py:func:`khorosjx.users.parse_user_fields`
* Changed the default ``return_fields`` value to ``None`` and made related adjustments in
the following functions:
* :py:func:`khorosjx.core.get_fields_from_api_response`
* :py:func:`khorosjx.core.get_paginated_results`
* :py:func:`khorosjx.content.base.get_paginated_content`
* :py:func:`khorosjx.content.base.get_document_info`
* :py:func:`khorosjx.groups.get_group_info`
* :py:func:`khorosjx.groups.get_all_groups`
* :py:func:`khorosjx.news.get_all_publications`
* :py:func:`khorosjx.news.get_publication`
* :py:func:`khorosjx.news.get_stream`
* :py:func:`khorosjx.news.get_subscribers`
* :py:func:`khorosjx.places.base.get_place_info`
* :py:func:`khorosjx.places.spaces.get_space_info`
* Changed the default ``categories`` and ``tags`` values to ``None`` in the
:py:func:`khorosjx.content.docs.create_document` and adjusted the function accordingly.
* The name of the raised exception was added to the error message in the
:py:func:`khorosjx.core._api_request_with_payload` function.
* Renamed the :py:func:`khorosjx.users.__validate_lookup_type` function to be
:py:func:`khorosjx.users._validate_lookup_type` instead. (Single underscore prefix)
* Renamed the :py:func:`khorosjx.users.__get_paginated_content_count` function to be
:py:func:`khorosjx.users._get_paginated_content_count` instead. (Single underscore prefix)
* Renamed the :py:func:`khorosjx.users.__get_followed` function to be
:py:func:`khorosjx.users._get_followed` instead. (Single underscore prefix)
* Updated the :py:func:`khorosjx.users._validate_lookup_type` function call in
the following functions to use the new function name:
* :py:func:`khorosjx.users.get_user_id`
* :py:func:`khorosjx.users.get_username`
* :py:func:`khorosjx.users.get_primary_email`
* Updated the :py:func:`khorosjx.users._get_paginated_content_count` function call in
:py:func:`khorosjx.users.get_user_content_count` to use the new function name.
* Added a ``TODO`` to rename the following functions:
* :py:func:`khorosjx.content.base.__convert_lookup_value`
* :py:func:`khorosjx.content.base.__trim_attachments_info`
* :py:func:`khorosjx.places.base.__verify_browse_id`

Supporting Modules
------------------
Changes to the :doc:`supporting modules <supporting-modules>`.

* Moved the function :py:func:`khoros.errors.handlers._raise_exception_for_status_code` function
out to the module level from within :py:func:`khoros.errors.handlers.check_api_response`.

Fixed
=====

Primary Modules
---------------
Fixes in the :doc:`primary modules <primary-modules>`.

* Fixed how the ``query_url`` variable is defined in the :py:func:`khorosjx.core.get_data`
function to proactively avoid raising any :py:exc:`NameError` exceptions.
* Adjusted a dictionary lookup in the following functions to proactively avoid raising
a :py:exc:`KeyError` exception:
* :py:func:`khorosjx.groups._get_paginated_groups`
* :py:func:`khorosjx.content.docs.get_document_attachments`
* Added parenthesis to the exception classes in the following functions:
* :py:func:`khorosjx.core.set_credentials`
* :py:func:`khorosjx.content.docs.delete_document`
* :py:func:`khorosjx.groups.check_user_membership`
* :py:func:`khorosjx.groups.add_user_to_group`
* :py:func:`khorosjx.news.filter_subscriptions_by_id`
* :py:func:`khorosjx.users._get_followed`
* Refactored the :py:func:`khorosjx.core.get_base_url` function to properly utilize
the ``base_url`` global variable.
* Removed a hardcoded URL in the :py:func:`khorosjx.users.get_profile_url` with the
interpolated ``base_url`` variable.
* Made some minor syntax improvements in the :py:func:`khorosjx.content.base.get_content_id`
function.
* Made improvements to the :py:func:`khoros.places.base.get_place_id` function to proactively
avoid raising any :py:exc:`NameError` exceptions.

Supporting Modules
------------------
Changes to the :doc:`supporting modules <supporting-modules>`.

* Added parenthesis to the exception classes in the following functions:
* :py:func:`khorosjx.errors.handlers.check_json_for_error`

|

******

******
**Release Date: 2021-09-20**

Added
=====

General
-------
* Added the ``codeql-analysis.yml`` workflow.
* Merged dependabot pull requests to mitigate security vulnerabilities with
:py:mod:`twine` dependency packages.

Changed
=======

General
-------
* Started over with the ``requirements.txt`` file and renamed the original file
to be ``original-requirements.txt``.
* Added the ``install_requires`` configuration to the ``setup.py`` file.
* Added Python version 3.9 to ``pythonpackage.yml``.

Fixed
=====

General
-------
* Fixed a minor grammatical error in the ``examples/khorosjx_helper.yml`` file.

|

******

******
**Release Date: 2020-05-01**

Changed
=======

Primary Modules
---------------
Changes to the :doc:`primary modules <primary-modules>`.

* Added the optional ``quiet`` argument to the :py:func:`khorosjx.core.get_fields_from_api_response`
function which silences any errors for being unable to locate API fields.
* Added the optional ``quiet`` argument to the :py:func:`khorosjx.core.get_paginated_results`
function which silences any errors for being unable to locate API fields.
* Added the optional ``quiet`` argument to the :py:func:`khorosjx.groups.get_group_memberships`
function which silences any errors for being unable to locate API fields.
* Added the optional ``quiet`` argument to the :py:func:`khorosjx.groups._add_paginated_members`
function which silences any errors for being unable to locate API fields.
* Removed the unnecessary variable definition of ``added_to_group`` within the
:py:func:`khorosjx.groups.add_user_to_group` function.
* Renamed the :py:func:`khorosjx.core.__get_filter_syntax` function to be
:py:func:`khorosjx.core._get_filter_syntax` instead.
* Renamed the :py:func:`khorosjx.core.__api_request_with_payload` function to be
:py:func:`khorosjx.core._api_request_with_payload` instead.

Documentation
-------------
Changes to the documentation.

* Added a docstring to the :py:func:`khorosjx.core._get_filter_syntax` function.

Fixed
=====

Primary Modules
---------------
Fixes to the :doc:`primary modules <primary-modules>`.

* Changed the filter string ``emails.value`` to be ``email.value`` in the
:py:func:`khorosjx.core.get_fields_from_api_response` function.

|

******

******
**Release Date: 2020-04-29**

Fixed
=====

Supporting Modules
------------------
Fixes to the :doc:`supporting modules <supporting-modules>`.

* Fixed the :py:func:`khorosjx.utils.helper._convert_yaml_to_bool` function to only perform its
operations if the passed value is not a Boolean value to prevent the following :py:exc:`AttributeError`
exception from occurring: ``AttributeError: 'bool' object has no attribute 'lower'``

|

******

******
**Release Date: 2020-04-29**

Added
=====

Supporting Modules
------------------
Additions to the :doc:`supporting modules <supporting-modules>`.

* Added the :py:func:`khorosjx.utils.core_utils.remove_comment_wrappers_from_html` function.

General
-------
* Added *PyCharm Python Security Scanner* to the
`pythonpackage.yml <https://github.com/jeffshurtliff/khorosjx/blob/master/.github/workflows/pythonpackage.yml>`_ file.
* Updated to `bleach v3.1.4 <https://github.com/mozilla/bleach/releases/tag/v3.1.4>`_ as
`recommended by GitHub <https://github.com/jeffshurtliff/khorosjx/commit/702819ea09f63635804f820fb365de42a8efdc2e>`_
to include some security fixes.

Changed
=======

Primary Modules
---------------
Changes to the :doc:`primary modules <primary-modules>`.

* Renamed the :py:func:`khorosjx.places.spaces.get_space_permissions` function to be
:py:func:`khorosjx.places.spaces.get_space_content_permissions` instead and added a :py:exc:`DeprecationWarning` to
the original.
* Moved the :py:func:`khorosjx.places.spaces.__get_paginated_content_permissions` function from within the
:py:func:`khorosjx.places.spaces.get_space_permissions` function to the module level.
* Moved the :py:func:`khorosjx.places.spaces.verify_core_connection.__get_info` function to the module level as
:py:func:`khorosjx.places.spaces.retrieve_connection_info`.
* Renamed the :py:func:`khorosjx.groups.__add_paginated_members` function to be
:py:func:`khorosjx.groups._add_paginated_members` instead.
* Renamed the :py:func:`khorosjx.groups.__get_paginated_groups` function to be
:py:func:`khorosjx.groups._get_paginated_groups` instead.
* Added the ``?fields=all`` query string to the API URI in the :py:func:`khorosjx.groups.get_group_members`
function to ensure all fields are retrieved.

Supporting Modules
------------------
Changes to the :doc:`supporting modules <supporting-modules>`.

* Replaced the ``yaml.load()`` function call with ``yaml.safe_load()`` in
:py:func:`khoros.utils.helper.import_yaml_file` as it is a better security practice.
* Renamed the :py:func:`khorosjx.utils.helper.__get_connection_info` function to be
:py:func:`khorosjx.utils.helper._get_connection_info` instead.
* Renamed the :py:func:`khorosjx.utils.helper.__get_credentials_from_module` function to be
:py:func:`khorosjx.utils.helper._get_credentials_from_module` instead.
* Renamed the :py:func:`khorosjx.utils.helper.__parse_function_arguments` function to be
:py:func:`khorosjx.utils.helper._parse_function_arguments` instead.
* Renamed the :py:func:`khorosjx.utils.helper.__get_console_color_settings` function to be
:py:func:`khorosjx.utils.helper._get_console_color_settings` instead.
* Renamed the :py:func:`khorosjx.utils.helper.__get_modules_to_import` function to be
:py:func:`khorosjx.utils.helper._get_modules_to_import` instead.
* Renamed the :py:func:`khorosjx.utils.helper.__convert_yaml_to_bool` function to be
:py:func:`khorosjx.utils.helper._convert_yaml_to_bool` instead.

Fixed
=====

Primary Modules
---------------
Fixes to the :doc:`primary modules <primary-modules>`.

* Added error handling to the :py:func:`khorosjx.core.get_fields_from_api_response` function to
prevent it from failing with an :py:exc:`IndexError` exception.

Documentation
-------------
Fixes to the documentation.

* Fixed a typo and added hyperlinks to raised exceptions in the
:py:func:`khorosjx.places.spaces.get_permitted_content_types` function docstring.
* Fixed a typo in the docstring for the :py:func:`khorosjx.news.filter_subscriptions_by_id` function.

|

******