thegarage-gitx 2.5.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0b811de52af14874eb51c9c61fd1394fc6ce510
-  data.tar.gz: a497c02d33bbe70cdc915bbab537f019d20e82d8
+  metadata.gz: a1472845b75ae2e8f0c0a41c0ff1d19eda8813af
+  data.tar.gz: bbd73d4d28d3d416c3ede2ab3b4334feaae97030
 SHA512:
-  metadata.gz: a7cf35490ed34c5b821d659bf89f7e67450a1718c00f2d1fd63dc4843a837d13565bb3f36ca12e80e7e3c8eb9cdf61e4807c0ef62714bcdc067b7cc2c27e5cd2
-  data.tar.gz: 1d2d0f3cfd6f47ded0614469664a948a73ed5f1237bb8a4f46a97e5100e56616eb6f664673ba50127b11ac3b52e83cc32ead1d32d8234b9a5ca0ea523d9ee8d6
+  metadata.gz: cc00306173a80368159b1a29cd92ce1b14f00fb11b8f6cae0c08bdda557bb4e1749610bec58f22db924c39f27d4b433788ff902772a14202007ecd2d29785492
+  data.tar.gz: e9b309a00bae2aef338e1fc05af23618f2be9553cd850252c04b3456f0a8e4664fbe536970c05a0819b3d8b2ee12aa8f2f598fa778bb0e05408d768535eb13c3

data/lib/thegarage/gitx/cli/github.rb

@@ -0,0 +1,133 @@
+require 'octokit'
+
+module Thegarage
+  module Gitx
+    module Cli
+      module Github
+        CLIENT_URL = 'https://github.com/thegarage/thegarage-gitx'
+        PULL_REQUEST_FOOTER = <<-EOS.dedent
+          # Pull Request Protips(tm):
+          # * Include description of how this change accomplishes the task at hand.
+          # * Use GitHub flavored Markdown http://github.github.com/github-flavored-markdown/
+          # * Review CONTRIBUTING.md for recommendations of artifacts, links, images, screencasts, etc.
+          #
+          # This footer will automatically be stripped from the pull request description
+        EOS
+
+        def find_or_create_pull_request(branch)
+          pull_request = find_pull_request(branch)
+          pull_request ||= begin
+            UpdateCommand.new.update
+            pull_request = create_pull_request(branch)
+            say 'Created pull request: '
+            say pull_request.html_url, :green
+
+            pull_request
+          end
+          pull_request
+        end
+
+        # @return [Sawyer::Resource] data structure of pull request info if found
+        # @return nil if no pull request found
+        def find_pull_request(branch)
+          head_reference = "#{github_organization}:#{branch}"
+          params = {
+            head: head_reference,
+            state: 'open'
+          }
+          pull_requests = github_client.pull_requests(github_slug, params)
+          pull_requests.first
+        end
+
+        # @see http://developer.github.com/v3/pulls/
+        def create_pull_request(branch)
+          say "Creating pull request for "
+          say "#{branch} ", :green
+          say "against "
+          say "#{Thegarage::Gitx::BASE_BRANCH} ", :green
+          say "in "
+          say github_slug, :green
+
+          title = branch
+          body = pull_request_body(branch)
+          github_client.create_pull_request(github_slug, Thegarage::Gitx::BASE_BRANCH, branch, title, body)
+        end
+
+        def pull_request_body(branch)
+          changelog = run_cmd "git log #{Thegarage::Gitx::BASE_BRANCH}...#{branch} --no-merges --pretty=format:'* %s%n%b'"
+          description = options[:description]
+
+          description_template = []
+          description_template << "#{description}\n" if description
+          description_template << '### Changelog'
+          description_template << changelog
+          description_template << PULL_REQUEST_FOOTER
+
+          body = ask_editor(description_template.join("\n"), repo.config['core.editor'])
+          body.gsub(PULL_REQUEST_FOOTER, '').chomp.strip
+        end
+
+        # token is cached in local git config for future use
+        # @return [String] auth token stored in git (current repo, user config or installed global settings)
+        # @see http://developer.github.com/v3/oauth/#scopes
+        # @see http://developer.github.com/v3/#user-agent-required
+        def authorization_token
+          auth_token = repo.config['thegarage.gitx.githubauthtoken']
+          return auth_token unless auth_token.to_s.blank?
+
+          auth_token = create_authorization
+          repo.config['thegarage.gitx.githubauthtoken'] = auth_token
+          auth_token
+        end
+
+        def create_authorization
+          password = ask("Github password for #{username}: ", :echo => false)
+          say ''
+          client = Octokit::Client.new(login: username, password: password)
+          response = client.create_authorization(authorization_request_options)
+          response.token
+        end
+
+        def authorization_request_options
+          timestamp = Time.now.utc.strftime('%Y-%m-%dT%H:%M:%S%z')
+          client_name = "The Garage Git eXtensions - #{github_slug} #{timestamp}"
+          options = {
+            :scopes => ['repo'],
+            :note => client_name,
+            :note_url => CLIENT_URL
+          }
+          two_factor_auth_token = ask("Github two factor authorization token (if enabled): ", :echo => false)
+          say ''
+          options[:headers] = {'X-GitHub-OTP' => two_factor_auth_token} if two_factor_auth_token
+          options
+        end
+
+        def github_client
+          @client ||= Octokit::Client.new(:access_token => authorization_token)
+        end
+
+        # @return [String] github username (ex: 'wireframe') of the current github.user
+        # @raise error if github.user is not configured
+        def username
+          username = repo.config['github.user']
+          fail "Github user not configured.  Run: `git config --global github.user 'me@email.com'`" unless username
+          username
+        end
+
+        # @return the github slug for the current repository's remote origin url.
+        # @example
+        #   git@github.com:socialcast/thegarage/gitx.git #=> thegarage/gitx
+        # @example
+        #   https://github.com/socialcast/thegarage/gitx.git #=> thegarage/gitx
+        def github_slug
+          remote = repo.config['remote.origin.url']
+          remote.to_s.gsub(/\.git$/,'').split(/[:\/]/).last(2).join('/')
+        end
+
+        def github_organization
+          github_slug.split('/').first
+        end
+      end
+    end
+  end
+end

