github_api 0.11.3 → 0.12.0

data/spec/github/client/repos/commits/compare_spec.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Client::Repos::Commits, '#compare' do
+  let(:user) { 'peter-murach' }
+  let(:repo) { 'github' }
+  let(:base) { 'master' }
+  let(:head) { 'topic' }
+  let(:request_path) { "/repos/#{user}/#{repo}/compare/#{base}...#{head}" }
+
+  before {
+    stub_get(request_path).
+      to_return(:body => fixture('repos/commit_comparison.json'),
+        :status => 200,
+        :headers => {:content_type => "application/json; charset=utf-8"})
+  }
+
+  after { reset_authentication_for(subject) }
+
+  it { expect { subject.compare }.to raise_error(ArgumentError) }
+
+  it "should fail to get resource without base" do
+    expect { subject.compare user, repo, nil, head }.to raise_error(ArgumentError)
+  end
+
+  it "should compare successfully" do
+    subject.compare user, repo, base, head
+    a_get(request_path).should have_been_made
+  end
+
+  it "should get comparison information" do
+    commit = subject.compare user, repo, base, head
+    commit.base_commit.commit.author.name.should == 'Monalisa Octocat'
+  end
+end # compare

data/spec/github/client/repos/commits/get_spec.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Client::Repos::Commits, '#get' do
+  let(:user) { 'peter-murach' }
+  let(:repo) { 'github' }
+  let(:sha) { '23432dfosfsufd' }
+  let(:request_path) { "/repos/#{user}/#{repo}/commits/#{sha}" }
+
+  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('repos/commit.json') }
+    let(:status) { 200 }
+
+    it { should respond_to :find }
+
+    it { expect { subject.get }.to raise_error(ArgumentError) }
+
+    it "should fail to get resource without sha key" do
+      expect { subject.get user, repo }.to raise_error(ArgumentError)
+    end
+
+    it "should get the resource" do
+      subject.get user, repo, sha
+      a_get(request_path).should have_been_made
+    end
+
+    it "should get commit information" do
+      commit = subject.get user, repo, sha
+      commit.commit.author.name.should == 'Monalisa Octocat'
+    end
+
+    it "should return mash" do
+      commit = subject.get user, repo, sha
+      commit.should be_a Github::ResponseWrapper
+    end
+  end
+
+  it_should_behave_like 'request failure' do
+    let(:requestable) { subject.get user, repo, sha }
+  end
+end # get

data/spec/github/client/repos/commits/list_spec.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Client::Repos::Commits, '#list' do
+  let(:user) { 'peter-murach' }
+  let(:repo) { 'github' }
+  let(:request_path) { "/repos/#{user}/#{repo}/commits" }
+
+  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('repos/commits.json') }
+    let(:status) { 200 }
+
+    it { should respond_to :all }
+
+    it { expect { subject.list }.to raise_error(ArgumentError) }
+
+    it { expect { subject user }.to raise_error(ArgumentError) }
+
+    it "should get the resources" do
+      subject.list user, repo
+      a_get(request_path).should have_been_made
+    end
+
+    it_should_behave_like 'an array of resources' do
+      let(:requestable) { subject.list user, repo }
+    end
+
+    it "should get commit information" do
+      commits = subject.list user, repo
+      commits.first.author.name.should == 'Scott Chacon'
+    end
+
+    it "should yield to a block" do
+      yielded = []
+      result = subject.list(user, repo) { |obj| yielded << obj }
+      yielded.should == result
+    end
+  end
+
+  it_should_behave_like 'request failure' do
+    let(:requestable) { subject.list user, repo }
+  end
+end # list

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

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Client::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
+
+  context 'with defaults' do
+    let(:request_path) { "/repos/#{user}/#{repo}/tarball/master" }
+
+    it { expect { subject.archive user }.to raise_error(ArgumentError) }
+
+    it 'should get the resource' do
+      subject.archive user, repo
+      a_get(request_path).should have_been_made
+    end
+  end
+end

data/spec/github/client/repos/contents/create_spec.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Client::Repos::Contents, '#create' do
+  let(:user) { 'peter-murach' }
+  let(:repo) { 'github' }
+  let(:path) { 'hello.rb' }
+  let(:request_path) { "/repos/#{user}/#{repo}/contents/#{path}" }
+
+  before {
+    stub_put(request_path).to_return(:body => body, :status => status,
+        :headers => {:content_type => "application/json; charset=utf-8"})
+  }
+
+  after { reset_authentication_for(subject) }
+
+  let(:params) {
+    {
+      "path"    => 'hello.rb',
+      "content" => "puts 'hello ruby'",
+      "message" => "initial commit"
+    }
+  }
+  let(:body) { fixture('repos/content_created.json') }
+  let(:status) { 201 }
+
+  it { expect { subject.create }.to raise_error(ArgumentError)}
+
+  it { expect { subject.create user, repo, path }.to raise_error(Github::Error::RequiredParams) }
+
+  it "creates the resource" do
+    subject.create user, repo, path, params
+    a_put(request_path).should have_been_made
+  end
+
+  it "gets repository contents information" do
+    content = subject.create user, repo, path, params
+    content.content.name.should == 'hello.txt'
+  end
+end

data/spec/github/client/repos/contents/delete_spec.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Client::Repos::Contents, '#delete' do
+  let(:user) { 'peter-murach' }
+  let(:repo) { 'github' }
+  let(:path) { 'hello.rb' }
+  let(:params) {
+    {
+      "path"    => 'hello.rb',
+      "message" => "initial commit",
+      "sha"     => "329688480d39049927147c162b9d2deaf885005f"
+    }
+  }
+  let(:request_path) { "/repos/#{user}/#{repo}/contents/#{path}" }
+
+  after { reset_authentication_for(subject) }
+
+  before do
+    stub_delete(request_path).with(:query => params).
+      to_return(:body => body, :status => status,
+        :headers => { :content_type => "application/json; charset=utf-8"})
+  end
+
+  context "resource deleted successfully" do
+    let(:body)   { fixture('repos/content_deleted.json') }
+    let(:status) { 200 }
+
+    it { expect { subject.delete }.to raise_error(ArgumentError) }
+
+    it "should fail to delete without 'user/repo' parameters" do
+      expect { subject.delete user }.to raise_error(ArgumentError)
+    end
+
+    it "should fail to delete resource without 'path'" do
+      expect { subject.delete user, repo, path }.to raise_error(Github::Error::RequiredParams)
+    end
+
+    it "should delete the resource" do
+      subject.delete user, repo, path, params
+      a_delete(request_path).with(:query => params).should have_been_made
+    end
+
+    it "gets repository contents information" do
+      content = subject.delete user, repo, path, params
+      content.content.should be_nil
+    end
+  end
+
+  it_should_behave_like 'request failure' do
+    let(:requestable) { subject.delete user, repo, path, params }
+  end
+
+end # delete

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

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Client::Repos::Contents, '#get' do
+  let(:user) { 'peter-murach' }
+  let(:repo) { 'github' }
+  let(:path) { 'README.md' }
+  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 { expect { subject.get user, repo }.to raise_error(ArgumentError) }
+
+  it { expect { subject.get }.to raise_error(ArgumentError)}
+
+  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/client/repos/contents/readme_spec.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Client::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/client/repos/contributors_spec.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Client::Repos, '#contributors' do
+  let(:user) { 'peter-murach' }
+  let(:repo) { 'github' }
+
+  after { reset_authentication_for subject }
+
+  let(:request_path) { "/repos/#{user}/#{repo}/contributors" }
+
+  before do
+    stub_get(request_path).to_return(:body => body, :status => status,
+      :headers => {:content_type => "application/json; charset=utf-8"})
+  end
+
+  context "resource found" do
+    let(:body)   { fixture('repos/contributors.json') }
+    let(:status) { 200 }
+
+    it "should raise error when no user/repo parameters" do
+      expect { subject.contributors }.to raise_error(ArgumentError)
+    end
+
+    it "should raise error when no repository" do
+      expect { subject.contributors user }.to raise_error(ArgumentError)
+    end
+
+    it 'filters out unknown parameters' do
+      subject.contributors user, repo, :unknown => true
+      a_get(request_path).with({}).should have_been_made
+    end
+
+    it "should find resources" do
+      subject.contributors user, repo
+      a_get(request_path).should have_been_made
+    end
+
+    it_should_behave_like 'an array of resources' do
+      let(:requestable) { subject.contributors user, repo }
+    end
+
+    it "should get branch information" do
+      contributors = subject.contributors user, repo
+      contributors.first.login.should == 'octocat'
+    end
+
+    it "should yield to a block" do
+      subject.should_receive(:contributors).with(user, repo).and_yield('web')
+      subject.contributors(user, repo) { |param| 'web'}
+    end
+  end
+
+  it_should_behave_like 'request failure' do
+    let(:requestable) { subject.contributors user, repo }
+  end
+end # contributors

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

@@ -0,0 +1,77 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Client::Repos, '#create' do
+  let(:user) { 'peter-murach' }
+  let(:repo) { 'github' }
+  let(:inputs) { {
+    :name => 'web',
+    :description => "This is your first repo",
+    :homepage => "https://github.com",
+    :public => true,
+    :has_issues => true,
+    :has_wiki => true
+  } }
+
+  before {
+    subject.oauth_token = OAUTH_TOKEN
+    stub_post(request_path).with(inputs).
+      to_return(:body => body, :status => status,
+        :headers => {:content_type => "application/json; charset=utf-8"} )
+  }
+
+  after { reset_authentication_for subject }
+
+  context "resource created successfully" do
+    let(:body)   { fixture('repos/repo.json') }
+    let(:status) { 201 }
+
+    context "for the authenticated user" do
+      let(:request_path) { "/user/repos?access_token=#{OAUTH_TOKEN}" }
+
+      it "should faile to create resource if 'name' inputs is missing" do
+        expect {
+          subject.create inputs.except(:name)
+        }.to raise_error(Github::Error::RequiredParams)
+      end
+
+      it "should create resource" do
+        subject.create inputs
+        a_post(request_path).with(inputs).should have_been_made
+      end
+
+      it "should return the resource" do
+        repository = subject.create inputs
+        repository.name.should == 'Hello-World'
+      end
+
+      it "should return mash type" do
+        repository = subject.create inputs
+        repository.should be_a Github::ResponseWrapper
+      end
+    end
+
+    context "for the authenticated user belonging to organization" do
+      let(:request_path) { "/orgs/#{org}/repos?access_token=#{OAUTH_TOKEN}" }
+      let(:org) { '37signals' }
+
+      it "should get the resource" do
+        subject.create inputs.merge(:org => org)
+        a_post(request_path).with(inputs).should have_been_made
+      end
+    end
+  end
+
+  context "failed to create" do
+    let(:request_path) { "/user/repos?access_token=#{OAUTH_TOKEN}" }
+    let(:body)   { '' }
+    let(:status) { 404 }
+
+    it "should faile to retrieve resource" do
+      expect {
+        subject.create inputs
+      }.to raise_error(Github::Error::NotFound)
+    end
+  end
+end # create