particlepi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 378a300df1c3cd72dc616ff61695f01c6ebce650
+  data.tar.gz: fcfba3c8e971740842f5d0e4fac0e7e285c8d700
+SHA512:
+  metadata.gz: ea5458b2fbbc1304b9403d208a66cfc6cf14fbab8609179b8db49730ffd5b535bca1a98cffbd1b5ffa9ad0cfd60bb8c59c13166611eff67f462be5fed9ceb07d
+  data.tar.gz: 85b304c940ab2c8a32e521e4520606679f90da4140065cdd84d4af66203b12c53f97c617c0c662541ebbf398751f634a7510c6e4d2d5f7d7cef8b4476dd4fbf0

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+# For travis
+gem "rake", "~> 11.0"
+
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2014 Spark IO
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,106 @@
+# Particle Pi Agent [![Build Status](https://travis-ci.com/spark/particlepi.svg?token=xZbAFMKBu94uE5pFYFFK&branch=master)](https://travis-ci.com/spark/particlepi)
+
+This program supervises the Particle firmware executable running on
+Raspberry Pi.
+
+## Architecture
+
+Particle Pi is a Ruby application. The logic lives inside <lib>
+
+The Agent is an executable that runs as a background service (daemon).
+The agent executable is <bin/agent> and does things like command line parsing.
+It delegates to the [Daemon class](lib/daemon.rb) to manage a PID file,
+a log file and fork the process to the background.
+
+The service description for the Agent is a System V init script in
+<init/particlepi>. I tried making a systemd service but couldn't find
+the right documentation to set that up.
+
+## Installing the service
+
+```
+sudo cp init/particlepi /etc/init.d
+sudo ln -s $PWD/bin/agent /usr/local/bin/particlepi-agent
+sudo insserv particlepi
+```
+
+After updating the `init/particlepi` script run:
+```
+sudo systemctl daemon-reload
+```
+
+Note: `update-rc.d` is deprecated. Use `insserv` instead.
+
+## Start the service
+
+```
+sudo service particlepi start
+```
+
+Other commands:
+```
+$ sudo service particlepi
+Usage: /etc/init.d/particlepi {start|stop|restart|status}
+```
+
+
+## Releasing software to a Debian personal package archive (PPA)
+
+Our PPA is https://launchpad.net/~particleio/+archive/ubuntu/particlepi
+
+1. Create an account on Launchpad
+2. Create a team on Launchpad
+3. Create a PPA on Launchpad
+https://help.launchpad.net/Packaging/PPA/BuildingASourcePackage
+4. Upload a source package to Launchpad
+https://help.launchpad.net/Packaging/PPA/Uploading
+5. Launchpad will build your package
+
+To get added to the Launchpad team, launch https://launchpad.net/people/+me, register an account and ask one of the existing team members to add you to the particleio team.
+
+### Development notes
+
+Communicate with child processes
+https://www.rubytapas.com/2016/06/16/episode-419-subprocesses-part-4-redirection/
+
+`
+input, output = IO.pipe
+
+pid = Process.spawm "exec", "arg", out: output
+
+Process.waitpid(pid)
+input.close
+input.read
+`
+
+>>
+
+`
+rd, wr = IO.pipe
+
+if fork
+  wr.close
+  puts "Starting read"
+  puts "Parent got: <#{rd.read}>"
+  rd.close
+  Process.wait
+else
+  rd.close
+  sleep 1
+  puts "Sending message to parent"
+  wr.write "Hi Dad"
+  wr.close
+end
+`
+
+>>
+
+Trap SIGCHLD when child exits
+https://www.rubytapas.com/2016/06/30/episode-423-subprocesses-part-5-sigchld/
+
+`
+trap("CHLD") do
+  pid = Process.waitpid(-1)
+  pids[pid] = :done
+end
+`

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.pattern = "spec/*_spec.rb"
+end
+
+task default: :test

data/bin/particlepi

