github_api 0.3.5 → 0.3.6

data/spec/github/repos/keys_spec.rb

@@ -0,0 +1,217 @@
+require 'spec_helper'
+
+describe Github::Repos::Keys do
+
+  let(:github) { Github.new }
+  let(:user)   { 'peter-murach'}
+  let(:repo)   { 'github' }
+
+  it { described_class::VALID_KEY_PARAM_NAMES.should_not be_nil }
+
+  describe "keys" do
+    context "resource found" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/keys").
+          to_return(:body => fixture("repos/keys.json"), :status => 200, :headers => {})
+      end
+
+      it "should fail to get resource without username" do
+        github.user, github.repo = nil, nil
+        expect { github.repos.keys }.to raise_error(ArgumentError)
+      end
+
+      it "should get the resources" do
+        github.repos.keys(user, repo)
+        a_get("/repos/#{user}/#{repo}/keys").should have_been_made
+      end
+
+      it "should return array of resources" do
+        keys = github.repos.keys(user, repo)
+        keys.should be_an Array
+        keys.should have(1).items
+      end
+
+      it "should get key information" do
+        keys = github.repos.keys(user, repo)
+        keys.first.title.should == 'octocat@octomac'
+      end
+    end
+
+    context "resource not found" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/keys").
+          to_return(:body => fixture("repos/keys.json"), :status => 404)
+      end
+
+      it "should fail to retrieve resource" do
+        expect {
+          github.repos.keys user, repo
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+
+  end
+
+  describe "get_key" do
+    let(:key_id) { 1 }
+
+    context "resource found" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/keys/#{key_id}").
+          to_return(:body => fixture("repos/key.json"), :status => 200)
+      end
+
+      it "should fail to get resource without key" do
+        expect {
+          github.repos.get_key(user, repo, nil)
+        }.to raise_error(ArgumentError)
+      end
+
+      it "should get the resource" do
+        github.repos.get_key(user, repo, key_id)
+        a_get("/repos/#{user}/#{repo}/keys/#{key_id}").should have_been_made
+      end
+
+      it "should get key information" do
+        key = github.repos.get_key(user, repo, key_id)
+        key.id.should == key_id
+      end
+    end
+
+    context "resource not found" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/keys/#{key_id}").
+          to_return(:body => fixture("repos/keys.json"), :status => 404)
+      end
+
+      it "should fail to retrieve resource" do
+        expect {
+          github.repos.get_key(user, repo, key_id)
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end
+
+  describe "create_key" do
+    let(:inputs) { {:title => "octocat@octomac", :key => "ssh-rsa AAA..." } }
+
+    context "resource created" do
+      before do
+        stub_post("/repos/#{user}/#{repo}/keys").with(inputs).
+          to_return(:body => fixture("repos/key.json"), :status => 201)
+      end
+
+      it "should fail to create resource if 'title' input is missing" do
+        expect {
+          github.repos.create_key(user, repo, :key => 'ssh-rsa AAA...')
+        }.to raise_error(ArgumentError)
+      end
+
+      it "should fail to create resource if 'key' input is missing" do
+        expect {
+          github.repos.create_key(user, repo, :title => 'octocat@octomac')
+        }.to raise_error(ArgumentError)
+      end
+
+      it "should create the resource" do
+        github.repos.create_key(user, repo, inputs)
+        a_post("/repos/#{user}/#{repo}/keys").with(inputs).should have_been_made
+      end
+
+      it "should get the key information back" do
+        key = github.repos.create_key(user, repo, inputs)
+        key.title.should == 'octocat@octomac'
+      end
+    end
+
+    context "failed to create resource" do
+      before do
+        stub_post("/repos/#{user}/#{repo}/keys").
+          to_return(:body => fixture("repos/key.json"), :status => 404)
+      end
+
+      it "should fail to retrieve resource" do
+        expect {
+          github.repos.create_key(user, repo, inputs)
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end
+
+  describe "edit_key" do
+    let(:key_id) { 1 }
+    let(:inputs) { {:title => "octocat@octomac", :key => "ssh-rsa AAA..." } }
+
+    context "resource edited successfully" do
+      before do
+        stub_patch("/repos/#{user}/#{repo}/keys/#{key_id}").
+          to_return(:body => fixture("repos/key.json"), :status => 200)
+      end
+
+      it "should edit the resource" do
+        github.repos.edit_key(user, repo, key_id, inputs)
+        a_patch("/repos/#{user}/#{repo}/keys/#{key_id}").should have_been_made
+      end
+
+      it "should get the key information back" do
+        key = github.repos.edit_key(user, repo, key_id, inputs)
+        key.id.should == key_id
+        key.title.should == 'octocat@octomac'
+      end
+    end
+
+    context "failed to edit resource" do
+      before do
+        stub_patch("/repos/#{user}/#{repo}/keys/#{key_id}").
+          to_return(:body => fixture("repos/key.json"), :status => 404)
+      end
+
+      it "should fail to retrieve resource" do
+        expect {
+          github.repos.edit_key(user, repo, key_id, inputs)
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+
+  end
+
+  describe "delete_key" do
+    let(:key_id) { 1 }
+
+    context "resource found successfully" do
+      before do
+        stub_delete("/repos/#{user}/#{repo}/keys/#{key_id}").
+          to_return(:body => "", :status => 204, :headers => { :content_type => "application/json; charset=utf-8"} )
+      end
+
+      it "should fail to delete without 'user/repo' parameters" do
+        github.user, github.repo = nil, nil
+        expect { github.repos.delete_key }.to raise_error(ArgumentError)
+      end
+
+      it "should fail to delete resource without key id" do
+        expect {
+          github.repos.delete_key user, repo, nil
+        }.to raise_error(ArgumentError)
+      end
+
+      it "should delete the resource" do
+        github.repos.delete_key(user, repo, key_id)
+        a_delete("/repos/#{user}/#{repo}/keys/#{key_id}").should have_been_made
+      end
+    end
+
+    context "failed to find resource" do
+      before do
+        stub_delete("/repos/#{user}/#{repo}/keys/#{key_id}").
+          to_return(:body => "", :status => 404)
+      end
+      it "should fail to find resource" do
+        expect {
+          github.repos.delete_key(user, repo, key_id)
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end
+
+end # Github::Repos::Keys

data/spec/github/repos/pub_sub_hubbub_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe Github::Repos::PubSubHubbub do
+
+  let(:github) { Github.new }
+  let(:topic)  { "https://github.com/peter-murach/github/events/push"}
+  let(:callback) { "github://campfire?subdomain=github&room=Commits&token=abc123" }
+  let(:hub_inputs) {
+    {
+       "hub.mode" => 'subscribe',
+       "hub.topic" => topic,
+       "hub.callback" => callback,
+       "hub.verify"   => 'sync',
+       "hub.secret"   => ''
+    }
+  }
+
+  describe "subscribe" do
+    context "success" do
+      before do
+        github.oauth_token = OAUTH_TOKEN
+        stub_post("/hub?access_token=#{OAUTH_TOKEN}").with(hub_inputs).
+          to_return(:body => '', :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      after do
+        github.oauth_token = nil
+      end
+
+      it "should subscribe to hub" do
+        github.repos.subscribe topic, callback
+        a_post("/hub?access_token=#{OAUTH_TOKEN}").with(hub_inputs).should have_been_made
+      end
+    end
+
+    context "failure" do
+      before do
+        github.oauth_token = OAUTH_TOKEN
+        stub_post("/hub?access_token=#{OAUTH_TOKEN}").with(hub_inputs).
+          to_return(:body => '', :status => 404, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to subscribe to hub" do
+        expect {
+          github.repos.subscribe topic, callback
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end
+
+  describe "unsubscribe" do
+    context "success" do
+      before do
+        github.oauth_token = OAUTH_TOKEN
+        stub_post("/hub?access_token=#{OAUTH_TOKEN}").with(hub_inputs.merge("hub.mode" => 'unsubscribe')).
+          to_return(:body => '', :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      after do
+        github.oauth_token = nil
+      end
+
+      it "should subscribe to hub" do
+        github.repos.unsubscribe topic, callback
+        a_post("/hub?access_token=#{OAUTH_TOKEN}").with(hub_inputs).should have_been_made
+      end
+    end
+
+    context "failure" do
+      before do
+        github.oauth_token = OAUTH_TOKEN
+        stub_post("/hub?access_token=#{OAUTH_TOKEN}").with(hub_inputs.merge("hub.mode" => 'unsubscribe')).
+          to_return(:body => '', :status => 404, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to subscribe to hub" do
+        expect {
+          github.repos.unsubscribe topic, callback
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end
+end # Github::Repos::PubSubHubbub

data/spec/github/repos/watching_spec.rb

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