json_rpc_over_mqtt_example 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 89147978eb0cef9761d2e9ea890eb248ac998c92
+  data.tar.gz: 82e471a263fdfc13e93888b8b71e41c37c15ccf8
+SHA512:
+  metadata.gz: b4c4cbc3755f910c80ad37f93da93b822b4b98405e81bc7493cea8c1c0a13e41af04a77f4e4882ed6919087ea6ae8f54e872ef37cc79fb2b92f20f3235857923
+  data.tar.gz: 25fb71508adc4297b620ed60acbe616b15b213bab1af297e0001af0022705d6ebcf340c821c64545604d250a5b5a0c6ded9aa8ed3ad5947d64d9645237cf0612

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+vendor/*

data/.rspec

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 futoase
+
+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.

data/README.md

@@ -0,0 +1,112 @@
+# JSON-RPC over MQTT example
+
+JSON-RPC over MQTT example
+
+## Installation
+
+```ruby
+> gem 'json_rpc_over_mqtt_example'
+```
+
+## Usage
+
+Setup of the MQTT Broker in your machine.
+Mosquitto is better.
+
+### Setup of the MQTT Broker
+
+- Mac OS X (homebrew)
+
+Install
+
+```
+> brew install mosquitto
+```
+
+Starting MQTT Broker
+
+```
+> launchctl load ~/Library/LaunchAgents/homebrew.mxcl.mosquitto.plist
+```
+
+### Connect MQTT subscriber to MQTT Broker
+
+```
+> mosquitto_sub -h localhost -t client
+```
+
+### Starting demo server
+
+Starting JSON-RPC over MQTT example demo server.
+
+```
+> json_rpc_over_mqtt_server
+```
+
+### Publish message to MQTT Broker
+
+Publish message to a MQTT Broker.
+
+- ping
+
+Publisher
+
+```
+> mosquitto_pub -h localhost -t server -m '{"jsonrpc": "2.0", "id": 2, "method": "ping", "params": {"url": "yahoo.co.jp"}}'
+```
+
+Subscriber
+
+```
+> {"jsonrpc":"2.0","id":2,"result":"OK: yahoo.co.jp"}
+```
+
+- hello world
+
+Publisher
+
+```
+> mosquitto_pub -h localhost -t server -m '{"jsonrpc": "2.0", "id": 1000, "method": "hello_world", "params": {"name": "Bob"}}'
+```
+
+Subscriber
+
+```
+> {"jsonrpc":"2.0","id":1000,"result":"Hello World, Bob!"}
+```
+
+- what time is it
+
+Publisher
+
+```
+> mosquitto_pub -h localhost  -t server -m '{"jsonrpc": "2.0", "id": 1000, "method": "what_time_is_it?"}'
+```
+
+Subscriber
+
+```
+> {"jsonrpc":"2.0","id":1000,"result":"2014-12-31T09:36:47+09:00"}
+```
+
+## environments variable
+
+- Broker address
+
+**BROKER_ADDRESS**
+
+- topic name of server
+
+**SERVER_TOPIC_NAME**
+
+- topic name of client
+
+**CLIENT_TOPIC_NAME**
+
+## Contributing
+
+1. Fork it ( https://github.com/futoase/json_rpc_over_mqtt_example/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,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/bin/json_rpc_over_mqtt_server

@@ -0,0 +1,5 @@
+require 'json_rpc_over_mqtt_example'
+
+logger.info("Starting the JSONRPC over MQTT server")
+
+JSONRPCOverMQTT::MQTT::Connect::start

data/config/const.rb

@@ -0,0 +1,5 @@
+module JSONRPCOverMQTT
+  BROKER_ADDRESS = ENV['BROKER_ADDRESS'] || 'localhost'
+  SERVER_TOPIC_NAME = ENV['SERVER_TOPIC_NAME'] || 'server'
+  CLIENT_TOPIC_NAME = ENV['CLIENT_TOPIC_NAME'] || 'client'
+end

data/json_rpc_over_mqtt_example.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json_rpc_over_mqtt_example/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "json_rpc_over_mqtt_example"
+  spec.version       = JSONRPCOverMQTT::VERSION
+  spec.authors       = ["futoase"]
+  spec.email         = ["futoase@gmail.com"]
+  spec.summary       = %q{JSONRPC Over MQTT Example.}
+  spec.description   = %q{JSONRPC Over MQTT Example.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_dependency             "mqtt"
+  spec.add_dependency             "net-ping"
+end

data/lib/json_rpc_over_mqtt_example.rb

@@ -0,0 +1,13 @@
+require 'json'
+require 'mqtt'
+
+require_relative File.expand_path(__dir__ + '/../config/const')
+require_relative 'json_rpc_over_mqtt_example/logger'
+require_relative 'json_rpc_over_mqtt_example/json_rpc'
+require_relative 'json_rpc_over_mqtt_example/mqtt'
+
+__my_dir__ = File.expand_path(__dir__)
+functions_dir = File.expand_path(__my_dir__ + '/json_rpc_over_mqtt_example/functions/**/*.rb')
+
+# Include functions
+Dir.glob(functions_dir).map { |f| require_relative f }

