picobrew-api 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fef7a8adfcad93dbe7c7288eafd32ef7af4a3856
+  data.tar.gz: 70567e4d2d24ffd86afd38c57f19ac15a2497245
+SHA512:
+  metadata.gz: a0723f5f3c833c43f0533191f1d5073491d264a1dc76ef7752a7480fbb0bff7fb928c29a545dcef7516e16c4dc686cdaf3aadde27b9fd3cb13aed17ab1e8e2ed
+  data.tar.gz: 06515f97fcd2ae797b3d5e86afc04e223e56f465e70f6bcae3a5f395b425088ddc1dc74df012c03d0e761bbc2d8b29b002dbbd0dd3b8f90a1dde02b12808d2e2

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in picobrew-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Todd Quessenberry
+
+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,51 @@
+# Picobrew::Api
+
+Back in 2013, Picobrew launched a [Kickstarter](https://www.kickstarter.com/projects/1708005089/picobrew-zymatic-the-automatic-beer-brewing-applia/faqs#project_faq_69315) for the Zymatic, and advertised that they'd open source the firmware and provide web APIs.  I haven't seen any indication they plan on following through with that pledge despite many requests from their customers, so this project attempts to begin to fill that void.
+
+The first version of this api provides some simple getters for various data from your Picobrew account - recipes, sessions, logs, notes, etc.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'picobrew-api', :git => 'https://github.com/toddq/picobrew-api.git'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+```ruby
+require 'picobrew/api'
+
+picobrew = Picobrew::Api.new('your-username', 'your-password')
+recipe = picobrew.get_all_recipes().first
+control_program = picobrew.get_recipe_control_program(recipe['GUID'])
+session = picobrew.get_sessions_for_recipe(recipe['GUID']).first
+session_notes = picobrew.get_session_notes(session['id'])
+session_log = picobrew.get_session_log(session['id'])
+```
+
+## Future
+
+* Post notes to session
+* Create/edit recipes
+* Create/edit recipe control programs
+* Document the api
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 `gem build picobrew-api.gemspec` and `gem install ./picobrew-api-{version}.gem`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/toddq/picobrew-api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,273 @@
+require 'json'
+require 'httparty'
+require 'nokogiri'
+
+module Picobrew
+end
+
+class Picobrew::Api
+
+	HOST = 'picobrew.com'
+	include HTTParty
+	base_uri 'https://picobrew.com'
+	# debug_output
+
+    attr_reader :cookies
+
+	def initialize(username, password, cookies = nil)
+		@username = username
+		@password = password
+		@http = Net::HTTP.new(HOST, 443)
+		@http.use_ssl = true
+		@http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        @cached_sessions = []
+
+		log "Created Picobrew object for #{username}"
+        if !cookies.nil?
+            log "Using provided cookies instead of logging in"
+            @cookies = cookie_from_hash(cookies)
+        else
+            login()
+        end
+	end
+
+	def login()
+		log "Logging in"
+		begin
+            options = {
+                :body => {'username' => @username, 'Password' => @password},
+                :headers => {'Content-Type' => 'application/x-www-form-urlencoded; charset=UTF-8'},
+                :follow_redirects => false
+            }
+	        response = self.class.post('/account/loginAjax.cshtml', options)
+            raise "No Set-Cookie in response" if response.get_fields('Set-Cookie').nil?
+	        @cookies = parse_cookie(response)
+        rescue Exception => e
+            raise "Authentication error: #{e}"
+        end
+        log "logged in"
+	end
+
+	def logged_in?()
+		!@cookies.nil?
+	end
+
+	def get_all_recipes()
+		log "Get All Recipes"
+        begin
+        	options = options({:body => {'option' => 'getAllRecipesForUser'}})
+        	response = self.class.post('/JSONAPI/Zymatic/ZymaticRecipe.cshtml', options)
+        	body = JSON.parse(response.body)
+        rescue Exception => e
+        	log "Error: #{e}"
+        end
+	end
+
+    def get_recipe(recipe_id)
+        log "Scrape Recipe #{recipe_id}"
+        begin
+            options = options({})
+            response = self.class.get("/Members/Recipes/ParseRecipe.cshtml?id=#{recipe_id}", options)
+            page = Nokogiri::HTML(response.body)
+            recipe = {'specs' => {}}
+            page.css('#user-specs-table tr').each do |element|
+                recipe['specs'][element.css('td')[0].text] = element.css('td')[1].text
+            end
+            page.css('#editForm input').each do |element|
+                if is_json? element['value']
+                    recipe[element['name']] = JSON.parse(element['value'])
+                else
+                    recipe[element['name']] = element['value']
+                end
+            end
+            recipe
+        rescue Exception => e
+            log "Error: #{e}"
+        end
+    end
+
+    def get_recipe_control_program(recipe_id)
+        log "Scrape Recipe Advanced Editor"
+        begin
+            options = options({})
+            response = self.class.get("/members/recipes/editctlprogram?id=#{recipe_id}", options)
+            page = Nokogiri::HTML(response.body)
+            program = {'steps' => []}
+            page.css('#stepTable tr').each do |row|
+                next if row.at_css('input').nil?
+
+                step = {
+                    'index' => row.at_css('input')['data-index'].to_i,
+                    'name' => row.at_css('input[name*=Name]')['value'],
+                    'location' => row.at_css('select option[@selected=selected]').text,
+                    'targetTemp' => row.at_css('input[name*=Temp]')['value'].to_i,
+                    'time' => row.at_css('input[name*=Time]')['value'].to_i,
+                    'drain' => row.at_css('input[name*=Drain]')['value'].to_i
+                }
+
+                program['steps'].push(step) if !step['name'].nil?
+            end
+            program
+        rescue Exception => e
+            log "Error: #{e}"
+        end
+    end
+
+    def get_sessions_for_recipe(recipe_id)
+        log "Get Sessions for Recipe #{recipe_id}"
+        begin
+            options = options({})
+            response = self.class.get("/Members/Logs/brewingsessions.cshtml?id=#{recipe_id}", options)
+            page = Nokogiri::HTML(response.body)
+            sessions = []
+            page.css('#BrewingSessions tbody tr').each do |row|
+                sessions.push({
+                    'name' => row.css('td.name').text,
+                    'id' => row.css('td.name a')[0]['href'].gsub(/.*id=/, ''),
+                    'date' => row.css('td.date').text,
+                    'notes' => row.css('td')[3].text
+                } )
+            end
+            sessions
+        rescue Exception => e
+            log "Error: #{e}"
+        end
+    end
+
+    def get_all_sessions()
+        log "Get All Sessions"
+        begin
+            options = options({:body => {'option' => 'getAllSessionsForUser'}})
+            response = self.class.post('/JSONAPI/Zymatic/ZymaticSession.cshtml', options)
+            body = JSON.parse(response.body)
+        rescue Exception => e
+            log "Error: #{e}"
+        end
+    end
+
+	def get_session_log(session_id)
+		log "Get Session Log for #{session_id}"
+        # the sessions list contains references for guids, but the log api
+        # wants a *different* id, so need to lookup one from the other
+        if session_id.length > 6
+            session_id = get_short_session_id_for_guid(session_id)
+            raise Exception "No short session id for guid" if session_id.nil?
+            log "Get Session Log for #{session_id}"
+        end
+		begin
+			options = options({:body => {'option' => 'getSessionLogs', 'sessionID' => session_id}})
+			response = self.class.post('/JSONAPI/Zymatic/ZymaticSession.cshtml', options)
+			body = JSON.parse(response.body)
+		rescue Exception => e
+			log "Error: #{e}"
+		end
+	end
+
+    def get_session_notes(session_id)
+        log "Get Session Notes for #{session_id}"
+        if session_id.length > 6
+            session_id = get_short_session_id_for_guid(session_id)
+            raise Exception, "No short session id for guid" if session_id.nil?
+            log "Get Session Notes for #{session_id}"
+        end
+        begin
+            options = options({ :body => {'option' => 'getSessionNotes', 'sessionID' => session_id} })
+            response = self.class.post('/JSONAPI/Zymatic/ZymaticSession.cshtml', options)
+            body = JSON.parse(response.body)
+        rescue Exception => e
+            log "Error: #{e}"
+        end
+    end
+
+	def get_recipe_id_for_session_id(session_guid)
+		session = find_session(session_guid)
+		return session['RecipeGUID'] if !session.nil?
+	end
+
+    def get_short_session_id_for_guid(session_guid)
+		session = find_session(session_guid)
+        return session['ID'] if !session.nil?
+    end
+
+	def find_session(session_guid)
+        log "Looking up short session id for #{session_guid}"
+        # quick and dirty cache expiration
+        cache_sessions if @cached_sessions.empty? || @cached_at.to_i + 5 * 60 < Time.now.to_i
+        return @cached_sessions.find {|session| session['GUID'] == session_guid}
+	end
+
+    def cache_sessions()
+        log "Caching sesions"
+        @cached_sessions = get_all_sessions()
+        @cached_at = Time.now
+    end
+
+	def get_active_session()
+        log "Get Active Session"
+        begin
+        	options = options({:body => {'option' => 'getZymaticsForUser', 'getActiveSession' => 'true'}})
+        	response = self.class.post('/JSONAPI/Zymatic/ZymaticSession.cshtml', options)
+			# TOOD: return json
+            response.body
+        rescue Exception => e
+        	log "Error: #{e}"
+        end
+	end
+
+    # don't really understand this one, not sure if id is required
+    def check_active(session_id)
+        log "Check if session is active: #{session_id}"
+        begin
+            options = options({:body => {'option' => 'checkActive', 'sessionId' => session_id}})
+            response = self.class.post('/JSONAPI/Zymatic/ZymaticSession.cshtml', options)
+            response.body
+        rescue Exception => e
+            log "Error: #{e}"
+        end
+    end
+
+    # API used by Zymatic hardware
+    # Does not require auth, but require user id and machine id
+    # Move this to a separate class?
+    def get_recipe_control_programs(user_id, machine_id)
+        log "Get Recipe Control Programs"
+        begin
+            response = self.class.get("/API/SyncUser?user=#{user_id}&machine=#{machine_id}")
+            response.body
+        rescue Exception => e
+            log "Error: #{e}"
+        end
+    end
+
+    def is_json?(json)
+        begin
+            JSON.parse(json)
+            return true
+        rescue JSON::ParserError
+            return false
+        end
+    end
+
+    def options(params)
+        { :headers => {
+            'Content-Type' => 'application/x-www-form-urlencoded',
+            'Cookie' => @cookies.to_cookie_string }
+        }.merge params
+    end
+
+	def parse_cookie(resp)
+	    cookie_hash = CookieHash.new
+	    resp.get_fields('Set-Cookie').each { |c| cookie_hash.add_cookies(c) }
+	    cookie_hash
+	end
+
+    def cookie_from_hash(hsh)
+        cookie_hash = CookieHash.new
+        cookie_hash.add_cookies(hsh)
+        cookie_hash
+    end
+
+    def log(msg)
+    	# puts msg
+    end
+end

data/picobrew-api.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "picobrew-api"
+  spec.version       = "0.1.2"
+  spec.authors       = ["Todd Quessenberry"]
+  spec.email         = ["todd@quessenberry.com"]
+
+  spec.summary       = %q{Provides a library to access your Picobrew data}
+  spec.homepage      = "https://github.com/toddq/picobrew-api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency "httparty", "~> 0.15"
+  spec.add_runtime_dependency "nokogiri", "~> 1.8"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: picobrew-api
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Todd Quessenberry
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: 
+email:
+- todd@quessenberry.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/picobrew/api.rb
+- picobrew-api.gemspec
+homepage: https://github.com/toddq/picobrew-api
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Provides a library to access your Picobrew data
+test_files: []