ugc 0.0.1 → 0.0.2

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm_gemset_create_on_use_flag=1
+rvm gemset use 'ugc'

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/README.md

@@ -0,0 +1,31 @@
+# Usergrid Command Line (ugc)
+
+ugc enables convenient terminal access to Apigee's App Services (aka Usergrid).
+
+## Installation
+
+    $ gem install ugc
+
+## Usage
+
+### Help
+
+    $ ugc help
+
+### Setup
+
+Connect to an Apigee administrator account:
+
+	$ ugc profile apigee
+	$ ugc target organization scottganyo
+	organization = scottganyo
+	$ ugc target app messagee
+	application = messagee
+	$ ugc login -a scott@ganyo.com
+	password: **********
+	logged in user: scott@ganyo.com
+	
+
+### Examples
+
+![image](https://github.com/scottganyo/ugc/raw/master/examples.jpeg)

data/Rakefile

@@ -0,0 +1,46 @@
+require "bundler/gem_tasks"
+
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'
+require 'cucumber'
+require 'cucumber/rake/task'
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  rd.title = 'Your application title'
+end
+
+spec = eval(File.read('ugc.gemspec'))
+
+Gem::PackageTask.new(spec) do |pkg|
+end
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+desc 'Run features'
+Cucumber::Rake::Task.new(:features) do |t|
+  opts = "features --format html -o #{CUKE_RESULTS} --format progress -x"
+  opts += " --tags #{ENV['TAGS']}" if ENV['TAGS']
+  t.cucumber_opts =  opts
+  t.fork = false
+end
+
+desc 'Run features tagged as work-in-progress (@wip)'
+Cucumber::Rake::Task.new('features:wip') do |t|
+  tag_opts = ' --tags ~@pending'
+  tag_opts = ' --tags @wip'
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty -x -s#{tag_opts}"
+  t.fork = false
+end
+
+task :cucumber => :features
+task 'cucumber:wip' => 'features:wip'
+task :wip => 'features:wip'
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+end
+
+task :default => [:test,:features]

data/features/step_definitions/ugc_steps.rb

@@ -0,0 +1,6 @@
+When /^I get help for "([^"]*)"$/ do |app_name|
+  @app_name = app_name
+  step %(I run `#{app_name} help`)
+end
+
+# Add more step definitions here

data/features/support/env.rb

@@ -0,0 +1,15 @@
+require 'aruba/cucumber'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+end

data/features/ugc.feature

@@ -0,0 +1,8 @@
+Feature: My bootstrapped app kinda works
+  In order to get going on coding my awesome app
+  I want to have aruba and cucumber setup
+  So I don't have to do it myself
+
+  Scenario: App just runs
+    When I get help for "ugc"
+    Then the exit status should be 0

data/lib/ugc/application.rb

@@ -0,0 +1,25 @@
+module Ugc
+  class Application < Usergrid::Application
+
+    def initialize
+      super application_url
+      self.auth_token = $settings.access_token
+    end
+
+    def application_url
+      url = $settings.base_url
+      org = $settings.organization
+      app = $settings.application
+
+      raise "not configured" unless url && org && app
+
+      concat_urls url, "#{org}/#{app}"
+    end
+
+    def login(username, password)
+      super username, password
+      $settings.access_token = auth_token
+    end
+
+  end
+end

data/lib/ugc/commands/delete.rb

@@ -0,0 +1,10 @@
+desc 'http delete'
+arg_name 'url'
+
+command :delete do |c|
+
+  c.action do |global_options,options,args|
+    format_result resource(args[0]).delete
+  end
+
+end

data/lib/ugc/commands/get.rb

@@ -0,0 +1,10 @@
+desc 'http get'
+arg_name 'url'
+
+command :get do |c|
+
+  c.action do |global_options,options,args|
+    format_result resource(args[0]).get
+  end
+
+end

data/lib/ugc/commands/list.rb

@@ -0,0 +1,47 @@
+desc 'list'
+command :ls,:list do |c|
+
+  c.desc 'collections'
+  c.command [:collections] do |c2|
+
+    c2.action do |global_options,options,args|
+      app = $application.entity
+      collections = app['metadata']['collections']
+      table border: true do
+        row header: true do
+          collections.first[1].each_key do |k|
+            column k
+          end
+        end
+        collections.each_value do |coll|
+          row do
+            coll.each_value do |v|
+              column v
+            end
+          end
+        end
+      end
+    end
+  end
+
+  default_names = %w(assets users events roles folders activities devices groups)
+  default_names.each do |e|
+    c.desc e
+    c.command [e.to_sym] do |c2|
+      c2.action do |global_options,options,args|
+        format_collection($application[e].collection)
+      end
+    end
+  end
+
+  c.desc 'whatevers'
+  c.command [:whatevers] do |c2|
+    c2.action do |global_options,options,args|
+      whatevers = $application[args[0]].collection
+      format_collection(whatevers)
+    end
+  end
+
+  c.default_command :whatevers
+
+end

