lex-esphome 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 148f84f9ca373f72b699972f52455d6daa583da5229e7223a14a8db3214a5c32
+  data.tar.gz: 73e621f2470dc178fd2cdf890372af7148d090538c6c6d5b55e0a5cbc6e1d8ec
+SHA512:
+  metadata.gz: edce3c1f083e18ffb72b911d2200bad900357191da6cb2b66065cc5d5647c555e628038998133a351ad200541079f927e8b58b395409f802c02c888ba7881e80
+  data.tar.gz: 6d4195bb0a038486df1d1b9b973026de887f6557e67dc37036399783b4cf59cebbdbf6991aa2558cff315353723517c1267c39ddfcef9d5af756b4dd9bab9157

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,28 @@
+Layout/LineLength:
+  Max: 120
+Metrics/MethodLength:
+  Max: 50
+Metrics/ClassLength:
+  Max: 1500
+Metrics/BlockLength:
+  Max: 50
+Metrics/AbcSize:
+  Max: 30
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: space
+Style/SymbolArray:
+  Enabled: true
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+Style/Documentation:
+  Enabled: false
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Naming/FileName:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at matt.iverson@optum.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 miverso2
+
+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,89 @@
+# Legion::Extensions::Esphome
+
+A Legion Extension to process messages coming from the [ESPHome](https://esphome.io/) Project
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lex-esphome'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install lex-esphome
+
+## Adding to Legion
+You can manually install with a `gem install lex-esphome` command or by adding it into your settings with something like this
+```json
+{
+  "extensions": {
+    "esphome": {
+      "enabled": true, "workers": 1
+    }
+  }
+}
+```
+
+Example [shoveler](https://www.rabbitmq.com/shovel.html) definition to get data over from `/` to `/legion` when using [RabbitMQ + MQTT](https://www.rabbitmq.com/mqtt.html)
+```json
+{
+  "permissions": [{
+    "user": "legion",
+	"vhost": "/",
+	"read": "to_legion"
+  }],
+  "parameters": [{
+	"value": {
+	  "dest-exchange": "esphome",
+	  "dest-protocol": "amqp091",
+	  "dest-uri": "amqp://legion@/legion",
+	  "src-delete-after": "never",
+	  "src-protocol": "amqp091",
+	  "src-queue": "to_legion",
+	  "src-uri": "amqp://"
+	},
+	"vhost": "legion",
+	"component": "shovel",
+	"name": "ESPHome -> Legion"
+  }],
+	"queues": [{
+      "name": "to_legion",
+	  "vhost": "/",
+	  "durable": true,
+	}],
+	"bindings": [{
+	  "source": "amq.topic",
+	  "vhost": "/",
+	  "destination": "to_legion",
+	  "destination_type": "queue",
+	  "routing_key": "#.sensor.#.state",
+	  "arguments": {}
+	}, {
+	  "source": "amq.topic",
+	  "vhost": "/",
+	  "destination": "to_legion",
+	  "destination_type": "queue",
+	  "routing_key": "esphome.logs.#",
+	  "arguments": {}
+	}]
+}
+```
+
+## Usage
+There are two passive runners within this Lex. One to process log entries, the other to process sensor data
+
+|runner|function|value|routing key|timestamp_in_ms|
+|---|---|---|---|---|
+|Logs|process|required|required|X|
+|Sensors|process|required|required|optional|
+
+
+## Development
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'legion/extensions/esphome'
+
+# 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(__FILE__)

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/lex-esphome.gemspec

@@ -0,0 +1,34 @@
+require_relative 'lib/legion/extensions/esphome/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lex-esphome'
+  spec.version       = Legion::Extensions::Esphome::VERSION
+  spec.authors       = ['Esity']
+  spec.email         = ['matthewdiverson@gmail.com']
+
+  spec.summary       = 'LEX::Esphome'
+  spec.description   = 'Used to connect Legion to Esphome'
+  spec.homepage      = 'https://bitbucket.org/legion-io/lex-esphome'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://bitbucket.org/legion-io/lex-esphome'
+  spec.metadata['changelog_uri'] = 'https://bitbucket.org/legion-io/lex-esphome/src/master/CHANGELOG.md'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'codecov'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec_junit_formatter'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-md'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rspec'
+end

data/lib/legion/extensions/esphome.rb

@@ -0,0 +1,10 @@
+require 'legion/extensions/esphome/version'
+require 'legion/extensions'
+
+module Legion
+  module Extensions
+    module Esphome
+      extend Legion::Extensions::Core
+    end
+  end
+end

data/lib/legion/extensions/esphome/actors/logs.rb

@@ -0,0 +1,21 @@
+module Legion
+  module Extensions
+    module Esphome
+      module Actor
+        class Logs < Legion::Extensions::Actors::Subscription
+          def runner_function
+            'process'
+          end
+
+          def include_metadata_in_message?
+            true
+          end
+
+          def generate_task?
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/esphome/actors/sensors.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Legion
+  module Extensions
+    module Esphome
+      module Actor
+        class Sensors < Legion::Extensions::Actors::Subscription
+          def runner_function
+            'process'
+          end
+
+          def include_metadata_in_message?
+            true
+          end
+
+          def generate_task?
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/esphome/runners/logs.rb

@@ -0,0 +1,19 @@
+module Legion
+  module Extensions
+    module Esphome
+      module Runners
+        module Logs
+          def self.process(value:, **payload)
+            {
+              log:             value.gsub(/\e\[([;\d]+)?m/, ''),
+              location:        payload[:routing_key].split('.').last,
+              timestamp_in_ms: payload[:timestamp_in_ms]
+            }
+          end
+
+          include Legion::Extensions::Helpers::Lex
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/esphome/runners/sensors.rb

@@ -0,0 +1,57 @@
+module Legion
+  module Extensions
+    module Esphome
+      module Runners
+        module Sensors
+          def self.process(value:, **payload) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/AbcSize,Metrics/PerceivedComplexity
+            items = payload[:routing_key].split('.')
+
+            subtype = if items[2].include?('fan')
+                        'fan'
+                      elsif items[2].include?('voltage')
+                        'voltage'
+                      elsif items[2].include?('temp')
+                        'temperature'
+                      elsif items[2].include?('humidity')
+                        'humidity'
+                      elsif items[2].include?('wifi_signal')
+                        'wifi_signal'
+                      elsif items[2].include?('uptime')
+                        'uptime'
+                      elsif items[2].include?('pressure')
+                        'pressure'
+                      elsif items[2].include?('pulse')
+                        'pulse'
+                      elsif items[2].include?('meter')
+                        'meter'
+                      elsif items[2].include?('brightness')
+                        'brightness'
+                      elsif items[2].include?('illuminance') || items[2].include?('lx') || items[2].include?('bright')
+                        'illuminance'
+                      elsif items[2].include?('current')
+                        'current'
+                      end
+
+            if subtype.nil?
+              log.warn("Subtype was not found for esphome item subtype: #{items[2]}")
+              subtype = items[2]
+            elsif subtype == 'temperature'
+              value = ((value.to_i * 9 / 5) + 32).round(3) if settings[:convert_c_to_f]
+            end
+
+            {
+              value:           value,
+              name:            items[0],
+              type:            items[2],
+              sub_type:        subtype,
+              item:            items[3],
+              timestamp_in_ms: payload[:timestamp_in_ms]
+            }
+          end
+
+          include Legion::Extensions::Helpers::Lex
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/esphome/transport.rb

@@ -0,0 +1,14 @@
+require 'legion/extensions/transport'
+require 'legion/extensions/esphome'
+
+module Legion::Extensions::Esphome
+  module Transport
+    extend Legion::Extensions::Transport
+    def self.additional_e_to_q
+      [
+        { from: 'esphome', to: 'sensors', routing_key: '#.sensor.#.state' },
+        { from: 'esphome', to: 'logs', routing_key: 'esphome.logs.#' }
+      ]
+    end
+  end
+end

data/lib/legion/extensions/esphome/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Legion
+  module Extensions
+    module Esphome
+      VERSION = '0.1.0'
+    end
+  end
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: lex-esphome
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Esity
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: codecov
+  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: rake
+  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: 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: rspec_junit_formatter
+  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: rubocop
+  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: rubocop-md
+  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: rubocop-performance
+  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: rubocop-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'
+description: Used to connect Legion to Esphome
+email:
+- matthewdiverson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lex-esphome.gemspec
+- lib/legion/extensions/esphome.rb
+- lib/legion/extensions/esphome/actors/logs.rb
+- lib/legion/extensions/esphome/actors/sensors.rb
+- lib/legion/extensions/esphome/runners/logs.rb
+- lib/legion/extensions/esphome/runners/sensors.rb
+- lib/legion/extensions/esphome/transport.rb
+- lib/legion/extensions/esphome/version.rb
+homepage: https://bitbucket.org/legion-io/lex-esphome
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://bitbucket.org/legion-io/lex-esphome
+  source_code_uri: https://bitbucket.org/legion-io/lex-esphome
+  changelog_uri: https://bitbucket.org/legion-io/lex-esphome/src/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: LEX::Esphome
+test_files: []