kinokero 0.0.5

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/console/.ruby-gemset

@@ -0,0 +1 @@
+twiga_console

data/console/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p247

data/console/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+ruby "2.0.0"
+
+gem 'kinokero', :git => "git://github.com/dsaronin/kinokero.git"
+gem 'cups'

data/console/Gemfile.lock

@@ -0,0 +1,63 @@
+GIT
+  remote: git://github.com/dsaronin/kinokero.git
+  revision: b5c815573cdf04d8923d0c53d9134893a5bd7495
+  specs:
+    kinokero (0.0.5)
+      activesupport
+      beefcake
+      faraday
+      faraday-cookie_jar
+      faraday_middleware
+      json
+      logger
+      simple_oauth
+      typhoeus
+      xmpp4r
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.4)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    beefcake (0.5.0)
+    cups (0.1.9)
+    domain_name (0.5.19)
+      unf (>= 0.0.5, < 1.0.0)
+    ethon (0.7.1)
+      ffi (>= 1.3.0)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    faraday-cookie_jar (0.0.6)
+      faraday (>= 0.7.4)
+      http-cookie (~> 1.0.0)
+    faraday_middleware (0.9.1)
+      faraday (>= 0.7.4, < 0.10)
+    ffi (1.9.3)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    i18n (0.6.11)
+    json (1.8.1)
+    logger (1.2.8)
+    minitest (5.4.0)
+    multipart-post (2.0.0)
+    simple_oauth (0.2.0)
+    thread_safe (0.3.4)
+    typhoeus (0.6.9)
+      ethon (>= 0.7.1)
+    tzinfo (1.2.1)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.6)
+    xmpp4r (0.5.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cups
+  kinokero!

data/console/README.md

@@ -0,0 +1,34 @@
+kinokero
+========
+
+faraday-based http client for interacting with Google CloudPrint & other
+
+# Kinokero
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kinokero'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kinokero
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/console/config/application_configuration.rb

@@ -0,0 +1,39 @@
+# ****************************************************************************
+# *******    general configuration for console appliance    ********************
+# ****************************************************************************
+
+# ****************************************************************************
+
+# ****************************************************************************
+    # Twiga module common methods invoked here
+  load File.expand_path('../../lib/appliance_common.rb', __FILE__)
+
+# #########################################################################
+
+module Twiga
+
+# #########################################################################
+# ****************************************************************************
+require 'rubygems'
+require "kinokero"
+require 'json'
+
+# ****************************************************************************
+# ******  mimic the way RAILS sets up required gems  *************************
+# Set up gems listed in the Gemfile.
+# ****************************************************************************
+# puts File.expand_path('../../Gemfile', __FILE__)
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+
+# ****************************************************************************
+# ****************************************************************************
+# ****************************************************************************
+
+# -----------------------------------------------------------------------------
+
+# ****************************************************************************
+# ****************************************************************************
+# ****************************************************************************
+# #########################################################################
+end  # module Twiga

data/console/config/gcp_seed.yml

@@ -0,0 +1,73 @@
+---
+test:
+  printer_id: 0
+  item: test
+  cups_alias: laserjet_1102w
+  is_active: true
+  virgin_access: false
+  gcp_xmpp_jid: 345e29425516857a8c70581f58a180c7@cloudprint.googleusercontent.com
+  gcp_confirmation_url: https://www.google.com/cloudprint/regconfirmpage?printername=gcp_test_printer&email=dsanderson77@gmail.com&dpi=300&pagesize=215900,279400
+  gcp_owner_email: dsanderson77@gmail.com
+  gcp_printer_name: gcp_test_printer
+  gcp_printerid: d0510370-f36b-356f-1a82-f93c0756a5d9
+  gcp_access_token: ya29.dQBJZ59OXnON3x4AAADdeIzdkmsmnD_wwnboRXHXFJWrRmnaASlV8VoJurmBig
+  gcp_refresh_token: 1/MPXAGbW_0AkF5eSFtc96PesWp68lFnOz-HUSUd5aU_w
+  gcp_token_type: Bearer
+  gcp_token_expiry_time: 2014-09-03 17:22:54.101172269 -07:00
+  capability_ppd: /etc/cups/ppd/laserjet_1102w.ppd
+  capability_cdd: /etc/cups/cdd/laserjet_1102w.cdd
+  gcp_uuid: VND3R11877
+  gcp_manufacturer: Hewlett-Packard
+  gcp_model: LaserJet P1102w
+  gcp_setup_url: http://www8.hp.com/us/en/campaigns/wireless-printing-center/printer-setup-help.html
+  gcp_support_url: http://h10025.www1.hp.com/ewfrf/wc/product?product=4110396&lc=en&cc=us&dlc=en&lang=en&cc=us
+  gcp_update_url: http://h10025.www1.hp.com/ewfrf/wc/product?product=4110396&lc=en&cc=us&dlc=en&lang=en&cc=us
+  gcp_firmware: '20130703'
+wild:
+  gcp_xmpp_jid: 9bd529179dfa665930799067d4016e9e@cloudprint.googleusercontent.com
+  gcp_confirmation_url: https://www.google.com/cloudprint/regconfirmpage?printername=gcp_wild_printer&email=conjugalis@gmail.com&dpi=300&pagesize=215900,279400
+  gcp_owner_email: conjugalis@gmail.com
+  gcp_printer_name: gcp_wild_printer
+  gcp_printerid: 94f42964-2269-fdeb-99af-4ed1bd3f07fe
+  gcp_access_token: ya29.hABKAR8kZeUq4vbgUgxV_xv3oXY-cc-FRkZvTvrf5H3fGuklzY6h8s29
+  gcp_refresh_token: 1/JDe8Y-rjbxRDzswmLEDuh8CJdnQ40Q10QhRyNWhyHn0
+  gcp_token_type: Bearer
+  gcp_token_expiry_time: 2014-09-17 19:11:40.886171387 -07:00
+  is_active: false
+  virgin_access: true
+  printer_id: 0
+  item: wild
+  cups_alias: laserjet_1102w
+  capability_ppd: /etc/cups/ppd/laserjet_1102w.ppd
+  capability_cdd: /etc/cups/cdd/laserjet_1102w.cdd
+  gcp_uuid: VND3R11877
+  gcp_manufacturer: Hewlett-Packard
+  gcp_model: LaserJet P1102w
+  gcp_setup_url: http://www8.hp.com/us/en/campaigns/wireless-printing-center/printer-setup-help.html
+  gcp_support_url: http://h10025.www1.hp.com/ewfrf/wc/product?product=4110396&lc=en&cc=us&dlc=en&lang=en&cc=us
+  gcp_update_url: http://h10025.www1.hp.com/ewfrf/wc/product?product=4110396&lc=en&cc=us&dlc=en&lang=en&cc=us
+  gcp_firmware: '20130703'
+lime:
+  gcp_xmpp_jid: 3e0163e6a4802ba77c29d73410aad929@cloudprint.googleusercontent.com
+  gcp_confirmation_url: https://www.google.com/cloudprint/regconfirmpage?printername=gcp_lime_printer&email=dsanderson77@gmail.com&dpi=300&pagesize=215900,279400
+  gcp_owner_email: dsanderson77@gmail.com
+  gcp_printer_name: gcp_lime_printer
+  gcp_printerid: 8231517c-716d-4b0a-f721-83fdbe52a05d
+  gcp_access_token: ya29.UgA-fXhCHp0ZiR0AAADbQqXfRA-ks9CK2POGZA8yYF2a1vhEQa4G4_QSltFK_g
+  gcp_refresh_token: 1/NjwUJyyrebUIXsvl1mvqDmKCr-VtZfYR3pPusRPkLH0
+  gcp_token_type: Bearer
+  gcp_token_expiry_time: 2014-07-30 10:27:22.592090444 -07:00
+  is_active: false
+  virgin_access: false
+  printer_id: 0
+  item: lime
+  cups_alias: laserjet_1102w
+  capability_ppd: /etc/cups/ppd/laserjet_1102w.ppd
+  capability_cdd: /etc/cups/cdd/laserjet_1102w.cdd
+  gcp_uuid: VND3R11877
+  gcp_manufacturer: Hewlett-Packard
+  gcp_model: LaserJet P1102w
+  gcp_setup_url: http://www8.hp.com/us/en/campaigns/wireless-printing-center/printer-setup-help.html
+  gcp_support_url: http://h10025.www1.hp.com/ewfrf/wc/product?product=4110396&lc=en&cc=us&dlc=en&lang=en&cc=us
+  gcp_update_url: http://h10025.www1.hp.com/ewfrf/wc/product?product=4110396&lc=en&cc=us&dlc=en&lang=en&cc=us
+  gcp_firmware: '20130703'

data/console/config/kinokero_initializer_template.rb

@@ -0,0 +1,108 @@
+# OPTIONAL: Use this as a template for changing kinokero configuration
+# put it in your config/initializers directory and rename to 
+# kinokero.rb
+# values shown below are the defaults in kinokero
+# if for some reason you wish to respecify these defaults, precede the
+# default name with "Kinokero::", such as the example for my_proxy_id
+#
+Kinokero.setup do |config|
+
+# ---------------------------------------------------------------------
+#  class Proxy required
+# ---------------------------------------------------------------------
+
+# two verbose settings are needed: one for Proxy instances and the 
+# other for any class-level decisions; the one below is class-level
+   config.verbose             =  false  
+
+# unique name for this running of the GCP connector client
+#   config.my_proxy_id         =  Kinokero::MY_PROXY_ID
+
+# picks up your registered Google API client id from environment
+#   config.proxy_client_id     =  ENV["GCP_PROXY_CLIENT_ID"]
+
+# picks up your registered Google API client secret from environment
+#   config.proxy_client_secret =  ENV["GCP_PROXY_CLIENT_SECRET"]
+
+# picks up a unique serial number for this proxy (future expansion)
+#   config.proxy_serial_nbr    =  ENV["GCP_PROXY_SERIAL_NBR"]
+
+# ---------------------------------------------------------------------
+#  class Cloudprint required
+# ---------------------------------------------------------------------
+
+# how to encoade oauth files
+#   config.mimetype_oauth  = MIMETYPE_OAUTH 
+
+# how to encode PPD files
+#   config.mimetype_ppd  =   MIMETYPE_PPD   
+
+# how to encode CDD files
+#   config.mimetype_cdd  =   MIMETYPE_CDD   
+
+# secs to sleep before register polling again
+#   config.polling_secs  =   POLLING_SECS   
+
+# number of characters to truncate response logs 
+#   config.truncate_log  =   TRUNCATE_LOG   
+
+# cloudprint registration main URL
+#   config.followup_host =   FOLLOWUP_HOST  #
+
+# GCP constant
+#   config.followup_uri  =   FOLLOWUP_URI   #
+
+# Google primary URI
+#   config.gaia_host  =      GAIA_HOST      #
+
+# user-based OAUTH2 access (future expansion)
+#   config.login_uri  =      LOGIN_URI      #
+
+# GCPS primary URL
+#   config.gcp_url  =        GCP_URL        #
+
+# GCPS service point
+#   config.gcp_service  =    GCP_SERVICE    #
+
+# full pathname of SSL certificates path for this machine
+#   config.ssl_ca_path  =    SSL_CERT_PATH
+
+
+# GCP documentation constants
+#   config.authorization_scope  =        AUTHORIZATION_SCOPE         #
+#   config.authorization_redirect_uri  = AUTHORIZATION_REDIRECT_URI  #
+
+# Google OAUTH2 token handling endpint URL
+#   config.oauth2_token_endpoint  =      OAUTH2_TOKEN_ENDPOINT       #
+
+
+# ---------------------------------------------------------------------
+#  class Jingle required
+# ---------------------------------------------------------------------
+
+# Google jingle (XMPP) server domain
+#   config.xmpp_server  =     XMPP_SERVER     #  
+
+# Jingle extension for google push stanzas
+#   config.ns_google_push  =  NS_GOOGLE_PUSH  #  
+
+# Jingle cloudprint channel domain
+#   config.gcp_channel  =     GCP_CHANNEL     #  
+
+# ---------------------------------------------------------------------
+#  cups testpage file path
+# ---------------------------------------------------------------------
+
+# pathname location of a printable testfile on local machine
+#   config.cups_testpage_file = CUPS_TESTPAGE_FILE
+
+# ---------------------------------------------------------------------
+#  printer device/cups related
+# ---------------------------------------------------------------------
+
+# number of seconds to wait before polling printer status
+#   config.printer_poll_cycle = PRINTER_POLL_CYCLE
+
+
+
+end  # Kinokero setup

data/console/console

@@ -0,0 +1,2 @@
+#!/bin/bash
+bundle exec "`pwd`/twiga.rb -m"

data/console/irb_console

@@ -0,0 +1,2 @@
+#!/bin/bash
+bundle exec irb -r "`pwd`/twiga.rb -m"

data/console/lib/appliance_common.rb

@@ -0,0 +1,73 @@
+# ****************************************************************************
+# *******    common methods for twiga appliance    ********************
+# ****************************************************************************
+module Twiga
+# **************************************************************************
+
+  @@env = nil
+
+# -----------------------------------------------------------------------------
+  def self.say_info(msg)
+    print "\e[1;34m" + msg + "\e[0m"
+  end
+# -----------------------------------------------------------------------------
+  def self.say_warn(msg)
+    print "\e[1;33m" + msg + "\e[0m"
+  end
+# -----------------------------------------------------------------------------
+  def self.say_err(msg)
+    print "\e[1;31m" + msg + "\e[0m"
+  end
+# -----------------------------------------------------------------------------
+
+# -----------------------------------------------------------------------------
+# env= -- sets the environment for appliance
+  # raises ArgumentError exception if invalid
+# -----------------------------------------------------------------------------
+  def self.env=( new_env )
+
+    if %w(development production test staging).include?( new_env )
+      @@env = new_env   # ok to set environment
+    else
+      raise ArgumentError, "Unrecognized environment: #{new_env}"
+    end  # environment validation check
+
+    return @@env
+
+  end
+
+# -----------------------------------------------------------------------------
+# set_environment! -- initializes and sets environment variable
+  # tries to get from environment variable if missing
+  # else defaults to 'development'
+# -----------------------------------------------------------------------------
+  def self.set_environment!
+    env= ( ENV[ 'TWIGA_ENV' ] || 'development' )
+  end
+
+  def self.env
+    @@env || set_environment!
+  end
+
+  def self.env_is_production?
+    @@env == 'production'
+  end
+
+  def self.env_is_test?
+    @@env == 'test'
+  end
+
+  def self.env_is_staging?
+    @@env == 'staging'
+  end
+
+  def self.env_is_development?
+    @@env == 'development'
+  end
+
+
+
+# ****************************************************************************
+# ****************************************************************************
+# ****************************************************************************
+end  # module Twiga

data/console/twiga.rb

@@ -0,0 +1,579 @@
+#!/usr/bin/env ruby
+
+# ****************************************************************************
+# *****  app configured, initialized, and ruby-prepped here   ****************
+# ****************************************************************************
+
+puts "\nTwiga configuration; running ruby #{ RUBY_VERSION }"
+
+    # make it so that our lib is at the head of the load/require path array
+  $:.unshift( File.expand_path('../lib', __FILE__) )
+    # kick off module configurations
+  load File.expand_path('../config/application_configuration.rb', __FILE__)
+  
+# ****************************************************************************
+
+  require 'yaml'
+  require 'erb'
+  require 'active_support/core_ext/hash'
+  require 'cups'
+  require 'thread'
+  
+# ****************************************************************************
+# get temporary managed printer data for testing interfaces
+# ****************************************************************************
+
+GCP_SEED_FILE = "../config/gcp_seed.yml"
+
+# #########################################################################
+# ##########  working with seed data  #####################################
+# #########################################################################
+
+# -----------------------------------------------------------------------------
+
+  def load_gcp_seed()
+    if @seed_data.nil?
+      @seed_data =  YAML.load( 
+          ERB.new(
+            File.read(
+              File.expand_path(GCP_SEED_FILE , __FILE__ ) 
+            )
+          ).result 
+      )
+
+      puts "seed_data: #{@seed_data.object_id}"
+
+    end
+  end
+
+# -----------------------------------------------------------------------------
+
+  def write_gcp_seed()
+    unless @seed_data.nil?
+
+      ::Twiga.say_warn "updating seed data\n"
+
+      File.open(
+        File.expand_path(GCP_SEED_FILE , __FILE__ ), 
+        'w'
+      ) { |f| 
+        YAML.dump(@seed_data, f) 
+      }
+
+    end   # unless no seed data yet
+  end
+
+# -----------------------------------------------------------------------------
+
+  def get_gcp_control( item )
+    load_gcp_seed()
+
+    @seed_data[ item ].symbolize_keys
+  end
+
+# -----------------------------------------------------------------------------
+
+  def update_gcp_seed(gcp_control, item, &block )
+
+    @seed_data[item] ||= {}  # if first time
+    
+    @seed_data[item]['gcp_xmpp_jid'] = gcp_control[:gcp_xmpp_jid]
+    @seed_data[item]['gcp_confirmation_url'] = gcp_control[:gcp_confirmation_url]
+    @seed_data[item]['gcp_owner_email'] = gcp_control[:gcp_owner_email]
+
+    @seed_data[item]['gcp_printer_name'] = gcp_control[:gcp_printer_name]
+    @seed_data[item]['gcp_printerid'] = gcp_control[:gcp_printerid]
+
+    @seed_data[item]['gcp_access_token'] = gcp_control[:gcp_access_token]
+    @seed_data[item]['gcp_refresh_token'] = gcp_control[:gcp_refresh_token]
+    @seed_data[item]['gcp_token_type'] = gcp_control[:gcp_token_type]
+    @seed_data[item]['gcp_token_expiry_time'] = gcp_control[:gcp_token_expiry_time]
+
+    @seed_data[item]['is_active'] = gcp_control[:is_active]
+    @seed_data[item]['virgin_access'] = gcp_control[:virgin_access]
+
+    yield( @seed_data[item] ) if block_given?
+
+    write_gcp_seed()
+
+  end
+
+# -----------------------------------------------------------------------------
+
+
+  def add_gcp_seed_request( seed, new_request )
+
+      # add in some addtional initializing seed info from the request block
+    seed['printer_id']    = new_request[:printer_id]
+    seed['item']          = new_request[:item]
+    seed['cups_alias']    = new_request[:cups_alias]
+    seed['capability_ppd']   = new_request[:capability_ppd]
+    seed['capability_cdd']   = new_request[:capability_cdd]
+    seed['gcp_printer_name'] = new_request[:gcp_printer_name]
+
+    seed['gcp_uuid']     = new_request[:gcp_uuid]
+    seed['gcp_manufacturer']     = new_request[:gcp_manufacturer]
+    seed['gcp_model']     = new_request[:gcp_model]
+    seed['gcp_setup_url']     = new_request[:gcp_setup_url]
+    seed['gcp_support_url']     = new_request[:gcp_support_url]
+    seed['gcp_update_url']     = new_request[:gcp_update_url]
+    seed['gcp_firmware']     = new_request[:gcp_firmware]
+
+    return seed
+  end
+
+# -----------------------------------------------------------------------------
+
+  def update_gcp_seed_tokens( item )
+
+    @seed_data[item] ||= {}  # if first time
+    
+    gcp = @proxy.my_devices[item].gcp_printer_control
+
+    @seed_data[item]['gcp_access_token'] = gcp[:gcp_access_token]
+    @seed_data[item]['gcp_token_expiry_time'] = gcp[:gcp_token_expiry_time]
+    @seed_data[item]['virgin_access'] = gcp[:virgin_access]
+
+    write_gcp_seed()
+  end
+
+# -----------------------------------------------------------------------------
+
+  def build_device_list()
+
+    load_gcp_seed()    # load the seed data
+
+      # prep to build up a hash of gcp_control hashes
+    gcp_control_hash = {}
+
+    @seed_data.each_key do |item|
+      gcp_control_hash[ item ] = @seed_data[ item ].symbolize_keys  # strip item into hash with keys
+    end   # convert each seed to a device object
+
+    return gcp_control_hash
+    
+  end   # convert each seed to a device object
+
+# -----------------------------------------------------------------------------
+
+# if item hasn't yet been defined in seed data, create one out of
+# thin air by using test as a template
+  def build_gcp_request( item )
+
+    use_item = validate_item( item )
+
+    return {
+      item:  item,
+      printer_id:   0,  # will be cue to create new record
+      gcp_printer_name: "gcp_#{item}_printer",
+      capability_ppd: @seed_data[use_item]['capability_ppd'],
+      capability_cdd: @seed_data[use_item]['capability_cdd'],
+      cups_alias: @seed_data[use_item]['cups_alias'],
+      gcp_uuid:         @seed_data[use_item]['gcp_uuid'],
+      gcp_manufacturer: @seed_data[use_item]['gcp_manufacturer'],
+      gcp_model:        @seed_data[use_item]['gcp_model'],
+      gcp_setup_url:    @seed_data[use_item]['gcp_setup_url'],
+      gcp_support_url:  @seed_data[use_item]['gcp_support_url'],
+      gcp_update_url:   @seed_data[use_item]['gcp_update_url'],
+      gcp_firmware:     @seed_data[use_item]['gcp_firmware'],
+    }
+  end
+
+# -----------------------------------------------------------------------------
+
+  def validate_item( item )
+    return ( @seed_data.has_key?(item) ? item : 'test' )
+  end
+
+# -----------------------------------------------------------------------------
+
+# #########################################################################
+# ##########  one-offs for do_work commands  ##############################
+# #########################################################################
+
+# -----------------------------------------------------------------------------
+
+  def do_ready_state( item )
+    @proxy.do_ready_state( validate_item( item ) )
+  end
+
+
+# -----------------------------------------------------------------------------
+
+  def do_list( item )
+    @proxy.do_list( validate_item( item ) )
+  end
+
+# -----------------------------------------------------------------------------
+
+  def do_fetch( item )
+    jobs = @proxy.do_fetch_jobs( validate_item( item ) )
+    if jobs['success']
+      ::Twiga.say_warn "#{jobs['request']['params']['printerid'].first }: #{jobs['jobs'].size } print jobs"
+    else  # had error
+      ::Twiga.say_err "#{jobs['request']['params']['printerid'].first }: #{jobs['message']}" 
+    end
+  end
+
+
+# -----------------------------------------------------------------------------
+
+  def do_register( item )
+    new_request = build_gcp_request( item )
+
+    response = @proxy.do_register( new_request ) do |gcp_control|
+
+      update_gcp_seed(gcp_control, gcp_control[:item] ) do |seed|
+        add_gcp_seed_request( seed, new_request )
+      end  # seed additions
+
+    end   # do persist new printer information
+
+    unless response[:success]
+      ::Twiga.say_err "printer registration failed: #{response[:message]}"
+    end
+
+  end
+
+# -----------------------------------------------------------------------------
+
+  def do_delete( item )
+    item = validate_item( item )
+    @proxy.do_delete( item )
+    @seed_data[item]['is_active'] = false
+    write_gcp_seed()
+  end
+
+# -----------------------------------------------------------------------------
+
+  def do_refresh( item )
+    item = validate_item( item )
+    @proxy.do_refresh( item )
+    update_gcp_seed_tokens( item )
+  end
+
+# -----------------------------------------------------------------------------
+
+  def do_connect( item )
+    item = validate_item( item )
+    ::Twiga.say_info  "Starting jingle connection to device: #{item}...\n"
+    @proxy.do_connect( item )
+    update_gcp_seed_tokens( item )
+  end
+
+# -----------------------------------------------------------------------------
+
+  def show_seed()
+    ::Twiga.say_warn "seed_data: #{@seed_data.object_id}"
+    puts @seed_data.inspect
+  end
+
+# -----------------------------------------------------------------------------
+
+  def show_gcp( item )
+    gcp = @proxy.my_devices[validate_item( item )].gcp_printer_control
+    ::Twiga.say_warn "cloudprint gcp: #{gcp.object_id}\n"
+    puts gcp.inspect
+
+  end
+
+# -----------------------------------------------------------------------------
+
+  def show_devices()
+    ::Twiga.say_warn "device obj: #{@proxy.my_devices.object_id}\n"
+    puts @proxy.my_devices.inspect
+  end
+
+# -----------------------------------------------------------------------------
+
+  def show_time( item )
+    item = validate_item( item )
+    extime = @proxy.my_devices[item].gcp_printer_control[:gcp_token_expiry_time]
+    ::Twiga.say_warn "expiry for #{item}: #{extime.class.name}\t#{extime.to_s(:db)}\n"
+
+  end
+
+# -----------------------------------------------------------------------------
+
+HELP_LIST = %w(list fetch register ready refresh delete devices connect save seed time exit quit gcp help)
+
+  def show_help()
+    ::Twiga.say_info "Twiga commands: " + HELP_LIST.join(', ')
+  end
+
+# -----------------------------------------------------------------------------
+# do_work --  mini command interpretor to assist debugging & development
+# -----------------------------------------------------------------------------
+  def do_work()
+
+    show_help()
+   ::Twiga.say_info "\ntwiga> "
+
+   while (cmd = gets) do
+     cmd.strip!
+     tokens = cmd.split(/ /)
+     unless tokens.empty?
+
+       item = tokens[1]  ||  'test'
+     
+       case tokens.first.downcase
+
+         when 'quit','exit' then break
+
+         when 'register' then do_register( item )
+         when 'refresh'  then do_refresh( item )
+         when 'list'     then do_list( item )
+         when 'fetch'    then do_fetch( item )
+         when 'delete'   then do_delete( item )
+
+         when 'save'     then update_gcp_seed_tokens( item )
+         when 'seed'     then show_seed()
+         when 'ready'    then do_ready_state( item )
+         when 'time'     then show_time( item )
+         when 'devices'  then show_devices()
+
+         when 'connect'  then do_connect( item )
+
+         when 'help' then show_help() 
+         when 'cups' then do_cups_work() 
+         when 'gcp'  then show_gcp( item )
+
+       else
+         ::Twiga.say_err "? unknown command: #{cmd}"
+       end # case
+     
+     end # unless no command
+
+     ::Twiga.say_info "\ntwiga> "
+   end
+
+  end
+
+# -----------------------------------------------------------------------------
+
+# #########################################################################
+# ##########  one-offs for do_cups commands  ##############################
+# #########################################################################
+
+# -----------------------------------------------------------------------------
+
+  def show_printers()
+    list = Cups.show_destinations
+    puts list.inspect
+  end
+
+  def show_default()
+    printer = Cups.default_printer
+    puts printer.inspect
+  end
+
+  def show_jobs()
+    hash = Cups.all_jobs( Cups.default_printer )
+    last_job = hash.keys.sort.last
+    puts "#{last_job}: " + hash[last_job].inspect
+  end
+
+  def show_brief_options()
+    ::Twiga.say_warn snippet_brief_options(
+      Cups.options_for( Cups.default_printer )
+    )
+  end
+
+  def show_options()
+    show_brief_options()
+    puts snippet_full_options Cups.options_for( Cups.default_printer )
+  end
+  
+  def state_to_s( state )
+    case ( state )
+      when '3' then 'idle'
+      when '4' then 'busy'
+      when '5' then 'stopped'
+      else
+        state
+    end # case
+  end
+
+  def snippet_full_options( state_hash )
+<<RUBY20
+  name:    #{ state_hash['printer-info'] }
+  make:    #{ state_hash['printer-make-and-model'] }
+  ready:   #{ state_hash['printer-is-accepting-jobs'] }
+  state:   #{ state_to_s( state_hash['printer-state'] ) }
+  why:     #{ state_hash['printer-state-reasons'] }
+RUBY20
+  end
+
+  def snippet_brief_options( state_hash )
+
+    state_hash['printer-info'] + ': ' +
+    ( state_hash['printer-is-accepting-jobs']  ?  ''  :  'not ') +
+    'ready - ' +
+    state_to_s( state_hash['printer-state'] ) + 
+    ( state_hash['printer-state-reasons'] == 'none'  ?  
+     ''  : 
+     ': ' + state_hash['printer-state-reasons']    ) + "\n"
+
+  end
+
+  def print_testpage( printer=nil )
+   pj = setup_testpage( printer )
+   puts "pj initial state is: #{pj.state}"
+   pj.print
+   return pj
+  end
+
+  def setup_testpage( printer=nil )
+    return Cups::PrintJob.new( Kinokero.cups_testpage_file, printer) 
+  end
+
+  def scan_state( printer=nil )
+    state = :queued
+    pj = print_testpage( printer )
+    while ( state == :processing || state == :held || state == :queued )
+      unless pj.state == state
+        state = pj.state
+        puts "state changed to: #{state}; #{pj.error_code} / #{pj.error_reason}"
+      end   # state changed
+      sleep 0.200   # sleep for 200 ms
+    end  # while
+    
+    puts "final state:   #{pj.state}"
+    puts "scan state finished: #{pj.completed?} / #{pj.failed?}"
+    puts "error info: #{pj.error_code} / #{pj.error_reason}"
+  end
+
+  def start_poll_thread()
+
+    poll_thread = Thread.new  do
+
+      while true 
+        show_brief_options()
+        sleep 2
+      end
+
+    end  # polling thread
+
+      # force abort of everything if exception in thread
+    poll_thread.abort_on_exception = true
+
+    return poll_thread
+
+  end
+
+
+# -----------------------------------------------------------------------------
+
+CUPS_HELP_LIST = %w(printers default jobs options print scan exit quit help)
+
+  def show_cups_help()
+    ::Twiga.say_info "Twiga cups commands: " + CUPS_HELP_LIST.join(', ')
+  end
+
+
+# -----------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
+
+  def do_cups_work()
+
+    # start_poll_thread()
+
+    show_help()
+   ::Twiga.say_info "\ncups>> "
+
+   while (cmd = gets) do
+     cmd.strip!
+     tokens = cmd.split(/ /)
+     unless tokens.empty?
+
+       item = tokens[1]  ||  'test'
+     
+       case tokens.first.downcase
+
+         when 'quit','exit' then break
+
+         when 'printers' then show_printers() 
+         when 'default' then show_default() 
+         when 'jobs' then show_jobs() 
+         when 'options' then show_options() 
+
+         when 'print' then print_testpage() 
+         when 'scan' then scan_state() 
+
+         when 'help' then show_cups_help() 
+
+       else
+         ::Twiga.say_err "? unknown command: #{cmd}"
+       end # case
+     
+     end # unless no command
+
+     ::Twiga.say_info "\ncups>> "
+   end
+
+
+  end
+
+# -----------------------------------------------------------------------------
+
+# #########################################################################
+# ##########  command line options handling  ##############################
+# #########################################################################
+
+# -----------------------------------------------------------------------------
+
+  def parse_options()
+
+    options = {}
+
+    ARGV.each_index do |index|
+      case $*[index]
+        when '-m' then options[:auto_connect] = false
+        when '-v' then options[:verbose] = true
+        when '-q' then options[:verbose] = false
+        when '-t' then options[:log_truncate] = true
+        when '-r' then options[:log_response] = false
+      else
+        ::Twiga.say_warn "unknown option: #{arg}"
+      end    # case
+
+      $*.delete_at(index)   # remove from command line
+
+    end   # do each cmd line arg
+      
+    return Kinokero::Cloudprint::DEFAULT_OPTIONS.merge(options)
+
+  end
+
+# -----------------------------------------------------------------------------
+
+# **************************************************************************** # *****  appliance initialization here   *************************************
+# ********   MAIN STARTING POINT HERE   **************************************
+# ****************************************************************************
+
+  ::Twiga.say_info "\nTwiga starting...\n"
+  
+     # start up the GCP proxy
+  @proxy = Kinokero::Proxy.new( build_device_list(), parse_options )
+  @my_devices = @proxy.my_devices
+
+  unless $0 =~ /irb/   # are we in console mode? 
+    #  no, start appliance
+
+  # ****************************************************************************
+  # ***  appliance primary work goes here   ************************************
+  # ****************************************************************************
+
+    do_work()   # primary twiga control area
+
+  # ****************************************************************************
+  # *********   app ends here   ************************************************
+  # ****************************************************************************
+
+  ::Twiga.say_info "...ending\n\n"
+
+    exit 0
+
+# -----------------------------------------------------------------------------
+  end   # end unless console mode
+# fall through to IRB