data/lib/ugc/commands/login.rb

@@ -0,0 +1,28 @@
+require 'io/console'
+
+desc 'Describe login here'
+arg_name 'username'
+
+command :login do |c|
+
+  c.switch [:a,:admin]
+  c.action do |global_options,options,args|
+
+    if args[0]
+      password = ask('password: ') { |q| q.echo = '*' }
+
+      if password
+        if options[:admin]
+          management = Ugc::Management.new
+          management.login args[0], password
+        else
+          application = Ugc::Application.new
+          application.login args[0], password
+        end
+      end
+      puts "logged in user: #{args[0]}"
+    else
+      raise 'username required'
+    end
+  end
+end

data/lib/ugc/commands/post.rb

@@ -0,0 +1,11 @@
+desc 'http post'
+arg_name 'url [data]'
+
+command :post do |c|
+  c.flag [:d,:data]
+
+  c.action do |global_options,options,args|
+    format_result resource(args[0]).post (options[:data] || args[1])
+  end
+
+end

data/lib/ugc/commands/profile.rb

@@ -0,0 +1,32 @@
+desc 'set the current profile'
+arg_name 'profile name'
+
+command :profile,:profiles do |c|
+  c.switch :d,:delete
+  c.action do |global_options,options,args|
+    if args[0]
+      if options[:delete]
+        $settings.delete_profile args[0]
+        puts "Deleted profile: " + args[0]
+      else
+        $settings.active_profile_name = args[0]
+        puts 'Set active profile:'
+        show_profile(args[0])
+      end
+    else
+      puts "Saved profiles:"
+      $settings.profiles.each_key do |name|
+        show_profile(name)
+      end
+    end
+  end
+end
+
+def show_profile(name)
+  profile = $settings.profile(name)
+  print $settings.active_profile_name == name ? ' *' : '  '
+  puts name
+  $settings.profile(name).each_pair do |k,v|
+    puts "    #{k}: #{v}"
+  end
+end

data/lib/ugc/commands/put.rb

@@ -0,0 +1,11 @@
+desc 'http put'
+arg_name 'url [data]'
+
+command :put do |c|
+  c.flag [:d,:data]
+
+  c.action do |global_options,options,args|
+    format_result resource(args[0]).put (options[:data] || args[1])
+  end
+
+end

data/lib/ugc/commands/query.rb

@@ -0,0 +1,54 @@
+desc 'query'
+long_desc 'note: query may contain a "from" clause instead of specifying collection_name'
+arg_name '[collection_name] query'
+
+command :query do |c|
+  c.action do |global_options,options,args|
+
+    case args.size
+      when 2
+        type = args[0]
+        query = args[1]
+      when 1
+        query = args[0]
+      else
+        help_now!
+    end
+
+    parsed_query = parse_sql query
+
+    if type == nil && parsed_query['from']
+      type = parsed_query['from']
+      query.gsub! /from\s+#{type}/i, ''
+    end
+
+    result = $application[type].query query
+
+    collection = result.collection
+    format_collection collection, parsed_query['select']
+  end
+
+end
+
+def parse_sql(query)
+  result = {}
+  keywords = %w(select from where)
+  current = nil
+  query.downcase.split(/[\s,*]/).each do |ea|
+    next if ea == ''
+    if keywords.include? ea
+      current = ea
+    elsif current
+      if result[current]
+        if result[current].is_a? Array
+          result[current] << ea
+        else
+          result[current] = [result[current]] << ea
+        end
+      else
+        result[current] = ea
+      end
+    end
+  end
+  result
+end

data/lib/ugc/commands/target.rb

