octokit 3.1.2 → 3.2.0

data/lib/octokit/client/stats.rb

@@ -8,7 +8,7 @@ module Octokit
 
       # Get contributors list with additions, deletions, and commit counts
       #
-      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @return [Array<Sawyer::Resource>] Array of contributor stats
       # @see https://developer.github.com/v3/repos/statistics/#contributors
       # @example Get contributor stats for octokit
@@ -20,7 +20,7 @@ module Octokit
 
       # Get the last year of commit activity data
       #
-      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @return [Array<Sawyer::Resource>] The last year of commit activity grouped by
       #   week. The days array is a group of commits per day, starting on Sunday.
       # @see https://developer.github.com/v3/repos/statistics/#get-the-last-year-of-commit-activity-data
@@ -32,7 +32,7 @@ module Octokit
 
       # Get the number of additions and deletions per week
       #
-      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @return [Array<Sawyer::Resource>] Weekly aggregate of the number of additions
       #   and deletions pushed to a repository.
       # @see https://developer.github.com/v3/repos/statistics/#code-frequency
@@ -44,7 +44,7 @@ module Octokit
 
       # Get the weekly commit count for the repo owner and everyone else
       #
-      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @return [Sawyer::Resource] Total commit counts for the owner and total commit
       #   counts in all. all is everyone combined, including the owner in the last
       #   52 weeks. If you’d like to get the commit counts for non-owners, you can
@@ -58,7 +58,7 @@ module Octokit
 
       # Get the number of commits per hour in each day
       #
-      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @return [Array<Array>] Arrays containing the day number, hour number, and
       #   number of commits
       # @see https://developer.github.com/v3/repos/statistics/#punch-card
@@ -73,11 +73,11 @@ module Octokit
 
       # @private Get stats for a repository
       #
-      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @param metric [String] The metrics you are looking for
       # @return [Array<Sawyer::Resource>] Magical unicorn stats
       def get_stats(repo, metric, options = {})
-        data = get("repos/#{Repository.new(repo)}/stats/#{metric}", options)
+        data = get("#{Repository.path repo}/stats/#{metric}", options)
 
         last_response.status == 202 ? nil : data
       end

data/lib/octokit/client/statuses.rb

@@ -9,30 +9,30 @@ module Octokit
 
       # List all statuses for a given commit
       #
-      # @param repo [String, Repository, Hash] A GitHub repository
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
       # @param sha [String] The SHA1 for the commit
       # @return [Array<Sawyer::Resource>] A list of statuses
       # @see https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref
       def statuses(repo, sha, options = {})
-        get "repos/#{Repository.new(repo)}/statuses/#{sha}", options
+        get "#{Repository.path repo}/statuses/#{sha}", options
       end
       alias :list_statuses :statuses
 
       # Get the combined status for a ref
       #
-      # @param repo [String, Repository, Hash] a GitHub repository
+      # @param repo [Integer, String, Repository, Hash] a GitHub repository
       # @param ref  [String] A Sha or Ref to fetch the status of
       # @return [Sawyer::Resource] The combined status for the commit
       # @see https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref
       def combined_status(repo, ref, options = {})
         ensure_combined_status_api_media_type(options)
-        get "repos/#{Repository.new(repo)}/commits/#{ref}/status", options
+        get "#{Repository.path repo}/commits/#{ref}/status", options
       end
       alias :status :combined_status
 
       # Create status for a commit
       #
-      # @param repo [String, Repository, Hash] A GitHub repository
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
       # @param sha [String] The SHA1 for the commit
       # @param state [String] The state: pending, success, failure, error
       # @option options [String] :context A context to differentiate this status from others
@@ -42,7 +42,7 @@ module Octokit
       # @see https://developer.github.com/v3/repos/statuses/#create-a-status
       def create_status(repo, sha, state, options = {})
         options.merge!(:state => state)
-        post "repos/#{Repository.new(repo)}/statuses/#{sha}", options
+        post "#{Repository.path repo}/statuses/#{sha}", options
       end
 
       private

data/lib/octokit/client/users.rb

@@ -24,18 +24,14 @@ module Octokit
 
       # Get a single user
       #
-      # @param user [String] A GitHub user name.
+      # @param user [Integer, String] GitHub user login or id.
       # @return [Sawyer::Resource]
       # @see https://developer.github.com/v3/users/#get-a-single-user
       # @see https://developer.github.com/v3/users/#get-the-authenticated-user
       # @example
       #   Octokit.user("sferik")
       def user(user=nil, options = {})
-        if user
-          get "users/#{user}", options
-        else
-          get 'user', options
-        end
+        get User.path(user), options
       end
 
       # Retrieve the access_token.
@@ -92,24 +88,28 @@ module Octokit
 
       # Get a user's followers.
       #
-      # @param user [String] Username of the user whose list of followers you are getting.
-      # @return [Array<Sawyer::Resource>] Array of hashes representing users followers.
+      # @param user [Integer, String] GitHub user login or id of the user whose
+      #   list of followers you are getting.
+      # @return [Array<Sawyer::Resource>] Array of hashes representing users
+      #   followers.
       # @see https://developer.github.com/v3/users/followers/#list-followers-of-a-user
       # @example
       #   Octokit.followers('pengwynn')
       def followers(user=login, options = {})
-        paginate "users/#{user}/followers", options
+        paginate "#{User.path user}/followers", options
       end
 
       # Get list of users a user is following.
       #
-      # @param user [String] Username of the user who you are getting the list of the people they follow.
-      # @return [Array<Sawyer::Resource>] Array of hashes representing users a user is following.
+      # @param user [Intger, String] GitHub user login or id of the user who you
+      #   are getting the list of the people they follow.
+      # @return [Array<Sawyer::Resource>] Array of hashes representing users a
+      #   user is following.
       # @see https://developer.github.com/v3/users/followers/#list-users-followed-by-another-user
       # @example
       #   Octokit.following('pengwynn')
       def following(user=login, options = {})
-        paginate "users/#{user}/following", options
+        paginate "#{User.path user}/following", options
       end
 
       # Check if you are following a user. Alternatively, check if a given user
@@ -118,10 +118,11 @@ module Octokit
       # Requries an authenticated client.
       #
       # @overload follows?(target)
-      #   @param target [String] Username of the user that you want to check if you are following.
+      #   @param target [String] GitHub login of the user that you want to
+      #   check if you are following.
       # @overload follows?(user, target)
-      #   @param user [String] Username of first user
-      #   @param target [String] Username of the target user
+      #   @param user [Integer, String] GitHub user login or id of first user
+      #   @param target [String] GitHub login of the target user
       # @return [Boolean] True following target user, false otherwise.
       # @see https://developer.github.com/v3/users/followers/#check-if-you-are-following-a-user
       # @see https://developer.github.com/v3/users/followers/#check-if-one-user-follows-another
@@ -132,12 +133,7 @@ module Octokit
       def follows?(*args)
         target = args.pop
         user = args.first
-        if user.nil?
-          url = "user/following/#{target}"
-        else
-          url = "users/#{user}/following/#{target}"
-        end
-        boolean_from_response :get, url
+        boolean_from_response :get, "#{User.path user}/following/#{target}"
       end
 
       # Follow a user.
@@ -168,7 +164,8 @@ module Octokit
 
       # Get list of repos starred by a user.
       #
-      # @param user [String] Username of the user to get the list of their starred repositories.
+      # @param user [Integer, String] GitHub user login of the user to get the
+      #   list of their starred repositories.
       # @param options [Hash] Optional options
       # @option options [String] :sort (created) Sort: <tt>created</tt> or <tt>updated</tt>.
       # @option options [String] :direction (desc) Direction: <tt>asc</tt> or <tt>desc</tt>.
@@ -234,13 +231,14 @@ module Octokit
 
       # Get list of public keys for user.
       #
+      # @param user [Integer, String] GitHub user login or id.
       # @return [Array<Sawyer::Resource>] Array of hashes representing public keys.
       # @see https://developer.github.com/v3/users/keys/#list-public-keys-for-a-user
       # @example
       #   @client.user_keys('pengwynn')
       def user_keys(user, options = {})
         # TODO: Roll this into .keys
-        paginate "users/#{user}/keys", options
+        paginate "#{User.path user}/keys", options
       end
 
       # Add public key to user account.
@@ -266,7 +264,10 @@ module Octokit
       # @option options [String] :title
       # @option options [String] :key
       # @return [Sawyer::Resource] Hash representing the updated public key.
+      #
+      # @deprecated This method is no longer supported in the API
       # @see https://developer.github.com/v3/users/keys/#update-a-public-key
+      # @see https://developer.github.com/changes/2014-02-24-finer-grained-scopes-for-ssh-keys/
       # @example
       #   @client.update_key(1, :title => 'new title', :key => "ssh-rsa BBB")
       def update_key(key_id, options = {})
