pushradar 3.0.0.pre.alpha.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fea818e1295502c3c3361557ab50c818d6820c836283f3966efa3d6d78e7e6e3
-  data.tar.gz: 15fdd2749967ad5aa968aba4991c27940c36032e93ed2b429f7fc063f67f8252
+  metadata.gz: 9edffa9f99b71bf60f915bfc6a4d91be7481491a29e84214fa36aa68e2e669cc
+  data.tar.gz: a3e47791e64cd2796ce5cb0820c0af3d5dc2c4b0282f693f256264e5a22015e9
 SHA512:
-  metadata.gz: f07920a98b154a8fbb5b322caed9447bf61f231a258b6b6775208a7e98360bd45b11758de3902c419c7349fde0d37294756b54bc2181b33c4cd11ae327a00d16
-  data.tar.gz: d8e53e91270839a55509cf8e88c5a04600c7b51a133cde5d5c37e17875005331277f11d3c93238aab26f4d844667dd2ccd8d17c04b81dfec546ed5132bba1ae5
+  metadata.gz: e8b05a7441edc5070490c0a909b0800105fe361a99a7f34965d94d4e0253be4bab21c2b18c8128e3a8d24a35468555c691d0a2f0c1eebbe9df1a988c3f7eec4d
+  data.tar.gz: e6c32fc1588940ff1ea0f8cd991dcbc4256b47befa4c92cacadd316eda1df46b00efd36284d842ef5e09c238893bd73525405100d80cc1502711335df463c1fb

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,7 @@
+## 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,7 +42,7 @@ 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
@@ -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
 ```
 
@@ -84,5 +85,5 @@ Complete documentation for PushRadar's Ruby server library can be found at: <htt
 
 ## 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.0.0

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,21 +26,29 @@ 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
@@ -45,11 +57,19 @@ module PushRadar
         raise PushRadar::Error, 'Channel authentication can only be used with private 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']
       else
-        raise PushRadar::Error, 'There was a problem receiving a channel authentication token. Server returned: ' + response[:body].to_json
+        raise PushRadar::Error, 'There was a problem receiving a channel authentication token. 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.0.0'
 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.0.0
 platform: ruby
 authors:
 - PushRadar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-08 00:00:00.000000000 Z
+date: 2021-02-18 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,9 +107,9 @@ 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
 signing_key: