tasc 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjhiMDlmYTY4ODc1YTBiNzI5ZWI4OTllOWM1NmMxNjVhYTQzNTM2Ng==
+  data.tar.gz: !binary |-
+    ODU0ZjdiNWUwMTVlZjE0ZTljYzE1Mzg3YzBmNTUyNzliMmUyNWNlYw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    Y2Q4YjBjOWQ3OTk5MGVlMWJjZDU0ZTg3MDljMjJhNGQ4M2Y0ZGE1NDMxYjU5
+    ZTM5OGJjZmRjOThlYmJhYTFmYTY1YmQ2ZmQ2NmFmYWM0Y2YwNGJjYzZiMzQx
+    MTM2MDk0Yjg2NzNkMjdhMWViMTA4NmE0ZDg4MGIzNDVlZDIxMmY=
+  data.tar.gz: !binary |-
+    NWRhMmY1ZTc2NzEyMzc2ZGVkODA0MWNiMzVlYmZlNzhlMWRlYWVjMzcyYThk
+    MTQxN2JkYTA5YjMwNzhiMDgyYzM4N2ExYzg1ZmIwYTg0ZWVlNjVlYjEyYWRk
+    NWUzOGViODU5ZDlmMjJiNjE5YWMzOWZhYzY3YzZjZDQ4OTk1ZGI=

data/README.md

@@ -0,0 +1,94 @@
+# tasc CLI
+tasc is a command-line interface (CLI) for maintaining and managing the
+lists of terms that are available for auto-complete from the TrieService.
+
+tasc is a ruby gem built on top of the gli (aka, "git-like interface")
+library.
+
+### Installing
+    $ gem install tasc
+
+Alternatively, clone this repo and execute the following commands from within this
+directory
+    $ rake
+    $ gem install tasc
+
+### Features 
+Some of the more basic feeatures are described below to help get you
+started.  To see all available commands simply type
+
+    $ tasc
+
+#### Client Configuration
+tasc will create a configuration file of servers you may connect to in
+your user directory under _.tasc/servers.yaml_.  You can use the _config_
+command to display your current config settings or alter them.
+
+    $ tasc config
+    Configuration:
+    +----------------+--------------------+
+    | Key | Value |
+    +----------------+--------------------+
+    | current_server | dev                |
+    | default        | localhost:8080     |
+    | testsvr        | 127.0.0.1:81       |
+    | foo            | bar:80             |
+    | dev            | 10.45.205.204:8080 |
+    | testingsq      | 1.1.02.10:3333     |
+    | bchee          | 10.115.100.77:8080 |
+    +----------------+--------------------+
+
+#### List Management
+
+* upload & download a list in a file 
+* add, update, remove entries from a list
+* create, delete, update, show a list
+
+#### List Configuration
+Supports 2 types of lists:
+* static - list of pre-determined items, use the _upload_ command
+* dynamic - list is generated by usage, use the _create_ command
+
+Dynamic lists are self-maintaining.  The TrieService keeps track of each
+entry's usage and age.  You can configure a maximum number of entries
+that will be maintained.  When the max size is reached, the usage and age is used to sort
+the list and remove the least-recently, least-frequently used item (LRLFU).
+
+### Building
+
+The included Rakefile will build the tasc gem, e.g.,
+
+```shell
+$ rake
+Using rake (10.0.3)
+Using ffi (1.4.0)
+Using childprocess (0.3.9)
+Using builder (3.2.0)
+Using diff-lcs (1.2.1)
+Using json (1.7.7)
+Using gherkin (2.11.6)
+Using multi_json (1.6.1)
+Using cucumber (1.2.2)
+Using rspec-expectations (2.13.0)
+Using aruba (0.5.1)
+Using awesome_print (1.1.0)
+Using gli (2.5.4)
+Using hirb (0.7.0)
+Using mime-types (1.21)
+Using rdoc (4.0.0)
+Using rest-client (1.6.7)
+Using wopen3 (0.3)
+Using tasc (0.1.0)
+Using bundler (1.3.1)
+Your bundle is complete! Use `bundle show [gemname]` to see where a
+bundled gem is installed.
+Latest version currently installed. Aborting.
+Updating installed gems
+Nothing to update
+WARNING:  licenses is empty
+WARNING:  no description specified
+  Successfully built RubyGem
+  Name: tasc
+  Version: 0.1.0
+  File: tasc-0.1.0.gem
+```

