github_api 0.6.5 → 0.7.0

data/spec/fixtures/repos/stargazers.json

@@ -0,0 +1,9 @@
+[
+  {
+    "login": "octocat",
+    "id": 1,
+    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+    "gravatar_id": "somehexcode",
+    "url": "https://api.github.com/users/octocat"
+  }
+]

data/spec/fixtures/repos/starred.json

@@ -0,0 +1,34 @@
+[
+  {
+    "url": "https://api.github.com/repos/octocat/Hello-World",
+    "html_url": "https://github.com/octocat/Hello-World",
+    "clone_url": "https://github.com/octocat/Hello-World.git",
+    "git_url": "git://github.com/octocat/Hello-World.git",
+    "ssh_url": "git@github.com:octocat/Hello-World.git",
+    "svn_url": "https://svn.github.com/octocat/Hello-World",
+    "mirror_url": "git://git.example.com/octocat/Hello-World",
+    "id": 1296269,
+      "owner": {
+        "login": "octocat",
+        "id": 1,
+        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+        "gravatar_id": "somehexcode",
+        "url": "https://api.github.com/users/octocat"
+      },
+    "name": "Hello-World",
+    "full_name": "octocat/Hello-World",
+    "description": "This your first repo!",
+    "homepage": "https://github.com",
+    "language": null,
+    "private": false,
+    "fork": false,
+    "forks": 9,
+    "watchers": 80,
+    "size": 108,
+    "master_branch": "master",
+    "open_issues": 0,
+    "pushed_at": "2011-01-26T19:06:43Z",
+    "created_at": "2011-01-26T19:01:12Z",
+    "updated_at": "2011-01-26T19:14:43Z"
+  }
+]

data/spec/fixtures/repos/status.json

@@ -0,0 +1,16 @@
+{
+  "created_at": "2012-07-20T01:19:13Z",
+  "updated_at": "2012-07-20T01:19:13Z",
+  "state": "success",
+  "target_url": "https://ci.example.com/1000/output",
+  "description": "Build has completed successfully",
+  "id": 1,
+  "url": "https://api.github.com/repos/octocat/example/statuses/1",
+  "creator": {
+    "login": "octocat",
+    "id": 1,
+    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+    "gravatar_id": "somehexcode",
+    "url": "https://api.github.com/users/octocat"
+  }
+}

data/spec/fixtures/repos/statuses.json

@@ -0,0 +1,18 @@
+[
+  {
+    "created_at": "2012-07-20T01:19:13Z",
+    "updated_at": "2012-07-20T01:19:13Z",
+    "state": "success",
+    "target_url": "https://ci.example.com/1000/output",
+    "description": "Build has completed successfully",
+    "id": 1,
+    "url": "https://api.github.com/repos/octocat/example/statuses/1",
+    "creator": {
+      "login": "octocat",
+      "id": 1,
+      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+      "gravatar_id": "somehexcode",
+      "url": "https://api.github.com/users/octocat"
+    }
+  }
+]

data/spec/github/{repos → issues}/assignees_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
-describe Github::Repos::Assignees do
-  let(:github) { Github::Repos::Assignees.new }
+describe Github::Issues::Assignees do
+  let(:github) { Github::Issues::Assignees.new }
   let(:user) { 'peter-murach' }
   let(:repo) { 'github' }
   let(:assignee) { 'octocat' }

