viaduct-webpush 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 18d110157e02cd4d3a06114d0cf940ac589edf46
+  data.tar.gz: 863edbc6adc567e905450a95b828c2294eecef39
+SHA512:
+  metadata.gz: bc5c4f548d9d33f4d97a2ad9381d61270fb9159a866c95780111f439323aa1b38b9904005d0aae4f3136e09fdd84af1e1f2c295d9d63af0c05d7e667cef0fb2f
+  data.tar.gz: 4922ed5f743ac54afb41b5a5a0aabee3721343e82212c181dd4f76ff79cf95402d117b8c4a360b92514b08c42f1396f0e42e07588d30f250c64861d7240efdab

data/README.md

@@ -0,0 +1,32 @@
+# Viaduct WebPush Ruby Client
+
+This is a Ruby Client for the Viaduct WebPush service. The WebPush service
+allows you to easily provide real-time messaging to your users in their browsers.
+
+## Installation
+
+Just add the `viaduct-webpush` gem to your `Gemfile` and run `bundle` to install
+it.
+
+```ruby
+gem 'viaduct-webpush', :require => 'viaduct/webpush'
+```
+
+## Usage
+
+```ruby
+require 'viaduct/webpush'
+
+Viaduct::WebPush.token = 'your-token'
+Viaduct::WebPush.secret = 'your-secret'
+
+# Sending a single message
+Viaduct::WebPush['test-channel'].trigger('say-hello', {
+  :name => 'Adam'
+})
+
+# Sending a message to multiple channels
+Viaduct::WebPush::Channel.multi_trigger(['channel1', 'channel2'], 'say-hello', {
+  :name => 'Adam'
+})
+```

data/lib/viaduct/web_push.rb

@@ -0,0 +1,70 @@
+require 'json'
+require 'uri'
+require 'net/https'
+require 'viaduct/web_push/channel'
+
+module Viaduct
+  module WebPush
+
+    class Error < StandardError; end
+
+    class << self
+
+      #
+      # Return the endpoint for API request
+      #
+      def endpoint
+        @endpoint ||= 'https://webpush.viaduct.io/vwp/api'
+      end
+
+      #
+      # Return the application token
+      #
+      def token
+        @token || raise(Error, "Must set `Viaudct::WebPush.token` to an application token")
+      end
+
+      #
+      # Return the application secret
+      #
+      def secret
+        @secret || raise(Error, "Must set `Viaudct::WebPush.secret` to an application secret")
+      end
+
+      #
+      # Allow some configuration to be overridden/set
+      #
+      attr_writer :endpoint
+      attr_writer :token
+      attr_writer :secret
+
+      #
+      # Initialize a new channel with the given name (caching it for future use)
+      #
+      def [](name)
+        @channels ||= {}
+        @channels[name] ||= Channel.new(name)
+      end
+
+      #
+      # Make an HTTP request to the WebPush API
+      #
+      def request(action, params = {})
+        uri = URI.parse(self.endpoint + "/#{action}")
+        request = Net::HTTP::Post.new(uri.path)
+        request.set_form_data(params.merge(:token => self.token, :secret => self.secret))
+        http = Net::HTTP.new(uri.host, uri.port)
+        if uri.scheme == 'https'
+          http.use_ssl = true
+        end
+        Timeout.timeout(5) do
+          result = http.request(request)
+          result.is_a?(Net::HTTPSuccess)
+        end
+      rescue Exception, Timeout::Error => e
+        raise Error, "An error occurred while sending data to the WebPush HTTP API. #{e.to_s}"
+      end
+
+    end
+  end
+end

data/lib/viaduct/web_push/channel.rb

@@ -0,0 +1,34 @@
+module Viaduct
+  module WebPush
+    class Channel
+
+      def initialize(name)
+        @name = name
+      end
+
+      #
+      # Trigger an event on this channel
+      #
+      def trigger(event, data = {})
+        self.class.trigger(@name, event, data)
+      end
+
+      #
+      # Trigger a single even on a given channel
+      #
+      def self.trigger(channel, event, data = {})
+        WebPush.request('trigger', {:channel => channel, :event => event, :data => data.to_json})
+      end
+
+
+      #
+      # Trigger an event on multiple channels simultaneously
+      #
+      def self.multi_trigger(channels, event, data = {})
+        raise Error, "`channels` must an arrayof strings" unless channels.all? { |c| c.is_a?(String) }
+        WebPush.request('trigger', {:channel => channels.join(','), :event => event, :data => data.to_json})
+      end
+
+    end
+  end
+end

data/lib/viaduct/webpush.rb

@@ -0,0 +1 @@
+require 'viadut/web_push'

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: viaduct-webpush
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Adam Cooke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: A client library allows messages to be sent to the WebPush API.
+email:
+- adam@viaduct.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/viaduct/web_push.rb
+- lib/viaduct/web_push/channel.rb
+- lib/viaduct/webpush.rb
+homepage: http://viaduct.io
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A client library for the Viaduct WebPush API.
+test_files: []
+has_rdoc: