octokit 3.1.2 → 3.2.0

data/lib/octokit/client/organizations.rb

@@ -8,7 +8,7 @@ module Octokit
 
       # Get an organization
       #
-      # @param org [String] Organization GitHub username.
+      # @param org [String, Integer] Organization GitHub login or id.
       # @return [Sawyer::Resource] Hash representing GitHub organization.
       # @see https://developer.github.com/v3/orgs/#get-an-organization
       # @example
@@ -16,7 +16,7 @@ module Octokit
       # @example
       #   Octokit.org('github')
       def organization(org, options = {})
-        get "orgs/#{org}", options
+        get Organization.path(org), options
       end
       alias :org :organization
 
@@ -24,7 +24,7 @@ module Octokit
       #
       # Requires authenticated client with proper organization permissions.
       #
-      # @param org [String] Organization GitHub username.
+      # @param org [String, Integer] Organization GitHub login or id.
       # @param values [Hash] The updated organization attributes.
       # @option values [String] :billing_email Billing email address. This address is not publicized.
       # @option values [String] :company Company name.
@@ -44,7 +44,7 @@ module Octokit
       # @example
       #   @client.update_org('github', {:company => 'Unicorns, Inc.'})
       def update_organization(org, values, options = {})
-        patch "orgs/#{org}", options.merge({:organization => values})
+        patch Organization.path(org), options.merge({:organization => values})
       end
       alias :update_org :update_organization
 
@@ -59,7 +59,8 @@ module Octokit
       # Calling this method on a `@client` will return that users organizations.
       # Private organizations are included only if the `@client` is authenticated.
       #
-      # @param user [String] Username of the user to get list of organizations.
+      # @param user [Integer, String] GitHub user login or id of the user to get
+      #   list of organizations.
       # @return [Array<Sawyer::Resource>] Array of hashes representing organizations.
       # @see https://developer.github.com/v3/orgs/#list-user-organizations
       # @example
@@ -75,11 +76,7 @@ module Octokit
       # @example
       #   @client.organizations
       def organizations(user=nil, options = {})
-        if user
-          get "users/#{user}/orgs", options
-        else
-          get "user/orgs", options
-        end
+        get "#{User.path user}/orgs", options
       end
       alias :list_organizations :organizations
       alias :list_orgs :organizations
@@ -90,7 +87,8 @@ module Octokit
       # Public repositories are available without authentication. Private repos
       # require authenticated organization member.
       #
-      # @param org [String] Organization handle for which to list repos
+      # @param org [String, Integer] Organization GitHub login or id for which
+      #   to list repos.
       # @option options [String] :type ('all') Filter by repository type.
       #   `all`, `public`, `member`, `sources`, `forks`, or `private`.
       #
@@ -105,7 +103,7 @@ module Octokit
       # @example
       #   @client.org_repos('github', {:type => 'private'})
       def organization_repositories(org, options = {})
-        paginate "orgs/#{org}/repos", options
+        paginate "#{Organization.path org}/repos", options
       end
       alias :org_repositories :organization_repositories
       alias :org_repos :organization_repositories
@@ -116,7 +114,7 @@ module Octokit
       # authenticated client that is a member of the GitHub organization
       # is required to get private members.
       #
-      # @param org [String] Organization GitHub username.
+      # @param org [String, Integer] Organization GitHub login or id.
       # @return [Array<Sawyer::Resource>] Array of hashes representing users.
       # @see https://developer.github.com/v3/orgs/members/#members-list
       # @example
@@ -125,7 +123,7 @@ module Octokit
       #   Octokit.org_members('github')
       def organization_members(org, options = {})
         path = "public_" if options.delete(:public)
-        paginate "orgs/#{org}/#{path}members", options
+        paginate "#{Organization.path org}/#{path}members", options
       end
       alias :org_members :organization_members
 
@@ -151,7 +149,7 @@ module Octokit
       # you are a member. If you are not in the organization you are checking,
       # use .organization_public_member? instead.
       #
-      # @param org [String] Organization GitHub username.
+      # @param org [String, Integer] Organization GitHub login or id.
       # @param user [String] GitHub username of the user to check.
       #
       # @return [Boolean] Is a member?
@@ -162,7 +160,7 @@ module Octokit
       #   @client.organization_member?('your_organization', 'pengwynn')
       #   => false
       def organization_member?(org, user, options = {})
-        result = boolean_from_response(:get, "orgs/#{org}/members/#{user}", options)
+        result = boolean_from_response(:get, "#{Organization.path org}/members/#{user}", options)
         if !result && last_response && last_response.status == 302
           boolean_from_response :get, last_response.headers['Location']
         else
@@ -176,7 +174,7 @@ module Octokit
       # If you are checking for membership of a user of an organization that
       # you are in, use .organization_member? instead.
       #
-      # @param org [String] Organization GitHub username.
+      # @param org [String, Integer] Organization GitHub login or id.
       # @param user [String] GitHub username of the user to check.
       #
       # @return [Boolean] Is a public member?
@@ -187,7 +185,7 @@ module Octokit
       #   @client.organization_public_member?('github', 'pengwynn')
       #   => true
       def organization_public_member?(org, user, options = {})
-        boolean_from_response :get, "orgs/#{org}/public_members/#{user}", options
+        boolean_from_response :get, "#{Organization.path org}/public_members/#{user}", options
       end
       alias :org_public_member? :organization_public_member?
 
@@ -195,7 +193,7 @@ module Octokit
       #
       # Requires authenticated organization member.
       #
-      # @param org [String] Organization GitHub username.
+      # @param org [String, Integer] Organization GitHub login or id.
       # @return [Array<Sawyer::Resource>] Array of hashes representing teams.
       # @see https://developer.github.com/v3/orgs/teams/#list-teams
       # @example
@@ -203,7 +201,7 @@ module Octokit
       # @example
       #   @client.org_teams('github')
       def organization_teams(org, options = {})
-        paginate "orgs/#{org}/teams", options
+        paginate "#{Organization.path org}/teams", options
       end
       alias :org_teams :organization_teams
 
@@ -211,7 +209,7 @@ module Octokit
       #
       # Requires authenticated organization owner.
       #
-      # @param org [String] Organization GitHub username.
+      # @param org [String, Integer] Organization GitHub login or id.
       # @option options [String] :name Team name.
       # @option options [Array<String>] :repo_names Repositories for the team.
       # @option options [String, optional] :permission ('pull') Permissions the
@@ -229,7 +227,7 @@ module Octokit
       #     :permission => 'push'
       #   })
       def create_team(org, options = {})
-        post "orgs/#{org}/teams", options
+        post "#{Organization.path org}/teams", options
       end
 
       # Get team
@@ -422,7 +420,7 @@ module Octokit
       #
       # Requires authenticated organization owner or member with team `admin` access.
       #
-      # @param org [String] Organization GitHub username.
+      # @param org [String, Integer] Organization GitHub login or id.
       # @param user [String] GitHub username of user to remove.
       # @return [Boolean] True if removal is successful, false otherwise.
       # @see https://developer.github.com/v3/orgs/members/#remove-a-member
@@ -433,7 +431,7 @@ module Octokit
       def remove_organization_member(org, user, options = {})
         # this is a synonym for: for team in org.teams: remove_team_member(team.id, user)
         # provided in the GH API v3
-        boolean_from_response :delete, "orgs/#{org}/members/#{user}", options
+        boolean_from_response :delete, "#{Organization.path org}/members/#{user}", options
       end
       alias :remove_org_member :remove_organization_member
 
@@ -441,21 +439,21 @@ module Octokit
       #
       # Requires authenticated organization owner.
       #
-      # @param org [String] Organization GitHub username.
+      # @param org [String, Integer] Organization GitHub login or id.
       # @param user [String] GitHub username of user to publicize.
       # @return [Boolean] True if publicization successful, false otherwise.
       # @see https://developer.github.com/v3/orgs/members/#publicize-a-users-membership
       # @example
       #   @client.publicize_membership('github', 'pengwynn')
       def publicize_membership(org, user, options = {})
-        boolean_from_response :put, "orgs/#{org}/public_members/#{user}", options
+        boolean_from_response :put, "#{Organization.path org}/public_members/#{user}", options
       end
 
       # Conceal a user's membership of an organization.
       #
       # Requires authenticated organization owner.
       #
-      # @param org [String] Organization GitHub username.
+      # @param org [String, Integer] Organization GitHub login or id.
       # @param user [String] GitHub username of user to unpublicize.
       # @return [Boolean] True of unpublicization successful, false otherwise.
       # @see https://developer.github.com/v3/orgs/members/#conceal-a-users-membership
@@ -464,7 +462,7 @@ module Octokit
       # @example
       #   @client.conceal_membership('github', 'pengwynn')
       def unpublicize_membership(org, user, options = {})
-        boolean_from_response :delete, "orgs/#{org}/public_members/#{user}", options
+        boolean_from_response :delete, "#{Organization.path org}/public_members/#{user}", options
       end
       alias :conceal_membership :unpublicize_membership
 

data/lib/octokit/client/pages.rb

@@ -8,30 +8,30 @@ module Octokit
 
       # List Pages information for a repository
       #
-      # @param repo [String, Repository, Hash] A GitHub repository
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
       # @return Sawyer::Resource A GitHub Pages resource
       # @see https://developer.github.com/v3/repos/pages/#get-information-about-a-pages-site
       def pages(repo, options = {})
-        get "repos/#{Repository.new(repo)}/pages", options
+        get "#{Repository.path repo}/pages", options
       end
 
       # List Pages builds for a repository
       #
-      # @param repo [String, Repository, Hash] A GitHub repository
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
       # @return [Array<Sawyer::Resource>] A list of build history for a repository.
       # @see https://developer.github.com/v3/repos/pages/#list-pages-builds
       def pages_builds(repo, options = {})
-        get "repos/#{Repository.new(repo)}/pages/builds", options
+        get "#{Repository.path repo}/pages/builds", options
       end
       alias :list_pages_builds :pages_builds
 
       # List the latest Pages build information for a repository
       #
-      # @param repo [String, Repository, Hash] A GitHub repository
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
       # @return Sawyer::Resource A GitHub Pages resource about a build
       # @see https://developer.github.com/v3/repos/pages/#list-latest-pages-build
       def latest_pages_build(repo, options = {})
-        get "repos/#{Repository.new(repo)}/pages/builds/latest", options
+        get "#{Repository.path repo}/pages/builds/latest", options
       end
     end
   end

data/lib/octokit/client/pull_requests.rb

@@ -9,12 +9,12 @@ module Octokit
       # List pull requests for a repository
       #
       # @overload pull_requests(repo, options)
-      #   @param repo [String, Hash, Repository] A GitHub repository
+      #   @param repo [Integer, String, Hash, Repository] A GitHub repository
       #   @param options [Hash] Method options
       #   @option options [String] :state `open` or `closed`.
       # @overload pull_requests(repo, state, options)
       #   @deprecated
-      #   @param repo [String, Hash, Repository] A GitHub repository
+      #   @param repo [Integer, String, Hash, Repository] A GitHub repository
       #   @param state [String] `open` or `closed`.
       #   @param options [Hash] Method options
       # @return [Array<Sawyer::Resource>] Array of pulls
@@ -29,25 +29,25 @@ module Octokit
           octokit_warn "DEPRECATED: Client#pull_requests: Passing state as positional argument is deprecated. Please use :state => '#{state}'"
           opts[:state] = state if state
         end
-        paginate "repos/#{Repository.new(repo)}/pulls", opts
+        paginate "#{Repository.path repo}/pulls", opts
       end
       alias :pulls :pull_requests
 
       # Get a pull request
       #
       # @see https://developer.github.com/v3/pulls/#get-a-single-pull-request
-      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @param number [Integer] Number of the pull request to fetch
       # @return [Sawyer::Resource] Pull request info
       def pull_request(repo, number, options = {})
-        get "repos/#{Repository.new(repo)}/pulls/#{number}", options
+        get "#{Repository.path repo}/pulls/#{number}", options
       end
       alias :pull :pull_request
 
       # Create a pull request
       #
       # @see https://developer.github.com/v3/pulls/#create-a-pull-request
-      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @param base [String] The branch (or git ref) you want your changes
       #                      pulled into. This should be an existing branch on the current
       #                      repository. You cannot submit a pull request to one repo that requests
@@ -63,13 +63,13 @@ module Octokit
           :title => title,
           :body  => body,
         }
-        post "repos/#{Repository.new(repo)}/pulls", options.merge(pull)
+        post "#{Repository.path repo}/pulls", options.merge(pull)
       end
 
       # Create a pull request from existing issue
       #
       # @see https://developer.github.com/v3/pulls/#alternative-input
-      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @param base [String] The branch (or git ref) you want your changes
       #                      pulled into. This should be an existing branch on the current
       #                      repository. You cannot submit a pull request to one repo that requests
