pandapush 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed1f11964261dd089725408b9b0cdafbdb102f84
-  data.tar.gz: e5089f52a913070a54bcc123bac308f6dd0711b0
+  metadata.gz: 7eaf114b2127c4e9c12b3957c3fab1587d78b1f4
+  data.tar.gz: 76f9166307aa27257b5915c6a8be0152e5267a90
 SHA512:
-  metadata.gz: 20348abcdf6f57480d05f9ac8d99648659cd43c876e96f80ba42d2b2d80f2a29c47dec902dac261c4b0eda9147befec26039599537c51713137374117d93fe25
-  data.tar.gz: 28ae36cb4cba536455417959906e110e323b705e5a6c75e15bcf0da7f188fa1066513364dba4f2335c7d9c1426d1a4333d1a2d6fa961d18ad7128b3c42740ee4
+  metadata.gz: 00cadbacf74c653b7d730560c8f6108ba556fc2ca1d451f6fc4f839fd44dd29df6f1e88c759c1b197d0118abfd186d1aaa4e012bf05131cf6f4b41bcf75f0e7c
+  data.tar.gz: 6beea7e93ad36f7bcb806dd15c0291066420890ca0e033418ba3709d3a289a024ddfc7d1bb8f8bffb48a630cba72d9b72ad3a35e9bc751ee14db590a3f21162f

data/README.md

@@ -1,7 +1,5 @@
 # Pandapush
 
-[https://www.github.com/neilgupta/pandapush](https://www.github.com/neilgupta/pandapush)
-
 [![Gem Version](https://badge.fury.io/rb/pandapush.png)](http://badge.fury.io/rb/pandapush)
 
 Pandapush is an event push system similar to Pusher for internal Instructure use.
@@ -76,14 +74,15 @@ Pandapush.publish(channel: 'messages', message: {user: {id: 1, name: 'Neil Gupta
 
 Note: `channel` is a string and can be any valid uri, such as `'users/1'`. Pandapush will handle generating the URL with your app id and channel type.
 
-### Pandapush.generate_token(channel:, channel_type: 'private', pub: true, sub: true)
+### Pandapush.generate_token(channel:, channel_type: 'private', pub: true, sub: true, presence: nil)
 
 Generates a JWT token for client authentication.
 
 * `channel` - The channel name the token works for (required)
-* `channel_type` - 'public' or 'private'. Defaults to private
+* `channel_type` - 'public', 'private', or 'presence'. Defaults to private
 * `pub` - true if this token allows publishing. Defaults to true
 * `sub` - true if this token allows subscribing. Note that sub on a public channel is redundant. Defaults to true
+* `presence` - A hash used to identify a user when subscribing to a presence channel. Must have at least an `id` key.
 
 Example:
 
@@ -105,14 +104,6 @@ Getter and setter for your app secret.
 
 ### Pandapush.url
 
-Getter and setter to override the default url we use for Pandapush.
+Getter and setter to override the default url we use for Pandapush. Useful for running dockerized pandapush.
 
 All methods can also be accessed from `Pandapush::Client.new`.
-
-## Author
-
-Neil Gupta [http://metamorphium.com](http://metamorphium.com)
-
-## License
-
-The MIT License (MIT) Copyright (c) 2015 Neil Gupta. See [MIT-LICENSE](https://raw.github.com/neilgupta/pandapush/master/MIT-LICENSE)

data/lib/pandapush/client.rb

@@ -20,7 +20,7 @@ module Pandapush
     def publish(channel:, message:, channel_type: 'private')
       raise ConfigurationError, 'Missing client configuration: please check that key, secret and app_id are configured.' unless configured?
 
-      RestClient.post channel_uri(channel, channel_type, include_base_url: true), message.to_json, 
+      RestClient.post channel_uri(channel, channel_type, include_base_url: true), message.to_json,
                       {:content_type => :json, :Authorization => "Token #{generate_token(channel: channel, channel_type: channel_type)}"}
     end
 
@@ -32,15 +32,19 @@ module Pandapush
     #
     # @example
     #   client.generate_token(channel: 'messages', sub: false)
-    def generate_token(channel:, channel_type: 'private', pub: true, sub: true)
+    def generate_token(channel:, channel_type: 'private', pub: true, sub: true, presence: nil)
       raise ConfigurationError, 'Missing client configuration: please check that key, secret and app_id are configured.' unless configured?
 
-      JWT.encode({
+      payload = {
         keyId: key,
         channel: channel_uri(channel, channel_type),
         pub: pub,
         sub: sub
-      }, secret)
+      }
+
+      payload[:presence] = presence if presence
+
+      JWT.encode(payload, secret)
     end
 
     private

data/lib/pandapush/version.rb

@@ -1,3 +1,3 @@
 module Pandapush
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pandapush
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Neil Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-21 00:00:00.000000000 Z
+date: 2017-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -101,15 +101,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
 - README.md
 - Rakefile
 - lib/pandapush.rb
 - lib/pandapush/client.rb
 - lib/pandapush/version.rb
-homepage: https://github.com/neilgupta/pandapush
-licenses:
-- MIT
+homepage: https://instructure.com
+licenses: []
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -127,9 +125,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby client for pushing to Pandapush
 test_files: []
-has_rdoc: 

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright 2015 Neil Gupta
-
-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.