ugc 0.0.6 → 0.9.0

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    ugc (0.0.6)
+    ugc (0.9.0)
       command_line_reporter
       gli (= 2.5.0)
       highline
-      usergrid_iron
+      usergrid_iron (>= 0.0.9)
 
 GEM
   remote: http://rubygems.org/
@@ -41,7 +41,7 @@ GEM
       mime-types (>= 1.16)
     rspec-expectations (2.12.1)
       diff-lcs (~> 1.1.3)
-    usergrid_iron (0.0.8)
+    usergrid_iron (0.0.9)
       multi_json
       rest-client
 

data/README.md

@@ -5,10 +5,14 @@ ugc enables convenient terminal access to Apigee's App Services (aka Usergrid).
 ## Features
 
 * Multiple connection/login profiles
-* Simple syntax
-* Use relative (or absolute) URLs
+* Simple syntax to Usergrid data
+* Use relative or absolute URLs
+* Convenient path reference '@n' to previous list entities
 * Easy-to-read tabular output
-* Optionally also emits raw output (--verbose switch)
+* Simplified json-generating syntax for data (key: 'value')
+* Ruby evaluation within data elements
+* Can optionally emits raw output (--verbose switch)
+* Extended SQL syntax (adds 'from' and 'limit' clauses to standard Usergrid syntax)
 
 ## Installation
 
@@ -18,41 +22,168 @@ Note: Requires Ruby 1.9.3+. If you have issues, check your version:
 
 	$ ruby -v
 	
