github-copywriter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 042abefd4aaf029250ac23d3e3c2922ff1226830
+  data.tar.gz: 91effc0c7e326866d4b5b1bfcd3adc19a42edb0e
+SHA512:
+  metadata.gz: 0c20d89f92d42dcbfb72770e2d7d05956440f79f4799cd3b4057dba93cf691524ed346319a65ef95f46a1d66e27bcaf931f24de786694058b4db2ec3c787413e
+  data.tar.gz: 399848ed05d2e4d63277a31426fb334cdd267292ae503254c7bfc8db6ab68235748a404c489532942ad802f3b84152fae282909c7ae3f29fa85ddc697986747c

data/.gitignore

@@ -0,0 +1,22 @@
+# Added by bundler
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+# Jekyll build
+_site
+
+# Vim
+.*.swp
+.*.swo

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ryan Jacobs
+
+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,40 @@
+# github-copywriter
+
+Updates your copyrights... so you don't have to!
+
+`$ gem install github-copywriter`
+
+---
+
+### Update specific repos
+`$ github-copywriter MyCoolRepo MyOtherCoolRepo`
+
+### Update all repos
+`$ github-copywriter --all`
+
+### Update all repos, excluding forks
+`$ github-copywriter --all --skip-forks`
+
+---
+
+## Contributing
+Please submit issues or feature requests [here](//github.com/ryanmjacobs/github-copywriter/issues).
+Questions and comments are fine too :)
+
+Feel free to [fork](//github.com/ryanmjacobs/github-copywriter) this project, and:
+
+* fix bugs
+* add some sweet features
+* implement feature requests
+* improve the docs and/or this site
+
+---
+
+## Under the hood
+All GitHub API calls are made with [Octokit](//github.com/octokit/octokit.rb).
+
+####Basic breakdown of the program's logic:
+1. Authenticate to GitHub.
+2. Loop through each user repo given, and:
+    * Update copyrights on files: `README.md`, `LICENSE`, etc.
+    * Create a local commit and push to GitHub.

data/Rakefile

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

data/bin/github-copywriter

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+################################################################################
+# github-copywriter
+#
+# Author: Ryan Jacobs <ryan.mjacobs@gmail.com
+################################################################################
+
+require "github-copywriter"
+require "optparse"
+
+options = {}
+
+ARGV << "-h" if ARGV.empty?
+OptionParser.new do |opts|
+    executable_name = File.split($0)[1]
+    opts.banner = <<-EOS
+Updates your copyrights... so you don't have to!
+
+Usage: #{executable_name} [repos...]
+       #{executable_name} --all
+
+    EOS
+
+    opts.on("--all", "Update copyrights on ALL repositories.") do
+        options[:all] = true
+    end
+
+    opts.on("-s", "--skip-forks", "Don't update forked repositories.") do
+        options[:skip_forks] = true
+    end
+
+    opts.on_tail("-h","--help", "Show this message.") do
+        puts opts
+        exit
+    end
+
+    opts.on_tail("-v", "--version", "Print the version.") do
+        puts "github-copywriter v#{Copywriter::VERSION}"
+        exit
+    end
+end.parse!
+
+if ARGV.empty? and not options[:all]
+    puts "error: No repositories supplied!"
+    exit
+end
+
+options[:repos] = ARGV
+
+Copywriter.login!
+Copywriter.run!(options)

data/github-copywriter.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "github-copywriter"
+
+Gem::Specification.new do |spec|
+  spec.name          = "github-copywriter"
+  spec.version       = Copywriter::VERSION
+  spec.authors       = ["Ryan Jacobs"]
+  spec.email         = ["ryan.mjacobs@gmail.com"]
+  spec.summary       = %q{github-copywriter updates your copyrights... so you don't have to!}
+  spec.description   = %q{github-copywriter scans through your repositories and updates any copyrights it finds.}
+  spec.homepage      = "http://ryanmjacobs.github.io/github-copywriter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency "octokit"  # GitHub API
+  spec.add_runtime_dependency "colorize" # Colorize text
+end

data/lib/github-copywriter.rb

@@ -0,0 +1,209 @@
+################################################################################
+# github-copywriter
+#
+# Author: Ryan Jacobs <ryan.mjacobs@gmail.com
+################################################################################
+
+require "highline/import"
+require "octokit"
+require "base64"
+require "colorize"
+require "pp" # debug tool
+
+module Copywriter
+    extend self
+
+    VERSION    = "0.0.1"
+    COMMIT_MSG = "Update copyright. ♥ github-copywriter\nFor more info, visit http://ryanmjacobs.github.io/github-copywriter"
+
+    # Get time/date
+    time = Time.now
+    CUR_YEAR = time.year
+
+    def login!
+        # Grab username and pass
+        puts "Obtaining OAuth2 access_token from github."
+        username = ask("GitHub username: ") { |q| q.echo = true }
+        password = ask("GitHub password: ") { |q| q.echo = "*" }
+
+        # Auth to GitHub
+        @client = Octokit::Client.new(:login => username, :password => password)
+
+        # Check if the basic_auth worked; TODO: Find a better way to do this
+        begin
+            @client.authorizations
+        rescue Octokit::Unauthorized
+            puts "error: Bad credentials".red
+            exit
+        end
+    end
+
+    ##
+    # Returns true if this is a file that we will update.
+    def accepted_name?(filename)
+        filename = File.basename(filename)
+
+        names      = ["readme", "license"]
+        extensions = [".md", ".txt", ".html"]
+
+        if names.include?      filename.downcase               then return true end
+        if extensions.include? File.extname(filename.downcase) then return true end
+    end
+
+    ##
+    # Updates copyright using regex, then commits it.
+    #
+    # repo         = Repo to commit to,      e.g. "user/repo_name"
+    # ref          = Branch to commit to,    e.g. "heads/master"
+    # file_path    = File path on repo,      e.g. "readme", "src/file.rb", etc.
+    #
+    def update_copyright(repo, ref, file_path)
+
+        # Grab file from repo
+        file = @client.contents(repo, :path => file_path)
+        if file[:type] != "file" then raise "error: #{file_path} on #{repo} is not a file!" end
+
+        # Have to do separate assignments b/c ruby shares strings,
+        # TODO: find a way around this
+        content     = Base64.decode64(file[:content])
+        old_content = Base64.decode64(file[:content])
+
+        # Do the substitution
+        #
+        # Matches:
+        #     Copyright 2014
+        #     copyright 2014
+        #
+        #     Copyright (C) 2014
+        #     copyright (c) 2014
+        #     Copyright © 2014
+        #     copyright © 2014
+        #
+        #     (c) 2014
+        #     (C) 2014
+        #     © 2014
+        begin
+            content.gsub!(/([Cc]opyright( \([Cc]\)| ©)|\([Cc]\)|©) \d{4}/, "\\1 #{CUR_YEAR}")
+        rescue
+            # try w/o "©" symbol if we had errors
+            content.gsub!(/([Cc]opyright( \([Cc]\))|\([Cc]\)) \d{4}/, "\\1 #{CUR_YEAR}")
+        end
+
+        # Only commit if we need to
+        if content != old_content then
+            @modified_files << {:path => file_path, :content => content}
+            puts "  #{file_path} is now up-to-date.".green
+        else
+            puts "  #{file_path} was already up-to-date."
+        end
+    end
+
+    ##
+    # Commits files to a GitHub repo.
+    #
+    # repo         = Repo to commit to,      e.g. "user/repo_name"
+    # ref          = Branch to commit to,    e.g. "heads/master"
+    # file_mode    = Filemode on repo,       e.g. "100644"
+    # files        = Array of {:path, :content}
+    # commit_msg   = Commit message,         e.g. "Update file.rb"
+    #
+    def commit_files(repo, ref, file_mode, files, commit_msg)
+
+        # Return if we don't have any files to commit
+        if files.size == 0 then return end
+
+        # Force file_mode to be either 100644 or 100775
+        if file_mode != "100644" or file_mode != "100775" then
+           file_mode = "100644"
+        end
+
+        # Construct temp. tree of files to commit
+        trees = Array.new
+        files.each do |file|
+            blob_sha = @client.create_blob(repo, Base64.encode64(file[:content]), "base64")
+
+            trees << {
+                :path => file[:path],
+                :mode => file_mode,
+                :type => "blob",
+                :sha  => blob_sha
+            }
+        end
+
+        # Contruct the commit
+        latest_commit = @client.ref(repo, ref).object
+        base_tree     = @client.commit(repo, latest_commit.sha).commit.tree
+        new_tree      = @client.create_tree(repo, trees, :base_tree => base_tree.sha)
+        new_commit    = @client.create_commit(repo, commit_msg, new_tree.sha, latest_commit.sha)
+
+        # Commit it!
+        @client.update_ref(repo, ref, new_commit.sha)
+    end
+
+    def run!(options={})
+        # Default options
+        options = {all: false, skip_forks: false}.merge(options)
+
+        if options[:all] then
+            repos = @client.repositories()
+        else
+            repos = Array.new
+            options[:repos].each do |r|
+                name = @client.login+"/"+File.basename(r)
+                if @client.repository?(name) then
+                    repos << @client.repository(name)
+                else
+                    puts "error: repo \"#{name}\" does not exist!".red
+                    exit
+                end
+            end
+        end
+
+        # Loop through each repo
+        repos.each do |repo|
+
+            next if options[:skip_forks] and repo[:fork]
+
+            # Get repo info
+            repo_name     = repo[:full_name]
+            ref           = "heads/#{repo[:default_branch]}"
+            latest_commit = @client.ref(repo_name, ref).object
+            root_tree     = @client.commit(repo_name, latest_commit.sha).commit.tree
+            puts "\n"+repo_name+":"
+
+            # Grab the *whole* tree
+            tree = @client.tree(repo_name, root_tree.sha, :recursive => true)
+
+            # warn user about truncation
+            if tree[:truncated] then
+                puts "  warning: tree truncated because number of items exceeded limit.".yellow
+                puts "           If you feel like fixing this, see issue #xx".yellow
+                puts "           http://github.com/ryanmjacobs/github-copywriter/xx".yellow
+            end
+
+            # Stores updated files until we commit
+            # @modified_files is a hash {:path, :content}
+            @modified_files = Array.new
+
+            # Loop through all of the tree's blobs
+            tree[:tree].each do |file|
+                next if file[:type] != "blob"
+
+                if accepted_name?(file[:path]) then
+                    update_copyright(repo_name, ref, file[:path])
+                end
+            end
+
+            # Commit stored up files
+            if @modified_files.size > 0 then
+                print "  Committing #{@modified_files.size} files..."
+                commit_files(repo_name, ref, "100644", @modified_files, COMMIT_MSG)
+                puts " done"
+            else
+                puts "  No files needed to be commited."
+            end
+        end
+    end
+
+    private :update_copyright, :accepted_name?, :commit_files
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: github-copywriter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan Jacobs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  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'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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: github-copywriter scans through your repositories and updates any copyrights
+  it finds.
+email:
+- ryan.mjacobs@gmail.com
+executables:
+- github-copywriter
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/github-copywriter
+- github-copywriter.gemspec
+- lib/github-copywriter.rb
+homepage: http://ryanmjacobs.github.io/github-copywriter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: github-copywriter updates your copyrights... so you don't have to!
+test_files: []