backup_on_the_go 0.1.5 → 0.2.2

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YzM0MTI2YTgwZDhlMzk4YmVkM2Q4Y2UxOGI0NjM3N2JhZjlmNDk5YQ==
-  data.tar.gz: !binary |-
-    ZTY3MDI4ZTI3ZGRjNzRhNGMzYWVkMzA2ODNhZDY2ZmIxODgxNzExMQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    NzcyZWM0NjZhY2NkYTU1YzRjMmVmODgyNjFkZDc5ZDA0MDQ4ODUxNDllYTFm
-    YTUyZDc2MGVhMjRlZDIzM2MyMTMxYTI5NGJhNWFmMmQ2NzU0ODUxMjQ1OWFj
-    OGJjOTdkMjdjMWMxZGM2ZGVhMGFkYWRhOGU2ZGY5OGFiNzRhZDY=
-  data.tar.gz: !binary |-
-    ZjUyZGFiMDcyMWM3MTMwMjg4Zjk0MDEzOGJlMjNhYWM1OGY5OWMwYzRhNmNj
-    ODIyM2ZjMDhhOTVhMTJiMmM5ZWYzMTYzMDZhNDg0MDEzNDM5NzIzZmFiYzMz
-    MWFkM2Y4ZDZiMGU3OTIzNTRhNDE4N2QzMWQxODJjOGE0YjdjODM=
+SHA1:
+  metadata.gz: 74d66dc8e67ff27c2920c630c0cb04f4e11f7377
+  data.tar.gz: 442f688f41e905f920ae82f05a340421385954e4
+SHA512:
+  metadata.gz: ed89ec5e52c44b13810ac322d4098dd4ea0ffda0936822cf72c9400c01bdd2192c8639464167a76861ff5810dcf2acb8a842a3c008b0f5b9353b6aa3efdc18bb
+  data.tar.gz: 77c41424789d658bfe81782ea151091e14f38f92c2d55d152c1230f7f41eb39aac9b5d261ee3a0dd0ea686727003cdd534d5ac9a696a73f484f5d848b9f0ecd7

data/README.md

@@ -61,9 +61,22 @@ dyno instead of the web dyno:
 Done!
 
 
