pushradar 3.0.0.pre.alpha.1 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fea818e1295502c3c3361557ab50c818d6820c836283f3966efa3d6d78e7e6e3
-  data.tar.gz: 15fdd2749967ad5aa968aba4991c27940c36032e93ed2b429f7fc063f67f8252
+  metadata.gz: a3f0b3697a50e61ecbfc19f3a3013e0d3f96d9a2de94bdf009d51bc597dc2494
+  data.tar.gz: c17c7b4153c113cda86396d09e63735cd1351bcc7207c69eaa599c525046db0d
 SHA512:
-  metadata.gz: f07920a98b154a8fbb5b322caed9447bf61f231a258b6b6775208a7e98360bd45b11758de3902c419c7349fde0d37294756b54bc2181b33c4cd11ae327a00d16
-  data.tar.gz: d8e53e91270839a55509cf8e88c5a04600c7b51a133cde5d5c37e17875005331277f11d3c93238aab26f4d844667dd2ccd8d17c04b81dfec546ed5132bba1ae5
+  metadata.gz: 4d8124eb2217e3c4493a0af5ca5fc6e0c802e24ff2b813f7c14fc44f6129d10129893ebc7cb0c028163cee5aa94d443f49d0744bb035c51ec94a7d4331bee4c9
+  data.tar.gz: fc0d142f4d794d6e021f5f2e322bb5f7b42f4ce2510d23b30d0f6344455d817ffc2916bfae860d17f7a27322a4274d585c353cd3f6d595f065314d4538ee8aa5

data/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml
+# Editor-based HTTP Client requests
+/httpRequests/

data/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="Rubocop" enabled="false" level="WARNING" enabled_by_default="false" />
+  </profile>
+</component>

data/.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" project-jdk-name="ruby-2.6.3-p62" project-jdk-type="RUBY_SDK" />
+</project>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/pushradar-server-ruby.iml" filepath="$PROJECT_DIR$/.idea/pushradar-server-ruby.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/pushradar-server-ruby.iml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v1.17.2, ruby-2.6.3-p62) [gem]" level="application" />
+  </component>
+</module>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 3.1.1 (2022-06-25)
+
+[CHANGED] Modified documentation
+
+## 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
+
 ## 3.0.0-alpha.1 (2021-02-08)
 
 [NEW] Work on base code of package, compatible with the next release of PushRadar

data/README.md

@@ -42,13 +42,13 @@ Alterntively, install manually by running `$ gem install pushradar`
 require 'pushradar'
 
 radar = PushRadar::Client.new('your-secret-key')
-radar.broadcast('channel-1', {message: 'Hello world!'})
+radar.broadcast('channel-1', { message: 'Hello world!' })
 ```
 
 ## Receiving Messages
 
 ```html
-<script src="https://pushradar.com/js/v3/pushradar.min.js"></script>
+<script src="https://js.pushradar.com/v3/pushradar.min.js"></script>
 <script>
     var radar = new PushRadar('your-public-key');
     radar.subscribe.to('channel-1', function (data) {
@@ -64,11 +64,12 @@ Private channels require authentication and start with the prefix **private-**.
 You will need to set up an authentication endpoint that returns a token using the `auth(...)` method if the user is allowed to subscribe to the channel. For example:
 
 ```ruby
-radar = PushRadar::Client.new('sk_fdcaf6a6-bf6f-4dea-9406-16320cca95e6')
+radar = PushRadar::Client.new('your-secret-key')
 channel_name = params[:channelName]
+socket_id = params[:socketID]
 # is user allowed to access channel?
 if true
-      return {'token': radar.auth(channel_name)}.to_json
+  return { 'token': radar.auth(channel_name, socket_id) }.to_json
 end
 ```
 
@@ -78,11 +79,36 @@ 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
 
-Copyright 2021, PushRadar. PushRadar's Ruby server library is licensed under the MIT license:
-http://www.opensource.org/licenses/mit-license.php
+Copyright © 2021, PushRadar. PushRadar's Ruby server library is licensed under the MIT license:
+<https://opensource.org/licenses/mit-license.php>

data/VERSION

@@ -0,0 +1 @@
+3.1.1

data/lib/pushradar/client.rb

@@ -5,7 +5,11 @@ require 'cgi'
 module PushRadar
   class Client
     def initialize(secret_key)
-      unless secret_key.is_a?(String) && secret_key.start_with?('sk_')
+      unless secret_key.is_a?(String)
+        raise PushRadar::Error, 'Secret key must be a string.'
+      end
+
+      unless secret_key.start_with?('sk_')
         raise PushRadar::Error, 'Please provide your PushRadar secret key. You can find it on the API page of your dashboard.'
       end
 
@@ -22,34 +26,68 @@ module PushRadar
     end
 
     def broadcast(channel_name, data)
+      unless channel_name.is_a?(String)
+        raise PushRadar::Error, 'Channel name must be a string.'
+      end
+
       if channel_name.nil? || channel_name.strip.empty?
         raise PushRadar::Error, 'Channel name empty. Please provide a channel name.'
       end
 
       validate_channel_name(channel_name)
-      response = do_http_request('POST', @api_endpoint + "/broadcasts", { channel: channel_name.strip, data: data })
+      response = do_http_request('POST', @api_endpoint + "/broadcasts", { channel: channel_name, data: data.to_json })
 
       if response[:status] === 200
         true
       else
-        raise PushRadar::Error, 'An error occurred while calling the API. Server returned: ' + response[:body].to_json
+        raise PushRadar::Error, 'An error occurred while calling the API. Server returned: ' + response[:body]
       end
     end
 
-    def auth(channel_name)
+    def auth(channel_name, socket_id)
+      unless channel_name.is_a?(String)
+        raise PushRadar::Error, 'Channel name must be a string.'
+      end
+
       if channel_name.nil? || channel_name.strip.empty?
         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
 
-      response = do_http_request('GET', @api_endpoint + "/channels/auth?channel=" + CGI.escape(channel_name), {})
+      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('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, 'There was a problem receiving a channel authentication token. Server returned: ' + response[:body].to_json
+        raise PushRadar::Error, 'An error occurred while calling the API. Server returned: ' + response[:body]
       end
     end
 

data/lib/pushradar/version.rb

@@ -1,3 +1,3 @@
 module PushRadar
-  VERSION = '3.0.0-alpha.1'
+  VERSION = '3.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pushradar
 version: !ruby/object:Gem::Version
-  version: 3.0.0.pre.alpha.1
+  version: 3.1.1
 platform: ruby
 authors:
 - PushRadar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-08 00:00:00.000000000 Z
+date: 2022-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -76,11 +76,18 @@ files:
 - ".document"
 - ".gemtest"
 - ".gitignore"
+- ".idea/.gitignore"
+- ".idea/inspectionProfiles/Project_Default.xml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/pushradar-server-ruby.iml"
+- ".idea/vcs.xml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- VERSION
 - lib/pushradar.rb
 - lib/pushradar/client.rb
 - lib/pushradar/version.rb
@@ -100,11 +107,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: PushRadar Ruby server library