Changelog for Ruby SDK

## v5.5.0 *January 28, 2025* | Type | Changes | |------|----------| | **Added** | • Add the ability to specify `type` and `status` fields for `channel metadata`, `uuid metadata`, `member`, and `membership`.<br/>• Add missing `include` options for App Context APIs: `custom`, `status`, `type`, `uuid_status`, `uuid_type`, `channel_status`, and `channel_type`. | ## v5.4.0 *January 7, 2025* | Type | Changes | |------|----------| | **Added** | • Add batch history support.<br/>• Add fetch messages with message reactions.<br/>• Add fetch messages (batch history) endpoint support to fetch history for multiple channels.<br/>• Add fetch messages with reactions support.<br/>• Add `include_custom_message_type` support for fetch messages endpoint.<br/>• Add `custom_message_type` support for `publish` / `signal` and `subscribe` endpoints. | ## v5.3.5 *October 9, 2024* | Type | Changes | |------|----------| | **Modified** | • Updated direct and transient dependency versions. | ## v5.3.4 *April 29, 2024* | Type | Changes | |------|----------| | **Fixed** | • Fix issue because of which client didn't encode App Context get all event `filter` query value. | ## v5.3.3 *January 29, 2024* | Type | Changes | |------|----------| | **Modified** | • Bump required version to the minimum officially supported Ruby version. | ## v5.3.2 *November 23, 2023* | Type | Changes | |------|----------| | **Modified** | • Return source event data when a client configured with crypto is unable to decrypt it (can be not encrypted data or encrypted with different options). | ## v5.3.1 *November 3, 2023* | Type | Changes | |------|----------| | **Modified** | • Update license information. | ## v5.3.0 *October 16, 2023* | Type | Changes | |------|----------| | **Added** | • Add crypto module that allows to configure SDK to encrypt and decrypt messages. | | **Fixed** | • Improved security of crypto implementation by adding enhanced AES-CBC cryptor. | ## v5.2.2 *March 14, 2023* | Type | Changes | |------|----------| | **Fixed** | • Fix issue which raised an exception when PubNub client has been configured with a secret key. | ## v5.2.1 *December 13, 2022* | Type | Changes | |------|----------| | **Fixed** | • Fix format which is used to return server data from `get_message_actions` method call. | ## v5.2.0 *December 12, 2022* | Type | Changes | |------|----------| | **Added** | • Add api which allow to work with message actions endpoints. | | **Modified** | • Migrate test suite run from Travis to GitHub Actions. | ## v5.1.2 *November 23, 2022* | Type | Changes | |------|----------| | **Fixed** | • Fix issue because of which channel hasn't been encoded properly with endpoint call. | ## v5.1.1 *October 26, 2022* | Type | Changes | |------|----------| | **Fixed** | • Fix issue because of which `callback` and `http_sync` provided during client configuration not used when missing in method call. | ## v5.1.0 *July 26, 2022* | Type | Changes | |------|----------| | **Added** | • Add support for spaces and users permissions in grant_token.<br/>• Add user_id and deprecate uuid when creating new pubnub instance. | ## v5.0.0 *January 13, 2022* | Type | Changes | |------|----------| | **Modified** | • BREAKING CHANGES: uuid is required parameter to create PubNub instance. | ## v4.8.0 *December 16, 2021* | Type | Changes | |------|----------| | **Added** | • Add revoke token feature. | ## v4.7.1 *November 24, 2021* | Type | Changes | |------|----------| | **Added** | • Add new method `all_history_messages` which return messages from requested interval or `since` / `before` date in single object. | | **Fixed** | • Fix exception raised when optional start / end not passed to `paged_history`. | ## v4.7.0 *November 9, 2021* | Type | Changes | |------|----------| | **Added** | • Grant_token allows generation of signed token with permissions for channels, channel groups and uuids. | ## v4.6.2 *June 9, 2021* | Type | Changes | |------|----------| | **Modified** | • Add new `sdks` section to `.pubnub.yml` with information about available artifacts and distribution variants. | ## v4.6.1 *May 19, 2021* | Type | Changes | |------|----------| | **Modified** | • Exclude `spec` and `fixtures` from built gem file.<br/>• Fix Ruby SDK repository location under `sdks` section in `.pubnub.yml`.<br/>• Add new section to `.pubnub.yml` file with information about SDK and destribution types. | ## v4.6.0 *March 8, 2021* | Type | Changes | |------|----------| | **Added** | • BREAKING CHANGE: Add randomized initialization vector usage by default for data encryption / decryption in publish / subscribe / history API calls. | | **Fixed** | • Fix issue which caused Object request body encryption when `cipher_key` is set. | ## v4.5.0 *December 3, 2020* | Type | Changes | |------|----------| | **Added** | • Add support for APNS2 device/channel management. | | **Fixed** | • Resolved issue with multiple timetokens in message counts endpoint | ## v4.4.0 *October 21, 2020* | Type | Changes | |------|----------| | **Added** | • Add simplified Objects API support with UUID and Channel metadata / membership management.<br/>• Add uuid and parameter to Grant API along with new Objects permissions: `get`, `update` and `join`. | ## v4.3.0 *October 18, 2020* | Type | Changes | |------|----------| | **Added** | • Add `delete` permission for `channel` to Grant. | ## v4.2.7 *September 14, 2020* | Type | Changes | |------|----------| | **Fixed** | • Don't suppress runtime errors. | ## v4.2.6 *August 25, 2020* | Type | Changes | |------|----------| | **Added** | • History can now respond with message meta information.<br/>• Added official support for Ruby 2.7.X | | **Fixed** | • History properly decrypts messages when using the "include_token" parameter. | ## v4.2.5 *June 2, 2020* | Type | Changes | |------|----------| | **Fixed** | • Fixed Message Counts channel timetokens by disabling alphabetic sorting of the channels list. | ## v4.2.4 *May 22, 2020* | Type | Changes | |------|----------| | **Fixed** | • Replace event name with full endpoint path in PAM signatures, for compatibility with PAM v2 signatures.<br/>• Change paths for PAM endpoints from v1 to v2.<br/>• Update PAM signature generator to correctly sort the query string parameters based on key instead of combined key and value. | ## 4.2.2 *November 11, 2019* | Type | Changes | |------|----------| | **Fixed** | • Resolved issue with multiple timetokens in message counts endpoint | ## 4.2.1 *October 25, 2019* | Type | Changes | |------|----------| | **Added** | • Updated listener methods | ## 4.2.0 *October 11, 2019* | Type | Changes | |------|----------| | **Added** | • Added objects feature | ## 4.1.6 *August 21, 2019* | Type | Changes | |------|----------| | **Added** | • Added signal feature | ## 4.1.5 *July 29, 2019* | Type | Changes | |------|----------| | **Modified** | • Updated dependencies | ## 4.1.1 *April 8, 2019* | Type | Changes | |------|----------| | **Added** | • Added push API | ## 4.1.0 *February 28, 2019* | Type | Changes | |------|----------| | **Added** | • Added 'message_count' API endpoint | ## 4.0.28 *August 28, 2018* | Type | Changes | |------|----------| | **Fixed** | • Switch from Celluloid to concurrent-ruby. | ## 4.0.27 *November 17, 2017* | Type | Changes | |------|----------| | **Fixed** | • Fixed telemetry issues. | ## 4.0.26 *October 23, 2017* | Type | Changes | |------|----------| | **Fixed** | • Secured telemetry call. Fixed crash when an app was exiting. | ## 4.0.25 *September 12, 2017* | Type | Changes | |------|----------| | **Added** | • Added telemetry | ## 4.0.24 *August 29, 2017* | Type | Changes | |------|----------| | **Added** | • Added #delete_messages method | | **Modified** | • Improved timeout error handling (thanks @f1sherman) | ## 4.0.23 *July 26, 2017* | Type | Changes | |------|----------| | **Fixed** | • Fixed HereNow envelope generation | ## 4.0.22 *May 31, 2017* | Type | Changes | |------|----------| | **Fixed** | • Fixed signature generation and channel name escaping | ## 4.0.21 *April 18, 2017* | Type | Changes | |------|----------| | **Fixed** | • Fixed signature generation | ## 4.0.20 *April 11, 2017* | Type | Changes | |------|----------| | **Modified** | • origin can now be set in initialized client<br/>• presence interval support<br/>• allows using multiple cipher keys | ## v4.0.18 *March 2, 2017* | Type | Changes | |------|----------| | **Fixed** | • Fixed sync subscribe not terminating actors | ## v4.0.17 *December 21, 2016* | Type | Changes | |------|----------| | **Modified** | • Added a bit more debug logging<br/>• Updated default origin | ## v4.0.16 *November 23, 2016* | Type | Changes | |------|----------| | **Fixed** | • Fixed missing channel group parameter in leave event | ## v4.0.15 *November 21, 2016* | Type | Changes | |------|----------| | **Fixed** | • Fixed PAM signature when some special characters are present | ## v4.0.14 *November 4, 2016* | Type | Changes | |------|----------| | **Modified** | • Added ttl parameter for publish | ## v4.0.13 *November 4, 2016* | Type | Changes | |------|----------| | **Modified** | • Changed init message log level to debug | ## v4.0.12 *October 31, 2016* | Type | Changes | |------|----------| | **Modified** | • Added alert on catchup failure (REQUEST_MESSAGE_COUNT_EXCEEDED) | ## v4.0.11 *October 31, 2016* | Type | Changes | |------|----------| | **Modified** | • Added super admin mode (Enabled when secret key is set on Pubnub::Client init) | ## v4.0.10 *October 31, 2016* | Type | Changes | |------|----------| | **Modified** | • Better single events timeout handling<br/>• DRYed envelope formatting a bit | ## v4.0.9 *October 31, 2016* | Type | Changes | |------|----------| | **Modified** | • Removed json dependency<br/>• Updated dependecies | ## v4.0.8 *October 31, 2016* | Type | Changes | |------|----------| | **Modified** | • Updated dry-validation.<br/>• Dropped support for ruby 2.0. | ## v4.0.7 *August 23, 2016* | Type | Changes | |------|----------| | **Modified** | • Added message decrypting in history. | ## v4.0.6 *August 17, 2016* | Type | Changes | |------|----------| | **Modified** | • channel and channels are the same argument.<br/>• channel_group and channel_groups are the same argument.<br/>• added `with_presence` flag for subscribe, default false. | ## v4.0.5 *August 17, 2016* | Type | Changes | |------|----------| | **Modified** | • Required CGI. | ## v4.0.2 *August 17, 2016* | Type | Changes | |------|----------| | **Added** | • Added #subscribe_filter for client | ## v4.0.1 *August 17, 2016* | Type | Changes | |------|----------| | **Modified** | • Updated dry-validation and EnvelopeSchema. | ## v4.0.0 *August 17, 2016* | Type | Changes | |------|----------| | **Added** | • Removed auth_key and uuid setters (#set_auth_key, | | **Modified** | • Added | ## v3.8.3 *August 17, 2016* | Type | Changes | |------|----------| | **Modified** | • Restored auth_key and uuid setters. Important notice: they will be removed | ## v3.8.2 *August 17, 2016* | Type | Changes | |------|----------| | **Added** | • Added :include_token parameter to history call. | ## v3.8.1 *August 17, 2016* | Type | Changes | |------|----------| | **Modified** | • Updated celluloid dependency. | ## v3.8.0 *August 17, 2017* | Type | Changes | |------|----------| | **Modified** | • Release of celluloid version of pubnub gem. It's complete rewrite but public API doesn't change. |

