broker 0.0.9

data/lib/broker/client/QuickBaseMisc.rb

@@ -0,0 +1,117 @@
+#--#####################################################################
+# Copyright (c) 2009-2012 Gareth Lewis and Intuit, Inc.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v1.0
+# which accompanies this distribution, and is available at
+# http://www.opensource.org/licenses/eclipse-1.0.php
+#
+# Contributors:
+#    Gareth Lewis - Initial contribution.
+#    Intuit Partner Platform.
+#++#####################################################################
+
+module QuickBase
+
+  # Miscellaneous static helper methods
+  class Misc
+
+    def Misc.ruby19?
+       RUBY_VERSION >= "1.9"
+    end
+   
+    def Misc.createBase32ConversionHash
+      base32Symbols = {}
+      decimal = 0
+      ("a".."z").each{|letter|
+         unless letter == "l" or letter == "o"
+           base32Symbols[decimal.to_s]=letter
+           decimal += 1
+         end
+      }
+      (2..9).each{|number|
+           base32Symbols[decimal.to_s]=number.to_s
+           decimal += 1
+      }
+      base32Symbols
+    end
+
+    def Misc.decimalToBase32(decimalNumber)
+      @base32Symbols ||= Misc.createBase32ConversionHash
+      base32Num = ""
+      decimalNumber = decimalNumber.to_i
+      if decimalNumber < 32
+        base32Num = @base32Symbols[decimalNumber.to_s]
+      else
+        power = 10
+        power -= 1 while (decimalNumber/(32**power)) < 1
+        while decimalNumber > 0
+           n = (decimalNumber/(32**power))
+           base32Num << @base32Symbols[n.to_s] if @base32Symbols[n.to_s]
+           decimalNumber = (decimalNumber-((32**power)*n))
+           power -= 1
+         end
+      end
+      base32Num
+    end
+    
+    def Misc.isBase32Number?(string)
+      ret = true
+      if string
+        @base32Symbols ||= Misc.createBase32ConversionHash
+        base32SymbolsValues = @base32Symbols.values
+        stringCopy = string.to_s
+        stringCopy.split(//).each{|char|
+          if !base32SymbolsValues.include?(char)
+            ret = false 
+            break
+          end  
+        }
+      else
+        ret = false
+      end  
+      ret
+    end  
+    
+    def Misc.isDbidString?(string) 
+      Misc.isBase32Number?(string) 
+    end
+    
+    def Misc.time_in_milliseconds(time = nil)
+      ret = 0
+      time ||= Time.now
+      if time.is_a?(Time)
+        ret = (time.to_f * 1000).to_i
+      elsif time.is_a?(DateTime)
+        t = Time.mktime(time.year,time.month,time.day,time.hour,time.min,time.sec,0)
+        ret = (t.to_f * 1000).to_i
+      elsif time.is_a?(Date)
+        t = Time.mktime(time.year,time.month,time.day,0,0,0,0)
+        ret = (t.to_f * 1000).to_i
+      end  
+      ret  
+    end 
+    
+    def Misc.listUserToArray(listUser)
+      listUser.split(/;/)
+    end
+    
+    def Misc.arrayToListUser(array)
+      array.join(";")
+    end
+    
+   def Misc.save_file(filename, contents, mode="wb")
+      File.open(filename, mode){|f|
+         f.write(contents)
+         f.flush
+      }
+      rescue StandardError => error
+      new_filename = filename.gsub(/\W/,"_")
+      File.open(new_filename, mode){|f|
+         f.write(contents)
+         f.flush
+      }
+   end
+       
+  end
+end

data/lib/broker/client/quickbase_client.rb

@@ -0,0 +1 @@
+require_relative 'QuickBaseClient'

data/lib/broker/export.rb

@@ -0,0 +1,16 @@
+require 'broker/session'
+
+module Broker
+  class Export < Broker::Session
+    
+   def initialize(opt={})
+     super(opt)
+   end
+   
+   def query
+     res = client.dbid_bji2vn2ck.qid_22.records.map { |r| r.to_s }
+     sign_out && res
+   end 
+   
+  end
+end

data/lib/broker/import.rb

@@ -0,0 +1,11 @@
+require 'broker'
+require 'broker/client/quickbase_client'
+
+module Broker
+  class Import
+   
+   
+   
+    
+  end
+end

data/lib/broker/launcher.rb