data/bin/tasc

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+
+$: << File.expand_path(File.dirname(File.realpath(__FILE__)) + '/../lib')
+
+require 'gli'
+require 'tasc'
+
+include GLI::App
+
+program_desc 'a command line app for managing lists of terms available for auto-complete from the TrieService'
+version Tasc::VERSION
+preserve_argv
+
+# config_file stored in .tasc subdirectory of user's home directory
+# ruby handles finding it, so it's platform agnostic
+CFG_FILE = config_file('.tasc/servers.yaml')
+
+
+# **********************************
+# List Global Switches here, but command-specific switches in the ./command/<command>.rb
+# Switches are value-less options passed to the command
+# Example: --lb would specify that the command is to operate on the Load Balancer
+# desc 'Describe your switch here'
+# switch [:s,:switch]
+
+# ***********************************
+# List Global Flags here, but command-specific flags in the ./command/<command>.rb
+# Flags are name value pairs passed to the command
+# Example: -h 10.20.41.256 tells the command to operate against this specific server
+# desc 'Describe your flag here'
+# arg_name 'name of flag arg'
+# flag [:f,:flag]
+
+pre do |global,command,options,args|
+  # Pre logic here
+  # Return true to proceed; false to abort and not call the
+  # chosen command
+  # Use skips_pre before a command to skip this block
+  # on that command only
+
+  # Create directory and config if they don't already exist
+  @conf_dir = File.join(File.expand_path(ENV['HOME']),'.tasc')
+  #ap "config directory: " + @conf_dir
+  unless File.exists?(CFG_FILE)
+    unless Dir.exists?(@conf_dir) then Dir.mkdir @conf_dir end
+
+    tasc_conf = YAML::Store.new(CFG_FILE)
+    tasc_conf.transaction do
+      tasc_conf["current_server"] = "default"
+      tasc_conf["default"] = "localhost:8080"
+    end
+  end
+  true
+end
+
+post do |global,command,options,args|
+  # Post logic here
+  # Use skips_post before a command to skip this
+  # block on that command only
+end
+
+# Initialization for each command
+around do |global,command,options,args,code|
+  #ap "Executing around ..."
+  if (File.exist?(CFG_FILE))
+    $tasc_conf = YAML::load(File.open(CFG_FILE, 'r'))
+    $server = $tasc_conf['current_server']
+    if ( $tasc_conf.has_key?($server) )
+      $host = $tasc_conf[$server]
+      code.call
+    else
+      exit_now!("No server label '#{$server}' configured")
+    end
+  end
+end
+
+
+# put commands into the './lib/tasc' subdirectory
+commands_from 'tasc'
+
+exit run(ARGV)

data/lib/tasc/config.rb