@@ -83,19 +83,19 @@ module Octokit
           :head  => head,
           :issue => issue
         }
-        post "repos/#{Repository.new(repo)}/pulls", options.merge(pull)
+        post "#{Repository.path repo}/pulls", options.merge(pull)
       end
 
       # Update a pull request
       # @overload update_pull_request(repo, id, title=nil, body=nil, state=nil, options = {})
       #   @deprecated
-      #   @param repo [String, Hash, Repository] A GitHub repository.
+      #   @param repo [Integer, String, Hash, Repository] A GitHub repository.
       #   @param number [Integer] Number of pull request to update.
       #   @param title [String] Title for the pull request.
       #   @param body [String] Body content for pull request. Supports GFM.
       #   @param state [String] State of the pull request. `open` or `closed`.
       # @overload update_pull_request(repo, id,  options = {})
-      #   @param repo [String, Hash, Repository] A GitHub repository.
+      #   @param repo [Integer, String, Hash, Repository] A GitHub repository.
       #   @param number [Integer] Number of pull request to update.
       #   @option options [String] :title Title for the pull request.
       #   @option options [String] :body Body for the pull request.
@@ -112,12 +112,12 @@ module Octokit
         arguments = Octokit::Arguments.new(args)
         repo   = arguments.shift
         number = arguments.shift
-        patch "repos/#{Repository.new(repo)}/pulls/#{number}", arguments.options
+        patch "#{Repository.path repo}/pulls/#{number}", arguments.options
       end
 
       # Close a pull request
       #
-      # @param repo [String, Hash, Repository] A GitHub repository.
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
       # @param number [Integer] Number of pull request to update.
       # @return [Sawyer::Resource] Hash representing updated pull request.
       # @see https://developer.github.com/v3/pulls/#update-a-pull-request
@@ -131,11 +131,11 @@ module Octokit
       # List commits on a pull request
       #
       # @see https://developer.github.com/v3/pulls/#list-commits-on-a-pull-request
-      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @param number [Integer] Number of pull request
       # @return [Array<Sawyer::Resource>] List of commits
       def pull_request_commits(repo, number, options = {})
-        paginate "repos/#{Repository.new(repo)}/pulls/#{number}/commits", options
+        paginate "#{Repository.path repo}/pulls/#{number}/commits", options
       end
       alias :pull_commits :pull_request_commits
 
@@ -143,7 +143,7 @@ module Octokit
       #
       # By default, Review Comments are ordered by ascending ID.
       #
-      # @param repo [String, Repository, Hash] A GitHub repository
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
       # @param options [Hash] Optional parameters
       # @option options [String] :sort created or updated
       # @option options [String] :direction asc or desc. Ignored without sort
@@ -165,41 +165,41 @@ module Octokit
       #     :since => '2010-05-04T23:45:02Z'
       #   })
       def pull_requests_comments(repo, options = {})
-        get("repos/#{Repository.new(repo)}/pulls/comments", options)
+        get("#{Repository.path repo}/pulls/comments", options)
       end
       alias :pulls_comments   :pull_requests_comments
       alias :reviews_comments :pull_requests_comments
 
       # List comments on a pull request
       #
-      # @see https://developer.github.com/v3/pulls/#list-comments-on-a-pull-request
-      # @param repo [String, Hash, Repository] A GitHub repository
+      # @see https://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @param number [Integer] Number of pull request
       # @return [Array<Sawyer::Resource>] List of comments
       def pull_request_comments(repo, number, options = {})
         # return the comments for a pull request
-        get "repos/#{Repository.new(repo)}/pulls/#{number}/comments", options
+        get "#{Repository.path repo}/pulls/#{number}/comments", options
       end
       alias :pull_comments   :pull_request_comments
       alias :review_comments :pull_request_comments
 
       # Get a pull request comment
       #
-      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @param comment_id [Integer] Id of comment to get
       # @return [Sawyer::Resource] Hash representing the comment
       # @see https://developer.github.com/v3/pulls/comments/#get-a-single-comment
       # @example
       #   @client.pull_request_comment("pengwynn/octkit", 1903950)
       def pull_request_comment(repo, comment_id, options = {})
-        get "repos/#{Repository.new(repo)}/pulls/comments/#{comment_id}", options
+        get "#{Repository.path repo}/pulls/comments/#{comment_id}", options
       end
       alias :pull_comment   :pull_request_comment
       alias :review_comment :pull_request_comment
 
       # Create a pull request comment
       #
-      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @param pull_id [Integer] Pull request id
       # @param body [String] Comment content
       # @param commit_id [String] Sha of the commit to comment on.
@@ -217,14 +217,14 @@ module Octokit
           :path => path,
           :position => position
         })
-        post "repos/#{Repository.new(repo)}/pulls/#{pull_id}/comments", options
+        post "#{Repository.path repo}/pulls/#{pull_id}/comments", options
       end
       alias :create_pull_comment :create_pull_request_comment
       alias :create_view_comment :create_pull_request_comment
 
       # Create reply to a pull request comment
       #
-      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @param pull_id [Integer] Pull request id
       # @param body [String] Comment contents
       # @param comment_id [Integer] Comment id to reply to
@@ -237,14 +237,14 @@ module Octokit
           :body => body,
           :in_reply_to => comment_id
         })
-        post "repos/#{Repository.new(repo)}/pulls/#{pull_id}/comments", options
+        post "#{Repository.path repo}/pulls/#{pull_id}/comments", options
       end
       alias :create_pull_reply   :create_pull_request_comment_reply
       alias :create_review_reply :create_pull_request_comment_reply
 
       # Update pull request comment
       #
-      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @param comment_id [Integer] Id of the comment to update
       # @param body [String] Updated comment content
       # @return [Sawyer::Resource] Hash representing the updated comment
@@ -253,21 +253,21 @@ module Octokit
       #   @client.update_pull_request_comment("octokit/octokit.rb", 1903950, ":shipit:")
       def update_pull_request_comment(repo, comment_id, body, options = {})
         options.merge! :body => body
-        patch("repos/#{Repository.new(repo)}/pulls/comments/#{comment_id}", options)
+        patch("#{Repository.path repo}/pulls/comments/#{comment_id}", options)
       end
       alias :update_pull_comment   :update_pull_request_comment
       alias :update_review_comment :update_pull_request_comment
 
       # Delete pull request comment
       #
-      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @param comment_id [Integer] Id of the comment to delete
       # @return [Boolean] True if deleted, false otherwise
       # @see https://developer.github.com/v3/pulls/comments/#delete-a-comment
       # @example
       #   @client.delete_pull_request_comment("octokit/octokit.rb", 1902707)
       def delete_pull_request_comment(repo, comment_id, options = {})
-        boolean_from_response(:delete, "repos/#{Repository.new(repo)}/pulls/comments/#{comment_id}", options)
+        boolean_from_response(:delete, "#{Repository.path repo}/pulls/comments/#{comment_id}", options)
       end
       alias :delete_pull_comment   :delete_pull_request_comment
       alias :delete_review_comment :delete_pull_request_comment
@@ -275,33 +275,33 @@ module Octokit
       # List files on a pull request
       #
       # @see https://developer.github.com/v3/pulls/#list-pull-requests-files
-      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @param number [Integer] Number of pull request
       # @return [Array<Sawyer::Resource>] List of files
       def pull_request_files(repo, number, options = {})
-        paginate "repos/#{Repository.new(repo)}/pulls/#{number}/files", options
+        paginate "#{Repository.path repo}/pulls/#{number}/files", options
       end
       alias :pull_files :pull_request_files
 
       # Merge a pull request
       #
       # @see https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-buttontrade
-      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @param number [Integer] Number of pull request
       # @param commit_message [String] Optional commit message for the merge commit
       # @return [Array<Sawyer::Resource>] Merge commit info if successful
       def merge_pull_request(repo, number, commit_message='', options = {})
-        put "repos/#{Repository.new(repo)}/pulls/#{number}/merge", options.merge({:commit_message => commit_message})
+        put "#{Repository.path repo}/pulls/#{number}/merge", options.merge({:commit_message => commit_message})
       end
 
       # Check pull request merge status
       #
       # @see https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged
-      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @param number [Integer] Number of pull request
       # @return [Boolean] True if the pull request has been merged
       def pull_merged?(repo, number, options = {})
-        boolean_from_response :get, "repos/#{Repository.new(repo)}/pulls/#{number}/merge", options
+        boolean_from_response :get, "#{Repository.path repo}/pulls/#{number}/merge", options
       end
       alias :pull_request_merged? :pull_merged?