@@ -0,0 +1,47 @@
+desc 'set the base url, org, and app'
+
+command :target do |c|
+
+  c.desc 'set base url'
+  c.command [:base,:base_url] do |ep|
+    ep.action do |global_options,options,args|
+      $settings.base_url = args[0]
+      puts "base_url = #{$settings.base_url}"
+    end
+  end
+
+  c.desc 'set organization'
+  c.command [:org,:organization] do |ep|
+    ep.action do |global_options,options,args|
+      $settings.organization = args[0]
+      puts "organization = #{$settings.organization}"
+    end
+  end
+
+  c.desc 'set application'
+  c.command [:app,:application] do |ep|
+    ep.action do |global_options,options,args|
+      $settings.application = args[0]
+      puts "application = #{$settings.application}"
+    end
+  end
+
+  c.desc 'set full url - parses base, org, and app'
+  c.command [:url] do |url|
+    url.action do |global_options,options,args|
+      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]
+        $settings.base_url = base_url
+        $settings.organization = org_name
+        $settings.application = app_name
+      end
+      puts "base_url = #{$settings.base_url}"
+      puts "organization = #{$settings.organization}"
+      puts "application = #{$settings.application}"
+    end
+  end
+
+  c.default_command :url
+end

data/lib/ugc/helpers/formatters.rb

@@ -0,0 +1,91 @@
+SKIP_ATTRS = %w(metadata uri type)
+
+def format_result(result)
+  if result.multiple_entities? && result.collection.size > 1
+    format_collection(result.collection)
+  else
+    format_entity(result.entity)
+  end
+end
+
+INDEX_COL_WIDTH = 2
+COL_OVERHEAD = 3
+
+def format_collection(collection, headers=nil)
+  if collection && collection.size > 0
+    table border: true do
+      row header: true do
+        headers ||= collection.first.keys.reject{|e| SKIP_ATTRS.include? e}
+        column '#', width: INDEX_COL_WIDTH
+        headers.each do |r|
+          column r, width: equal_column_size(headers.size)
+        end
+      end
+      collection.each_with_index do |entity, index|
+        row do
+          column index
+          if entity.is_a? Array
+            entity.each do |v|
+              column v
+            end
+          else
+            entity.reject{|k,v| SKIP_ATTRS.include? k}.each_value do |v|
+              column v
+            end
+          end
+        end
+      end
+    end
+  else
+    puts "0 results"
+  end
+end
+
+def format_entity(entity)
+  if entity
+    table border: true do
+      row header: true do
+        column 'name', width: 20
+        column 'value', width: (terminal_columns - 28)
+      end
+      entity.data.reject{|k,v| SKIP_ATTRS.include? k}.each do |k,v|
+        row do
+          column(k)
+          column(v)
+        end
+      end
+    end
+  else
+    puts "no data"
+  end
+end
+
+def equal_column_size(num_cols)
+  ((terminal_columns - COL_OVERHEAD - (INDEX_COL_WIDTH + COL_OVERHEAD)) / num_cols).to_i - COL_OVERHEAD
+end
+
+def terminal_columns
+  size = detect_terminal_size
+  size ? size[0] : 80
+end
+
+# Returns [width, height] of terminal when detected, nil if not detected.
+# Think of this as a simpler version of Highline's Highline::SystemExtensions.terminal_size()
+def detect_terminal_size
+  if (ENV['COLUMNS'] =~ /^\d+$/) && (ENV['LINES'] =~ /^\d+$/)
+    [ENV['COLUMNS'].to_i, ENV['LINES'].to_i]
+  elsif (RUBY_PLATFORM =~ /java/ || (!STDIN.tty? && ENV['TERM'])) && command_exists?('tput')
+    [`tput cols`.to_i, `tput lines`.to_i]
+  elsif STDIN.tty? && command_exists?('stty')
+    `stty size`.scan(/\d+/).map { |s| s.to_i }.reverse
+  else
+    nil
+  end
+rescue
+  nil
+end
+
+# Determines if a shell command exists by searching for it in ENV['PATH'].
+def command_exists?(command)
+  ENV['PATH'].split(File::PATH_SEPARATOR).any? {|d| File.exists? File.join(d, command) }
+end

data/lib/ugc/helpers/uri.rb

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

data/lib/ugc/management.rb

@@ -0,0 +1,20 @@
+module Ugc
+  class Management < Usergrid::Management
+
+    def initialize
+      super management_url
+      auth_token = $settings.access_token
+    end
+
+    def management_url
+      raise "not configured" unless $settings.base_url
+      $settings.base_url
+    end
+
+    def login(username, password)
+      super username, password
+      $settings.access_token = auth_token
+    end
+
+  end
+end

data/lib/ugc/settings.rb

