brewer 0.0.83 → 0.0.89

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 609b03ad9438c34f412625c145e3ea542aa1ba24
-  data.tar.gz: c8c87ac2200e23851190b84c6a6d6cf243c46c53
+  metadata.gz: d8bb3d0d515993f778a4aeac172e3eafef9402c8
+  data.tar.gz: 0e7c1aa4c511b6a441c575afaed60e43fb594dbe
 SHA512:
-  metadata.gz: 361547ccce8b1cb02ea49364554d5c03101d6c922bd1672dbc63a90fce2e2a48ba2b90a473b3520c74dd61f6228e36ef180810b47d6159f123064441e82c43ea
-  data.tar.gz: 3a60d9739afa32e0a89166b8c693e9fb539f177a69956e1ed7bcff9c519da66ac23037b0e323f113460238c5d2fb7eb92271841c9cc6603f68c68fb939b8a652
+  metadata.gz: 8ca12ae113bcf9d5eb5b16e07c4af5a18f147fb8ac3b11fb4e6923c7f578bafd4416b4d592ad2b85162f07c696635da0d9a7f19072b3d9b609c13e0e93b0fcc9
+  data.tar.gz: 40658e53decd3f843ee1eb33c7b7d3cfa87fb848686a8b870219745d0c504881a81b95f1b3a945d931dd692d2fc1f1f9a9ecf5be670a479dcc57e63c43e22dea

data/Gemfile.lock

@@ -1,12 +1,14 @@
 PATH
   remote: .
   specs:
-    brewer (0.0.74)
+    brewer (0.0.88)
       git (~> 1.3, >= 1.3.0)
       net-ping (~> 1.7)
+      rack-flash3
       rainbow
       require_all
       ripl (~> 0.7.0)
+      sinatra
       slack-notifier
       terminal-table
       wannabe_bool
@@ -25,6 +27,11 @@ GEM
       addressable (~> 2.3)
     net-ping (1.7.8)
     public_suffix (2.0.5)
+    rack (1.6.5)
+    rack-flash3 (1.0.5)
+      rack
+    rack-protection (1.5.3)
+      rack
     rainbow (2.2.1)
     rake (12.0.0)
     rdoc (5.1.0)
@@ -49,9 +56,14 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
+    sinatra (1.4.8)
+      rack (~> 1.5)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
     slack-notifier (2.1.0)
     terminal-table (1.7.3)
       unicode-display_width (~> 1.1.1)
+    tilt (2.0.7)
     unicode-display_width (1.1.3)
     wannabe_bool (0.6.0)
 

data/README.md

@@ -2,31 +2,84 @@
 ### A Ruby gem for [adaptiman/adaptibrew](http://github.com/adaptiman/adaptibrew)
 
 # Disclaimer
