ably 1.1.5 → 1.1.6

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 57c815b3e4e0dc7d47193fc7778dafa3d3dac69712b996c09e87e8021c0d739d
4
- data.tar.gz: de4aecba3dd4d87986d11fdbbde09377b8d543b94ff165d2a89bb4526208fa07
3
+ metadata.gz: fa84b23cf7efa53651ed44ee5ba5fd19fa1e18b63025b5217cb88d069c095b5a
4
+ data.tar.gz: 357ce5eb6984d9a0cbc16a96fd267d45de4325d9b885538a9e09550bead51082
5
5
  SHA512:
6
- metadata.gz: 55548f44c758f2ea9aaa2c5f9ecdfb8a06c812513dd32417980fee828b8da193ea4418b574a312e12c2dfabc68dbb8116c906071549545a65772e2a2c4ad6fc4
7
- data.tar.gz: 3595470c751c1972c27f9914a7da1313c0479d93bb4e1bfcd8157821db0411e6f5c8729fb18eddbf7e4007b59a10e95c6cbd18c00d5b9ef7bc08f3f5f5de6d4b
6
+ metadata.gz: f17679d2f885d6cf61d99996a3ebdc7bcf0b03e6edf8b0ca35c26806199f897e39ce033c1454f0082f643824e703a508d465be217a413e88650b7a04bd3faddb
7
+ data.tar.gz: 3fd85374765d146902fb6f64968fc2f6b9560e40bf168b2d3acf336b6dd94b0f9e98ccf0edcb1b04fb3e38eceb16f41601828c6a4da5a8efe64734e89b1243be
data/CHANGELOG.md CHANGED
@@ -1,7 +1,22 @@
1
1
  # Change Log
2
2
 
