mqttsrvc 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 22bdb9e7497a2abc7ae4cf66afc4524d804f4703419db3d3d85619077f50aa09
+  data.tar.gz: 6755e5808f1d2ee5ade3fc1ea3ccd7bb73f8eb56977cce102e6f083f13304de0
+SHA512:
+  metadata.gz: 92e6bed956f55124e1cb470bfde0feb0e07cac3c10bdc3fcec6454f32690a6532293addafe8f4d1495cb3a3dc34945482bfdcaebc29833f442f3b9a68130c20f
+  data.tar.gz: 3a5684ada6e6d1d6879ecbdadce3e0fa6922a95a677c3399071e98d2358dcffe1fac63a37ad9f5085b57384b5e500b45f95d51bf8ca01e9209c60bcbc408e5b9

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem 'mqtt'
+gem 'colorize'
+gem 'recursive-open-struct'
+gem 'ejson'

data/README.md

@@ -0,0 +1,11 @@
+# MqttSrvc
+
+MqttSrvc makes it easy to implement a new, MQTT-integrated service in Ruby. It handles:
+
+- loading YAML config
+- connecting to a broker
+- subscribing to configured topics
+- logging to a topic
+- adding supplementary fields to each published message:
+    + client_id
+    + ip_address

data/bin/mqttsrvc

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'mqttsrvc'
+
+mqttsrvc = MqttSrvc.new(__dir__)
+mqttsrvc.run

data/etc/credentials.json

@@ -0,0 +1,15 @@
+{
+  "_public_key": "711abc041141040248de76d821b8de45074966eaebcef47ce7ccc5e5c13b3a2f",
+  "development": {
+    "mqtt": {
+      "api_key": "EJ[1:U03yLpdanoN3d5Sm0DjXn7NwLdOvsHetC/Fh0PpLzmI=:7v4AnlOf77hw5Jh3aE3WEvcUEl6sQWFF:HIUVVaF62X4Owq7Z0U5Ri6FKhl6xyfaHIcg=]",
+      "api_secret": "EJ[1:U03yLpdanoN3d5Sm0DjXn7NwLdOvsHetC/Fh0PpLzmI=:/1cGum3JgAPqcPo3/H+lkStVMNmTWkty:8XKNRGsia/rfDS769WvDVMQw6+5QJH6eJQCqQr3Nkqqo8W5W2Svyg8kjqp+ndT1J]"
+    }
+  },
+  "production": {
+    "mqtt": {
+      "api_key": "EJ[1:U03yLpdanoN3d5Sm0DjXn7NwLdOvsHetC/Fh0PpLzmI=:pRFNwbtaSbiQ39KH4TYkOlzWUVUPCCF3:a7IMgniMI5dwSyymORiuw1VBxKQWKK3D7Eg=]",
+      "api_secret": "EJ[1:U03yLpdanoN3d5Sm0DjXn7NwLdOvsHetC/Fh0PpLzmI=:jiydWqPIb+s6Yf9kcEvinAnDiCWfapka:JzUtb5upPNe5M37oWuJGVBgV17MmZdqZB9ETt8+kY/ugv33CzmMZiQWGlSOxd64R]"
+    }
+  }
+}

data/etc/logger.yml

@@ -0,0 +1,18 @@
+default: &default
+  loggers:
+    -
+      level: debug
+      path: STDOUT
+    -
+      level: info
+      path: log/mqttsrvc.log
+      size: 52428800
+      count: 5
+development: 
+  <<: *default
+test:
+  <<: *default
+staging:
+  <<: *default
+production:
+  <<: *default

data/etc/mqtt.yml

@@ -0,0 +1,34 @@
+default: &default
+  client_id: mqttsrvc_0
+  host: localhost
+  port: 1883
+  ssl: false
+  keep_alive: 60
+  implicit_hash_key: "_msg"
+  topics:
+    sub:
+      - "/home/hello/in"
+      - "/home/shadowbox/cmd"
+    boot: "/home/boot"
+    lwt: "/home/lwt"
+    log: "/home/log"
+    pub: 
+      - "/home/hello/out"
+    ping: "/home/ping"
+    pong: "/home/pong"
+  qos: 2
+  retain: 0
+  keepalive: 15
+  client:
+    omit_retained: true
+development: 
+  <<: *default
+test:
+  <<: *default
+staging:
+  <<: *default
+production:
+  <<: *default
+  host: 'thngs.rmtly.com'
+  port: 8883
+  ssl: true

