github_api 0.4.7 → 0.4.8

data/lib/github_api/api.rb

@@ -117,7 +117,7 @@ module Github
     # TODO add to core extensions
     def _extract_parameters(array)
       if array.last.is_a?(Hash) && array.last.instance_of?(Hash)
-        pop
+        array.pop
       else
         {}
       end

data/lib/github_api/repos/hooks.rb

@@ -42,7 +42,7 @@ module Github
       #  @github.repos.hooks 'user-name', 'repo-name'
       #  @github.repos.hooks 'user-name', 'repo-name' { |hook| ... }
       #
-      def hooks(user_name=nil, repo_name=nil, params={})
+      def hooks(user_name, repo_name, params={})
         _update_user_repo_params(user_name, repo_name)
         _validate_user_repo_params(user, repo) unless user? && repo?
         _normalize_params_keys(params)

data/lib/github_api/users/emails.rb

@@ -9,9 +9,13 @@ module Github
       # = Examples
       #  @github = Github.new :oauth_token => '...'
       #  @github.users.emails
+      #  @github.users.emails { |email| ... }
       #
       def emails(params={})
-        get("/user/emails", params)
+        _normalize_params_keys(params)
+        response = get("/user/emails", params)
+        return response unless block_given?
+        response.each { |el| yield el }
       end
 
       # Add email address(es) for the authenticated user
@@ -25,7 +29,8 @@ module Github
       #
       def add_email(*args)
         params = _extract_parameters(args)
-        params['data'] = [args].flatten
+        _normalize_params_keys(params)
+        params['data'] = [args].flatten if args
         post("/user/emails", params)
       end
 
@@ -38,8 +43,9 @@ module Github
       #  @github = Github.new :oauth_token => '...'
       #  @github.users.delete_email "octocat@github.com", "support@github.com"
       #
-      def add_email(*args)
+      def delete_email(*args)
         params = _extract_parameters(args)
+        _normalize_params_keys(params)
         params['data'] = [args].flatten
         delete("/user/emails", params)
       end

data/lib/github_api/users/keys.rb

@@ -13,12 +13,13 @@ module Github
       #  @github.users.public_keys
       #  @github.users.public_keys { |key| ... }
       #
-      def public_keys(params={})
+      def keys(params={})
         _normalize_params_keys(params)
         response = get("/user/keys", params)
         return response unless block_given?
         response.each { |el| yield el }
       end
+      alias :public_keys :keys
 
       # Get a single pulic key for the authenticated user
       #
@@ -26,11 +27,12 @@ module Github
       #  @github = Github.new :oauth_token => '...'
       #  @github.users.public_key 'key-id'
       #
-      def public_key(key_id, params={})
+      def key(key_id, params={})
         _validate_presence_of key_id
         _normalize_params_keys(params)
         get("/user/keys/#{key_id}", params)
       end
+      alias :public_key :key
 
       # Create a public key for the authenticated user
       #

data/lib/github_api/version.rb

@@ -4,7 +4,7 @@ module Github
   module VERSION
     MAJOR = 0
     MINOR = 4
-    PATCH = 7
+    PATCH = 8
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.');

data/spec/github/repos/commits_spec.rb

@@ -4,7 +4,8 @@ describe Github::Repos::Commits do
   let(:github) { Github.new }
   let(:user) { 'peter-murach' }
   let(:repo) { 'github' }
-  after { github.user, github.repo = nil, nil }
+
+  after { github.user, github.repo, github.oauth_token = nil, nil, nil }
 
   describe "commits" do
     context "resource found" do

data/spec/github/repos/hooks_spec.rb

@@ -27,7 +27,6 @@ describe Github::Repos::Hooks do
       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
 

data/spec/github/users/emails_spec.rb

@@ -1,5 +1,109 @@
 require 'spec_helper'
 