@@ -0,0 +1,66 @@
+require 'broker/utility'
+
+module Broker
+  class Launcher
+    
+   def initialize
+     @poller = Broker::Poller.new
+     @finished = false     
+   end
+   
+   def run
+     puts "launcher is running"
+     @poller.start
+   end
+   
+   def stop
+     @finished = true     
+     @poller.terminate
+     puts "launcher stopped"
+   end 
+    
+  end
+  
+  class Poller
+    include Utility
+    
+    def initialize
+      @finished = false
+      @wait_time = Broker.poll_interval
+      @folder = Broker.queue
+    end
+    
+    def terminate
+      @finished = true
+      if @thread
+        t = @thread
+        @thread = nil
+        wait 1
+        t.value
+        puts "Polling thread terminated"
+      end
+    end
+    
+    def start
+      @thread ||= safe_thread("poller") do 
+        pause_first
+        
+        while !@finished
+          puts "Checking for new files in #{@folder}"
+          wait
+        end
+      end
+    end
+    
+    private
+    
+    def pause_first
+      sleep 5
+    end
+    
+    def wait(dur=nil)
+      sleep dur || @wait_time
+    end
+  end
+  
+end

data/lib/broker/session.rb

@@ -0,0 +1,34 @@
+require 'broker'
+require 'broker/client/quickbase_client'
+
+module Broker
+  class Session
+    
+    attr_reader :client, :app
+    
+    def initialize(opt={})
+      @app        = opt[:app]
+      
+      credentials = {
+        "username" => Broker.secrets['USER'],
+        "password" => Broker.secrets['PASSWORD'],
+        "appname"  => @app,
+        "org"      => Broker.secrets['ORG'],
+        "apptoken" => opt[:token] || Broker.tables[@app]['token']
+      }
+      
+      @client = QuickBase::Client.init(credentials)
+    end
+    
+    def get_field_names(table)
+      table &&= table.to_s
+      db = Broker.tables[@app]['tables'][table]
+      db && @client.getFieldNames(db, "", true)
+    end
+    
+    def sign_out
+      @client.signOut
+    end
+    
+  end
+end

data/lib/broker/templates/broker.rb

@@ -0,0 +1,21 @@
+# Use this hook to configure Broker
+
+Broker.setup do |config|
+
+  # Store private quickbase credentials for authenticating via the api
+  config.secrets_path = 'config/secrets.yml'
+
+  # Store a table mapping for all quickbase apps you want to connect with
+  config.tables_path = 'config/quickbase_tables.yml'
+  
+  # Directory where your import files will be queued for import
+  config.queue = 'broker_queue'
+  
+  # Uncomment to change the default file type to use for importing
+  # [:csv, :tab]
+  #config.file_ext = :csv
+  
+  # Sets polling wait time before checking for new import files
+  config.poll_interval = 10
+
+end

data/lib/broker/templates/quickbase_tables.yml

@@ -0,0 +1,22 @@
+# Add Quickbase Table Configuration here
+#
+# Give each app an easy to remember/type name for broker to use
+# Tables should also be given a simple short name
+#
+# This config file will be used to generate the sync queue and to connect to the corresponding apps in quickbase
+# Don't check this into version control, keep this private
+#
+# EXAMPLES
+#
+tracker:
+  name: Job Tracker
+  token:  your_apps_token_for_tracker
+  tables:
+    main:  table_dbid
+    people:  table_dbid
+billings:
+  name:  Financial Billings
+  token:  your_apps_token_for_billings
+  tables:
+    projects:  table_dbid
+    pace:  table_dbid

data/lib/broker/templates/secrets.yml

@@ -0,0 +1,10 @@
+# Place your quickbase credentials here
+# Do not check into version control, keep your secrets safe
+#
+# ORG -> if you are using a custom subdomain such as mycompany.quickbase.com,
+# you will set ORG:  mycompany, otherwise www is the default
+#
+#
+ORG:  www
+USERNAME:  billy_the_kid@user.com
+PASSWORD:  mickeymouse

data/lib/broker/utility.rb

@@ -0,0 +1,17 @@
+module Broker
+  module Utility
+   
+   def watcher(last_words)
+     yield
+   rescue Exception => ex
+     raise ex
+   end
+   
+   def safe_thread(name, &block)
+     Thread.new do
+       watcher(name, &block)
+     end
+   end
+    
+  end
+end

data/lib/broker/version.rb

@@ -0,0 +1,3 @@
+module Broker
+  VERSION = "0.0.9"
+end

data/lib/broker/web.rb

