milk_maid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60b61c742362d8e47611594ae8d749eb21c0e196
+  data.tar.gz: e30619de06cb423bfb20929b45b6e39a2d45086d
+SHA512:
+  metadata.gz: fc59278709740c167a7e3167586b02b5d2829ae33f92f3699dc1d897b23363a47bec834e7cb2c9002c7a2811c98873b46a8c57224c3c6c72c3572c2d7f351cd5
+  data.tar.gz: 9ee3ce7b156b4902cd29abd5ca0327571666f3256619ae9cfd3b68af6087643ed850e6d6f39655013e225a5ec92e68bb163ad9fbd3ea6b3cd6bb5c9aaa4bb362

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.yml

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.2.1

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.5

data/Gemfile

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

data/README.md

@@ -0,0 +1,36 @@
+# Milkmaid
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/milkmaid`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'milkmaid'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install milkmaid
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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/[USERNAME]/milkmaid.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

data/bin/milkmaid

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'milkmaid'
+
+Milkmaid::CLI.start( ARGV )

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/firebase.yml.sample

@@ -0,0 +1 @@
+firebase_url: 'YOUR FIREBASE URL'

data/lib/milkmaid/batch.rb

@@ -0,0 +1,51 @@
+module Milkmaid
+  class Batch
+    attr_accessor :name, :batch_guid, :temperature, :duration, :size, :notifier, :sensor
+
+    NAP_TIME = 5
+
+    def initialize(options = {})
+      options.each { |key, value| send("#{key}=", value) }
+
+      @batch_guid = generate_guid
+    end
+
+    def compare_temperature(current_temperature)
+      notifier.log_temperature(current_temperature)
+      current_temperature.to_i >= temperature.to_i
+    end
+
+    def start
+      notifier.batch_started(name: name, guid: batch_guid, duration: duration, base_temperature: temperature, batch_size: size)
+
+      until compare_temperature(sensor.reading)
+        take_a_nap
+      end
+
+      ending_time = Time.now + duration
+
+      notifier.temperature_reached
+
+      until Time.now > ending_time
+        current_temp = sensor.reading
+        notifier.log_temperature(current_temp)
+
+        notifier.post_warning(current_temp, temperature) if current_temp < temperature
+
+        take_a_nap
+      end
+
+      notifier.batch_completed
+    end
+
+  private
+
+    def generate_guid
+      ::SecureRandom.uuid
+    end
+
+    def take_a_nap
+      sleep NAP_TIME
+    end
+  end
+end

data/lib/milkmaid/cli.rb

@@ -0,0 +1,48 @@
+require 'thor'
+
+module Milkmaid
+  class CLI < Thor
+    desc 'monitor_batch BATCH_NAME', "Start Monitoring a batch"
+    long_desc <<-DESC
+
+    `monitor_batch BATCH_NAME` will create a batch called BATCH_NAME
+    and begin monitoring it for 30 minutes
+
+    DESC
+    option :batch_name, :type => :string, :required => :true, :aliases => "-b"
+    option :temperature, :type => :numeric, :required => :false, :default => 30, :aliases => '-t'
+    option :duration, :type => :numeric, :required => false, :default => 30, :aliases => '-d'
+    option :logger, :type => :string, :required => false, :default => 'Console', :aliases => '-l'
+    option :sensor, :type => :boolean, :required => false, :default => true, :aliases => '-s'
+    def monitor_batch
+      batch_name = options[:batch_name]
+      temperature = options[:temperature].to_i
+      duration = options[:duration].to_i
+      logger_type = options[:logger]
+      sensor_type = options[:sensor]
+
+      sensor = get_sensor(sensor_type)
+      notifier = get_logger(logger_type)
+      batch = ::Milkmaid::Batch.new(name: batch_name, temperature: temperature, duration: duration, notifier: notifier, sensor: sensor)
+
+      batch.start
+    rescue ::Milkmaid::SensorException => e
+      puts e.message
+    end
+
+    no_commands do
+      def get_sensor(sensor_type)
+        sensor_type ? ::Milkmaid::TemperatureSensor.new : ::Milkmaid::MockTemperatureSensor.new(options[:temperature].to_i - 20, options[:temperature].to_i + 30)
+      end
+
+      def get_logger(logger_type)
+        case logger_type.upcase
+        when 'CONSOLE'
+          ::Milkmaid::ConsoleNotifier.new
+        when 'WEB'
+          ::Milkmaid::ParseNotifier.new
+        end
+      end
+    end
+  end
+end

data/lib/milkmaid/console_notifier.rb

@@ -0,0 +1,23 @@
+module Milkmaid
+  class ConsoleNotifier
+    def batch_completed
+      puts "#{Time.now} - Batch Completed"
+    end
+
+    def batch_started(_)
+      puts "#{Time.now} - Batch Started"
+    end
+
+    def log_temperature(temperature)
+      puts "#{Time.now} - Temperature reading: #{temperature}"
+    end
+
+    def post_warning(current_temperature, base_temperature)
+      puts "#{Time.now} - WARNING: Current Temperature: #{current_temperature} Base Temperature: #{base_temperature}"
+    end
+
+    def temperature_reached
+      puts "#{Time.now} - Temperature reached!"
+    end
+  end
+end

data/lib/milkmaid/firebase_notifier/batch_record.rb

@@ -0,0 +1,78 @@
+require 'firebase'
+require 'yaml'
+
+module Milkmaid
+  module FirebaseNotifier
+    class BatchRecord
+      attr_accessor :name, :guid, :duration, :base_temperature, :batch_size, :status, :record
+
+      CACHE_THRESHOLD = 20
+
+      def initialize
+        @firebase = ::Firebase::Client.new(::YAML.load_file(File.join(CONFIG_DIR, 'firebase.yml'))['firebase_url'])
+      end
+
+      def start(batch_data = {})
+        batch_data.each { |key, value| send("#{key}=", value) }
+        @status = 'Started'
+
+        self.create_remote_record
+      end
+
+      def create_remote_record
+        @response = @firebase.push("batches", {
+          :guid => guid,
+          :name => name,
+          :duration => duration,
+          :base_temperature => base_temperature,
+          :batch_size => batch_size,
+          :status => status
+        })
+      end
+
+      def add_event(event_type, data = 0)
+        events << ::Milkmaid::FirebaseNotifier::Event.new(event_name_from_type(event_type), data, timestamp)
+        return if cache_event(event_type)
+        send_events!
+      end
+
+      def cache_event(event_type)
+        return false unless event_type == :temperature
+        return false if @events.length < CACHE_THRESHOLD
+        true
+      end
+
+      def close_batch
+        @firebase.update("/batches/#{guid}", :status => 'Completed')
+      end
+
+      def complete!
+        add_event(:batch_completed)
+        close_batch
+      end
+
+      def event_name_from_type(event)
+        event.to_s.split(/_/).map(&:capitalize).join(' ')
+      end
+
+      def events
+        @events ||= []
+      end
+
+      def send_events!
+        events.each do |event|
+          @firebase.push("/batches/#{guid}/events", event.to_h)
+        end
+
+        @events = []
+      end
+
+      def timestamp
+        Time.now
+      end
+    end
+
+    class Event < Struct.new(:name, :data, :timestamp)
+    end
+  end
+end

data/lib/milkmaid/firebase_notifier.rb

@@ -0,0 +1,31 @@
+module Milkmaid
+  class FirebaseNotifier < ::Milkmaid::ConsoleNotifier
+    attr_accessor :batch_record
+
+    def batch_completed
+      super
+      batch_record.complete!
+    end
+
+    def batch_started(batch_data = {})
+      super(batch_data)
+      batch_record = ::Milkmaid::FirebaseNotifier::BatchRecord.new(batch_data)
+    end
+
+    def log_temperature(temperature)
+      super(temperature)
+      batch_record.add_event(:temperature, temperature)
+    end
+
+    def post_warning(current_temperature, base_temperature)
+      super(current_temperature, base_temperature)
+      batch_record.add_event(:temperature_warning, current_temperature)
+    end
+
+    def temperature_reached
+      super
+      batch_record.add_event(:threshold_reached)
+    end
+
+  end
+end

data/lib/milkmaid/parse_notifier.rb

@@ -0,0 +1,34 @@
+module Milkmaid
+  class ParseNotifier < ::Milkmaid::ConsoleNotifier
+    attr_accessor :batch_record
+
+    def batch_completed
+      super
+      batch_record.complete!
+    end
+
+    def batch_record
+      @batch_record ||= ::Milkmaid::FirebaseNotifier::BatchRecord.new
+    end
+
+    def batch_started(batch_data = {})
+      super(batch_data)
+      batch_record.start(batch_data)
+    end
+
+    def log_temperature(temperature)
+      super(temperature)
+      batch_record.add_event(:temperature, temperature)
+    end
+
+    def post_warning(current_temperature, base_temperature)
+      super(current_temperature, base_temperature)
+      batch_record.add_event(:temperature_warning, current_temperature)
+    end
+
+    def temperature_reached
+      super
+      batch_record.add_event(:threshold_reached)
+    end
+  end
+end

data/lib/milkmaid/remote_notifier/batch_record.rb

@@ -0,0 +1,80 @@
+require 'parse-ruby-client'
+
+module Milkmaid
+  module RemoteNotifier
+    class BatchRecord
+      attr_accessor :name, :guid, :duration, :base_temperature, :batch_size, :status, :record
+
+      def initialize
+        Parse.init(
+          :application_id => 'JxuqdmEaI0DYwxcDV1imv2S64PWMLNjJq3wpGcVC',
+          :api_key => 'dsEh8Uqc3gwT9kYcG6OvR9W6pRlzcZlG6X9NeClS'
+        )
+      end
+
+      def start(batch_data = {})
+        batch_data.each { |key, value| send("#{key}=", value) }
+        @status = 'Started'
+        self.create_remote_record
+      end
+
+      def create_remote_record
+        @record = ::Parse::Object.new('BatchRecords')
+        @record[:name] = name
+        @record[:guid] = guid
+        @record[:duration] = duration
+        @record[:base_temperature] = base_temperature
+        @record[:batch_size] = batch_size
+        @record[:status] = status
+
+        @record.save
+      end
+
+      def add_event(event_type, data = 0)
+        events << ::Milkmaid::RemoteNotifier::Event.new(name: event_name_from_type(event_type), data: data, timestamp: timestamp)
+        return if event_type == :temperature
+        send_events!
+      end
+
+      def close_batch
+        @record[:status] = 'Completed'
+        @record.save
+      end
+
+      def complete!
+        add_event(:batch_completed)
+        close_batch
+      end
+
+      def event_name_from_type(event)
+        event.to_s.split(/_/).map(&:capitalize).join(' ')
+      end
+
+      def events
+        @events ||= []
+      end
+
+      def send_events!
+        events.each do |event|
+          event.save
+          @record.array_add_relation("BatchRecordEvents", event.pointer)
+          @record.save
+        end
+
+      end
+
+      def timestamp
+        Time.now
+      end
+    end
+
+    class Event < ::Parse::Object
+      def initialize(params = {})
+        super('Events')
+        self[:name] = params.fetch(:name)
+        self[:data] = params.fetch(:data)
+        self[:timestamp] = params.fetch(:timestamp)
+      end
+    end
+  end
+end

data/lib/milkmaid/temperature_sensor.rb

@@ -0,0 +1,38 @@
+require 'w1temp'
+
+module Milkmaid
+  class SensorException < RuntimeError; end
+
+  class TemperatureSensor
+    def initialize
+      @sensor = Temperature.new
+
+      fail ::Milkmaid::SensorException.new 'Sensor not available' unless @sensor.name
+    end
+
+    def name
+      return "No sensor attached" unless @sensor.display
+      @sensor.name
+    end
+
+    def reading
+      return "Reading: No sensor attached" unless @sensor.display
+      @sensor.reading
+    end
+  end
+
+  class MockTemperatureSensor
+    def initialize(low_temp, high_temp)
+      @low_temp = low_temp.to_i
+      @high_temp = high_temp.to_i
+    end
+
+    def name
+      'MockTemperatureSensor'
+    end
+
+    def reading
+      rand(@low_temp..@high_temp)
+    end
+  end
+end

data/lib/milkmaid/version.rb

@@ -0,0 +1,3 @@
+module Milkmaid
+  VERSION = "0.1.0"
+end

data/lib/milkmaid.rb

@@ -0,0 +1,13 @@
+require 'milkmaid/batch'
+require 'milkmaid/cli'
+require 'milkmaid/console_notifier'
+require 'milkmaid/parse_notifier'
+require 'milkmaid/remote_notifier/batch_record'
+require 'milkmaid/firebase_notifier/batch_record'
+require 'milkmaid/temperature_sensor'
+require 'milkmaid/version'
+
+CONFIG_DIR = File.join(File.dirname(__FILE__), '..', 'config')
+
+module Milkmaid
+end

data/milkmaid.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'milkmaid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "milk_maid"
+  spec.version       = Milkmaid::VERSION
+  spec.authors       = ["Steve Newell"]
+  spec.email         = ["steve.newell@mx.com"]
+
+  spec.summary       = %q{Reads data from Raspberry PI sensor and posts to Firebase}
+  spec.description   = %q{Reads data from Raspberry PI sensor and posts to Firebase}
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor"
+  spec.add_runtime_dependency "w1temp"
+  spec.add_runtime_dependency "parse-ruby-client"
+  spec.add_runtime_dependency "firebase"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard-rspec"
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: milk_maid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steve Newell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: w1temp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: parse-ruby-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: firebase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: 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: guard-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: Reads data from Raspberry PI sensor and posts to Firebase
+email:
+- steve.newell@mx.com
+executables:
+- console
+- milkmaid
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/milkmaid
+- bin/setup
+- config/firebase.yml.sample
+- lib/milkmaid.rb
+- lib/milkmaid/batch.rb
+- lib/milkmaid/cli.rb
+- lib/milkmaid/console_notifier.rb
+- lib/milkmaid/firebase_notifier.rb
+- lib/milkmaid/firebase_notifier/batch_record.rb
+- lib/milkmaid/parse_notifier.rb
+- lib/milkmaid/remote_notifier/batch_record.rb
+- lib/milkmaid/temperature_sensor.rb
+- lib/milkmaid/version.rb
+- milkmaid.gemspec
+homepage: 
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Reads data from Raspberry PI sensor and posts to Firebase
+test_files: []