@@ -0,0 +1,85 @@
+desc 'Lets you add, remove, list, or use a service connection'
+long_desc 'Controls the configuration of tasc. The default sub-command is "list"'
+
+command :config do |c|
+
+  c.desc 'Displays the configured service connections'
+  c.long_desc 'Arguments are ignored'
+  c.command :list do |l|
+    l.action do |global_options,options,args|
+      unless args.empty?
+        ap "Warning: Arguments to 'config list' are ignored."
+      end
+      entries = $tasc_conf.to_a
+      puts "Configuration:"
+      puts Hirb::Helpers::Table.render entries, :description=>false, :headers=>["Key", "Value"]
+    end
+  end
+
+  c.desc 'Switch tasc to use a different service'
+  c.long_desc '[label] argument required.  Changes the value of "current_server". e.g., tasc use dev'
+  c.command :use do |u|
+    u.action do |global_options,options,args|
+      if (args[0] == nil)
+        help_now! 'Missing label identifying the service to use.'
+      else
+        if (args.length > 1)
+          help_now! "Too many arguments given for 'config use' command."
+        else
+          label = args[0]
+          if ($tasc_conf.has_key?(label))
+            $tasc_conf['current_server'] = label
+            File.open(CFG_FILE, 'w') do |out|
+              YAML.dump($tasc_conf, out)
+            end
+            ap "Switched connection to '#{label}'"
+          else
+            help_now! "Config label '#{label}' does not exist"
+          end
+        end
+
+      end
+    end
+  end
+
+  c.desc 'Adds a service connection'
+  c.long_desc '[label] [server] arguments are required.  The label "current_server" is reserved. e.g., tasc add dev 127.0.0.1'
+  c.command :add do |a|
+    a.action do |global_options,options,args|
+      if args.length == 2
+        $tasc_conf[args[0]] = args[1]
+        File.open(CFG_FILE, 'w') do |out|
+          YAML.dump($tasc_conf, out)
+        end
+        ap "Configured new connection"
+        ap "  '#{args[0]}' : '#{args[1]}'"
+      else
+        help_now! "Wrong number of arguments to 'config add'"
+      end
+    end
+  end
+
+  c.desc 'Delete a service connection named label'
+  c.long_desc '[label] argument required.   The "current_server" label cannot be deleted. e.g., tasc delete dev'
+  c.command :delete do |d|
+    d.action do |global_options,options,args|
+      if args.length == 1
+        label = args[0]
+        if ($tasc_conf.has_key?(label))
+          $tasc_conf.delete(label)
+          File.open(CFG_FILE, 'w') do |out|
+            YAML.dump($tasc_conf, out)
+          end
+          ap "Deleted connection #{args[0]}"
+        else
+          help_now! "Service connection #{args[0]} does not exist."
+        end
+      else
+        help_now! "Wrong number of arguments to 'config delete'"
+      end
+    end
+  end
+
+  c.default_command :list
+
+end

data/lib/tasc/create.rb

@@ -0,0 +1,28 @@
+desc 'Create a self-maintaining entity list'
+long_desc '[name] [maxSize] arguments - [name] is required; [maxSize] is optional and will default to 10,000'
+
+command :create do |c|
+  c.action do |global_options,options,args|
+    if (args[0] == nil)
+      help_now! "Missing required argument to create command: Name of list to create."
+    else
+      if (args[1] == nil)
+        args[1] = 10000
+      end
+      if (args[1].to_i < 1)
+        args[1] = 10000
+      end
+      # Construct URL to REST-ful service
+      uristr = "http://#{$host}/typeahead/createCache?entity=#{args[0]}&maxSize=#{args[1]}"
+      uri = URI(uristr)
+      resp = Net::HTTP.get_response(uri)
+      if (resp.code == '200')
+        ap "List created: #{args[0]}"
+      else
+        ap  "Server Error: #{resp.code} - #{resp.message}"
+        ap "URI: #{uristr}"
+        ap "response body: #{resp.body}"
+      end
+    end
+  end
+end

data/lib/tasc/delete.rb

@@ -0,0 +1,23 @@
+desc 'Deletes an entity list from the server'
+long_desc '[name] argument required'
+
+command :delete do |c|
+  c.action do |global_options,options,args|
+    ap "Executing delete command"
+    if ( args[0] == nil)
+      help_now! "Missing required argument: Name of list to remove."
+    else
+      if ( args.length > 1 )
+        help_now! "Delete takes only one argument."
+      else
+        uristr = "http://#{$host}/typeahead/deleteTrie?entity=#{args[0]}"
+        resp = Net::HTTP.get_response(URI(uristr))
+      end
+    end
+    if (resp.code == '200')
+      ap "Delete command successful. #{args[0]} deleted."
+    else
+      ap "Server Error: #{resp.code} - #{resp.message}"
+    end
+  end
+end

data/lib/tasc/download.rb

