pushradar 2.0.4 → 3.0.0.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a81a450f2c39f7b4e56ca6c5c40671754962dad8
-  data.tar.gz: 992d8b99f0154a689bba984f70ce27e41c46d2fa
+SHA256:
+  metadata.gz: fea818e1295502c3c3361557ab50c818d6820c836283f3966efa3d6d78e7e6e3
+  data.tar.gz: 15fdd2749967ad5aa968aba4991c27940c36032e93ed2b429f7fc063f67f8252
 SHA512:
-  metadata.gz: a74947a6e1a097c2787edc6fbe3f70978a6bc202c0d5073b8e15fac1e3d7cc533f987b4fd90cf554697a7c3e6353072dda9c9ca96c9cf505d0c70cb9719818cb
-  data.tar.gz: b5b1ff5840040326bede1f0ec60973655bd92c8408be946c2a91395a9adabe3f60f900d4156f484b9f17e133735abcbb8f214767e2af88de503a2e5ae522d035
+  metadata.gz: f07920a98b154a8fbb5b322caed9447bf61f231a258b6b6775208a7e98360bd45b11758de3902c419c7349fde0d37294756b54bc2181b33c4cd11ae327a00d16
+  data.tar.gz: d8e53e91270839a55509cf8e88c5a04600c7b51a133cde5d5c37e17875005331277f11d3c93238aab26f4d844667dd2ccd8d17c04b81dfec546ed5132bba1ae5

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/CHANGELOG.md

@@ -1,44 +1,3 @@
-### 2.0.4 (2019-07-06)
+## 3.0.0-alpha.1 (2021-02-08)
 
-* Changed to send channel name to server in channel_auth method
-
-### 2.0.3 (2019-07-04)
-
-* Minor changes
-
-### 2.0.2 (2019-07-04)
-
-* Stable release for next version of PushRadar (PushRadar 2)
-
-### 2.0.0 (2019-07-04)
-
-* Version 2 of the platform
-
-### 1.8.2 (2019-07-04)
-
-* 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,80 +1,88 @@
-<p align="center"><img src="https://pushradar.s3-eu-west-2.amazonaws.com/v2/img/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/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('sk_fdcaf6a6-bf6f-4dea-9406-16320cca95e6')
+channel_name = params[:channelName]
+# is user allowed to access channel?
+if true
+      return {'token': radar.auth(channel_name)}.to_json
+end
+```
+
+Then register your authentication endpoint by calling the `auth(...)` method client-side:
+
+```javascript
+radar.auth('/auth');
+```
+
+## Complete Documentation
+
+Complete documentation for PushRadar's Ruby server library can be found at: <https://pushradar.com/docs/3.x?lang=ruby>
+
+## License
+
+Copyright 2021, PushRadar. PushRadar's Ruby server library is licensed under the MIT license:
+http://www.opensource.org/licenses/mit-license.php

data/Rakefile

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

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,81 @@
+require 'net/http'
+require 'json'
+require 'cgi'
+
+module PushRadar
+  class Client
+    def initialize(secret_key)
+      unless secret_key.is_a?(String) && 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)
+      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 })
+
+      if response[:status] === 200
+        true
+      else
+        raise PushRadar::Error, 'An error occurred while calling the API. Server returned: ' + response[:body].to_json
+      end
+    end
+
+    def auth(channel_name)
+      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.'
+      end
+
+      response = do_http_request('GET', @api_endpoint + "/channels/auth?channel=" + CGI.escape(channel_name), {})
+      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
+      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

data/lib/pushradar/version.rb

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

data/pushradar.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/pushradar/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = "pushradar"
+  s.version = PushRadar::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors = ["PushRadar"]
+  s.email = ["contact@pushradar.com"]
+  s.homepage = "https://github.com/PushRadar/pushradar-server-ruby"
+  s.summary = %q{PushRadar Ruby server library}
+  s.description = %q{PushRadar's official Ruby server library}
+  s.license = "MIT"
+
+  s.add_dependency "multi_json", "~> 1.15"
+  s.add_dependency "httpclient", "~> 2.8"
+  s.add_dependency "json", "~> 2.3"
+
+  s.add_development_dependency "rake", "~> 13.0"
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -1,73 +1,91 @@
 --- !ruby/object:Gem::Specification
 name: pushradar
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 3.0.0.pre.alpha.1
 platform: ruby
 authors:
 - PushRadar
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2019-07-06 00:00:00.000000000 Z
+date: 2021-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.15'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-description: 
+        version: '13.0'
+description: PushRadar's official Ruby server library
 email:
 - contact@pushradar.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".document"
+- ".gemtest"
 - ".gitignore"
-- ".idea/.rakeTasks"
-- ".idea/PushRadarRuby.iml"
-- ".idea/inspectionProfiles/Project_Default.xml"
-- ".idea/misc.xml"
-- ".idea/modules.xml"
-- ".idea/vcs.xml"
-- ".idea/workspace.xml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
-- PushRadar.gemspec
 - README.md
 - Rakefile
-- VERSION
-- bin/console
-- bin/setup
-- lib/PushRadar.rb
-- lib/PushRadar/APIClient.rb
-- lib/PushRadar/Targeting.rb
-- lib/PushRadar/Utils.rb
-- lib/PushRadar/version.rb
-homepage: https://github.com/pushradar/pushradar-ruby
+- lib/pushradar.rb
+- lib/pushradar/client.rb
+- lib/pushradar/version.rb
+- pushradar.gemspec
+homepage: https://github.com/PushRadar/pushradar-server-ruby
 licenses:
 - MIT
 metadata: {}
@@ -82,13 +100,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: PushRadar's official Ruby library, wrapping the PushRadar API.
+summary: PushRadar Ruby server library
 test_files: []