3
+ ## [v1.1.6](https://github.com/ably/ably-ruby/tree/v1.1.6)
4
+
5
+ [Full Changelog](https://github.com/ably/ably-ruby/compare/v1.1.5...v1.1.6)
6
+
7
+ This release will have no effect for users of the realtime `ably-ruby` client, however for users of `ably-ruby-rest` it will update the `faraday` dependency to 1.x (this change was already made for `ably-ruby` in `v1.1.5`).
8
+
9
+ **Merged pull requests:**
10
+
11
+ - Document libcurl requirement [\#243](https://github.com/ably/ably-ruby/pull/243) ([owenpearson](https://github.com/owenpearson))
12
+ - Fix broken markdown hyperlink in readme [\#242](https://github.com/ably/ably-ruby/pull/242) ([owenpearson](https://github.com/owenpearson))
13
+ - Update README with new Ably links [\#239](https://github.com/ably/ably-ruby/pull/239) ([mattheworiordan](https://github.com/mattheworiordan))
14
+ - Fix documentation for Channel\#publish [\#183](https://github.com/ably/ably-ruby/pull/183) ([zreisman](https://github.com/zreisman))
15
+
3
16
  ## [v1.1.5](https://github.com/ably/ably-ruby/tree/v1.1.5)
4
17
 
18
+ Please note: this library now depends on `libcurl` as a system dependency. On most systems this is already installed but in rare cases where it isn't (for example debian-slim Docker images such as ruby-slim) you will need to install it yourself. On debian you can install it with the command `sudo apt-get install libcurl4`.
19
+
5
20
  [Full Changelog](https://github.com/ably/ably-ruby/compare/v1.1.4...v.1.1.5)
6
21
 
7
22
  **Implemented enhancements:**
data/README.md CHANGED
@@ -1,21 +1,23 @@
1
- # [Ably](https://www.ably.io)
1
+ # [Ably](https://ably.com)
2
2
 
3
3
  [![Gem Version](https://img.shields.io/gem/v/ably?style=flat)](https://img.shields.io/gem/v/ably?style=flat)
4
4
  [![Coverage Status](https://coveralls.io/repos/ably/ably-ruby/badge.svg)](https://coveralls.io/r/ably/ably-ruby)
5
5
 
6
- A Ruby client library for [ably.io](https://www.ably.io), the realtime messaging service. This library currently targets the [Ably 1.1 client library specification](https://www.ably.io/documentation/client-lib-development-guide/features/). You can jump to the '[Known Limitations](#known-limitations)' section to see the features this client library does not yet support or [view our client library SDKs feature support matrix](https://www.ably.io/download/sdk-feature-support-matrix) to see the list of all the available features.
6
+ A Ruby client library for [ably.com](https://ably.com), the realtime messaging service. This library currently targets the [Ably 1.1 client library specification](https://ably.com/documentation/client-lib-development-guide/features/). You can see the complete list of features this client library supports in [our client library SDKs feature support matrix](https://ably.com/download/sdk-feature-support-matrix).
7
7
 
8
8
  ## Supported platforms
9
9
 
10
10
  This SDK supports Ruby 1.9.3+.
11
11
 
12
+ As of v1.1.5 this library requires `libcurl` as a system dependency. On most systems this is already installed but in rare cases where it isn't (for example debian-slim Docker images such as ruby-slim) you will need to install it yourself. On debian you can install it with the command `sudo apt-get install libcurl4`.
13
+
12
14
  We regression-test the SDK against a selection of Ruby versions (which we update over time, but usually consists of mainstream and widely used versions). Please refer to [.github/workflows/check.yml](./.github/workflows/check.yml) for the set of versions that currently undergo CI testing.
13
15
 
14
- If you find any compatibility issues, please [do raise an issue](https://github.com/ably/ably-ruby/issues/new) in this repository or [contact Ably customer support](https://support.ably.io/) for advice.
16
+ If you find any compatibility issues, please [do raise an issue](https://github.com/ably/ably-ruby/issues/new) in this repository or [contact Ably customer support](https://ably.com/support/) for advice.
15
17
 
16
18
  ## Documentation
17
19
 
18
- Visit https://www.ably.io/documentation for a complete API reference and more examples.
20
+ Visit https://ably.com/documentation for a complete API reference and code examples.
19
21
 
20
22
  ## Installation
21
23
 
@@ -35,7 +37,7 @@ Or install it yourself as:
35
37
 
36
38
  ### Using with Rails or Sinatra
37
39
 
38
- This `ably` gem provides both a [Realtime](http://www.ably.io/documentation/realtime/usage) and [REST](http://www.ably.io/documentation/rest/usage) version of the Ably library. Realtime depends on EventMachine to provide an asynchronous evented framework to run the library in, whereas the REST library depends only on synchronous libraries such as Faraday.
40
+ This `ably` gem provides both a [Realtime](https://ably.com/documentation/realtime/usage) and [REST](https://ably.com/documentation/rest/usage) version of the Ably library. Realtime depends on EventMachine to provide an asynchronous evented framework to run the library in, whereas the REST library depends only on synchronous libraries such as Faraday.
39
41
 
40
42
  If you are using Ably within your Rails or Sinatra apps, more often than not, you probably want to use the REST only version of the library that has no dependency on EventMachine and provides a synchronous API that you will be used to using within Rails and Sinatra. [See the REST only Ruby version of the Ably library](https://github.com/ably/ably-ruby-rest).
41
43
 
@@ -61,7 +63,7 @@ client = Ably::Realtime.new(key: 'xxxxx')
61
63
  client = Ably::Realtime.new(token: 'xxxxx')
62
64
  ```
63
65
 
64
- If you do not have an API key, [sign up for a free API key now](https://www.ably.io/signup)
66
+ If you do not have an API key, [sign up for a free API key now](https://ably.com/signup)
65
67
 
66
68
  ### Connection
67
69
 
@@ -187,7 +189,7 @@ channel.publish "name (not encrypted)", "sensitive data (encrypted before being
187
189
 
188
190
  ### Introduction
189
191
 
190
- Unlike the Realtime API, all calls are synchronous and are not run within an [EventMachine](https://github.com/eventmachine/eventmachine) [reactor](https://github.com/eventmachine/eventmachine/wiki/General-Introduction).
192
+ Unlike the Realtime API, all calls are synchronous and are not run within [EventMachine](https://github.com/eventmachine/eventmachine).
191
193
 
192
194
  All examples assume a client and/or channel has been created as follows:
193
195
 
@@ -295,7 +297,7 @@ If you only need to use the REST features of this library and do not want EventM
295
297
 
296
298
  ## Support, feedback and troubleshooting
297
299
 
298
- Please visit http://support.ably.io/ for access to our knowledgebase and to ask for any assistance.
300
+ Please visit https://ably.com/support for access to our knowledgebase and to ask for any assistance.
299
301
 
300
302
  You can also view the [community reported Github issues](https://github.com/ably/ably-ruby/issues).
301
303
 
@@ -52,8 +52,8 @@ module Ably
52
52
  #
53
53
  # # Publish an array of message Hashes
54
54
  # messages = [
55
- # { name: 'click', { x: 1, y: 2 } },
56
- # { name: 'click', { x: 2, y: 3 } }
55
+ # { name: 'click', data: { x: 1, y: 2 } },
56
+ # { name: 'click', data: { x: 2, y: 3 } }
57
57
  # ]
58
58
  # channel.publish messages
59
59
  #
data/lib/ably/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  module Ably
2
- VERSION = '1.1.5'
2
+ VERSION = '1.1.6'
3
3
  PROTOCOL_VERSION = '1.1'
4
4
 
5
5
  # Allow a variant to be configured for all instances of this client library
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ably
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.5
4
+ version: 1.1.6
5
5
  platform: ruby
6
6
  authors:
7
7
  - Lewis Marshall
@@ -9,7 +9,7 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2021-05-05 00:00:00.000000000 Z
12
+ date: 2021-05-25 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: eventmachine