github_api 0.5.3 → 0.5.4

data/features/gists.feature

@@ -1,12 +1,10 @@
-Feature: Accessing Gists Main API
-  In order to interact with github gists
-  GithubAPI gem
-  Should return the expected results depending on passed parameters
+Feature: Gists API
 
   Background:
     Given I have "Github::Gists" instance
 
-  Scenario: Lists all user's gists
+  Scenario: List all user's gists
+
     Given I want to list resources
       And I pass the following request options:
         | user          |
@@ -14,24 +12,63 @@ Feature: Accessing Gists Main API
     When I make request within a cassette named "gists/gists/user_all"
     Then the response status should be 200
       And the response type should be JSON
+      And the response should not be empty
+
+  Scenario: List public gists
 
-  Scenario: Lists all public gists
     Given I want to list resources
     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
 
+  Scenario: List starred gists
+
+    Given I want starred resources
+    When I make request within a cassette named "gists/gists/starred"
+    Then the response status should be 200
+      And the response type should be JSON
+
   Scenario: Gets a single gist
+
     Given I want to get resource with the following params:
       | gist_id |
       | 1738161 |
     When I make request within a cassette named "gists/gist"
     Then the response status should be 200
       And the response type should be JSON
+      And the response should not be empty
 
   Scenario: Check if gist is starred
+
     Given I want to starred? resource with the following params:
       | gist_id |
       | 1738161 |
     When I make request within a cassette named "gists/starred"
     Then the response should equal false
+
+  Scenario: Start gist
+
+    Given I want to star resource with the following params:
+      | gist_id |
+      | 2900588 |
+    When I make request within a cassette named "gists/star"
+    Then the response status should be 204
+
+  Scenario: Unstart gist
+
+    Given I want to unstar resource with the following params:
+      | gist_id |
+      | 2900588 |
+    When I make request within a cassette named "gists/unstar"
+    Then the response status should be 204
+
+  Scenario: Fork gist
+
+    Given I want to fork resource with the following params:
+      | gist_id |
+      | 2900588 |
+    When I make request within a cassette named "gists/fork"
+    Then the response status should be 201
+      And the response type should be JSON
+      And the response should not be empty
+

data/features/orgs.feature

@@ -0,0 +1,32 @@
+Feature: Organizations API
+
+  Background:
+    Given I have "Github::Orgs" instance
+
+  Scenario: List for the user
+
+    Given I want to list resources
+      And I pass the following request options:
+        | user   |
+        | wycats |
+    When I make request within a cassette named "orgs/list/user"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty
+
+  Scenario: List for the authenticated user
+
+    Given I want to list resources
+    When I make request within a cassette named "orgs/list/oauth_user"
+    Then the response status should be 200
+      And the response type should be JSON
+
+  Scenario: Get
+
+    Given I want to get resource with the following params:
+      | org_name |
+      | github   |
+    When I make request within a cassette named "orgs/get"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty

data/features/pagination.feature

@@ -1,4 +1,4 @@
-Feature: Githu API pagination
+Feature: Github API pagination
 
   The gem permits to paginate resources.
 

data/features/repos.feature

@@ -1,30 +1,30 @@
-Feature: Accessing Repos Main API
-  In order to interact with github repositories
-  GithubAPI gem
-  Should return the expected results depending on passed parameters
+Feature: Repositories API
 
   Background:
     Given I have "Github::Repos" instance
 
-  Scenario: Returning all repository branches
-    When I am looking for "branches" with the following params:
+  Scenario: Branches
+
+    Given I want branches resource with the following params:
       | user          | repo   |
       | peter-murach  | github |
-      And I make request within a cassette named "repos/branches"
+    When I make request within a cassette named "repos/branches"
     Then the response status should be 200
       And the response type should be JSON
       And the response should not be empty
 
-  Scenario: Returning all repository tags
-    When I am looking for "tags" with the following params:
+  Scenario: Tags
+
+    Given I want tags resource with the following params:
       | user          | repo   |
       | peter-murach  | github |
-      And I make request within a cassette named "repos/tags"
+    When I make request within a cassette named "repos/tags"
     Then the response status should be 200
       And the response type should be JSON
       And the response should not be empty
 
-  Scenario: Returning all repositories for the user
+  Scenario: All repositories for the user
+
     Given I want to list resources
       And I pass the following request options:
         | user          |
@@ -35,6 +35,7 @@ Feature: Accessing Repos Main API
       And the response should not be empty
 
   Scenario: Get a repository
+
     Given I want to get resource with the following params:
       | user   | repo |
       | wycats | thor |
@@ -43,15 +44,18 @@ Feature: Accessing Repos Main API
       And the response type should be JSON
       And the response should not be empty
 
-  Scenario: Listing repository languages
-    When I am looking for "languages" with the following params:
+  Scenario: Languages
+
+    Given I want languages resource with the following params:
       | user          | repo   |
       | peter-murach  | github |
-      And I make request within a cassette named "repos/languages"
+    When I make request within a cassette named "repos/languages"
     Then the response status should be 200
       And the response type should be JSON
+      And the response should not be empty
 
   Scenario: Create repository
+
     Given I want to create resource
       And I pass the following request options:
         | name            |
@@ -60,3 +64,4 @@ Feature: Accessing Repos Main API
     Then the response status should be 201
       And the response type should be JSON
       And the response should not be empty
+

data/features/step_definitions/github_api_steps.rb

@@ -30,11 +30,11 @@ When /^I will have access to "([^"]*)" API$/ do |api|
   @response.class.to_s.should match api
 end
 
-When /^I want to (.*) (?:resource|resources)$/ 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|
+When /^I want(?: to|) (.*) (?:resource|resources) with the following params:$/ do |method, table|
   table.hashes.each do |attributes|
     @method = method.to_sym
     @attributes = attributes

data/lib/github_api/core_ext/array.rb

@@ -10,4 +10,8 @@ class Array # :nodoc:
     copy
   end unless method_defined?(:except!)
 
+  def extract_options!
+    last.is_a?(::Hash) ? pop : {}
+  end
+
 end # Array

data/lib/github_api/issues/labels.rb

@@ -129,7 +129,7 @@ module Github
     #  github.issues.labels.add 'user-name', 'repo-name', 'issue-id', 'label1', 'label2', ...
     #
     def add(user_name, repo_name, issue_id, *args)
-      params = args.last.is_a?(Hash) ? args.pop : {}
+      params = args.extract_options!
       params['data'] = args unless args.empty?
 
       _update_user_repo_params(user_name, repo_name)
@@ -174,7 +174,7 @@ module Github
     #  github.issues.labels.replace 'user-name', 'repo-name', 'issue-id', 'label1', 'label2', ...
     #
     def replace(user_name, repo_name, issue_id, *args)
-      params = args.last.is_a?(Hash) ? args.pop : {}
+      params = args.extract_options!
       params['data'] = args unless args.empty?
 
       _update_user_repo_params(user_name, repo_name)

data/lib/github_api/orgs.rb

@@ -34,21 +34,22 @@ module Github
     # List all public organizations for a user.
     #
     # = Examples
-    #  github = Github.new :user => 'user-name'
-    #  github.orgs.list
+    #  github = Github.new
+    #  github.orgs.list user: 'user-name'
     #
     # List public and private organizations for the authenticated user.
     #
-    #  github = Github.new :oauth_token => '..'
-    #  github.orgs.list 'github'
+    #  github = Github.new oauth_token: '..'
+    #  github.orgs.list
     #
-    def list(user_name=nil, params={})
-      _update_user_repo_params(user_name)
+    def list(*args)
+      params = args.extract_options!
       _normalize_params_keys(params)
 
-      response = if user?
-        get_request("/users/#{user}/orgs", params)
+      response = if (user_name = params.delete("user"))
+        get_request("/users/#{user_name}/orgs", params)
       else
+        # For the authenticated user
         get_request("/user/orgs", params)
       end
       return response unless block_given?

data/lib/github_api/orgs/teams.rb

@@ -209,8 +209,11 @@ module Github
     alias :team_repository? :team_repo?
 
     # Add a team repository
+    #
     # In order to add a repo to a team, the authenticated user must be
-    # an owner of the org that the team is associated with.
+    # an owner of the org that the team is associated with. Also, the repo
+    # must be owned by the organization, or a direct for of a repo owned
+    # by the organization.
     #
     # = Examples
     #  github = Github.new :oauth_token => '...'
@@ -224,8 +227,9 @@ module Github
     alias :add_repository :add_repo
 
     # Remove a team repository
+    #
     # In order to add a repo to a team, the authenticated user must be
-    # an owner of the org that the team is associated with. 
+    # an owner of the org that the team is associated with.
     # note: This does not delete the repo, it just removes it from the team.
     #
     # = Examples

data/lib/github_api/repos.rb

@@ -133,7 +133,7 @@ module Github
     #   github.repos.create :name => 'repo-name', :org => 'organisation-name'
     #
     def create(*args)
-      params = args.last.is_a?(Hash) ? args.pop : {}
+      params = args.extract_options!
       _normalize_params_keys(params)
       _filter_params_keys(VALID_REPO_OPTIONS + %w[ org ], params)
 