v5.5.0

January 28, 2025
Added
  • Add the ability to specify type and status fields for channel metadata, uuid metadata, member, and membership.
  • Add missing include options for App Context APIs: custom, status, type, uuid_status, uuid_type, channel_status, and channel_type.

v5.4.0

January 7, 2025
Added
  • Add batch history support.
  • Add fetch messages with message reactions.
  • Add fetch messages (batch history) endpoint support to fetch history for multiple channels.
  • Add fetch messages with reactions support.
  • Add include_custom_message_type support for fetch messages endpoint.
  • Add custom_message_type support for publish / signal and subscribe endpoints.

v5.3.5

October 9, 2024
Modified
  • Updated direct and transient dependency versions.

v5.3.4

April 29, 2024
Fixed
  • Fix issue because of which client didn't encode App Context get all event filter query value.

v5.3.3

January 29, 2024
Modified
  • Bump required version to the minimum officially supported Ruby version.

v5.3.2

November 23, 2023
Modified
  • Return source event data when a client configured with crypto is unable to decrypt it (can be not encrypted data or encrypted with different options).

v5.3.1

November 3, 2023
Modified
  • Update license information.

v5.3.0

October 16, 2023
Added
  • Add crypto module that allows to configure SDK to encrypt and decrypt messages.
Fixed
  • Improved security of crypto implementation by adding enhanced AES-CBC cryptor.

