github_api 0.4.11 → 0.5.0.rc1

data/spec/github/issues/milestones_spec.rb

@@ -7,50 +7,53 @@ describe Github::Issues::Milestones do
   let(:user)   { 'peter-murach' }
   let(:repo)   { 'github' }
 
-  after { github.user, github.repo, github.oauth_token = nil, nil, nil }
+  after { reset_authentication_for github }
 
   it { described_class::VALID_MILESTONE_OPTIONS.should_not be_nil }
   it { described_class::VALID_MILESTONE_INPUTS.should_not be_nil }
 
-  describe 'milestones' do
-    it { github.issues.should respond_to :milestones }
-    it { github.issues.should respond_to :list_milestones }
+  describe '#list' do
+    it { github.issues.milestones.should respond_to :all }
 
     context "resource found" do
       before do
         stub_get("/repos/#{user}/#{repo}/milestones").
-          to_return(:body => fixture('issues/milestones.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+          to_return(:body => fixture('issues/milestones.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.issues.milestones nil, repo }.to raise_error(ArgumentError)
+        expect {
+          github.issues.milestones.list nil, repo
+        }.to raise_error(ArgumentError)
       end
 
       it "should get the resources" do
-        github.issues.milestones user, repo
+        github.issues.milestones.list user, repo
         a_get("/repos/#{user}/#{repo}/milestones").should have_been_made
       end
 
       it "should return array of resources" do
-        milestones = github.issues.milestones user, repo
+        milestones = github.issues.milestones.list user, repo
         milestones.should be_an Array
         milestones.should have(1).items
       end
 
       it "should be a mash type" do
-        milestones = github.issues.milestones user, repo
+        milestones = github.issues.milestones.list user, repo
         milestones.first.should be_a Hashie::Mash
       end
 
       it "should get issue information" do
-        milestones = github.issues.milestones user, repo
+        milestones = github.issues.milestones.list user, repo
         milestones.first.title.should == 'v1.0'
       end
 
       it "should yield to a block" do
-        github.issues.should_receive(:milestones).with(user, repo).and_yield('web')
-        github.issues.milestones(user, repo) { |param| 'web' }.should == 'web'
+        github.issues.milestones.should_receive(:list).
+          with(user, repo).and_yield('web')
+        github.issues.milestones.list(user, repo) { |param| 'web' }.should == 'web'
       end
     end
 
@@ -62,41 +65,44 @@ describe Github::Issues::Milestones do
 
       it "should return 404 with a message 'Not Found'" do
         expect {
-          github.issues.milestones user, repo
+          github.issues.milestones.list user, repo
         }.to raise_error(Github::Error::NotFound)
       end
     end
-  end # milestones
+  end # list
 
-  describe "milestone" do
+  describe "#get" do
     let(:milestone_id) { 1 }
 
-    it { github.issues.should respond_to :milestone }
-    it { github.issues.should respond_to :get_milestone }
+    it { github.issues.milestones.should respond_to :find }
 
     context "resource found" do
       before do
         stub_get("/repos/#{user}/#{repo}/milestones/#{milestone_id}").
-          to_return(:body => fixture('issues/milestone.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+          to_return(:body => fixture('issues/milestone.json'),
+            :status => 200,
+            :headers => {:content_type => "application/json; charset=utf-8"})
       end
 
       it "should fail to get resource without milestone id" do
-        expect { github.issues.milestone(user, repo, nil)}.to raise_error(ArgumentError)
+        expect {
+          github.issues.milestones.get user, repo, nil
+        }.to raise_error(ArgumentError)
       end
 
       it "should get the resource" do
-        github.issues.milestone user, repo, milestone_id
+        github.issues.milestones.get user, repo, milestone_id
         a_get("/repos/#{user}/#{repo}/milestones/#{milestone_id}").should have_been_made
       end
 
       it "should get milestone information" do
-        milestone = github.issues.milestone user, repo, milestone_id
+        milestone = github.issues.milestones.get user, repo, milestone_id
         milestone.number.should == milestone_id
         milestone.title.should == 'v1.0'
       end
 
       it "should return mash" do
-        milestone = github.issues.milestone user, repo, milestone_id
+        milestone = github.issues.milestones.get user, repo, milestone_id
         milestone.should be_a Hashie::Mash
       end
     end
@@ -104,16 +110,18 @@ describe Github::Issues::Milestones do
     context "resource not found" do
       before do
         stub_get("/repos/#{user}/#{repo}/milestones/#{milestone_id}").
-          to_return(:body => fixture('issues/milestone.json'), :status => 404, :headers => {:content_type => "application/json; charset=utf-8"})
+          to_return(:body => fixture('issues/milestone.json'),
+            :status => 404,
+            :headers => {:content_type => "application/json; charset=utf-8"})
       end
 
       it "should fail to retrive resource" do
         expect {
-          github.issues.milestone user, repo, milestone_id
+          github.issues.milestones.get user, repo, milestone_id
         }.to raise_error(Github::Error::NotFound)
       end
     end
-  end # milestone
+  end # get
 
   describe "create_milestone" do
     let(:inputs) {
@@ -128,27 +136,29 @@ describe Github::Issues::Milestones do
     context "resouce created" do
       before do
         stub_post("/repos/#{user}/#{repo}/milestones").with(inputs).
-          to_return(:body => fixture('issues/milestone.json'), :status => 201, :headers => {:content_type => "application/json; charset=utf-8"})
+          to_return(:body => fixture('issues/milestone.json'),
+            :status => 201,
+            :headers => {:content_type => "application/json; charset=utf-8"})
       end
 
       it "should fail to create resource if 'title' input is missing" do
         expect {
-          github.issues.create_milestone user, repo, inputs.except('title')
+          github.issues.milestones.create user, repo, inputs.except('title')
         }.to raise_error(Github::Error::RequiredParams)
       end
 
       it "should create resource successfully" do
-        github.issues.create_milestone user, repo, inputs
+        github.issues.milestones.create user, repo, inputs
         a_post("/repos/#{user}/#{repo}/milestones").with(inputs).should have_been_made
       end
 
       it "should return the resource" do
-        milestone = github.issues.create_milestone user, repo, inputs
+        milestone = github.issues.milestones.create user, repo, inputs
         milestone.should be_a Hashie::Mash
       end
 
       it "should get the milestone information" do
-        milestone = github.issues.create_milestone user, repo, inputs
+        milestone = github.issues.milestones.create user, repo, inputs
         milestone.title.should == 'v1.0'
       end
     end
@@ -156,19 +166,21 @@ describe Github::Issues::Milestones do
     context "failed to create resource" do
       before do
         stub_post("/repos/#{user}/#{repo}/milestones").with(inputs).
-          to_return(:body => fixture('issues/milestone.json'), :status => 404, :headers => {:content_type => "application/json; charset=utf-8"})
+          to_return(:body => fixture('issues/milestone.json'),
+            :status => 404,
+            :headers => {:content_type => "application/json; charset=utf-8"})
 
       end
 
       it "should faile to retrieve resource" do
         expect {
-          github.issues.create_milestone user, repo, inputs
+          github.issues.milestones.create user, repo, inputs
         }.to raise_error(Github::Error::NotFound)
       end
     end
-  end # create_milestone
+  end # create
 
-  describe "update_milestone" do
+  describe "#update" do
     let(:milestone_id) { 1 }
     let(:inputs) {
       {
@@ -181,68 +193,76 @@ describe Github::Issues::Milestones do
 
     context "resouce updated" do
       before do
-        stub_patch("/repos/#{user}/#{repo}/milestones/#{milestone_id}").with(inputs).
+        stub_patch("/repos/#{user}/#{repo}/milestones/#{milestone_id}").
+          with(inputs).
           to_return(:body => fixture('issues/milestone.json'), :status => 201, :headers => {:content_type => "application/json; charset=utf-8"})
       end
 
       it "should fail to create resource if 'title' input is missing" do
         expect {
-          github.issues.update_milestone user, repo, milestone_id, inputs.except('title')
+          github.issues.milestones.update user, repo, milestone_id, inputs.except('title')
         }.to raise_error(Github::Error::RequiredParams)
       end
 
       it "should update resource successfully" do
-        github.issues.update_milestone user, repo, milestone_id, inputs
-        a_patch("/repos/#{user}/#{repo}/milestones/#{milestone_id}").with(inputs).should have_been_made
+        github.issues.milestones.update user, repo, milestone_id, inputs
+        a_patch("/repos/#{user}/#{repo}/milestones/#{milestone_id}").
+          with(inputs).should have_been_made
       end
 
       it "should return the resource" do
-        milestone = github.issues.update_milestone user, repo, milestone_id, inputs
+        milestone = github.issues.milestones.update user, repo, milestone_id, inputs
         milestone.should be_a Hashie::Mash
       end
 
       it "should get the milestone information" do
-        milestone = github.issues.update_milestone user, repo, milestone_id, inputs
+        milestone = github.issues.milestones.update user, repo, milestone_id, inputs
         milestone.title.should == 'v1.0'
       end
     end
 
     context "failed to create resource" do
       before do
-        stub_patch("/repos/#{user}/#{repo}/milestones/#{milestone_id}").with(inputs).
-          to_return(:body => fixture('issues/milestone.json'), :status => 404, :headers => {:content_type => "application/json; charset=utf-8"})
+        stub_patch("/repos/#{user}/#{repo}/milestones/#{milestone_id}").
+          with(inputs).
+          to_return(:body => fixture('issues/milestone.json'),
+            :status => 404,
+            :headers => {:content_type => "application/json; charset=utf-8"})
 
       end
 
       it "should faile to retrieve resource" do
         expect {
-          github.issues.update_milestone user, repo, milestone_id, inputs
+          github.issues.milestones.update user, repo, milestone_id, inputs
         }.to raise_error(Github::Error::NotFound)
       end
     end
-  end # update_milestone
+  end # update
 
-  describe "delete_milestone" do
+  describe "#delete" do
     let(:milestone_id) { 1 }
 
     context "resouce removed" do
       before do
         stub_delete("/repos/#{user}/#{repo}/milestones/#{milestone_id}").
-          to_return(:body => fixture('issues/milestone.json'), :status => 201, :headers => {:content_type => "application/json; charset=utf-8"})
+          to_return(:body => fixture('issues/milestone.json'),
+            :status => 201,
+            :headers => {:content_type => "application/json; charset=utf-8"})
       end
 
       it "should remove resource successfully" do
-        github.issues.delete_milestone user, repo, milestone_id
-        a_delete("/repos/#{user}/#{repo}/milestones/#{milestone_id}").should have_been_made
+        github.issues.milestones.delete user, repo, milestone_id
+        a_delete("/repos/#{user}/#{repo}/milestones/#{milestone_id}").
+          should have_been_made
       end
 
       it "should return the resource" do
-        milestone = github.issues.delete_milestone user, repo, milestone_id
+        milestone = github.issues.milestones.delete user, repo, milestone_id
         milestone.should be_a Hashie::Mash
       end
 
       it "should get the milestone information" do
-        milestone = github.issues.delete_milestone user, repo, milestone_id
+        milestone = github.issues.milestones.delete user, repo, milestone_id
         milestone.title.should == 'v1.0'
       end
     end
@@ -250,15 +270,17 @@ describe Github::Issues::Milestones do
     context "failed to remove resource" do
       before do
         stub_delete("/repos/#{user}/#{repo}/milestones/#{milestone_id}").
-          to_return(:body => fixture('issues/milestone.json'), :status => 404, :headers => {:content_type => "application/json; charset=utf-8"})
+          to_return(:body => fixture('issues/milestone.json'),
+            :status => 404,
+            :headers => {:content_type => "application/json; charset=utf-8"})
       end
 
       it "should faile to retrieve resource" do
         expect {
-          github.issues.delete_milestone user, repo, milestone_id
+          github.issues.milestones.delete user, repo, milestone_id
         }.to raise_error(Github::Error::NotFound)
       end
     end
-  end # delete_milestone
+  end # delete
 
 end # Github::Issues::Milestones

data/spec/github/issues_spec.rb

@@ -7,19 +7,19 @@ describe Github::Issues do
   let(:github) { Github.new }
   let(:user)   { 'peter-murach' }
   let(:repo)   { 'github' }
+  let(:issue_id) { 1347 }
 
-  after { github.user, github.repo, github.oauth_token = nil, nil, nil }
+  after { reset_authentication_for github }
 
-  describe 'modules inclusion' do
-    it { issues_api.included_modules.should include Github::Issues::Comments }
-    it { issues_api.included_modules.should include Github::Issues::Events }
-    it { issues_api.included_modules.should include Github::Issues::Labels }
-    it { issues_api.included_modules.should include Github::Issues::Milestones }
+  context 'access to apis' do
+    it { subject.comments.should be_a Github::Issues::Comments }
+    it { subject.events.should be_a Github::Issues::Events }
+    it { subject.labels.should be_a Github::Issues::Labels }
+    it { subject.milestones.should be_a Github::Issues::Milestones }
   end
 
-  describe 'issues' do
-    it { github.issues.should respond_to :issues }
-    it { github.issues.should respond_to :list_issues }
+  context '#list' do
+    it { github.issues.should respond_to(:all) }
 
     context "resource found" do
       before do
@@ -28,29 +28,29 @@ describe Github::Issues do
       end
 
       it "should get the resources" do
-        github.issues.issues
+        github.issues.list
         a_get("/issues").should have_been_made
       end
 
       it "should return array of resources" do
-        issues = github.issues.issues
+        issues = github.issues.list
         issues.should be_an Array
         issues.should have(1).items
       end
 
       it "should be a mash type" do
-        issues = github.issues.issues
+        issues = github.issues.list
         issues.first.should be_a Hashie::Mash
       end
 
       it "should get issue information" do
-        issues = github.issues.issues
+        issues = github.issues.list
         issues.first.title.should == 'Found a bug'
       end
 
       it "should yield to a block" do
-        github.issues.should_receive(:issues).and_yield('web')
-        github.issues.issues { |param| 'web' }.should == 'web'
+        github.issues.should_receive(:list).and_yield('web')
+        github.issues.list { |param| 'web' }.should == 'web'
       end
     end
 
@@ -61,53 +61,50 @@ describe Github::Issues do
       end
 
       it "should return 404 with a message 'Not Found'" do
-        expect { github.issues.issues }.to raise_error(Github::Error::NotFound)
+        expect { github.issues.list }.to raise_error(Github::Error::NotFound)
       end
     end
-  end # issues
+  end # list
 
-  describe 'repo_issues' do
-    it { github.issues.should respond_to :repo_issues }
-    it { github.issues.should respond_to :list_repo_issues }
-    it { github.issues.should respond_to :list_repository_issues }
+  describe '#list_repo' do
+    it { github.issues.should respond_to :list_repository }
 
     context "resource found" do
       before do
-        github.user, github.repo = nil, nil
         stub_get("/repos/#{user}/#{repo}/issues").
           to_return(:body => fixture('issues/issues.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
       end
 
       it "should raise error if user-name empty" do
         expect {
-          github.issues.repo_issues nil, repo
+          github.issues.list_repo nil, repo
         }.should raise_error(ArgumentError)
       end
 
       it "should get the resources" do
-        github.issues.repo_issues user, repo
+        github.issues.list_repo user, repo
         a_get("/repos/#{user}/#{repo}/issues").should have_been_made
       end
 
       it "should return array of resources" do
-        repo_issues = github.issues.repo_issues user, repo
+        repo_issues = github.issues.list_repo user, repo
         repo_issues.should be_an Array
         repo_issues.should have(1).items
       end
 
       it "should be a mash type" do
-        repo_issues = github.issues.repo_issues user, repo
+        repo_issues = github.issues.list_repo user, repo
         repo_issues.first.should be_a Hashie::Mash
       end
 
       it "should get repository issue information" do
-        repo_issues = github.issues.repo_issues user, repo
+        repo_issues = github.issues.list_repo user, repo
         repo_issues.first.title.should == 'Found a bug'
       end
 
       it "should yield to a block" do
-        github.issues.should_receive(:issues).with(user, repo).and_yield('web')
-        github.issues.issues(user, repo) { |param| 'web' }.should == 'web'
+        github.issues.should_receive(:list_repo).with(user, repo).and_yield('web')
+        github.issues.list_repo(user, repo) { |param| 'web' }.should == 'web'
       end
     end
 
@@ -119,41 +116,39 @@ describe Github::Issues do
 
       it "should return 404 with a message 'Not Found'" do
         expect {
-          github.issues.repo_issues user, repo
+          github.issues.list_repo user, repo
         }.to raise_error(Github::Error::NotFound)
       end
     end
-  end # repo_issues
+  end # list_repo
 
-  describe "get_issue" do
-    let(:issue_id) { 1347 }
-
-    it { github.issues.should respond_to :issue }
-    it { github.issues.should respond_to :get_issue }
+  describe "#find" do
 
     context "resource found" do
       before do
         stub_get("/repos/#{user}/#{repo}/issues/#{issue_id}").
-          to_return(:body => fixture('issues/issue.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+          to_return(:body => fixture('issues/issue.json'),
+          :status => 200,
+          :headers => {:content_type => "application/json; charset=utf-8"})
       end
 
       it "should fail to get resource without issue id" do
-        expect { github.issues.issue(user, repo, nil)}.to raise_error(ArgumentError)
+        expect { github.issues.find(user, repo, nil)}.to raise_error(ArgumentError)
       end
 
       it "should get the resource" do
-        github.issues.issue user, repo, issue_id
+        github.issues.find user, repo, issue_id
         a_get("/repos/#{user}/#{repo}/issues/#{issue_id}").should have_been_made
       end
 
       it "should get issue information" do
-        issue = github.issues.issue user, repo, issue_id
+        issue = github.issues.find user, repo, issue_id
         issue.number.should == issue_id
         issue.title.should == 'Found a bug'
       end
 
       it "should return mash" do
-        issue = github.issues.issue user, repo, issue_id
+        issue = github.issues.find user, repo, issue_id
         issue.should be_a Hashie::Mash
       end
     end
@@ -161,18 +156,20 @@ describe Github::Issues do
     context "resource not found" do
       before do
         stub_get("/repos/#{user}/#{repo}/issues/#{issue_id}").
-          to_return(:body => fixture('issues/issue.json'), :status => 404, :headers => {:content_type => "application/json; charset=utf-8"})
+          to_return(:body => fixture('issues/issue.json'),
+          :status => 404,
+          :headers => {:content_type => "application/json; charset=utf-8"})
       end
 
       it "should fail to retrive resource" do
         expect {
-          github.issues.issue user, repo, issue_id
+          github.issues.find user, repo, issue_id
         }.to raise_error(Github::Error::NotFound)
       end
     end
   end # get_issue
 
-  describe "create_issue" do
+  describe "#create" do
     let(:inputs) {
       {
          "title" =>  "Found a bug",
@@ -193,22 +190,22 @@ describe Github::Issues do
 
       it "should fail to create resource if 'title' input is missing" do
         expect {
-          github.issues.create_issue user, repo, inputs.except('title')
+          github.issues.create user, repo, inputs.except('title')
         }.to raise_error(Github::Error::RequiredParams)
       end
 
       it "should create resource successfully" do
-        github.issues.create_issue user, repo, inputs
+        github.issues.create user, repo, inputs
         a_post("/repos/#{user}/#{repo}/issues").with(inputs).should have_been_made
       end
 
       it "should return the resource" do
-        issue = github.issues.create_issue user, repo, inputs
+        issue = github.issues.create user, repo, inputs
         issue.should be_a Hashie::Mash
       end
 
       it "should get the issue information" do
-        issue = github.issues.create_issue(user, repo, inputs)
+        issue = github.issues.create(user, repo, inputs)
         issue.title.should == 'Found a bug'
       end
     end
@@ -221,14 +218,13 @@ describe Github::Issues do
 
       it "should faile to retrieve resource" do
         expect {
-          github.issues.create_issue user, repo, inputs
+          github.issues.create user, repo, inputs
         }.to raise_error(Github::Error::NotFound)
       end
     end
-  end # create_issue
+  end # create
 
-  describe "edit_issue" do
-    let(:issue_id) { 1349 }
+  describe "#edit" do
     let(:inputs) {
       {
          "title" =>  "Found a bug",
@@ -250,22 +246,22 @@ describe Github::Issues do
 
       it "should fail to edit without 'user/repo' parameters" do
         expect {
-          github.issues.edit_issue nil, repo, issue_id
+          github.issues.edit nil, repo, issue_id
         }.to raise_error(ArgumentError)
       end
 
       it "should edit the resource" do
-        github.issues.edit_issue user, repo, issue_id, inputs
+        github.issues.edit user, repo, issue_id, inputs
         a_patch("/repos/#{user}/#{repo}/issues/#{issue_id}").with(inputs).should have_been_made
       end
 
       it "should return resource" do
-        issue = github.issues.edit_issue user, repo, issue_id, inputs
+        issue = github.issues.edit user, repo, issue_id, inputs
         issue.should be_a Hashie::Mash
       end
 
       it "should be able to retrieve information" do
-        issue = github.issues.edit_issue user, repo, issue_id, inputs
+        issue = github.issues.edit user, repo, issue_id, inputs
         issue.title.should == 'Found a bug'
       end
     end
@@ -278,7 +274,7 @@ describe Github::Issues do
 
       it "should fail to find resource" do
         expect {
-          github.issues.edit_issue user, repo, issue_id, inputs
+          github.issues.edit user, repo, issue_id, inputs
         }.to raise_error(Github::Error::NotFound)
       end
     end