github_api 0.3.5 → 0.3.6

data/spec/github/repos/downloads_spec.rb

@@ -0,0 +1,247 @@
+require 'spec_helper'
+
+describe Github::Repos::Downloads do
+
+  let(:github) { Github.new }
+  let(:user)   { 'peter-murach' }
+  let(:repo)   { 'github' }
+
+  it { described_class::VALID_DOWNLOAD_PARAM_NAMES.should_not be_nil }
+  it { described_class::REQUIRED_PARAMS.should_not be_nil }
+  it { described_class::REQUIRED_S3_PARAMS.should_not be_nil }
+
+  describe "downloads" do
+    it { github.repos.should respond_to :downloads }
+    it { github.repos.should respond_to :list_downloads }
+    it { github.repos.should respond_to :get_downloads }
+
+    context "resource found" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/downloads").
+          to_return(:body => fixture('repos/downloads.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to get resource without username" do
+        github.user, github.repo = nil, nil
+        expect { github.repos.downloads }.to raise_error(ArgumentError)
+      end
+
+      it "should get the resources" do
+        github.repos.downloads  user, repo
+        a_get("/repos/#{user}/#{repo}/downloads").should have_been_made
+      end
+
+      it "should return array of resources" do
+        downloads = github.repos.downloads user, repo
+        downloads.should be_an Array
+        downloads.should have(1).items
+      end
+
+      it "should be a mash type" do
+        downloads = github.repos.downloads user, repo
+        downloads.first.should be_a Hashie::Mash
+      end
+
+      it "should get download information" do
+        downloads = github.repos.downloads user, repo
+        downloads.first.name.should == 'new_file.jpg'
+      end
+
+      it "should yield to a block" do
+        github.repos.should_receive(:downloads).with(user, repo).and_yield('web')
+        github.repos.downloads(user, repo) { |param| 'web' }
+      end
+    end
+
+    context "resource not found" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/downloads").
+          to_return(:body => "", :status => [404, "Not Found"])
+      end
+
+      it "should return 404 with a message 'Not Found'" do
+        expect {
+          github.repos.downloads user, repo
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end # downloads
+
+  describe "download" do
+    let(:download_id) { 1 }
+
+    it { github.repos.should respond_to :download }
+    it { github.repos.should respond_to :get_download }
+
+    context "resource found" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/downloads/#{download_id}").
+          to_return(:body => fixture('repos/download.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to get resource without download id" do
+        expect { github.repos.download(user, repo, nil)}.to raise_error(ArgumentError)
+      end
+
+      it "should get the resource" do
+        github.repos.download user, repo, download_id
+        a_get("/repos/#{user}/#{repo}/downloads/#{download_id}").should have_been_made
+      end
+
+      it "should get download information" do
+        download = github.repos.download user, repo, download_id
+        download.id.should == download_id
+        download.name.should == 'new_file.jpg'
+      end
+
+      it "should return mash" do
+        download = github.repos.download user, repo, download_id
+        download.should be_a Hashie::Mash
+      end
+    end
+
+    context "resource not found" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/downloads/#{download_id}").
+          to_return(:body => fixture('repos/download.json'), :status => 404, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to retrive resource" do
+        expect {
+          github.repos.download user, repo, download_id
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end # download
+
+  describe "delete_download" do
+    let(:download_id) { 1 }
+
+    context "resource edited successfully" do
+      before do
+        stub_delete("/repos/#{user}/#{repo}/downloads/#{download_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_download }.to raise_error(ArgumentError)
+      end
+
+      it "should fail to delete resource without 'download_id'" do
+        expect {
+          github.repos.delete_download user, repo
+        }.to raise_error(ArgumentError)
+      end
+
+      it "should delete the resource" do
+        github.repos.delete_download user, repo, download_id
+        a_delete("/repos/#{user}/#{repo}/downloads/#{download_id}").should have_been_made
+      end
+    end
+
+    context "failed to edit resource" do
+      before do
+        stub_delete("/repos/#{user}/#{repo}/downloads/#{download_id}").
+          to_return(:body => fixture("repos/download.json"), :status => 404, :headers => { :content_type => "application/json; charset=utf-8"})
+
+      end
+
+      it "should fail to find resource" do
+        expect {
+          github.repos.delete_download user, repo, download_id
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end # delete_download
+
+  describe "create_download" do
+    let(:inputs) { {:name => 'new_file.jpg', :size => 114034, :description => "Latest release", :content_type => 'text/plain'} }
+
+    context "resouce created" do
+      before do
+        stub_post("/repos/#{user}/#{repo}/downloads").with(inputs).
+          to_return(:body => fixture('repos/download_s3.json'), :status => 201, :headers => {:content_type => "application/json; charset=utf-8"})
+
+      end
+
+      it "should fail to create resource if 'name' input is missing" do
+        expect {
+          github.repos.create_download user, repo, inputs.except(:name)
+        }.to raise_error(ArgumentError)
+      end
+
+      it "should failt to create resource if 'size' input is missing" do
+        expect {
+          github.repos.create_download user, repo, inputs.except(:size)
+        }.to raise_error(ArgumentError)
+      end
+
+      it "should create resource successfully" do
+        github.repos.create_download user, repo, inputs
+        a_post("/repos/#{user}/#{repo}/downloads").with(inputs).should have_been_made
+      end
+
+      it "should return the resource" do
+        download = github.repos.create_download user, repo, inputs
+        download.should be_a Hashie::Mash
+      end
+
+      it "should get the download information" do
+        download = github.repos.create_download user, repo, inputs
+        download.name.should == 'new_file.jpg'
+      end
+    end
+
+    context "failed to create resource" do
+      before do
+        stub_post("/repos/#{user}/#{repo}/downloads").with(inputs).
+          to_return(:body => fixture('repos/download_s3.json'), :status => 404, :headers => {:content_type => "application/json; charset=utf-8"})
+
+      end
+
+      it "should faile to retrieve resource" do
+        expect {
+          github.repos.create_download(user, repo, inputs)
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end # create_download
+
+  describe 'upload' do
+    let(:inputs) { {:name => 'new_file.jpg', :size => 114034, :description => "Latest release", :content_type => 'text/plain'} }
+    let(:resource) { Hashie::Mash.new ::JSON.parse(fixture('repos/download_s3.json').read) }
+    let(:file)     { 'filename' }
+
+    context 'resource uploaded' do
+      before do
+        stub_post('', 'https://github.s3.amazonaws.com/').with(resource).
+          to_return(:body => '', :status => 200, :headers => {})
+      end
+
+      it "should fail if resource is of incorrect type" do
+        expect { github.repos.upload file, file }.to raise_error(ArgumentError)
+      end
+
+      it "should upload resource successfully" do
+        github.repos.upload resource, file
+        a_post('', 'https://github.s3.amazonaws.com').with(resource).should have_been_made
+      end
+
+    end
+    context 'failed to upload resource' do
+      before do
+        stub_post('', 'https://github.s3.amazonaws.com/').with(resource).
+          to_return(:body => '', :status => 404, :headers => {})
+      end
+
+      it "should faile to retrieve resource" do
+        expect {
+          github.repos.upload resource, file
+        }.to raise_error(Github::ResourceNotFound)
+      end
+
+    end
+  end # upload
+
+end # Github::Repos::Downloads

data/spec/github/repos/forks_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+describe Github::Repos::Forks do
+
+  let(:github) { Github.new }
+  let(:user)   { 'peter-murach' }
+  let(:repo)   { 'github' }
+
+  describe "forks" do
+
+    it { github.repos.should respond_to :forks }
+    it { github.repos.should respond_to :repo_forks }
+    it { github.repos.should respond_to :repository_forks }
+
+    context "resource found" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/forks").
+          to_return(:body => fixture('repos/forks.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to get resource without username" do
+        github.user, github.repo = nil, nil
+        expect { github.repos.forks }.to raise_error(ArgumentError)
+      end
+
+      it "should get the resources" do
+        github.repos.forks user, repo
+        a_get("/repos/#{user}/#{repo}/forks").should have_been_made
+      end
+
+      it "should return array of resources" do
+        forks = github.repos.forks user, repo
+        forks.should be_an Array
+        forks.should have(1).items
+      end
+
+      it "should be a mash type" do
+        forks = github.repos.forks user, repo
+        forks.first.should be_a Hashie::Mash
+      end
+
+      it "should get fork information" do
+        forks = github.repos.forks user, repo
+        forks.first.name.should == 'Hello-World'
+      end
+
+      it "should yield to a block" do
+        github.repos.should_receive(:forks).with(user, repo).and_yield('web')
+        github.repos.forks(user, repo) { |param| 'web' }
+      end
+    end
+
+    context "resource not found" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/forks").
+          to_return(:body => "", :status => [404, "Not Found"])
+      end
+
+      it "should return 404 with a message 'Not Found'" do
+        expect {
+          github.repos.forks user, repo
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end # forks
+
+  describe "create_hook" do
+    let(:inputs) { {:org => 'github'} }
+
+    context "resouce created" do
+      before do
+        stub_post("/repos/#{user}/#{repo}/forks").with(inputs).
+          to_return(:body => fixture('repos/fork.json'), :status => 201, :headers => {:content_type => "application/json; charset=utf-8"})
+
+      end
+
+      it "should create resource successfully" do
+        github.repos.create_fork(user, repo, inputs)
+        a_post("/repos/#{user}/#{repo}/forks").with(inputs).should have_been_made
+      end
+
+      it "should return the resource" do
+        fork = github.repos.create_fork user, repo, inputs
+        fork.should be_a Hashie::Mash
+      end
+
+      it "should get the fork information" do
+        fork = github.repos.create_fork(user, repo, inputs)
+        fork.name.should == 'Hello-World'
+      end
+    end
+
+    context "failed to create resource" do
+      before do
+        stub_post("/repos/#{user}/#{repo}/forks").with(inputs).
+          to_return(:body => fixture('repos/fork.json'), :status => 404, :headers => {:content_type => "application/json; charset=utf-8"})
+
+      end
+
+      it "should faile to retrieve resource" do
+        expect {
+          github.repos.create_fork user, repo, inputs
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end # create_fork
+
+end # Github::Repos::Forks

data/spec/github/repos/hooks_spec.rb

@@ -0,0 +1,333 @@
+require 'spec_helper'
+
+describe Github::Repos::Hooks do
+
+  let(:hooks_api) { Github::Repos::Hooks }
+  let(:github) { Github.new }
+  let(:user)   { 'peter-murach' }
+  let(:repo)   { 'github' }
+
+  it { hooks_api::VALID_HOOK_PARAM_NAMES.should_not be_nil }
+  it { hooks_api::VALID_HOOK_PARAM_VALUES.should_not be_nil }
+  it { hooks_api::REQUIRED_PARAMS.should_not be_nil }
+
+  describe "hooks" do
+    context 'check aliases' do
+      it { github.repos.should respond_to :hooks }
+      it { github.repos.should respond_to :repo_hooks }
+      it { github.repos.should respond_to :repository_hooks }
+    end
+
+    context "resource found" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/hooks").
+          to_return(:body => fixture('repos/hooks.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to get resource without username" do
+        github.user, github.repo = nil, nil
+        expect { github.repos.hooks }.to raise_error(ArgumentError)
+      end
+
+      it "should get the resources" do
+        github.repos.hooks user, repo
+        a_get("/repos/#{user}/#{repo}/hooks").should have_been_made
+      end
+
+      it "should return array of resources" do
+        hooks = github.repos.hooks user, repo
+        hooks.should be_an Array
+        hooks.should have(1).items
+      end
+
+      it "should be a mash type" do
+        hooks = github.repos.hooks user, repo
+        hooks.first.should be_a Hashie::Mash
+      end
+
+      it "should get hook information" do
+        hooks = github.repos.hooks user, repo
+        hooks.first.name.should == 'web'
+      end
+
+      it "should yield to a block" do
+        github.repos.should_receive(:hooks).with(user, repo).and_yield('web')
+        github.repos.hooks(user, repo) { |param| 'web' }
+      end
+    end
+
+    context "resource not found" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/hooks").
+          to_return(:body => "", :status => [404, "Not Found"])
+      end
+
+      it "should return 404 with a message 'Not Found'" do
+        expect {
+          github.repos.hooks user, repo
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end # hooks
+
+  describe "hook" do
+    let(:hook_id) { 1 }
+
+    context 'check aliases' do
+      it { github.repos.should respond_to :hook }
+      it { github.repos.should respond_to :get_hook }
+      it { github.repos.should respond_to :repo_hook }
+      it { github.repos.should respond_to :get_repo_hook }
+      it { github.repos.should respond_to :repository_hook }
+    end
+
+    context "resource found" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/hooks/#{hook_id}").
+          to_return(:body => fixture('repos/hook.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to get resource without hook id" do
+        expect { github.repos.hook(user, repo, nil)}.to raise_error(ArgumentError)
+      end
+
+      it "should get the resource" do
+        github.repos.hook user, repo, hook_id
+        a_get("/repos/#{user}/#{repo}/hooks/#{hook_id}").should have_been_made
+      end
+
+      it "should get hook information" do
+        hook = github.repos.hook user, repo, hook_id
+        hook.id.should == hook_id
+        hook.name.should == 'web'
+      end
+
+      it "should return mash" do
+        hook = github.repos.hook user, repo, hook_id
+        hook.should be_a Hashie::Mash
+      end
+    end
+
+    context "resource not found" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/hooks/#{hook_id}").
+          to_return(:body => fixture('repos/hook.json'), :status => 404, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to retrive resource" do
+        expect {
+          github.repos.hook user, repo, hook_id
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end # hook
+
+  describe "create_hook" do
+    let(:inputs) {
+      {
+        :name => 'web',
+        :config => { :url => "http://something.com/webhook" },
+        :active => true
+      }
+    }
+
+    context "resouce created" do
+      before do
+        stub_post("/repos/#{user}/#{repo}/hooks").with(inputs).
+          to_return(:body => fixture('repos/hook.json'), :status => 201, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to create resource if 'name' input is missing" do
+        expect {
+          github.repos.create_hook user, repo, inputs.except(:name)
+        }.to raise_error(ArgumentError)
+      end
+
+      it "should failt to create resource if 'config' input is missing" do
+        expect {
+          github.repos.create_hook user, repo, inputs.except(:config)
+        }.to raise_error(ArgumentError)
+      end
+
+      it "should create resource successfully" do
+        github.repos.create_hook user, repo, inputs
+        a_post("/repos/#{user}/#{repo}/hooks").with(inputs).should have_been_made
+      end
+
+      it "should return the resource" do
+        hook = github.repos.create_hook user, repo, inputs
+        hook.should be_a Hashie::Mash
+      end
+
+      it "should get the hook information" do
+        hook = github.repos.create_hook(user, repo, inputs)
+        hook.name.should == 'web'
+      end
+    end
+
+    context "fail to create resource" do
+      before do
+        stub_post("/repos/#{user}/#{repo}/hooks").with(inputs).
+          to_return(:body => fixture('repos/hook.json'), :status => 404, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to retrieve resource" do
+        expect {
+          github.repos.create_hook user, repo, inputs
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end # create_hook
+
+  describe "edit_hook" do
+    let(:hook_id) { 1 }
+    let(:inputs) {
+      {
+        :name => 'web',
+        :config => { :url => "http://something.com/webhook" },
+        :active => true
+      }
+    }
+
+    context "resource edited successfully" do
+      before do
+        stub_patch("/repos/#{user}/#{repo}/hooks/#{hook_id}").with(inputs).
+          to_return(:body => fixture("repos/hook.json"), :status => 200, :headers => { :content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to edit without 'user/repo' parameters" do
+        github.user, github.repo = nil, nil
+        expect { github.repos.edit_hook }.to raise_error(ArgumentError)
+      end
+
+      it "should fail to edit resource without 'name' parameter" do
+        expect{
+          github.repos.edit_hook user, repo, inputs.except(:name)
+        }.to raise_error(ArgumentError)
+      end
+
+      it "should fail to edit resource without 'hook_id'" do
+        expect {
+          github.repos.edit_hook user, repo
+        }.to raise_error(ArgumentError)
+      end
+
+      it "should fail to edit resource without 'config' parameter" do
+        expect {
+          github.repos.edit_hook user, repo, hook_id, inputs.except(:config)
+        }.to raise_error(ArgumentError)
+      end
+
+      it "should edit the resource" do
+        github.repos.edit_hook user, repo, hook_id, inputs
+        a_patch("/repos/#{user}/#{repo}/hooks/#{hook_id}").with(inputs).should have_been_made
+      end
+
+      it "should return resource" do
+        hook = github.repos.edit_hook user, repo, hook_id, inputs
+        hook.should be_a Hashie::Mash
+      end
+
+      it "should be able to retrieve information" do
+        hook = github.repos.edit_hook user, repo, hook_id, inputs
+        hook.name.should == 'web'
+      end
+
+    end
+
+    context "failed to edit resource" do
+      before do
+        stub_patch("/repos/#{user}/#{repo}/hooks/#{hook_id}").with(inputs).
+          to_return(:body => fixture("repos/hook.json"), :status => 404, :headers => { :content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to find resource" do
+        expect {
+          github.repos.edit_hook user, repo, hook_id, inputs
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end # edit_hook
+
+  describe "delete_hook" do
+    let(:hook_id) { 1 }
+
+    context "resource removed successfully" do
+      before do
+        stub_delete("/repos/#{user}/#{repo}/hooks/#{hook_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_hook }.to raise_error(ArgumentError)
+      end
+
+      it "should fail to delete resource without 'hook_id'" do
+        expect {
+          github.repos.delete_hook user, repo
+        }.to raise_error(ArgumentError)
+      end
+
+      it "should delete the resource" do
+        github.repos.delete_hook user, repo, hook_id
+        a_delete("/repos/#{user}/#{repo}/hooks/#{hook_id}").should have_been_made
+      end
+    end
+
+    context "failed to edit resource" do
+      before do
+        stub_delete("/repos/#{user}/#{repo}/hooks/#{hook_id}").
+          to_return(:body => fixture("repos/hook.json"), :status => 404, :headers => { :content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to find resource" do
+        expect {
+          github.repos.delete_hook user, repo, hook_id
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end # delete_hook
+
+  describe "test_hook" do
+    let(:hook_id) { 1 }
+
+    context "resource tested successfully" do
+      before do
+        stub_post("/repos/#{user}/#{repo}/hooks/#{hook_id}/test").
+          to_return(:body => '', :status => 204, :headers => { :content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to test without 'user/repo' parameters" do
+        github.user, github.repo = nil, nil
+        expect { github.repos.test_hook }.to raise_error(ArgumentError)
+      end
+
+      it "should fail to test resource without 'hook_id'" do
+        expect {
+          github.repos.test_hook user, repo
+        }.to raise_error(ArgumentError)
+      end
+
+      it "should trigger test for the resource" do
+        github.repos.test_hook user, repo, hook_id
+        a_post("/repos/#{user}/#{repo}/hooks/#{hook_id}/test").should have_been_made
+      end
+    end
+
+    context "failed to test resource" do
+      before do
+        stub_post("/repos/#{user}/#{repo}/hooks/#{hook_id}/test").
+          to_return(:body => '', :status => 404, :headers => { :content_type => "application/json; charset=utf-8"})
+
+      end
+
+      it "should fail to find resource" do
+        expect {
+          github.repos.test_hook user, repo, hook_id
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end # test_hook
+
+end # Github::Repos::Hooks