-This is just a gem to make adaptibrew more user friendly. It will provide a clean shell and easy to understand methods for all the actions you need to control your brew rig with continuity.
+This is a gem that will provide a command line interface for [adaptiman/adaptibrew](http://github.com/adaptiman/adaptibrew). It will provide pre-made procedures (see Brewer::Procedures) and an easy interface to control a brewing rig.
 
 This will require an actual brew rig and all the equipment listed in [adaptiman/adaptibrew](https://github.com/adaptiman/adaptibrew)'s readme. If you are looking to build an automated brew rig, **this is not the place to start**. Head over to [adaptiman/adaptibrew](https://github.com/adaptiman/adaptibrew), or hit up [adaptiman](https://github.com/adaptiman).
 
+# Quick Start
+
+You should have ruby installed. Install this gem with:
+
+```shell
+gem install brewer
+```
+
+Start the brewer shell with
+
+```shell
+brewer
+```
+
+
+You can now run the master procedure (the entire standard brewing process) with:
+
+```ruby
+>> procedures.master
+```
+
+
+You will be prompted to enter a slack `webhook_url`, which you can get from the `incoming-webhooks` integration on your slack channel.
+
+
+The shell will ask you for recipe variables in the beginning, and will warn you when you need to intervene.
+
+# Web Interface (in development)
+Run the `brewer-server` binary the same way you would run the `brewer` binary. This will start a `sinatra` server on your pi's ip address. The default port is `8080`, but you can specify a custom port with:
+
+```shell
+sudo brewer-server -p YOUR_PORT
+```
+
+Keep in mind that any port below 1024 will need root access. I like to specify port `80` (http default) so that I can leave the port off and it will default to 80.
+
+You can add a line to `/etc/hosts` on your workstation and redirect a url to your pi's ip. For instance, the relevant line in my `/etc/hosts` looks like this:
+
+```shell
+192.168.0.224   navasota.brew
+```
+
+so I can visit `navasota.brew` and see the brewing homepage when `brewer-server` is running.
+
+# Starting the server on system startup
+
+You may want to start the `brewer-server` an system boot so that a workstation is not required to connect (ssh) to your pi.
+
+[See here for a StackOverflow solution](https://raspberrypi.stackexchange.com/a/8735) or read on below.
+
 # Installation
 This is a gem, published on [rubygems.org](http://rubygems.org). Install it the recommended way with:
 ```shell
 gem install brewer
 ```
 This will be the latest stable release.
-**Or** you can put the following line in a `Gemfile`;
+**Or** you can put the following line in a `Gemfile`:
 ```ruby
 gem 'brewer'
 ```
-and run `bundle install`.
+or `.gemspec` file:
+```ruby
+s.add_runtime_dependency 'brewer'
+```
 
-You may also download a .gem file from the releases section and install it that way, or further still build a new .gem file from the `brewer.gemspec` if you want the latest possible release. Keep in mind this may not be stable.
+You may also download a .gem file from the [releases section on github](https://github.com/llamicron/brewer/releases) and install it that way, or further still build a new .gem file from the `brewer.gemspec` if you want the latest possible release. This is not recommended, as I do not regularly make releases on Github, just rubygems
 
 After installation, run
 ```shell
 brewer
 ```
-to open an interactive shell to control your brew rig in realtime.Just like any other gem, you can `require 'brewer'` from another ruby project.
+to open an interactive shell to control your brew rig in realtime. Just like any other gem, you can `require 'brewer'` from another ruby project.
 
-# Documentation
+# Note
 **Warning: RDoc may have a seizure when encountering Gemfiles, Rakefiles, etc. Basically files that don't end in `.rb` but have ruby syntax. Docs will be a bit weird on those files. I suggest just reading the comments in source.**
 Documentation is in `doc/` or on rubygems.org
 

data/Rakefile

@@ -8,8 +8,14 @@ task default: %w[spec]
 # Unit testing
 # You can specify a specific test case to use
 # rake spec SPEC=spec/adaptibrew_spec.rb SPEC_OPTS="-e \"#new\""
-task :spec, [:tc] do |t, tc|
-  RSpec::Core::RakeTask.new(:spec)
+#
+# task :spec, [:tc] do |t, tc|
+#   RSpec::Core::RakeTask.new(:spec)
+# end
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/*_spec.rb"
+  t.verbose = false
 end
 
 # Opens code coverage in your browser
@@ -23,8 +29,10 @@ end
 # Generate or update documentation
 # Generates in `doc/`
 RDoc::Task.new do |rdoc|
+  rm_rf "doc/"
   rdoc.rdoc_dir = 'doc/'
-  rdoc.rdoc_files.include("**/*.rb")
+  rdoc.main = "README.md"
+  # rdoc.rdoc_files.include("**/*.rb")
 end
 
 # Opens documentation.

data/bin/brewer

@@ -1,12 +1,10 @@
 #!/usr/bin/env ruby
 require_relative "../lib/brewer"
 
-adaptibrew = Adaptibrew.new.refresh
-com = Communicator.new
-brewer = Brewer.new
-settings = Settings.new
-procedures = Procedures.new
-
+adaptibrew  = Brewer::Adaptibrew.new
+com         = Brewer::Communicator.new
+brewer      = Brewer::Brewer.new
+procedures  = Brewer::Procedures.new
 puts "🍺  have fun 🍺"
-Ripl.start :binding => binding
+binding.pry
 # 🍺🍺🍺

data/bin/brewer-server

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+require 'sinatra/base'
+require "rainbow"
+require 'rack-flash'
+
+require_relative "../lib/gems"
+require_relative "../lib/brewer"
+
+include Brewer
+
+module Brewer
+  class Server < Sinatra::Base
+
+    configure do
+
+      use Rack::Flash
+
+      if ARGV.include? "-p"
+        port = ARGV[ARGV.index("-p") + 1].to_i
+        if port < 1024
+          print Rainbow("Warning: ").yellow
+          puts "The port you selected is less than 1024. This will require sudo."
+          puts "Either use sudo or choose a different port. Sinatra default is 4567."
+          puts ""
+        end
+      else
+        port = 4567
+      end
+
+      # Configuration
+      set :bind, '0.0.0.0'
+      set :port, port
+      set :views, Proc.new { File.join(File.expand_path("..", __dir__), "views") }
+      enable :run
+      enable :sessions
+
+      $brewer = Brewer.new
+    end
+
+    # Routes
+    not_found do
+      erb :not_found
+    end
+
+
+    get '/' do
+      @relays_status = $brewer.relays_status
+      @pid_status = $brewer.pid
+
+      erb :index
+    end
+
+    post '/apply-relay-config' do
+      $brewer.relay_config(params)
+      flash[:config_done] = "Relay Configuration Applied"
+      redirect '/'
+    end
+
+    run!
+  end
+end

data/lib/brewer.rb

@@ -1,14 +1,4 @@
-require "require_all"
-require 'git'
-require 'fileutils'
-require 'slack-notifier'
-require 'yaml'
-require 'yaml/store'
-require 'net/ping'
-require 'ripl'
-require 'wannabe_bool'
-require 'terminal-table'
-require "rainbow"
+require_relative "gems"
 
 require_rel 'brewer/'
 

data/lib/brewer/adaptibrew.rb

@@ -1,45 +1,44 @@
-require_relative "../brewer"
+require_relative "helpers.rb"
 
-# This is the 'manager' for the adaptibrew repo. It handles cloning and such.
-class Adaptibrew
+include Helpers
 
-  def initialize
-    refresh
-  end
+module Brewer
+  class Adaptibrew
 
-  # This will clone adaptibrew into ~/.brewer/adaptibrew/
-  def clone
-    raise "🛑  Cannot clone, no network connection" unless network?
-    if !Dir.exists?(adaptibrew_dir)
-      Git.clone('https://github.com/llamicron/adaptibrew.git', 'adaptibrew', :path => brewer_dir)
+    # This will clone adaptibrew into ~/.brewer/adaptibrew/
+    def clone
+      raise "🛑  Cannot clone, no network connection" unless network?
+      if !Dir.exists?(adaptibrew_dir)
+        Git.clone('https://github.com/llamicron/adaptibrew.git', 'adaptibrew', :path => brewer_dir)
+      end
+      self
     end
-    self
-  end
 
-  # Danger zone...
-  def clear
-    # :nocov: since this requires network to be off
-    if !network?
-      print "Warning: you have no network connection. If you clear, you will not be able to clone again, and you'll be stuck without the adaptibrew source. Are you sure? "
-      confirm ? nil : abort
+    # Danger zone...
+    def clear
+      # :nocov: since this requires network to be off
+      if !network?
+        print "Warning: you have no network connection. If you clear, you will not be able to clone again, and you'll be stuck without the adaptibrew source. Are you sure? "
+        confirm ? nil : abort
+      end
+      # :nocov:
+      FileUtils.rm_rf(adaptibrew_dir)
+      self
     end
-    # :nocov:
-    FileUtils.rm_rf(adaptibrew_dir)
-    self
-  end
 
-   # This is a good catch-all method
-   # If it's not there, it will clone.
-   # If it is, it will delete and re-clone
-  def refresh
-    raise "🛑  Cannot refresh, no network connection" unless network?
-    clear
-    clone
-    self
-  end
+     # This is a good catch-all method
+     # If it's not there, it will clone.
+     # If it is, it will delete and re-clone
+    def refresh
+      raise "🛑  Cannot refresh, no network connection" unless network?
+      clear
+      clone
+      self
+    end
 
-  def present?
-    return Dir.exists?(adaptibrew_dir) ? true : false
-  end
+    def present?
+      return Dir.exists?(adaptibrew_dir) ? true : false
+    end
 
+  end
 end

data/lib/brewer/brewer.rb

@@ -1,141 +1,160 @@
 require_relative "../brewer"
 
-class Brewer
+module Brewer
+  class Brewer
 
-  attr_reader :base_path
-  attr_accessor :temps
+    attr_reader :base_path
+    attr_accessor :temps, :relays
 
-  def initialize
-    @base_path = Dir.home + '/.brewer'
-    Settings.new
-    @temps = {}
-  end
+    def initialize
+      @base_path = Dir.home + '/.brewer'
+      Settings.new
+      @temps = {}
+    end
 
-  public
+    public
 
-  # Brewer methods ------------------------------------------------------
-  # general utilities for the brewer class
+    # Brewer methods ------------------------------------------------------
+    # general utilities for the brewer class
 
-  def wait(time=30)
-    sleep(time.to_f)
-    true
-  end
+    def wait(time=30)
+      sleep(time.to_f)
+      true
+    end
 
-  # Runs an adaptibrew script
-  # Output will be stored in @out
-  # you may see `echo` quite a bit. This will almost always be directly after calling a script
-  # It will be set to the output of the last script. I can't just return the output because i need to return self
-  def script(script, params=nil)
-    `python #{@base_path}/adaptibrew/#{script}.py #{params}`.chomp
-  end
+    # Runs an adaptibrew script
+    # Output will be stored in @out
+    # you may see `echo` quite a bit. This will almost always be directly after calling a script
+    # It will be set to the output of the last script. I can't just return the output because i need to return self
+    def script(script, params=nil)
+      `python #{@base_path}/adaptibrew/#{script}.py #{params}`.chomp
+    end
 
-  # Adaptibrew methods ----------------------------------------------
-  # for working with the rig
 
-  def pump(state="status")
-    if state == "status"
-      return relay_status($settings['pumpRelay'])
-    end
+    # Adaptibrew methods ----------------------------------------------
+    # for working with the rig
+
+    def pump(state="status")
+      if state == "status"
+        return relay_status($settings['pumpRelay'])
+      end
 
-    if state == 1
-      return script("set_pump_on")
-    else
-      if pid['pid_running'].to_b
-        pid(0)
+      if state == 1
+        return script("set_pump_on")
+      else
+        if pid['pid_running'].to_b
+          pid(0)
+        end
+        return script("set_pump_off")
       end
-      return script("set_pump_off")
     end
-  end
 
-  # Turns PID on or off, or gets state if no arg is provided
-  def pid(state="status")
-    if state == "status"
-      return {
-        'pid_running' => script("is_pid_running"),
-        'sv_temp' => sv,
-        'pv_temp' => pv
-      }
+    # Turns PID on or off, or gets state if no arg is provided
+    def pid(state="status")
+      if state == "status"
+        return {
+          'pid_running' => script("is_pid_running"),
+          'sv_temp' => sv,
+          'pv_temp' => pv
+        }
+      end
+
+      if state == 1
+        script('set_pid_on')
+        pump(1)
+        return "Pump and PID are now on"
+      else
+        return script("set_pid_off")
+      end
     end
 
-    if state == 1
-      script('set_pid_on')
-      pump(1)
-      return "Pump and PID are now on"
-    else
-      return script("set_pid_off")
+    def sv(temp=nil)
+      if temp
+        return script('set_sv', temp).to_f
+      end
+      script('get_sv').to_f
     end
-  end
 
-  def sv(temp=nil)
-    if temp
-      return script('set_sv', temp).to_f
+    def pv
+      script('get_pv').to_f
     end
-    script('get_sv').to_f
-  end
 
-  def pv
-    script('get_pv').to_f
-  end
+    def relay(relay, state)
+      # If you try to turn the relay to a state that it is already in, this skips the wait
+      if relay_status(relay).to_b == state.to_b
+        return true
+      end
+      script("set_relay", "#{relay} #{state}")
+      true
+    end
 
-  def relay(relay, state)
-    # If you try to turn the relay to a state that it is already in, this skips the wait
-    if relay_status(relay).to_b == state.to_b
-      return true
+    def all_relays_status
+      output = script("get_relay_status_test").split("\n")
+      output.shift(3)
+      return output
     end
-    script("set_relay", "#{relay} #{state}")
-    wait(10)
-    true
-  end
 
-  def all_relays_status
-    output = script("get_relay_status_test")
-    puts output.split('\n')
-    true
-  end
+    def relays_status
+      statuses = {}
+      all_relays_status.shift(4).each do |status|
+        relay_num, status = status.match(/relay [0-9+]([0-9]+): (on|off)/).captures
+        relay_names = $settings.select { |key, value| key.to_s.match(/Relay/) }
+        statuses[relay_names.key(relay_num.to_i)] = status
+      end
+      return statuses
+    end
 
-  def relay_status(relay)
-    if script("get_relay_status", "#{relay}").include? "on"
-      return "on"
-    else
-      return "off"
+    def relay_config(params)
+      raise "Params must be a hash" unless params.is_a? Hash
+      params.each do |method, setting|
+        if method == "pump"
+          setting = setting.to_i
+        end
+        send(method, setting)
+      end
     end
-  end
 
-  # :nocov:
-  def watch
-    until pv >= sv do
-      wait(2)
+    def relay_status(relay)
+      if script("get_relay_status", "#{relay}").include? "on"
+        return "on"
+      else
+        return "off"
+      end
     end
-    self
-  end
-  # :nocov:
 
-  def rims_to(location)
-    if location == "mash"
-      # we ended up swapping this relay, so the name is backwards
-      relay($settings['rimsToMashRelay'], 0)
-    elsif location == "boil"
-      relay($settings['rimsToMashRelay'], 1)
+    # :nocov:
+    def watch
+      until pv >= sv do
+        wait(2)
+      end
+      Communicator.new.ping("Temperature is now at #{pv.to_f} F")
+      self
+    end
+    # :nocov:
+
+    def rims_to(location)
+      if location == "mash"
+        # we ended up swapping this relay, so the name is backwards
+        relay($settings['rimsToMashRelay'], 0)
+      elsif location == "boil"
+        relay($settings['rimsToMashRelay'], 1)
+      end
+      self
     end
-    self
-  end
 
-  def hlt_to(location)
-    if location == "mash"
-      relay($settings['spargeToMashRelay'], 0)
-    elsif location == "boil"
-      relay($settings['spargeToMashRelay'], 1)
+    def hlt_to(location)
+      if location == "mash"
+        relay($settings['spargeToMashRelay'], 0)
+      elsif location == "boil"
+        relay($settings['spargeToMashRelay'], 1)
+      end
+      self
     end
-    self
-  end
 
-  def hlt(state)
-    if state.to_b
-      relay($settings['spargeRelay'], 1)
-    elsif !state.to_b
-      relay($settings['spargeRelay'], 0)
+    def hlt(state)
+      relay($settings['spargeRelay'], state)
+      self
     end
-    self
-  end
 
+  end
 end