@@ -328,12 +329,9 @@ module Octokit
 
       # List repositories being watched by a user.
       #
-      # @param user [String] User's GitHub username.
-      #
+      # @param user [Integer, String] GitHub user login or id.
       # @return [Array<Sawyer::Resource>] Array of repositories.
-      #
       # @see https://developer.github.com/v3/activity/watching/#list-repositories-being-watched
-      #
       # @example
       #   @client.subscriptions("pengwynn")
       def subscriptions(user=login, options = {})
@@ -349,7 +347,7 @@ module Octokit
       if user == login && user_authenticated?
         "user/#{path}"
       else
-        "users/#{user}/#{path}"
+        "#{User.path user}/#{path}"
       end
     end
   end

data/lib/octokit/error.rb

@@ -17,6 +17,7 @@ module Octokit
                   when 401      then error_for_401(headers)
                   when 403      then error_for_403(body)
                   when 404      then Octokit::NotFound
+                  when 405      then Octokit::MethodNotAllowed
                   when 406      then Octokit::NotAcceptable
                   when 409      then Octokit::Conflict
                   when 415      then Octokit::UnsupportedMediaType
@@ -189,6 +190,9 @@ module Octokit
   # Raised when GitHub returns a 404 HTTP status code
   class NotFound < ClientError; end
 
+  # Raised when GitHub returns a 405 HTTP status code
+  class MethodNotAllowed < ClientError; end
+
   # Raised when GitHub returns a 406 HTTP status code
   class NotAcceptable < ClientError; end
 

data/lib/octokit/organization.rb

@@ -0,0 +1,17 @@
+module Octokit
+  # GitHub organization class to generate API path urls
+  class Organization
+    # Get the api path for an organization
+    #
+    # @param org [String, Integer] GitHub organization login or id
+    # @return [String] Organization Api path
+    def self.path org
+      case org
+      when String
+        "orgs/#{org}"
+      when Integer
+        "organizations/#{org}"
+      end
+    end
+  end
+end

data/lib/octokit/repository.rb

@@ -3,7 +3,7 @@ module Octokit
   # Class to parse GitHub repository owner and name from
   # URLs and to generate URLs
   class Repository
-    attr_accessor :owner, :name
+    attr_accessor :owner, :name, :id
 
     # Instantiate from a GitHub repository URL
     #
@@ -14,6 +14,8 @@ module Octokit
 
     def initialize(repo)
       case repo
+      when Integer
+        @id = repo
       when String
         @owner, @name = repo.split('/')
       when Repository
@@ -32,6 +34,29 @@ module Octokit
     end
     alias :to_s :slug
 
+    # @return [String] Repository API path
+    def path
+      return named_api_path if @owner && @name
+      return id_api_path if @id
+    end
+
+    # Get the api path for a repo
+    # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+    # @return [String] Api path.
+    def self.path repo
+      new(repo).path
+    end
+
+    # @return [String] Api path for owner/name identified repos
+    def named_api_path
+      "repos/#{slug}"
+    end
+
+    # @return [String] Api path for id identified repos
+    def id_api_path
+      "repositories/#{@id}"
+    end
+
     # Repository URL based on {Octokit::Client#web_endpoint}
     # @return [String]
     def url

data/lib/octokit/user.rb

@@ -0,0 +1,19 @@
+module Octokit
+  # GitHub user class to generate API path urls
+  class User
+    # Get the api path for a user
+    #
+    # @param user [String, Integer] GitHub user login or id
+    # @return [String] User Api path
+    def self.path user
+      case user
+      when String
+        "users/#{user}"
+      when Integer
+        "user/#{user}"
+      else
+        "user"
+      end
+    end
+  end
+end

data/lib/octokit/version.rb

@@ -2,6 +2,6 @@ module Octokit
 
   # Current version
   # @return [String]
-  VERSION = "3.1.2".freeze
+  VERSION = "3.2.0".freeze
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.2.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-11 00:00:00.000000000 Z
+date: 2014-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,11 +97,13 @@ files:
 - lib/octokit/default.rb
 - lib/octokit/error.rb
 - lib/octokit/gist.rb
+- lib/octokit/organization.rb
 - lib/octokit/rate_limit.rb
 - lib/octokit/repo_arguments.rb
 - lib/octokit/repository.rb
 - lib/octokit/response/feed_parser.rb
 - lib/octokit/response/raise_error.rb
+- lib/octokit/user.rb
 - lib/octokit/version.rb
 - lib/octokit.rb
 homepage: https://github.com/octokit/octokit.rb