@@ -264,7 +264,7 @@ module Github
     #  github.repos.list :org => 'org-name', { |repo| ... }
     #
     def list(*args)
-      params = args.last.is_a?(Hash) ? args.pop : {}
+      params = args.extract_options!
       _normalize_params_keys(params)
       _merge_user_into_params!(params) unless params.has_key?('user')
       _filter_params_keys(%w[ org user type ], params)

data/lib/github_api/repos/watching.rb

@@ -33,7 +33,7 @@ module Github
     #  github.repos.watching.watched
     #
     def watched(*args)
-      params = args.last.is_a?(Hash) ? args.pop : {}
+      params = args.extract_options!
       _normalize_params_keys(params)
       _merge_user_into_params!(params) unless params.has_key?('user')
 

data/lib/github_api/request.rb

@@ -1,9 +1,5 @@
 # encoding: utf-8
 
-require 'base64'
-require 'addressable/uri'
-require 'multi_json'
-
 module Github
   # Defines HTTP verbs
   module Request
@@ -64,18 +60,5 @@ module Github
       options['mime_type'] = params['resource'] ? params.delete('mime_type') : ''
     end
 
-    # no need for this smizzle
-    def formatted_path(path, options={})
-      [ path, options.fetch(:format, format) ].compact.join('.')
-    end
-
-    def basic_auth(login, password) # :nodoc:
-      auth = Base64.encode("#{login}:#{password}")
-      auth.gsub!("\n", "")
-    end
-
-    def token_auth
-    end
-
   end # Request
 end # Github

data/lib/github_api/request/basic_auth.rb

@@ -17,7 +17,7 @@ module Github
       def initialize(app, *args)
         @app = app
         credentials = ""
-        options = args.last.is_a?(Hash) ? args.pop : {}
+        options = args.extract_options!
         if options.has_key? :login
           credentials = "#{options[:login]}:#{options[:password]}"
         elsif options.has_key? :basic_auth

data/lib/github_api/version.rb

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

data/spec/github/orgs_spec.rb

@@ -24,29 +24,29 @@ describe Github::Orgs do
       end
 
       it "should get the resources" do
-        github.orgs.list user
+        github.orgs.list :user => user
         a_get("/users/#{user}/orgs").should have_been_made
       end
 
       it "should return array of resources" do
-        orgs = github.orgs.list user
+        orgs = github.orgs.list :user => user
         orgs.should be_an Array
         orgs.should have(1).items
       end
 
       it "should be a mash type" do
-        orgs = github.orgs.list user
+        orgs = github.orgs.list :user => user
         orgs.first.should be_a Hashie::Mash
       end
 
       it "should get org information" do
-        orgs = github.orgs.list user
+        orgs = github.orgs.list :user => user
         orgs.first.login.should == 'github'
       end
 
       it "should yield to a block" do
-        github.orgs.should_receive(:list).with(user).and_yield('web')
-        github.orgs.list(user) { |param| 'web' }
+        github.orgs.should_receive(:list).with(:user => user).and_yield('web')
+        github.orgs.list(:user => user) { |param| 'web' }
       end
     end
 
@@ -76,7 +76,7 @@ describe Github::Orgs do
 
       it "should return 404 with a message 'Not Found'" do
         expect {
-          github.orgs.list user
+          github.orgs.list :user => user
         }.to raise_error(Github::Error::NotFound)
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github_api
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-06 00:00:00.000000000Z
+date: 2012-06-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &2154417660 !ruby/object:Gem::Requirement
+  requirement: &2154258300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *2154417660
+  version_requirements: *2154258300
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &2154417160 !ruby/object:Gem::Requirement
+  requirement: &2154257800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.8.0
   type: :runtime
   prerelease: false
-  version_requirements: *2154417160
+  version_requirements: *2154257800
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &2154416700 !ruby/object:Gem::Requirement
+  requirement: &2154257340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *2154416700
+  version_requirements: *2154257340
 - !ruby/object:Gem::Dependency
   name: oauth2
-  requirement: &2154416240 !ruby/object:Gem::Requirement
+  requirement: &2154256880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '0.7'
   type: :runtime
   prerelease: false
-  version_requirements: *2154416240
+  version_requirements: *2154256880
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2154415780 !ruby/object:Gem::Requirement
+  requirement: &2154256420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.5.2
   type: :runtime
   prerelease: false
-  version_requirements: *2154415780
+  version_requirements: *2154256420
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2154435800 !ruby/object:Gem::Requirement
+  requirement: &2154272320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154435800
+  version_requirements: *2154272320
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &2154435340 !ruby/object:Gem::Requirement
+  requirement: &2154271860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154435340
+  version_requirements: *2154271860
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &2154434880 !ruby/object:Gem::Requirement
+  requirement: &2154271400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: 1.1.0
   type: :development
   prerelease: false