data/lib/thegarage/gitx/cli/integrate_command.rb

@@ -2,11 +2,13 @@ require 'thor'
 require 'thegarage/gitx'
 require 'thegarage/gitx/cli/base_command'
 require 'thegarage/gitx/cli/update_command'
+require 'thegarage/gitx/cli/github'
 
 module Thegarage
   module Gitx
     module Cli
       class IntegrateCommand < BaseCommand
+        include Github
         desc 'integrate', 'integrate the current branch into one of the aggregate development branches (default = staging)'
         method_option :resume, :type => :string, :aliases => '-r', :desc => 'resume merging of feature-branch'
         def integrate(integration_branch = 'staging')
@@ -23,6 +25,9 @@ module Thegarage
 
           integrate_branch(branch, integration_branch) unless options[:resume]
           checkout_branch branch
+
+          pull_request = find_or_create_pull_request(branch)
+          create_integrate_comment(pull_request)
         end
 
         private
@@ -83,6 +88,11 @@ module Thegarage
           repo.create_branch(target_branch, Thegarage::Gitx::BASE_BRANCH)
           run_cmd "git push origin #{target_branch}:#{target_branch}"
         end
+
+        def create_integrate_comment(pull_request)
+          comment = '[gitx] integrated into staging :twisted_rightwards_arrows:'
+          github_client.add_comment(github_slug, pull_request.number, comment)
+        end
       end
     end
   end

data/lib/thegarage/gitx/cli/review_command.rb

@@ -2,21 +2,13 @@ require 'thor'
 require 'thegarage/gitx'
 require 'thegarage/gitx/cli/base_command'
 require 'thegarage/gitx/cli/update_command'
-require 'octokit'
+require 'thegarage/gitx/cli/github'
 
 module Thegarage
   module Gitx
     module Cli
       class ReviewCommand < BaseCommand
