pushradar 2.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e658126d203b053e9374f48359144207555b6563
-  data.tar.gz: cc90a66d8a7725c13f37141df80435e3fc7e7398
+SHA256:
+  metadata.gz: 4cb5a3926082d52f847bbb57e800e4c964cb9ea35c005e67c3df6246ceb17a07
+  data.tar.gz: a942aaea6376412ca2addd8d8e760df9919bb99ffe5c4de7164c148c5b306a57
 SHA512:
-  metadata.gz: cdedffae714725bee4d4a3ba7874f3d2975f598f9277a22842fbc1ec364dd524efdcd363291a9ecd9aa04aaa3b92b1dd3a32881c12796203dff5426075b01a4f
-  data.tar.gz: 6035678595a7db5347326ad95161110b3f7c7abaa9b447f4ead82911a702dbbba4d169ac5ec462a6e4f4b4cd84bd706e99f5b128e4acd531b441d4d4896e7281
+  metadata.gz: 99a48b950b8d6d196bbb621c3fb9c7d7a3f08fd9fdc80f8e1edbe7b100358743c48eb68314ebc237e8e64bbdc239391f71992b4e251578200463072d088f06cf
+  data.tar.gz: b7b05961ebc5e0492b55430fc223954fa497b3186eef2a15214da55920acc9af346a654d15096ac8d190749d860860f87c93c7d5e09c8584910ef5882b292dd7

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -1,10 +1,35 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-todo
+.DS_Store
+*.tmproj
+tmtags
+*~
+\#*
+.\#*
+*.swp
+coverage
+rdoc
+pkg
+.yardoc
+Gemfile.lock
+.bundle
+
+/node_modules
+/public/hot
+/public/storage
+/storage/*.key
+/vendor
+.env
+.env.backup
+.env.production
+.phpunit.result.cache
+docker-compose.override.yml
+Homestead.json
+Homestead.yaml
+npm-debug.log
+yarn-error.log
+composer.lock
+phpunit.xml
+tests/config.php
+vendor
+/src/_notUsed
+/_pr-test
+/_notUsed

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

@@ -1,6 +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 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

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectRootManager" version="2" project-jdk-name="ruby-2.4.1-p111" project-jdk-type="RUBY_SDK" />
+<?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

@@ -1,8 +1,8 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/PushRadarRuby.iml" filepath="$PROJECT_DIR$/.idea/PushRadarRuby.iml" />
-    </modules>
-  </component>
+<?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/{PushRadarRuby.iml → pushradar-server-ruby.iml}

@@ -1,13 +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$" />
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-    <orderEntry type="library" scope="PROVIDED" name="bundler (v1.15.3, ruby-2.4.1-p111) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rake (v10.5.0, ruby-2.4.1-p111) [gem]" level="application" />
-  </component>
+<?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

@@ -1,6 +1,6 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
+<?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,36 +1,11 @@
-### 2.0.2 (2019-07-04)
+## 3.1.0 (2021-04-05)
 
-* Stable release for next version of PushRadar (PushRadar 2)
+[NEW] Added support for client data registration
 
-### 2.0.0 (2019-07-04)
+## 3.0.0 (2021-02-18)
 
-* Version 2 of the platform
+[NEW] Updated for release of PushRadar v3
 
-### 1.8.2 (2019-07-04)
+## 3.0.0-alpha.1 (2021-02-08)
 
-* Broadcasting bug fixes
-
-### 1.8.1 (2019-07-04)
-
-* Changed channel auth token generation
-
-### 1.8.0 (2019-07-04)
-
-* New PushRadar API
-* Added channel authentication
-
-### 1.0.2 (2017-08-21)
-
-* Launch of PushRadar
-
-### 1.0.1 (2017-08-16)
-
-* Modifications to continent targeting
-
-### 1.0.0 (2017-08-16)
-
-* Closed beta release
-
-### 0.9.1 (2017-08-13)
-
-* Pre-release of PushRadar's Ruby server library
+[NEW] Work on base code of package, compatible with the next release of PushRadar

data/Gemfile

@@ -1,5 +1,2 @@
-source 'https://rubygems.org'
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
+source "https://rubygems.org"
 gemspec

data/LICENSE

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+The MIT License
 
-Copyright (c) 2019. PushRadar
+Copyright (c) 2021. PushRadar
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,78 +1,114 @@
-## Introduction
-
-[PushRadar](https://www.pushradar.com) is a realtime notifications API service for the web. The service uses a simple publish-subscribe model, allowing you to broadcast "notifications" on "channels" that are subscribed to by one or more clients. Notifications are pushed in realtime to those clients.
-
-PushRadar features advanced targeting options, including the ability to target clients by actions they have taken on your website or web app, geographical location (countries & continents), IP address, web browser and user ID.
-
-This is PushRadar's official Ruby library.
-
-## Prerequisites
-
-In order to use this library, please ensure that you have the following:
-
-- A PushRadar account - you can sign up at [www.pushradar.com](https://www.pushradar.com).
-
-## Installation
-
-To install PushRadar's Ruby gem, add this line to your application's Gemfile:
-
-```ruby
-gem 'pushradar'
-```
-
-And then execute:
-
-```
-$ bundle
-```
-
-Alternatively, you can install it yourself by running the command:
-
-```
-$ gem install pushradar
-``` 
-
-## Getting Started
-
-"Hello World!" example:
-
-```ruby
-require 'PushRadar'
-include PushRadar
-
-radar = Radar.new('your-secret-key')
-radar.broadcast('test-channel', {message: 'Hello World!'})
-```
-
-## Receiving Notifications
-
-To subscribe to channels and receive notifications broadcast on them, check out the documentation for PushRadar's [JavaScript client library](https://www.pushradar.com/documentation/latest/javascript).
-
-## Fluent Syntax
-
-The library supports fluent method chaining to structure broadcasts. For example, to target a notification to website visitors in the US who have not used live chat before:
-
-```ruby
-radar.target_country('US').target_not_action('live-chat').broadcast('test-channel', 
-    {message: 'Would you like to talk to one of our customer support team members on live chat?'})
-```
-
-Please note that targeting options reset after each call to the `broadcast` method.
-
-## Private and Presence Channels
-
-Private and presence channels require authentication before subscribers can receive messages on them.
-
-To generate a channel authentication token, PushRadar provides a convenient `channel_auth` method that you can call from your authentication endpoint:
-
-```ruby
-{authToken: radar.channel_auth("channel-name")}
-```
-
-Please note that private channels must start with the prefix 'private-' and presence channels must start with the prefix 'presence-'.
-
-Read the documentation on [private](https://www.pushradar.com/documentation/latest/private-channels) and [presence](https://www.pushradar.com/documentation/latest/presence-channels) channels to learn more.
-
-## Documentation
-
-Full documentation for PushRadar's Ruby library can be found at: [www.pushradar.com/documentation/latest/ruby](https://www.pushradar.com/documentation/latest/ruby).
+<p align="center"><a href="https://pushradar.com" target="_blank"><img src="https://pushradar.com/images/logo/pushradar-logo-dark.svg" width="300"></a></p>
+
+<p align="center">
+    <a href="https://rubygems.org/gems/pushradar"><img src="https://img.shields.io/gem/v/pushradar?cacheSeconds=60&color=5b86e5"></a>
+    <a href="https://rubygems.org/gems/pushradar"><img src="https://img.shields.io/gem/dt/pushradar?cacheSeconds=60&color=5b86e5"></a>
+    <a href="https://rubygems.org/gems/pushradar"><img src="https://img.shields.io/packagist/l/pushradar/pushradar-server-php?cacheSeconds=60&color=5b86e5"></a>
+</p>
+<br />
+
+## PushRadar Ruby Server Library
+
+[PushRadar](https://pushradar.com) is a realtime API service for the web. The service uses a simple publish-subscribe model, allowing you to broadcast "messages" on "channels" that are subscribed to by one or more clients. Messages are pushed in realtime to those clients.
+
+This is PushRadar's official Ruby server library.
+
+## Prerequisites
+
+In order to use this library, please ensure that you have the following:
+
+- Ruby 2.4+
+- A PushRadar account - you can sign up at [pushradar.com](https://pushradar.com)
+
+## Installation
+
+The easiest way to get up and running is to install the library using bundler. Add the following to your Gemfile:
+
+```ruby
+gem 'pushradar'
+```
+
+And then run bundle install:
+
+```bash
+$ bundle install
+```
+
+Alterntively, install manually by running `$ gem install pushradar`
+
+## Broadcasting Messages
+
+```ruby
+require 'pushradar'
+
+radar = PushRadar::Client.new('your-secret-key')
+radar.broadcast('channel-1', { message: 'Hello world!' })
+```
+
+## Receiving Messages
+
+```html
+<script src="https://pushradar.com/js/v3/pushradar.min.js"></script>
+<script>
+    var radar = new PushRadar('your-public-key');
+    radar.subscribe.to('channel-1', function (data) {
+        console.log(data.message);
+    });
+</script>
+```
+
+## Private Channels
+
+Private channels require authentication and start with the prefix **private-**. We recommend that you use private channels by default to prevent unauthorised access to channels.
+
+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('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, socket_id) }.to_json
+end
+```
+
+Then register your authentication endpoint by calling the `auth(...)` method client-side:
+
+```javascript
+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/ruby>
+
+## License
+
+Copyright © 2021, PushRadar. PushRadar's Ruby server library is licensed under the MIT license:
+<https://opensource.org/licenses/mit-license.php>

data/Rakefile

@@ -1 +1,2 @@
-require 'bundler/gem_tasks'
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/VERSION

@@ -1 +1 @@
-2.0.2
+3.1.0

data/lib/pushradar.rb

@@ -0,0 +1,10 @@
+require 'uri'
+require 'forwardable'
+
+require_relative 'pushradar/client'
+
+module PushRadar
+  class Error < RuntimeError; end
+end
+
+require_relative 'pushradar/version'

data/lib/pushradar/client.rb

@@ -0,0 +1,119 @@
+require 'net/http'
+require 'json'
+require 'cgi'
+
+module PushRadar
+  class Client
+    def initialize(secret_key)
+      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
+
+      @secret_key = secret_key
+      @api_endpoint = 'https://api.pushradar.com/v3'
+    end
+
+    def validate_channel_name(channel_name)
+      if /[^A-Za-z0-9_\-=@,.;]/.match(channel_name)
+        raise PushRadar::Error, "Invalid channel name: #{channel_name}. Channel names cannot contain spaces, and must consist of only " +
+          "upper and lowercase letters, numbers, underscores, equals characters, @ characters, commas, periods, semicolons, " +
+          "and hyphens (A-Za-z0-9_=@,.;-)."
+      end
+    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, data: 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 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-') || 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)
+        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]
+      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)
+      http.use_ssl = true
+
+      if method.downcase === 'post'
+        req = Net::HTTP::Post.new(url)
+        req['X-PushRadar-Library'] = 'pushradar-server-ruby ' + VERSION
+        req['Authorization'] = "Bearer " + @secret_key
+        req.content_type = 'application/json'
+        data = data.to_json
+        req.body = data
+      else
+        req = Net::HTTP::Get.new(url)
+        req['X-PushRadar-Library'] = 'pushradar-server-ruby ' + VERSION
+        req['Authorization'] = "Bearer " + @secret_key
+        req.content_type = 'application/json'
+      end
+
+      response = http.request(req)
+      { body: response.body, status: response.code.to_i }
+    end
+
+    private :validate_channel_name, :do_http_request
+  end
+end