phoenix_pubsub 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 09dc48151af907d57e652c72f9f75f545820b523
+  data.tar.gz: 393873ce4756ca2151e4859e6acad9600b7ded1a
+SHA512:
+  metadata.gz: 8cee86a7af857619eff4584b4ea34df7e18f91f5041ee157285b336fb1f1bcbde39c3106762565ae4e06531c5ec8d436c37bc126ee5388395c765dbc5fc96302
+  data.tar.gz: 0edd2ebddd4eb79e40e689dc029771566eb1578be224539f08bb86650084263d23914052fcfc6c70b959b9a67d7156b1a31df7c2899936c672915e1ea91d3ec4

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in phoenix_pubsub_redis.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Frontrunner Software
+
+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,62 @@
+# Phoenix Pubsub for Ruby
+
+PhoenixPubsub allows you to publish messages to Phoenix Channels from Ruby. Subscriptions are not implemented (yet).
+
+## Why?
+
+This might be very interesting for people wanting to enrich their Rails app with Realtime capabilities and to leverage the incredible websocket performance of the Erlang VM.
+The awaited Rails 5 release with ActionCable will most likely not feature such an ease of scalability as Elixir/Erlang does.
+
+Also this can help people to transition from Rails to Phoenix.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'phoenix_pubsub'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install phoenix_pubsub
+
+## Usage
+
+E.g.: using with [sample chat app](https://github.com/chrismccord/phoenix_chat_example):
+
+```ruby
+p = Phoenix::Pubsub::Redis.new(redis_url: 'redis://localhost:6379', phoenix_class: 'Chat.PubSub')
+p.publish 'rooms:lobby', 'new:msg', { user: 'rake', body: 'hello from ruby!' }
+```
+
+### Requirements
+
+  - Redis
+  - Phoenix app with [Redis PubSub adapter](https://github.com/phoenixframework/phoenix_pubsub_redis)
+
+### Sample Chat App
+
+  - Clone Phoenix [Sample Chat app](https://github.com/chrismccord/phoenix_chat_example)
+  - Install and configure the [Redis PubSub adapter](https://github.com/phoenixframework/phoenix_pubsub_redis)
+  - Make sure the demo app is running
+  - Clone this repo, install all dependencies and run `bundle exec rake`
+  - You should see a message coming from Ruby
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/phoenix_pubsub_redis/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/lib/phoenix/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'phoenix/pubsub'
+
+# 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

data/bin/setup

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

data/lib/phoenix/pubsub.rb

@@ -0,0 +1,69 @@
+require 'phoenix/pubsub/version'
+require 'erlang/etf'
+require 'redis'
+
+module Erlang
+  module ETF
+    module Extensions
+
+      module Symbol
+        def __erlang_type__
+          if to_s.ascii_only?
+            :atom
+          else
+            :atom_utf8
+          end
+        end
+      end
+
+      module Hash
+        def __erlang_type__
+          :map
+        end
+
+        def __erlang_evolve__
+          if size == 0
+            ETF::Map.new([], [])
+          else
+            values = flatten.map(&:__erlang_evolve__)
+            ETF::Map.new(*values.each_slice(values.size / 2).to_a)
+          end
+        end
+      end
+
+    end
+  end
+end
+
+
+module Phoenix
+  module Pubsub
+
+    class Redis
+      def initialize(redis_url: 'redis://localhost:6379', phoenix_class: 'Chat.PubSub')
+        @phoenix_class_name = phoenix_class
+        @redis = ::Redis.new(url: redis_url)
+      end
+
+      def publish topic, event, payload
+        @redis.publish("phx:Elixir.#{@phoenix_class_name}", serialize_message(topic, event, payload))
+      end
+
+      private
+
+      def serialize_message topic, event, payload
+        term = Erlang::Tuple[
+          # {@redis_msg_vsn, node_ref, pool_size, from_pid, topic, msg}
+          1, '', 1, :none, topic, {
+            :__struct__ => :"Elixir.Phoenix.Socket.Broadcast",
+            :event => event,
+            :payload => payload,
+            :topic => topic
+          }
+        ]
+        Erlang.term_to_binary term
+      end
+    end
+
+  end
+end

data/lib/phoenix/pubsub/version.rb

@@ -0,0 +1,5 @@
+module Phoenix
+  module Pubsub
+    VERSION = "0.1.0"
+  end
+end

data/phoenix_pubsub.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'phoenix/pubsub/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'phoenix_pubsub'
+  s.version       = Phoenix::Pubsub::VERSION
+  s.summary       = %q{Phoenix PubSub for Ruby}
+  s.description   = %q{Phoenix PubSub for Ruby}
+
+  s.authors       = ['Andreas Böhrnsen']
+  s.email         = ['andreas@frontrunner.io']
+  s.homepage      = 'https://github.com/frontrunnerio/phoenix_pubsub_rb'
+
+  s.license       = 'MIT'
+
+  s.required_ruby_version = '>= 2.0'
+
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'erlang-etf', '~> 1.1.1'
+  s.add_dependency 'redis', '~> 3.0.1'
+
+  s.add_development_dependency 'bundler', '~> 1.9'
+  s.add_development_dependency 'rake', '~> 10.0'
+
+  # testing
+  s.add_development_dependency 'minitest', '~> 5.8.4'
+  s.add_development_dependency 'shoulda-context', '~> 1.2.1'
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: phoenix_pubsub
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andreas Böhrnsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: erlang-etf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.8.4
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+description: Phoenix PubSub for Ruby
+email:
+- andreas@frontrunner.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/phoenix/pubsub.rb
+- lib/phoenix/pubsub/version.rb
+- phoenix_pubsub.gemspec
+homepage: https://github.com/frontrunnerio/phoenix_pubsub_rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.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: Phoenix PubSub for Ruby
+test_files: []