v5.2.2

March 14, 2023
Fixed
  • Fix issue which raised an exception when PubNub client has been configured with a secret key.

v5.2.1

December 13, 2022
Fixed
  • Fix format which is used to return server data from get_message_actions method call.

v5.2.0

December 12, 2022
Added
  • Add api which allow to work with message actions endpoints.
Modified
  • Migrate test suite run from Travis to GitHub Actions.

v5.1.2

November 23, 2022
Fixed
  • Fix issue because of which channel hasn't been encoded properly with endpoint call.

v5.1.1

October 26, 2022
Fixed
  • Fix issue because of which callback and http_sync provided during client configuration not used when missing in method call.

v5.1.0

July 26, 2022
Added
  • Add support for spaces and users permissions in grant_token.
  • Add user_id and deprecate uuid when creating new pubnub instance.

v5.0.0

January 13, 2022
Modified
  • BREAKING CHANGES: uuid is required parameter to create PubNub instance.

v4.8.0

December 16, 2021
Added
  • Add revoke token feature.

v4.7.1

November 24, 2021
Added
  • Add new method all_history_messages which return messages from requested interval or since / before date in single object.
Fixed
  • Fix exception raised when optional start / end not passed to paged_history.

v4.7.0

November 9, 2021
Added
  • Grant_token allows generation of signed token with permissions for channels, channel groups and uuids.

