github_snapshot 0.1.0 → 0.1.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OGI2N2ZkYjNkY2I0MTZkNjFjYzcxYjMyOWU1NjE1NjU5ZjI3NGEwYQ==
+    YjA2YjVjZjU1YTFmNWNiNTdiMjg5OTVhM2ZlNjRiNTk1ZjczYjkwZQ==
   data.tar.gz: !binary |-
-    YTFlNTIzZDBmNTVmOTUyYTQ1NmFiZjdjNjk0YzdjZDBiMmIxMjlkZA==
+    Yjc0MTg5ZDFiNzcyYTg3MWFlYWFiZjA1ZTRkMzg0ZjU5Yjk4NzU1ZA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YjMyMzIxOTg4MTI0MDkwYmU3YTUyY2E5MGFiNjI5YTMxZDM0YTcxN2RjNTVh
-    MTczZjZlMzkxOGJhNmExNTVmNTU0YWU2MTk1MmQxOTliYTYyZmQ0MDAyMGNm
-    MzRmMDM3NWFiOTNhMDcyOTVlOWFhM2JlNWQ0MjkxMWZhMDI0NjA=
+    OGIxYTA0MTJiZTkxMWJkNzJmMmVjNjg4Y2ZiMGMxNTA1MmI5NDE0NTc4YWQ4
+    YWYyNGFiNGNhOWQyNjAyMTcxMjk1YWQ3NTg0N2IxNzIwNTU0NTEyNGRiNTcy
+    NDczOWZiOTg0OTYyMTY0MmVjM2QxZGZjNzExYTM1N2E4M2ZlN2U=
   data.tar.gz: !binary |-
-    ODZjYWZjY2IzM2I1NDcxOTMyY2RiZjQyYjUxMzE1ODg3YTAyMzViY2Q3ZjEx
-    NGY5N2YwNmEwYTc0Mzg0NTJjOTZmMTU0MjEzNTViMDY0MzAxMWQyYmMzOGQ3
-    NWFkNjg3Y2QxYzZkMGE4ZGVkYmViOGEwZjgzMjdmZTY5OGQ1ZjY=
+    OGRiMjViOTZiZmQ4ZTk3N2QxYWI1YjZjYWQ2YjNhNWQ4YWJjYzUzM2ViMTIw
+    OTEwNmIxMTJmMGE0ZjI4YmIwOGYzMmVjOTQwNTIzMzZjZTIxYzM4YTQxOTNl
+    Y2U5OWE0M2NjOWRlNmFiMGI5OWNhNTU0ZDk4YWJhYjRiZDlhZDg=

data/Gemfile

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

data/README.md

@@ -1,12 +1,36 @@
 # GithubSnapshot
 
-Snapshoting organization's repositories, including wikis
+Snapshots multiple organizations GitHub repositories, including wikis, and syncs them to Amazon's S3. The gem also prunes old backups, keeping only the N most recent snapshots for each repository.
+
+Please do keep in mind that we are not setting up an additional remote that is kept in sync. We do a `git clone --mirror` on each repository and then gzip it with a timestamp. Here is a typical (and reduced for clarity) tree structure of the backup folder/S3 bucket:
+
+```
+github-backups/
+├── mozilla
+│   ├── brick-201308260300.git.tar.gz
+│   ├── brick-201308260300.wiki.git.tar.gz
+│   ├── brick-201308270300.git.tar.gz
+│   ├── brick-201308270300.wiki.git.tar.gz
+│   ├── shumway-201308260300.git.tar.gz
+│   ├── shumway-201308260300.wiki.git.tar.gz
+│   ├── shumway-201308270300.git.tar.gz
+│   ├── shumway-201308270300.wiki.git.tar.gz
+└── innvent
+    ├── github_snapshot-201308260300.git.tar.gz
+    ├── github_snapshot-201308270300.git.tar.gz
+    ├── matross-201308260300.git.tar.gz
+    ├── matross-201308270300.git.tar.gz
+    └── jobs-201308260300.git.tar.gz
+    └── jobs-201308270300.git.tar.gz
+```
 
 ## Installation
 
 `github_snapshot` should be run as a command line tool, so it makes sense installing it globally
 
