github_api 0.4.11 → 0.5.0.rc1

data/spec/github/request_spec.rb

@@ -2,6 +2,35 @@
 
 require 'spec_helper'
 
+
 describe Github::Request do
-  pending
-end
+  let(:github) { Github::API.new  }
+  let(:path) { 'github.api/repos/users' }
+  let(:params) { {} }
+  let(:options) { {} }
+
+  it "knows how to make get request" do
+    github.should_receive(:request).with(:get, path, params, options)
+    github.get_request path, params, options
+  end
+
+  it "knows how to make patch request" do
+    github.should_receive(:request).with(:patch, path, params, options)
+    github.patch_request path, params, options
+  end
+
+  it "knows how to make post request" do
+    github.should_receive(:request).with(:post, path, params, options)
+    github.post_request path, params, options
+  end
+
+  it "knows how to make put request" do
+    github.should_receive(:request).with(:put, path, params, options)
+    github.put_request path, params, options
+  end
+
+  it "knows how to make delete request" do
+    github.should_receive(:request).with(:delete, path, params, options)
+    github.delete_request path, params, options
+  end
+end # Github::Request

data/spec/github/users/emails_spec.rb

@@ -7,7 +7,9 @@ describe Github::Users::Emails do
   before { github.oauth_token = OAUTH_TOKEN }
   after { reset_authentication_for github }
 
-  describe "#emails" do
+  describe "#list" do
+    it { github.users.emails.should respond_to :all }
+
     context "resource found for an authenticated user" do
       before do
         stub_get("/user/emails").
@@ -18,26 +20,26 @@ describe Github::Users::Emails do
       end
 
       it "should get the resources" do
-        github.users.emails
+        github.users.emails.list
         a_get("/user/emails").
           with(:query => { :access_token => "#{OAUTH_TOKEN}"}).
           should have_been_made
       end
 
       it "should return resource" do
-        emails = github.users.emails
+        emails = github.users.emails.list
         emails.should be_an Array
         emails.should have(2).items
       end
 
       it "should get emails information" do
-        emails = github.users.emails
+        emails = github.users.emails.list
         emails.first.should == email
       end
 
       it "should yield to a block" do
-        github.users.should_receive(:emails).and_yield('web')
-        github.users.emails { |param| 'web' }
+        github.users.emails.should_receive(:list).and_yield('web')
+        github.users.emails.list { |param| 'web' }
       end
     end
 
@@ -50,13 +52,13 @@ describe Github::Users::Emails do
 
       it "should return 404 with a message 'Not Found'" do
         expect {
-          github.users.emails
+          github.users.emails.list
         }.to raise_error(Github::Error::NotFound)
       end
     end
   end # emails
 
-  context '#add_email' do
+  context '#add' do
     let(:params) { { :per_page => 21, :page => 1 }}
 
     before do
@@ -68,20 +70,20 @@ describe Github::Users::Emails do
     end
 
     it 'extracts request parameters and email data' do
-      github.users.should_receive(:post).
+      github.users.emails.should_receive(:post_request).
         with("/user/emails", { "per_page" => 21, "page" => 1, "data" => [email] })
-      github.users.add_email email, params
+      github.users.emails.add email, params
     end
 
     it 'submits request successfully' do
-      github.users.add_email email
+      github.users.emails.add email
       a_post("/user/emails").
         with(:query => { :access_token => "#{OAUTH_TOKEN}"}).
         should have_been_made
     end
-  end # add_email
+  end # add
 
-  context '#delete_email' do
+  context '#delete' do
     let(:params) { { :per_page => 21, :page => 1 }}
 
     before do
@@ -93,17 +95,17 @@ describe Github::Users::Emails do
     end
 
     it 'extracts request parameters and email data' do
-      github.users.should_receive(:delete).
+      github.users.emails.should_receive(:delete_request).
         with("/user/emails", { "per_page" => 21, "page" => 1, "data" => [email] })
-      github.users.delete_email email, params
+      github.users.emails.delete email, params
     end
 
     it 'submits request successfully' do
-      github.users.delete_email email
+      github.users.emails.delete email
       a_delete("/user/emails").
         with(:query => { :access_token => "#{OAUTH_TOKEN}", :data => email } ).
         should have_been_made
     end
-  end # delete_email
+  end # delete
 
 end # Github::Users::Emails

data/spec/github/users/followers_spec.rb

@@ -8,7 +8,9 @@ describe Github::Users::Followers do
 
   after { reset_authentication_for github }
 
-  describe "#followers" do
+  describe "#list" do
+    it { github.users.followers.should respond_to :all }
+
     context "resource found for a user" do
       before do
         stub_get("/users/#{user}/followers").
@@ -18,29 +20,29 @@ describe Github::Users::Followers do
       end
 
       it "should get the resources" do
-        github.users.followers user
+        github.users.followers.list user
         a_get("/users/#{user}/followers").should have_been_made
       end
 
       it "should return resource" do
-        followers = github.users.followers user
+        followers = github.users.followers.list user
         followers.should be_an Array
         followers.should have(1).items
       end
 
       it "should be a mash type" do
-        followers = github.users.followers user
+        followers = github.users.followers.list user
         followers.first.should be_a Hashie::Mash
       end
 
       it "should get followers information" do
-        followers = github.users.followers user
+        followers = github.users.followers.list user
         followers.first.login.should == 'octocat'
       end
 
       it "should yield to a block" do
-        github.users.should_receive(:followers).with(user).and_yield('web')
-        github.users.followers(user) { |param| 'web' }
+        github.users.followers.should_receive(:list).with(user).and_yield('web')
+        github.users.followers.list(user) { |param| 'web' }
       end
     end
 
@@ -55,7 +57,7 @@ describe Github::Users::Followers do
       end
 
       it "should get the resources" do
-        github.users.followers
+        github.users.followers.list
         a_get("/user/followers").
           with(:query => { :access_token => "#{OAUTH_TOKEN}"}).
           should have_been_made
@@ -70,11 +72,11 @@ describe Github::Users::Followers do
 
       it "should return 404 with a message 'Not Found'" do
         expect {
-          github.users.followers user
+          github.users.followers.list user
         }.to raise_error(Github::Error::NotFound)
       end
     end
-  end # followers
+  end # list
 
   describe "#following" do
     context "resource found for a user" do
@@ -86,29 +88,29 @@ describe Github::Users::Followers do
       end
 
       it "should get the resources" do
-        github.users.following user
+        github.users.followers.following user
         a_get("/users/#{user}/following").should have_been_made
       end
 
       it "should return resource" do
-        followings = github.users.following user
+        followings = github.users.followers.following user
         followings.should be_an Array
         followings.should have(1).items
       end
 
       it "should be a mash type" do
-        followings = github.users.following user
+        followings = github.users.followers.following user
         followings.first.should be_a Hashie::Mash
       end
 
       it "should get following users information" do
-        followings = github.users.following user
+        followings = github.users.followers.following user
         followings.first.login.should == 'octocat'
       end
 
       it "should yield to a block" do
-        github.users.should_receive(:following).with(user).and_yield('web')
-        github.users.following(user) { |param| 'web' }
+        github.users.followers.should_receive(:following).with(user).and_yield('web')
+        github.users.followers.following(user) { |param| 'web' }
       end
     end
 
@@ -123,7 +125,7 @@ describe Github::Users::Followers do
       end
 
       it "should get the resources" do
-        github.users.following
+        github.users.followers.following
         a_get("/user/following").
           with(:query => { :access_token => "#{OAUTH_TOKEN}"}).
           should have_been_made
@@ -138,7 +140,7 @@ describe Github::Users::Followers do
 
       it "should return 404 with a message 'Not Found'" do
         expect {
-          github.users.following user
+          github.users.followers.following user
         }.to raise_error(Github::Error::NotFound)
       end
     end
@@ -156,19 +158,19 @@ describe Github::Users::Followers do
 
     it 'should raise error if username not present' do
       expect {
-        github.users.following? nil
+        github.users.followers.following? nil
       }.to raise_error(ArgumentError)
     end
 
     it 'should perform request' do
-      github.users.following?(user)
+      github.users.followers.following?(user)
       a_get("/user/following/#{user}").
         with(:query => { :access_token => "#{OAUTH_TOKEN}"}).
         should have_been_made
     end
 
     it 'should return true if user is being followed' do
-      github.users.following?(user).should be_true
+      github.users.followers.following?(user).should be_true
     end
 
     it 'should return false if user is not being followed' do
@@ -177,7 +179,7 @@ describe Github::Users::Followers do
         to_return(:body => '',
               :status => 404,
               :headers => {:content_type => "application/json; charset=utf-8"})
-      github.users.following?(user).should be_false
+      github.users.followers.following?(user).should be_false
     end
   end # following?
 
@@ -193,19 +195,19 @@ describe Github::Users::Followers do
 
     it "should raise error if gist id not present" do
       expect {
-        github.users.follow nil
+        github.users.followers.follow nil
       }.to raise_error(ArgumentError)
     end
 
     it 'successfully unfollows a user' do
-      github.users.follow(user)
+      github.users.followers.follow(user)
       a_put("/user/following/#{user}").
         with(:query => { :access_token => "#{OAUTH_TOKEN}"}).
         should have_been_made
     end
 
     it "should return 204 with a message 'Not Found'" do
-      github.users.follow(user).status.should be 204
+      github.users.followers.follow(user).status.should be 204
     end
   end # follow
 
@@ -221,19 +223,19 @@ describe Github::Users::Followers do
 
     it "should raise error if gist id not present" do
       expect {
-        github.users.unfollow nil
+        github.users.followers.unfollow nil
       }.to raise_error(ArgumentError)
     end
 
     it 'successfully unfollows a user' do
-      github.users.unfollow(user)
+      github.users.followers.unfollow(user)
       a_delete("/user/following/#{user}").
         with(:query => { :access_token => "#{OAUTH_TOKEN}"}).
         should have_been_made
     end
 
     it "should return 204 with a message 'Not Found'" do
-      github.users.unfollow(user).status.should be 204
+      github.users.followers.unfollow(user).status.should be 204
     end
   end # unfollow
 

data/spec/github/users/keys_spec.rb

@@ -7,7 +7,9 @@ describe Github::Users::Keys do
   before { github.oauth_token = OAUTH_TOKEN }
   after { reset_authentication_for github }
 
-  describe "#keys" do
+  describe "#list" do
+    it { github.users.keys.should respond_to :all }
+
     context "resource found for an authenticated user" do
       before do
         stub_get("/user/keys").
@@ -18,26 +20,26 @@ describe Github::Users::Keys do
       end
 
       it "should get the resources" do
-        github.users.keys
+        github.users.keys.list
         a_get("/user/keys").
           with(:query => { :access_token => "#{OAUTH_TOKEN}"}).
           should have_been_made
       end
 
       it "should return resource" do
-        keys = github.users.keys
+        keys = github.users.keys.list
         keys.should be_an Array
         keys.should have(1).item
       end
 
       it "should get keys information" do
-        keys = github.users.keys
+        keys = github.users.keys.list
         keys.first.id.should == key_id
       end
 
       it "should yield to a block" do
-        github.users.should_receive(:keys).and_yield('web')
-        github.users.keys { |param| 'web' }
+        github.users.keys.should_receive(:list).and_yield('web')
+        github.users.keys.list { |param| 'web' }
       end
     end
 
@@ -50,13 +52,15 @@ describe Github::Users::Keys do
 
       it "should return 404 with a message 'Not Found'" do
         expect {
-          github.users.keys
+          github.users.keys.list
         }.to raise_error(Github::Error::NotFound)
       end
     end
-  end # keys
+  end # list
+
+  describe "#get" do
+    it { github.users.keys.should respond_to :find }
 
-  describe "#key" do
     context "resource found for an authenticated user" do
       before do
         stub_get("/user/keys/#{key_id}").
@@ -67,24 +71,24 @@ describe Github::Users::Keys do
       end
 
       it "should fail to get resource without key id" do
-        expect { github.users.key nil }.to raise_error(ArgumentError)
+        expect { github.users.keys.get nil }.to raise_error(ArgumentError)
       end
 
       it "should get the resource" do
-        github.users.key key_id
+        github.users.keys.get key_id
         a_get("/user/keys/#{key_id}").
           with(:query => { :access_token => "#{OAUTH_TOKEN}"}).
           should have_been_made
       end
 
       it "should get public key information" do
-        key = github.users.key key_id
+        key = github.users.keys.get key_id
         key.id.should == key_id
         key.title.should == 'octocat@octomac'
       end
 
       it "should return mash" do
-        key = github.users.key key_id
+        key = github.users.keys.get key_id
         key.should be_a Hashie::Mash
       end
     end
@@ -100,13 +104,13 @@ describe Github::Users::Keys do
 
       it "should fail to retrive resource" do
         expect {
-          github.users.key key_id
+          github.users.keys.get key_id
         }.to raise_error(Github::Error::NotFound)
       end
     end
-  end # key
+  end # get
 
-  describe "create_key" do
+  describe "#create" do
     let(:inputs) {
       {
         :title => "octocat@octomac",
@@ -125,18 +129,18 @@ describe Github::Users::Keys do
       end
 
       it "should create resource successfully" do
-        github.users.create_key inputs
+        github.users.keys.create inputs
         a_post("/user/keys?access_token=#{OAUTH_TOKEN}").
           with(inputs).should have_been_made
       end
 
       it "should return the resource" do
-        key = github.users.create_key inputs
+        key = github.users.keys.create inputs
         key.should be_a Hashie::Mash
       end
 
       it "should get the key information" do
-        key = github.users.create_key inputs
+        key = github.users.keys.create inputs
         key.title.should == 'octocat@octomac'
       end
     end
@@ -151,13 +155,13 @@ describe Github::Users::Keys do
 
       it "should fail to retrieve resource" do
         expect {
-          github.users.create_key inputs
+          github.users.keys.create inputs
         }.to raise_error(Github::Error::NotFound)
       end
     end
-  end # create_key
+  end # create
 
-  describe "#update_key" do
+  describe "#update" do
     let(:inputs) {
       {
         :title => "octocat@octomac",
@@ -176,22 +180,22 @@ describe Github::Users::Keys do
       end
 
       it "should fail to get resource without key id" do
-        expect { github.users.update_key nil }.to raise_error(ArgumentError)
+        expect { github.users.keys.update nil }.to raise_error(ArgumentError)
       end
 
       it "should create resource successfully" do
-        github.users.update_key key_id, inputs
+        github.users.keys.update key_id, inputs
         a_patch("/user/keys/#{key_id}?access_token=#{OAUTH_TOKEN}").
           with(inputs).should have_been_made
       end
 
       it "should return the resource" do
-        key = github.users.update_key key_id, inputs
+        key = github.users.keys.update key_id, inputs
         key.should be_a Hashie::Mash
       end
 
       it "should get the key information" do
-        key = github.users.update_key key_id, inputs
+        key = github.users.keys.update key_id, inputs
         key.title.should == 'octocat@octomac'
       end
     end
@@ -207,13 +211,13 @@ describe Github::Users::Keys do
 
       it "should fail to retrieve resource" do
         expect {
-          github.users.update_key key_id, inputs
+          github.users.keys.update key_id, inputs
         }.to raise_error(Github::Error::NotFound)
       end
     end
-  end # update_key
+  end # update
 
-  describe "#delete_key" do
+  describe "#delete" do
     context "resouce deleted" do
       before do
         stub_delete("/user/keys/#{key_id}?access_token=#{OAUTH_TOKEN}").
@@ -223,11 +227,11 @@ describe Github::Users::Keys do
       end
 
       it "should fail to get resource without key id" do
-        expect { github.users.delete_key nil }.to raise_error(ArgumentError)
+        expect { github.users.keys.delete nil }.to raise_error(ArgumentError)
       end
 
       it "should create resource successfully" do
-        github.users.delete_key key_id
+        github.users.keys.delete key_id
         a_delete("/user/keys/#{key_id}?access_token=#{OAUTH_TOKEN}").
           should have_been_made
       end
@@ -243,10 +247,10 @@ describe Github::Users::Keys do
 
       it "should fail to delete resource" do
         expect {
-          github.users.delete_key key_id
+          github.users.keys.delete key_id
         }.to raise_error(Github::Error::NotFound)
       end
     end
-  end # delete_key
+  end # delete
 
 end # Github::Users::Keys