kenai_tools 0.0.7

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+# RubyMine per-user files http://devnet.jetbrains.net/docs/DOC-1192
+.idea/workspace.xml
+.idea/tasks.xml

data/.idea/.name

@@ -0,0 +1 @@
+kenai_tools

data/.idea/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake"><RakeTask description="Build kenai_tools-0.0.1.gem into the pkg directory" fullCmd="build" taksId="build" /><RakeTask description="Build and install kenai_tools-0.0.1.gem into system gems" fullCmd="install" taksId="install" /><RakeTask description="Create tag v0.0.1 and build and push kenai_tools-0.0.1.gem to Rubygems" fullCmd="release" taksId="release" /></RakeGroup></Settings>

data/.idea/encodings.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="Encoding" useUTFGuessing="true" native2AsciiForPropertiesFiles="false" />
+</project>
+

data/.idea/kenai_tools.iml

@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="GemRequirementsHolder" version="3">
+    <requirement>
+      <requirement>
+        <dependency name="highline" version="1.6" bound="LATEST_IN_BRANCH" git="false" path="false" doRequire="true" />
+      </requirement>
+      <source from="Gemfile" />
+    </requirement>
+    <requirement>
+      <requirement>
+        <dependency name="json" version="1.5" bound="LATEST_IN_BRANCH" git="false" path="false" doRequire="true" />
+      </requirement>
+      <source from="Gemfile" />
+    </requirement>
+    <requirement>
+      <requirement>
+        <dependency name="rest-client" version="1.6" bound="LATEST_IN_BRANCH" git="false" path="false" doRequire="true" />
+      </requirement>
+      <source from="Gemfile" />
+    </requirement>
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec (v2.5.0, RVM: ruby-1.8.7-p302 [kenai_tools]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rest-client (v1.6.3, RVM: ruby-1.8.7-p302 [kenai_tools]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v2.5.2, RVM: ruby-1.8.7-p302 [kenai_tools]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.1.2, RVM: ruby-1.8.7-p302 [kenai_tools]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="highline (v1.6.2, RVM: ruby-1.8.7-p302 [kenai_tools]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v1.0.12, RVM: ruby-1.8.7-p302 [kenai_tools]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="mime-types (v1.16, RVM: ruby-1.8.7-p302 [kenai_tools]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="json (v1.5.3, RVM: ruby-1.8.7-p302 [kenai_tools]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="gemcutter (v0.7.0, RVM: ruby-1.8.7-p302 [kenai_tools]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v2.5.0, RVM: ruby-1.8.7-p302 [kenai_tools]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v2.5.0, RVM: ruby-1.8.7-p302 [kenai_tools]) [gem]" level="application" />
+  </component>
+</module>
+

data/.idea/misc.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="DependencyValidationManager">
+    <option name="SKIP_IMPORT_STATEMENTS" value="false" />
+  </component>
+  <component name="ProjectRootManager" version="2" project-jdk-name="RVM: ruby-1.8.7-p302 [kenai_tools]" project-jdk-type="RUBY_SDK" />
+</project>
+

data/.idea/modules.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/kenai_tools.iml" filepath="$PROJECT_DIR$/.idea/kenai_tools.iml" />
+    </modules>
+  </component>
+</project>
+

data/.idea/vcs.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in kenai_tools.gemspec
+gemspec

data/README.md

@@ -0,0 +1,28 @@
+# Kenai Tools
+
+## Description
+
+The kenai_tools gem provides command line tools to access web services for
+web sites that are hosted on the Kenai application platform. Currently,
+there is a dlutil tool that project admins can use to manage the downloads
+feature of a project. For example, they can perform bulk uploads and
+downloads of files to a site hosted on Kenai such as java.net.
+
+## Installation
+
+$ gem install kenai_tools
+
+or
+
+$ sudo gem install kenai_tools
+
+## Usage and documentation
+
+Please see the command usage information.
+
+$ dlutil --help
+
+## Problems
+
+Some dlutil commands do not work on Windows so a unix-based OS is
+recommended.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/dlutil

@@ -0,0 +1,139 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require "bundler/setup"
+
+$LOAD_PATH << File.dirname(__FILE__) + '/../lib'
+require 'ostruct'
+require 'optparse'
+require 'highline/import'
+require 'kenai_tools'
+
+PROGRAM = File.basename(__FILE__)
+
+# Array of command info. Keys are
+# :name = command line name
+# :call = name of method to call instead of :name, if specified
+# :result = method produces a result
+# :login = method requires authentication
+# :core = core, i.e. main command
+COMMANDS = [{:name => :ping, :result => true, :core => true},
+  {:name => :login, :call => :ping, :login => true, :result => true, :core => true},
+  {:name => :pull, :core => true},
+  {:name => :push, :login => true, :core => true},
+  {:name => :exist?, :result => true},
+  {:name => :entry_type, :result => true},
+  {:name => :mkdir, :login => true},
+  {:name => :rmdir, :login => true, :result => nil},
+  {:name => :rm, :login => true},
+  {:name => :rm_r, :login => true},
+  {:name => :delete_feature, :login => true},
+  {:name => :get_or_create, :login => true, :result => true},
+  {:name => :downloads_name, :result => true},
+  {:name => :downloads_feature, :result => true},
+  {:name => :ls, :result => true}]
+
+options = OpenStruct.new
+@opts = OptionParser.new do |opts|
+  opts.banner = "Usage: #{PROGRAM} [options] COMMAND [args] ..."
+
+  def wrap(s, width = 78)
+    s.gsub(/(.{1,#{width}})(\s+|\Z)/, "\\1\n")
+  end
+
+  str = COMMANDS.select { |info| info[:core] }.map { |info| info[:name] }.join(', ')
+  opts.separator "Main commands: #{wrap(str)}"
+  str = COMMANDS.reject { |info| info[:core] }.map { |info| info[:name] }.join(', ')
+  opts.separator "Other commands: #{wrap(str)}"
+  opts.separator "Note: Unix OS is recommended as some commands fail on Windows"
+  opts.separator "Examples:"
+  opts.separator "  #{PROGRAM} -r kenai.com,my-project pull / my-project-downloads"
+  opts.separator "  #{PROGRAM} -r java.net,my-project push dist/ /version-3.1"
+  opts.separator "  #{PROGRAM} -r java.net,my-project push toolkit-1.2.3.jar /"
+  opts.separator "  #{PROGRAM} -r java.net,glassfish login"
+  opts.separator "  #{PROGRAM} -r java.net,my-project rm /toolkit-1.2.3.jar"
+  opts.separator "  #{PROGRAM} -r java.net,my-project rm_r /version-3.1"
+  opts.separator ""
+  opts.separator "Specific options:"
+
+  def to_url(host_or_url)
+    host_or_url =~ %r{^http(s?)://} ? host_or_url : "https://#{host_or_url}/"
+  end
+
+  opts.on("-r", "--remote ENDPOINT_SPEC", "Remote endpoint SITE,PROJECT,[DOWNLOADS_NAME]",
+    "  SITE may be simply HOST or http(s)?://HOST:PORT") do |v|
+    host, project, downloads_name = v.split(',')
+    options.remote_valid = host && project
+    options.host_url = to_url(host)
+    options.project = project
+    options.downloads_name = downloads_name
+  end
+
+  opts.on("-p", "--password-file FILE", "Read username/password (nl-separated) from FILE") do |v|
+    options.password_file = v
+  end
+
+  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+    options.verbose = v
+  end
+
+  opts.on("-t", "--timeout SECS", "Timeout in seconds") do |v|
+    options.timeout = v
+  end
+
+  opts.on("--cloak-password PASSWORD", "Cloaking password") do |v|
+    options.cloak_password = v
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end
+
+def usage
+  puts @opts
+  exit 1
+end
+
+begin
+  @opts.parse!
+rescue
+  usage
+end
+
+usage unless command = ARGV.shift and
+  cmd_info = COMMANDS.find { |info| info[:name] == command.to_sym } and
+  options.remote_valid
+
+def get_credentials(options, dlc_opts)
+  user, password = nil
+  if options.password_file
+    File.open(options.password_file) do |f|
+      user, password = f.read.split
+    end
+  else
+    say "Please enter your login credentials for #{options.host_url}"
+    user = ask('Username: ')
+    password = ask('Password: ') { |q| q.echo = '*' }
+  end
+  if user
+    dlc_opts[:user] = user
+    dlc_opts[:password] = password
+  end
+end
+
+dlc_opts = {:downloads_name => options.downloads_name}
+if cmd_info[:login]
+  get_credentials(options, dlc_opts)
+end
+dlc_opts[:timeout] = options.timeout if options.timeout
+dlc_opts[:cloak_password] = options.cloak_password if options.cloak_password
+dlc_opts[:log] = $stderr if options.verbose
+dlclient = KenaiTools::DownloadsClient.new(options.host_url, options.project, dlc_opts)
+
+method_name = cmd_info[:call] ? cmd_info[:call] : cmd_info[:name]
+result = dlclient.send(method_name, *ARGV)
+if cmd_info[:result]
+  puts String === result ? result : result.inspect
+end

data/kenai_tools.gemspec

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "kenai_tools/version"
+
+Gem::Specification.new do |s|
+  s.name        = "kenai_tools"
+  s.version     = KenaiTools::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Edwin Goei", "Project Kenai Team"]
+  s.email       = ["edwin.goei@oracle.com"]
+  s.homepage    = "http://kenai.com/projects/kenaiapis"
+  s.summary     = %q{Tools for sites hosted on the Kenai platform. Use dlutil to upload and download files.}
+  s.description = %q{Tools for sites such as java.net that are hosted on the Kenai platform. Use dlutil to upload and download files.}
+  s.post_install_message = %q{
+==============================================================================
+
+Thanks for installing kenai_tools. Run the following command for what to do
+next:
+
+  dlutil --help
+
+Warning: this tool is not yet supported on Windows. Please use a unix-based
+OS. For more info, see http://kenai.com/jira/browse/KENAI-2853.
+
+==============================================================================
+
+
+}
+
+  s.rubyforge_project = "kenai_tools"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency("rspec", "~> 2.5")
+  s.add_development_dependency("bundler", "~> 1.0")
+  s.add_development_dependency("gemcutter")
+  s.add_dependency("rest-client", "~> 1.6")
+  s.add_dependency("json", "~> 1.5")
+  s.add_dependency("highline", "~> 1.6")
+end

data/lib/kenai_tools/downloads_client.rb

@@ -0,0 +1,241 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'forwardable'
+require 'rest_client'
+
+module KenaiTools
+  # Path arguments to public methods of this API work with Pathname objects as well as Strings
+  class DownloadsClient
+    CONTENT_TYPE_KENAI_ENTRIES = "application/vnd.com.kenai.entries+json"
+
+    extend Forwardable
+    def_delegators :@kc, :authenticate, :authenticated?
+
+    attr_accessor :project, :cloak_password
+
+    #
+    # Local options are :downloads_name, :log, :cloak_password
+    # Other options such as :timeout are forwarded
+    # DownloadClient.new("https://kenai.com/", "jruby")
+    # DownloadClient.new("https://testkenai.com/", "my-project", :downloads_name => 'downloads2', :log => $stderr
+    #  :timeout => 36000, :cloak_password => 'a_secret')
+    #
+    def initialize(site, project, opts = {})
+      @site = site
+      @project = project
+      @specified_downloads_name = opts.delete(:downloads_name)
+      @cloak_password = opts.delete(:cloak_password)
+      RestClient.log = opts.delete(:log)
+      @kc = KenaiClient.new(site, opts)
+    end
+
+    def get_or_create
+      unless ping
+        @specified_downloads_name = "downloads" unless @specified_downloads_name
+        params = {:feature => {:name => @specified_downloads_name, :service => "downloads",
+          :display_name => @specified_downloads_name.capitalize}}
+        @kc["projects/#{project}/features"].post(params, :content_type => 'application/json')
+      end
+      downloads_name
+    end
+
+    def delete_feature(confirm = nil)
+      unless confirm == 'yes'
+        fail "Confirm delete project downloads feature with an argument of 'yes'"
+      else
+        # Flush cache
+        orig_downloads_name = downloads_name
+        @downloads_feature = @downloads_name = nil
+        @kc["projects/#{project}/features/#{orig_downloads_name}"].delete
+      end
+    end
+
+    #
+    # Returns the specified downloads feature if found, or a discovered one
+    # if the project only has one
+    #
+    def downloads_feature
+      @downloads_feature ||= begin
+        project = @kc.project(@project)
+        features = project && project['features']
+        if downloads_features = features && features.select { |f| f['type'] == 'downloads' }
+          if @specified_downloads_name
+            downloads_features.detect { |f| f['name'] == @specified_downloads_name }
+          elsif downloads_features.size == 1
+            downloads_features.first
+          else
+            nil
+          end
+        else
+          nil
+        end
+      end
+    end
+
+    def downloads_name
+      @downloads_name ||= downloads_feature && downloads_feature['name']
+    end
+
+    alias_method :ping, :downloads_name
+
+    def ls(path = '/')
+      entry(path)
+    end
+
+    def exist?(path = '/')
+      !!entry(path)
+    end
+
+    def entry_type(path)
+      if h = entry(path)
+        h['entry_type']
+      end
+    end
+
+    #
+    # Pull a remote file or directory hierarchy to the local host. Use
+    # +remote_path+ to specify the remote file or directory hierarchy to
+    # download. If +remote_path+ is '/', download all content. Use
+    # +local_dest_dir+ to specify the target location for the content which
+    # defaults to the current directory.
+    #
+    # For example:
+    #   dlclient.pull('version-1.9')
+    #   dlclient.pull('version-1.9', '/tmp/project_downloads')
+    #
+    def pull(remote_path, local_dest_dir = '.')
+      dest = Pathname(local_dest_dir)
+      fail "Destination must be a directory" unless dest.directory?
+      remote_pn = clean_id_pn(remote_path)
+      if ent = entry(remote_pn)
+        display_name = ent['display_name']
+        basename = display_name == '/' ? '.' : display_name
+        local_path = dest + basename
+        case ent['entry_type']
+        when 'directory'
+          local_path.mkdir unless local_path.exist?
+          ent['children'].each do |ch|
+            remote_child = remote_pn + ch['display_name']
+            pull(remote_child, local_path)
+          end
+        when 'file'
+          content = get_cloaked_url(ent['content_url'])
+          local_path.open("w") { |f| f.write(content) }
+        else
+          puts "Warning: skipping unsupported entry type"
+        end
+      else
+        puts "Unknown downloads entry: #{remote_pn}"
+      end
+    end
+
+    #
+    # Push a local file or directory hierarchy to the server. Use
+    # +local_path+ path to specify the local file or directory to upload. If
+    # +local_path+ is a directory that ends in '/', upload the contents of
+    # that directory instead of the directory and its contents. Use
+    # +remote_dir+ to specify the remote directory to upload to.
+    #
+    # For example:
+    #   dlclient.push('version-1.9')
+    #   dlclient.push('dist', '/version-1.9')
+    #
+    def push(local_path, remote_dir = '/', opts = {})
+      src = Pathname(local_path)
+      if src.directory?
+        if src.to_s.end_with?('/')
+          target_dir = remote_dir
+        else
+          target_dir = Pathname(remote_dir) + src.basename
+          mkdir(target_dir)
+        end
+        src.children.each do |ch|
+          push(ch, target_dir)
+        end
+      else
+        remote_id = Pathname(remote_dir) + src.basename
+        entry = {:content_data => File.new(src)}.merge(opts)
+        begin
+        @kc[entry_api_path(remote_id)].put(:entry => entry)
+        rescue => ex
+          err_msg = "Error: unable to upload to target '#{remote_id}'"
+          if server_msg = extract_error_message(ex)
+            err_msg += ": #{server_msg}"
+          end
+          $stderr.puts err_msg
+          raise ex
+        end
+      end
+    end
+
+    def mkdir(dir, opts = {})
+      path = Pathname(dir)
+      entry = {:display_name => path.basename}
+      entry.merge(opts)
+      @kc[entry_api_path(path)].put(:entry => entry)
+    end
+
+    def rm_r(path)
+      @kc[entry_api_path(path)].delete
+    end
+
+    def rm(path)
+      if entry_type(path) == 'directory'
+        fail "Entry is a directory: #{path}"
+      else
+        @kc[entry_api_path(path)].delete
+      end
+    end
+
+    def rmdir(path)
+      entry = entry(path)
+      if entry['entry_type'] == 'directory'
+        if entry['children'].size == 0
+          @kc[entry_api_path(path)].delete
+        else
+          fail "Directory not empty: #{path}"
+        end
+      else
+        fail "Not a directory: #{path}"
+      end
+    end
+
+    private
+
+    # Canonicalize an entry id and return a relative Pathname or root Pathname
+    def clean_id_pn(remote_path)
+      remote_pn = Pathname(remote_path)
+      root = Pathname('/')
+      if remote_pn.absolute? && remote_pn != root
+        remote_pn.relative_path_from(root)
+      else
+        remote_pn
+      end
+    end
+
+    def entry_api_path(id)
+      fail "Downloads feature not found" unless downloads_name
+      escaped_id = URI.escape(clean_id_pn(id).to_s)
+      "projects/#{@project}/features/#{downloads_name}/entries/#{escaped_id}"
+    end
+
+    def entry(path)
+      begin
+        resource = @kc[entry_api_path(path)].get
+      rescue RestClient::ResourceNotFound => err
+        return nil
+      end
+      JSON.parse(resource)
+    end
+
+    def get_cloaked_url(url)
+      opts = @cloak_password ? {:user => "dont_care", :password => @cloak_password} : {}
+      RestClient::Resource.new(url, opts).get
+    end
+
+    def extract_error_message(ex)
+      ex.response if ex.respond_to?(:response)
+    end
+  end
+end