lhbackup 0.1.0

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.sublime-project
+*.sublime-workspace
+.DS_Store
+run

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Nathan Youngman
+
+MIT License
+
+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/README.md

@@ -0,0 +1,34 @@
+# Lhbackup
+
+On-demand backup of Lighthouse.
+
+## Installation
+
+Install it:
+
+    $ gem install lhbackup
+
+## Usage
+
+Run it:
+
+    $ lhbackup --help
+
+    --account, -a <s>:  Lighthouse account (eg. activereload)
+    --token,   -t <s>:  Token to authenticate with
+    --output,  -o <s>:  Output folder (defaults to account)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## TODO
+
+* Tags, skipped as was running into errors with the Lighthouse gem.
+* Other users that aren't currently members of a project? (are they still in Lighthouse anyway?)
+* Message attachments are not downloaded
+* Individual requests contain more information (ticket versions), which are not retrieved.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/lhbackup

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "bundler/setup"
+
+Bundler.setup :default
+Bundler.require :default
+
+require 'lhbackup'
+Lhbackup::main

data/lhbackup.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/lhbackup/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nathan Youngman"]
+  gem.email         = ["git@nathany.com"]
+  gem.description   = %q{On-demand backup of Lighthouse.}
+  gem.summary       = %q{For some reason the Lighthouse project export feature never seems to work for me.}
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "lhbackup"
+  gem.require_paths = ["lib"]
+  gem.version       = Lhbackup::VERSION
+
+  gem.add_runtime_dependency('lighthouse', '~> 2.1')
+  gem.add_runtime_dependency('addressable', '~> 2.2')
+  gem.add_runtime_dependency('trollop', '~> 1.16')
+end

data/lib/lhbackup.rb

@@ -0,0 +1,4 @@
+require "lhbackup/version"
+require "lhbackup/cli"
+require "lhbackup/backup"
+

data/lib/lhbackup/backup.rb

@@ -0,0 +1,127 @@
+# Lighthouse
+# http://lighthouseapp.com/api/
+# https://github.com/smathy/lighthouse
+require 'lighthouse'
+require 'set'
+
+module Lhbackup
+
+  class Backup
+    def initialize(account, token)
+      Lighthouse.account = account
+      Lighthouse.token = token
+    end
+
+    def run
+      print "Retreiving projects..."
+      projects = Lighthouse::Project.find(:all)
+      store(projects, 'projects.json')
+
+      projects.each do |project|
+        puts "#{project.permalink}:"
+        retrieve_project(project)
+      end
+    end
+
+    def retrieve_project(project)
+      @project = project
+      @attachments = Set.new
+
+      # subfolder for the project
+      @folder = File.join(FileUtils.pwd, @project.permalink)
+
+      # unpaginated resources
+      retrieve_resource "memberships"
+      retrieve_resource "bins"
+
+      # paginated resources
+      %w{milestones tickets messages changesets}.each do |resource|
+        retrieve_resource resource, :paginated
+      end
+
+      # attachments
+      puts "#{@attachments.count} attachments to download"
+
+      File.open(File.join(@folder, "attachments.sh"), "w") do |f|
+        f.write(@attachments.map {|url| curl(url)}.join("\n"))
+      end
+      system(File.join(@folder, "attachments.sh"))
+    end
+
+    def retrieve_resource(resource, paginated = false)
+      print "- retreiving #{resource}"
+
+      data = if paginated
+        load_pages do |p|
+          @project.send(resource, :page => p)
+        end
+      else
+        @project.send(resource)
+        puts
+      end
+
+      store(data, File.join(@folder, "#{resource}.json"))
+
+      find_attachments(data) if resource == "tickets"
+      # TODO: messages have attachments too (but on the comments)
+    end
+
+    def find_attachments(data)
+      print "- finding #{data.sum(&:attachments_count)} attachments"
+
+      attachment_data = data.map do |obj|
+        next if obj.attachments_count.zero?
+
+        # individual tickets respond to attachments, but the listed ones don't
+        attachments = Lighthouse::Ticket.find(obj.number, :params => {:project_id => @project.id}).attachments
+        putc '.'
+
+        attachments.each do |a|
+          if a.respond_to?(:url)
+            @attachments << a.url
+          elsif a.respond_to?(:image) && a.image.respond_to?(:url)
+            @attachments << a.image.url
+          else
+            puts "Whats the url for this attachment? #{a.to_json}"
+          end
+        end
+        {obj.number => attachments} # ticket to attachments
+      end.compact
+
+      store(attachment_data, File.join(@folder, "ticket-attachments.json"))
+    end
+
+    def curl(url)
+      output = File.join(@folder, URI(url).path)
+      "curl -H 'X-LighthouseToken: #{Lighthouse.token}' #{url} -o #{output} -L --create-dirs"
+      # -C - would continue downloads
+    end
+
+    def store(data, file)
+      FileUtils.mkdir_p(File.dirname(file)) if File.dirname(file).present?
+
+      puts "  saving #{File.basename(file)}"
+
+      File.open(file, "w") do |f|
+        f.write(data.to_json)
+      end
+    end
+
+    # results are paginated, get them all
+    def load_pages
+      p = 1
+      results = []
+      while true
+        result = yield p
+        # TODO error cases
+        break if result.count.zero?
+        results += result
+        p = p + 1
+        putc "."
+      end
+      puts
+      results
+    end
+  end
+
+end

data/lib/lhbackup/cli.rb

@@ -0,0 +1,24 @@
+# Trollop
+# http://trollop.rubyforge.org/
+# http://rubydoc.info/gems/trollop/1.16.2/Trollop/Parser
+require 'trollop'
+
+module Lhbackup
+
+  def self.main
+    opts = Trollop::options do
+      version "lhbackup #{VERSION} Copyright (c) 2012 Nathan Youngman"
+      banner "Lighthouse Backup"
+      opt :account, "Lighthouse account (eg. activereload)", :type => :string, :required => true
+      opt :token, "Token to authenticate with", :type => :string, :required => true
+      opt :output, "Output folder (defaults to account)", :type => :string
+    end
+
+    folder = opts[:output] || opts[:account]
+    FileUtils.mkdir_p(folder)
+    FileUtils.chdir(folder)
+
+    Backup.new(opts[:account], opts[:token]).run
+  end
+
+end

data/lib/lhbackup/version.rb

@@ -0,0 +1,3 @@
+module Lhbackup
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: lhbackup
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Nathan Youngman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lighthouse
+  requirement: &70148192233640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70148192233640
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: &70148192233100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70148192233100
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: &70148192232320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70148192232320
+description: On-demand backup of Lighthouse.
+email:
+- git@nathany.com
+executables:
+- lhbackup
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/lhbackup
+- lhbackup.gemspec
+- lib/lhbackup.rb
+- lib/lhbackup/backup.rb
+- lib/lhbackup/cli.rb
+- lib/lhbackup/version.rb
+homepage: ''
+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'
+      segments:
+      - 0
+      hash: 2739751983264181991
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2739751983264181991
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: For some reason the Lighthouse project export feature never seems to work
+  for me.
+test_files: []