github_api 0.4.11 → 0.5.0.rc1

data/features/cassettes/pagination/repos/per_page/each_page.yml

@@ -410,4 +410,49 @@ http_interactions:
 
     http_version: 
   recorded_at: Sat, 10 Mar 2012 23:14:13 GMT
+- request: 
+    method: get
+    uri: https://api.github.com/repos/https://api.github.com/users/wycats/repos/%7B%22page%22=%3E2,%20%22per_page%22=%3E30%7D
+    body: 
+      encoding: US-ASCII
+      string: ""
+    headers: 
+      Accept-Encoding: 
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept: 
+      - "*/*"
+      User-Agent: 
+      - Ruby
+  response: 
+    status: 
+      code: 404
+      message: Not Found
+    headers: 
+      Server: 
+      - nginx/1.0.13
+      Date: 
+      - Mon, 09 Apr 2012 15:18:37 GMT
+      Content-Type: 
+      - application/json; charset=utf-8
+      Transfer-Encoding: 
+      - chunked
+      Connection: 
+      - keep-alive
+      Status: 
+      - 404 Not Found
+      X-Ratelimit-Limit: 
+      - "5000"
+      Etag: 
+      - "\"e66a7a6c91e2c26803f3f49feb7a883f\""
+      X-Ratelimit-Remaining: 
+      - "4998"
+      Content-Encoding: 
+      - gzip
+    body: 
+      encoding: ASCII-8BIT
+      string: !binary |
+        H4sIAAAAAAAAA6tWyk0tLk5MT1WyUvLLL1Fwyy/NS1GqBQB8+Ys1FwAAAA==
+
+    http_version: 
+  recorded_at: Mon, 09 Apr 2012 15:18:37 GMT
 recorded_with: VCR 2.0.0

data/features/cassettes/repos/list.yml

@@ -0,0 +1,92 @@
+--- 
+http_interactions: 
+- request: 
+    method: get
+    uri: https://api.github.com/users/peter-murach/repos
+    body: 
+      encoding: US-ASCII
+      string: ""
+    headers: 
+      Accept-Encoding: 
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept: 
+      - "*/*"
+      User-Agent: 
+      - Ruby
+  response: 
+    status: 
+      code: 200
+      message: OK
+    headers: 
+      Server: 
+      - nginx/1.0.13
+      Date: 
+      - Mon, 09 Apr 2012 17:55:27 GMT
+      Content-Type: 
+      - application/json; charset=utf-8
+      Transfer-Encoding: 
+      - chunked
+      Connection: 
+      - keep-alive
+      Status: 
+      - 200 OK
+      X-Ratelimit-Limit: 
+      - "5000"
+      Etag: 
+      - "\"8fdb914bd8bb00728968cb0942542ec8\""
+      X-Ratelimit-Remaining: 
+      - "4998"
+      Content-Encoding: 
+      - gzip
+    body: 
+      encoding: ASCII-8BIT
+      string: !binary |
+        H4sIAAAAAAAAA+1bbY+bRhD+K8hS2y9nH7uAbZCqNmrVJG0qVRerUltV1hrW
+        NjoMiIVLrlH+e5/lxQZ78XEGf7N0uvhimBl25nl2Znb458voE0vdLU/EyCF3
+        o42fLrMkGDnyk3N/j9/bbDVxo919zFOejHdZwtztffrJT/HnksXxBNeM7kZx
+        JrbcW7IU91Kd6GNCx8ReENshlkOnf+OSbbTjMdtwXIG/xFNYqtqmaSy6KZNS
+        mFh60acwiJgHo9Mk4/jPdBdcJC2LPZbW7CZjmK6bC91wLNMxZtLunZ8kUVKI
+        D7MgKGzwhcj43oBi0aonYbEvl6VauoTHkWhdQGhYR8lj4YCAhZusWKOHbPVc
+        fjdy1iwQeE43iEL++gctfSTE9uDdHw8GOi/4Vi75J//Rr1Zb+P/BiXRGTfg9
+        8Z+wggcLE95YUAQCGevTBZk5luFQSy4ovMeTkfNlFEQbP0Q41PXjewaJrFxw
+        uLaIDsHdLOGTTVJ8m8dk8fF+vaKm7VnW1GT6eu5aTF9Nba57M+JZc9u0f/C+
+        33uGmvMJn7BHtmP+JOTpPROCp6Lmrm/oL/4OLhD4UGmrfx4TU5/E4QaGnvV6
+        JoCqhtdxRyVw6Xt47pcMxw3yOtM0DUK/3o1CtpPoqaEPV3hcuIkfp34kl3JR
+        IFML/EeuAZ6B7zL5leaH2gPzA1HKJLo1M6ZwYBTzcFkFs/717kJG4J/jKEnZ
+        KoCLVISAIMAPXVDimFPH0vsQwkEXHqYvHzSEtdIBuIA61vxadNAw4ipscOKf
+        bmRwcpuaC4wZ7UQF1Z4AbiXGjQoKnutDBY3AaTJBjnYtDjJwrJZGGmeCa8X1
+        frjRUiYexaRiAzKnpmUMxgZPXKQsWD6BAcE9ObtC01GOUFCCsaDU0Ylj2X0o
+        4UjhALxwKrGVHKYOoY6Rx/P5XKHcxc9uG4pk4dSUkiL0u1FbwlDkRa/JF9Q+
+        60YT6nvVXEGs6ctcgdgw8vwRySPCI98ubmlD0ittOA2jJmH8xnmsMe3nh7+0
+        rS/SKHnWorX2HGWJ9sZN/Sf+wN0o8bRd5PFAfKe5WySrSIGLJIVYuk5lRjhQ
+        QoH8fq3mDYo8YkwtGRvmrIyNS2sLqWUAsijFHDOEytLzDFHA9rUEUaq/SuJQ
+        80M3LqjdoCYAYzrvRAD2mFJZQOpzxzBvBNA/WSjDpIn6t3ynIXC0DUdRhlIB
+        qcEKNZznJtluJe60gLNQ+1bb4Z8qW6CmYecZ3zmom1b3dkJZiiqzBGDIHOvY
+        CWYORRaeB8KlaC/0DID3vSAF4uvW5uXuNRC/N6DCPIi3LRW4oHfQcEg32Ddu
+        UQOfGt12fgAf7G47xhSb/w34/YG/j5ajCgEdJvQF0MhbM5fLGqG4UHvzx3vt
+        ySg3dhQGU0qQajbQTi7uFHj8iQeQldR6LuqNPm/GYQ9Az8BCHpiDqQZ92dNB
+        21AlDxd27y+2COjbWGgRe8wYRw+ZV0HnGePCKqLFnmuUEipVr+pBnhGgphZC
+        OlGLbO7OFgTNXeIY5EYt/alF5SlE8FGO4afvslVOK17kZjsepnlTsmIYy6BT
+        G8cP5/KJV5xOsJAl7va5lVQAOVuSCvIJ2qvrUCoaIKE4SFLwQ81eI98Pz/PD
+        ZTXEwQJlGfEreu0f8z4z9MsrLjqTaHqmW2LRvEcNf7sb+quFJKZj3loK5TFL
+        n/bjIWiagK+APSf63DxOHS4/ZMD5gkC2cgbYVJfsbuKn1wlDqWgAYB8kKYF9
+        ZO81gH2wQAns3seMDZ90g3TTj2pIEx1x89LpIgBNxnINcaqkO8btdHEATB/i
+        pQ3ThkntwTbr9DnNWg4I8vYZmckDAlT/Zq/SP1czBJ5LOcdoPrL1aoV/9RzX
+        wXLNFx2RXLtDjeOO3T45LqIvqCE9rd+OBofAcRmpTRS/40EsZFNf22Hz3nBN
+        TuRoqZ8GXMgZgbzdXxwdyuGeaiO3LWsmO3oDZej1gY8X2wCAVjE6gEM2HeNE
+        fTqALYoHIIZ2yQqqOHmea2z87RYpyWOYDL9F6auq//My1DRjTbulC/nJkWwo
+        yYzh1gDo3wBocRYQpUwfDN206Wy4Wt+L0rUP7lLXBMXhATo+qPR1R+9V7Fea
+        BuCKmigFOeAAoWnxNcihZoKSDf70dx/6VPpHfumWTRzd1APpxZ4xlakjHG/d
+        EooBEopayDSh/VMUrv0NJoPzQcMcjvmRIgsCbfesZaH/GYcL0X72EMOMxJyj
+        ZTNQNhFw/tiKf2y1qCDQELAdM5/fu/TwUGoZAPulGAXuTyy9Bu5L9UrM920F
+        1PzQDe+1G9RYJ2aHEeMC64WTp5gWuO3q/Xf1MkyOcJ6hd7/iiYYmHIoIFnra
+        w8eYu3KqkLtFS79APoazUV54mEIO8ynkakgIyJ+Z8qhmIOS7mLQXacLCaIyj
+        yzGGDjGQdIYKiqkha+5YeR/9UipQqh2AG9rkKsni8Cx5Y+QaZNFmz1XYQ6ns
+        VXXDOQlqfpl3pZdy3Axvs+SvstxGEfuNIio9hXVt8s3vWZAC3rJBcbhBzihg
+        eHmzpxQ6tWzpx4EopRiBWLpB/goPbDqaWi5KCrzQgnzC6jl9eNA1AHk0hCkY
+        A2VF0+prMEbDiKvQxIl/uqUaJ7epCcGYd2gjIAQwnEwWqCwMzKXciosBiotG
+        4BylHR/ej1d4ecHTmOtyIeSg0tvDRMF+UAmdZrzsdZpc/Ps/lLXz8uY4AAA=
+
+    http_version: 
+  recorded_at: Mon, 09 Apr 2012 17:55:27 GMT
+recorded_with: VCR 2.0.0

data/features/error_codes.feature

@@ -6,7 +6,7 @@ Feature: Handles HTTP error codes
 
   Scenario: A response of '401 - Unauthorised access'
     Given I have "Github::Repos" instance
-    When I am looking for "create_repo"
+    When I want to create resource
       And I pass the following request options:
         | name       |
         | basic_auth |

data/features/gists.feature

@@ -7,7 +7,7 @@ Feature: Accessing Gists Main API
     Given I have "Github::Gists" instance
 
   Scenario: Lists all user's gists
-    When I am looking for "gists" with the following params:
+    When I want to list resources with the following params:
       | user          |
       | peter-murach  |
     And I make request within a cassette named "gists/gists/user_all"
@@ -15,7 +15,7 @@ Feature: Accessing Gists Main API
     And the response type should be "JSON"
 
   Scenario: Lists all public gists
-    When I am looking for "gists" with the following params:
+    When I want to list resources with the following params:
       | user |
       | nil  |
     And I make request within a cassette named "gists/gists/public_all"
@@ -23,9 +23,18 @@ Feature: Accessing Gists Main API
     And the response type should be "JSON"
 
   Scenario: Gets a single gist
-    When I am looking for "gist" with the following params:
+    When I want to get resource with the following params:
       | gist_id |
       | 1738161 |
     And I make request within a cassette named "gists/gist"
     Then the response should be "200"
     And the response type should be "JSON"
+
+  Scenario: Check if gist is starred
+    When I want to starred? resource with the following params:
+      | gist_id |
+      | 1738161 |
+    And I make request within a cassette named "gists/starred"
+    Then the response should equal false
+
+

data/features/gists/comments.feature

@@ -4,10 +4,10 @@ Feature: Accessing Gists Comments API
   Should return the expected results depending on passed parameters
 
   Background:
-    Given I have "Github::Gists" instance
+    Given I have "Github::Gists::Comments" instance
 
   Scenario: Lists comments on a gist
-    When I am looking for "comments" with the following params:
+    When I want to list resources with the following params:
       | gist_id |
       | 999390  |
       And I make request within a cassette named "gists/comments/all"
@@ -16,7 +16,7 @@ Feature: Accessing Gists Comments API
       And the response should have 18 items
 
   Scenario: Gets a single gist's comment
-    When I am looking for "comment" with the following params:
+    When I want to get resource with the following params:
       | comment_id |
       | 33469      |
     And I make request within a cassette named "gists/comments/first"

data/features/github_api.feature

@@ -1,7 +1,8 @@
 Feature: Github API components
 
-  In order to interact with full Github API
-  A user needs to request a Github class instance
+  In order to navigate within Github API hierachy
+  A user
+  I want to be able to with a given Github API instance
 
   Scenario: Accessing repositories API
     Given I have github instance
@@ -13,6 +14,16 @@ Feature: Github API components
     When  I fetch "orgs"
     Then  I will have access to "Github::Orgs" API
 
+  Scenario: Accessing members API
+    Given I have "Github::Orgs" instance
+    When  I call members
+    Then  I will have access to "Github::Orgs::Members" API
+
+  Scenario: Accessing teams API
+    Given I have "Github::Orgs" instance
+    When  I call teams
+    Then  I will have access to "Github::Orgs::Teams" API
+
   Scenario: Accessing gists API
     Given I have github instance
     When  I fetch "gists"

data/features/pagination.feature

@@ -5,73 +5,74 @@ Feature: Githu API pagination
 
   Scenario: Passing per_page param
     Given I have "Github::Repos" instance
-    When I am looking for "repos"
-    And I pass the following request options:
-      | user   | per_page |
-      | wycats | 45       |
-    And I make request within a cassette named "pagination/repos"
+    When I want to list resources
+      And I pass the following request options:
+        | user   | per_page |
+        | wycats | 45       |
+      And I make request within a cassette named "pagination/repos/list"
     Then the response should be "200"
-    And the response type should be "JSON"
-    And the response should have 45 items
+      And the response type should be "JSON"
+      And the response should have 45 items
 
-    When I request "next" page within a cassette named "pagination/repos/next"
+    When I request "next" page within a cassette named "pagination/repos/list/next"
     Then the response should be "200"
-    And the response should have 45 items
+      And the response should have 45 items
 
   Scenario: Returned paginated resources are different
     Given I have "Github::Repos" instance
-    When I am looking for "repos"
-    And I pass the following request options:
-      | user   |
-      | wycats |
-    And I make request within a cassette named "pagination/repos/diff"
+    When I want to list resources
+      And I pass the following request options:
+        | user   |
+        | wycats |
+      And I make request within a cassette named "pagination/repos/diff"
     Then the response should be "200"
-    And the response type should be "JSON"
-    And the response should have 30 items
+      And the response type should be "JSON"
+      And the response should have 30 items
 
     When I request "next" page within a cassette named "pagination/repos/diff/next"
     Then the response should be "200"
-    And the response should have 30 items
-    And the response collection of resources is different for "name" attribute
+      And the response should have 30 items
+      And the response collection of resources is different for "name" attribute
 
   Scenario: Calling 'commits' for Github::Repos with per_page param
-    Given I have "Github::Repos" instance
-    When I am looking for "commits" with the following params:
+    Given I have "Github::Repos::Commits" instance
+    When I am looking for "list" with the following params:
       | user          | repo   |
       | peter-murach  | github |
-    And I pass the following request options:
-      | per_page |
-      | 45       |
-    And I make request within a cassette named "pagination/repos/commits"
+      And I pass the following request options:
+        | per_page |
+        | 45       |
+      And I make request within a cassette named "pagination/repos/commits/list"
     Then the response should be "200"
-    And the response type should be "JSON"
-    And the response should have 45 items
+      And the response type should be "JSON"
+      And the response should have 45 items
 
     When I request "next" page within a cassette named "pagination/repos/commits/next"
     Then the response should be "200"
-    And the response should have 45 items
+      And the response should have 45 items
 
-  Scenario: Calling 'commits' for Github::Repos returns different collections
-    Given I have "Github::Repos" instance
-    When I am looking for "commits" with the following params:
+  Scenario: Calling 'list' for Github::Repos::Commits returns different collections
+    Given I have "Github::Repos::Commits" instance
+    When I am looking for "list" with the following params:
       | user          | repo   |
       | peter-murach  | github |