-        CLIENT_URL = 'https://github.com/thegarage/thegarage-gitx'
-        PULL_REQUEST_FOOTER = <<-EOS.dedent
-          # Pull Request Protips(tm):
-          # * Include description of how this change accomplishes the task at hand.
-          # * Use GitHub flavored Markdown http://github.github.com/github-flavored-markdown/
-          # * Review CONTRIBUTING.md for recommendations of artifacts, links, images, screencasts, etc.
-          #
-          # This footer will automatically be stripped from the pull request description
-        EOS
+        include Github
 
         desc "review", "Create or update a pull request on github"
         method_option :description, :type => :string, :aliases => '-d', :desc => 'pull request description'
@@ -29,6 +21,7 @@ module Thegarage
 
           branch = current_branch.name
           pull_request = find_or_create_pull_request(branch)
+          create_bump_comment(pull_request) if options[:bump]
           assign_pull_request(pull_request) if options[:assignee]
 
           run_cmd "open #{pull_request.html_url}" if options[:open]
@@ -36,70 +29,6 @@ module Thegarage
 
         private
 
-        def find_or_create_pull_request(branch)
-          pull_request = find_pull_request(branch)
-          if pull_request
-            create_bump_comment(pull_request) if options[:bump]
-            pull_request
-          else
-            UpdateCommand.new.update
-            pull_request = create_pull_request(branch)
-            say 'Pull request created: '
-            say pull_request.html_url, :green
-
-            pull_request
-          end
-        end
-
-        # token is cached in local git config for future use
-        # @return [String] auth token stored in git (current repo, user config or installed global settings)
-        # @see http://developer.github.com/v3/oauth/#scopes
-        # @see http://developer.github.com/v3/#user-agent-required
-        def authorization_token
-          auth_token = repo.config['thegarage.gitx.githubauthtoken']
-          return auth_token unless auth_token.to_s.blank?
-
-          auth_token = create_authorization
-          repo.config['thegarage.gitx.githubauthtoken'] = auth_token
-          auth_token
-        end
-
-        def create_authorization
-          password = ask("Github password for #{username}: ", :echo => false)
-          say ''
-          client = Octokit::Client.new(login: username, password: password)
-          response = client.create_authorization(authorization_request_options)
-          response.token
-        end
-
-        def authorization_request_options
-          timestamp = Time.now.utc.strftime('%Y-%m-%dT%H:%M:%S%z')
-          client_name = "The Garage Git eXtensions - #{github_slug} #{timestamp}"
-          options = {
-            :scopes => ['repo'],
-            :note => client_name,
-            :note_url => CLIENT_URL
-          }
-          two_factor_auth_token = ask("Github two factor authorization token (if enabled): ", :echo => false)
-          say ''
-          options[:headers] = {'X-GitHub-OTP' => two_factor_auth_token} if two_factor_auth_token
-          options
-        end
-
-        # @see http://developer.github.com/v3/pulls/
-        def create_pull_request(branch)
-          say "Creating pull request for "
-          say "#{branch} ", :green
-          say "against "
-          say "#{Thegarage::Gitx::BASE_BRANCH} ", :green
-          say "in "
-          say github_slug, :green
-
-          title = branch
-          body = pull_request_body(branch)
-          github_client.create_pull_request(github_slug, Thegarage::Gitx::BASE_BRANCH, branch, title, body)
-        end
-
         def assign_pull_request(pull_request)
           assignee = options[:assignee]
           say "Assigning pull request to "
@@ -113,18 +42,6 @@ module Thegarage
           github_client.update_issue(github_slug, pull_request.number, title, body, options)
         end
 
-        # @return [Sawyer::Resource] data structure of pull request info if found
-        # @return nil if no pull request found
-        def find_pull_request(branch)
-          head_reference = "#{github_organization}:#{branch}"
-          params = {
-            head: head_reference,
-            state: 'open'
-          }
-          pull_requests = github_client.pull_requests(github_slug, params)
-          pull_requests.first
-        end
-
         def create_bump_comment(pull_request)
           comment_template = []
           comment_template << '[gitx] review bump :tada:'
