pully 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60cb6b722172142529c46b79835a40df267f064a
-  data.tar.gz: 04c49a7512ea7c1eb87f1b693afb7bdb0ab2e09a
+  metadata.gz: bfac1f15dc32ea73cea429df9e08e5f6b1ce2603
+  data.tar.gz: a02b5a8a9b17e3cf0f2a72f897cf921711cfcb89
 SHA512:
-  metadata.gz: 5b751f7a8ffdb0c564c2e9eb31c8fd7a8eb94266c3046c190f66e6c5b7dd50846c4d363706ba016cae3d607f347dfe586cb0839a8838bf868ba3b84d56bcd72a
-  data.tar.gz: 8ae2840d65a0449645563ac2a7a50276c95ad187fe14057239d41f11df447529444e9446ded01be499394e9cd6743050af758e146cd60107419fcd152715d9a7
+  metadata.gz: 60a3d82905a951e4a1e456340655c6a8863269a8aeaefaa84ed47b68a7a680128a57ddcb679057267dd5b886edffed9c8f023e4474d1be20d8ef7eab1c2151ca
+  data.tar.gz: a7e963a02497934fa619f4eb6ba2a81e42c19b7949a1e598c17682b348a1213c80361da1da2bdc464ef6a7b7f472a3a3a56f40cddc5c2ea80b673211980a2e5f

data/README.md