-    $ gem install github_snapshot
+```bash
+$ gem install github_snapshot
+```
 
 [`s3cmd`](https://github.com/s3tools/s3cmd) should also be installed on the system and properly configured.
 
@@ -37,6 +61,16 @@ $ github_snapshot
 $ echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
 ```
 
+## To-Do
+
+Although this gem was created to serve a very specific purpose at Innvent, here is the roadmap we have in mind:
+
+- Tests;
+- Backup GitHub issues;
+- Flag based configuration, in addition to the YAML config file;
+- Turn off S3 synchronization;
+- Restore backups to GitHub;
+
 ## Contributing
 
 1. Fork it

data/github_snapshot.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = GithubSnapshot::VERSION
   spec.authors       = ["Artur Rodrigues" , "Joao Sa"]
   spec.email         = ["arturhoo@gmail.com"]
-  spec.description   = %q{Snapshoting organization's repositories, including wikis}
-  spec.summary       = %q{Snapshoting organization's repositories}
-  spec.homepage      = ""
+  spec.description   = %q{Snapshots multiple organizations GitHub repositories, including wikis, and syncs them to Amazon's S3}
+  spec.summary       = %q{Snapshots Github repositories}
+  spec.homepage      = "https://github.com/innvent/github_snapshot"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -19,10 +19,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "awesome_print"
 
   spec.add_dependency "github_api", "~> 0.10.2"
-  spec.add_dependency "rake"
 end

data/lib/github_snapshot/organization.rb

@@ -4,11 +4,10 @@ module GithubSnapshot
 
   class Organization
 
-    attr_reader :name, :folder, :repos
+    attr_reader :name, :repos
 
-    def initialize(name, folder, repos)
+    def initialize(name, repos)
       @name   = name
-      @folder = folder
       @repos  = repos
     end
 

data/lib/github_snapshot/repository.rb

@@ -12,7 +12,7 @@ module GithubSnapshot
 
     def initialize(repo, organization)
       @name           = repo['name']
-      @folder         = "#{organization.folder}/#{@name}-#{GithubSnapshot.time_now}.git"
+      @folder         = "#{@name}-#{GithubSnapshot.time_now}.git"
       @wiki_folder    = @folder.gsub('.git', '.wiki.git')
       @ssh_url        = repo['ssh_url']
       @wiki_ssh_url   = @ssh_url.gsub('.git', '.wiki.git')
@@ -35,9 +35,11 @@ module GithubSnapshot
         return nil
       end
 
+      Dir.chdir "#{organization.name}"
       clone
       clone_wiki if self.has_wiki?
       prune_old_backups
+      Dir.chdir ".."
 
       GithubSnapshot.logger.info "#{canonical_name} - success"
     end
@@ -66,13 +68,13 @@ module GithubSnapshot
 
     def prune_old_backups
       GithubSnapshot.logger.info "#{canonical_name} - pruning old backups"
-      file_regex  = "#{organization.folder}/#{name}*"
+      file_regex  = "#{name}*"
       zipped_bkps = FileList[file_regex].exclude(/wiki/)
       zipped_bkps.sort[0..-(GithubSnapshot.releases_to_keep + 1)].each do |file|
         File.delete file
       end if zipped_bkps.length > GithubSnapshot.releases_to_keep
 
-      wiki_regex   = "#{organization.name}/#{name}*wiki*"
+      wiki_regex   = "#{name}*wiki*"
       zipped_wikis = FileList[wiki_regex]
       zipped_wikis.sort[0..-(GithubSnapshot.releases_to_keep + 1)].each do |file|
         File.delete file

data/lib/github_snapshot/snapshot.rb

@@ -79,13 +79,15 @@ module GithubSnapshot
     end
 
     def backup_orgs
+      Dir.chdir "#{backup_folder}"
       organizations.each do |org|
         GithubSnapshot.logger.info "#{org} - initializing"
         repos        = github.repos.list org: org
-        organization = Organization.new org, "#{backup_folder}/#{org}", repos
+        organization = Organization.new org, repos
         organization.backup
         GithubSnapshot.logger.info "#{org} - ending"
       end
+      Dir.chdir ".."
     end
 
     def upload_to_s3

data/lib/github_snapshot/version.rb

@@ -1,3 +1,3 @@
 module GithubSnapshot
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github_snapshot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Artur Rodrigues
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-27 00:00:00.000000000 Z
+date: 2013-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,20 +25,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -81,21 +67,8 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.10.2
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-description: Snapshoting organization's repositories, including wikis
+description: Snapshots multiple organizations GitHub repositories, including wikis,
+  and syncs them to Amazon's S3
 email:
 - arturhoo@gmail.com
 executables:
@@ -116,7 +89,7 @@ files:
 - lib/github_snapshot/snapshot.rb
 - lib/github_snapshot/utilities.rb
 - lib/github_snapshot/version.rb
-homepage: ''
+homepage: https://github.com/innvent/github_snapshot
 licenses:
 - MIT
 metadata: {}
@@ -139,5 +112,5 @@ rubyforge_project:
 rubygems_version: 2.0.7
 signing_key: 
 specification_version: 4
-summary: Snapshoting organization's repositories
+summary: Snapshots Github repositories
 test_files: []