@@ -135,46 +52,6 @@ module Thegarage
           comment = comment.chomp.strip
           github_client.add_comment(github_slug, pull_request.number, comment)
         end
-
-        def github_client
-          @client ||= Octokit::Client.new(:access_token => authorization_token)
-        end
-
-        # @return [String] github username (ex: 'wireframe') of the current github.user
-        # @raise error if github.user is not configured
-        def username
-          username = repo.config['github.user']
-          fail "Github user not configured.  Run: `git config --global github.user 'me@email.com'`" unless username
-          username
-        end
-
-        # @return the github slug for the current repository's remote origin url.
-        # @example
-        #   git@github.com:socialcast/thegarage/gitx.git #=> thegarage/gitx
-        # @example
-        #   https://github.com/socialcast/thegarage/gitx.git #=> thegarage/gitx
-        def github_slug
-          remote = repo.config['remote.origin.url']
-          remote.to_s.gsub(/\.git$/,'').split(/[:\/]/).last(2).join('/')
-        end
-
-        def github_organization
-          github_slug.split('/').first
-        end
-
-        def pull_request_body(branch)
-          changelog = run_cmd "git log #{Thegarage::Gitx::BASE_BRANCH}...#{branch} --no-merges --pretty=format:'* %s%n%b'"
-          description = options[:description]
-
-          description_template = []
-          description_template << "#{description}\n" if description
-          description_template << '### Changelog'
-          description_template << changelog
-          description_template << PULL_REQUEST_FOOTER
-
-          body = ask_editor(description_template.join("\n"), repo.config['core.editor'])
-          body.gsub(PULL_REQUEST_FOOTER, '').chomp.strip
-        end
       end
     end
   end

data/lib/thegarage/gitx/version.rb

@@ -1,5 +1,5 @@
 module Thegarage
   module Gitx
-    VERSION = '2.5.1'
+    VERSION = '2.6.0'
   end
 end

data/spec/thegarage/gitx/cli/integrate_command_spec.rb

@@ -29,8 +29,10 @@ describe Thegarage::Gitx::Cli::IntegrateCommand do
       allow(Thegarage::Gitx::Cli::UpdateCommand).to receive(:new).and_return(fake_update_command)
     end
     context 'when integration branch is ommitted and remote branch exists' do
+      let(:authorization_token) { '123123' }
       let(:remote_branch_names) { ['origin/staging'] }
       before do
+        allow(cli).to receive(:authorization_token).and_return(authorization_token)
         expect(fake_update_command).to receive(:update)
 
         expect(cli).to receive(:run_cmd).with("git fetch origin").ordered
@@ -40,15 +42,70 @@ describe Thegarage::Gitx::Cli::IntegrateCommand do
         expect(cli).to receive(:run_cmd).with("git push origin HEAD").ordered
         expect(cli).to receive(:run_cmd).with("git checkout feature-branch").ordered
 
-        cli.integrate
+        stub_request(:post, /.*api.github.com.*/).to_return(:status => 201)
+
+        VCR.use_cassette('pull_request_does_exist') do
+          cli.integrate
+        end
       end
       it 'defaults to staging branch' do
         should meet_expectations
       end
