websockethook 0.1.0 → 0.1.01

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a598958034d0bc23bffba798c4e79791c6101441
-  data.tar.gz: de4ba13cfc67d63f6fe9de5e07bfa995273b7d1c
+  metadata.gz: dd91e0fc65cf4e459ff0657766ea34ac7a9f1d8e
+  data.tar.gz: 77ddfff2e872950d7621d7c58ac99ce9792f4e88
 SHA512:
-  metadata.gz: 6b6726ea1ce6af24499f6fc3fa09798de312c3a368e789e3b447df55f62c31c5ade4546f5240c2a8dcec81df54c30bb5dc35339aab183a4edc901831ab430d3e
-  data.tar.gz: 1ec3c17f5344aacdcb34d1a056e6b40b5084152d8a82053beed896ae3087cffc1001aa0b4eda7d06f1c74db638ce5f57aec1fb8ea666cea81ba279f214a3bd8d
+  metadata.gz: 93056aaea58aac3939e1fe79d083d2f6eaf2fd465a234dcd50b748eb421a12484837c8b828ecd27d407b3ae3b68c16d0a28378ae91f0933adbae6990dd371105
+  data.tar.gz: 6de885962949b5db7165709a3dfcfe7aae3d89de67ddd869a3a8a058ca117f4abb0af15753db30559c0083a4ecafae6d29543837ea17cc3ace456367aa52caf4

data/lib/websockethook.rb

@@ -6,27 +6,18 @@ class WebSocketHook
   DEFAULT_HOST = 'ws://web.sockethook.io'
 
   def initialize(options = {})
-    @host       = options[:host] || DEFAULT_HOST
-    @pause      = options[:sleep] || 0.1
-    @stay_alive = options[:stay_alive] || true
-    @ping       = options[:ping] || 20
-    hooks       = options[:hooks] || []
-    @stopping   = false
-    @hooks      = []
-
-    raise 'Host (:host) must be a URL' unless @host.is_a?(String)
-    raise 'Pause (:pause) must be a float or integer' unless @pause.is_a?(Float) || @pause.is_a?(Integer)
-    raise 'Stay Alive (:stay_alive) must be a boolean (true/false)' unless @stay_alive == true || @stay_alive == false
-    raise 'Ping (:ping) must be an integer' unless @ping.is_a?(Integer)
-    raise 'Stopping (:stopping) must be boolean (true/false)' unless @stopping == true || @stopping == false
-    raise 'Hooks (:hooks) must be an array' unless hooks.is_a?(Array)
-
-    hooks.each {|hook| register(hook) }
+    @stopping = false
+    @hooks    = []
+    initialize_host options
+    initialize_pause options
+    initialize_keep_alive options
+    initialize_ping options
+    initialize_hooks options
   end
 
   def register(id)
-    raise "Hook id '#{id}' must be a String" unless id.is_a?(String)
-    raise "Hook id must only be alphanumeric, '_', '.', or '_'" unless /^[a-zA-Z0-9\-_\.]*$/ === id
+    fail "Hook id '#{id}' must be a String" unless id.is_a?(String)
+    fail "Hook id must only be alphanumeric, '_', '.', or '_'" unless /^[a-zA-Z0-9\-_\.]*$/ === id
     @hooks << id unless @hooks.include?(id)
   end
 
@@ -35,13 +26,13 @@ class WebSocketHook
   end
 
   def listen(&block)
-    raise 'Block must be provided' unless block && block.is_a?(Proc)
+    fail 'Block must be provided' unless block && block.is_a?(Proc)
     begin
       @stopping = false
       listener(&block)
-      restart = @stay_alive && !@stopping
+      restart = @keep_alive && !@stopping
       if restart
-        block.call type:'restart', message:'restarting connection since it was lost'
+        block.call type: 'restart', message: 'restarting connection since it was lost'
         sleep 5
       end
     end while restart
@@ -54,51 +45,79 @@ class WebSocketHook
 
   private
 
+  def initialize_host(options = {})
+    @host = options[:host] || DEFAULT_HOST
+    fail 'Host (:host) must be a URL' unless @host.is_a?(String)
+  end
+
+  def initialize_pause(options = {})
+    @pause = options[:sleep] || 0.1
+    fail 'Pause (:pause) must be a float or integer' unless @pause.is_a?(Float) || @pause.is_a?(Integer)
+  end
+
+  def initialize_keep_alive(options = {})
+    @keep_alive = options[:keep_alive] || true
+    fail 'Keep Alive (:keep_alive) must be a boolean (true/false)' unless @keep_alive == true || @keep_alive == false
+  end
+
+  def initialize_ping(options = {})
+    @ping = options[:ping] || 20
+    fail 'Ping (:ping) must be an integer' unless @ping.is_a?(Integer)
+  end
+
+  def initialize_hooks(options = {})
+    hooks  = options[:hooks] || []
+    fail 'Hooks (:hooks) must be an array' unless hooks.is_a?(Array)
+    hooks.each { |hook| register(hook) }
+  end
+
   def stop_em