-  version_requirements: *2154434880
+  version_requirements: *2154271400
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &2154434420 !ruby/object:Gem::Requirement
+  requirement: &2154270940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +109,10 @@ dependencies:
         version: 1.8.0
   type: :development
   prerelease: false
-  version_requirements: *2154434420
+  version_requirements: *2154270940
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &2154433960 !ruby/object:Gem::Requirement
+  requirement: &2154270480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +120,10 @@ dependencies:
         version: 2.2.0
   type: :development
   prerelease: false
-  version_requirements: *2154433960
+  version_requirements: *2154270480
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2154433500 !ruby/object:Gem::Requirement
+  requirement: &2154270020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,10 +131,10 @@ dependencies:
         version: 0.6.1
   type: :development
   prerelease: false
-  version_requirements: *2154433500
+  version_requirements: *2154270020
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &2154433120 !ruby/object:Gem::Requirement
+  requirement: &2154269640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +142,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154433120
+  version_requirements: *2154269640
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2154432660 !ruby/object:Gem::Requirement
+  requirement: &2154269180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,10 +153,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154432660
+  version_requirements: *2154269180
 - !ruby/object:Gem::Dependency
   name: guard-cucumber
-  requirement: &2154432240 !ruby/object:Gem::Requirement
+  requirement: &2154268760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -164,10 +164,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154432240
+  version_requirements: *2154268760
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2154431820 !ruby/object:Gem::Requirement
+  requirement: &2154268340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -175,10 +175,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154431820
+  version_requirements: *2154268340
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2154431400 !ruby/object:Gem::Requirement
+  requirement: &2154267920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -186,7 +186,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154431400
+  version_requirements: *2154267920
 description: ! ' Ruby wrapper that supports all of the GitHub API v3 methods(nearly
   200). It''s build in a modular way, that is, you can either instantiate the whole
   api wrapper Github.new or use parts of it e.i. Github::Repos.new if working solely
@@ -198,15 +198,30 @@ extra_rdoc_files: []
 files:
 - Rakefile
 - features/cassettes/errors/repos/create.yml
+- features/cassettes/events/issue.yml
+- features/cassettes/events/network.yml
+- features/cassettes/events/org.yml
+- features/cassettes/events/performed.yml
+- features/cassettes/events/public.yml
+- features/cassettes/events/received.yml
+- features/cassettes/events/repo.yml
+- features/cassettes/events/user_org.yml
 - features/cassettes/gists/comments/all.yml
 - features/cassettes/gists/comments/first.yml
+- features/cassettes/gists/fork.yml
 - features/cassettes/gists/gist.yml
 - features/cassettes/gists/gists/public_all.yml
+- features/cassettes/gists/gists/starred.yml
 - features/cassettes/gists/gists/user_all.yml
+- features/cassettes/gists/star.yml
 - features/cassettes/gists/starred.yml
+- features/cassettes/gists/unstar.yml
 - features/cassettes/git_data/references/all.yml
 - features/cassettes/git_data/references/all_tags.yml
 - features/cassettes/git_data/references/one.yml
+- features/cassettes/orgs/get.yml
+- features/cassettes/orgs/list/oauth_user.yml
+- features/cassettes/orgs/list/user.yml
 - features/cassettes/pagination/issues/list/first.yml
 - features/cassettes/pagination/issues/list/last.yml
 - features/cassettes/pagination/issues/list/next.yml
@@ -232,11 +247,13 @@ files:
 - features/cassettes/users/emails/all.yml
 - features/cassettes/users/emails/delete.yml
 - features/error_codes.feature
+- features/events.feature
 - features/gists/comments.feature
 - features/gists.feature
 - features/git_data/references.feature
 - features/github_api.feature
 - features/options.feature
+- features/orgs.feature
 - features/pagination.feature
 - features/README.rdoc
 - features/repos.feature
@@ -475,7 +492,7 @@ files:
 homepage: https://github.com/peter-murach/github
 licenses: []
 post_install_message: ! "\n--------------------------------------------------------------------------------\nThank
-  you for installing github_api-0.5.3.\n\n*NOTE*: Version 0.5.0 introduces breaking
+  you for installing github_api-0.5.4.\n\n*NOTE*: Version 0.5.0 introduces breaking
   changes to the way github api is queried.\nThe interface has been rewritten to be
   more consistent with REST verbs that\ninteract with GitHub hypermedia resources.
   Thus, to list resources 'list' or 'all'\nverbs are used, to retrieve individual