data/lib/app.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+require 'mqttsrvc'
+
+# sample MqttSrvc implementation
+class HelloMqttSrvc < MqttSrvc
+  def initialize
+    super(__dir__)
+
+    publish(@config.topics.pub.first, 'HelloWorld!')
+  end
+
+  def mqtt_receive(topic, msg, _msg_hash)
+    log_msg = "Received a message on #{topic}: #{msg}"
+    logger.debug(log_msg)
+    logger.data(log_msg)
+    logger.info(log_msg)
+    logger.warn(log_msg)
+    logger.error(log_msg)
+    logger.error_bold(log_msg)
+    publish(@config.topics.pub.first, @credentials['api_key'])
+  end
+end
+
+HelloMqttSrvc.new.run if $PROGRAM_NAME == __FILE__

data/lib/config.rb

@@ -0,0 +1,19 @@
+require 'yaml'
+require 'recursive_open_struct'
+
+class Config
+  def self.for(dir:, config_type:, config_extension: 'yml')
+    config_file_for_type = config_file(dir, config_type) + '.' + config_extension
+
+    puts "Loading config for environment #{environment} from '#{config_file_for_type}'..."
+    RecursiveOpenStruct.new(YAML.load_file(config_file_for_type)[environment])
+  end
+
+  def self.config_file(dir, config_type)
+    File.expand_path File.join(dir, '..', 'etc', config_type)
+  end
+
+  def self.environment
+    ENV['ENV'] || 'development'
+  end
+end

data/lib/credentials.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class Credentials
+  CREDENTIALS_FILE = 'credentials.json'.freeze
+
+  def self.for(dir:, credentials_type:)
+    puts "Loading #{credentials_type} credentials for environment #{environment} from '#{credentials_file(dir)}'..."
+    load(dir)[environment][credentials_type]
+  end
+
+  def self.credentials_file(dir)
+    File.join(dir, '..', 'etc', CREDENTIALS_FILE)
+  end
+  private_class_method :credentials_file
+
+  def self.environment
+    ENV['ENV'] || 'development'
+  end
+  private_class_method :environment
+
+  def self.load(dir)
+    JSON.parse(`ejson decrypt #{credentials_file(dir)}`)
+  end
+  private_class_method :load
+end

data/lib/mqtt_srvc_logger.rb

@@ -0,0 +1,80 @@
+#!/bin/false
+
+require 'logger'
+require 'colorize'
+require 'recursive_open_struct'
+
+class MqttSrvcLogger
+  def initialize(dir)
+    config = Config.for(dir: dir, config_type: 'logger')['loggers']
+
+    @loggers = {}
+    @logger_formatter = proc do |severity, datetime, _progname, msg|
+      "%s %-6s %s\n" % [datetime, severity, msg]
+    end
+
+    config.each do |logger_config|
+      logger_config = RecursiveOpenStruct.new(logger_config)
+
+      @loggers[logger_config.path] = configured_logger(logger_config)
+    end
+  end
+
+  def debug(msg)
+    each_logger { |logger| logger.debug(msg.light_blue) }
+  end
+
+  def info(msg)
+    each_logger { |logger| logger.info(msg.green) }
+  end
+
+  def data(msg)
+    each_logger { |logger| logger.info(msg.magenta) }
+  end
+
+  def warn(msg)
+    each_logger { |logger| logger.warn(msg.yellow) }
+  end
+
+  def error(msg)
+    each_logger { |logger| logger.error(msg.red) }
+  end
+
+  def error_bold(msg)
+    each_logger { |logger| logger.error(msg.red.bold) }
+  end
+
+  alias fatal error_bold
+
+  private
+
+  def each_logger
+    @loggers.each do |_key, logger|
+      yield logger
+    end
+  end
+
+  def configured_logger(logger_config)
+    if logger_config.path == 'STDOUT'
+      STDOUT.sync = true
+      logger = Logger.new(STDOUT)
+    else
+      create_log_dir(File.dirname(logger_config.path))
+
+      logger = Logger.new(
+        logger_config.path,
+        logger_config.count,
+        logger_config.size
+      )
+    end
+
+    logger.level = logger_config.level if logger_config.level
+    logger.formatter = @logger_formatter
+
+    logger
+  end
+
+  def create_log_dir(dir)
+    Dir.mkdir(dir) unless Dir.exist?(dir)
+  end
+end

data/lib/mqttsrvc.rb