v4.6.2

June 9, 2021
Modified
  • Add new sdks section to .pubnub.yml with information about available artifacts and distribution variants.

v4.6.1

May 19, 2021
Modified
  • Exclude spec and fixtures from built gem file.
  • Fix Ruby SDK repository location under sdks section in .pubnub.yml.
  • Add new section to .pubnub.yml file with information about SDK and destribution types.

v4.6.0

March 8, 2021
Added
  • BREAKING CHANGE: Add randomized initialization vector usage by default for data encryption / decryption in publish / subscribe / history API calls.
Fixed
  • Fix issue which caused Object request body encryption when cipher_key is set.

v4.5.0

December 3, 2020
Added
  • Add support for APNS2 device/channel management.
Fixed
  • Resolved issue with multiple timetokens in message counts endpoint

v4.4.0

October 21, 2020
Added
  • Add simplified Objects API support with UUID and Channel metadata / membership management.
  • Add uuid and parameter to Grant API along with new Objects permissions: get, update and join.

v4.3.0

October 18, 2020
Added
  • Add delete permission for channel to Grant.

v4.2.7

September 14, 2020
Fixed
  • Don't suppress runtime errors.

v4.2.6

August 25, 2020
Added
  • History can now respond with message meta information.
  • Added official support for Ruby 2.7.X
Fixed
  • History properly decrypts messages when using the "include_token" parameter.

v4.2.5

June 2, 2020
Fixed
  • Fixed Message Counts channel timetokens by disabling alphabetic sorting of the channels list.