@@ -0,0 +1,43 @@
+desc "Downloads an existing entity list from the server in CSV format gzip'd"
+long_desc '[name] [filepath] arguments - [name] required; [filepath] optional, defaults to the list name in the current directory.'
+
+command :download do |c|
+  c.action do |global_options,options,args|
+    ap "Executing download command ..."
+    if (args[0] == nil)
+      help_now! "Missing required argument: Name of list to download."
+    else
+      if (args.length > 2)
+        help_now! "Too many arguments given."
+      end
+    end
+
+    uristr = "http://#{$host}/typeahead/download?entity=#{args[0]}"
+    resp = Net::HTTP.get_response(URI(uristr))
+
+    if (args[1] != nil)
+      filename = args[1]
+    else
+      filename = args[0]
+    end
+
+    begin
+      file = File.open("#{filename}.csv.gz", "w")
+      file.write(resp.body)
+    rescue IOError => e
+      ap "Failed to write file #{filename}.csv.gz."
+    ensure
+      file.close unless file == nil
+    end
+
+    if (resp.code == '200')
+      ap "Downloaded #{args[0]} to #{filename}.csv.gz"
+    else
+      ap  "Server Error: #{resp.code} - #{resp.message}"
+      ap "URI: #{uristr}"
+      ap "response body: #{resp.body}"
+    end
+
+    ap "download command ran"
+  end
+end

data/lib/tasc/list.rb

@@ -0,0 +1,22 @@
+desc 'Displays a list of available entity types for auto-complete selection'
+long_desc 'takes no arguments'
+
+command :list do |c|
+  c.action do |global_options,options,args|
+    ap "Executing list command ..."
+    if ( !args.empty? || args.length != 0 )
+      help_now! "Wrong number of arguments to 'list'"
+    else
+      resp = Net::HTTP.get_response(URI("http://#{$host}/typeahead/listEntities"))
+      if resp.code == '200'
+        puts "List of Labels:"
+        entries = JSON resp.body
+        entries.sort!.each do |e|
+          puts "  #{e}"
+        end
+      else
+        ap "Server Error: #{resp.code} - #{resp.message}"
+      end
+    end
+  end
+end

data/lib/tasc/remove.rb

@@ -0,0 +1,28 @@
+desc 'Removes an existing key and its associated value from an entity list'
+long_desc '[name] [key] arguments are required'
+
+command :remove do |c|
+  c.action do |global_options,options,args|
+
+    ap "Executing remove command ..."
+    if (args[0] == nil) || (args[1] == nil)
+      help_now! "Missing required arguments to remove command."
+    else
+      if (args.length > 2)
+        help_now! "Too many arguments given."
+      else
+        uristr = "http://#{$host}/typeahead/remove?entity=#{args[0]}&key=#{args[1]}"
+        uri = URI(uristr)
+        resp = Net::HTTP.get_response(uri)
+        if (resp.code == '200')
+          ap "Removed #{args[1]} from #{args[0]}"
+        else
+          ap  "Server Error: #{resp.code} - #{resp.message}"
+          ap "URI: #{uristr}"
+          ap "response body: #{resp.body}"
+        end
+      end
+    end
+
+  end
+end

data/lib/tasc/show.rb

@@ -0,0 +1,24 @@
+desc 'Display an existing entity list'
+long_desc '[name] argument required'
+
+command :show do |c|
+  c.action do |global_options,options,args|
+    if ( args.empty? || args.length != 1 )
+      help_now! "Wrong number of arguments to 'show'"
+    else
+      name = args[0]
+      resp = Net::HTTP.get_response(URI("http://#{$host}/typeahead/listTrie?entity=#{name}"))
+      if resp.code == '200'
+        entries = JSON resp.body
+        puts "Entries from #{name}:"
+        puts Hirb::Helpers::Table.render entries, :headers=>["Key", "Value",  "Weight"]
+      elsif resp.code == '202'
+        puts "List '#{name}' too long to display"
+      elsif resp.code == '204'
+        puts "Unknown list: '#{name}'"
+      else
+        puts "Server Error: #{resp.code} - #{resp.message}"
+      end
+    end
+  end
+end

data/lib/tasc/update.rb