data/lib/json_rpc_over_mqtt_example/functions/hello_world.rb

@@ -0,0 +1,4 @@
+def hello_world(**kwargs)
+  name = kwargs[:name] || "Bob"
+  "Hello World, #{name}!"
+end

data/lib/json_rpc_over_mqtt_example/functions/ping.rb

@@ -0,0 +1,8 @@
+require 'net/ping'
+
+def ping(**kwargs)
+  url = kwargs[:url] || "google.com"
+  target = Net::Ping::External.new(url)
+  result = target.ping? ? "OK" : "NG"
+  "#{result}: #{url}"
+end

data/lib/json_rpc_over_mqtt_example/functions/what_time_is_it.rb

@@ -0,0 +1,5 @@
+require 'date'
+
+def what_time_is_it?
+  DateTime.now.to_s
+end

data/lib/json_rpc_over_mqtt_example/json_rpc.rb

@@ -0,0 +1,9 @@
+require_relative 'json_rpc/error_response'
+require_relative 'json_rpc/request'
+require_relative 'json_rpc/response'
+
+module JSONRPCOverMQTT
+  module JSONRPC
+    VERSION = "2.0"
+  end
+end

data/lib/json_rpc_over_mqtt_example/json_rpc/error_response.rb

@@ -0,0 +1,28 @@
+module JSONRPCOverMQTT
+  module JSONRPC
+
+    class ErrorResponse
+    
+      METHOD_NOT_FOUND = {code: "-32601", message: "Method not found"}
+      PARSE_ERROR = {code: "-32602", message: "JSON parse error"}
+    
+      def self.generate_response(json_rpc_id, error_response)
+        ::JSON.generate({
+          jsonrpc: VERSION,
+          id: json_rpc_id,
+          error: error_response
+        })
+      end
+    
+      def self.method_not_found(json_rpc_id)
+        generate_response(json_rpc_id, METHOD_NOT_FOUND)
+      end
+    
+      def self.parse_error
+        generate_response(nil, PARSE_ERROR)
+      end
+    
+     end
+
+  end
+end

data/lib/json_rpc_over_mqtt_example/json_rpc/request.rb

@@ -0,0 +1,22 @@
+module JSONRPCOverMQTT
+  module JSONRPC
+
+    class Request
+
+      attr_reader :id, :method, :params
+
+      def initialize(message)
+        json_rpc_obj = JSON.parse(message)
+        @id = json_rpc_obj["id"]
+        @method = json_rpc_obj["method"]
+
+        if json_rpc_obj["params"].nil?
+          @params = nil
+        else
+          @params = Hash[json_rpc_obj["params"].map{ |k,v| [k.to_sym, v] }]
+        end
+      end
+    end
+
+  end
+end

data/lib/json_rpc_over_mqtt_example/json_rpc/response.rb

@@ -0,0 +1,19 @@
+module JSONRPCOverMQTT
+  module JSONRPC
+
+    class Response
+      def self.generate_response(json_rpc_id, response)
+        ::JSON.generate({
+          jsonrpc: VERSION,
+          id: json_rpc_id,
+          result: response
+        })
+      end
+
+      def self.generate(json_rpc_id, response)
+        generate_response(json_rpc_id, response)
+      end
+    end
+
+  end
+end

data/lib/json_rpc_over_mqtt_example/logger.rb

@@ -0,0 +1,7 @@
+require 'logger'
+
+def logger
+  @log ||= Logger.new(STDOUT)
+  @log.level = Logger::INFO
+  @log
+end

data/lib/json_rpc_over_mqtt_example/mqtt.rb

@@ -0,0 +1 @@
+require_relative 'mqtt/connect'

data/lib/json_rpc_over_mqtt_example/mqtt/connect.rb

@@ -0,0 +1,41 @@
+module JSONRPCOverMQTT
+  module MQTT
+
+    class Connect
+      def self.start
+
+        ::MQTT::Client.connect(BROKER_ADDRESS) do |c|
+          c.get(SERVER_TOPIC_NAME) do |topic, message|
+            logger.info("TOPIC: #{topic} MESSAGE:#{message}")
+        
+            begin
+              request = JSONRPC::Request.new(message)
+        
+              unless request.params.nil?
+                result = method(request.method).call(**request.params)
+              else
+                result = method(request.method).call
+              end
+        
+              c.publish(
+                CLIENT_TOPIC_NAME, 
+                JSONRPC::Response.generate(request.id, result)
+              )
+            rescue ::JSON::ParserError => e
+              c.publish(
+                CLIENT_TOPIC_NAME, 
+                JSONRPC::ErrorResponse.parse_error
+              )
+            rescue NameError => e
+              c.publish(
+                CLIENT_TOPIC_NAME,
+                JSONRPC::ErrorResponse.method_not_found(request.id)
+              )
+            end
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/json_rpc_over_mqtt_example/version.rb

@@ -0,0 +1,3 @@
+module JSONRPCOverMQTT
+  VERSION = "0.0.1"
+end

data/spec/json_rpc_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe JSONRPCOverMQTT::JSONRPC do
+
+  let(:error_response) { JSONRPCOverMQTT::JSONRPC::ErrorResponse }
+  let(:json_rpc_version) { '2.0' }
+  let(:json_rpc_id) { 100 }
+
+  context 'when generate method not found a not exists valid request' do 
+    let(:method_not_found) { JSON.parse(error_response.method_not_found(json_rpc_id)) }
+    let(:error_code) { error_response::METHOD_NOT_FOUND[:code] }
+    let(:error_message) { error_response::METHOD_NOT_FOUND[:message] }
+    it "should be get response for method_not_found" do
+
+      expect(method_not_found).to be_instance_of(Hash)
+      expect(method_not_found).to include('jsonrpc')
+      expect(method_not_found).to include('id')
+      expect(method_not_found).to include('error')
+      expect(method_not_found["jsonrpc"]).to eq(json_rpc_version)
+      expect(method_not_found["id"]).to eq(json_rpc_id)
+      expect(method_not_found["error"]["code"]).to eq(error_code)
+      expect(method_not_found["error"]["message"]).to eq(error_message)
+    end
+  end
+
+  context 'when generate method not found a not exists valid request' do 
+
+    let(:parse_error) { JSON.parse(error_response.parse_error) }
+    let(:error_code) { error_response::PARSE_ERROR[:code] }
+    let(:error_message) { error_response::PARSE_ERROR[:message] }
+
+    it "should be get response for parse_error" do
+
+      expect(parse_error).to be_instance_of(Hash)
+      expect(parse_error).to include('jsonrpc')
+      expect(parse_error).to include('id')
+      expect(parse_error).to include('error')
+      expect(parse_error["jsonrpc"]).to eq(json_rpc_version)
+      expect(parse_error["id"]).to eq(nil)
+      expect(parse_error["error"]["code"]).to eq(error_code)
+      expect(parse_error["error"]["message"]).to eq(error_message)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'json'
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'json_rpc_over_mqtt_example/json_rpc'
+require 'json_rpc_over_mqtt_example/mqtt_connect'
+require 'json_rpc_over_mqtt_example/logger'

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: json_rpc_over_mqtt_example
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- futoase
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mqtt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-ping
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: JSONRPC Over MQTT Example.
+email:
+- futoase@gmail.com
+executables:
+- json_rpc_over_mqtt_server
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/json_rpc_over_mqtt_server
+- config/const.rb
+- json_rpc_over_mqtt_example.gemspec
+- lib/json_rpc_over_mqtt_example.rb
+- lib/json_rpc_over_mqtt_example/functions/hello_world.rb
+- lib/json_rpc_over_mqtt_example/functions/ping.rb
+- lib/json_rpc_over_mqtt_example/functions/what_time_is_it.rb
+- lib/json_rpc_over_mqtt_example/json_rpc.rb
+- lib/json_rpc_over_mqtt_example/json_rpc/error_response.rb
+- lib/json_rpc_over_mqtt_example/json_rpc/request.rb
+- lib/json_rpc_over_mqtt_example/json_rpc/response.rb
+- lib/json_rpc_over_mqtt_example/logger.rb
+- lib/json_rpc_over_mqtt_example/mqtt.rb
+- lib/json_rpc_over_mqtt_example/mqtt/connect.rb
+- lib/json_rpc_over_mqtt_example/version.rb
+- spec/json_rpc_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.4.5
+signing_key: 
+specification_version: 4
+summary: JSONRPC Over MQTT Example.
+test_files:
+- spec/json_rpc_spec.rb
+- spec/spec_helper.rb