github_api 0.8.1 → 0.8.2

data/spec/github/gitignore/get_spec.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Gitignore, '#get' do
+  let(:template) { 'Ruby' }
+  let(:request_path) { "/gitignore/templates/#{template}" }
+
+
+  before {
+    stub_get(request_path).to_return(:body => body, :status => status,
+      :headers => {:accept => accept })
+  }
+
+  after { reset_authentication_for(subject) }
+
+  context "resource found" do
+    let(:body) { fixture("gitignore/template.json") }
+    let(:status) { 200 }
+    let(:accept) { "application/json; charset=utf-8" }
+
+    it { should respond_to :find }
+
+    it "should fail to get resource without key" do
+      expect { subject.get nil }.to raise_error(ArgumentError)
+    end
+
+    it "should get the resource" do
+      subject.get template
+      a_get(request_path).should have_been_made
+    end
+
+    it "should get key information" do
+      temp = subject.get template
+      temp.name.should == "C"
+    end
+  end
+
+  context 'raw content' do
+    let(:body) { fixture("gitignore/template_raw") }
+    let(:status) { 200 }
+    let(:accept) { 'application/vnd.github.raw' }
+
+    it "should get the resource" do
+      subject.get template, 'mime' => 'application/vnd.github.raw'
+      a_get(request_path).should have_been_made
+    end
+  end
+
+  it_should_behave_like 'request failure' do
+    let(:accept) { 'application/json' }
+    let(:requestable) { subject.get template }
+  end
+end # get

data/spec/github/gitignore/list_spec.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Gitignore, '#list' do
+  let(:request_path) { "/gitignore/templates" }
+
+  before {
+    stub_get(request_path).to_return(:body => body, :status => status,
+      :headers => {:content_type => "application/json; charset=utf-8"})
+  }
+
+  after { reset_authentication_for(subject) }
+
+  context "resource found" do
+    let(:body) { fixture("gitignore/templates.json") }
+    let(:status) { 200 }
+
+    it { should respond_to :all }
+
+    it "should get the resources" do
+      subject.list
+      a_get(request_path).should have_been_made
+    end
+
+    it "should get template information" do
+      templates = subject.list
+      templates.first.should == 'Actionscript'
+    end
+
+    it "should yield to a block" do
+      yielded = []
+      result = subject.list { |obj| yielded << obj }
+      yielded.should == result
+    end
+  end
+
+  it_should_behave_like 'request failure' do
+    let(:requestable) { subject.list }
+  end
+
+end # list

data/spec/github/issues/comments_spec.rb

@@ -16,7 +16,7 @@ describe Github::Issues::Comments do
   describe '#list' do
     it { github.issues.should respond_to :all }
 