-If necessary, install a new version of Ruby. [RVM](Ruby 1.9.x
-) is recommended:
+If necessary, install a new version of Ruby. [RVM](https://rvm.io) is recommended:
 
 	$ \curl -L https://get.rvm.io | bash -s stable --ruby
 
 ## Usage
 
-### Help
+### Commands
 
-    $ ugc help
+    delete              - delete an entity
+    get, show, ls, list - retrieve a collection or entity
+    help                - Shows a list of commands or help for one command
+    login               - Describe login here
+    post, create        - non-idempotent create or update (usually create)
+    profile, profiles   - set the current profile
+    put, update         - idempotent create or update (usually an update)
+    query               - query
+    target              - set the base url, org, and app
 
 ### Setup
 
-Connect to an Apigee administrator account:
+#### Create a profile:
 
 	$ ugc profile apigee
+
+#### Set targets:
+
+    $ ugc target base https://api.usergrid.com
+	base_url = https://api.usergrid.com
+
 	$ ugc target organization scottganyo
 	organization = scottganyo
+
 	$ ugc target app messagee
 	application = messagee
+
+#### (Alternatively, you can just specify the whole url at once)
+
+	$ ugc target url https://api.usergrid.com/scottganyo/messagee
+    base_url = https://api.usergrid.com
+    organization = scottganyo
+    application = messagee
+
+#### Login:
+
+(Note the user in this case is an admin user)
+
 	$ ugc login --admin scott@ganyo.com
 	password: **********
 	logged in user: scott@ganyo.com
-	
+
+#### Verify your profile:
+
+    $ ugc profile apigee
+    Set active profile:
+     *apigee
+        base_url: https://api.usergrid.com
+        organization: scottganyo
+        application: messagee
+        access_token: YWMtKgZnO1ULEeKKqQLoGuZA3AAAATwesjMsUYmz_ZGk8vkTwp0lh66Cv_CCEM4
+
 
 ### Examples
 
-![image](https://github.com/scottganyo/ugc/raw/master/examples.jpeg)
+#### list all Usergrid entity collections
+
+    $ ugc list collections
+    title      count      name       type
+    Assets     0          assets     asset
+    Users      0          users      user
+    Events     0          events     event
+    Roles      3          roles      role
+    Folders    0          folders    folder
+    Activities 0          activities activity
+    Devices    0          devices    device
+    Groups     0          groups     group
+
+What? No dogs? A travesty!
+
+#### create a dog
+
+(Note the use of simplified json syntax)
+
+    $ ugc create dog "breed: 'Black Mouth Cur', name: 'Old Yeller'"
+    name     value
+    uuid     91833fd9-56c5-11e2-a6b8-14109fd49581
+    name     Old Yeller
+    created  1357341732438
+    modified 1357341732438
+    breed    Black Mouth Cur
+
+#### he's lonely. we need more dogs.
+
+(Note use of square brackets to create an array of dogs)
+
+    $ ugc create dogs "[{ name: 'Tramp' },{ breed: 'Cocker Spaniel', name: 'Lady' }]"
+    #  uuid                                 name  created       modified      breed
+    1  79dfb563-56cb-11e2-a6b8-14109fd49581 Tramp 1357344269759 1357344269759
+    2  79e11500-56cb-11e2-a6b8-14109fd49581 Lady  1357344269768 1357344269768 Cocker Spaniel
+
+All the created dogs were returned as a list.
+
+#### oops, show that first dog
+
+(Note use of @1 to reference the 1st row from the previous list.)
+
+    $ ugc show @1
+    name     value
+    uuid     79dfb563-56cb-11e2-a6b8-14109fd49581
+    name     Tramp
+    created  1357344269759
+    modified 1357344269768
+
+Note synonym commands:
+
+    $ ugc show dogs/79dfb563-56cb-11e2-a6b8-14109fd49581
+    $ ugc show dogs/Tramp
+
+
+#### yup. forgot to set the breed, update that dog
+
+(Note use of standard json data)
+
+    $ ugc update @1 '{ "breed" : "Mixed" }'
+    name     value
+    uuid     79dfb563-56cb-11e2-a6b8-14109fd49581
+    name     Tramp
+    created  1357344269759
+    modified 1357344537483
+    breed    Mixed
+
+#### show off our latest dogs
+
+    $ ugc query dogs 'select name, breed where modified >= 1357344269768'
+    #  name     breed
+    1  Einstein Mixed
+    2  Lady     Cocker Spaniel
+
+Note: with ugc, you can also use extended sql syntax...
+
+    $ ugc query 'select name, breed from dogs where modified >= 1357344269768 limit 1'
+    #  name     breed
+    1  Einstein Mixed
+
+#### -- Special note on specifying column names in queries --
+
+If you specify column names in your query, you will be unable to reference the returned rows by @1 reference in later commands. (The current Usergrid implementation doesn't return any metadata for the entries.) In addition, for your safety the history will be cleared so that you don't inadvertently reference entities from a previous list.
 
 ## Release notes
 
+### 0.9.0
+* New features
+  1. path reference '@n' in commands to previous list entities
+     * eg. `$ ugc put @1 foo: 'bar'`
+  2. added --no-border flag
+  3. added rm alias for delete
+* Bug fixes
+  1. lock required version of usergrid_iron
+
 ### 0.0.6
 * New features
   1. Ruby eval of data in put and post commands
-     * eg. may now use "key: 'value'" for json instead of '{"key": "value"}'
+     * eg. may now use `key: 'value'` for json instead of `{"key": "value"}`
   2. Added alias: 'show' for 'get'
   3. Made 'list' an alias of 'get' and updated get to include 'list' functionality
   4. smart column width for entities

data/bin/ugc

@@ -13,7 +13,11 @@ program_desc 'Usergrid Command Line'
 version Ugc::VERSION
 
 desc 'verbose'
-switch [:v,:verbose]
+switch [:v,:verbose], negatable: false
+
+desc 'draw table border'
+default_value true
+switch [:b,:border]
 
 desc 'settings directory'
 arg_name 'settings directory'
@@ -33,7 +37,7 @@ pre do |global_options,command,options,args|
     Usergrid::LOG.level = Logger::WARN
   end
 
-  $settings = Ugc::Settings.new global_options[:settings]
+  $settings = Ugc::Settings.new global_options
   if pre_login.include? command.name
     true
   elsif command.name == :login && $settings.configured?

data/lib/ugc/application.rb

@@ -21,5 +21,14 @@ module Ugc
       $settings.access_token = auth_token
     end
 
+    def [](uri)
+      uri = perform_substitutions uri
+      if URI.parse(uri).host
+        Usergrid::Resource.new(uri, nil, $application.options) # absolute
+      else
+        super # relative
+      end
+    end
+
   end
 end

data/lib/ugc/commands/delete.rb

@@ -1,12 +1,12 @@
 desc 'delete an entity'
 arg_name 'url'
 
-command :delete do |c|
+command :rm,:del,:delete do |c|
 
   c.action do |global_options,options,args|
     help_now! unless args[0]
 
-    format_result resource(args[0]).delete
+    format_response $application[args[0]].delete
   end
 
 end

data/lib/ugc/commands/get.rb

@@ -8,7 +8,7 @@ command :get,:show,:ls,:list do |c|
     c2.action do |global_options,options,args|
       help_now! unless args[0]
 
-      format_result $application[args[0]].get
+      format_response $application[args[0]].get
     end
   end
 
@@ -18,7 +18,7 @@ command :get,:show,:ls,:list do |c|
     c2.action do |global_options,options,args|
       app = $application.entity
       collections = app['metadata']['collections']
-      table border: true do
+      table border: $settings.table_border? do
         row header: true do
           collections.first[1].each_key do |k|
             column k
@@ -40,7 +40,9 @@ command :get,:show,:ls,:list do |c|
     c.desc e
     c.command [e.to_sym] do |c2|
       c2.action do |global_options,options,args|
-        format_collection($application[e].collection)
+        response = $application[e].get
+        format_collection response.collection
+        save_response response
       end
     end
   end

data/lib/ugc/commands/post.rb

@@ -7,7 +7,7 @@ command :post,:create do |c|
   c.action do |global_options,options,args|
     help_now! unless args[0]
 
-    format_result resource(args[0]).post parse_data(options[:data] || args[1])
+    format_response $application[args[0]].post parse_data(options[:data] || args[1])
   end
 
 end

data/lib/ugc/commands/put.rb

@@ -7,7 +7,7 @@ command :put,:update do |c|
   c.action do |global_options,options,args|
     help_now! unless args[0]
 
-    format_result resource(args[0]).put parse_data(options[:data] || args[1])
+    format_response $application[args[0]].put parse_data(options[:data] || args[1])
   end
 
 end

data/lib/ugc/commands/query.rb

@@ -21,6 +21,7 @@ command :query do |c|
       type = parsed_query['from']
       query.gsub! /from\s+#{type}/i, ''
     end
+    help_now! 'collection_name or sql from clause is required' unless type
 
     params = {}
     if parsed_query['limit']
@@ -32,6 +33,7 @@ command :query do |c|
     response = $application[type].query query, params
 
     format_collection response.collection, parsed_query['select']
+    save_response response
   end
 
 end

data/lib/ugc/commands/target.rb

@@ -36,7 +36,7 @@ command :target do |c|
       if args[0]
         app_name = args[0].split('/')[-1]
         org_name = args[0].split('/')[-2]
-        base_url = args[0][0..url.index(org_name)-2]
+        base_url = args[0][0..args[0].index(org_name)-2]
         $settings.base_url = base_url
         $settings.organization = org_name
         $settings.application = app_name

data/lib/ugc/helpers/format.rb

@@ -1,20 +1,23 @@
 SKIP_ATTRS = %w(metadata uri type)
+INDEX_COL_WIDTH = 2
 
-def format_result(response)
+def format_response(response)
   if response.multiple_entities? && response.collection.size > 1
-    format_collection(response.collection)
+    format_collection response.collection
   else
-    format_entity(response.entity)
+    format_entity response.entity
   end
 end
 
-INDEX_COL_WIDTH = 2
-COL_OVERHEAD = 3
+def col_overhead
+  $settings.table_border? ? 3 : 1
+end
 
 def format_collection(collection, headers=nil)
   if collection && collection.size > 0
+    save_response collection.response
     metadata = collection_metadata collection, headers
-    table border: true do
+    table border: $settings.table_border? do
       row header: true do
         headers ||= metadata.keys
         column '#', width: INDEX_COL_WIDTH
@@ -46,10 +49,11 @@ def format_entity(entity)
       name_cols = [name_cols, k.size].max
       value_cols = [value_cols, v.to_s.size].max
     end
-    table border: true do
+    table border: $settings.table_border? do
       row header: true do
-        column 'name', width: [name_cols, 20].min
-        column 'value', width: [value_cols, HighLine.new.output_cols - 28].min
+        name_width = [name_cols, 20].min
+        column 'name', width: name_width
+        column 'value', width: [value_cols, HighLine.new.output_cols - name_width - (3 * col_overhead)].min
       end
       entity.data.reject{|k,v| SKIP_ATTRS.include? k}.each do |k,v|
         row do
@@ -86,7 +90,7 @@ def collection_metadata(collection, headers=nil)
     total + meta[:max_size]
   end
   terminal_columns = HighLine.new.output_cols
-  overhead = (result.keys.size + 2) * COL_OVERHEAD + INDEX_COL_WIDTH
+  overhead = (result.keys.size + 2) * col_overhead + INDEX_COL_WIDTH
   if total_size + overhead < terminal_columns
     result.each {|col,meta| meta[:size] = meta[:max_size]}
   else

data/lib/ugc/helpers/history.rb

@@ -0,0 +1,25 @@
+def save_response(response)
+  if response && response.multiple_entities? && response.collection.size > 1
+    paths = response.entities.collect {|e| e['metadata']['path'][1..-1] } rescue []
+    blob = Marshal.dump paths
+    $settings.save_profile_blob 'last_response', blob
+  end
+end
+
+def replacement_for(replacement_parm)
+  unless @last_response
+    blob = $settings.load_profile_blob 'last_response'
+    @last_response = Marshal.load blob
+  end
+  index = replacement_parm[1..-1].to_i
+  raise "no data for replacement param: #{replacement_parm}" unless @last_response[index-1]
+  @last_response[index-1]
+end
+
+def perform_substitutions(string)
+  string = string.clone
+  string.scan(/@[0-9]+/).uniq.each do |e|
+    string.gsub! e, replacement_for(e)
+  end
+  string
+end

data/lib/ugc/helpers/parse.rb

@@ -25,8 +25,9 @@ end
 
 # returns a json string
 def parse_data(input)
+  return unless input
   # must be wrapped in {}
-  input = "{#{input}}" unless input.start_with? '{'
+  input = "{#{input}}" unless input.start_with? '{' or input.start_with? '['
   # must be a json string or 1.9 hash format
   begin
     MultiJson.dump(eval(input))

data/lib/ugc/settings.rb

@@ -3,9 +3,10 @@ module Ugc
 
     SETTINGS_FILE = 'settings.yml'
 
-    def initialize(directory)
-      @file = File.join directory, SETTINGS_FILE
-      @settings = YAML.load_file(@file) rescue default_settings
+    def initialize(global_options)
+      @draw_table_border = global_options[:border]
+      @settings_file = File.join global_options[:settings], SETTINGS_FILE
+      @settings = YAML.load_file(@settings_file) rescue default_settings
     end
 
     def active_profile_name
@@ -15,14 +16,14 @@ module Ugc
     def active_profile_name=(name)
       raise "unknown profile: #{name}" unless profile(name)
       @settings['active_profile'] = name
-      save
+      save_profile
     end
 
     def delete_profile(name)
       raise "cannot delete active profile" if active_profile_name == name
       raise "unknown profile: #{name}" unless profiles[name]
       profiles.delete name
-      save
+      save_profile
     end
 
     def profile(name=nil)
@@ -71,20 +72,39 @@ module Ugc
       base_url && organization && application
     end
 
+    def table_border?
+      !!@draw_table_border
+    end
+
     def logged_in?
       !!access_token
     end
 
+    def save_profile_blob(name, data)
+      file = File.join settings_dir, "#{active_profile_name}.#{name}"
+      File.open(file, 'w') do |out|
+        out.write data
+      end
+    end
+
+    def load_profile_blob(name)
+      IO.read File.join settings_dir, "#{active_profile_name}.#{name}"
+    end
+
     private
 
     def set_profile(prop, value)
       profile[prop] = value
-      save
+      save_profile
+    end
+
+    def settings_dir
+      File.dirname(@settings_file)
     end
 
-    def save
-      Dir.mkdir(File.dirname(@file)) unless Dir.exist?(File.dirname(@file))
-      File.open(@file, 'w') do |out|
+    def save_profile
+      Dir.mkdir(settings_dir) unless Dir.exist?(settings_dir)
+      File.open(@settings_file, 'w') do |out|
         YAML.dump(@settings, out)
       end
     end

data/lib/ugc/version.rb

@@ -1,3 +1,3 @@
 module Ugc
-  VERSION = '0.0.6'
+  VERSION = '0.9.0'
 end

data/ugc.gemspec

@@ -19,7 +19,7 @@ spec = Gem::Specification.new do |s|
   s.add_development_dependency('rdoc')
   s.add_development_dependency('aruba')
   s.add_runtime_dependency('gli','2.5.0')
-  s.add_runtime_dependency('usergrid_iron')
+  s.add_runtime_dependency('usergrid_iron','>= 0.0.9')
   s.add_runtime_dependency('highline')
   s.add_runtime_dependency('command_line_reporter')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ugc
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-04 00:00:00.000000000 Z
+date: 2013-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -82,7 +82,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -90,7 +90,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.9
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
@@ -140,7 +140,6 @@ files:
 - README.rdoc
 - Rakefile
 - bin/ugc
-- examples.jpeg
 - features/step_definitions/ugc_steps.rb
 - features/support/env.rb
 - features/ugc.feature
@@ -155,8 +154,8 @@ files:
 - lib/ugc/commands/query.rb
 - lib/ugc/commands/target.rb
 - lib/ugc/helpers/format.rb
+- lib/ugc/helpers/history.rb
 - lib/ugc/helpers/parse.rb
-- lib/ugc/helpers/uri.rb
 - lib/ugc/management.rb
 - lib/ugc/settings.rb
 - lib/ugc/version.rb
@@ -184,7 +183,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2161769601695807419
+      hash: 1424632812538279797
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -193,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2161769601695807419
+      hash: 1424632812538279797
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24

data/lib/ugc/helpers/uri.rb

@@ -1,7 +0,0 @@
-def resource(uri)
-  if URI.parse(uri).host
-    Usergrid::Resource.new(uri, nil, $application.options) # absolute
-  else
-    $application[uri] # relative
-  end
-end