@@ -0,0 +1,33 @@
+require 'erb'
+require 'sinatra/base'
+
+require 'broker/web_helpers'
+require 'broker/web_routes'
+
+
+module Broker
+  class Web < Sinatra::Base
+    
+    set :root, File.expand_path(File.dirname(__FILE__) + "/../../web")
+    set :public_folder, Proc.new { "#{root}/assets" }
+    set :views, Proc.new { "#{root}/views" }
+    
+    helpers WebHelpers
+    
+    register Broker::WebRoutes
+    
+    DEFAULT_TABS = {
+      "Dashboard" => '',
+      "Imports"   => 'imports',
+      "Exports"   => 'exports',
+      "API"       => 'api'
+    }
+    
+    class << self
+      def default_tabs
+        DEFAULT_TABS
+      end
+    end
+        
+  end
+end

data/lib/broker/web_helpers.rb

@@ -0,0 +1,12 @@
+require 'uri'
+
+module Broker
+  module WebHelpers
+    def root_path
+      "#{env['SCRIPT_NAME']}/"
+    end
+    def current_path
+      @current_path ||= request.path_info.gsub(/^\//,'')
+    end
+  end
+end

data/lib/broker/web_routes.rb

@@ -0,0 +1,34 @@
+require 'broker/import'
+require 'broker/export'
+
+module Broker
+  module WebRoutes
+    def self.registered(app)
+      app.get "/" do
+        erb :index
+      end
+    
+      app.get '/imports' do 
+        erb :imports
+      end
+    
+      app.get '/exports' do
+        db = params['table']
+        app = params['app']
+        @fields = []
+        @header = "Exports"
+        if db && app
+          qb = Broker::Export.new(:app => app)
+          @fields = qb.get_field_names(db)
+          @header = "App: #{app.downcase} | Table: #{db.capitalize}"
+          qb.sign_out
+        end
+        erb :exports
+      end
+      
+      app.get '/api' do
+        erb :api
+      end
+    end
+  end
+end

data/lib/broker.rb

@@ -0,0 +1,115 @@
+require 'broker/version'
+require 'yaml'
+
+module Broker
+  NAME = "Broker: Quickbase Data Intake"
+  
+  DEFAULTS = {
+    secrets_path: 'config/secrets.yml',
+    tables_path: 'config/quickbase_tables.yml',
+    initializer: 'config/initializers/broker.rb',
+    poll_interval: 300,
+    queue: 'broker_queue',
+    file_ext: :csv
+  }
+  
+  @@secrets_path    = @@secrets_path ||= DEFAULTS[:secrets_path]
+  @@tables_path 		= @@tables_path  ||= DEFAULTS[:tables_path]
+  @@initializer 		= @@initializer  ||= DEFAULTS[:initializer]
+  @@poll_interval		= @poll_interval ||= DEFAULTS[:poll_interval]
+  @@queue           = @@queue        ||= DEFAULTS[:queue]
+  @@file_ext        = @@file_ext     ||= DEFAULTS[:file_ext]
+  
+  @@secrets   			= YAML.load_file(@@secrets_path) rescue {}
+  @@tables    			= YAML.load_file(@@tables_path) rescue {}
+  
+  def self.lookup_tbid(opt={})
+    tables[opt[:app]]['tables'][opt[:table]]
+  end
+  
+  def self.path
+    Dir.pwd
+  end
+  
+  def self.setup
+    yield self unless launched?
+  end
+  
+  def self.launched?
+    defined?(Broker::Launcher)
+  end
+  
+  def self.config_files
+    [secrets_path, tables_path, initializer]
+  end
+  
+  # def self.options
+#     @options ||= DEFAULTS.dup
+#   end
+#
+#   def self.options=(opt)
+#     @options = opt
+#   end
+  
+  def self.poll_interval
+    @@poll_interval
+  end
+  
+  def self.poll_interval=(val)
+    @@poll_interval = val
+  end
+  
+  def self.queue
+    @@queue
+  end
+  
+  def self.queue=(val)
+    @@queue = val
+  end
+  
+  def file_ext
+    @@file_ext
+  end
+  
+  def file_ext=(val)
+    @@file_ext = val if [:csv, :tab].include? val
+  end
+  
+  def self.secrets
+    @@secrets
+  end
+  
+  def self.secrets_path
+    @@secrets_path
+  end
+  
+  def self.secrets_path=(val)
+    @@secrets_path = val
+    @@secrets   = YAML.load_file(@@secrets_path) rescue {}
+  end
+  
+  def self.tables
+    @@tables
+  end
+  
+  def self.tables_path
+    @@tables_path
+  end
+  
+  def self.tables_path=(val)
+    @@tables_path = val
+    @@tables = YAML.load_file(@@tables_path) rescue {}
+  end
+  
+  def self.initializer
+    @@initializer
+  end
+  
+  def self.initializer=(val)
+    @@initializer = val
+  end
+    
+end
+
+require 'broker/application'
+