+## Real World Examples
+
+For a real world example, you can check [my backup BitBucket Account][]. For
+another example of backing up organizations, see EditorConfig on [GitHub][4]
+and [BitBucket][5].
+
+
+
+[![githalytics.com alpha](https://cruel-carlota.pagodabox.com/6f3b3972996375aafd08f51e6ed619cc "githalytics.com")](http://githalytics.com/xuhdev/backup-on-the-go)
+
 [1]: https://rubygems.org/gems/backup_on_the_go
 [2]: http://rubydoc.info/github/xuhdev/backup-on-the-go/master/frames
 [3]: http://rubydoc.info/github/xuhdev/backup-on-the-go/master/BackupOnTheGo.backup
-[heroku_signup]: https://id.heroku.com/signup
+[4]: https://github.com/editorconfig
+[5]: https://bitbucket.org/editorconfig
 [Heroku Toolbelt]: https://toolbelt.heroku.com/
+[My backup BitBucket Account]: https://bitbucket.org/xuhdev-backup
+[heroku_signup]: https://id.heroku.com/signup
 [scale your dyno formation]: https://devcenter.heroku.com/articles/scaling

data/lib/backup_on_the_go.rb

@@ -11,6 +11,7 @@ module BackupOnTheGo #:nodoc:#
 
   DEFAULT_CONFIG = {
     :backup_fork => false,
+    :backup_private => false,
     :git_cmd => 'git',
     :github_repos_max => '200',
     :is_private => true,
@@ -19,29 +20,43 @@ module BackupOnTheGo #:nodoc:#
     :verbose => true
   }.freeze
 
-  # Backup GitHub repositories to BitBucket.
+
+  # Back up GitHub repositories to BitBucket.
   #
   # = Parameters
-  # * <tt>:backup_fork</tt> - Optional boolean - <tt>true</tt> to backup forked repositories, <tt>false</tt> to skip them. Default is <tt>false</tt>.
+  # * <tt>:backup_fork</tt> - Optional boolean - <tt>true</tt> to back up forked repositories, <tt>false</tt> to skip them. Default is <tt>false</tt>.
+  # * <tt>:backup_private</tt> - Optional boolean - <tt>true</tt> to back up private repositories, <tt>false</tt> to NOT back up private repositories. Default is <tt>false</tt>.
   # * <tt>:bitbucket_password</tt> - Optional string - The password to access the BitBucket account. If not specified, a prompt will show up to ask for the password.
   # * <tt>:bitbucket_repos_owner</tt> - Optional string - Owner of the backup repositories on BitBucket. The owner could be a team. If not specified, <tt>:bitbucket_user</tt> will be used.
   # * <tt>:bitbucket_user</tt> - *Required* string if <tt>:user</tt> is not specified - The user name on BitBucket. If not specified, <tt>:user</tt> will be used.
   # * <tt>:git_cmd</tt> - Optional string - The git command you want to use. Default is 'git'.
+  # * <tt>:github_password</tt> - Optional string - When backup_private is set to true, this is the password used to access the GitHub account. If not specified, a prompt will show up to ask for the password.
   # * <tt>:github_repos_max</tt> - Optional string - The max number of your GitHub repos, since GitHub API requires to give a repo number upper limit. Usually you don't need to set up this number unless you have more than 200 repositories. Default is <tt>"200"</tt>.
   # * <tt>:github_repos_owner</tt> - Optional string - The owner of the repositories that need to be backed up. The owner could be an organization. If not specified, <tt>:github_user</tt> will be used.
   # * <tt>:github_user</tt> - *Required* string if <tt>:user</tt> is not specified - The user name on GitHub. If not specified, <tt>:user</tt> will be used.
-  # * <tt>:is_private</tt> - Optional boolean - <tt>true</tt> to make the backup repositories private, <tt>false</tt> to make them public. Default is <tt>true</tt>.
-  # * <tt>:no_public_forks</tt> - Optional boolean - <tt>true</tt> to forbid public fork for the backup repositories, <tt>false</tt> to allow public fork. Default is <tt>true</tt>.
+  # * <tt>:is_private</tt> - Optional boolean - <tt>true</tt> to make the backup repositories private even if the corresponding github repositories are public; <tt>false</tt> to keep the original privacy. Default is <tt>true</tt>.
+  # * <tt>:no_public_forks</tt> - Optional boolean - <tt>true</tt> to forbid public fork for the backup repositories, <tt>false</tt> to allow public fork. Only valid for public backup repositories. Default is <tt>true</tt>.
   # * <tt>:repo_prefix</tt> - Optional string - The prefix you wanna prepend to the backup repository names. In this way, if you have a repository with the same name on BitBucket, it won't get flushed. Default is <tt>"backup-on-the-go-"</tt>.
   # * <tt>:user</tt> - *Required* string if <tt>:github_user</tt> and <tt>:bitbucket_user</tt> are not both specified - The user name of GitHub and BitBucket (if they are same for you). If you want to use different user names on GitHub and BitBucket, please specify <tt>:github_user</tt> and <tt>:bitbucket_user</tt> instead.
   # * <tt>:verbose</tt> - Optional boolean - <tt>true</tt> to print additional information and <tt>false</tt> to suppress them. Default is <tt>true</tt>.
   #
   # = Examples
   #  
-  #  # Back up personal repositories
+  #  # Back up personal public repositories only
+  #  BackupOnTheGo.backup :github_user => 'github_user_name',
+  #  :bitbucket_user => 'bitbucket_user_name',
+  #  :is_private => false,    # make backup repositories public
+  #  :bitbucket_password => 'bitbucket_password',
+  #  :repo_prefix => ''      # don't need any prefix
+  #
+  # = Examples
+  #
+  #  # Back up personal public and private repositories
   #  BackupOnTheGo.backup :github_user => 'github_user_name',
   #  :bitbucket_user => 'bitbucket_user_name',
+  #  :backup_private => true,   # back up private repositories
   #  :is_private => false,    # make backup repositories public
+  #  :github_password => 'github_password',
   #  :bitbucket_password => 'bitbucket_password',
   #  :repo_prefix => ''      # don't need any prefix
   #
@@ -77,11 +92,19 @@ module BackupOnTheGo #:nodoc:#
       config[:bitbucket_repos_owner] = config[:bitbucket_user]
     end
 
-    # Ask for the password if it is not specified
+    # Ask for the passwords if they are not specified
+    if config[:backup_private] and !config.has_key?(:github_password)
+      config[:github_password] = ask("Enter your GitHub password for #{config[:github_user]}: ") { |q| q.echo = false }
+    end
     unless config.has_key?(:bitbucket_password)
-      config[:bitbucket_password] = ask("Enter your BitBucket password: ") { |q| q.echo = false }
+      config[:bitbucket_password] = ask("Enter your BitBucket password for #{config[:bitbucket_user]}: ") { |q| q.echo = false }
     end
 
+    # print an empty line
+    puts
+
+    # log in BitBucket
+
     bb = BitBucket.new :login => config[:bitbucket_user], :password => config[:bitbucket_password]
 
     backup_repo_names = Array.new
@@ -92,13 +115,12 @@ module BackupOnTheGo #:nodoc:#
       end
     end
 
-    # obtain github repos
-    gh_repos = Github.repos.list :user => config[:github_repos_owner],
-      :per_page => config[:github_repos_max]
-
-    gh_repos.each do |repo|
+    # handling each GitHub repo, used below
+    repo_each_proc = Proc.new do |repo|
       next if repo.fork && !config[:backup_fork]
 
+      is_private = config[:is_private] || repo.private?
+
       puts "Backing up #{repo.name}..." if config[:verbose]
 
       backup_repo_name = "#{config[:repo_prefix]}#{repo.name}"
@@ -108,7 +130,8 @@ module BackupOnTheGo #:nodoc:#
         puts "Creating new repository #{config[:bitbucket_repos_owner]}/#{backup_repo_name}..." if config[:verbose]
         begin
           bb.repos.create :name => backup_repo_name, :owner => config[:bitbucket_repos_owner],
-            :scm => 'git', :is_private => config[:is_private], :no_public_forks => config[:no_public_forks]
+            :scm => 'git', :is_private => is_private,
+            :no_public_forks => config[:no_public_forks]
         rescue
           puts_warning "Creation of repository #{config[:bitbucket_repos_owner]}/#{backup_repo_name} failed."
         end
@@ -120,17 +143,22 @@ module BackupOnTheGo #:nodoc:#
         bb.repos.edit config[:bitbucket_repos_owner], backup_repo_name,
           :website => repo.homepage,
           :description => repo.description,
-          :is_private => config[:is_private],
-          :no_public_forks => config[:no_public_forks]
-      rescue
+          :is_private => is_private,
+          :no_public_forks => is_private && config[:no_public_forks]
+      rescue Exception => e
         puts_warning "Failed to update information for #{config[:bitbucket_repos_owner]}/#{backup_repo_name}"
+        puts e.message
       end
 
       Dir.mktmpdir do |dir|
-        cmd = "#{config[:git_cmd]} clone --mirror #{repo.git_url} #{dir}/tmp-repo"
-        puts "Executing #{cmd}" if config[:verbose]
+        # clone git url
+        clone_url = repo.clone_url
+        clone_url.sub!(/https:\/\//,
+                       "https://#{config[:github_user]}:#{config[:github_password]}@") if config[:backup_private]
+        cmd = "#{config[:git_cmd]} clone --mirror '#{clone_url}' #{dir}/tmp-repo"
+        puts "Executing [#{config[:git_cmd]} clone --mirror 'https://#{config[:bitbucket_user]}:your_password@github.com/#{config[:github_repos_owner]}/#{repo.name}.git' #{dir}/tmp-repo]" if config[:verbose]
         unless system(cmd)
-          puts_warning "'git clone' failed for #{repo.git_url}\n"
+          puts_warning "'git clone' failed for #{clone_url}\n"
           break
         end
 
@@ -174,6 +202,39 @@ module BackupOnTheGo #:nodoc:#
         puts
       end
     end
+
+    # obtain github repos
+    if config[:backup_private]
+      gh = Github.new :login => config[:github_user], :password => config[:github_password]
+    else
+      gh = Github.new
+    end
+
+    # private repos
+    if config[:backup_private]
+      puts "Backing up private repositories...\n".green
+
+      gh_repos = gh.repos.list :per_page => config[:github_repos_max]
+
+      gh_repos.each do |repo|
+        # only back up private repositories with the owner specified
+        if repo.owner.login == config[:github_repos_owner] and repo.private?
+          repo_each_proc.call(repo)
+        end
+      end
+    end
+
+    # public repos
+    puts "Backing up public repositories...\n".green
+
+    gh_repos = gh.repos.list :user => config[:github_repos_owner],
+      :per_page => config[:github_repos_max]
+
+    gh_repos.each do |repo|
+      repo_each_proc.call(repo)
+    end
+
+
   end
 
   private

data/lib/backup_on_the_go/version.rb

@@ -3,8 +3,8 @@
 module BackupOnTheGo #:nodoc:#
   module VERSION
     MAJOR = 0
-    MINOR = 1
-    TINY  = 5
+    MINOR = 2
+    TINY  = 2
 
     STRING = [MAJOR, MINOR, TINY].compact.join('.')
   end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: backup_on_the_go
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.2
 platform: ruby
 authors:
 - Hong Xu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-06 00:00:00.000000000 Z
+date: 2013-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.11
+        version: 0.10.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.11
+        version: 0.10.1
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.16
+        version: 1.6.19
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.16
+        version: 1.6.19
 - !ruby/object:Gem::Dependency
   name: bitbucket_rest_api
   requirement: !ruby/object:Gem::Requirement
@@ -88,17 +88,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Backup GitHub repositories to BitBucket