-    context "resource found" do
+    context "on an issue" do
       before do
         stub_get("/repos/#{user}/#{repo}/issues/#{issue_id}/comments").
           to_return(:body => fixture('issues/comments.json'),
@@ -26,36 +26,71 @@ describe Github::Issues::Comments do
 
       it "should fail to get resource without username" do
         expect {
-          github.issues.comments.list user, repo, nil
+          github.issues.comments.list user, nil
         }.to raise_error(ArgumentError)
       end
 
       it "should get the resources" do
-        github.issues.comments.list user, repo, issue_id
+        github.issues.comments.list user, repo, :issue_id => issue_id
         a_get("/repos/#{user}/#{repo}/issues/#{issue_id}/comments").should have_been_made
       end
 
       it "should return array of resources" do
-        comments = github.issues.comments.list user, repo, issue_id
+        comments = github.issues.comments.list user, repo, :issue_id => issue_id
+        comments.should be_an Array
+        comments.should have(1).items
+      end
+
+      it "should be a mash type" do
+        comments = github.issues.comments.list user, repo, :issue_id => issue_id
+        comments.first.should be_a Hashie::Mash
+      end
+
+      it "should get issue comment information" do
+        comments = github.issues.comments.list user, repo, :issue_id => issue_id
+        comments.first.user.login.should == 'octocat'
+      end
+
+      it "should yield to a block" do
+        yielded = []
+        result = github.issues.comments.list(user, repo, :issue_id => issue_id) { |obj| yielded << obj }
+        yielded.should == result
+      end
+    end
+
+    context "in a repository" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/issues/comments").
+          to_return(:body => fixture('issues/comments.json'),
+            :status => 200,
+            :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should get the resources" do
+        github.issues.comments.list user, repo
+        a_get("/repos/#{user}/#{repo}/issues/comments").should have_been_made
+      end
+
+      it "should return array of resources" do
+        comments = github.issues.comments.list user, repo
         comments.should be_an Array
         comments.should have(1).items
       end
 
       it "should be a mash type" do
-        comments = github.issues.comments.list user, repo, issue_id
+        comments = github.issues.comments.list user, repo
         comments.first.should be_a Hashie::Mash
       end
 
       it "should get issue comment information" do
-        comments = github.issues.comments.list user, repo, issue_id
+        comments = github.issues.comments.list user, repo
         comments.first.user.login.should == 'octocat'
       end
 
       it "should yield to a block" do
-        github.issues.comments.should_receive(:list).
-          with(user, repo, issue_id).and_yield('web')
-        github.issues.comments.list(user, repo, issue_id) { |param| 'web' }.
-          should == 'web'
+        yielded = []
+        result = github.issues.comments.list(user, repo) { |obj| yielded << obj }
+        yielded.should == result
       end
     end
 
@@ -67,7 +102,7 @@ describe Github::Issues::Comments do
 
       it "should return 404 with a message 'Not Found'" do
         expect {
-          github.issues.comments.list user, repo, issue_id
+          github.issues.comments.list user, repo, :issue_id => issue_id
         }.to raise_error(Github::Error::NotFound)
       end
     end

data/spec/github/pull_requests/comments_spec.rb

@@ -14,8 +14,7 @@ describe Github::PullRequests::Comments do
   describe "#list" do
     it { github.pull_requests.comments.should respond_to :all }
 
-    context 'resource found' do
-
+    context 'on a pull request' do
       before do
         stub_get("/repos/#{user}/#{repo}/pulls/#{pull_request_id}/comments").
           to_return(:body => fixture('pull_requests/comments.json'),
@@ -25,36 +24,72 @@ describe Github::PullRequests::Comments do
 
       it "throws error if comment id not provided" do
         expect {
-          github.pull_requests.comments.list user, repo, nil
+          github.pull_requests.comments.list user, nil
         }.to raise_error(ArgumentError)
       end
 
       it "should get the resources" do
-        github.pull_requests.comments.list user, repo, pull_request_id
+        github.pull_requests.comments.list user, repo, :request_id => pull_request_id
         a_get("/repos/#{user}/#{repo}/pulls/#{pull_request_id}/comments").
           should have_been_made
       end
 
       it "should return array of resources" do
-        comments = github.pull_requests.comments.list user, repo, pull_request_id
+        comments = github.pull_requests.comments.list user, repo, :request_id => pull_request_id
+        comments.should be_an Array
+        comments.should have(1).items
+      end
+
+      it "should be a mash type" do
+        comments = github.pull_requests.comments.list user, repo, :request_id => pull_request_id
+        comments.first.should be_a Hashie::Mash
+      end
+
+      it "should get pull request comment information" do
+        comments = github.pull_requests.comments.list user, repo, :request_id => pull_request_id
+        comments.first.id.should == pull_request_id
+      end
+
+      it "should yield to a block" do
+        yielded = []
+        result = github.pull_requests.comments.list(user, repo, :request_id => pull_request_id) { |obj| yielded << obj }
+        yielded.should == result
+      end
+    end
+
+    context 'in a repository' do
+      before do
+        stub_get("/repos/#{user}/#{repo}/pulls/comments").
+          to_return(:body => fixture('pull_requests/comments.json'),
+            :status => 200,
+            :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should get the resources" do
+        github.pull_requests.comments.list user, repo
+        a_get("/repos/#{user}/#{repo}/pulls/comments").should have_been_made
+      end
+
+      it "should return array of resources" do
+        comments = github.pull_requests.comments.list user, repo
         comments.should be_an Array
         comments.should have(1).items
       end
 
       it "should be a mash type" do
-        comments = github.pull_requests.comments.list user, repo, pull_request_id
+        comments = github.pull_requests.comments.list user, repo
         comments.first.should be_a Hashie::Mash
       end
 
       it "should get pull request comment information" do
-        comments = github.pull_requests.comments.list user, repo, pull_request_id
+        comments = github.pull_requests.comments.list user, repo
         comments.first.id.should == pull_request_id
       end
 
       it "should yield to a block" do
-        github.pull_requests.comments.should_receive(:list).
-          with(user, repo, pull_request_id).and_yield('web')
-        github.pull_requests.comments.list(user, repo, pull_request_id) {|param| 'web' }
+        yielded = []
+        result = github.pull_requests.comments.list(user, repo) { |obj| yielded << obj }
+        yielded.should == result
       end
     end
 
@@ -66,7 +101,7 @@ describe Github::PullRequests::Comments do
 
       it "should return 404 with a message 'Not Found'" do
         expect {
-          github.pull_requests.comments.list user, repo, pull_request_id
+          github.pull_requests.comments.list user, repo, :request_id => pull_request_id
         }.to raise_error(Github::Error::NotFound)
       end
     end

data/spec/github/pull_requests_spec.rb

@@ -57,7 +57,7 @@ describe Github::PullRequests do
     context 'resource not found' do
       before do
         stub_get("/repos/#{user}/#{repo}/pulls").
-          to_return(:body => "", :status => [404, "Not Found"])
+          to_return(:body => "[]", :status => [404, "Not Found"])
       end
 
       it "should return 404 with a message 'Not Found'" do
@@ -338,7 +338,7 @@ describe Github::PullRequests do
         github.oauth_token = nil
         github.user = nil
         stub_get("/repos/#{user}/#{repo}/pulls/#{pull_request_id}/merge").
-          to_return(:body => "", :status => 404, :headers => {:user_agent => github.user_agent})
+          to_return(:body => "[]", :status => 404, :headers => {:user_agent => github.user_agent})
       end
 
       it "should fail validation " do
@@ -354,7 +354,7 @@ describe Github::PullRequests do
 
       it "should return true if resoure found" do
         stub_get("/repos/#{user}/#{repo}/pulls/#{pull_request_id}/merge").
-          to_return(:body => "", :status => 200,
+          to_return(:body => "[]", :status => 200,
                     :headers => {:user_agent => github.user_agent})
         merged = github.pull_requests.merged? user, repo, pull_request_id
         merged.should be_true

data/spec/github/repos/contents/archive_spec.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Repos::Contents, '#get' do
+  let(:user) { 'peter-murach' }
+  let(:repo) { 'github' }
+  let(:request_path) { "/repos/#{user}/#{repo}/#{archive_format}/#{ref}" }
+
+  before {
+    stub_get(request_path).to_return(:body => body, :status => status,
+        :headers => {:content_type => "application/json; charset=utf-8"})
+  }
+
+  after { reset_authentication_for(subject) }
+
+  let(:archive_format) { 'tarball' }
+  let(:ref) { 'master' }
+  let(:body) { '[]' }
+  let(:status) { 302 }
+
+  it "should get the resources" do
+    subject.archive user, repo, :archive_format => archive_format, :ref => ref
+    a_get(request_path).should have_been_made
+  end
+end

data/spec/github/repos/contents/get_spec.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Repos::Contents, '#get' do
+  let(:user) { 'peter-murach' }
+  let(:repo) { 'github' }
+  let(:request_path) { "/repos/#{user}/#{repo}/contents/#{path}" }
+
+  before {
+    stub_get(request_path).to_return(:body => body, :status => status,
+        :headers => {:content_type => "application/json; charset=utf-8"})
+  }
+
+  after { reset_authentication_for(subject) }
+
+  let(:path) { 'README.md' }
+  let(:body) { fixture('repos/content.json') }
+  let(:status) { 200 }
+
+  it "should get the resources" do
+    subject.get user, repo, path
+    a_get(request_path).should have_been_made
+  end
+
+  it "should get repository information" do
+    content = subject.get user, repo, path
+    content.name.should == 'README.md'
+  end
+end

data/spec/github/repos/contents/readme_spec.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Repos::Contents, '#readme' do
+  let(:user) { 'peter-murach' }
+  let(:repo) { 'github' }
+  let(:request_path) { "/repos/#{user}/#{repo}/readme" }
+
+  before {
+    stub_get(request_path).
+      to_return(:body => body, :status => status,
+        :headers => {:content_type => "application/json; charset=utf-8"})
+  }
+
+  after { reset_authentication_for(subject) }
+
+  let(:body) { fixture('repos/readme.json') }
+  let(:status) { 200 }
+
+  it "should get the resources" do
+    subject.readme user, repo
+    a_get(request_path).should have_been_made
+  end
+
+  it "should get readme information" do
+    readme = subject.readme user, repo
+    readme.name.should == 'README.md'
+  end
+end

data/spec/github/repos/hooks/create_spec.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Repos::Hooks, '#create' do
+  let(:user) { 'peter-murach' }
+  let(:repo) { 'github' }
+  let(:request_path) { "/repos/#{user}/#{repo}/hooks" }
+  let(:inputs) {
+    {
+      'name' => 'web',
+      'config' => {
+        'url' => "http://something.com/webhook",
+        'address' => "test@example.com",
+        'subdomain' => "github",
+        'room' => "Commits",
+        'token' => "abc123"
+      },
+      'active' => true,
+      'unrelated' => true
+    }
+  }
+
+  before {
+    stub_post(request_path).with(inputs.except('unrelated')).
+      to_return(:body => body, :status => status,
+        :headers => {:content_type => "application/json; charset=utf-8"})
+  }
+
+  after { reset_authentication_for(subject) }
+
+  context "resouce created" do
+    let(:body) { fixture('repos/hook.json') }
+    let(:status) { 201 }
+
+    it "should fail to create resource if 'name' input is missing" do
+      expect {
+        subject.create user, repo, inputs.except('name')
+      }.to raise_error(Github::Error::RequiredParams)
+    end
+
+    it "should failt to create resource if 'config' input is missing" do
+      expect {
+        subject.create user, repo, inputs.except('config')
+      }.to raise_error(Github::Error::RequiredParams)
+    end
+
+    it "should create resource successfully" do
+      subject.create user, repo, inputs
+      a_post(request_path).with(inputs).should have_been_made
+    end
+
+    it "should return the resource" do
+      hook = subject.create user, repo, inputs
+      hook.should be_a Hashie::Mash
+    end
+
+    it "should get the hook information" do
+      hook = subject.create user, repo, inputs
+      hook.name.should == 'web'
+    end
+  end
+
+  it_should_behave_like 'request failure' do
+    let(:requestable) { subject.create user, repo, inputs }
+  end
+
+end # create