backup-github 1.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,24 @@
+source :rubygems
+
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+  gem "mocha", "~> 0.10.3"  
+  # gem "pry" # active for debug
+end
+
+group :default do
+  gem "octokit", "~> 0.6.5"
+  gem "json", "~> 1.6.4"
+  gem "grit", "~> 2.4.1"
+  gem "trollop", "~> 1.16.2"
+end
+
+# yo dawg, i herd u lieked jeweler
+group :xzibit do
+  # steal a page from bundler's gemspec:
+  # add this directory as jeweler, in order to bundle exec jeweler and use the current working directory
+  gem 'backup-github', :path => '.'
+end

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    backup-github (1.1.0)
+      grit (~> 2.4.1)
+      json (~> 1.6.4)
+      octokit (~> 0.6.5)
+      trollop (~> 1.16.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.6)
+    diff-lcs (1.1.3)
+    faraday (0.7.6)
+      addressable (~> 2.2)
+      multipart-post (~> 1.1)
+      rack (~> 1.1)
+    faraday_middleware (0.7.0)
+      faraday (~> 0.7.3)
+    git (1.2.5)
+    grit (2.4.1)
+      diff-lcs (~> 1.1)
+      mime-types (~> 1.15)
+    hashie (1.2.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.5)
+    metaclass (0.0.1)
+    mime-types (1.17.2)
+    mocha (0.10.3)
+      metaclass (~> 0.0.1)
+    multi_json (1.0.4)
+    multipart-post (1.1.4)
+    octokit (0.6.5)
+      addressable (~> 2.2.6)
+      faraday (~> 0.7.4)
+      faraday_middleware (~> 0.7.0)
+      hashie (~> 1.2.0)
+      multi_json (~> 1.0.2)
+    rack (1.4.1)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    trollop (1.16.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  backup-github!
+  bundler (~> 1.0.0)
+  grit (~> 2.4.1)
+  jeweler (~> 1.8.3)
+  json (~> 1.6.4)
+  mocha (~> 0.10.3)
+  octokit (~> 0.6.5)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)
+  trollop (~> 1.16.2)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Zauber (http://www.zaubersoftware.com)
+
+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,48 @@
+# backup-github
+
+Utility tool to backup github repository issues. It will backup up all the issues from all the repositories from a given github account.
+
+It works with a local git repository, on which issues from all repositories of a github account are serialized to json and commited. Thanks to git, all changes are versioned, and saved.
+
+To install you can just download the gem with:
+
+```bash
+    gem install backup-github
+```
+
+Then, to run the backup command:
+
+```bash
+    backup-github -r path/to/my/backup/dir -u github_user -p github_pwd 
+```
+
+If, instead you want to backup up all the issues from an Organization within github, then you run:
+
+```bash
+    backup-github -r path/to/my/backup/dir -u github_user -p github_pwd -o org_name
+```
+
+**Important**: The github user used, should have access to all the organization repositories.
+
+To properly configure the backup system, we recommend setting a cron job to run the command once a day.
+
+## Contributing to backup-github
+ 
+* Check out the latest master to make sure the feature hasn't been implemented
+  or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it 
+  and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to 
+  have your own version, or is otherwise necessary, that is fine, but please 
+  isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Zauber. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "backup-github"
+  gem.homepage = "http://github.com/zauberlabs/backup-github"
+  gem.license = "MIT"
+  gem.summary = %Q{Backups Github Issues}
+  gem.description = %Q{Command to backup Github Issues as JSON files in a Git Repository}
+  gem.email = "mariano@zauberlabs.com"
+  gem.authors = ["Mariano A. Cortesi"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "backup-github #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.1.0

data/backup-github.gemspec

@@ -0,0 +1,78 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "backup-github"
+  s.version = "1.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mariano A. Cortesi"]
+  s.date = "2012-02-01"
+  s.description = "Command to backup Github Issues as JSON files in a Git Repository"
+  s.email = "mariano@zauberlabs.com"
+  s.executables = ["gh-backup-issues"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "backup-github.gemspec",
+    "bin/gh-backup-issues",
+    "lib/backup-github.rb",
+    "lib/backup-github/cli.rb",
+    "spec/backup-github_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/zauberlabs/backup-github"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "Backups Github Issues"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<octokit>, ["~> 0.6.5"])
+      s.add_runtime_dependency(%q<json>, ["~> 1.6.4"])
+      s.add_runtime_dependency(%q<grit>, ["~> 2.4.1"])
+      s.add_runtime_dependency(%q<trollop>, ["~> 1.16.2"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<mocha>, ["~> 0.10.3"])
+    else
+      s.add_dependency(%q<octokit>, ["~> 0.6.5"])
+      s.add_dependency(%q<json>, ["~> 1.6.4"])
+      s.add_dependency(%q<grit>, ["~> 2.4.1"])
+      s.add_dependency(%q<trollop>, ["~> 1.16.2"])
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<mocha>, ["~> 0.10.3"])
+    end
+  else
+    s.add_dependency(%q<octokit>, ["~> 0.6.5"])
+    s.add_dependency(%q<json>, ["~> 1.6.4"])
+    s.add_dependency(%q<grit>, ["~> 2.4.1"])
+    s.add_dependency(%q<trollop>, ["~> 1.16.2"])
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<mocha>, ["~> 0.10.3"])
+  end
+end
+