@@ -0,0 +1,110 @@
+module Ugc
+  class Settings
+
+    SETTINGS_FILE = 'settings.yml'
+
+    def initialize(directory)
+      @file = File.join directory, SETTINGS_FILE
+      @settings = YAML.load_file(@file) rescue default_settings
+    end
+
+    def active_profile_name
+      @settings['active_profile'] || 'local'
+    end
+
+    def active_profile_name=(name)
+      raise "unknown profile: #{name}" unless profile(name)
+      @settings['active_profile'] = name
+      save
+    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
+    end
+
+    def profile(name=nil)
+      name ||= active_profile_name
+      profiles[name] || profiles[name] = {}
+    end
+
+    def profiles
+      @settings['profiles'] || @settings['profiles'] = {}
+    end
+
+    def base_url
+      profile['base_url']
+    end
+
+    def base_url=(url)
+      URI.parse url
+      set_profile 'base_url', url
+    end
+
+    def organization
+      profile['organization']
+    end
+
+    def organization=(org)
+      set_profile 'organization', org
+    end
+
+    def application
+      profile['application']
+    end
+
+    def application=(app)
+      set_profile 'application', app
+    end
+
+    def access_token
+      profile['access_token']
+    end
+
+    def access_token=(token)
+      set_profile 'access_token', token
+    end
+
+    def configured?
+      base_url && organization && application
+    end
+
+    def logged_in?
+      !!access_token
+    end
+
+    private
+
+    def set_profile(prop, value)
+      profile[prop] = value
+      save
+    end
+
+    def save
+      Dir.mkdir(File.dirname(@file)) unless Dir.exist?(File.dirname(@file))
+      File.open(@file, 'w') do |out|
+        YAML.dump(@settings, out)
+      end
+    end
+
+    def default_settings
+      {
+        'target' => 'https://api.usergrid.com',
+        'active_profile' => 'local',
+        'profiles' => {
+          'local' => {
+              'base_url' => 'http://localhost:8080',
+              'organization' => 'test-organization',
+              'application' => 'test-app'
+          },
+          'apigee' => {
+            'base_url' => 'https://api.usergrid.com'
+          }
+        }
+      }
+    end
+
+  end
+end

data/lib/ugc/version.rb

@@ -1,3 +1,3 @@
 module Ugc
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/test/default_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+class DefaultTest < Test::Unit::TestCase
+
+  def setup
+  end
+
+  def teardown
+  end
+
+  def test_the_truth
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'test/unit'
+
+# Add test libraries you want to use here, e.g. mocha
+
+class Test::Unit::TestCase
+
+  # Add global extensions to the test case class here
+  
+end

data/ugc.gemspec

@@ -0,0 +1,25 @@
+# Ensure we require the local version and not one we might have installed already
+require File.join([File.dirname(__FILE__),'lib','ugc','version.rb'])
+spec = Gem::Specification.new do |s| 
+  s.name = 'ugc'
+  s.version = Ugc::VERSION
+  s.author = 'Scott Ganyo'
+  s.email = 'scott@ganyo.com'
+  s.homepage = 'http://ganyo.com'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'Usergrid Command Line'
+  s.files = `git ls-files`.split($\)
+  s.require_paths << 'lib'
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README.rdoc','ugc.rdoc']
+  s.rdoc_options << '--title' << 'ugc' << '--main' << 'README.rdoc' << '-ri'
+  s.bindir = 'bin'
+  s.executables << 'ugc'
+  s.add_development_dependency('rake')
+  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('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.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -132,10 +132,36 @@ extra_rdoc_files:
 - README.rdoc
 - ugc.rdoc
 files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.md
+- README.rdoc
+- Rakefile
 - bin/ugc
-- lib/ugc/version.rb
+- examples.jpeg
+- features/step_definitions/ugc_steps.rb
+- features/support/env.rb
+- features/ugc.feature
 - lib/ugc.rb
-- README.rdoc
+- lib/ugc/application.rb
+- lib/ugc/commands/delete.rb
+- lib/ugc/commands/get.rb
+- lib/ugc/commands/list.rb
+- lib/ugc/commands/login.rb
+- lib/ugc/commands/post.rb
+- lib/ugc/commands/profile.rb
+- lib/ugc/commands/put.rb
+- lib/ugc/commands/query.rb
+- lib/ugc/commands/target.rb
+- lib/ugc/helpers/formatters.rb
+- lib/ugc/helpers/uri.rb
+- lib/ugc/management.rb
+- lib/ugc/settings.rb
+- lib/ugc/version.rb
+- test/default_test.rb
+- test/test_helper.rb
+- ugc.gemspec
 - ugc.rdoc
 homepage: http://ganyo.com
 licenses: []
@@ -157,7 +183,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2484694068275381343
+      hash: -2123078772774079119
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -166,11 +192,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2484694068275381343
+      hash: -2123078772774079119
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Usergrid Explorer
+summary: Usergrid Command Line
 test_files: []