@@ -0,0 +1,28 @@
+desc 'Updates an existing value on an entity list. If the value does not exist, it will be added.'
+long_desc '[name] [key] [value] [rank] are all required; e.g., tasc update state massachusetts MA 1'
+
+command :update do |c|
+  c.action do |global_options,options,args|
+
+    ap "Executing update command ..."
+    if (args[0] == nil) || (args[1] == nil)  || (args[2] == nil) || (args[3] == nil)
+      help_now! "Missing required arguments to update command."
+    else
+      if (args.length > 4)
+        help_now! "Too many arguments given."
+      else
+        uristr = "http://#{$host}/typeahead/update?entity=#{args[0]}&key=#{args[1]}&value=#{args[2]}&rank=#{args[3]}"
+        uri = URI(uristr)
+        resp = Net::HTTP.get_response(uri)
+        if (resp.code == '200')
+          ap "Added #{args[1]} to #{args[0]} with value #{args[2]} rank #{args[3]}"
+        else
+          ap  "Server Error: #{resp.code} - #{resp.message}"
+          ap "URI: #{uristr}"
+          ap "response body: #{resp.body}"
+        end
+      end
+    end
+
+  end
+end

data/lib/tasc/upload.rb

@@ -0,0 +1,28 @@
+desc "Upload a CSV file (gzip'd or not) containing a comma-separated list of values and meta-data on which to auto-complete.  Replaces an existing entity list if it already exists, creates a new one otherwise."
+long_desc '[filepath] argument required'
+
+command :upload do |c|
+  c.action do |global_options,options,args|
+    unless args.empty?
+      filepath = args[0]
+      url = "http://#{$host}/typeahead/upload"
+      # see http://stackoverflow.com/questions/184178/ruby-how-to-post-a-file-via-http-as-multipart-form-data
+      # and https://wincent.com/products/wopen3
+      # orig: curl -F media=@#{photo.path} -F username=#{@username} -F password=#{@password} -F message='#{photo.title}' http://twitpic.com/api/uploadAndPost`
+      # adapted: curl -F file=@#{filepath} #{url}
+      file = "file=@#{filepath}"
+      result = Wopen3.system('curl', '-F', file, url)
+      if result.success?
+        puts "Successfully uploaded '#{filepath}'"
+        puts "stdout: #{result.stdout}"
+        puts "stderr: #{result.stderr}"
+      else
+        puts "Failed to upload"
+        puts "stdout: #{result.stdout}"
+        puts "stderr: #{result.stderr}"
+      end
+    else
+      help_now! "Wrong number of arguments to 'upload'"
+    end
+  end
+end

data/lib/tasc/version.rb

@@ -0,0 +1,4 @@
+module Tasc
+  VERSION = '0.1.0'
+  COMMENT = 'beta release'
+end

data/lib/tasc.rb

@@ -0,0 +1,11 @@
+require 'tasc/version.rb'
+
+# Add requires for other files you add to your project here, so
+# you just need to require this one file in your bin file
+require 'json'
+require 'rest-client'
+require 'awesome_print'
+require 'yaml/store'
+require 'net/http'
+require 'hirb'
+require 'wopen3'

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: tasc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steve Quince
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-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: json
+  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: awesome_print
+  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: hirb
+  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: wopen3
+  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: rake
+  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: rdoc
+  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: aruba
+  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: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+description: 
+email: squince@glgroup.com
+executables:
+- tasc
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/tasc
+- lib/tasc/config.rb
+- lib/tasc/create.rb
+- lib/tasc/delete.rb
+- lib/tasc/download.rb
+- lib/tasc/list.rb
+- lib/tasc/remove.rb
+- lib/tasc/show.rb
+- lib/tasc/update.rb
+- lib/tasc/upload.rb
+- lib/tasc/version.rb
+- lib/tasc.rb
+- README.md
+homepage: http://github.com/glg/AutoComplete
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- 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.0.2
+signing_key: 
+specification_version: 4
+summary: TrieService Auto-Suggest Command-Line Client for managing term lists
+test_files: []