-    And I make request within a cassette named "pagination/repos/commits/sha"
+      And I make request within a cassette named "pagination/repos/commits/sha"
     Then the response should be "200"
-    And the response should have 30 items
+      And the response should have 30 items
 
     When I request "next" page within a cassette named "pagination/repos/commits/sha/next"
     Then the response should be "200"
-    And the response should have 30 items
-    And the response collection of resources is different for "sha" attribute
+      And the response should have 30 items
+      And the response collection of resources is different for "sha" attribute
 
   Scenario: Requesting resources with per_page helper
     Given I have "Github::Repos" instance
-    When I am looking for "repos"
-    And I pass the following request options:
-      | user   |
-      | wycats |
-    And I make request within a cassette named "pagination/repos/per_page/first"
+    When I want to list resources
+      And I pass the following request options:
+        | user   |
+        | wycats |
+      And I make request within a cassette named "pagination/repos/per_page/first"
     Then the response should be "200"
     When I iterate through collection pages within a cassette named "pagination/repos/per_page/each_page"
     Then this collection should include first page
+

data/features/repos.feature

@@ -23,10 +23,10 @@ Feature: Accessing Repos Main API
       And the response type should be "JSON"
 
   Scenario: Returning all repositories for the user
-    When I am looking for "list_repos"
+    When I want to list resources
       And I pass the following request options:
         | user          |
         | peter-murach  |
-      And I make request within a cassette named "repos/tags"
+      And I make request within a cassette named "repos/list"
     Then the response should be "200"
       And the response type should be "JSON"

data/features/step_definitions/common_steps.rb

@@ -10,6 +10,18 @@ Then /^the response should be "([^"]*)"$/ do |expected_response|
   @response.status.should eql expected_response.to_i
 end
 
+Then /^the response should equal (.*)$/ do |expected_response|
+  expected = case expected_response
+  when /t/
+    true
+  when /f/
+    false
+  else
+    raise ArgumentError 'Expected boolean type!'
+  end
+  @response.should == expected
+end
+
 Then /^the response type should be "([^"]*)"$/ do |type|
   @response.content_type.should =~ /application\/#{type.downcase}/
 end

data/features/step_definitions/github_api_steps.rb

@@ -10,14 +10,25 @@ When /^I fetch "([^"]*)"$/ do |method|
   @response = @github.send(method.to_sym)
 end
 
+When /^I call (.*)$/ do |api_part|
+  @response = @instance.send(api_part.to_sym)
+end
+
 When /^I will have access to "([^"]*)" API$/ do |api|
   @response.class.to_s.should match api
 end
 
-When /^I am looking for "([^"]*)"$/ do |method|
+When /^I want to (.*) (?:resource|resources)$/ do |method|
   @method = method
 end
 
+When /^I want to (.*) (?:resource|resources) with the following params:$/ do |method, table|
+  table.hashes.each do |attributes|
+    @method = method.to_sym
+    @attributes = attributes
+  end
+end
+
 When /^I pass the following request options:$/ do |table|
   table.hashes.each do |options|
     @options = options

data/lib/github_api.rb

@@ -81,7 +81,7 @@ module Github
     :PageLinks    => 'page_links',
     :PageIterator => 'page_iterator',
     :PagedRequest => 'paged_request',
-    :Validation   => 'validation',
+    :Validations  => 'validations',
     :Filter       => 'filter'
 
 end # Github

data/lib/github_api/api.rb

@@ -2,7 +2,7 @@
 
 require 'github_api/configuration'
 require 'github_api/connection'
-require 'github_api/validation'
+require 'github_api/validations'
 require 'github_api/request'
 require 'github_api/mime_type'
 require 'github_api/core_ext/hash'
@@ -19,9 +19,11 @@ module Github
     include MimeType
     include Connection
     include Request
-    include Validation
+    # TODO Validation & Filter will be optional
+    include Validations
     include Filter
 
+
     attr_reader *Configuration::VALID_OPTIONS_KEYS
     attr_accessor *VALID_API_KEYS