@@ -1,4 +1,4 @@
-![pully: A command line interface for building a pull request bot](https://raw.githubusercontent.com/sotownsend/pully/master/logo.png)
+![pully: A ruby library for managing GitHub pull requests](https://raw.githubusercontent.com/sotownsend/pully/master/logo.png)
 
 [![Gem Version](https://badge.fury.io/rb/pully.svg)](http://badge.fury.io/rb/pully)
 [![Build Status](https://travis-ci.org/sotownsend/Pully.svg?branch=master)](https://travis-ci.org/sotownsend/Pully)
@@ -6,8 +6,12 @@
 [![License](http://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/sotownsend/pully/blob/master/LICENSE)
 
 # What is this?
+Pully is a ruby library for managing GitHub pull requests; purpose built for our continuous integration & deployment infrastructure at [Fittr®](http://www.fittr.com).
 
-A work in progress
+# Selling points
+1.  It's easy to use
+2.  It has full code coverage on tests involving GitHub's API
+3.  While it uses the pull request interface on GitHub, **it does not use the big green button** to perform a merge.
 
 # Basic usage
 ```ruby
@@ -24,9 +28,21 @@ pully.write_comment_to_pull_request(pull_number, "Test Comment")
 
 #Get all comments
 comments = pully.comments_for_pull_request(pull_number)
+
+#Get the SHA of the 'from' branch of a certain pull request
+pully.sha_for_pull_request(pull_number)
+
+#Set the status of a pull request to pending (Other options include 'error', 'failed', and 'success')
+pully.set_pull_request_status(pull_number, "pending")
+
+#Set the status of a pull request to ready
+pully.set_pull_request_status(pull_number, "success")
+
+#Merge the request (Will NOT use GitHub's pull request merge, will merge commits into history as-is)
+pully.merge_pull_request(pull_number)
 ```
 
-# Organization / Repositories not owned by you
+# Organization Repositories
 If your repositories are not owner by you, i.e. they are owned by an organization or another user who has granted you permissions, you will need to
 pass the `owner` field for the other individual or organization.
 
@@ -50,6 +66,13 @@ pully = Pully.new(user:"github_username", pass:"github_password", repo:"my_repos
 
 Run `sudo gem install pully`
 
+## Known issues
+
+1. GitHub does not register commits immediately after a push is received. Things like `sha_for_pull_request` will return old values if you don't wait
+   several seconds
+2. GitHub's status API for pull requests returns 'pending' even if the UI says 'success'. We account for this bug, but if it is fixed in the future,
+   then our specs will catch it
+
 ---
 
 ## FAQ

data/lib/pully/version.rb

@@ -1,3 +1,3 @@
 module Pully
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/lib/pully.rb

@@ -38,6 +38,39 @@ module Pully
     def write_comment_to_pull_request pull_number, comment
       @gh_client.add_comment(@repo_selector, pull_number, comment)
     end
+
+    def sha_for_pull_request pull_number
+      @gh_client.pull_request(@repo_selector, pull_number).head.sha
+    end
+
+    def pull_request_status(pull_number)
+      sha = sha_for_pull_request pull_number
+      @gh_client.combined_status(@repo_selector, sha)["state"]
+    end
+
+    def set_pull_request_status(pull_number, status)
+      sha = sha_for_pull_request pull_number
+      @gh_client.create_status(@repo_selector, sha, status)
+    end
+
+    def merge_pull_request(pull_number)
+      branches = pull_request_branches(pull_number)
+      from_name = branches[:from]
+      to_name = branches[:to]
+      @gh_client.merge(@repo_selector, to_name, from_name)
+      @gh_client.close_pull_request(@repo_selector, pull_number)
+    end
+
+    def pull_request_branches(pull_number)
+      from_name = @gh_client.pull_request(@repo_selector, pull_number).head.ref
+      to_name = @gh_client.pull_request(@repo_selector, pull_number).base.ref
+
+      return {:from => from_name, :to => to_name}
+    end
+
+    def pull_request_is_open?(pull_number)
+      @gh_client.pull_request(@repo_selector, pull_number)["state"] == 'open'
+    end
   end
 
   module TestHelpers 
@@ -122,6 +155,11 @@ module Pully
         @git_client.branches.remote.map{|e| e.name}
       end
 
+      def latest_sha branch_name
+        @git_client.checkout(branch_name)
+        @git_client.object("HEAD").sha
+      end
+
       def master_branch
         @repo.default_branch
       end
@@ -130,13 +168,16 @@ module Pully
       def commit_new_random_file(branch_name)
         #Create a new file
         Dir.chdir "#{@path}/pully" do
-          File.write branch_name, branch_name
+          File.write "#{branch_name}.#{SecureRandom.hex}", branch_name
         end
 
         #Commit
         @git_client.add(:all => true)
         @git_client.commit_all("New branch from Pully Test Suite #{SecureRandom.hex}")
+        local_sha = @git_client.object("HEAD").sha
         @git_client.push("origin", branch_name)
+
+        return local_sha
       end
     end
   end

data/spec/lib_spec.rb

@@ -31,6 +31,7 @@ RSpec.describe "Library" do
   #end
 
   it "Can call create a new pull request and returns an integer for the pull request #" do
+    sleep 10
     #test branch creator
     new_branch_name = SecureRandom.hex
     th = Pully::TestHelpers::Branch.new(user: gh_info["user"], pass: gh_info["pass"], repo_selector: repo_selector(user: gh_info["user"], repo: gh_info["repo"], owner:nil), clone_url: gh_info["clone_url"])
@@ -45,6 +46,7 @@ RSpec.describe "Library" do
   end
 
   it "Can call create a new pull request for an organization repo and returns an integer for the pull request #" do
+    sleep 10
     #test branch creator
     new_branch_name = SecureRandom.hex
     th = Pully::TestHelpers::Branch.new(user: gh_info["user"], pass: gh_info["pass"], repo_selector: repo_selector(user: gh_info["user"], repo: gh_info["org_repo"], owner:gh_info["org_owner"]), clone_url: gh_info["org_clone_url"])
@@ -95,4 +97,126 @@ RSpec.describe "Library" do
 
     th.delete_branch(new_branch_name)
   end
+
+  it "Can call create a new pull request, get the SHA of that pull request, and compare it to the SHA of the from branch" do
+    sleep 10
+    #test branch creator
+    new_branch_name = SecureRandom.hex
+    th = Pully::TestHelpers::Branch.new(user: gh_info["user"], pass: gh_info["pass"], repo_selector: repo_selector(user: gh_info["user"], repo: gh_info["repo"], owner:nil), clone_url: gh_info["clone_url"])
+    th.create_branch(new_branch_name)
+    local_sha = th.commit_new_random_file(new_branch_name)
+
+    pully = Pully.new(user: gh_info["user"], pass: gh_info["pass"], repo: gh_info["repo"])
+    pull_number = pully.create_pull_request(from:new_branch_name, to:"master", subject:"My pull request", message:"Hey XXXX, can you merge this for me?")
+
+    from_sha = pully.sha_for_pull_request(pull_number)
+
+    expect(local_sha).to eq(from_sha)
+
+    th.delete_branch(new_branch_name)
+  end
+
+  it "Changes the SHA when commits are added after a pull request" do
+    sleep 10
+    #test branch creator
+    new_branch_name = SecureRandom.hex
+    th = Pully::TestHelpers::Branch.new(user: gh_info["user"], pass: gh_info["pass"], repo_selector: repo_selector(user: gh_info["user"], repo: gh_info["repo"], owner:nil), clone_url: gh_info["clone_url"])
+    th.create_branch(new_branch_name)
+    local_sha_a = th.commit_new_random_file(new_branch_name)
+
+    pully = Pully.new(user: gh_info["user"], pass: gh_info["pass"], repo: gh_info["repo"])
+    pull_number = pully.create_pull_request(from:new_branch_name, to:"master", subject:"My pull request", message:"Hey XXXX, can you merge this for me?")
+
+    #Get the SHA from the pull request
+    from_sha_a = pully.sha_for_pull_request(pull_number)
+    expect(local_sha_a).to eq(from_sha_a)
+
+    local_sha_b = th.commit_new_random_file(new_branch_name)
+    sleep 5 #Wait for GitHub to update
+    from_sha_b = pully.sha_for_pull_request(pull_number)
+    expect(local_sha_b).not_to eq(local_sha_a)
+    expect(local_sha_b).to eq(from_sha_b)
+
+    th.delete_branch(new_branch_name)
+  end
+
+  it "Can set the pull request status to success, assumes BUG IN GITHUB SETS TO PENDING" do
+    sleep 10
+    #test branch creator
+    new_branch_name = SecureRandom.hex
+    th = Pully::TestHelpers::Branch.new(user: gh_info["user"], pass: gh_info["pass"], repo_selector: repo_selector(user: gh_info["user"], repo: gh_info["repo"], owner:nil), clone_url: gh_info["clone_url"])
+    th.create_branch(new_branch_name)
+    th.commit_new_random_file(new_branch_name)
+
+    pully = Pully.new(user: gh_info["user"], pass: gh_info["pass"], repo: gh_info["repo"])
+    pull_number = pully.create_pull_request(from:new_branch_name, to:"master", subject:"My pull request", message:"Hey XXXX, can you merge this for me?")
+    pully.sha_for_pull_request(pull_number) 
+
+    status = pully.pull_request_status(pull_number)
+    expect(status).to eq("pending")
+
+    pully.set_pull_request_status(pull_number, "success")
+    status = pully.pull_request_status(pull_number)
+    expect(status).to eq("success") 
+
+    th.delete_branch(new_branch_name)
+  end
+
+  it "Can get the from and to names of the pull request" do
+    sleep 10
+    #test branch creator
+    new_branch_name = SecureRandom.hex
+    th = Pully::TestHelpers::Branch.new(user: gh_info["user"], pass: gh_info["pass"], repo_selector: repo_selector(user: gh_info["user"], repo: gh_info["repo"], owner:nil), clone_url: gh_info["clone_url"])
+    th.create_branch(new_branch_name)
+    th.commit_new_random_file(new_branch_name)
+
+    pully = Pully.new(user: gh_info["user"], pass: gh_info["pass"], repo: gh_info["repo"])
+    pull_number = pully.create_pull_request(from:new_branch_name, to:"master", subject:"My pull request", message:"Hey XXXX, can you merge this for me?")
+    branches = pully.pull_request_branches(pull_number) 
+
+    expect(branches[:from]).to eq(new_branch_name)
+    expect(branches[:to]).to eq("master")
+
+    th.delete_branch(new_branch_name)
+  end
+
+  it "Can get the from and to names of the pull request from an organization" do
+    sleep 10
+    #test branch creator
+    new_branch_name = SecureRandom.hex
+    th = Pully::TestHelpers::Branch.new(user: gh_info["user"], pass: gh_info["pass"], repo_selector: repo_selector(user: gh_info["user"], repo: gh_info["org_repo"], owner:gh_info["org_owner"]), clone_url: gh_info["org_clone_url"])
+    th.create_branch(new_branch_name)
+    th.commit_new_random_file(new_branch_name)
+
+    pully = Pully.new(user: gh_info["user"], pass: gh_info["pass"], repo: gh_info["org_repo"])
+    pull_number = pully.create_pull_request(from:new_branch_name, to:"master", subject:"My pull request", message:"Hey XXXX, can you merge this for me?")
+    branches = pully.pull_request_branches(pull_number) 
+
+    expect(branches[:from]).to eq(new_branch_name)
+    expect(branches[:to]).to eq("master")
+
+    th.delete_branch(new_branch_name)
+  end
+
+  it "Can merge the pull request into master" do
+    sleep 10
+    #test branch creator
+    new_branch_name = SecureRandom.hex
+    th = Pully::TestHelpers::Branch.new(user: gh_info["user"], pass: gh_info["pass"], repo_selector: repo_selector(user: gh_info["user"], repo: gh_info["repo"], owner:nil), clone_url: gh_info["clone_url"])
+    th.create_branch(new_branch_name)
+    last_sha = th.commit_new_random_file(new_branch_name)
+
+    pully = Pully.new(user: gh_info["user"], pass: gh_info["pass"], repo: gh_info["repo"])
+    pull_number = pully.create_pull_request(from:new_branch_name, to:"master", subject:"My pull request", message:"Hey XXXX, can you merge this for me?")
+    pully.merge_pull_request(pull_number)
+
+    #Check leading sha
+    th = Pully::TestHelpers::Branch.new(user: gh_info["user"], pass: gh_info["pass"], repo_selector: repo_selector(user: gh_info["user"], repo: gh_info["repo"], owner:nil), clone_url: gh_info["clone_url"])
+    expect(th.latest_sha("master")).to eq(last_sha)
+
+    #We expect the pull request to be closed
+    expect(pully.pull_request_is_open?(pull_number)).to eq(false)
+
+    th.delete_branch(new_branch_name)
+  end
 end

data/spec/lib_test_spec.rb

@@ -53,4 +53,17 @@ RSpec.describe "Test Library" do
     th.delete_branch(new_branch_name)
     expect(th.list_branches).not_to include(new_branch_name)
   end
+
+  it "Can create a new branch from our repository, grab something that looks like a SHA of the commit, and delete it" do
+    new_branch_name = SecureRandom.hex
+    th = Pully::TestHelpers::Branch.new(user: gh_info["user"], pass: gh_info["pass"], repo_selector: repo_selector, clone_url: gh_info["clone_url"])
+
+    th.create_branch(new_branch_name)
+    sha = th.commit_new_random_file(new_branch_name)
+    expect(sha.class).to be(String)
+    expect(sha.length).to be(40)
+
+    #Delete the branch
+    th.delete_branch(new_branch_name)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pully
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Seo Townsend