pushradar 1.0.2 → 1.8.0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 1.8.0 (2019-07-04)
+
+* New PushRadar API
+* Added channel authentication
+
 ### 1.0.2 (2017-08-21)
 
 * Launch of PushRadar

data/Gemfile

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

data/LICENSE

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2017. 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
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+The MIT License (MIT)
+
+Copyright (c) 2019. 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.

data/PushRadar.gemspec

@@ -1,25 +1,25 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'PushRadar/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'pushradar'
-  spec.version       = PushRadar::VERSION
-  spec.authors       = ['PushRadar']
-  spec.email         = ['contact@pushradar.com']
-
-  spec.summary       = %q{PushRadar's official Ruby library, wrapping the PushRadar API.}
-  spec.homepage      = 'https://github.com/pushradar/pushradar-ruby'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'rake', '~> 10.0'
-end
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'PushRadar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pushradar'
+  spec.version       = PushRadar::VERSION
+  spec.authors       = ['PushRadar']
+  spec.email         = ['contact@pushradar.com']
+
+  spec.summary       = %q{PushRadar's official Ruby library, wrapping the PushRadar API.}
+  spec.homepage      = 'https://github.com/pushradar/pushradar-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/README.md

@@ -1,66 +1,80 @@
-<p align="center"><img src="https://www.pushradar.com/img/logo/pushradar_github.png"></p>
-
-## 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/docs/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.
-
-## Documentation
-
+<p align="center"><img src="https://www.pushradar.com/img/logo/pushradar_github.png"></p>
+
+## 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/docs/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 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/docs/ruby](https://www.pushradar.com/docs/latest/ruby).

data/VERSION

@@ -1 +1 @@
-1.0.2
+1.8.0

data/bin/console

@@ -1,6 +1,6 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'irb'
-
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'irb'
+
 IRB.start(__FILE__)

data/bin/setup

@@ -1,6 +1,6 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
 bundle install

data/lib/PushRadar/APIClient.rb

@@ -17,7 +17,7 @@ module PushRadar
       @api_secret = api_secret
 
       # Set the API endpoint
-      @api_endpoint = 'https://api.pushradar.com/v1'
+      @api_endpoint = 'https://api.pushradar.com/v2'
 
     end
 
@@ -25,9 +25,9 @@ module PushRadar
     def post(destination, data)
 
       # Add in the fields that should be sent with each request
-      data['api_secret'] = @api_secret
-      data['client_platform'] = 'ruby'
-      data['request_sent_at'] = Time.now.to_i
+      data['apiSecret'] = @api_secret
+      data['clientPlatform'] = 'ruby'
+      data['timestamp'] = Time.now.to_i
 
       # Make sure the destination does not contain the base URL or forward slash characters
       destination = destination.gsub('/', '')

data/lib/PushRadar/Targeting.rb

@@ -7,10 +7,6 @@ module PushRadar
   # Specifies the target audience of a PushRadar notification
   class Targeting
 
-    # ------------------------------
-    # Initialization & configuration
-    # ------------------------------
-
     # Creates a new notification targeting object
     def initialize
 
@@ -25,10 +21,6 @@ module PushRadar
 
     end
 
-    # ------------------------------
-    # Browser targeting
-    # ------------------------------
-
     # Adds a browser to the list of target browsers
     def target_browser(browser)
 
@@ -48,10 +40,6 @@ module PushRadar
 
     end
 
-    # ------------------------------
-    # Country targeting
-    # ------------------------------
-
     # Adds a country to the list of target countries
     def target_country(country_code)
 
@@ -76,10 +64,6 @@ module PushRadar
 
     end
 
-    # ------------------------------
-    # Continent targeting
-    # ------------------------------
-
     # Targets a continent by its continent code
     def target_continent(continent_code)
 
@@ -95,10 +79,6 @@ module PushRadar
 
     end
 
-    # ------------------------------
-    # IP address targeting
-    # ------------------------------
-
     # Targets the notification to clients with the given IP address
     def target_ip(ip_address)
 
@@ -127,60 +107,52 @@ module PushRadar
 
     end
 
-    # ------------------------------
-    # Action targeting
-    # ------------------------------
-
     # Targets the notification to clients who have taken the given action
-    def target_action(action_identifier)
+    def target_action(action)
 
       # Trim the action identifier
-      action_identifier.strip!
+      action.strip!
 
       # Make sure the action identifier is not empty
-      if action_identifier == ''
+      if action == ''
         raise 'The action identifier cannot be empty'
       end
 
       # Make sure that the action is not in the target "not" actions list
-      if @target_not_actions.include? action_identifier
-        raise "Action '" + action_identifier + "' is already in the 'not' actions list."
+      if @target_not_actions.include? action
+        raise "Action '" + action + "' is already in the 'not' actions list."
       end
 
       # Add the action to the list
-      unless @target_actions.include? action_identifier
-        @target_actions.push action_identifier
+      unless @target_actions.include? action
+        @target_actions.push action
       end
 
     end
 
     # Targets the notification to clients who have not taken the given action
-    def target_not_action(action_identifier)
+    def target_not_action(action)
 
       # Trim the action identifier
-      action_identifier.strip!
+      action.strip!
 
       # Make sure the action identifier is not empty
-      if action_identifier == ''
+      if action == ''
         raise 'The action identifier cannot be empty'
       end
 
       # Make sure that the action is not in the target actions list
-      if @target_actions.include? action_identifier
-        raise "Action '" + action_identifier + "' is already in the actions list."
+      if @target_actions.include? action
+        raise "Action '" + action + "' is already in the actions list."
       end
 
       # Add the action to the list
-      unless @target_not_actions.include? action_identifier
-        @target_not_actions.push action_identifier
+      unless @target_not_actions.include? action
+        @target_not_actions.push action
       end
 
     end
 
-    # ------------------------------
-    # User targeting
-    # ------------------------------
-
     # Targets the notification to a specific user (identifier by their user ID)
     def target_user(user_id)
 

data/lib/PushRadar/Utils.rb

@@ -6,10 +6,6 @@ module PushRadar
   # Contains helpful methods that are used throughout the library
   class Utils
 
-    # ------------------------------
-    # Collection utilities
-    # ------------------------------
-
     # Searches the given dictionary for values matching the value provided, and returns the keys of those elements
     def self.keys_where_value(dictionary, value)
 
@@ -26,10 +22,6 @@ module PushRadar
 
     end
 
-    # ------------------------------
-    # Location utilities
-    # ------------------------------
-
     # Gets a hash that associates ISO 3166-1 alpha-2 country codes with country names
     def self.get_countries
 
@@ -549,10 +541,6 @@ module PushRadar
 
     end
 
-    # ------------------------------
-    # IP address utilities
-    # ------------------------------
-
     # Checks whether the given IP address is valid
     def self.is_valid_ip(addr)
       case addr

data/lib/PushRadar/version.rb

@@ -1,3 +1,3 @@
-module PushRadar
-  VERSION = '1.0.2'
+module PushRadar
+  VERSION = '1.8.0'
 end