+      it 'posts comment to pull request' do
+        expect(WebMock).to have_requested(:post, "https://api.github.com/repos/thegarage/thegarage-gitx/issues/10/comments").
+          with(body: {body: '[gitx] integrated into staging :twisted_rightwards_arrows:'})
+      end
+    end
+    context 'when a pull request doesnt exist for the feature-branch' do
+      let(:authorization_token) { '123123' }
+      let(:changelog) { '* made some fixes' }
+      let(:new_pull_request) do
+        {
+          html_url: "https://path/to/html/pull/request",
+          issue_url: "https://api/path/to/issue/url",
+          number: 10,
+          head: {
+            ref: "branch_name"
+          }
+        }
+      end
+      before do
+        allow(cli).to receive(:ask_editor).and_return('description')
+        allow(cli).to receive(:authorization_token).and_return(authorization_token)
+        expect(fake_update_command).to receive(:update).twice
+
+        expect(cli).to receive(:run_cmd).with("git fetch origin").ordered
+        expect(cli).to receive(:run_cmd).with("git branch -D staging", allow_failure: true).ordered
+        expect(cli).to receive(:run_cmd).with("git checkout staging").ordered
+        expect(cli).to receive(:run_cmd).with("git merge feature-branch").ordered
+        expect(cli).to receive(:run_cmd).with("git push origin HEAD").ordered
+        expect(cli).to receive(:run_cmd).with("git checkout feature-branch").ordered
+
+        expect(cli).to receive(:run_cmd).with("git log master...feature-branch --no-merges --pretty=format:'* %s%n%b'").and_return("2013-01-01 did some stuff").ordered
+
+        stub_request(:post, 'https://api.github.com/repos/thegarage/thegarage-gitx/pulls').to_return(:status => 201, :body => new_pull_request.to_json, :headers => {'Content-Type' => 'application/json'})
+        stub_request(:post, 'https://api.github.com/repos/thegarage/thegarage-gitx/issues/10/comments').to_return(:status => 201)
+
+        VCR.use_cassette('pull_request_does_not_exist') do
+          cli.integrate
+        end
+      end
+      it 'creates github pull request' do
+        should meet_expectations
+      end
+      it 'creates github comment for integration' do
+        expect(WebMock).to have_requested(:post, "https://api.github.com/repos/thegarage/thegarage-gitx/issues/10/comments").
+          with(body: {body: '[gitx] integrated into staging :twisted_rightwards_arrows:'})
+      end
+      it 'runs expected commands' do
+        should meet_expectations
+      end
     end
     context 'when staging branch does not exist remotely' do
+      let(:authorization_token) { '123123' }
       let(:remote_branch_names) { [] }
       before do
+        allow(cli).to receive(:authorization_token).and_return(authorization_token)
         expect(fake_update_command).to receive(:update)
 
         expect(repo).to receive(:create_branch).with('staging', 'master')
@@ -62,15 +119,24 @@ describe Thegarage::Gitx::Cli::IntegrateCommand do
         expect(cli).to receive(:run_cmd).with("git push origin HEAD").ordered
         expect(cli).to receive(:run_cmd).with("git checkout feature-branch").ordered
 
-        cli.integrate
+        stub_request(:post, /.*api.github.com.*/).to_return(:status => 201)
+
+        VCR.use_cassette('pull_request_does_exist') do
+          cli.integrate
+        end
       end
       it 'creates remote aggregate branch' do
         should meet_expectations
       end
+      it 'posts comment to pull request' do
+        expect(WebMock).to have_requested(:post, "https://api.github.com/repos/thegarage/thegarage-gitx/issues/10/comments")
+      end
     end
     context 'when integration branch == prototype and remote branch exists' do
+      let(:authorization_token) { '123123' }
       let(:remote_branch_names) { ['origin/prototype'] }
       before do
+        allow(cli).to receive(:authorization_token).and_return(authorization_token)
         expect(fake_update_command).to receive(:update)
 
         expect(cli).to receive(:run_cmd).with("git fetch origin").ordered
@@ -80,11 +146,18 @@ describe Thegarage::Gitx::Cli::IntegrateCommand do
         expect(cli).to receive(:run_cmd).with("git push origin HEAD").ordered
         expect(cli).to receive(:run_cmd).with("git checkout feature-branch").ordered
 
-        cli.integrate 'prototype'
+        stub_request(:post, /.*api.github.com.*/).to_return(:status => 201)
+
+        VCR.use_cassette('pull_request_does_exist') do
+          cli.integrate 'prototype'
+        end
       end
       it 'runs expected commands' do
         should meet_expectations
       end
