pandapush 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ebb3e7ba70e437ae721f98024ffc4bc745765e76
+  data.tar.gz: c0d945e17bbcb367f445cd96f1d4a5ddf04bcd9a
+SHA512:
+  metadata.gz: 385c36ba0abcc3765eba953db895769afd22eaffbbf27e3c88ac67a194300e5380a85e722c784ec87286466e06f7b1f4035520ab22c93a31b4dd670e5fddf55c
+  data.tar.gz: 879ead1eadb40cdddec612ea7014c3c35249447fe1373d6e187ed4cdb724594c97f021a5ead6a9b657201e539b585099706aefbbc6a61add7a993ee616cfcd81

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+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.

data/README.md

@@ -0,0 +1,114 @@
+# 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.
+
+## Installation
+
+Install the gem on your machine:
+
+```
+gem install pandapush
+```
+
+Or add it to your `Gemfile`:
+
+```ruby
+gem 'pandapush'
+```
+
+## Setup
+
+Create `/config/initializers/pandapush.rb` and add:
+
+```ruby
+Pandapush.app_id = 'YOUR APP ID'
+Pandapush.key = 'YOUR APP KEY'
+Pandapush.secret = 'YOUR APP SECRET'
+```
+
+## Usage
+
+To publish a message:
+
+```ruby
+Pandapush.publish('messages', {user: {id: 1, name: 'Neil Gupta', email: 'neil@instructure.com'}})
+```
+
+To generate a token for a JS client:
+
+```ruby
+Pandapush.generate_token('messages')
+```
+
+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({
+  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'}})
+```
+
+## Documentation
+
+### Pandapush.publish(channel, message, is_public)
+
+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
+
+Example:
+
+```ruby
+Pandapush.publish('messages', {user: {id: 1, name: 'Neil Gupta', email: 'neil@instructure.com'}})
+```
+
+### Pandapush.generate_token(channel, is_public, pub, sub)
+
+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
+* `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.app_id
+
+Getter and setter for your app id.
+
+### Pandapush.key
+
+Getter and setter for your app key.
+
+### Pandapush.secret
+
+Getter and setter for your app secret.
+
+### Pandapush.url
+
+Getter and setter to override the default url we use for Pandapush. This should never be used/needed.
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/pandapush.rb

@@ -0,0 +1,27 @@
+require 'forwardable'
+require 'pandapush/client'
+
+module Pandapush
+  # All errors descend from this class so they can be easily rescued
+  #
+  # @example
+  #   begin
+  #     Pandapush.publish('channel_name', {some: 'data'})
+  #   rescue Pandapush::Error => e
+  #     # Do something on error
+  #   end
+  class Error < RuntimeError; end
+  class ConfigurationError < Error; end
+
+  class << self
+    extend Forwardable
+
+    def_delegators :client, :app_id, :key, :secret, :url
+    def_delegators :client, :app_id=, :key=, :secret=, :url=
+    def_delegators :client, :publish, :generate_token
+
+    def client
+      @client ||= Pandapush::Client.new
+    end
+  end
+end

data/lib/pandapush/client.rb

@@ -0,0 +1,62 @@
+require 'httparty'
+require 'jwt'
+
+module Pandapush
+  class Client
+
+    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)
+    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
+    # 
+    # @example
+    #   client.publish('messages', {user: {id: 1, name: 'Neil Gupta', email: 'neil@instructure.com'}})
+    def publish(channel, message, is_public = false)
+      raise ConfigurationError, 'Missing client configuration: please check that key, secret and app_id are configured.' unless configured?
+      
+      HTTParty.post(channel_uri(channel, is_public, true), 
+                    basic_auth: { username: key, password: secret }, 
+                    body: message.to_json, 
+                    headers: {"Content-Type" => "application/json"})
+    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
+    #   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
+    #   client.generate_token('messages')
+    def generate_token(channel, is_public = false, 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),
+        pub: pub,
+        sub: sub
+      }, secret)
+    end
+
+    private
+
+    def configured?
+      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}"
+    end
+  end
+end

data/lib/pandapush/version.rb

@@ -0,0 +1,3 @@
+module Pandapush
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: pandapush
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Neil Gupta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.18.0
+description: Pandapush is Instructure's internal pub/sub server. This is a ruby client
+  for that server.
+email: neil@instructure.com
+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
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Ruby client for pushing to Pandapush
+test_files: []
+has_rdoc: