github_api 0.1.0.pre → 0.1.0

data/lib/github_api/repos/watching.rb

@@ -3,48 +3,92 @@
 module Github
   class Repos
     module Watching
-      
+
       # List repo watchers
       #
-      # GET /repos/:user/:repo/watchers
+      # = Examples
+      #  @github = Github.new :user => 'user-name', :repo => 'repo-name'
+      #  @github.repos.watchers
+      #  @github.repos.watchers { |watcher| ... }
       #
-      def watchers
-        get("/repos/#{user}/#{repo}/watchers")
+      def watchers(user_name=nil, repo_name=nil, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _normalize_params_keys(params)
+
+        response = get("/repos/#{user}/#{repo}/watchers")
+        return response unless block_given?
+        response.each { |el| yield el }
       end
-      
-      # List repos being watched
-      def watched(user=nil)
-        if user
+
+      # List repos being watched by a user
+      #
+      # = Examples
+      #  @github = Github.new :user => 'user-name'
+      #  @github.repos.watched
+      #
+      # List repos being watched by the authenticated user
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.repos.watched
+      #
+      def watched(user_name=nil, params={})
+        _update_user_repo_params(user_name)
+        _normalize_params_keys(params)
+
+        response = if user
           get("/users/#{user}/watched")
         else
           get("/user/watched")
         end
+        return response unless block_given?
+        response.each { |el| yield el }
       end
 
-      # Check if you are watching a repo
+      # Check if you are watching a repository
       #
-      # GET /user/watched/:user/:repo
+      # Returns <tt>true</tt> if this repo is watched by you, <tt>false</tt> otherwise
+      # = Examples
+      #  @github = Github.new
+      #  @github.repos.watching? 'user-name', 'repo-name'
       #
-      def watching?(user, repo)
-        get("/user/watched/#{user}/#{repo}")
+      def watching?(user_name, repo_name, params={})
+        _validate_presence_of user_name, repo_name
+        _normalize_params_keys(params)
+        get("/user/watched/#{user_name}/#{repo_name}")
+        true
+      rescue Github::ResourceNotFound
+        false
       end
 
-      # Watch a repo 
+      # Watch a repository
       #
-      # PUT /user/watched/:user/:repo
+      # You need to be authenticated to watch a repository
       #
-      def start_watching(user, repo)
-        put("/user/watched/#{user}/#{repo}")
+      # = Examples
+      #  @github = Github.new
+      #  @github.repos.start_watching 'user-name', 'repo-name'
+      #
+      def start_watching(user_name, repo_name, params={})
+        _validate_presence_of user_name, repo_name
+        _normalize_params_keys(params)
+        put("/user/watched/#{user_name}/#{repo_name}")
       end
-      
-      # Stop watching a repo
+
+      # Stop watching a repository
       #
-      # DELETE /user/watched/:user/:repo
+      # You need to be authenticated to stop watching a repository.
+      # = Examples
+      #  @github = Github.new
+      #  @github.repos.start_watching 'user-name', 'repo-name'
       #
-      def stop_watching(user, repo)
-        delete("/user/watched/#{user}/#{repo}")
+      def stop_watching(user_name, repo_name, params={})
+        _validate_presence_of user_name, repo_name
+        _normalize_params_keys(params)
+        delete("/user/watched/#{user_name}/#{repo_name}")
       end
 
-    end
-  end
-end
+    end # Watching
+  end # Repos
+end # Github

data/lib/github_api/request/oauth2.rb

@@ -8,9 +8,9 @@ module Github
       dependency 'oauth2'
 
       def call(env)
-        puts "ENV: #{env.inspect}"
-        puts "TOKEN : #{@token}"
-        puts "APP: #{@app}"
+#         puts "ENV: #{env.inspect}"
+#         puts "TOKEN : #{@token}"
+#         puts "APP: #{@app}"
 
         # Extract parameters from the query
         params = env[:url].query_values || {}

data/lib/github_api/version.rb

@@ -5,7 +5,7 @@ module Github
     MAJOR = 0
     MINOR = 1
     PATCH = 0
-    BUILD = 'pre'
+    BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.');
   end

data/spec/fixtures/repos/key.json

@@ -0,0 +1,6 @@
+{
+  "url": "https://api.github.com/user/keys/1",
+  "id": 1,
+  "title": "octocat@octomac",
+  "key": "ssh-rsa AAA..."
+}

data/spec/fixtures/repos/keys.json

@@ -0,0 +1,8 @@
+[
+  {
+    "url": "https://api.github.com/user/keys/1",
+    "id": 1,
+    "title": "octocat@octomac",
+    "key": "ssh-rsa AAA..."
+  }
+]

data/spec/fixtures/repos/watched.json

@@ -0,0 +1,29 @@
+[
+  {
+    "url": "https://api.github.com/repos/octocat/Hello-World",
+    "html_url": "https://github.com/octocat/Hello-World",
+    "clone_url": "https://github.com/octocat/Hello-World.git",
+    "git_url": "git://github.com/octocat/Hello-World.git",
+    "ssh_url": "git@github.com:octocat/Hello-World.git",
+    "svn_url": "https://svn.github.com/octocat/Hello-World",
+    "owner": {
+      "login": "octocat",
+      "id": 1,
+      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+      "url": "https://api.github.com/users/octocat"
+    },
+    "name": "Hello-World",
+    "description": "This your first repo!",
+    "homepage": "https://github.com",
+    "language": null,
+    "private": false,
+    "fork": false,
+    "forks": 9,
+    "watchers": 80,
+    "size": 108,
+    "master_branch": "master",
+    "open_issues": 0,
+    "pushed_at": "2011-01-26T19:06:43Z",
+    "created_at": "2011-01-26T19:01:12Z"
+  }
+]

data/spec/fixtures/repos/watchers.json

@@ -0,0 +1,8 @@
+[
+  {
+    "login": "octocat",
+    "id": 1,
+    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+    "url": "https://api.github.com/users/octocat"
+  }
+]

data/spec/github/api_spec.rb

@@ -1,6 +1,25 @@
 require 'spec_helper'
 
 describe Github::API do
-  
-  pending
+
+  let(:api) { Github::API.new }
+
+  before(:each) do
+    @params = { 'a' => { :b => { 'c' => 1 }, 'd' => [ 'a', { :e => 2 }] } }
+  end
+
+  it "should stringify all the keys inside nested hash" do
+    actual = api.send(:_normalize_params_keys, @params)
+    expected = { 'a' => { 'b'=> { 'c' => 1 }, 'd' => [ 'a', { 'e'=> 2 }] } }
+    actual.should == expected
+  end
+
+  it "should filter param keys" do
+    valid = ['a', 'b', 'e']
+    hash = {'a' => 1, 'b' => 3, 'c' => 2, 'd'=> 4, 'e' => 5 }
+    actual = api.send(:_filter_params_keys, valid, hash)
+    expected = {'a' => 1, 'b' => 3, 'e' => 5 }
+    actual.should == expected
+  end
+
 end

data/spec/github/repos/keys_spec.rb

@@ -1,5 +1,205 @@
 require 'spec_helper'
 
 describe Github::Repos::Keys do
-  pending
-end
+
+  let(:github) { Github.new }
+  let(:user)   { 'peter-murach'}
+  let(:repo)   { 'github' }
+
+  describe "keys" do
+
+    context "resource found" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/keys").
+          to_return(:body => fixture("repos/keys.json"), :status => 200, :headers => {})
+      end
+
+      it "should fail to get resource without username" do
+        github.user, github.repo = nil, nil
+        expect { github.repos.keys }.to raise_error(ArgumentError)
+      end
+
+      it "should get the resources" do
+        github.repos.keys(user, repo)
+        a_get("/repos/#{user}/#{repo}/keys").should have_been_made
+      end
+
+      it "should return array of resources" do
+        keys = github.repos.keys(user, repo)
+        keys.should be_an Array
+        keys.should have(1).items
+      end
+
+      it "should get key information" do
+        keys = github.repos.keys(user, repo)
+        keys.first.title.should == 'octocat@octomac'
+      end
+    end
+
+    context "resource not found" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/keys").
+          to_return(:body => fixture("repos/keys.json"), :status => 404)
+      end
+
+      it "should fail to retrieve resource" do
+        expect {
+          github.repos.keys user, repo
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+
+  end
+
+  describe "get_key" do
+    let(:key_id) { 1 }
+
+    context "resource found" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/keys/#{key_id}").
+          to_return(:body => fixture("repos/key.json"), :status => 200)
+      end
+
+      it "should fail to get resource without key" do
+        expect {
+          github.repos.get_key(user, repo, nil)
+        }.to raise_error(ArgumentError)
+      end
+
+      it "should get the resource" do
+        github.repos.get_key(user, repo, key_id)
+        a_get("/repos/#{user}/#{repo}/keys/#{key_id}").should have_been_made
+      end
+
+      it "should get key information" do
+        key = github.repos.get_key(user, repo, key_id)
+        key.id.should == key_id
+      end
+    end
+
+    context "resource not found" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/keys/#{key_id}").
+          to_return(:body => fixture("repos/keys.json"), :status => 404)
+      end
+
+      it "should fail to retrieve resource" do
+        expect {
+          github.repos.get_key(user, repo, key_id)
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end
+
+  describe "create_key" do
+    let(:inputs) { {:title => "octocat@octomac", :key => "ssh-rsa AAA..." } }
+
+    context "resource created" do
+      before do
+        stub_post("/repos/#{user}/#{repo}/keys").
+          to_return(:body => fixture("repos/key.json"), :status => 201)
+      end
+
+      it "should fail to create resource if 'title' input is missing" do
+        expect {
+          github.repos.create_key(user, repo, :key => 'ssh-rsa AAA...')
+        }.to raise_error(ArgumentError)
+      end
+
+      it "should fail to create resource if 'key' input is missing" do
+        expect {
+          github.repos.create_key(user, repo, :title => 'octocat@octomac')
+        }.to raise_error(ArgumentError)
+      end
+
+      it "should create the resource" do
+        github.repos.create_key(user, repo, inputs)
+        a_post("/repos/#{user}/#{repo}/keys").should have_been_made
+      end
+
+      it "should get the key information back" do
+        key = github.repos.create_key(user, repo, inputs)
+        key.title.should == 'octocat@octomac'
+      end
+    end
+
+    context "failed to create resource" do
+      before do
+        stub_post("/repos/#{user}/#{repo}/keys").
+          to_return(:body => fixture("repos/key.json"), :status => 404)
+      end
+
+      it "should fail to retrieve resource" do
+        expect {
+          github.repos.create_key(user, repo, inputs)
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end
+
+  describe "edit_key" do
+    let(:key_id) { 1 }
+    let(:inputs) { {:title => "octocat@octomac", :key => "ssh-rsa AAA..." } }
+
+    context "resource edited successfully" do
+      before do
+        stub_patch("/repos/#{user}/#{repo}/keys/#{key_id}").
+          to_return(:body => fixture("repos/key.json"), :status => 200)
+      end
+
+      it "should edit the resource" do
+        github.repos.edit_key(user, repo, key_id, inputs)
+        a_patch("/repos/#{user}/#{repo}/keys/#{key_id}").should have_been_made
+      end
+
+      it "should get the key information back" do
+        key = github.repos.edit_key(user, repo, key_id, inputs)
+        key.id.should == key_id
+        key.title.should == 'octocat@octomac'
+      end
+    end
+
+    context "failed to edit resource" do
+      before do
+        stub_patch("/repos/#{user}/#{repo}/keys/#{key_id}").
+          to_return(:body => fixture("repos/key.json"), :status => 404)
+      end
+
+      it "should fail to retrieve resource" do
+        expect {
+          github.repos.edit_key(user, repo, key_id, inputs)
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+
+  end
+
+  describe "delete_key" do
+    let(:key_id) { 1 }
+
+    context "resource found successfully" do
+      before do
+        stub_delete("/repos/#{user}/#{repo}/keys/#{key_id}").
+          to_return(:body => "", :status => 204)
+      end
+
+      it "should delete the resource" do
+        github.repos.delete_key(user, repo, key_id)
+        a_delete("/repos/#{user}/#{repo}/keys/#{key_id}").should have_been_made
+      end
+    end
+
+    context "failed to find resource" do
+      before do
+        stub_delete("/repos/#{user}/#{repo}/keys/#{key_id}").
+          to_return(:body => "", :status => 404)
+      end
+      it "should fail to find resource" do
+        expect {
+          github.repos.delete_key(user, repo, key_id)
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end
+
+end # Github::Repos::Keys

data/spec/github/repos/watching_spec.rb

@@ -1,5 +1,212 @@
+# encoding: utf-8
+
 require 'spec_helper'
 
 describe Github::Repos::Watching do
-  pending
-end
+
+  let(:github) { Github.new }
+  let(:user)   { 'peter-murach' }
+  let(:repo)   { 'github' }
+
+  describe "watchers" do
+    before do
+      stub_get("/repos/#{user}/#{repo}/watchers").
+        to_return(:body => fixture("repos/watchers.json"), :status => 200, :headers => {})
+    end
+
+    it "should fail to get resource without username" do
+      github.user, github.repo = nil, nil
+      expect { github.repos.watchers }.to raise_error(ArgumentError)
+    end
+
+    it "should yield iterator if block given" do
+      pending
+      block = lambda { ['a', 'b', 'c'] }
+      github.repos.watchers(user, repo, &block)
+    end
+
+    it "should get the resources" do
+      github.repos.watchers(user, repo)
+      a_get("/repos/#{user}/#{repo}/watchers").should have_been_made
+    end
+
+    it "should return array of resources" do
+      watchers = github.repos.watchers(user, repo)
+      watchers.should be_an Array
+      watchers.should have(1).items
+    end
+
+    it "should get watcher information" do
+      watchers = github.repos.watchers(user, repo)
+      watchers.first.login.should == 'octocat'
+    end
+
+    context "fail to find resource" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/watchers").
+          to_return(:body => "", :status => 404)
+      end
+
+      it "should return 404 not found message" do
+        lambda { github.repos.watchers(user, repo) }.should raise_error(Github::ResourceNotFound)
+      end
+
+    end
+
+  end
+
+  describe "watched" do
+
+    context "if user unauthenticated" do
+      before do
+        WebMock.reset!
+      end
+
+      it "should fail to get resource without username " do
+        stub_get("/user/watched").
+          to_return(:body => fixture("repos/watched.json"), :status => 401, :headers => {})
+        expect {
+          github.user = nil
+          github.repos.watched
+        }.to raise_error(Github::Unauthorised)
+      end
+
+      it "should get the resource with username" do
+        stub_get("/users/#{user}/watched").
+          to_return(:body => fixture("repos/watched.json"), :status => 200, :headers => {})
+        github.repos.watched(user)
+        a_get("/users/#{user}/watched").should have_been_made
+      end
+    end
+
+    context "if user authenticated" do
+      before do
+        github.user = nil
+        github.oauth_token = OAUTH_TOKEN
+        stub_get("/user/watched?access_token=#{OAUTH_TOKEN}").
+          to_return(:body => fixture("repos/watched.json"), :status => 200, :headers => {})
+      end
+
+      it "should get the resources" do
+        github.repos.watched
+        a_get("/user/watched?access_token=#{OAUTH_TOKEN}").should have_been_made
+      end
+
+      it "should return array of resources" do
+        watched = github.repos.watched
+        watched.should be_an Array
+        watched.should have(1).items
+      end
+
+      it "should get watched information" do
+        watched = github.repos.watched
+        watched.first.name.should == 'Hello-World'
+        watched.first.owner.login.should == 'octocat'
+      end
+    end
+  end
+
+  describe "watching?" do
+
+    context "with username ane reponame passed" do
+
+      context "this repo is being watched by the user"
+        before do
+          github.oauth_token = nil
+          github.user = nil
+          stub_get("/user/watched/#{user}/#{repo}").
+            to_return(:body => "", :status => 404, :headers => {:user_agent => github.user_agent})
+        end
+
+      it "should return false if resource not found" do
+        watching = github.repos.watching? user, repo
+        watching.should be_false
+      end
+
+      it "should return true if resoure found" do
+          stub_get("/user/watched/#{user}/#{repo}").
+            to_return(:body => "", :status => 200, :headers => {:user_agent => github.user_agent})
+        watching = github.repos.watching? user, repo
+        watching.should be_true
+      end
+
+    end
+
+    context "without username and reponame passed" do
+      it "should fail validation " do
+        expect { github.repos.watching?(nil, nil) }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe "start_watching" do
+
+    context "user authenticated" do
+
+      context "with correct information" do
+        before do
+          github.user, github.repo = nil, nil
+          github.oauth_token = OAUTH_TOKEN
+          stub_put("/user/watched/#{user}/#{repo}?access_token=#{OAUTH_TOKEN}").
+            to_return(:body => "", :status => 204, :headers => {})
+        end
+
+        it "should successfully watch a repo" do
+          github.repos.start_watching(user, repo)
+          a_put("/user/watched/#{user}/#{repo}?access_token=#{OAUTH_TOKEN}").should have_been_made
+        end
+      end
+
+      context "without correct information" do
+
+      end
+    end
+
+    context "user unauthenticated" do
+      it "should fail" do
+        github.oauth_token = nil
+        stub_put("/user/watched/#{user}/#{repo}").
+          to_return(:body => "", :status => 401, :headers => {})
+        expect {
+          github.repos.start_watching(user, repo)
+        }.to raise_error(Github::Unauthorised)
+      end
+    end
+  end
+
+  describe "stop_watching" do
+
+    context "user authenticated" do
+
+      context "with correct information" do
+        before do
+          github.user, github.repo = nil, nil
+          github.oauth_token = OAUTH_TOKEN
+          stub_delete("/user/watched/#{user}/#{repo}?access_token=#{OAUTH_TOKEN}").
+            to_return(:body => "", :status => 204, :headers => {})
+        end
+
+        it "should successfully watch a repo" do
+          github.repos.stop_watching(user, repo)
+          a_delete("/user/watched/#{user}/#{repo}?access_token=#{OAUTH_TOKEN}").should have_been_made
+        end
+      end
+
+      context "without correct information" do
+
+      end
+    end
+
+    context "user unauthenticated" do
+      it "should fail" do
+        github.oauth_token = nil
+        stub_delete("/user/watched/#{user}/#{repo}").
+          to_return(:body => "", :status => 401, :headers => {})
+        expect {
+          github.repos.stop_watching(user, repo)
+        }.to raise_error(Github::Unauthorised)
+      end
+    end
+  end
+
+end # Github::Respos::Watching

data/spec/github/repos_spec.rb

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
 describe Github::Repos do
-  
+
   let(:github) { Github.new }
-  let(:repo) { mock('object').as_null_object } 
+  let(:repo)   { mock('object').as_null_object } 
 
   before do
     github.stub(:repos).and_return(repo)
@@ -17,18 +17,21 @@ describe Github::Repos do
     end
 
     it "should raise error when no user" do
+      pending
       expect {
         Github.new.repos.branches
       }.to raise_error(ArgumentError, /\[user\] parameter cannot be nil/)
     end
 
     it "should raise error when no repo" do
+      pending
       expect {
         Github.new(:user => 'peter-murach').repos.branches
       }.to raise_error(ArgumentError, /\[repo\] parameter cannot be nil/)
     end
 
     it "should list all branches" do
+      pending
       github.repos.should_receive(:branches).and_return(@branches)
     end
   end