@@ -0,0 +1,12 @@
+#!/usr/bin/ruby
+
+$LOAD_PATH.unshift File.expand_path("../../lib", File.realdirpath(__FILE__))
+
+require "particlepi/cli"
+
+begin
+  ParticlePi::CLI.start(ARGV)
+rescue Interrupt, EOFError
+  # Ctrl-C or Ctrl-D ==> bye bye!
+  puts
+end

data/bin/particlepi-agent

@@ -0,0 +1,48 @@
+#!/usr/bin/ruby
+
+$LOAD_PATH.unshift File.expand_path("../../lib", File.realdirpath(__FILE__))
+
+require 'optparse'
+
+options = {}
+
+version = "1.0.0"
+
+options        = {}
+version        = "1.0.0"
+daemonize_help = "run daemonized in the background (default: false)"
+pidfile_help   = "the pid filename"
+logfile_help   = "the log filename"
+debug_help     = "set $DEBUG to true"
+warn_help      = "enable warnings"
+
+op = OptionParser.new
+op.banner =  "A background service that supervises the Particle firmware"
+op.separator ""
+op.separator "Usage: daemon [options]"
+op.separator ""
+
+op.separator "Process options:"
+op.on("-d", "--daemon",   daemonize_help)      { options[:daemonize] = true  }
+op.on("-p", "--pidfile PIDFILE", pidfile_help) { |value| options[:pidfile]   = value }
+op.on("-l", "--logfile LOGFILE", logfile_help) { |value| options[:logfile]   = value }
+op.separator ""
+
+op.separator "Ruby options:"
+op.on(      "--debug",        debug_help)   { $DEBUG = true }
+op.on(      "--warn",         warn_help)    { $-w = true    }
+op.separator ""
+
+op.separator "Common options:"
+op.on("-h", "--help")    { puts op.to_s; exit }
+op.on("-v", "--version") { puts version; exit }
+op.separator ""
+
+op.parse!(ARGV)
+
+require 'particlepi/daemon'
+require 'particlepi/agent'
+ParticlePi::Daemon.new(options).run! do |daemon|
+  ParticlePi::Agent.new.run!(daemon)
+end
+

data/init/particlepi

@@ -0,0 +1,57 @@
+#!/bin/sh
+# Start/stop the Particle Pi agent
+#
+### BEGIN INIT INFO
+# Provides:          particlepi
+# Required-Start:    $remote_fs $syslog
+# Required-Stop:     $remote_fs $syslog
+# Default-Start:     2 3 4 5
+# Default-Stop:      0 1 6
+# Short-Description: Manages Particle firmware
+### END INIT INFO
+#set -x
+PATH=/sbin:/bin:/usr/sbin:/usr/bin
+DESC="Particle Agent"
+NAME=particlepi
+
+DAEMON=/usr/local/bin/particlepi-agent
+PIDFILE=/var/run/particlepi.pid
+LOGFILE=/var/log/particlepi.log
+
+# Load helper functions
+. /lib/init/vars.sh
+. /lib/lsb/init-functions
+
+# Exit if the package is not installed
+test -x $DAEMON || exit 5
+
+#
+# Function that starts the daemon/service
+case $1 in
+  start)
+    log_daemon_msg "Starting $DESC" "$NAME"
+    start-stop-daemon -v --start --quiet --oknodo --pidfile $PIDFILE --exec \
+      $DAEMON -- --daemon --pidfile $PIDFILE --logfile $LOGFILE
+    log_end_msg $?
+    ;;
+  stop)
+    log_daemon_msg "Stopping $DESC" "$NAME"
+    start-stop-daemon -v --stop --signal TERM --retry 30 --quiet --oknodo --pidfile $PIDFILE
+    log_end_msg $?
+    rm -f $PIDFILE
+    ;;
+  restart)
+    $0 stop
+    sleep 1
+    $0 start
+    ;;
+  status)
+    status_of_proc -p $PIDFILE "$DAEMON" "$NAME" && exit 0 || exit $?
+    ;;
+  *)
+    echo "Usage: $0 {start|stop|restart|status}"
+    exit 2
+    ;;
+esac
+
+exit 0