kenai_tools 1.0.0 → 1.0.1

data/bin/wiki-copy

@@ -0,0 +1,201 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+$LOAD_PATH << File.dirname(__FILE__) + '/../lib'
+require 'optparse'
+require 'highline/import'
+require 'kenai_tools'
+
+$terminal = HighLine.new($stdin, $stderr)
+
+def fail(message, exit_code = 2)
+  $stderr.puts(message)
+  exit exit_code
+end
+
+def check_project(kc, url, proj_name)
+  fail "Unable to find project '#{proj_name}' at #{url}" unless kc.project(proj_name)
+end
+
+def to_url(host_or_url)
+  host_or_url =~ %r{^http(s?)://} ? host_or_url : "https://#{host_or_url}/"
+end
+
+def copy_images(src_client, src_proj, dst_client, dst_proj)
+  if on_page = @options[:on_page]
+    images = src_client.wiki_images(src_proj, on_page)
+    puts "Found #{images.size} source wiki images on page #{on_page}"
+  else
+    images = src_client.wiki_images(src_proj)
+    puts "Found #{images.size} source wiki images"
+  end
+
+  images.each do |image|
+    filename = image['filename']
+    print "Copying wiki image #{filename}..."
+    image_data = src_client.wiki_image_data(image)
+    unless @options[:dry_run]
+      tries = 0
+      begin
+        tries += 1
+        dst_client.create_or_update_wiki_image(dst_proj, :image_data => image_data,
+          :content_type => image['image_content_type'], :filename => filename,
+          :comments => image['comments'])
+      rescue IOError => ex
+        if (tries < 4)
+          print "  retrying..."
+          sleep(2**tries) # Wait for 2, 4, or 8 secs
+          retry
+        end
+      end
+    end
+    puts "done"
+  end
+end
+
+def copy_pages(src_client, src_proj, dst_client, dst_proj)
+  if on_page = @options[:on_page]
+    pages = src_client.wiki_pages(src_proj, on_page)
+    puts "Found #{pages.size} source wiki pages on page #{on_page}"
+  else
+    pages = src_client.wiki_pages(src_proj)
+    puts "Found #{pages.size} source wiki pages"
+  end
+
+  pages.each do |page|
+    page_name = page['name']
+    print "Copying page #{page_name}..."
+    contents = src_client.wiki_page(src_proj, page_name)['text']
+    unless @options[:dry_run]
+      dst_client.edit_wiki_page(dst_proj, page_name) { |s| contents }
+    end
+    puts "done"
+  end
+end
+
+def usage
+  puts @opts
+  exit 1
+end
+
+def parse_endpoint_spec(spec, type)
+  usage unless spec
+  host, project = spec.split(',')
+  fail "Bad #{type}_ENDPOINT: PROJECT not specified" unless project
+  [host, project]
+end
+
+def get_credentials(option, url)
+  user, password = nil
+  if option[:prompt]
+    say "Please enter your login credentials for #{url}"
+    user = ask('Username: ')
+    password = ask('Password: ') { |q| q.echo = '*' }
+  else
+    File.open(option[:file]) do |f|
+      user, password = f.read.split
+    end
+  end
+  [user, password]
+end
+
+def main
+  program = File.basename(__FILE__)
+  @options = {}
+  @opts = OptionParser.new do |opts|
+    opts.banner = "Usage: #{program} [options] SRC_ENDPOINT DST_ENDPOINT"
+    opts.separator "  where ENDPOINT is HOST,PROJECT"
+    opts.separator "Note: unix-like OS is recommended as this tool may fail on Windows"
+    opts.separator "Examples:"
+    opts.separator "  #{program} kenai.com,my-project java.net,my-project"
+    opts.separator "  #{program} --text-only kenai.com,my-project java.net,my-project"
+    opts.separator ""
+    opts.separator "Specific options:"
+
+    opts.on("-p", "--password FILE", "Read DST nl-separated username/password from file") do |v|
+      @options[:password] = {:prompt => !v, :file => v}
+    end
+
+    opts.on("-s", "--source-password [FILE]", "Prompt or read SRC username/password from file") do |v|
+      @options[:source_password] = {:prompt => !v, :file => v}
+    end
+
+    opts.on("--images-only", "Copy images only") do |v|
+      @options[:images_only] = v
+    end
+
+    opts.on("--text-only", "Copy text only") do |v|
+      @options[:text_only] = v
+    end
+
+    opts.on("-n", "--dry-run", "No writes, dry run only") do |v|
+      @options[:dry_run] = v
+    end
+
+    opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+      @options[:verbose] = v
+    end
+
+    opts.on_tail("--on-page API_PAGE", "Copy only text or images on API_PAGE") do |v|
+      @options[:on_page] = v
+    end
+
+    opts.on_tail("--version", "Show kenai_tools gem version") do |v|
+      puts KenaiTools::VERSION
+      exit
+    end
+
+    opts.on_tail("-h", "--help", "Show this message") do
+      usage
+    end
+  end
+
+  begin
+    @opts.parse!
+  rescue Exception => ex
+    fail ex
+  end
+
+  kc_opts = {}
+  kc_opts[:log] = $stderr if @options[:verbose]
+
+  if @options[:dry_run]
+    puts "Dry run, no actual writes will be performed..."
+  end
+
+  src_host, src_proj = parse_endpoint_spec(ARGV.shift, "SRC")
+  dst_host, dst_proj = parse_endpoint_spec(ARGV.shift, "DST")
+
+  unless src_host && src_proj
+    usage
+  end
+  src_url = to_url(src_host)
+
+  unless dst_host && dst_proj
+    usage
+  end
+  dst_url = to_url(dst_host)
+
+  dst_client = KenaiTools::KenaiClient.new(dst_url, kc_opts)
+  user, password = get_credentials(@options[:password], dst_url)
+  result = dst_client.authenticate(user, password)
+  fail "Invalid DST_ENDPOINT credentials for #{dst_url}" unless result
+  check_project(dst_client, dst_url, dst_proj)
+
+  src_client = KenaiTools::KenaiClient.new(src_url, kc_opts)
+  user, password = get_credentials(@options[:source_password], src_url)
+  result = src_client.authenticate(user, password)
+  fail "Invalid SRC_ENDPOINT credentials #{src_url}" unless result
+  check_project(src_client, src_url, src_proj)
+
+  unless @options[:dry_run]
+    copy_images(src_client, src_proj, dst_client, dst_proj) unless @options[:text_only]
+    copy_pages(src_client, src_proj, dst_client, dst_proj) unless @options[:images_only]
+  end
+end
+
+begin
+  main
+rescue SystemExit
+end

data/kenai_tools.gemspec

@@ -9,8 +9,9 @@ Gem::Specification.new do |s|
   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.summary     = %q{Tools for sites hosted on the Kenai platform. Use dlutil to manage downloads and wiki-copy to copy wikis.}
+  s.description = %q{Tools for sites such as java.net that are hosted on the Kenai platform. Use dlutil to upload and download files.
+Use wiki-copy to copy wiki contents and images from one project to another across sites.}
   s.post_install_message = %q{
 ==============================================================================
 
@@ -40,4 +41,5 @@ OS. For more info, see http://kenai.com/jira/browse/KENAI-2853.
   s.add_dependency("rest-client", "~> 1.6")
   s.add_dependency("json", "~> 1.5")
   s.add_dependency("highline", "~> 1.6")
+  s.add_dependency("multipart-post", "~> 1.1")
 end

data/lib/kenai_tools/kenai_client.rb

@@ -2,6 +2,7 @@ require 'rubygems'
 
 require 'rest_client'
 require 'json'
+require 'net/http/post/multipart'
 
 module KenaiTools
   class KenaiClient
@@ -12,6 +13,7 @@ module KenaiTools
     attr_reader :host, :user, :password
 
     def initialize(host = nil, opts = {})
+      RestClient.log = opts[:log] if opts[:log]
       @host = host || DEFAULT_HOST
       @opts = opts
     end
@@ -81,7 +83,9 @@ module KenaiTools
 
     # get wiki images for a project
     def wiki_images(project, on_page = nil)
-      fetch_all("projects/#{project}/features/wiki/images", 'images', :page => on_page)
+      opts = {}
+      opts[:page] = on_page if on_page
+      fetch_all("projects/#{project}/features/wiki/images", 'images', opts)
     end
 
     # get the wiki raw image data for an image
@@ -89,25 +93,33 @@ module KenaiTools
       RestClient.get(image['image_url'], :accept => image['image_content_type'])
     end
 
-    # hash has the following keys
-    # +:uploaded_data+ = raw image data, required only if creating a new image
+    # opts has the following keys
+    # +:image_data+ = raw image data, required only if creating a new image
+    # +:content_type+ = image_data content-type
+    # +:filename+ = filename for multipart
+    #
     # +:comments+ = optional comments for the image
     # throws IOError unless create or update was successful
-    def create_or_update_wiki_image(proj_name, image_filename, hash)
+    def create_or_update_wiki_image(proj_name, opts)
       req_params = {}
-      if data = hash[:uploaded_data]
-        upload_io = UploadIO.new(StringIO.new(data), "image/png", image_filename)
-        req_params["image[uploaded_data]"] = upload_io
+      if data = opts[:image_data]
+        content_type = opts[:content_type]
+        filename = opts[:filename]
+        req_params["image[uploaded_data]"] = UploadIO.new(StringIO.new(data), content_type, filename)
       end
-      if comments = hash[:comments]
+      if comments = opts[:comments]
         req_params["image[comments]"] = comments
       end
       return false if req_params.empty?
+
+      self["projects/#{proj_name}/features/wiki/images/#{filename}"].put(req_params)
     end
 
     # get wiki pages for a project
     def wiki_pages(project, on_page = nil)
-      fetch_all("projects/#{project}/features/wiki/pages", 'pages', :page => on_page)
+      opts = {}
+      opts[:page] = on_page if on_page
+      fetch_all("projects/#{project}/features/wiki/pages", 'pages', opts)
     end
 
     def wiki_page(proj_name, page_name)

data/lib/kenai_tools/version.rb

@@ -1,3 +1,3 @@
 module KenaiTools
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,97 +1,147 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: kenai_tools
-version: !ruby/object:Gem::Version
-  version: 1.0.0
+version: !ruby/object:Gem::Version 
+  hash: 21
   prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
 platform: ruby
-authors:
+authors: 
 - Edwin Goei
 - Project Kenai Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-22 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-05-15 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: &2152634940 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.5'
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 5
+        version: "2.5"
   type: :development
-  prerelease: false
-  version_requirements: *2152634940
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: &2152634380 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
   type: :development
-  prerelease: false
-  version_requirements: *2152634380
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: gemcutter
-  requirement: &2152633980 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *2152633980
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: rest-client
-  requirement: &2152633340 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.6'
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 6
+        version: "1.6"
   type: :runtime
-  prerelease: false
-  version_requirements: *2152633340
-- !ruby/object:Gem::Dependency
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: json
-  requirement: &2152632760 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.5'
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        version: "1.5"
   type: :runtime
-  prerelease: false
-  version_requirements: *2152632760
-- !ruby/object:Gem::Dependency
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
   name: highline
-  requirement: &2152632280 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.6'
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 6
+        version: "1.6"
   type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: multipart-post
   prerelease: false
-  version_requirements: *2152632280
-description: Tools for sites such as java.net that are hosted on the Kenai platform.
-  Use dlutil to upload and download files.
-email:
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 1
+        version: "1.1"
+  type: :runtime
+  version_requirements: *id007
+description: |-
+  Tools for sites such as java.net that are hosted on the Kenai platform. Use dlutil to upload and download files.
+  Use wiki-copy to copy wiki contents and images from one project to another across sites.
+email: 
 - edwin.goei@oracle.com
-executables:
+executables: 
 - dlutil
+- wiki-copy
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - Gemfile
 - README.md
 - Rakefile
 - bin/dlutil
+- bin/wiki-copy
 - kenai_tools.gemspec
 - lib/kenai_tools.rb
 - lib/kenai_tools/downloads_client.rb
@@ -115,35 +165,55 @@ files:
 - spec/fixtures/data/sax2r2.jar
 - spec/fixtures/data/text1.txt
 - spec/spec_helper.rb
+has_rdoc: true
 homepage: http://kenai.com/projects/kenaiapis
 licenses: []
-post_install_message: ! "\n==============================================================================\n\nThanks
-  for installing kenai_tools. Run the following command for what to do\nnext:\n\n
-  \ dlutil --help\n\nWarning: this tool is not yet supported on Windows. Please use
-  a unix-based\nOS. For more info, see http://kenai.com/jira/browse/KENAI-2853.\n\n==============================================================================\n\n\n"
+
+post_install_message: |+
+  
+  ==============================================================================
+  
+  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.
+  
+  ==============================================================================
+  
+  
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: kenai_tools
-rubygems_version: 1.8.17
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Tools for sites hosted on the Kenai platform. Use dlutil to upload and download
-  files.
-test_files:
+summary: Tools for sites hosted on the Kenai platform. Use dlutil to manage downloads and wiki-copy to copy wikis.
+test_files: 
 - spec/downloads_client_spec.rb
 - spec/fixtures/data/irs_docs/irs-form-1040.pdf
 - spec/fixtures/data/irs_docs/irs-p555.pdf