+      it 'posts comment to pull request' do
+        expect(WebMock).to have_requested(:post, "https://api.github.com/repos/thegarage/thegarage-gitx/issues/10/comments")
+      end
     end
     context 'when integration branch is not an aggregate branch' do
       it 'raises an error' do
@@ -125,41 +198,57 @@ describe Thegarage::Gitx::Cli::IntegrateCommand do
         }
       end
       let(:repo) { cli.send(:repo) }
+      let(:authorization_token) { '123123' }
       before do
+        allow(cli).to receive(:authorization_token).and_return(authorization_token)
+
         expect(fake_update_command).to receive(:update)
 
         expect(cli).not_to receive(:run_cmd).with("git branch -D staging")
         expect(cli).not_to receive(:run_cmd).with("git push origin HEAD")
         expect(cli).to receive(:run_cmd).with("git checkout feature-branch")
 
-        cli.integrate
+        stub_request(:post, /.*api.github.com.*/).to_return(:status => 201)
+
+        VCR.use_cassette('pull_request_does_exist') do
+          cli.integrate
+        end
       end
       it 'does not delete local staging branch' do
         should meet_expectations
       end
+      it 'posts comment to pull request' do
+        expect(WebMock).to have_requested(:post, "https://api.github.com/repos/thegarage/thegarage-gitx/issues/10/comments")
+      end
     end
     context 'with --resume "feature-branch" flag when feature-branch does not exist' do
       let(:options) do
         {
-          resume: 'feature-branch'
+          resume: 'invalid-feature-branch'
         }
       end
-      let(:repo) { cli.send(:repo) }
-      let(:branches) { double(each_name: ['my-feature-branch'])}
-      let(:local_branch_names) { ['another-feature-branch'] }
+      let(:local_branch_names) { ['feature-branch'] }
+      let(:authorization_token) { '123123' }
       before do
+        allow(cli).to receive(:authorization_token).and_return(authorization_token)
         expect(fake_update_command).to receive(:update)
-        expect(cli).to receive(:ask).and_return('another-feature-branch')
+        expect(cli).to receive(:ask).and_return('feature-branch')
 
         expect(cli).not_to receive(:run_cmd).with("git branch -D staging")
         expect(cli).not_to receive(:run_cmd).with("git push origin HEAD")
-        expect(cli).to receive(:run_cmd).with("git checkout another-feature-branch").ordered
+        expect(cli).to receive(:run_cmd).with("git checkout feature-branch").ordered
 
-        cli.integrate
+        stub_request(:post, /.*api.github.com.*/).to_return(:status => 201)
+        VCR.use_cassette('pull_request_does_exist') do
+          cli.integrate
+        end
       end
       it 'asks user for feature-branch name' do
         should meet_expectations
       end
+      it 'posts comment to pull request' do
+        expect(WebMock).to have_requested(:post, "https://api.github.com/repos/thegarage/thegarage-gitx/issues/10/comments")
+      end
     end
   end
 end

data/spec/thegarage/gitx/cli/review_command_spec.rb

@@ -133,7 +133,8 @@ describe Thegarage::Gitx::Cli::ReviewCommand do
         end
       end
       it 'posts comment to github' do
-        expect(WebMock).to have_requested(:post, "https://api.github.com/repos/thegarage/thegarage-gitx/issues/10/comments")
+        expect(WebMock).to have_requested(:post, "https://api.github.com/repos/thegarage/thegarage-gitx/issues/10/comments").
+          with(body: {body: 'comment description'})
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thegarage-gitx
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.6.0
 platform: ruby
 authors:
 - Ryan Sonnek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-24 00:00:00.000000000 Z
+date: 2014-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -263,6 +263,7 @@ files:
 - lib/thegarage/gitx/cli/base_command.rb
 - lib/thegarage/gitx/cli/buildtag_command.rb
 - lib/thegarage/gitx/cli/cleanup_command.rb
+- lib/thegarage/gitx/cli/github.rb
 - lib/thegarage/gitx/cli/integrate_command.rb
 - lib/thegarage/gitx/cli/nuke_command.rb
 - lib/thegarage/gitx/cli/release_command.rb