data/bin/gh-backup-issues

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+# Don't try to run this binary directory. Instead:
+# * `bundle exec backup-github` if doing backup-github development
+# * `backup-github` if installed through rubygems, relying on the rubygem wrapper
+
+require "backup-github/cli"
+
+BackupGithub::Cli::run()

data/lib/backup-github.rb

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'octokit'
+require 'json'
+require 'grit'
+require 'ostruct'
+require 'pathname'
+require 'logger'
+
+$logger = Logger.new($stdout)
+  
+class GithubBackup
+
+  def initialize(github)
+    @github = github
+  end
+
+  def serialize_issue(issue)
+    JSON.pretty_generate( issue.content )
+  end
+
+  def save_issue(dir, issue)
+    file = dir + ('%04d.js' % issue.number)
+    file.open('w') { |f| f.write(serialize_issue(issue)) }
+    @gitrepo.add(file.to_s)
+  end
+
+  def run( orgname, local_repo )
+    Dir.chdir(local_repo) do |path|
+      @gitrepo = begin
+        Grit::Repo.new(".")
+      rescue Grit::InvalidGitRepositoryError => e
+        $logger.warn "Not a git Repository, creating a new one"
+        Grit::Repo.init(".")
+      end
+
+      orgdir = Pathname.new orgname
+      
+      repositories = @github.repositories orgname 
+
+      repositories.each do |repo|      
+        reponame = "#{orgname}/#{repo.name}"
+        $logger.info "Backuping #{reponame}"
+        
+        if @github.has_issues? reponame
+          projectdir = orgdir + repo.name
+          projectdir.mkpath
+
+          @github.on_issues(reponame) {|issue| save_issue(projectdir, issue)}
+        else
+          $logger.info "No issues for #{reponame}"
+        end
+      end
+
+      @gitrepo.commit_index("Backup...")
+      $logger.info 'Backup Finished'
+    end
+  end
+
+end
+
+
+class GithubAPIAdapter
+  @@ISSUE_STATES = %w{open closed}
+  
+  def initialize(client) 
+    @client = client
+  end
+
+  def has_issues?(reponame)
+    @client.repository(reponame).has_issues
+  end
+     
+  def on_issues(reponame, &block)
+    @@ISSUE_STATES.each do |status|
+      page = 0
+
+      begin
+          issues = @client.list_issues( reponame, :page => page, :state => status )
+          issues.each do |issue|
+            yield OpenStruct.new(:number => issue.number, 
+                                 :content => @client.issue(reponame, issue.number))
+          end
+          page += 1
+      end until issues.length != 10
+    end
+  end
+
+  def repositories(orgname)
+    @client.repositories(orgname)
+  end
+end

data/lib/backup-github/cli.rb

@@ -0,0 +1,43 @@
+require 'trollop'
+require 'backup-github'
+
+module BackupGithub
+  module Cli
+
+    def self.parse_options
+      opts = Trollop::options do
+        banner "hola mundo"
+        opt :localrepo, "Path to the local repository where backups are saved", 
+          :short => "-r",
+          :type => String,
+          :required => true
+        opt :organization, "Organization name if you want to backup repositories from one", 
+          :short => "-o",
+          :type => String,
+          :required => false
+        opt :github_user, "Github User", 
+          :short => "-u",
+          :type => String,
+          :required => true
+        opt :github_password, "Github Password", 
+          :short => "-p",
+          :type => String,
+          :required => true
+      end
+      Trollop::die :localrepo, "must exist" unless File.directory? opts[:localrepo]
+      opts
+    end
+
+    def self.run
+      opts = parse_options
+      account = opts[:organization] || opts[:github_user]
+      github = GithubAPIAdapter.new(
+                Octokit::Client.new(
+                  :login => opts[:github_user], 
+                  :password => opts[:github_password]))
+      GithubBackup.new(github).run(account, opts[:localrepo])
+    end
+
+  end
+end
+

data/spec/backup-github_spec.rb

@@ -0,0 +1,79 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require "mocha"
+require "ostruct"
+require_relative "../lib/backup-github"
+
+describe GithubAPIAdapter do
+  
+  before :each  do 
+    @client = double()
+    @github = GithubAPIAdapter.new(@client)
+  end
+
+  describe "repositories" do
+    it "should retrieve repositories for an organization" do
+      @client.should_receive(:repositories) {%w{repo1 repo2 repo3}}
+
+      @github.repositories("org1").should eq(%w{repo1 repo2 repo3})
+    end
+  end
+
+  describe "on_issues" do
+    it "should retrieve open issues" do
+      @client.should_receive(:list_issues).with("repo", {:page => 0, :state => "open"}) do
+        [1,2,4].collect {|i| OpenStruct.new(:number => i)}
+      end
+      @client.should_receive(:list_issues).with("repo", {:page => 0, :state => "closed"}) {[]}
+      @client.should_receive(:issue).at_least(:once) {"content"}
+
+      data = []
+      @github.on_issues("repo") {|r| data << r}
+      data.should have(3).items
+    end
+
+    it "should retrieve closed issues" do
+      @client.should_receive(:list_issues).with("repo", {:page => 0, :state => "closed"}) do
+        [1,2,4].collect {|i| OpenStruct.new(:number => i)}
+      end
+      @client.should_receive(:list_issues).with("repo", {:page => 0, :state => "open"}) {[]}
+      @client.should_receive(:issue).at_least(:once) {"content"}
+
+      data = []
+      @github.on_issues("repo") {|r| data << r}
+      data.should have(3).items
+    end
+
+    it "should retrieve all issues pages" do
+      @client.should_receive(:list_issues).exactly(12).times do |repo, opt |
+        values = if opt[:page] < 5 
+                   (1..10)
+                 else
+                   (1..4)
+                 end
+        values.collect {|i| OpenStruct.new(:number => i)}
+      end
+      @client.should_receive(:issue).at_least(:once) {"content"}
+
+      data = []
+      @github.on_issues("repo") { |r| data << r }
+      data.should have(5*10*2 + 4*2).items
+    end
+
+    it "should retrieve issue content for each issue" do 
+      @client.should_receive(:list_issues).twice do |repo, opt|
+        if opt[:state] == "open"
+          [1].collect {|i| OpenStruct.new(:number => i)}
+        else
+          []
+        end
+      end
+      @client.should_receive(:issue).at_least(:once) {"content"}
+
+      data = []
+      @github.on_issues("repo") {|r| data << r}
+      data.should have(1).items
+      data[0].content.should eq("content")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'backup-github'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: backup-github
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Mariano A. Cortesi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: &70183486958840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *70183486958840
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70183486957760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *70183486957760
+- !ruby/object:Gem::Dependency
+  name: grit
+  requirement: &70183486956980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70183486956980
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: &70183486956320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.16.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70183486956320
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70183486955700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70183486955700
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70183486954960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *70183486954960
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70183486954280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70183486954280
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70183486951860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *70183486951860
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70183486948440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: *70183486948440
+description: Command to backup Github Issues as JSON files in a Git Repository
+email: mariano@zauberlabs.com
+executables:
+- gh-backup-issues
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- backup-github.gemspec
+- bin/gh-backup-issues
+- lib/backup-github.rb
+- lib/backup-github/cli.rb
+- spec/backup-github_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/zauberlabs/backup-github
+licenses:
+- MIT
+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: 3014412636560081919
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Backups Github Issues
+test_files: []