bifrost-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3354b44b58bfe9235b57e656d7f3aef5899ef15e9b9c8aaaf6cf85383a48701f
+  data.tar.gz: 300fcfaf94f4f8c0499efd7cfd16ce7c1548da46e2d63ec2e59772dcdc457cae
+SHA512:
+  metadata.gz: 6967087f3458d75605e1b85c002bedaf3712513ac7d2c79017c7b059f26bb318999f982c549d6bfa8cd7682903e496b9cf4a6ff5e31589fbbfb19f1cba08251b
+  data.tar.gz: 696cd1fb5dfddedd6e4848c66d666b5873cbf66ff1f5fd8a6ec9b2eb7926d54d72303de1f8208ce333c53760bc17ec27b9eeef72b7bf0ded74669f116e8b196e

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bifrost-client.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    bifrost-client (0.1.0)
+      jwt (>= 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.7)
+    jwt (2.1.0)
+    public_suffix (3.0.2)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    safe_yaml (1.0.4)
+    webmock (3.3.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bifrost-client!
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  webmock
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Alternate Labs Ltd
+
+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,81 @@
+# Bifrost Ruby Client
+
+A ruby client helper for the [bifrost crystal](https://github.com/alternatelabs/bifrost) websockets server.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bifrost-client'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+## Configuration
+
+By default Bifrost::Client will look for environment variables:
+
+```sh
+JWT_SECRET=9c3ed1aa0ba8405effdb363839caa3cc
+BIFROST_URL=https://bifrost-server.myapp.com
+```
+
+And you can create a Bifrost client like so:
+
+```ruby
+client = Bifrost::Client.new
+```
+
+Or you can pass in configuration directly:
+
+```ruby
+client = Bifrost::Client.new(
+  jwt_secret: "9c3ed1aa0ba8405effdb363839caa3cc",
+  bifrost_server_url: "https://bifrost-server.myapp.com"
+)
+```
+
+## Usage
+
+### Token helper
+
+This helps you generate a JWT to give an end user permission to connect to a channel called `user:thor`
+
+```ruby
+token = client.token_for(channels: %w[user:thor]) # => "eyJhbGciOiJIUzUxMiJ9.eyJjaGFubmVscyI6WyJ1c2VyOnRob3IiXX0.SBgGNE-n7S8gVtYQ3wg7_WG2TqOGNFf-jy0GW57_YV-B-xjekm4KCQwTZIqxL_TXoqbWW3tThT9YTt4GLD4Y7A"
+```
+
+Once you have this token [follow the instructions on the bifrost repo](https://github.com/alternatelabs/bifrost#1-create-an-api-endpoint-in-your-application-that-can-give-users-a-realtime-token) to provide that token to client side JS and connect using ReconnectingWebsocket.
+
+### Broadcast events
+
+Use `client#broadcast` when you want to send an event out to all members of a channel. Payload must be a string, we recommend you encode it to JSON and can safely `JSON.parse(payload)` in your client side code upon receiving the message.
+
+```ruby
+begin
+  payload = JSON.dump({ name: "Hela" })
+  channel = "user:thor"
+  client.broadcast(channel, event: "invader_detected", data: payload) # => { deliveries: 1 }
+rescue Bifrost::ServerError => e
+  # Do something with the error
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alternatelabs/bifrost-ruby-client.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bifrost-client.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bifrost/client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bifrost-client"
+  spec.version       = Bifrost::Client::VERSION
+  spec.authors       = ["Pete Hawkins"]
+  spec.email         = ["pete@alternatelabs.co"]
+
+  spec.summary       = %q{Ruby client library for the bifrost crystal websocket server}
+  spec.description   = %q{Bifrost is a crystal websocket server, this is a client library to simplify broadcasting messages to it.}
+  spec.homepage      = "https://github.com/alternatelabs/bifrost"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "jwt", ">= 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bifrost/client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/bifrost/client.rb

@@ -0,0 +1,50 @@
+require "bifrost/client/version"
+require "net/http"
+require "json"
+require "jwt"
+
+module Bifrost
+  class Client
+    attr_reader :jwt_secret, :bifrost_server_url
+
+    def initialize(jwt_secret: ENV["JWT_SECRET"], bifrost_server_url: ENV["BIFROST_URL"])
+      @jwt_secret = jwt_secret
+      @bifrost_server_url = bifrost_server_url
+    end
+
+    def broadcast(channel, event:, data: nil)
+      data = {
+        channel: channel,
+        message: {
+          event: event,
+          data: data
+        },
+        exp: Time.now.to_i + 3600
+      }
+      jwt = JWT.encode(data, jwt_secret, "HS512")
+      uri = URI.parse(bifrost_server_url)
+      uri.path = "/broadcast"
+      ssl = uri.is_a?(URI::HTTPS)
+
+      res = Net::HTTP.start(uri.host, uri.port, use_ssl: ssl) do |http|
+        request                 = Net::HTTP::Post.new(uri.path)
+        request.body            = JSON.dump(token: jwt)
+        request["Content-Type"] = "application/json"
+        http.request(request)
+      end
+
+      if Integer(res.code) > 206
+        raise ServerError.new("Bifrost server responded with #{res.code}: #{res.body}")
+      else
+        JSON.parse(res.body, symbolize_names: true)
+      end
+    end
+
+    def token_for(channels:)
+      payload = { channels: channels }
+      JWT.encode(payload, jwt_secret, "HS512")
+    end
+  end
+
+  class ServerError < StandardError; end
+end

data/lib/bifrost/client/version.rb

@@ -0,0 +1,5 @@
+module Bifrost
+  class Client
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: bifrost-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pete Hawkins
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+description: Bifrost is a crystal websocket server, this is a client library to simplify
+  broadcasting messages to it.
+email:
+- pete@alternatelabs.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bifrost-client.gemspec
+- bin/console
+- bin/setup
+- lib/bifrost/client.rb
+- lib/bifrost/client/version.rb
+homepage: https://github.com/alternatelabs/bifrost
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Ruby client library for the bifrost crystal websocket server
+test_files: []