v4.2.4

May 22, 2020
Fixed
  • Replace event name with full endpoint path in PAM signatures, for compatibility with PAM v2 signatures.
  • Change paths for PAM endpoints from v1 to v2.
  • Update PAM signature generator to correctly sort the query string parameters based on key instead of combined key and value.

4.2.2

November 11, 2019
Fixed
  • Resolved issue with multiple timetokens in message counts endpoint

4.2.1

October 25, 2019
Added
  • Updated listener methods

4.2.0

October 11, 2019
Added
  • Added objects feature

4.1.6

August 21, 2019
Added
  • Added signal feature

4.1.5

July 29, 2019
Modified
  • Updated dependencies

4.1.1

April 8, 2019
Added
  • Added push API

4.1.0

February 28, 2019
Added
  • Added 'message_count' API endpoint

4.0.28

August 28, 2018
Fixed
  • Switch from Celluloid to concurrent-ruby.

4.0.27

November 17, 2017
Fixed
  • Fixed telemetry issues.

4.0.26

October 23, 2017
Fixed
  • Secured telemetry call. Fixed crash when an app was exiting.

4.0.25

September 12, 2017
Added
  • Added telemetry

4.0.24

August 29, 2017
Added
  • Added #delete_messages method
Modified
  • Improved timeout error handling (thanks @f1sherman)

4.0.23

July 26, 2017
Fixed
  • Fixed HereNow envelope generation

4.0.22

May 31, 2017
Fixed
  • Fixed signature generation and channel name escaping

4.0.21

April 18, 2017
Fixed
  • Fixed signature generation

4.0.20

April 11, 2017
Modified
  • origin can now be set in initialized client
  • presence interval support
  • allows using multiple cipher keys

v4.0.18

March 2, 2017
Fixed
  • Fixed sync subscribe not terminating actors

v4.0.17

December 21, 2016
Modified
  • Added a bit more debug logging
  • Updated default origin

v4.0.16

November 23, 2016
Fixed
  • Fixed missing channel group parameter in leave event

v4.0.15

November 21, 2016
Fixed
  • Fixed PAM signature when some special characters are present

v4.0.14

November 4, 2016
Modified
  • Added ttl parameter for publish

v4.0.13

November 4, 2016
Modified
  • Changed init message log level to debug

v4.0.12

October 31, 2016
Modified
  • Added alert on catchup failure (REQUEST_MESSAGE_COUNT_EXCEEDED)

v4.0.11

October 31, 2016
Modified
  • Added super admin mode (Enabled when secret key is set on Pubnub::Client init)

v4.0.10

October 31, 2016
Modified
  • Better single events timeout handling
  • DRYed envelope formatting a bit

v4.0.9

October 31, 2016
Modified
  • Removed json dependency
  • Updated dependecies

v4.0.8

October 31, 2016
Modified
  • Updated dry-validation.
  • Dropped support for ruby 2.0.

v4.0.7

August 23, 2016
Modified
  • Added message decrypting in history.

v4.0.6

August 17, 2016
Modified
  • channel and channels are the same argument.
  • channel_group and channel_groups are the same argument.
  • added with_presence flag for subscribe, default false.

v4.0.5

August 17, 2016
Modified
  • Required CGI.

v4.0.2

August 17, 2016
Added
  • Added #subscribe_filter for client

v4.0.1

August 17, 2016
Modified
  • Updated dry-validation and EnvelopeSchema.

v4.0.0

August 17, 2016
Added
  • Removed auth_key and uuid setters (#set_auth_key,
Modified
  • Added

v3.8.3

August 17, 2016
Modified
  • Restored auth_key and uuid setters. Important notice: they will be removed

v3.8.2

August 17, 2016
Added
  • Added :include_token parameter to history call.

v3.8.1

August 17, 2016
Modified
  • Updated celluloid dependency.

v3.8.0

August 17, 2017
Modified
  • Release of celluloid version of pubnub gem. It's complete rewrite but public API doesn't change.
Last updated on
On this page