publicity 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nathan Houle
+
+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,22 @@
+# Publicity
+
+Publicize all your (private) forks of Hack Reactor projects.
+
+## Installation
+
+Install it by executing:
+
+    $ gem install publicity
+
+## Usage
+
+Execute `publicity` from any directory and follow the command-line prompt,
+answering any questions until everything is done.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/publicity

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# Command-line parser for Publicity.
+
+THIS_FILE = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
+require File.dirname(THIS_FILE) + '/../lib/publicity'
+
+opts = Publicity::Exec.new(ARGV)
+opts.parse!

data/lib/publicity/host_is_osx.rb

@@ -0,0 +1,3 @@
+module Publicity
+  HOST_IS_OSX = RbConfig::CONFIG['host_os'] =~ /darwin/
+end

data/lib/publicity/prompt.rb

@@ -0,0 +1,302 @@
+require 'andand'
+require 'fileutils'
+require 'highline/import'
+require 'github_api'
+require 'rugged'
+require 'keychain'
+
+module Publicity
+  class Main
+    def initialize
+      @credential_helper = `git config --global credential.helper`.delete("\n")
+      @github = nil
+      @username = nil
+      @auth_type = nil
+
+      prompt
+    end
+
+    def prompt
+      puts <<EOS
+PUBLICITY
+=========
+
+Hello! I'm a script that will publicize all of your forked repositories.
+
+EOS
+      ask("Press enter when you're ready.") { |q| q.echo = '' }
+
+      # Clear the screen
+      print "\e[2J\e[f"
+
+      puts "I'll need your GitHub credentials to get started.", ''
+      get_github_credentials!
+
+      puts <<EOS
+
+Thanks.
+
+One more thing--this script will create a new readme for each of your projects.
+The readme will point to a project you think shows off your skills; you should
+pick a project you're proud of, and you should avoid picking a group project.
+
+EOS
+      project = get_project_info
+
+      # Gather a list of the user's repos which are forked from the hackreactor
+      # organization and are private. Ask the user which of those repos they'd like
+      # to publicize.
+      remote_repos = Array.new
+      private_repos = get_private_repos
+      if private_repos.length === 0
+        puts "Sorry, doesn't look like you have any private forks. Exiting..."
+        exit 0
+      end
+
+      private_repos.each do |private_repo|
+        response = ask("Would you like to publicize the #{private_repo[:name]} repository? (y/n): ") do |q|
+          q.validate = /^(y|n)$/i
+          q.responses[:not_valid] = "Sorry, that's an invalid option. Please enter either y or n: "
+        end
+        remote_repos.push(private_repo) if response === 'y'
+      end
+
+      # Create a scratch directory where we'll clone all our repos. This repo
+      # will get cleaned up after the begin block.
+      tmpdir = Dir.mktmpdir(nil, '/tmp')
+      begin
+        if @auth_type === 'basic'
+          # If the user is using basic auth, we'll need to put their credentials
+          # somewhere Git can access.
+          `git config --global credential.helper store`
+          tmpcreds = File.open("#{Dir.home}/.git-credentials", 'w', 0664) do |f|
+            f.write("https://#{@username}:#{@github.current_options[:password]}@github.com")
+            f
+          end
+        elsif @auth_type === 'keychain'
+          `git config --global credential.helper osxkeychain`
+        else
+          raise StandardError, "Unknown credential helper"
+        end
+
+        remote_repos.each do |remote_repo|
+          puts "Cloning down #{remote_repo[:name]}..."
+
+          dir = "#{tmpdir}/#{remote_repo[:name]}.git"
+
+          # Clone the original repo
+          `git clone --bare #{remote_repo.clone_url} #{dir} 1> /dev/null`
+
+          puts "Finished cloning."
+
+          # Wrap the cloned git directory in a libgit wrapper
+          local_repo = Rugged::Repository.new(dir)
+
+          # Get a list of all the branches, and filter out irrelevant branches
+          regex = /(#{Regexp.quote(@username)}|master)/
+          branches = Rugged::Branch.each_name(local_repo).sort.select { |branch| branch =~ regex }
+
+          # Ask the user which branch they want to keep; we'll end up deleting
+          # all other branches. Skip over this prompt if the repo only has a
+          # :master branch.
+          puts <<EOS
+
+I'll now take a branch of your choosing and make it your master branch. This
+way, anyone who looks at your repository will see your code right away, rather
+than the repository's boilerplate code.
+
+EOS
+          if branches.include?('master') and branches.length === 1
+            branch_name = 'master'
+            puts "Only found branch `#{branch_name}`. Using that one."
+          else
+            puts "Here's a list of the branches you can keep:", ''
+            branches.each { |branch| puts branch }
+            puts ''
+
+            branch_name = ask("Please enter the name of the branch you'd like to keep: ") do |q|
+              # Validate that the string isn't just whitespace and that it's a
+              # valid branch name. First check is sort of redundant, but whatev.
+              q.validate = lambda { |p| p =~ /^(?!\s*$).+/ and branches.include?(p) }
+              q.responses[:not_valid] = "Sorry, that's an invalid branch name. Please enter the name of the branch you'd like to keep: "
+            end
+          end
+
+          # Replace the master branch with the user's branch. This ensures that
+          # anyone viewing the repo on GitHub is first presented with the user's
+          # code, not some empty boilerplate project.
+          if not branch_name =~ /^master$/
+            Rugged::Branch.lookup(local_repo, branch_name)
+          end
+
+          # Delete all remote branches
+          Rugged::Branch.each_name(local_repo, :remote).sort.each do |r|
+            if not r =~ /^master$/
+              Rugged::Branch.lookup(local_repo, r).delete!
+            end
+          end
+
+          # Generate a readme and commit it to the repository.
+          create_readme!(local_repo, project)
+
+          # Rename the source repo on GitHub to make way for the (nicenamed) new
+          # repository.
+          @github.repos.edit @username, "#{remote_repo[:name]}",
+            :name => "#{remote_repo[:name]}.old",
+            :private => true
+
+          # Create an endpoint for the new repository.
+          options = {
+            :name => remote_repo[:name],
+            :description => 'A project I did at Hack Reactor',
+            :homepage => 'http://hackreactor.com',
+            :has_issues => false,
+            :has_wiki => false
+          }
+          @github.repos.create options
+
+          # Push the processed repository back up
+          puts '', 'Pushing up your processed repository...'
+          Dir.chdir(dir)
+          # Write to ~/.netrc and ensure delete afterward. Move mktmpdir into
+          # that block.
+          `git push -u #{remote_repo[:clone_url]} master 1> /dev/null`
+
+          # Display a different message if this is the last item
+          if remote_repos.index(remote_repo) === remote_repos.length - 1
+            puts "Finished with #{remote_repo[:name]}. Moving on to the next repository...", ''
+          else
+            puts "Finished with #{remote_repo[:name]}. All repos processed.", ''
+          end
+        end
+        # Each user currently has two versions of each repo up on GitHub--a
+        # private one called reponame.old, and a public one without the .old
+        # suffix. Offer to delete all the old, private repos.
+        puts <<EOS
+All your repos have been pushed up to GitHub. Please review all your newly
+pushed repos to make sure they look okay.
+
+EOS
+        delete_branches = ask("Would you like me to delete the old, private versions of your repos? (y/n) ") do |q|
+          q.validate = /^(y|n)$/i
+          q.responses[:not_valid] = "Sorry, that's an invalid option. Please enter either y or n: "
+        end
+
+        if delete_branches === 'y'
+          remote_repos.each do |private_repo|
+            @github.repos.delete(@username, "#{private_repo[:name]}.old")
+          end
+        end
+      ensure
+        # Make sure we tidy up after ourselves
+        `git config --global credential.helper '#{@credential_helper}'`
+        FileUtils.remove_entry(tmpdir) if tmpdir
+        FileUtils.remove_entry("#{Dir.home}/.git-credentials") if tmpcreds
+      end
+      puts <<EOS
+
+All your repos are now public. Please note that any of the repos this script
+processed are now out of sync with your local versions; before making any
+changes to local copies of these repos, please refresh from GitHub.
+
+Enjoy!
+EOS
+    end
+
+    def get_github_credentials
+      # TODO: Set a flag guarding Keychain access. If we try to access GitHub and the
+      # user's credentials fail, this will prevent us from looping over invalid
+      # keychain credentials over and over.
+
+      # If we're on OS X and can retrieve GitHub credentials from the keychain,
+      # use those. If the keychain is unavailable, or if we weren't able to
+      # retrieve GitHub credentials from it, we'll prompt the user for their
+      # credentials.
+      if Publicity::HOST_IS_OSX
+        item = Keychain.items.find { |i| i.label =~ /github\.com/ }
+      end
+
+      # Create an instance of the GitHub API. We'll use this to make all GitHub
+      # requests
+      @github = Github.new do |config|
+        if item
+          @auth_type = 'keychain'
+          config.login = item.account
+          config.password = item.password
+        else
+          @auth_type = 'basic'
+          config.login = ask("Enter your GitHub username: ") { |q| q.echo = true }
+          config.password = ask("And your password: ") { |q| q.echo = "*" }
+        end
+      end
+    end
+
+    def get_github_credentials!
+      begin
+        get_github_credentials
+        # Try to access something that requires credentials to test if these
+        # credentials are valid
+        @github.authorizations.list
+      rescue
+        puts '', "Sorry, login to GitHub failed. Please re-enter your credentials."
+        retry
+      end
+      @username = @github.current_options[:login]
+      @github
+    end
+
+    def get_project_info
+      project = Hash.new
+      project[:name] = ask("Please enter the name of that project: ")
+      project[:url] = ask("Please enter the URL to that project's GitHub repository, or to where it's hosted:")
+      puts ''
+      project
+    end
+
+    def get_private_repos
+      result = Array.new
+
+      @github.repos.list do |repo|
+        # The version of repo that comes with github.repos.list only has a
+        # limited subset of the repo's metadata--get the full version
+        repo = @github.repos.get(@username, repo[:name])
+
+        # If the repo is still private and it's a fork of a Hack Reactor repo,
+        # it qualifies for liberation
+        if repo[:private] and repo[:parent].andand[:owner].andand[:login] === 'hackreactor'
+          result.push repo
+        end
+      end
+
+      result
+    end
+
+    def create_readme!(repo, data)
+      text = <<EOS
+##{data[:name]}
+
+This is a copy of the work I did on a private repo, originally a project from
+the [Hack Reactor](http://hackreactor.com) curriculum. This project was worked
+on with a pair, and as such is representative of the kind of problems that I've
+tackled, but not of my solo work.
+
+For a better perspective on my own work, please see #{data[:name]}(#{data[:url]}).
+EOS
+
+      oid = repo.write(text, :blob)
+      index = Rugged::Index.new
+      index.add(:path => "README.md", :oid => oid, :mode => 0100644)
+
+      options = {}
+      options[:tree] = index.write_tree(repo)
+
+      options[:author] = { :email => "accounts@hackreactor.com", :name => 'Hack Reactor', :time => Time.now }
+      options[:committer] = { :email => "accounts@hackreactor.com", :name => 'Hack Reactor', :time => Time.now }
+      options[:message] ||= "Added an automatically generated readme"
+      options[:parents] = repo.empty? ? [] : [ repo.head.target ].compact
+      options[:update_ref] = 'HEAD'
+
+      Rugged::Commit.create(repo, options)
+    end
+  end
+end

data/lib/publicity/version.rb

@@ -0,0 +1,3 @@
+module Publicity
+  VERSION = "0.0.1"
+end

data/lib/publicity.rb

@@ -0,0 +1,63 @@
+require 'optparse'
+require 'publicity/host_is_osx'
+require 'publicity/prompt'
+require 'publicity/version'
+
+module Publicity
+  # Kicks off the parsing process by parsing command-line arguments and calling
+  # the method that parses each input file.
+  class Exec
+    # @param args [Array<String>] All command-line arguments
+    def initialize(args)
+      @args = args
+      @options = {}
+    end
+
+    # Parses the command-line arguments and begins parsing the files.
+    #
+    # @see #parse
+    def parse!
+      parse
+      exit 0
+    end
+
+    # Parses the command-line arguments and begins parsing the files.
+    #
+    # @see #parse!
+    def parse
+      @opts = OptionParser.new(&method(:set_opts))
+      @opts.parse!(@args)
+
+      process_result
+    end
+
+    # Takes the command-line arguments and parses them for optparse.
+    #
+    # @param opts [OptionParser]
+    def set_opts(opts)
+      opts.banner = <<EOS
+publicity v#{Publicity::VERSION}
+
+Description:
+
+TODO
+
+Usage (from within a .git repository):
+
+  publicity [options]
+
+Options:
+EOS
+
+      opts.on_tail( '-h', '--help', 'Display this screen' ) do
+        puts opts
+        exit
+      end
+    end
+
+    # Kickstarts the script prompt
+    def process_result
+      Publicity::Main.new
+    end
+  end
+end

data/publicity.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'publicity/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "publicity"
+  spec.version       = Publicity::VERSION
+  spec.authors       = ["Nathan Houle"]
+  spec.email         = ["nathan@nathanhoule.com"]
+  spec.description   = %q{Publicize private forks of Hack Reactor project repositories}
+  spec.summary       = %q{This script will go through a user's GitHub profile, prompting the user to make public any private forks of Hack Reactor repositories. It'll then move those private repos out of the way and push up a new repository that contains a new readme and is public. It'll then offer to remove the user's old repos.}
+  spec.homepage      = "https://github.com/hackreactor/publicity"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec", "~> 2.13.0"
+  spec.add_development_dependency "rake"
+
+  spec.add_runtime_dependency "andand", "~> 1.3.3"
+  spec.add_runtime_dependency "highline", "~> 1.6.18"
+  spec.add_runtime_dependency "github_api", "~> 0.9.7"
+  spec.add_runtime_dependency "keychain_services", "~> 0.1.1"
+  spec.add_runtime_dependency "rugged", "0.18.0.b1"
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: publicity
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nathan Houle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: andand
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.18
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.18
+- !ruby/object:Gem::Dependency
+  name: github_api
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.7
+- !ruby/object:Gem::Dependency
+  name: keychain_services
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: rugged
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.b1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.b1
+description: Publicize private forks of Hack Reactor project repositories
+email:
+- nathan@nathanhoule.com
+executables:
+- publicity
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/publicity
+- lib/publicity.rb
+- lib/publicity/host_is_osx.rb
+- lib/publicity/prompt.rb
+- lib/publicity/version.rb
+- publicity.gemspec
+homepage: https://github.com/hackreactor/publicity
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: This script will go through a user's GitHub profile, prompting the user to
+  make public any private forks of Hack Reactor repositories. It'll then move those
+  private repos out of the way and push up a new repository that contains a new readme
+  and is public. It'll then offer to remove the user's old repos.
+test_files: []
+has_rdoc: