octokit 1.25.0 → 2.0.0.pre

data/spec/octokit/client/pub_sub_hubbub_spec.rb

@@ -1,68 +1,77 @@
-# -*- encoding: utf-8 -*-
 require 'helper'
 
 describe Octokit::Client::PubSubHubbub do
-  let(:client) { Octokit::Client.new(:oauth_token => 'myfaketoken') }
 
-  describe ".subscribe" do
-    context "with valid params" do
-      let(:subscribe_request_body) {
-        {
-          :"hub.callback" => 'github://Travis?token=travistoken',
-          :"hub.mode" => 'subscribe',
-          :"hub.topic" => 'https://github.com/joshk/completeness-fu/events/push'
-        }
+  before do
+    Octokit.reset!
+    @client = oauth_client
+  end
+
+  describe ".subscribe", :vcr do
+    it "subscribes to pull events" do
+      subscribe_request_body = {
+        :"hub.callback" => 'github://Travis?token=travistoken',
+        :"hub.mode" => 'subscribe',
+        :"hub.topic" => 'https://github.com/api-playground/api-sandbox/events/push'
       }
-      it "subscribes to pull events" do
-        stub_post("/hub").
-          with(subscribe_request_body).
-          to_return(:status => 204)
 
-        expect(client.subscribe("https://github.com/joshk/completeness-fu/events/push", "github://Travis?token=travistoken")).to eq(true)
-        assert_requested :post, "https://api.github.com/hub", :body => subscribe_request_body, :times => 1,
-          :headers => {'Content-type' => 'application/x-www-form-urlencoded'}
-      end
+      result = @client.subscribe("https://github.com/api-playground/api-sandbox/events/push", "github://Travis?token=travistoken")
+      assert_requested :post, github_url("/hub"), :body => subscribe_request_body, :times => 1,
+        :headers => {'Content-type' => 'application/x-www-form-urlencoded'}
+      expect(result).to be_true
     end
-    context "when topic is not recognized" do
-      let(:subscribe_request_body) {
-        {
-          :"hub.callback" => 'github://Travis?token=travistoken',
-          :"hub.mode" => 'subscribe',
-          :"hub.topic" => 'https://github.com/joshk/not_existing_project/events/push'
-        }
+    it "raises an error when topic is not recognized" do
+      subscribe_request_body = {
+        :"hub.callback" => 'github://Travis?token=travistoken',
+        :"hub.mode" => 'subscribe',
+        :"hub.topic" => 'https://github.com/joshk/not_existing_project/events/push'
       }
-      it "raises an error" do
-        stub_post("/hub").
-          with(subscribe_request_body).
-          to_return(:status => 422)
-
-        expect {
-          client.subscribe("https://github.com/joshk/not_existing_project/events/push", "github://Travis?token=travistoken")
-        }.to raise_exception
-        assert_requested :post, "https://api.github.com/hub", :body => subscribe_request_body, :times => 1,
-          :headers => {'Content-type' => 'application/x-www-form-urlencoded'}
-      end
+      expect {
+        @client.subscribe("https://github.com/joshk/not_existing_project/events/push", "github://Travis?token=travistoken")
+      }.to raise_error Octokit::UnprocessableEntity
+      assert_requested :post, github_url("/hub"), :body => subscribe_request_body, :times => 1,
+        :headers => {'Content-type' => 'application/x-www-form-urlencoded'}
     end
-  end
+  end # .subscribe
 
-  describe ".unsubscribe" do
-    let(:unsubscribe_request_body) {
-      {
+  describe ".unsubscribe", :vcr do
+    it "unsubscribes from pull events" do
+      unsubscribe_request_body = {
         :"hub.callback" => 'github://Travis?token=travistoken',
         :"hub.mode" => 'unsubscribe',
-        :"hub.topic" => 'https://github.com/joshk/completeness-fu/events/push'
+        :"hub.topic" => 'https://github.com/api-playground/api-sandbox/events/push'
       }
-    }
 
-    it "unsubscribes from pull events" do
-      stub_post("/hub").
-        with(unsubscribe_request_body).
-        to_return(:status => 204)
+      result = @client.unsubscribe("https://github.com/api-playground/api-sandbox/events/push", "github://Travis?token=travistoken")
+      assert_requested :post, github_url("/hub"), :body => unsubscribe_request_body, :times => 1,
+        :headers => {'Content-type' => 'application/x-www-form-urlencoded'}
+      expect(result).to be_true
+    end
+  end # .unsubscribe
 
-      expect(client.unsubscribe("https://github.com/joshk/completeness-fu/events/push", "github://Travis?token=travistoken")).to eq(true)
-      assert_requested :post, "https://api.github.com/hub", :body => unsubscribe_request_body, :times => 1,
+  describe ".subscribe_service_hook", :vcr do
+    it "subscribes to pull events on specified topic" do
+      subscribe_request_body = {
+        :"hub.callback" => 'github://Travis?token=travistoken',
+        :"hub.mode" => 'subscribe',
+        :"hub.topic" => 'https://github.com/api-playground/api-sandbox/events/push'
+      }
+      expect(@client.subscribe_service_hook("api-playground/api-sandbox", "Travis", { :token => 'travistoken' })).to eq(true)
+      assert_requested :post, github_url("/hub"), :body => subscribe_request_body, :times => 1,
         :headers => {'Content-type' => 'application/x-www-form-urlencoded'}
     end
-  end
+  end # .subscribe_service_hook
 
+  describe "unsubscribe_service_hook", :vcr do
+    it "unsubscribes to stop receiving events on specified topic" do
+      unsubscribe_request_body = {
+        :"hub.callback" => 'github://Travis',
+        :"hub.mode" => 'unsubscribe',
+        :"hub.topic" => 'https://github.com/api-playground/api-sandbox/events/push'
+      }
+      expect(@client.unsubscribe_service_hook("api-playground/api-sandbox", "Travis")).to eq(true)
+      assert_requested :post, github_url("/hub"), :body => unsubscribe_request_body, :times => 1,
+        :headers => {'Content-type' => 'application/x-www-form-urlencoded'}
+    end
+  end
 end

data/spec/octokit/client/pull_requests_spec.rb

@@ -0,0 +1,186 @@
+require 'helper'
+
+describe Octokit::Client::PullRequests do
+
+  before do
+    Octokit.reset!
+    @client = oauth_client
+  end
+
+  describe ".pull_requests", :vcr do
+    it "returns all pull requests" do
+      pulls = @client.pulls("octokit/octokit.rb")
+      expect(pulls).to be_kind_of Array
+      assert_requested :get, github_url("/repos/octokit/octokit.rb/pulls")
+    end
+  end # .pull_requests
+
+  context "methods that require a new pull" do
+
+    before(:each) do
+      @pull = @client.create_pull_request("api-playground/api-sandbox", "master", "branch-for-pr", "A new PR", "The Body")
+    end
+
+    after(:each) do
+      @client.close_pull_request("api-playground/api-sandbox", @pull.number)
+    end
+
+    describe ".create_pull_request", :vcr do
+      it "creates a pull request" do
+        expect(@pull.title).to eq "A new PR"
+        assert_requested :post, github_url("/repos/api-playground/api-sandbox/pulls")
+      end
+    end # .create_pull_request
+
+    describe ".pull_request", :vcr do
+      it "returns a pull request" do
+        pull = @client.pull("api-playground/api-sandbox", @pull.number)
+        expect(pull.title).to eq "A new PR"
+        assert_requested :get, github_url("/repos/api-playground/api-sandbox/pulls/#{@pull.number}")
+      end
+    end # .pull_request
+
+    describe ".update_pull_request", :vcr do
+      it "updates a pull request" do
+        pull = @client.update_pull_request('api-playground/api-sandbox', @pull.number, 'New title', 'Updated body')
+        assert_requested :patch, github_url("/repos/api-playground/api-sandbox/pulls/#{@pull.number}")
+      end
+    end # .update_pull_request
+
+    describe ".pull_merged?", :vcr do
+      it "returns whether the pull request has been merged" do
+        merged = @client.pull_merged?("api-playground/api-sandbox", @pull.number)
+        expect(merged).to_not be_true
+        assert_requested :get, github_url("/repos/api-playground/api-sandbox/pulls/#{@pull.number}/merge")
+      end
+    end # .pull_merged?
+
+    context "methods requiring a pull request comment" do
+
+      before do
+        new_comment = {
+          :body => "Hawt",
+          :commit_id => "c5ea55b0dabb77dfdaffd2344ab1a40ebd51fe32",
+          :path => "new-file.txt",
+          :position => 1
+        }
+        @comment = @client.create_pull_request_comment \
+          "api-playground/api-sandbox",
+          @pull.number,
+          new_comment[:body],
+          new_comment[:commit_id],
+          new_comment[:path],
+          new_comment[:position]
+      end
+
+      describe ".create_pull_request_comment", :vcr do
+        it "creates a new comment on a pull request" do
+          assert_requested :post, github_url("/repos/api-playground/api-sandbox/pulls/#{@pull.number}/comments")
+        end
+      end # .create_pull_request_comment
+
+      describe ".create_pull_request_comment_reply", :vcr do
+        it "creates a new reply to a pull request comment" do
+          new_comment = {
+            :body => "done.",
+            :in_reply_to => @comment.id
+          }
+          reply = @client.create_pull_request_comment_reply("api-playground/api-sandbox", @pull.number, new_comment[:body], new_comment[:in_reply_to])
+          assert_requested :post, github_url("/repos/api-playground/api-sandbox/pulls/#{@pull.number}/comments"), :times => 2
+          expect(reply.body).to eq(new_comment[:body])
+        end
+      end # .create_pull_request_comment_reply
+
+      describe ".update_pull_request_comment", :vcr do
+        it "updates a pull request comment" do
+          comment = @client.update_pull_request_comment("api-playground/api-sandbox", @comment.id, ":shipit:")
+          expect(comment.body).to eq(":shipit:")
+          assert_requested :patch, github_url("/repos/api-playground/api-sandbox/pulls/comments/#{@comment.id}")
+        end
+      end # .update_pull_request_comment
+
+      describe ".delete_pull_request_comment", :vcr do
+        it "deletes a pull request comment" do
+          result = @client.delete_pull_request_comment("api-playground/api-sandbox", @comment.id)
+          expect(result).to eq(true)
+          assert_requested :delete, github_url("/repos/api-playground/api-sandbox/pulls/comments/#{@comment.id}")
+        end
+      end # .delete_pull_request_comment
+
+    end # pull request comment methods
+
+    describe ".close_pull_request", :vcr do
+      it "closes a pull request" do
+        response = @client.close_pull_request("api-playground/api-sandbox", @pull.number)
+        expect(response.state).to eq 'closed'
+        assert_requested :patch, github_url("/repos/api-playground/api-sandbox/pulls/#{@pull.number}")
+      end
+    end
+
+  end # new @pull methods
+
+  # stub this so we don't have to set up new fixture data
+  describe ".merge_pull_request" do
+    it "merges the pull request" do
+      VCR.turn_off!
+      request = stub_put(github_url("/repos/api-playground/api-sandbox/pulls/123/merge"))
+      response = @client.merge_pull_request("api-playground/api-sandbox", 123)
+      assert_requested request
+      VCR.turn_on!
+    end
+  end # .merge_pull_request
+
+  describe ".create_pull_request_for_issue", :vcr do
+    it "creates a pull request and attach it to an existing issue" do
+      issue = @client.create_issue("api-playground/api-sandbox", 'A new issue', "Gonna turn this into a PR")
+      pull = @client.create_pull_request_for_issue("api-playground/api-sandbox", "master", "some-fourth-branch", issue.number)
+      assert_requested :post, github_url("/repos/api-playground/api-sandbox/pulls")
+
+      # cleanup so we can re-run test with blank cassette
+      @client.close_pull_request("api-playground/api-sandbox", pull.number)
+    end
+  end # .create_pull_request_for_issue
+
+  describe ".pull_requests_comments", :vcr do
+    it "returns all comments on all pull requests" do
+      comments = @client.pull_requests_comments("octokit/octokit.rb")
+      expect(comments).to be_kind_of Array
+      assert_requested :get, github_url("/repos/octokit/octokit.rb/pulls/comments")
+    end
+  end # .pull_requests_comments
+
+  describe ".pull_request_commits", :vcr do
+    it "returns the commits for a pull request" do
+      commits = @client.pull_commits("octokit/octokit.rb", 67)
+      expect(commits).to be_kind_of Array
+      assert_requested :get, github_url("/repos/octokit/octokit.rb/pulls/67/commits")
+    end
+  end # .pull_request_commits
+
+  describe ".pull_request_files", :vcr do
+    it "lists files for a pull request" do
+      files = @client.pull_request_files("octokit/octokit.rb", 67)
+      file = files.first
+      expect(file.filename).to eq('lib/octokit/configuration.rb')
+      expect(file.additions).to eq(4)
+      assert_requested :get, github_url("/repos/octokit/octokit.rb/pulls/67/files")
+    end
+  end # .pull_request_files
+
+  describe ".pull_request_comments", :vcr do
+    it "returns the comments for a pull request" do
+      comments = @client.pull_comments("octokit/octokit.rb", 67)
+      expect(comments).to be_kind_of Array
+      assert_requested :get, github_url("/repos/octokit/octokit.rb/pulls/67/comments")
+    end
+  end # .pull_request_comments
+
+  describe ".pull_request_comment", :vcr do
+    it "returns a comment on a pull request" do
+      comment = @client.pull_request_comment("octokit/octokit.rb", 1903950)
+      expect(comment.body).to_not be_nil
+      assert_requested :get, github_url("/repos/octokit/octokit.rb/pulls/comments/1903950")
+    end
+  end # .pull_request_comment
+
+end

data/spec/octokit/client/rate_limit_spec.rb

@@ -0,0 +1,40 @@
+require 'helper'
+
+describe Octokit::Client do
+
+  describe ".rate_limit" do
+    it "makes a response if there is no last response" do
+      client = Octokit::Client.new
+      VCR.use_cassette 'rate_limit' do
+        rate = client.rate_limit
+
+        expect(rate.limit).to be_kind_of Fixnum
+        expect(rate.remaining).to be_kind_of Fixnum
+      end
+    end # .rate_limit
+    it "checks the rate limit from the last response" do
+      client = Octokit::Client.new
+      VCR.use_cassette 'root' do
+        client.get('/')
+        VCR.use_cassette 'rate_limit' do
+          rate = client.rate_limit
+          expect(rate.limit).to be_kind_of Fixnum
+          expect(rate.remaining).to be_kind_of Fixnum
+        end
+      end
+    end
+  end
+
+  describe ".rate_limit!" do
+    it "makes a web request to check the rate limit" do
+      client = Octokit::Client.new
+      VCR.use_cassette 'rate_limit' do
+        rate = client.rate_limit!
+
+        expect(rate.limit).to be_kind_of Fixnum
+        expect(rate.remaining).to be_kind_of Fixnum
+      end
+    end
+  end # .rate_limit!
+
+end

data/spec/octokit/client/refs_spec.rb

@@ -1,79 +1,70 @@
-# -*- encoding: utf-8 -*-
 require 'helper'
 
 describe Octokit::Client::Refs do
 
   before do
-    @client = Octokit::Client.new(:login => 'sferik')
+    Octokit.reset!
+    @client = oauth_client
   end
 
-  describe ".refs" do
-
+  describe ".refs", :vcr do
     it "returns all refs" do
-      stub_get("/repos/sferik/rails_admin/git/refs/").
-        to_return(json_response("refs.json"))
       refs = @client.refs("sferik/rails_admin")
-      expect(refs.first.ref).to eq("refs/heads/actions")
+      expect(refs).to be_kind_of Array
+      assert_requested :get, github_url("/repos/sferik/rails_admin/git/refs")
     end
-
     it "returns all tag refs" do
-      stub_get("/repos/sferik/rails_admin/git/refs/tags").
-        to_return(json_response("refs_tags.json"))
-      refs = @client.refs("sferik/rails_admin","tags")
-      expect(refs.first.ref).to eq("refs/tags/v0.0.1")
+      refs = @client.refs("sferik/rails_admin", "tags")
+      expect(refs).to be_kind_of Array
+      assert_requested :get, github_url("/repos/sferik/rails_admin/git/refs/tags")
     end
+  end # .refs
 
-  end
-
-  describe ".ref" do
-
-    it "returns the tags/v0.0.3 ref" do
-      stub_get("/repos/sferik/rails_admin/git/refs/tags/v0.0.3").
-        to_return(json_response("ref.json"))
-      ref = @client.ref("sferik/rails_admin","tags/v0.0.3")
-      expect(ref.object.type).to eq("tag")
-      expect(ref.ref).to eq("refs/tags/v0.0.3")
-      expect(ref.url).to eq("https://api.github.com/repos/sferik/rails_admin/git/refs/tags/v0.0.3")
+  describe ".ref", :vcr do
+    it "returns a tags ref" do
+      ref = @client.ref("sferik/rails_admin", "tags/v0.0.3")
+      expect(ref.object.type).to eq "tag"
+      assert_requested :get, github_url("/repos/sferik/rails_admin/git/refs/tags/v0.0.3")
     end
+  end # .ref
 
-  end
-
-  describe ".create_ref" do
+  context "methods that require a ref", :vcr do
 
-    it "creates a ref" do
-      stub_post("/repos/octocat/Hello-World/git/refs").
-        with(:body => { "ref" => "refs/heads/master", "sha" => "827efc6d56897b048c772eb4087f854f46256132" },
-             :headers => {'Content-Type'=>'application/json'}).
-        to_return(json_response("ref_create.json"))
-      ref = @client.create_ref("octocat/Hello-World","heads/master", "827efc6d56897b048c772eb4087f854f46256132")
-      expect(ref.first.ref).to eq("refs/heads/master")
+    before(:each) do
+      commits = @client.commits("api-playground/api-sandbox")
+      @first_sha = commits.first.sha
+      @last_sha = commits.last.sha
+      @ref = @client.create_ref("api-playground/api-sandbox","heads/testing/test-ref", @first_sha)
     end
 
-  end
-
-  describe ".update_ref" do
-
-    it "updates a ref" do
-      stub_patch("/repos/octocat/Hello-World/git/refs/heads/sc/featureA").
-        with(:body => { "sha" => "aa218f56b14c9653891f9e74264a383fa43fefbd", "force" => true },
-             :headers => {'Content-Type'=>'application/json'}).
-        to_return(json_response("ref_update.json"))
-      refs = @client.update_ref("octocat/Hello-World","heads/sc/featureA", "aa218f56b14c9653891f9e74264a383fa43fefbd", true)
-      expect(refs.first.ref).to eq("refs/heads/sc/featureA")
-      expect(refs.first.object.sha).to eq("aa218f56b14c9653891f9e74264a383fa43fefbd")
+    after(:each) do
+      begin
+        @client.delete_ref("api-playground/api-sandbox", "heads/testing/test-ref")
+      rescue Octokit::UnprocessableEntity
+      end
     end
-  end
-
-  describe ".delete_ref" do
 
-    it "deletes an existing ref" do
-      stub_delete("/repos/octocat/Hello-World/git/refs/heads/feature-a").
-        to_return(:status => 204)
-      result = @client.delete_ref("octocat/Hello-World", "heads/feature-a")
-      expect(result).to eq(true)
-    end
-
-  end
+    describe ".create_ref" do
+      it "creates a ref" do
+        assert_requested :post, github_url("/repos/api-playground/api-sandbox/git/refs")
+      end
+    end # .create_ref
+
+    describe ".update_ref" do
+      it "updates a ref" do
+        refs = @client.update_ref("api-playground/api-sandbox", "heads/testing/test-ref", @last_sha, true)
+        assert_requested :patch, github_url("/repos/api-playground/api-sandbox/git/refs/heads/testing/test-ref")
+      end
+    end # .update_ref
+
+    describe ".delete_ref" do
+      it "deletes an existing ref" do
+        result = @client.delete_ref("api-playground/api-sandbox", "heads/testing/test-ref")
+        assert_requested :delete, github_url("/repos/api-playground/api-sandbox/git/refs/heads/testing/test-ref")
+      end
+    end # .delete_ref
+
+  end # @ref methods
 
 end