right_branch 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03e90279927b64245f2cafc2605e98d8832f88cb
-  data.tar.gz: 66ced768c06d6baad8ad0ebbcdc518853de0e64c
+  metadata.gz: 4817adc6f712e714088de48667e079a1a0037f17
+  data.tar.gz: 5a908039cc340e39f7fbaa4fe06d2621b898159f
 SHA512:
-  metadata.gz: 7ff827ae6c9f78c9a9e44271713b1bdbe6566f78241bff29ca36ad67bf8445273bf6498b2415a8bd624c850061ba70c8e229f383c6fa4e7cf1fbc44afb812350
-  data.tar.gz: 40b149508d08044ff6fed1d8712e47c7615dc713f6334ebe1012f895293d56a711033ca50d60ebd2a7875a6024bda498d822adc7a32f17172861fdfc611d5581
+  metadata.gz: 84df2a61749b2cd51a051c67bd9295d82badf0f74eb87a310c429202934f154b54aa8652d64d3b59fd40bfe076ffeeb0d234ae3a63544177a6daa5ad20c66f74
+  data.tar.gz: 155b3ba87282af4cab69549d2e93ba6201d561a0ad479d19b58180b890a95ee5d9ddb16e06e49e9167f6466c5e5104ef13184aeeb9b00bccf92b8577805917cc

data/README.md