-    begin
-      EM.stop
-    rescue
-    end
+    EM.stop
+  rescue
   end
 
   def listener(&block)
-    EM.run do
-      ws_settings = {ping: @ping}
-      ws = Faye::WebSocket::Client.new(@host, nil, ws_settings)
-
+    websocket(block) do |ws|
+      ws.on :open do
+        @hooks.each do |hook|
+          ws.send({type:'register',id:hook}.to_json)
+        end
+      end
       ws.on :message do |message|
         data = nil
         begin
-          data = JSON.parse(message.data, symbolize_names:true)
+          data = JSON.parse(message.data, symbolize_names: true)
         rescue => ex
-          block.call type:'error', message: "Message received, but couldn't parse: #{ex.message}"
+          block.call type: 'error', message: "Message received, but couldn't parse: #{ex.message}"
         end
-        content = data.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo }
+        content = data.inject({}) { |memo, (k, v)| memo[k.to_sym] = v; memo }
+        data[:data][:url] = "#{@host.sub('ws://','http://')}#{data[:data][:path]}" if data[:type]=='registered' && data[:data] && data[:data][:path]
         block.call(content) if data && block
       end
 
-      ws.on :open do
-        block.call(type:'open') if block
-        @hooks.each do |hook|
-          ws.send({type:'register', id:hook}.to_json)
-        end
-      end
-
-      ws.on :close do
-        block.call(type:'close') if block
-        stop_em
-      end
+      handle_ws(ws, :error, block) { @hooks.each { |hook| ws.send({ type: 'register', id: hook }.to_json) } }
+      handle_ws(ws, :close, block) { stop_em }
+      handle_ws(ws, :error, block) { stop_em }
+    end
+  end
 
-      ws.on :error do
-        block.call(type:'error') if block
-        stop_em
-      end
+  def websocket(callback_block, &socket_block)
+    EM.run do
+      ws_settings = { ping: @ping }
+      ws = Faye::WebSocket::Client.new(@host, nil, ws_settings)
+      socket_block.call(ws)
     end
-    block.call(type:'stopped')
+    callback_block.call(type: 'stopped')
   rescue => ex
-    block.call type:'error', message:ex.message
+    callback_block.call type: 'error', message: ex.message
   rescue Interrupt
     stop
-    block.call(type:'stopped')
+    callback_block.call(type: 'stopped')
+  end
+
+  def handle_ws(ws, action, callback_block, &_block)
+    ws.on action do
+      callback_block.call(type: action.to_s)
+    end
   end
-end
+end

data/spec/spec_helper.rb

@@ -1,8 +1,8 @@
-require "codeclimate-test-reporter"
+require 'codeclimate-test-reporter'
 require 'rspec'
+require 'wrong'
 
 CodeClimate::TestReporter.start if ENV['CODECLIMATE_REPO_TOKEN']
 
-RSpec.configure do |c|
-  
-end
+RSpec.configure do |_c|
+end

data/spec/websockethook_spec.rb

@@ -1,12 +1,78 @@
 require 'spec_helper'
-
 require 'websockethook'
+require 'securerandom'
+require 'rest-client'
 
 describe WebSocketHook do
+  include Wrong
 
   it 'can initialize' do
-    expect {
+    expect do
       ws = WebSocketHook.new
-      }.to_not raise_error
+    end.to_not raise_error
+  end
+
+  it 'can register a hook' do
+    ws = WebSocketHook.new
+    data = []
+    t = Thread.new { ws.listen { |msg| data << msg } }
+
+    eventually do
+      data.any? do |line|
+        line[:type] == 'registered'
+      end
+    end
+
+    ws.stop
+    t.kill
+  end
+
+  it 'can register a hook with an id' do
+    id = "test_#{SecureRandom.hex(4)}"
+    ws = WebSocketHook.new
+    ws.register id
+    data = []
+    t = Thread.new { ws.listen { |msg| data << msg } }
+
+    eventually do
+      data.any? do |line|
+        line[:type] == 'registered' && line[:data][:id] == id
+      end
+    end
+
+    ws.stop
+    t.kill
+  end
+
+  it 'can trigger a hook with data' do
+    id = "test_#{SecureRandom.hex(4)}"
+    ws = WebSocketHook.new
+    ws.register id
+    data = []
+    t = Thread.new { ws.listen { |msg| data << msg } }
+    hook_url = ''
+
+    check_eventually data do |line|
+      found = line[:type] == 'registered' && line[:data][:id] == id
+      hook_url = line[:data][:url] if found
+      found
+    end
+
+    RestClient.post(hook_url,this_is_a:'test')
+
+    check_eventually data do |line|
+      line[:type] == 'hook' && line[:data] == {this_is_a:'test'}
+    end
+
+    ws.stop
+    t.kill
+  end
+
+  def check_eventually(data, &block)
+    eventually do
+      data.any? do |line|
+        block.yield(line)
+      end
+    end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: websockethook
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.01
 platform: ruby
 authors:
 - Maciej Skierkowski
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: wrong
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
 description: Listen for web hooks in your app without creating a web service.
 email:
 - maciej@factor.io