data/spec/github/repos/merging_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Github::Repos::Merging do
+  let(:github) { Github.new }
+  let(:user) { 'peter-murach' }
+  let(:repo) { 'github' }
+
+  after { github.user, github.repo, github.oauth_token = nil, nil, nil }
+
+  describe "#merge" do
+    let(:inputs) do
+      {
+        "base" => "master",
+        "head" => "cool_feature",
+        "commit_message" => "Shipped cool_feature!"
+      }
+    end
+
+    context "resouce merged" do
+      before do
+        stub_post("/repos/#{user}/#{repo}/merges").with(inputs).
+          to_return(:body => fixture('repos/merge.json'),
+            :status => 201,
+            :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to merge resource if 'base' input is missing" do
+        expect {
+          github.repos.merging.merge user, repo, inputs.except('base')
+        }.to raise_error(Github::Error::RequiredParams)
+      end
+
+      it "should fail to create resource if 'head' input is missing" do
+        expect {
+          github.repos.merging.merge user, repo, inputs.except('head')
+        }.to raise_error(Github::Error::RequiredParams)
+      end
+
+      it "should merge resource successfully" do
+        github.repos.merging.merge user, repo, inputs
+        a_post("/repos/#{user}/#{repo}/merges").with(inputs).should have_been_made
+      end
+
+      it "should return the resource" do
+        merge = github.repos.merging.merge user, repo, inputs
+        merge.should be_a Hashie::Mash
+      end
+
+      it "should get the commit comment information" do
+        merge = github.repos.merging.merge user, repo, inputs
+        merge.commit.author.login.should == 'octocat'
+      end
+    end
+
+    context "failed to create resource" do
+      before do
+        stub_post("/repos/#{user}/#{repo}/merges").with(inputs).
+          to_return(:body => fixture('repos/merge.json'), 
+            :status => 404,
+            :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to retrieve resource" do
+        expect {
+          github.repos.merging.merge user, repo, inputs
+        }.to raise_error(Github::Error::NotFound)
+      end
+    end
+  end # merge
+
+end # Github::Repos::Merging

data/spec/github/repos/starring_spec.rb

@@ -0,0 +1,203 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Repos::Starring do
+  let(:github) { Github.new }
+  let(:user) { 'peter-murach' }
+  let(:repo) { 'github' }
+
+  after { github.user, github.repo, github.oauth_token = nil, nil, nil }
+
+  describe "#list" do
+    before do
+      stub_get("/repos/#{user}/#{repo}/stargazers").
+        to_return(:body => fixture("repos/stargazers.json"),
+                  :status => 200, :headers => {})
+    end
+
+    it "should fail to get resource without username" do
+      expect {
+        github.repos.starring.list
+      }.to raise_error(ArgumentError)
+    end
+
+    it "should yield iterator if block given" do
+      github.repos.starring.should_receive(:list).
+        with(user, repo).and_yield('github')
+      github.repos.starring.list(user, repo) { |param| 'github' }
+    end
+
+    it "should get the resources" do
+      github.repos.starring.list user, repo
+      a_get("/repos/#{user}/#{repo}/stargazers").should have_been_made
+    end
+
+    it "should return array of resources" do
+      stargazers = github.repos.starring.list user, repo
+      stargazers.should be_an Array
+      stargazers.should have(1).items
+    end
+
+    it "should return result of mash type" do
+      stargazers = github.repos.starring.list user, repo
+      stargazers.first.should be_a Hashie::Mash
+    end
+
+    it "should get watcher information" do
+      stargazers = github.repos.starring.list user, repo
+      stargazers.first.login.should == 'octocat'
+    end
+
+    context "fail to find resource" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/stargazers").
+          to_return(:body => "", :status => 404)
+      end
+
+      it "should return 404 not found message" do
+        expect {
+          github.repos.starring.list user, repo
+        }.to raise_error(Github::Error::NotFound)
+      end
+    end
+  end
+
+  describe "#starred" do
+    context "if user unauthenticated" do
+      it "should fail to get resource without username " do
+        stub_get("/user/starred").
+          to_return(:body => '', :status => 401, :headers => {})
+        expect {
+          github.repos.starring.starred
+        }.to raise_error(Github::Error::Unauthorized)
+      end
+
+      it "should get the resource with username" do
+        stub_get("/users/#{user}/starred").
+          to_return(:body => fixture("repos/starred.json"), :status => 200, :headers => {})
+        github.repos.starring.starred :user => user
+        a_get("/users/#{user}/starred").should have_been_made
+      end
+    end
+
+    context "if user authenticated" do
+      before do
+        github.oauth_token = OAUTH_TOKEN
+        stub_get("/user/starred").
+          with(:query => {:access_token => OAUTH_TOKEN}).
+          to_return(:body => fixture("repos/starred.json"),
+            :status => 200, :headers => {})
+      end
+
+      it "should get the resources" do
+        github.repos.starring.starred
+        a_get("/user/starred").with(:query => {:access_token => OAUTH_TOKEN}).
+          should have_been_made
+      end
+
+      it "should return array of resources" do
+        starred = github.repos.starring.starred
+        starred.should be_an Array
+        starred.should have(1).items
+      end
+
+      it "should get starred information" do
+        starred = github.repos.starring.starred
+        starred.first.name.should == 'Hello-World'
+        starred.first.owner.login.should == 'octocat'
+      end
+    end
+  end # starred
+
+  describe "starring?" do
+    context "with username ane reponame passed" do
+      context "this repo is being watched by the user"
+        before do
+          stub_get("/user/starred/#{user}/#{repo}").
+            to_return(:body => "", :status => 404,
+                      :headers => {:user_agent => github.user_agent})
+        end
+
+      it "should return false if resource not found" do
+        starring = github.repos.starring.starring? user, repo
+        starring.should be_false
+      end
+
+      it "should return true if resoure found" do
+          stub_get("/user/starred/#{user}/#{repo}").
+            to_return(:body => "", :status => 200,
+            :headers => {:user_agent => github.user_agent})
+        starring = github.repos.starring.starring? user, repo
+        starring.should be_true
+      end
+    end
+
+    context "without username and reponame passed" do
+      it "should fail validation " do
+        expect {
+          github.repos.starring.starring?(nil, nil)
+        }.to raise_error(ArgumentError)
+      end
+    end
+  end # starring?
+
+  describe "#star" do
+    context "user authenticated" do
+      context "with correct information" do
+        before do
+          github.oauth_token = OAUTH_TOKEN
+          stub_put("/user/starred/#{user}/#{repo}").
+            with(:query => {:access_token => OAUTH_TOKEN}).
+            to_return(:body => "", :status => 204, :headers => {})
+        end
+
+        it "should successfully star a repo" do
+          github.repos.starring.star user, repo
+          a_put("/user/starred/#{user}/#{repo}").
+            with(:query => {:access_token => OAUTH_TOKEN}).
+            should have_been_made
+        end
+      end
+    end
+
+    context "user unauthenticated" do
+      it "should fail" do
+        stub_put("/user/starred/#{user}/#{repo}").
+          to_return(:body => "", :status => 401, :headers => {})
+        expect {
+          github.repos.starring.star user, repo
+        }.to raise_error(Github::Error::Unauthorized)
+      end
+    end
+  end # star
+
+  describe "#unstar" do
+    context "user authenticated" do
+      context "with correct information" do
+        before do
+          github.oauth_token = OAUTH_TOKEN
+          stub_delete("/user/starred/#{user}/#{repo}?access_token=#{OAUTH_TOKEN}").
+            to_return(:body => "", :status => 204, :headers => {})
+        end
+
+        it "should successfully unstar a repo" do
+          github.repos.starring.unstar user, repo
+          a_delete("/user/starred/#{user}/#{repo}?access_token=#{OAUTH_TOKEN}").
+            should have_been_made
+        end
+      end
+    end
+
+    context "user unauthenticated" do
+      it "should fail" do
+        stub_delete("/user/starred/#{user}/#{repo}").
+          to_return(:body => "", :status => 401, :headers => {})
+        expect {
+          github.repos.starring.unstar user, repo
+        }.to raise_error(Github::Error::Unauthorized)
+      end
+    end
+  end # stop_watching
+
+end # Github::Respos::Starring

data/spec/github/repos/statuses_spec.rb

@@ -0,0 +1,124 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Repos::Statuses do
+  let(:github) { Github.new }
+  let(:user) { 'peter-murach' }
+  let(:repo) { 'github' }
+  let(:sha) { 'f5f71ce1b7295c31f091be1654618c7ec0cc6b71' }
+
+  after { github.user, github.repo, github.oauth_token = nil, nil, nil }
+
+  it { described_class::VALID_STATUS_PARAM_NAMES.should_not be_nil }
+  it { described_class::REQUIRED_PARAMS.should_not be_nil }
+
+  describe "#list" do
+    it { github.repos.statuses.should respond_to :all }
+
+    context "resource found" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/statuses/#{sha}").
+          to_return(:body => fixture('repos/statuses.json'), :status => 200,
+            :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to get resource without sha" do
+        expect { github.repos.statuses.list }.to raise_error(ArgumentError)
+      end
+
+      it "should get the resources" do
+        github.repos.statuses.list user, repo, sha
+        a_get("/repos/#{user}/#{repo}/statuses/#{sha}").should have_been_made
+      end
+
+      it "should return array of resources" do
+        statuses = github.repos.statuses.list user, repo, sha
+        statuses.should be_an Array
+        statuses.should have(1).items
+      end
+
+      it "should be a mash type" do
+        statuses = github.repos.statuses.list user, repo, sha
+        statuses.first.should be_a Hashie::Mash
+      end
+
+      it "should get status information" do
+        statuses = github.repos.statuses.list user, repo, sha
+        statuses.first.state.should == 'success'
+      end
+
+      it "should yield to a block" do
+        github.repos.statuses.should_receive(:list).with(user, repo, sha).and_yield('web')
+        github.repos.statuses.list(user, repo, sha) { |param| 'web' }
+      end
+    end
+
+    context "resource not found" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/statuses/#{sha}").
+          to_return(:body => "", :status => [404, "Not Found"])
+      end
+
+      it "should return 404 with a message 'Not Found'" do
+        expect {
+          github.repos.statuses.list user, repo, sha
+        }.to raise_error(Github::Error::NotFound)
+      end
+    end
+  end # list
+
+  describe "#create" do
+    let(:inputs) {
+      {
+        'state' => 'success'
+      }
+    }
+
+    context "resource created" do
+      before do
+        stub_post("/repos/#{user}/#{repo}/statuses/#{sha}").
+          with(inputs.except('unrelated')).
+          to_return(:body => fixture('repos/status.json'),
+            :status => 201,
+            :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to create resource if 'state' input is missing" do
+        expect {
+          github.repos.statuses.create user, repo, sha, inputs.except('state')
+        }.to raise_error(Github::Error::RequiredParams)
+      end
+
+      it "should create resource successfully" do
+        github.repos.statuses.create user, repo, sha, inputs
+        a_post("/repos/#{user}/#{repo}/statuses/#{sha}").with(inputs).should have_been_made
+      end
+
+      it "should return the resource" do
+        status = github.repos.statuses.create user, repo, sha, inputs
+        status.should be_a Hashie::Mash
+      end
+
+      it "should get the status information" do
+        status = github.repos.statuses.create user, repo, sha, inputs
+        status.state.should == 'success'
+      end
+    end
+
+    context "fail to create resource" do
+      before do
+        stub_post("/repos/#{user}/#{repo}/statuses/#{sha}").with(inputs).
+          to_return(:body => fixture('repos/status.json'), :status => 404,
+            :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to retrieve resource" do
+        expect {
+          github.repos.statuses.create user, repo, sha, inputs
+        }.to raise_error(Github::Error::NotFound)
+      end
+    end
+  end # create
+
+end # Github::Repos::Statuses