pushradar 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9edffa9f99b71bf60f915bfc6a4d91be7481491a29e84214fa36aa68e2e669cc
-  data.tar.gz: a3e47791e64cd2796ce5cb0820c0af3d5dc2c4b0282f693f256264e5a22015e9
+  metadata.gz: 4cb5a3926082d52f847bbb57e800e4c964cb9ea35c005e67c3df6246ceb17a07
+  data.tar.gz: a942aaea6376412ca2addd8d8e760df9919bb99ffe5c4de7164c148c5b306a57
 SHA512:
-  metadata.gz: e8b05a7441edc5070490c0a909b0800105fe361a99a7f34965d94d4e0253be4bab21c2b18c8128e3a8d24a35468555c691d0a2f0c1eebbe9df1a988c3f7eec4d
-  data.tar.gz: e6c32fc1588940ff1ea0f8cd991dcbc4256b47befa4c92cacadd316eda1df46b00efd36284d842ef5e09c238893bd73525405100d80cc1502711335df463c1fb
+  metadata.gz: 99a48b950b8d6d196bbb621c3fb9c7d7a3f08fd9fdc80f8e1edbe7b100358743c48eb68314ebc237e8e64bbdc239391f71992b4e251578200463072d088f06cf
+  data.tar.gz: b7b05961ebc5e0492b55430fc223954fa497b3186eef2a15214da55920acc9af346a654d15096ac8d190749d860860f87c93c7d5e09c8584910ef5882b292dd7

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 3.1.0 (2021-04-05)
+
+[NEW] Added support for client data registration
+
 ## 3.0.0 (2021-02-18)
 
 [NEW] Updated for release of PushRadar v3

data/README.md

@@ -79,9 +79,34 @@ Then register your authentication endpoint by calling the `auth(...)` method cli
 radar.auth('/auth');
 ```
 
+## Presence Channels
+
+Presence channels require authentication and start with the prefix **presence-**. Presence channels are eligible for 'presence messages' containing information about channel subscribers.
+
+You will need to set up an authentication endpoint as with private channels (see above). You should then register a `onPresence(...)` callback which will be called periodically. Your callback should accept two parameters: subscriber count and subscriber data. For example:
+
+```javascript
+radar.auth('/auth');
+radar.call.on.connection('/connected');
+
+radar.subscribe.to('presence-channel-1', function (data) {
+    console.log(data.message);
+}).onPresence(function (count, clientData) {
+    console.log(count);
+});
+```
+
+If you wish to pass through subscriber (client) data, you can set up an endpoint and pass its URL to the `call.on.connection(...)` method. Your endpoint will be called when a user first connects to the service. From your endpoint you can register client data as follows:
+
+```ruby
+radar = PushRadar::Client.new('your-secret-key')
+socket_id = params[:socketID]
+radar.register_client_data(socket_id, { '##uniqueID': 1, 'name': 'James Smith' })
+```
+
 ## Complete Documentation
 
-Complete documentation for PushRadar's Ruby server library can be found at: <https://pushradar.com/docs/3.x?lang=ruby>
+Complete documentation for PushRadar's Ruby server library can be found at: <https://pushradar.com/docs/3.x/ruby>
 
 ## License
 

data/VERSION

@@ -1 +1 @@
-3.0.0
+3.1.0

data/lib/pushradar/client.rb

@@ -53,8 +53,8 @@ module PushRadar
         raise PushRadar::Error, 'Channel name empty. Please provide a channel name.'
       end
 
-      unless channel_name.start_with?('private-')
-        raise PushRadar::Error, 'Channel authentication can only be used with private channels.'
+      unless channel_name.start_with?('private-') || channel_name.start_with?('presence-')
+        raise PushRadar::Error, 'Channel authentication can only be used with private and presence channels.'
       end
 
       unless socket_id.is_a?(String)
@@ -67,12 +67,30 @@ module PushRadar
 
       response = do_http_request('GET', @api_endpoint + "/channels/auth?channel=" + CGI.escape(channel_name) + "&socketID=" + CGI.escape(socket_id), {})
       if response[:status] === 200
-         JSON(response[:body])['token']
+        JSON(response[:body])['token']
       else
         raise PushRadar::Error, 'There was a problem receiving a channel authentication token. Server returned: ' + response[:body]
       end
     end
 
+    def register_client_data(socket_id, client_data)
+      unless socket_id.is_a?(String)
+        raise PushRadar::Error, 'Socket ID must be a string.'
+      end
+
+      if socket_id.nil? || socket_id.strip.empty?
+        raise PushRadar::Error, 'Socket ID empty. Please pass through a socket ID.'
+      end
+
+      response = do_http_request('POST', @api_endpoint + "/client-data", { socketID: socket_id, clientData: client_data.to_json })
+
+      if response[:status] === 200
+        true
+      else
+        raise PushRadar::Error, 'An error occurred while calling the API. Server returned: ' + response[:body]
+      end
+    end
+
     def do_http_request(method, url, data)
       uri = URI.parse(url)
       http = Net::HTTP.new(uri.host, uri.port)

data/lib/pushradar/version.rb

@@ -1,3 +1,3 @@
 module PushRadar
-  VERSION = '3.0.0'
+  VERSION = '3.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pushradar
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - PushRadar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-18 00:00:00.000000000 Z
+date: 2021-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json