github_api 0.9.6 → 0.9.7

data/features/cassettes/users/keys/user.yml

@@ -0,0 +1,64 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<BASIC_AUTH>@api.github.com/user/keys?access_token=<TOKEN>
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.github.v3.full+json,application/vnd.github.beta.full+json;q=0.7,application/vnd.github+json;q=0.5,application/json;q=0.1
+      Accept-Charset:
+      - utf-8
+      User-Agent:
+      - Github Ruby Gem 0.9.6
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Wed, 10 Apr 2013 21:32:31 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - '5000'
+      X-Ratelimit-Remaining:
+      - '4998'
+      Vary:
+      - Accept, Authorization, Cookie
+      Cache-Control:
+      - private, max-age=60, s-maxage=60
+      Last-Modified:
+      - Wed, 23 Jan 2013 10:27:19 GMT
+      Etag:
+      - ! '"35217ca008626c2edeb80604cf854530"'
+      X-Github-Media-Type:
+      - github.v3; param=full; format=json
+      X-Content-Type-Options:
+      - nosniff
+      Content-Length:
+      - '2'
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Expose-Headers:
+      - Link, X-RateLimit-Limit, X-RateLimit-Remaining, X-OAuth-Scopes, X-Accepted-OAuth-Scopes
+      Access-Control-Allow-Origin:
+      - ! '*'
+    body:
+      encoding: US-ASCII
+      string: ! '[]'
+    http_version: !!null 
+  recorded_at: Wed, 10 Apr 2013 21:32:32 GMT
+recorded_with: VCR 2.4.0

data/features/cassettes/users/keys/user_all.yml

@@ -0,0 +1,91 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<BASIC_AUTH>@api.github.com/users/wycats/keys?access_token=<TOKEN>
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.github.v3.full+json,application/vnd.github.beta.full+json;q=0.7,application/vnd.github+json;q=0.5,application/json;q=0.1
+      Accept-Charset:
+      - utf-8
+      User-Agent:
+      - Github Ruby Gem 0.9.6
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Wed, 10 Apr 2013 21:30:59 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - '5000'
+      X-Ratelimit-Remaining:
+      - '4999'
+      Vary:
+      - Accept, Authorization, Cookie
+      Cache-Control:
+      - private, max-age=60, s-maxage=60
+      Last-Modified:
+      - Wed, 10 Apr 2013 21:28:41 GMT
+      Etag:
+      - ! '"f2cb84edaf3717927473ca494e9fa1ec"'
+      X-Github-Media-Type:
+      - github.v3; param=full; format=json
+      X-Content-Type-Options:
+      - nosniff
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Expose-Headers:
+      - Link, X-RateLimit-Limit, X-RateLimit-Remaining, X-OAuth-Scopes, X-Accepted-OAuth-Scopes
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Content-Encoding:
+      - gzip
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA4ySya6jVhRFfyXy1BXRYyipBvRg+sZcICMMvjZwAZseovx7
+        XhIpybD24EhbOpOttX77/VSVp+8EcyFY/Nupeeyn76dxfP06jPkvwldEyjly
+        idgLUvm7GuvX9RXhEh3qnu5lT3AmqxtiRXZXWyR64pjijF8tOsI2uVSOrFi2
+        qekID9ZUgyK+DLRRRp+a5yV2XByKuQK8aXSM9x57bakeKWJ8WlR2nzRwFPcl
+        TMRlennmWiEBzcXQUvm8NKlQ41vFWkWIW30ZAooQ4+bpluL5LWNdYVj17DRa
+        OCYPaA18wxu3xORwz+gZnxn4WMwifYHLcb4jHsUX4MdI5G/yTAF6I+WzapeD
+        6xt64IWLRIuQHMzwM5tX151izMwdk7pPM/O5A4Qleaq5kXnDu0Lsq6kTDPZD
+        1J+Int49f1gGJE27Nbt+CFRC0txrhMV9Uc/ZI0DLvJpU6w+f+YMBrTIeA1h/
+        /Dj98e0fJBzL0zj700gMRXgz9CXpcGDCcuTiCbVa6ErHh2+JIKtrZhJEmgPk
+        cURX6jLlKuvUX98UXjyJ2KfohuBriwgLvIpWvZ/fRGRjIO3SfMO8NtbBK14V
+        ez0LM7y6h9NvV6Puet6doDLGN4qlJNhmVacBnBRVw5mW7UmqBl/C3utlkXlG
+        zgg13fIs9KrD8b+ZPMNQNPETM2XBF8S/DBR86SwJyHnYY6HFcZkmzfLSUGUk
+        Q92cw6ZMIsq1dZh0KCMUObIBg1zMv28g2EmdasYLOw+F12RBhwAGkCQpZnT3
+        NFIAKq9cg7FwwUZIhh2lb+/JjiQ3TN1aHBxJcalrK63K6FIuGXCoxmuZ8Afz
+        8EJUBHlKkox+wJsGXn01P3Zrarh3AjnOrznMxix0yY5HYJoqfN54UhZaiLh0
+        h+uR3nCHC9cSY0c9mfsEdhA5btc+oSjKdecY76yfAsGpaTLzAxD3y9Pt8o9n
+        Z8ey3fA0JYc9+7BcfPWPxvabEelkLosGBYa2sy9pUsUhc952ORrtI6T5ea7c
+        j7TNGRm0ShSILms1c/CvecSFYn5Ovf8xkX3A1vHZdyVlSFi1cAn/3lnmfd+i
+        hMJbbJkYzFO3Te/j9zjG86AC+4UxJaELxnYnlaVmtk1kWmnHk7ONczf0Z0Pz
+        st0QEAAA9F+6taDEY5YSqom3MCLndFFvmQcNZsQ5/ff2/sAVCu/W5HkY0avS
+        LQ2ypKFWzWNk3CkRaCO2I8PUeShr5WSOG2umpNl8eAHycMyxl097LBVgpiBt
+        ycB8nOjQMTXbPL5GFU77pPC2E7439N+cAT80rNZ5PfZnbwgQ/RT02euKn0y5
+        EDACXcR0aG+af0nrpA9aCydY3ApsbCjcjzmvSjliEQbPMLdUltaLBM2oC66l
+        jtaayFkpZyiw+FS51onEh9I2Fjjz90BbQxcq2pAYrvv072hvINuBminEgPiD
+        u/vb79cfKh9lsKIFAAA=
+    http_version: !!null 
+  recorded_at: Wed, 10 Apr 2013 21:30:59 GMT
+recorded_with: VCR 2.4.0

data/features/gists.feature

@@ -16,7 +16,9 @@ Feature: Gists API
 
   Scenario: List public gists
 
-    Given I want to list resources
+    Given I want to list resources with the following params:
+      | public |
+      | public |
     When I make request within a cassette named "gists/gists/public_all"
     Then the response status should be 200
       And the response type should be JSON

data/features/repos.feature

@@ -46,7 +46,9 @@ Feature: Repositories API
 
   Scenario: All repositories
 
-    Given I want to list resources
+    Given I want to list resources with the following params:
+      | every |
+      | every |
     When I make request within a cassette named "repos/list_repos"
     Then the response status should be 200
       And the response type should be JSON

data/features/users/keys.feature

@@ -0,0 +1,27 @@
+Feature: Accessing Users Keys API
+
+  In order to interact with github user keys
+  GithubAPI gem
+  Should return the expected results depending on passed parameters
+
+  Background:
+    Given I have "Github::Users::Keys" instance
+
+  Scenario: Lists all public keys for a user
+
+    Given I want to list resources
+      And I pass the following request options:
+        | user   |
+        | wycats |
+    When I make request within a cassette named "users/keys/user_all"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty
+
+  Scenario: Lists all public keys for the authenticted user
+
+    Given I want to list resources
+    When I make request within a cassette named "users/keys/user"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should be empty

data/lib/github_api/gists.rb

@@ -32,15 +32,20 @@ module Github
     #  github = Github.new :oauth_token => '...'
     #  github.gists.list
     #
+    # List all public gists
+    #
+    #  github = Github.new
+    #  github.gists.list :public
+    #
     def list(*args)
       params = arguments(args).params
 
       response = if (user = params.delete('user'))
         get_request("/users/#{user}/gists", params)
-      elsif oauth_token
-        get_request("/gists", params)
-      else
+      elsif args.map(&:to_s).include?('public')
         get_request("/gists/public", params)
+      else
+        get_request("/gists", params)
       end
       return response unless block_given?
       response.each { |el| yield el }

data/lib/github_api/issues.rb

@@ -139,9 +139,6 @@ module Github
       params = arguments(args) do
         assert_values VALID_ISSUE_PARAM_VALUES
       end.params
-      # filter! VALID_ISSUE_PARAM_NAMES, params
-      # _merge_mime_type(:issue, params)
-      # assert_valid_values(VALID_ISSUE_PARAM_VALUES, params)
 
       response = if (org = params.delete('org'))
         get_request("/orgs/#{org}/issues", params)

data/lib/github_api/orgs/members.rb

@@ -21,8 +21,8 @@ module Github
     # Members of an organization can choose to have their membership publicized or not.
     # = Examples
     #  github = Github.new
-    #  github.orgs.members.list 'org-name', :public => true
-    #  github.orgs.members.list 'org-name', :public => true { |memb| ... }
+    #  github.orgs.members.list 'org-name', public: true
+    #  github.orgs.members.list 'org-name', public: true { |memb| ... }
     #
     def list(*args)
       params = arguments(args, :required => [:org_name]).params

data/lib/github_api/repos.rb

@@ -114,26 +114,26 @@ module Github
     #
     # = Examples
     #   github = Github.new
-    #   github.repos.list
-    #   github.repos.list { |repo| ... }
+    #   github.repos.list every: true
+    #   github.repos.list every: true { |repo| ... }
     #
     # List public repositories for the specified user.
     #
     # = Examples
     #   github = Github.new
-    #   github.repos.list :user => 'user-name'
-    #   github.repos.list :user => 'user-name', { |repo| ... }
+    #   github.repos.list user: 'user-name'
+    #   github.repos.list user: 'user-name', { |repo| ... }
     #
     # List repositories for the specified organisation.
     #
     # = Examples
     #  github = Github.new
-    #  github.repos.list :org => 'org-name'
-    #  github.repos.list :org => 'org-name', { |repo| ... }
+    #  github.repos.list org: 'org-name'
+    #  github.repos.list org: 'org-name', { |repo| ... }
     #
     def list(*args)
       arguments(args) do
-        sift %w[ user org type sort direction ]
+        sift %w[ user org type sort direction since ]
       end
       params = arguments.params
 
@@ -141,11 +141,11 @@ module Github
         get_request("/users/#{user_name}/repos", params)
       elsif (org_name = (params.delete("org")))
         get_request("/orgs/#{org_name}/repos", params)
-      elsif authenticated?
+      elsif args.map(&:to_s).include?("every")
+        get_request("/repositories", params)
+      else
         # For authenticated user
         get_request("/user/repos", params)
-      else
-        get_request("/repositories", params)
       end
       return response unless block_given?
       response.each { |el| yield el }

data/lib/github_api/repos/keys.rb

@@ -17,9 +17,8 @@ module Github
     #
     def list(*args)
       arguments(args, :required => [:user, :repo])
-      params = arguments.params
 
-      response = get_request("/repos/#{user}/#{repo}/keys", params)
+      response = get_request("/repos/#{user}/#{repo}/keys", arguments.params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -33,9 +32,8 @@ module Github
     #
     def get(*args)
       arguments(args, :required => [:user, :repo, :key_id])
-      params = arguments.params
 
-      get_request("/repos/#{user}/#{repo}/keys/#{key_id}", params)
+      get_request("/repos/#{user}/#{repo}/keys/#{key_id}", arguments.params)
     end
     alias :find :get
 

data/lib/github_api/users/keys.rb

@@ -12,9 +12,19 @@ module Github
     #  github.users.keys.list
     #  github.users.keys.list { |key| ... }
     #
+    # List public keys for the specified user
+    #
+    # = Examples
+    #  github.users.keys.list user: 'user-name'
+    #  github.users.keys.list user: 'user-name' { |key| ... }
+    #
     def list(*args)
-      arguments(args)
-      response = get_request("/user/keys", arguments.params)
+      params = arguments(args).params
+      response = if (user = params.delete('user'))
+        get_request("/users/#{user}/keys", params)
+      else
+        get_request("/user/keys", params)
+      end
       return response unless block_given?
       response.each { |el| yield el }
     end

data/lib/github_api/version.rb

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

data/spec/github/gists/list_spec.rb

@@ -50,12 +50,12 @@ describe Github::Gists, '#list' do
     let(:request_path) { "/gists/public" }
 
     it "should get the resources" do
-      subject.list
+      subject.list :public
       a_get(request_path).should have_been_made
     end
 
     it_should_behave_like 'an array of resources' do
-      let(:requestable) { subject.list }
+      let(:requestable) { subject.list :public }
     end
   end
 

data/spec/github/repos/list_spec.rb

@@ -26,10 +26,10 @@ describe Github::Repos, '#list' do
 
     it "falls back to all if user is unauthenticated" do
       subject.oauth_token = nil
-      stub_get("/repositories").to_return(:body => '[]', :status => 200,
+      stub_get("/user/repos").to_return(:body => '[]', :status => 200,
         :headers => {:content_type => "application/json; charset=utf-8"} )
       subject.list
-      a_get('/repositories').should have_been_made
+      a_get('/user/repos').should have_been_made
     end
 
     it "should get the resources" do
@@ -67,10 +67,9 @@ describe Github::Repos, '#list' do
     }
 
     it "should get the resources" do
-      subject.list
+      subject.list :every
       a_get(request_path).should have_been_made
     end
-
   end
 
   context "resource found for organization" do

data/spec/github/users/keys/list_spec.rb

@@ -4,7 +4,6 @@ require 'spec_helper'
 
 describe Github::Users::Keys, '#list' do
   let(:key_id) { 1 }
-  let(:request_path) { "/user/keys" }
 
   before {
     subject.oauth_token = OAUTH_TOKEN
@@ -16,6 +15,7 @@ describe Github::Users::Keys, '#list' do
   after { reset_authentication_for(subject) }
 
   context "resource found for an authenticated user" do
+    let(:request_path) { "/user/keys" }
     let(:body) { fixture('users/keys.json') }
     let(:status) { 200 }
 
@@ -41,10 +41,38 @@ describe Github::Users::Keys, '#list' do
       result = subject.list { |obj| yielded << obj }
       yielded.should == result
     end
+
+    it_should_behave_like 'request failure' do
+      let(:requestable) { subject.list }
+    end
   end
 
-  it_should_behave_like 'request failure' do
-    let(:requestable) { subject.list }
+  context "resource found for a user" do
+    let(:user) { 'peter-murach' }
+    let(:body) { fixture('users/keys.json') }
+    let(:status) { 200 }
+    let(:request_path) { "/users/#{user}/keys" }
+
+    it "should get the resources" do
+      subject.list :user => user
+      a_get(request_path).with(:query => { :access_token => "#{OAUTH_TOKEN}"}).
+        should have_been_made
+    end
+
+    it_should_behave_like 'an array of resources' do
+      let(:requestable) { subject.list :user => user }
+    end
+
+    it "should get keys information" do
+      keys = subject.list :user => user
+      keys.first.id.should == key_id
+    end
+
+    it "should yield to a block" do
+      yielded = []
+      result = subject.list(:user => user) { |obj| yielded << obj }
+      yielded.should == result
+    end
   end
 
 end # list