-describe Github::Users::Emails, :type => :base do
-  pending
+describe Github::Users::Emails do
+  let(:github) { Github.new }
+  let(:email) { "octocat@github.com" }
+
+  before { github.oauth_token = OAUTH_TOKEN }
+  after { reset_authentication_for github }
+
+  describe "#emails" do
+    context "resource found for an authenticated user" do
+      before do
+        stub_get("/user/emails").
+          with(:query => { :access_token => "#{OAUTH_TOKEN}"}).
+          to_return(:body => fixture('users/emails.json'),
+            :status => 200,
+            :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should get the resources" do
+        github.users.emails
+        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.should be_an Array
+        emails.should have(2).items
+      end
+
+      it "should get emails information" do
+        emails = github.users.emails
+        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' }
+      end
+    end
+
+    context "resource not found for a user" do
+      before do
+        stub_get("/user/emails").
+          with(:query => { :access_token => "#{OAUTH_TOKEN}"}).
+          to_return(:body => "", :status => [404, "Not Found"])
+      end
+
+      it "should return 404 with a message 'Not Found'" do
+        expect {
+          github.users.emails
+        }.to raise_error(Github::Error::NotFound)
+      end
+    end
+  end # emails
+
+  context '#add_email' do
+    let(:params) { { :per_page => 21, :page => 1 }}
+
+    before do
+      stub_post("/user/emails").
+        with(:query => { :access_token => "#{OAUTH_TOKEN}"}).
+        to_return(:body => fixture('users/emails.json'),
+          :status => 200,
+          :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it 'extracts request parameters and email data' do
+      github.users.should_receive(:post).
+        with("/user/emails", { "per_page" => 21, "page" => 1, "data" => [email] })
+      github.users.add_email email, params
+    end
+
+    it 'submits request successfully' do
+      github.users.add_email email
+      a_post("/user/emails").
+        with(:query => { :access_token => "#{OAUTH_TOKEN}"}).
+        should have_been_made
+    end
+  end # add_email
+
+  context '#delete_email' do
+    let(:params) { { :per_page => 21, :page => 1 }}
+
+    before do
+      stub_delete("/user/emails").
+        with(:query => { :access_token => "#{OAUTH_TOKEN}", :data => email}).
+        to_return(:body => fixture('users/emails.json'),
+          :status => 200,
+          :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it 'extracts request parameters and email data' do
+      github.users.should_receive(:delete).
+        with("/user/emails", { "per_page" => 21, "page" => 1, "data" => [email] })
+      github.users.delete_email email, params
+    end
+
+    it 'submits request successfully' do
+      github.users.delete_email email
+      a_delete("/user/emails").
+        with(:query => { :access_token => "#{OAUTH_TOKEN}", :data => email } ).
+        should have_been_made
+    end
+  end # delete_email
+
 end # Github::Users::Emails

data/spec/github/users/keys_spec.rb

@@ -1,5 +1,252 @@
 require 'spec_helper'
 
-describe Github::Users::Keys, :type => :base do
-  pending
+describe Github::Users::Keys do
+  let(:github) { Github.new }
+  let(:key_id) { 1 }
+
+  before { github.oauth_token = OAUTH_TOKEN }
+  after { reset_authentication_for github }
+
+  describe "#keys" do
+    context "resource found for an authenticated user" do
+      before do
+        stub_get("/user/keys").
+          with(:query => { :access_token => "#{OAUTH_TOKEN}"}).
+          to_return(:body => fixture('users/keys.json'),
+            :status => 200,
+            :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should get the resources" do
+        github.users.keys
+        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.should be_an Array
+        keys.should have(1).item
+      end
+
+      it "should get keys information" do
+        keys = github.users.keys
+        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' }
+      end
+    end
+
+    context "resource not found for a user" do
+      before do
+        stub_get("/user/keys").
+          with(:query => { :access_token => "#{OAUTH_TOKEN}"}).
+          to_return(:body => "", :status => [404, "Not Found"])
+      end
+
+      it "should return 404 with a message 'Not Found'" do
+        expect {
+          github.users.keys
+        }.to raise_error(Github::Error::NotFound)
+      end
+    end
+  end # keys
+
+  describe "#key" do
+    context "resource found for an authenticated user" do
+      before do
+        stub_get("/user/keys/#{key_id}").
+          with(:query => { :access_token => "#{OAUTH_TOKEN}"}).
+          to_return(:body => fixture('users/key.json'),
+            :status => 200,
+            :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to get resource without key id" do
+        expect { github.users.key nil }.to raise_error(ArgumentError)
+      end
+
+      it "should get the resource" do
+        github.users.key 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.id.should == key_id
+        key.title.should == 'octocat@octomac'
+      end
+
+      it "should return mash" do
+        key = github.users.key key_id
+        key.should be_a Hashie::Mash
+      end
+    end
+
+    context "resource not found" do
+      before do
+        stub_get("/user/keys/#{key_id}").
+          with(:query => { :access_token => "#{OAUTH_TOKEN}"}).
+          to_return(:body => fixture('users/key.json'),
+            :status => 404,
+            :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to retrive resource" do
+        expect {
+          github.users.key key_id
+        }.to raise_error(Github::Error::NotFound)
+      end
+    end
+  end # key
+
+  describe "create_key" do
+    let(:inputs) {
+      {
+        :title => "octocat@octomac",
+        :key => "ssh-rsa AAA...",
+        :unrelated => true
+      }
+    }
+
+    context "resouce created" do
+      before do
+        stub_post("/user/keys?access_token=#{OAUTH_TOKEN}").
+          with(:body => JSON.generate(inputs.except(:unrelated))).
+          to_return(:body => fixture('users/key.json'),
+            :status => 201,
+            :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should create resource successfully" do
+        github.users.create_key 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.should be_a Hashie::Mash
+      end
+
+      it "should get the key information" do
+        key = github.users.create_key inputs
+        key.title.should == 'octocat@octomac'
+      end
+    end
+
+    context "fail to create resource" do
+      before do
+        stub_post("/user/keys?access_token=#{OAUTH_TOKEN}").with(inputs).
+          to_return(:body => fixture('users/key.json'),
+            :status => 404,
+            :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to retrieve resource" do
+        expect {
+          github.users.create_key inputs
+        }.to raise_error(Github::Error::NotFound)
+      end
+    end
+  end # create_key
+
+  describe "#update_key" do
+    let(:inputs) {
+      {
+        :title => "octocat@octomac",
+        :key => "ssh-rsa AAA...",
+        :unrelated => true
+      }
+    }
+
+    context "resouce updated" do
+      before do
+        stub_patch("/user/keys/#{key_id}?access_token=#{OAUTH_TOKEN}").
+          with(:body => JSON.generate(inputs.except(:unrelated))).
+          to_return(:body => fixture('users/key.json'),
+            :status => 201,
+            :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to get resource without key id" do
+        expect { github.users.update_key nil }.to raise_error(ArgumentError)
+      end
+
+      it "should create resource successfully" do
+        github.users.update_key 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.should be_a Hashie::Mash
+      end
+
+      it "should get the key information" do
+        key = github.users.update_key key_id, inputs
+        key.title.should == 'octocat@octomac'
+      end
+    end
+
+    context "fail to update resource" do
+      before do
+        stub_patch("/user/keys/#{key_id}?access_token=#{OAUTH_TOKEN}").
+          with(inputs).
+          to_return(:body => fixture('users/key.json'),
+            :status => 404,
+            :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to retrieve resource" do
+        expect {
+          github.users.update_key key_id, inputs
+        }.to raise_error(Github::Error::NotFound)
+      end
+    end
+  end # update_key
+
+  describe "#delete_key" do
+    context "resouce deleted" do
+      before do
+        stub_delete("/user/keys/#{key_id}?access_token=#{OAUTH_TOKEN}").
+          to_return(:body => fixture('users/key.json'),
+            :status => 204,
+            :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to get resource without key id" do
+        expect { github.users.delete_key nil }.to raise_error(ArgumentError)
+      end
+
+      it "should create resource successfully" do
+        github.users.delete_key key_id
+        a_delete("/user/keys/#{key_id}?access_token=#{OAUTH_TOKEN}").
+          should have_been_made
+      end
+    end
+
+    context "fail to delete resource" do
+      before do
+        stub_delete("/user/keys/#{key_id}?access_token=#{OAUTH_TOKEN}").
+          to_return(:body => fixture('users/key.json'),
+            :status => 404,
+            :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to delete resource" do
+        expect {
+          github.users.delete_key key_id
+        }.to raise_error(Github::Error::NotFound)
+      end
+    end
+  end # delete_key
+
 end # Github::Users::Keys

metadata

@@ -2,7 +2,7 @@
 name: github_api
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.4.7
+  version: 0.4.8
 platform: ruby
 authors: 
 - Piotr Murach
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-11 00:00:00 +00:00
+date: 2012-03-17 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency