garden_messenger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf2e78c5ee99e2dcf110210cd876d6b54f0167a6e8152d23917bdf55f4e13f39
+  data.tar.gz: ca12a8feeb88be444d884fc4f7f57904e90ea8ee94435ab77e32969542a1c727
+SHA512:
+  metadata.gz: dc358cb22acfbdb7aeeb3a704927323228c16762c7f257c15311fa1bbb6a12e54e0e8488eecf4f90188281940f90e4775e43bc10cd4f141cab8ab8102dbb628a
+  data.tar.gz: 1e6ab85daf7cc36f5632eeb8655fcf9a40b34e10f7e51bd2d1cff86fc13487f915bb35c0e2bb55d3765e67f6cc4b6f31caeaa5d7d1b6bbd67a560906db99f212

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.travis/deploy_id
+/log/*
+!/log/.keep
+/vendor/*
+!/vendor/.keep
+/deploy_id
+/deploy_id.pub
+# rubocop cache files
+/.rubocop-*

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  - https://raw.githubusercontent.com/siegy22/dotfiles/de0fd27c50d34b4fce5a3947c0041a55e36e9fcb/rubocop.yml

data/.travis.yml

@@ -0,0 +1,11 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6
+before_install:
+  - gem install bundler -v '~> 2'
+script:
+  - bundle exec rake test
+  - bundle exec rubocop

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 Elektron1c97@gmail.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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    garden_messenger (0.1.0)
+      action_cable_client (~> 3.0)
+      http (~> 4.1)
+      i2c-devices (~> 0.0.6)
+      thor (~> 0.20)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    action_cable_client (3.0.1)
+      websocket-eventmachine-client (>= 1.2.0)
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    eventmachine (1.2.7)
+    http (4.1.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.0)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.1.1)
+    http_parser.rb (0.6.0)
+    i2c-devices (0.0.6)
+    jaro_winkler (1.5.2)
+    minitest (5.11.3)
+    parallel (1.17.0)
+    parser (2.6.2.1)
+      ast (~> 2.4.0)
+    psych (3.1.0)
+    public_suffix (3.0.3)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rubocop (0.67.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.10.0)
+    thor (0.20.3)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+    unicode-display_width (1.5.0)
+    websocket (1.2.8)
+    websocket-eventmachine-base (1.2.0)
+      eventmachine (~> 1.0)
+      websocket (~> 1.0)
+      websocket-native (~> 1.0)
+    websocket-eventmachine-client (1.2.0)
+      websocket-eventmachine-base (~> 1.0)
+    websocket-native (1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  garden_messenger!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  rubocop (~> 0.67)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Yves Siegrist
+
+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,57 @@
+# GardenMessenger
+
+[![Build Status](https://travis-ci.org/siegy22/garden_messenger.svg?branch=master)](https://travis-ci.org/siegy22/garden_messenger)
+
+Collects data of [AtlasScientific](https://www.atlas-scientific.com/) and [myStrom](https://mystrom.ch/) devices. The data is sent to [garden_monitor](https://github.com/siegy22/garden_monitor).
+
+Currently supported:
+
+[ ] [pH Kit](https://www.atlas-scientific.com/product_pages/kits/ph-kit.html)
+[ ] [Conductivity K 1.0 Kit](https://www.atlas-scientific.com/product_pages/kits/ec_k1_0_kit.html)
+[ ] [Temperature Kit](https://www.atlas-scientific.com/product_pages/kits/temp_kit.html)
+[x] [myStrom Switch (CH)](https://mystrom.ch/wifi-switch-ch/)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+Install it:
+
+```bash
+gem install garden_messenger
+```
+
+Checkout the [service file](/garden_messenger.service) for a template of a systemd service.
+
+## Usage
+
+Basic usage:
+
+```bash
+garden_messenger report http://garden-monitor.example.com super-secret-token
+```
+
+for advanced usage use, see:
+
+```bash
+garden_messenger help report
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/siegy22/garden_messenger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the GardenMessenger project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/siegy22/garden_messenger/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "garden_messenger"
+
+# 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/deploy/after_push

@@ -0,0 +1,17 @@
+#!/usr/bin/env zsh
+set -e
+oldrev=$1
+newrev=$2
+
+run() {
+  [ -x $1 ] && $1 $oldrev $newrev
+}
+
+echo files changed: $(git diff $oldrev $newrev --diff-filter=ACDMR --name-only | wc -l)
+
+umask 002
+
+git submodule sync && git submodule update --init --recursive
+
+run deploy/before_restart
+run deploy/restart && run deploy/after_restart

data/deploy/before_restart

@@ -0,0 +1,3 @@
+#!/usr/bin/env zsh
+
+bundle install --deployment

data/deploy/restart

@@ -0,0 +1,3 @@
+#!/usr/bin/env zsh
+
+sudo systemctl restart garden_messenger

data/exe/garden_messenger

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+
+require 'garden_messenger'
+require 'thor'
+
+class MessengerCLI < Thor
+  desc 'report MONITOR_URL TOKEN [options]', 'Report to a monitor which is located on MONITOR_URL'
+  option 'wattage-switch-host'
+  option 'update-rate'
+  option 'verbose', type: :boolean
+  def report(monitor_url, token)
+    reporter = GardenMessenger::Reporter.new(
+      monitor_url,
+      token,
+      options.fetch('update-rate') { 30 },
+      options.fetch('verbose') { false }
+    )
+
+    reporter.report! do
+      data = {}
+
+      if options.key?('wattage-switch-host')
+        wattage = GardenMessenger::Wattage.new(options['wattage-switch-host'])
+        data[:wattage] = wattage.get
+      end
+
+      data[:temp] = rand(18.0...26.0)
+      data[:ph] = rand(4.0...8.0)
+      data[:ec] = rand(0.8...1.6)
+
+      data
+    end
+  end
+
+  desc 'dev', 'Report random values to local monitor'
+  def dev
+    reporter = GardenMessenger::Reporter.new(
+      'ws://localhost:3000/cable',
+      'dev-token',
+      1,
+      true
+    )
+
+    reporter.report! do
+      temp = rand(18.0...26.0)
+      ph = rand(4.0...8.0)
+      ec = rand(0.8...1.6)
+      wattage = rand(700.0...800.0)
+      { temp: temp, ph: ph, ec: ec, wattage: wattage }
+    end
+  end
+end
+
+MessengerCLI.start(ARGV)

data/garden_messenger.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'garden_messenger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'garden_messenger'
+  spec.version       = GardenMessenger::VERSION
+  spec.authors       = ['Yves Siegrist']
+  spec.email         = ['Elektron1c97@gmail.com']
+
+  spec.summary       = 'Delivery boy for garden_monitor'
+  spec.description   = '...'
+  spec.homepage      = 'https://github.com/siegy22/garden_messenger'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  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.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'action_cable_client', '~> 3.0'
+  spec.add_dependency 'http', '~> 4.1'
+  spec.add_dependency 'i2c-devices', '~> 0.0.6'
+  spec.add_dependency 'thor', '~> 0.20'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.67'
+end

data/garden_messenger.service

@@ -0,0 +1,15 @@
+[Unit]
+Description=Garden messenger captures data of your garden.
+Wants=network-online.target
+After=network-online.target
+
+[Service]
+Type=simple
+Restart=always
+RestartSec=1
+User=siegy
+
+ExecStart=/bin/zsh -lc "garden_messenger report $MESSENGER_MONITOR_URL $MESSENGER_TOKEN --verbose"
+
+[Install]
+WantedBy=multi-user.target

data/lib/garden_messenger/reporter.rb

@@ -0,0 +1,62 @@
+require 'action_cable_client'
+require 'eventmachine'
+
+module GardenMessenger
+  class Reporter
+    def initialize(monitor_url, token, update_rate, verbose = false)
+      @monitor_url = monitor_url
+      @token = token
+      @update_rate = update_rate
+      @verbose = verbose
+
+      if @verbose
+        puts "Initialized #{self.class.name}:"
+        puts "  > monitor_url: #{@monitor_url}"
+        puts "  > token: #{@token}"
+        puts "  > update_rate: #{@update_rate} (seconds)"
+      end
+    end
+
+    def report!
+      EventMachine.run do
+        Signal.trap('INT')  { EventMachine.stop }
+        Signal.trap('TERM') { EventMachine.stop }
+
+        client = ActionCableClient.new(
+          @monitor_url,
+          'MessengerChannel',
+          true,
+          Authorization: "Token #{@token}"
+        )
+
+        # called whenever a welcome message is received from the server
+        client.connected do
+          if @verbose
+            puts 'Connection established with monitor ' \
+                 "on #{@monitor_url}"
+          end
+          Thread.new do
+            loop do
+              data = yield
+              puts "Sending data: #{data.to_json}" if @verbose
+              client.perform('report', data)
+
+              sleep @update_rate
+            end
+          end
+        end
+
+        client.disconnected do
+          puts 'Disconnected from monitor, exiting'
+          exit 1
+        end
+
+        client.errored do |error|
+          puts "Error received: #{error}"
+        end
+
+        client.received
+      end
+    end
+  end
+end

data/lib/garden_messenger/version.rb

@@ -0,0 +1,3 @@
+module GardenMessenger
+  VERSION = '0.1.0'.freeze
+end

data/lib/garden_messenger/wattage.rb

@@ -0,0 +1,14 @@
+require 'http'
+
+module GardenMessenger
+  class Wattage
+    def initialize(host)
+      @uri = URI::HTTP.build(host: host, path: '/report')
+    end
+
+    def get
+      response = HTTP.get(@uri.to_s).parse
+      response['power']
+    end
+  end
+end

data/lib/garden_messenger.rb

@@ -0,0 +1,8 @@
+require 'garden_messenger/reporter'
+require 'garden_messenger/version'
+require 'garden_messenger/wattage'
+
+module GardenMessenger
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: garden_messenger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yves Siegrist
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: action_cable_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: i2c-devices
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.67'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.67'
+description: "..."
+email:
+- Elektron1c97@gmail.com
+executables:
+- garden_messenger
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- deploy/after_push
+- deploy/before_restart
+- deploy/restart
+- exe/garden_messenger
+- garden_messenger.gemspec
+- garden_messenger.service
+- lib/garden_messenger.rb
+- lib/garden_messenger/reporter.rb
+- lib/garden_messenger/version.rb
+- lib/garden_messenger/wattage.rb
+- log/.keep
+homepage: https://github.com/siegy22/garden_messenger
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Delivery boy for garden_monitor
+test_files: []