pandapush 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1124a21f335f2328c4c303a75158a03297426e5d
-  data.tar.gz: 9059f4727900b469a8615220758bf3847beea5c7
+  metadata.gz: e8a77d5f3168132be3b18834c92d797ce3067dee
+  data.tar.gz: 65437b6baed64c1659b6fd2da239b0537432ecb0
 SHA512:
-  metadata.gz: f737da5048654c97d087af1117f88198d8af44391d0d00588754f751b261a8f034db8665d3af0862660fae7085ac2796b0fc2d04b7a5b3eba6214d5f253eabee
-  data.tar.gz: 2c02db28f3f164083755bded1c9c0046c75d43fc7d2f9c7a5fb262b3d191dccb003092c931d262c6064acc6ceb4310c112ab1250342b72067a1f693115766982
+  metadata.gz: 4ea71338a8eb17f99b27d376228a079d8ec1392bc5d19d03503c50fab401356a6d5f83a33c32e3d223c94164a5c183a196f4cb290cf279798365a51bb606d5c6
+  data.tar.gz: bba65a6930f72b19e9d8ac42fb1f2a22605cc2a5ff0fad10923099cbc4bbb355ed4fa8ea0a40d7f01287ecea5613a61ab3e0afb5f6fb3db14c89d67abeb6bf82

data/README.md

@@ -20,6 +20,8 @@ Or add it to your `Gemfile`:
 gem 'pandapush'
 ```
 
+Note: Pandapush 1.1.0+ requires Ruby 2.1+ due to its use of required named parameters.
+
 ## Setup
 
 Create `/config/initializers/pandapush.rb` and add:
@@ -32,59 +34,61 @@ Pandapush.secret = 'YOUR APP SECRET'
 
 ## Usage
 
-To publish a message:
+To publish a message to `/{your app id}/private/messages`:
 
 ```ruby
-Pandapush.publish('messages', {user: {id: 1, name: 'Neil Gupta', email: 'neil@instructure.com'}})
+client.publish(channel: 'messages', message: {user: {id: 1, name: 'Neil Gupta', email: 'neil@instructure.com'}})
 ```
 
-To generate a token for a JS client:
+To generate a token for a JS client to publish (but not subscribe) to `/{your app id}/private/messages`:
 
 ```ruby
-Pandapush.generate_token('messages')
+Pandapush.generate_token(channel: 'messages', sub: false)
 ```
 
 If, for some reason, you need to use multiple Pandapush API keys, you can also initialize your own client with
 
 ```ruby
-client = Pandapush::Client.new({
+client = Pandapush::Client.new(
   app_id: 'YOUR APP ID',
   key: 'YOUR APP KEY',
   secret: 'YOUR APP SECRET'
-})
+)
 
-client.publish('messages', {user: {id: 1, name: 'Neil Gupta', email: 'neil@instructure.com'}})
+client.publish(channel: 'messages', message: {user: {id: 1, name: 'Neil Gupta', email: 'neil@instructure.com'}})
 ```
 
 ## Documentation
 
-### Pandapush.publish(channel, message, is_public)
+### Pandapush.publish(channel:, message, channel_type: 'private')
 
 Sends a message to a Pandapush channel.
 
-* `channel` - The name of the channel to push to
-* `message` - hash that will be JSON encoded
-* `is_public` - boolean for whether this channel is public. Defaults to false
+* `channel` - The name of the channel to push to (required)
+* `message` - hash that will be JSON encoded (required)
+* `channel_type` - 'public' or 'private'. Defaults to private
 
 Example:
 
 ```ruby
-Pandapush.publish('messages', {user: {id: 1, name: 'Neil Gupta', email: 'neil@instructure.com'}})
+Pandapush.publish(channel: 'messages', message: {user: {id: 1, name: 'Neil Gupta', email: 'neil@instructure.com'}})
 ```
 
-### Pandapush.generate_token(channel, is_public, pub, sub)
+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)
 
 Generates a JWT token for client authentication.
 
-* `channel` - The channel name the token works for
-* `is_public` - boolean for whether this channel is public. Defaults to false
+* `channel` - The channel name the token works for (required)
+* `channel_type` - 'public' or 'private'. 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
 
 Example:
 
 ```ruby
-Pandapush.generate_token('messages')
+Pandapush.generate_token(channel: 'messages')
 ```
 
 ### Pandapush.app_id

data/lib/pandapush/client.rb

@@ -6,42 +6,38 @@ module Pandapush
 
     attr_accessor :app_id, :key, :secret, :url
 
-    def initialize(options = {})
-      options = {
-        url: 'https://pp-beta.instructure.com/channel'
-      }.merge(options)
-
-      @app_id, @key, @secret, @url = options.values_at(:app_id, :key, :secret, :url)
+    def initialize(app_id: nil, key: nil, secret: nil, url: 'https://pp-beta.instructure.com/channel')
+      @app_id, @key, @secret, @url = app_id, key, secret, url
     end
 
     # publish - sends a message to a Pandapush channel
-    #   channel - The name of the channel to push to
-    #   message - hash that will be JSON encoded
-    #   is_public - boolean for whether this channel is public or private. Defaults to false
-    # 
+    #   channel - The name of the channel to push to (required)
+    #   message - hash that will be JSON encoded (required)
+    #   channel_type - 'public' or 'private'. Defaults to private
+    #
     # @example
-    #   client.publish('messages', {user: {id: 1, name: 'Neil Gupta', email: 'neil@instructure.com'}})
-    def publish(channel, message, is_public = false)
+    #   client.publish(channel: 'messages', message: {user: {id: 1, name: 'Neil Gupta', email: 'neil@instructure.com'}})
+    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, is_public, true), message.to_json, 
-                      {:content_type => :json, :Authorization => "Token #{generate_token(channel, is_public)}"}
+
+      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
 
     # generate_token - returns a JWT token for client authentication
-    #   channel - The channel name the token works for
-    #   is_public - boolean for whether this channel is public or private. Defaults to false
+    #   channel - The channel name the token works for (required)
+    #   channel_type - 'public' or 'private'. 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
-    # 
+    #   sub - true if this token allows subscribing. Defaults to true
+    #
     # @example
-    #   client.generate_token('messages')
-    def generate_token(channel, is_public = false, pub = true, sub = true)
+    #   client.generate_token(channel: 'messages', sub: false)
+    def generate_token(channel:, channel_type: 'private', pub: true, sub: true)
       raise ConfigurationError, 'Missing client configuration: please check that key, secret and app_id are configured.' unless configured?
 
       JWT.encode({
         keyId: key,
-        channel: channel_uri(channel, is_public),
+        channel: channel_uri(channel, channel_type),
         pub: pub,
         sub: sub
       }, secret)
@@ -53,8 +49,8 @@ module Pandapush
       app_id && key && secret && url
     end
 
-    def channel_uri(channel, is_public = false, include_base_url = false)
-      "#{include_base_url ? url : ''}/#{app_id}/#{is_public ? 'public' : 'private'}/#{channel}"
+    def channel_uri(channel, type, include_base_url: false)
+      "#{include_base_url ? url : ''}/#{app_id}/#{type}/#{channel}"
     end
   end
 end

data/lib/pandapush/version.rb

@@ -1,3 +1,3 @@
 module Pandapush
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pandapush
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Neil Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-11 00:00:00.000000000 Z
+date: 2015-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client