@@ -0,0 +1,136 @@
+#!/usr/bin/env ruby
+
+require 'mqtt'
+require 'json'
+require_relative 'config'
+require_relative 'credentials'
+require_relative 'mqtt_srvc_logger'
+
+# framework for building ruby-based MQTT services
+class MqttSrvc
+  CONFIG_TYPE = 'mqtt'.freeze
+
+  attr_reader :logger
+
+  def initialize(dir)
+    @config = Config.for(dir: dir, config_type: CONFIG_TYPE)
+    @credentials = Credentials.for(dir: dir, credentials_type: 'mqtt')
+
+    puts 'Setting up logger...'
+    @logger = MqttSrvcLogger.new(dir)
+    @logger.info("Logger configured.")
+
+    @logger.info('Creating MQTT client...')
+    @mqtt_client = MQTT::Client.connect(
+      host: @config.host,
+      port: @config.port,
+      ssl: @config.ssl,
+      keep_alive: @config.keep_alive,
+      username: @credentials['api_key'],
+      password: @credentials['api_secret']
+    )
+    @logger.info("Client connected to #{@config.host}.")
+
+    subscribe_to_topics
+    subscribe_to_ping
+  end
+
+  def run
+    @run = true
+    do_loop
+  end
+
+  def stop
+    @run = false
+  end
+
+  def publish(topic, payload, retain = false)
+    payload = { @config.implicit_hash_key => payload } if payload.class.to_s == "".class.to_s
+    add_client_id(payload)
+    payload = payload.to_json
+    @logger.info('PUB ' + topic + ' | ' + payload.to_s)
+    @mqtt_client.publish(topic, payload, retain: retain)
+  end
+
+  def ping_topic
+    @ping_topic ||= @config.topics.ping + '/' + @credentials['api_key']
+  end
+
+  def pong_topic
+    @pong_topic ||= @config.topics.pong + '/' + @credentials['api_key']
+  end
+
+  private
+
+  def subscribe_to_topics
+    topics = @config.topics.sub
+    if topics.nil? || topics.empty?
+      @logger.info('No topics to which to subscribe.')
+      return
+    end
+    topics.each do |topic|
+      @logger.debug("Subscribing to #{topic}...")
+      subscribe(topic)
+    end
+  end
+
+  def subscribe_to_ping
+    @logger.debug("Subscribing to #{ping_topic}...")
+    subscribe(ping_topic)
+  end
+
+  def subscribe(topic)
+    @logger.info('SUB ' + topic)
+    @mqtt_client.subscribe(topic)
+  end
+
+  def do_loop
+    while @run
+      begin
+        @mqtt_client.get(nil, @config.client) do |topic, msg|
+          @logger.debug 'RCV ' + topic + ' | ' + msg.to_s
+          msg_hash = decode_message(msg)
+          mqtt_receive_shim(topic, msg, msg_hash)
+        end
+      rescue SystemExit, Interrupt
+        raise
+      rescue StandardError => e
+        @logger.error_bold e.message
+        @logger.error '    ' + e.backtrace.join($/ + '    ')
+      end
+    end
+  rescue Interrupt => e
+    @logger.info '[INT] Exiting...'
+    begin
+      @mqtt_client.disconnect
+    rescue Interrupt
+      @logger.info '[INT] Aborting...'
+    end
+  end
+
+  def decode_message(msg)
+    begin
+      msg_hash = JSON.parse(msg)
+      msg_hash = nil unless msg_hash.class == Hash
+    rescue JSON::ParserError
+      msg_hash = {@config.implicit_hash_key => msg}
+    end
+    msg_hash
+  end
+
+  def mqtt_receive_shim(topic, msg, msg_hash)
+    @logger.info "#{topic} #{msg}"
+    if topic == ping_topic
+      @logger.debug('Handling ping...')
+      publish(pong_topic, state: true)
+    else
+      mqtt_receive(topic, msg, msg_hash)
+    end
+  end
+
+  def add_client_id(payload)
+    payload[:clientid] = @credentials['api_key']
+  end
+end
+
+MqttSrvc.new(__dir__).run if $PROGRAM_NAME == __FILE__

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: mqttsrvc
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+platform: ruby
+authors:
+- nick@rmtly.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: mqtt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: 
+email: nick@rmtly.com
+executables:
+- mqttsrvc
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- bin/mqttsrvc
+- etc/credentials.json
+- etc/logger.yml
+- etc/mqtt.yml
+- lib/app.rb
+- lib/config.rb
+- lib/credentials.rb
+- lib/mqtt_srvc_logger.rb
+- lib/mqttsrvc.rb
+homepage: https://rmtly.com
+licenses:
+- Nonstandard
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: mqttsrvc provides a framework for MQTT-based services
+test_files: []