redsync 0.1.1

data/README.textile

@@ -0,0 +1,77 @@
+h1. Redsync
+
+h2. What's this?
+
+Sync your Redmine's wiki contents to your local filesystem.
+Edit them while offline, then upsync them to Redmine.
+
+h2. Usage
+
+Copy and edit config.yml.dist -> config.yml
+
+<pre>
+--- 
+:url: "http://your.redmine.url/"
+:project_slug: "project_identifier"
+:username: "username"
+:password: "password"
+:data_dir: "~/redsync"
+</pre>
+
+Run @bin/redsync@
+
+<pre>
+Usage: redsync [options]
+    -v, --[no-]verbose               Output verbose logs
+    -c, --config FILE                Use specified config file instead of config.yml
+    -u, --upsync-only                Upsync only, don't downsync
+    -d, --downsync-only              Downsync only, don't upsync
+</pre>
+
+h2. Dependencies
+
+* Ruby 1.9
+* Mechanize (@gem install mechanize@)
+* ActiveSupport (@gem install activesupport@)
+
+h2. How it works
+
+Just some scraping...
+
+h2. Warnings
+
+This software has NOT BEEN TESTED :(
+Use it at your own risk.
+Please beware that it may not work on all versions of Redmine (it's working fine with my installation of 1.2-stable)
+
+Redsync assumes that your local timezone is the same as your Redmine timezone.
+Sign in and go to "My Account" to change it.
+
+Redsync does not deal with edit conflicts well.
+In fact, it does not deal with conflics AT ALL.
+A default run of redsync will downsync first, overwriting any local changes if pages are updated on Redmine.
+Then it will upsync any remaining changes.
+
+h2. License
+
+The MIT License
+
+Copyright © 2011 Shinya Maeyama.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/bin/redsync

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# -*- vim: filetype=ruby
+
+if RUBY_VERSION < '1.9'
+  puts "Redsync requires Ruby >= 1.9.0"
+  exit
+end
+
+require 'pathname'
+self_file = Pathname.new(__FILE__).realpath
+$LOAD_PATH << File.join(File.dirname(self_file), "../lib")
+require 'redsync'
+
+Redsync::CLI.run

data/config.yml.dist

@@ -0,0 +1,6 @@
+--- 
+:url: "http://your.redmine.url/"
+:project_slug: "project_identifier"
+:username: "username"
+:password: "password"
+:data_dir: "~/redsync"

data/lib/redsync.rb

@@ -0,0 +1,235 @@
+# encoding:UTF-8
+
+require 'rubygems'
+require 'fileutils'
+require 'uri'
+require 'yaml'
+require 'date'
+require 'iconv'
+require 'mechanize'
+require 'active_support/all'
+
+require 'redsync/cli'
+
+
+class Redsync
+
+  class Status
+    DOWNLOADED = 1
+    SKIPPED_UNKNOWN = 2
+    SKIPPED_OLD = 4
+    UPLOADED = 8
+    CREATED = 16
+    ERROR_ON_CREATE = 32
+    ERROR_ON_EDIT = 64
+  end
+
+  def initialize(options)
+    @config = {}
+    @config.merge! options
+    @config[:data_dir] = File.expand_path(@config[:data_dir])
+    @config[:conflicts_dir] = File.join(@config[:data_dir], "__redsync_conflicts__")
+    @config[:pages_list_file] = File.join(@config[:data_dir], "__redsync_pages_list__.yml")
+    puts "Using data dir: #{@config[:data_dir]}"
+
+    @login_url = @config[:url] + "/login"
+    @wiki_base_url = @config[:url] + "/projects/" + @config[:project_slug] + "/wiki"
+
+    initialize_system_files
+    recover_pages_list
+
+    @agent = Mechanize.new
+    @logged_in = false
+  end
+
+
+  def initialize_system_files
+    unless File.exist? @config[:data_dir]
+      puts "Creating data dir"
+      FileUtils.mkdir(@config[:data_dir]) 
+    end
+    FileUtils.mkdir(@config[:conflicts_dir]) unless File.exist? @config[:conflicts_dir]
+    FileUtils.touch(@config[:pages_list_file]) unless File.exist? @config[:pages_list_file]
+  end
+
+
+  def login
+    puts "Logging in as #{@config[:username]} to #{@login_url}..."
+    page = @agent.get(@login_url)
+    login_form = page.form_with(:action => "/login")
+    login_form.field_with(:name => "username").value = @config[:username]
+    login_form.field_with(:name => "password").value = @config[:password]
+    result_page = login_form.submit
+    if result_page.link_with(:text => "Sign out")
+      puts "Logged in successfully."
+      return true
+    else
+      puts "Login failed."
+      return false
+    end
+  end
+
+
+  def pages
+    refresh_pages_list if (!@pages || @pages.empty?)
+    @pages
+  end
+
+
+  def downsync
+    puts "\nDownsync:"
+    statuses = {
+      Status::DOWNLOADED => 0,
+      Status::SKIPPED_OLD => 0,
+      Status::SKIPPED_UNKNOWN => 0,
+    }
+    pages.each do |pagename, info|
+      statuses[downsync_page(pagename)] += 1
+    end
+    puts "Downloaded #{statuses[Status::DOWNLOADED]} pages."
+    puts "Skipped #{statuses[Status::SKIPPED_OLD] + statuses[Status::SKIPPED_UNKNOWN]} pages."
+  end
+
+
+  def downsync_page(pagename)
+    now = DateTime.now
+
+    page_info = pages[pagename]
+    if !page_info
+      puts "--Skipping #{pagename}: unknown page"
+      return Status::SKIPPED_UNKNOWN
+    end
+
+    filename = File.join(@config[:data_dir], "#{pagename}.txt")
+
+    if File.exist? filename
+      local_updated_at = File.stat(filename).mtime.to_datetime
+      remote_updated_at = DateTime.parse(page_info[:updated_at_str] + "T00:00:00" + now.zone)
+      if remote_updated_at.year == now.year && remote_updated_at.month == now.month && remote_updated_at.day == now.day
+        remote_updated_at = page_history(pagename)[0][:timestamp]
+      end
+      if local_updated_at >= remote_updated_at
+        puts "--Skip #{pagename}: local (#{local_updated_at}) is newer than remote (#{remote_updated_at})" if @config[:verbose]
+        return Status::SKIPPED_OLD
+      end
+    end
+
+    puts "--Download #{pagename}"
+    page = @agent.get(page_info[:url] + "/edit")
+    File.open(filename, "w+:UTF-8") { |f| f.write(page.search("textarea")[0].text) }
+    @pages[pagename][:downloaded_at] = File.stat(filename).mtime.to_datetime
+    write_pages_list
+
+    return Status::DOWNLOADED
+  end
+
+
+  def upsync
+    puts "\nUpsync:"
+    statuses = {
+      Status::UPLOADED => 0,
+      Status::SKIPPED_OLD => 0,
+      Status::CREATED => 0,
+      Status::ERROR_ON_CREATE => 0,
+      Status::ERROR_ON_EDIT => 0
+    }
+    Dir.entries(@config[:data_dir]).each do |file|
+      fullpath = File.join(@config[:data_dir], file)
+      next if File.directory?(fullpath)
+      next if file =~ /^__redsync_/
+      file = Iconv.iconv("UTF-8", "UTF-8-MAC", file).first
+      statuses[upsync_page(File.basename(file, ".txt"))] += 1
+    end
+    print "Created #{statuses[Status::CREATED]} pages."
+    print " (#{statuses[Status::ERROR_ON_CREATE]} errors)" if statuses[Status::ERROR_ON_CREATE] > 0
+    print "\n"
+    print "Uploaded #{statuses[Status::UPLOADED]} pages."
+    print " (#{statuses[Status::ERROR_ON_EDIT]} errors)" if statuses[Status::ERROR_ON_EDIT] > 0
+    print "\n"
+    puts "Skipped #{statuses[Status::SKIPPED_OLD]} pages."
+  end
+
+
+  def upsync_page(pagename)
+    now = DateTime.now
+    page_info = pages[pagename]
+    filename = File.join(@config[:data_dir], "#{pagename}.txt")
+    local_updated_at = File.stat(filename).mtime.to_datetime
+
+    if page_info.try(:[], :downloaded_at) && local_updated_at <= page_info[:downloaded_at].to_datetime
+      puts "--Skip #{pagename}" if @config[:verbose]
+      return Status::SKIPPED_OLD
+    end
+
+    puts (page_info ? "--Upload #{pagename}" : "--Create #{pagename}")
+    page = @agent.get(@wiki_base_url + "/" + pagename + "/edit")
+    form = page.form_with(:id=>"wiki_form")
+    form.field_with(:name=>"content[text]").value = File.open(filename, "r:UTF-8").read
+    result_page = form.submit
+    errors = result_page.search("#errorExplanation li").map{|li|li.text}
+    if errors.any?
+      print "--Error: #{pagename}: "
+      puts errors
+      return (page_info ? Status::ERROR_ON_EDIT : Status::ERROR_ON_CREATE)
+    else
+      now = DateTime.now
+      pages[pagename] ||= {}
+      pages[pagename][:name] = pagename
+      pages[pagename][:url] = @wiki_base_url + "/" + URI.encode(pagename)
+      pages[pagename][:downloaded_at] = now
+      pages[pagename][:updated_at_str] = now.strftime("%Y-%m-%d")
+      write_pages_list
+      return (page_info ? Status::UPLOADED : Status::CREATED)
+    end
+  end
+
+
+  def refresh_pages_list
+    puts "Refreshing pages list"
+    @pages ||= {}
+    page = @agent.get(@wiki_base_url + "/date_index")
+
+    page.search("#content h3").each do |h3|
+      links = h3.next_element.search("a")
+      links.each do |link|
+        page_url = @config[:url] + link.attr("href")
+        pagename = URI.decode(page_url.match(/^#{@wiki_base_url}\/(.*)$/)[1]).force_encoding("UTF-8")
+        @pages[pagename] ||= {}
+        @pages[pagename][:name] = pagename
+        @pages[pagename][:url] = page_url
+        @pages[pagename][:updated_at_str] = h3.text
+      end
+    end
+
+    @pages
+  end
+
+
+  def recover_pages_list
+    @pages = YAML.load_file(@config[:pages_list_file])
+    @pages ||= {}
+  end
+
+
+  def write_pages_list
+    File.open(@config[:pages_list_file], "w+:UTF-8") do |f|
+      f.write(@pages.to_yaml)
+    end
+  end
+
+
+  def page_history(pagename)
+    puts "--Getting page history for #{pagename}" if @config[:verbose]
+    history = []
+    page = @agent.get(@wiki_base_url + "/" + URI.encode(pagename) + "/history")
+    page.search("table.wiki-page-versions tbody tr").each do |tr|
+      timestamp = DateTime.parse(tr.search("td")[3].text+"+0900") 
+      author_name = tr.search("td")[4].text.strip
+      history << {
+        :timestamp => timestamp,
+        :author_name => author_name
+      }
+    end
+    history
+  end
+end

data/lib/redsync/cli.rb

@@ -0,0 +1,89 @@
+require 'optparse'
+require 'yaml'
+
+class Redsync
+  class CLI
+    class << self
+
+      def run
+        parse_options
+        check_config_file
+
+        redsync = Redsync.new(YAML.load_file(@options.delete(:config_file)).merge(@options))
+        exit unless redsync.login
+
+        time do
+          redsync.downsync unless @options[:uponly]
+          redsync.upsync unless @options[:downonly]
+        end
+      end
+
+
+      def parse_options
+        @options = {
+          :config_file => "~/redsync.yml",
+        }
+
+        OptionParser.new do |opts|
+          opts.banner = "Usage: redsync [options]"
+          opts.on("-v", "--[no-]verbose", "Output verbose logs") do |v|
+            @options[:verbose] = v
+          end
+          opts.on("-c", "--config FILE", "Use specified config file instead of ~/redsync.yml") do |file|
+            @options[:config_file] = file
+          end
+          opts.on("-u", "--upsync-only", "Upsync only, don't downsync") do |v|
+            @options[:uponly] = v
+          end
+          opts.on("-d", "--downsync-only", "Downsync only, don't upsync") do |v|
+            @options[:downonly] = v
+          end
+          opts.on("-D", "--debug", "Debug mode. Requires ruby-debug19") do |v|
+            @options[:debug] = v
+          end
+        end.parse!
+
+        if @options[:debug]
+          require 'ruby-debug'
+          Debugger.settings[:autoeval] = true
+        end
+
+        @options[:config_file] = File.expand_path(@options[:config_file])
+      end
+
+
+      def check_config_file
+        if !File.exist? @options[:config_file]
+          Redsync::CLI.confirm("Config file #{@options[:config_file]} doesn't exist. Create?") do 
+            FileUtils.cp("config.yml.dist", @options[:config_file]) 
+            puts "Creating config file in #{@options[:config_file]}."
+            puts "Edit it and call me again when you're done."
+          end
+          exit
+        end
+      end
+      
+
+      def confirm(question, default_yes = true, &block)
+        print question
+        print (default_yes ? " [Y/n] " : " [N/y] ")
+        c = gets.strip
+        result = 
+          if c =~ /^$/
+            default_yes
+          else
+            c =~ /^y/i
+          end
+        block.call if result && block
+      end
+
+      
+      def time(&block)
+        start = Time.now
+        yield
+        puts "Finished in #{Time.now - start} seconds."
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: redsync
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- merikonjatta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-07 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: &2153510840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153510840
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2153510440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153510440
+description: Sync Redmine's wiki pages to your local filesystem. Edit as you like,
+  then upsync.
+email: merikonjatta@gmail.com
+executables:
+- redsync
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/redsync/cli.rb
+- lib/redsync.rb
+- README.textile
+- config.yml.dist
+- bin/redsync
+homepage: http://github.com/merikonjatta/redsync
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Sync Redmine's wiki pages to your local filesystem.
+test_files: []