@@ -0,0 +1,44 @@
+# Right Branch
+
+[![Gem version](http://img.shields.io/gem/v/right_branch.svg)](https://rubygems.org/gems/right_branch)
+[![Build Status](https://travis-ci.org/DyegoCosta/right_branch.svg?branch=master)](https://travis-ci.org/DyegoCosta/right_branch)
+
+Currently GitHub does not support switching the target branch of a Pull Request. This tool helps to do that in case a PR is submitted against a wrong branch.
+
+## Getting started
+
+Install gem:
+
+```
+$ gem install right_branch
+```
+
+Usage:
+
+```
+$ right_branch [options]
+    -u, --username USERNAME          Username
+    -r, --repository REPOSITORY      Repository
+    -b, --new-branch NEW_BRANCH      New branch
+    -p, --pull-request PULL_REQUEST  Pull request
+    -t, --access-token ACCESS_TOKEN  Access token
+        --password PASSWORD          Password
+```
+
+You can also use environment variables to set default configuration values.  
+
+```
+  $ export RIGHT_BRANCH_USERNAME=your_default_username
+  $ export RIGHT_BRANCH_REPOSITORY=your_default_repository
+  $ export RIGHT_BRANCH_ACCESS_TOKEN=your_default_access_token
+```
+
+## Acess token
+
+You can avoid having to type your `username` and `password` by providing an access token
+generated by GitHub.  
+If you specify it with the `--access-token` option or have it defined
+as a `RIGHT_BRANCH_ACCESS_TOKEN` envrionment variable, it will be used as you authentication method.  
+You can [create access tokens through your GitHub Account Settings][create-access-token].
+
+[create-access-token]:https://help.github.com/articles/creating-an-access-token-for-command-line-use

data/lib/right_branch/commands/change_pull_request_target.rb

@@ -5,7 +5,7 @@ require_relative '../updater'
 
 module RightBranch::Commands
   class ChangePullRequestTarget
-    REQUIRED_OPTIONS = %i(username repository new_branch pull_request)
+    REQUIRED_OPTIONS = [:repository, :new_branch, :pull_request]
 
     attr_accessor :stream
 
@@ -19,7 +19,13 @@ module RightBranch::Commands
 
     def run!
       options = build_options
-      updater(options).run!
+
+      attrs = {
+        credentials: build_credentials(options),
+        repository: options[:repository]
+      }
+
+      updater(attrs).run!(options[:pull_request], options[:new_branch])
     rescue ::Octokit::Unauthorized
       abort 'Invalid credentials to update pull request'
     rescue ::Octokit::UnprocessableEntity
@@ -39,25 +45,40 @@ module RightBranch::Commands
         abort missing_key_abort_message(missing, opt_parser)
       end
 
-      if String(options[:password]).empty?
-        options[:password] = ask("Enter your password: ") { |q| q.echo = '*' }
+      if prompt_for_password?(options)
+        options[:password] = ask('Enter your password: ') { |q| q.echo = '*' }
       end
 
       options
     end
 
+    def prompt_for_password?(options)
+      String(options[:access_token]).empty? &&
+        String(options[:password]).empty?
+    end
+
+    def build_credentials(options)
+      if options[:access_token].to_s.empty?
+        { login: options[:username], password: options[:password] }
+      else
+        { access_token: options[:access_token] }
+      end
+    end
+
     def missing_opt_keys(options)
       missing = REQUIRED_OPTIONS - options.keys
-      missing += options.select { |_, v| v.nil? || v.empty? }.keys
-      missing
+      required_blank = options.select do |k, v|
+        REQUIRED_OPTIONS.include?(k) && String(v).empty?
+      end
+      missing += required_blank.keys
     end
 
     def missing_key_abort_message(keys, opt_parser)
       "Missing required options: #{keys.join(', ')}\n\n#{opt_parser}"
     end
 
-    def updater(options)
-      RightBranch::Updater.new(options)
+    def updater(attrs)
+      RightBranch::Updater.new(attrs)
     end
 
     def build_opt_parser(options)
@@ -80,6 +101,10 @@ module RightBranch::Commands
           options[:pull_request] = v
         end
 
+        opts.on("-t", "--access-token ACCESS_TOKEN", "Access token") do |v|
+          options[:access_token] = v
+        end
+
         opts.on("--password PASSWORD", "Password") do |v|
           options[:password] = v
         end
@@ -89,6 +114,7 @@ module RightBranch::Commands
     def fallback_to_options_from_env(options)
       options[:username] ||= ENV['RIGHT_BRANCH_USERNAME']
       options[:repository] ||= ENV['RIGHT_BRANCH_REPOSITORY']
+      options[:access_token] ||= ENV['RIGHT_BRANCH_ACCESS_TOKEN']
     end
   end
 end

data/lib/right_branch/updater.rb

@@ -2,34 +2,30 @@ require 'octokit'
 
 module RightBranch
   class Updater
-    attr_reader :username, :password, :pull_request,
-      :new_branch, :repository
+    attr_reader :credentials, :repository
 
     def initialize(options)
-      @username = options.fetch(:username)
-      @password = options.fetch(:password)
-      @pull_request = options.fetch(:pull_request)
-      @new_branch = options.fetch(:new_branch)
-      @repository = options.fetch(:repository)
+      @repository = options[:repository]
+      @credentials = options[:credentials]
     end
 
-    def run!
-      old_pr = get_pr(pull_request)
-      new_pr = submit_pr(old_pr, new_branch)
-      update_pr(old_pr[:number], state: 'closed')
-      comment_on_issue old_pr[:number] ,
+    def run!(old_pr_number, new_branch)
+      new_pr = resubmit_pr(old_pr_number, new_branch)
+
+      update_pr(old_pr_number, state: 'closed')
+
+      comment_on_issue old_pr_number ,
         "Reopened against `#{new_branch}` (##{new_pr.number})"
     end
 
     private
 
     def github
-      @github ||= Octokit::Client.new \
-        login: username, password: password
+      @github ||= Octokit::Client.new(credentials)
     end
 
-    def get_pr(pr)
-      github.pull_request(repository, pr)
+    def get_pr(pr_number)
+      github.pull_request(repository, pr_number)
     end
 
     def comment_on_issue(number, comment)
@@ -40,13 +36,15 @@ module RightBranch
       github.update_pull_request(repository, number, args)
     end
 
-    def submit_pr(pr, new_branch)
+    def resubmit_pr(old_pr_number, new_branch)
+      old_pr = get_pr(old_pr_number)
+
       github.create_pull_request \
         repository,
         new_branch,
-        pr[:head][:label],
-        pr[:title],
-        pr[:body]
+        old_pr[:head][:label],
+        old_pr[:title],
+        old_pr[:body]
     end
   end
 end

data/lib/right_branch/version.rb

@@ -1,3 +1,3 @@
 module RightBranch
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/commands/change_pull_request_target_spec.rb

@@ -73,4 +73,20 @@ describe RightBranch::Commands::ChangePullRequestTarget do
         "Missing required options: a, b\n\nwow"
     end
   end
+
+  describe '#build_credentials' do
+    it 'returns access token if present' do
+      actual = subject.send :build_credentials,
+        access_token: 'omg', username: 'doge', password: 'wow'
+
+      expect(actual).to eq({ access_token: 'omg'})
+    end
+
+    it 'returns username and password if no access token is present' do
+      actual = subject.send :build_credentials,
+        username: 'doge', password: 'wow'
+
+      expect(actual).to eq({ login: 'doge', password: 'wow' })
+    end
+  end
 end

data/spec/updater_spec.rb

@@ -1,34 +1,62 @@
 require 'spec_helper'
 
 describe RightBranch::Updater do
-  subject { described_class.new default_options }
-
-  let(:default_options) do
-    {
-      pull_request: '1',
-      new_branch: 'test',
-      username: 'doge',
-      password: 'very_secure',
-      repository: 'foo/bar',
-    }
-  end
+  let(:gh) { double(:github) }
+  let(:repo) { 'doge/wow' }
+  let(:updater) { described_class.new(repository: repo) }
+
+  before { allow(updater).to receive(:github).and_return(gh) }
 
-  describe '#submit_pr' do
+  describe '#resubmit_pr' do
     it 'creats new pull request againts branch' do
-      gh = double(:github)
+      old_pr_number = 1
       title, body, label, branch = %w(title body label branch)
-      pr = { title: title, body: body, head: { label: label } }
-
-      allow(subject).to receive(:github).and_return(gh)
+      pr = { title: 'title', body: 'body', head: { label: 'label' } }
+      allow(updater).to receive(:get_pr).with(old_pr_number).and_return(pr)
 
       expect(gh).to receive(:create_pull_request).with \
-        default_options[:repository],
-        branch,
-        label,
-        title,
-        body
+        repo, branch, label, title, body
+
+      updater.send(:resubmit_pr, old_pr_number, branch)
+    end
+  end
+
+  describe '#run!' do
+    it 'resubmits old pull request' do
+      old = '1'
+      branch = 'test'
+      allow(updater).to receive(:comment_on_issue)
+      allow(updater).to receive(:update_pr)
+
+      expect(updater).to receive(:resubmit_pr)
+        .with(old, branch).and_return double(number: '2')
+
+      updater.run!(old, branch)
+    end
+
+    it 'closes old pr' do
+      old = '1'
+      new_pr = double(:new_pr, number: '2')
+      allow(updater).to receive(:resubmit_pr).and_return new_pr
+      allow(updater).to receive(:comment_on_issue)
+
+      expect(updater).to receive(:update_pr).with \
+        old, state: 'closed'
+
+      updater.run!(old, 'testing')
+    end
+
+    it 'comment on old pr with new pr number' do
+      old = '1'
+      new_pr = double(:new_pr, number: '2')
+      allow(updater).to receive(:resubmit_pr).and_return new_pr
+      allow(updater).to receive(:update_pr)
+
+      allow(updater).to receive(:comment_on_issue).with \
+        old, 'Reopened against `testing` (#2)'
+
 
-      subject.send(:submit_pr, pr, branch)
+      updater.run!(old, 'testing')
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: right_branch
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dyego Costa
@@ -58,6 +58,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7
 description: If you submit a Pull Request to a wrong branch on GitHub you can use
   this gem to change it
 email: dyego@dyegocosta.com
@@ -66,6 +86,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - bin/right_branch
 - lib/right_branch.rb
 - lib/right_branch/commands/change_pull_request_target.rb