crossbar-http 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9530ff099336cf9bdd53fef13a14a4bbd300d4f7
+  data.tar.gz: 1f388882acb44ab8a45cf04d2f4a2c1ff3023545
+SHA512:
+  metadata.gz: 549fbec78e190dee8cc82aa7817865979c609e6e759a2b12d9cf9f2fb77cb7292ce9d9fcb8e4e2772bf256aa44ea9900fcb94fdaca2f6862bc95155d704fe586
+  data.tar.gz: b8c76b295948e7c8f814b04f94ad5c12085338cf43109f53ecd7dc98f9912188e8c602857e0130897671c7a2c8e4bef72f0217c9abd723a2718e2939603addab

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Eric Chapman
+
+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,74 @@
+# Crossbar HTTP
+
+[![Gem Version](https://badge.fury.io/rb/crossbar-http.svg)](https://badge.fury.io/rb/crossbar-http)
+
+Module that provides methods for accessing Crossbar.io HTTP Bridge Services
+
+## Revision History
+
+  - v0.1:
+    - Initial version
+
+## Installation
+
+``` ruby
+gem 'crossbar-http'
+```
+
+## Usage
+
+### Call
+To call a Crossbar HTTP bridge, do the following
+
+``` ruby
+client = Crossbar::HTTP::Client("http://127.0.0.1/call")
+result = client.call("com.example.add", 2, 3, offset=10)
+```
+    
+This will call the following method
+
+``` python
+def onJoin(self, details):
+        
+    def add_something(x, y, offset=0):
+        print "Add was called"
+        return x+y+offset
+
+    self.register(add_something, "com.example.add")
+```
+        
+### Publish
+To publish to a Crossbar HTTP bridge, do the following
+
+``` ruby
+client = Crossbar::HTTP::Client("http://127.0.0.1/publish")
+result = client.publish("com.example.event", event="new event")
+```
+    
+The receiving subscription would look like
+
+``` python
+def onJoin(self, details):
+        
+    def subscribe_something(event=None, **kwargs):
+        print "Publish was called with event %s" % event
+
+    self.subscribe(subscribe_something, "com.example.event")
+```
+
+### Key/Secret
+For bridge services that have a key and secret defined, simply include the key and secret in the instantiation of the
+client.
+
+``` ruby
+client = Crossbar::HTTP::Client("http://127.0.0.1/publish", key: "key", secret: "secret")
+```
+
+## Contributing
+To contribute, fork the repo and submit a pull request.
+
+## Testing
+TODO
+
+##License
+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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "crossbar_http"
+
+# 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,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/crossbar-http.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'crossbar-http/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'crossbar-http'
+  spec.version       = Crossbar::HTTP::VERSION
+  spec.authors       = ['Eric Chapman']
+  spec.email         = ['eric.chappy@gmail.com']
+
+  spec.summary       = %q{Crossbar.io HTTP Bridge Ruby Client}
+  spec.description   = %q{}
+  spec.homepage      = 'https://github.com/ericchapman/ruby-crossbar-http'
+  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_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/crossbar-http/client.rb

@@ -0,0 +1,155 @@
+=begin
+
+Copyright (c) 2017 Eric Chapman
+
+MIT License
+
+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.
+
+=end
+
+require 'openssl'
+require 'base64'
+require 'net/http'
+require 'json'
+
+module Crossbar
+  module HTTP
+    class Client
+      attr_accessor :url, :key, :secret, :verbose, :sequence
+
+      # Initializes the client
+      # @param url [String] - The url of the router's HTTP bridge
+      # @param key [String] - The key (optional)
+      # @param secret [String] - The secret (optional)
+      # @param verbose [Bool] - 'True' if you want debug messages printed
+      def initialize(url, key: nil, secret: nil, verbose: false)
+
+        raise 'The url can not be nil' unless url != nil
+
+        self.url = url
+        self.key = key
+        self.secret = secret
+        self.verbose = verbose
+        self.sequence = 1
+      end
+
+      # Publishes to the topic
+      # @param topic [String] - The name of the topic
+      # @param *args [] - The arguments and key word arguments
+      # @return [Integer] - Returns the id of the publish
+      def publish(topic, *args, **kwargs)
+        raise 'The topic can not be nil' unless url != nil
+
+        params = {
+            topic: topic,
+            args: args,
+            kwargs: kwargs
+        }
+
+        self._make_api_call(params)
+      end
+
+      # Calls the procedure
+      # @param procedure [String] - The name of the topic
+      # @param *args [] - The arguments and key word arguments
+      # @return [Integer] - Returns the id of the publish
+      def call(procedure, *args, **kwargs)
+        raise 'The topic can not be nil' unless url != nil
+
+        params = {
+            procedure: procedure,
+            args: args,
+            kwargs: kwargs
+        }
+
+        self._make_api_call(params)
+      end
+
+      # Computes the signature.
+      # Described at: http://crossbar.io/docs/HTTP-Bridge-Services-Caller/
+      # Reference code is at: https://github.com/crossbario/crossbar/blob/master/crossbar/adapter/rest/common.py
+      # @param body [Hash]
+      # @return (signature, nonce, timestamp)
+      def _compute_signature(body, nonce: nil, timestamp: nil)
+
+        timestamp ||= Time.now.utc.strftime('%Y-%m-%dT%H:%M:%S.%LZ')
+        nonce ||= rand(0..2**53)
+
+        # Compute signature: HMAC[SHA256]_{secret} (key | timestamp | seq | nonce | body) => signature
+        hm = OpenSSL::HMAC.new(self.secret, OpenSSL::Digest::SHA256.new)
+        hm << self.key
+        hm << timestamp
+        hm << self.sequence.to_s
+        hm << nonce.to_s
+        hm << body
+        signature = Base64.urlsafe_encode64(hm.digest)
+
+        return signature, nonce, timestamp
+      end
+
+      def _make_api_call(json_params=nil)
+
+        puts "Crossbar::HTTP - Request: POST #{url}" if self.verbose
+
+        encoded_params = (json_params != nil) ? JSON.generate(json_params) : nil
+
+        puts "Crossbar::HTTP - Params: #{encoded_params}" if encoded_params != nil and self.verbose
+
+        uri = URI(self.url)
+
+        if self.key != nil and self.secret != nil and encoded_params != nil
+          signature, nonce, timestamp = self._compute_signature(encoded_params)
+          params = {
+              timestamp: timestamp,
+              seq: self.sequence.to_s,
+              nonce: nonce,
+              signature: signature,
+              key: self.key
+          }
+          uri.query = URI.encode_www_form(params)
+
+          puts "Crossbar::HTTP - Signature Params: #{params}" if self.verbose
+        end
+
+        # TODO: Not sure what this is supposed to be but this works
+        self.sequence += 1
+
+        # Create the request
+        req = Net::HTTP::Post.new(uri)
+        req['Content-Type'] = 'application/json'
+        req.body = encoded_params
+
+        res = Net::HTTP.start(uri.hostname, uri.port) do |http|
+          http.request(req)
+        end
+
+        case res
+          when Net::HTTPSuccess
+            puts "Crossbar::HTTP - Response Body: #{res.body}" if self.verbose
+            return JSON.parse(res.body, {:symbolize_names => true})
+          else
+            raise "Crossbar::HTTP - Code: #{res.code}, Error: #{res.message}"
+        end
+
+      end
+    end
+  end
+end

data/lib/crossbar-http/version.rb

@@ -0,0 +1,5 @@
+module Crossbar
+  module HTTP
+    VERSION = '0.1.0'
+  end
+end

data/lib/crossbar-http.rb

@@ -0,0 +1,30 @@
+=begin
+
+Copyright (c) 2017 Eric Chapman
+
+MIT License
+
+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.
+
+=end
+
+require 'crossbar-http/version'
+require 'crossbar-http/client'
+

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: crossbar-http
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eric Chapman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+description: ''
+email:
+- eric.chappy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- crossbar-http.gemspec
+- lib/crossbar-http.rb
+- lib/crossbar-http/client.rb
+- lib/crossbar-http/version.rb
+homepage: https://github.com/ericchapman/ruby-crossbar-http
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Crossbar.io HTTP Bridge Ruby Client
+test_files: []