octokit 3.0.0 → 3.1.0

data/lib/octokit/client/search.rb

@@ -3,7 +3,7 @@ module Octokit
 
     # Methods for the Search API
     #
-    # @see http://developer.github.com/v3/search/
+    # @see https://developer.github.com/v3/search/
     module Search
 
       # Search code
@@ -15,7 +15,7 @@ module Octokit
       # @option options [Fixnum] :page Page of paginated results
       # @option options [Fixnum] :per_page Number of items per page
       # @return [Sawyer::Resource] Search results object
-      # @see http://developer.github.com/v3/search/#search-code
+      # @see https://developer.github.com/v3/search/#search-code
       def search_code(query, options = {})
         search "search/code", query, options
       end
@@ -29,7 +29,7 @@ module Octokit
       # @option options [Fixnum] :page Page of paginated results
       # @option options [Fixnum] :per_page Number of items per page
       # @return [Sawyer::Resource] Search results object
-      # @see http://developer.github.com/v3/search/#search-issues
+      # @see https://developer.github.com/v3/search/#search-issues
       def search_issues(query, options = {})
         search "search/issues", query, options
       end
@@ -43,7 +43,7 @@ module Octokit
       # @option options [Fixnum] :page Page of paginated results
       # @option options [Fixnum] :per_page Number of items per page
       # @return [Sawyer::Resource] Search results object
-      # @see http://developer.github.com/v3/search/#search-repositories
+      # @see https://developer.github.com/v3/search/#search-repositories
       def search_repositories(query, options = {})
         search "search/repositories", query, options
       end
@@ -58,7 +58,7 @@ module Octokit
       # @option options [Fixnum] :page Page of paginated results
       # @option options [Fixnum] :per_page Number of items per page
       # @return [Sawyer::Resource] Search results object
-      # @see http://developer.github.com/v3/search/#search-users
+      # @see https://developer.github.com/v3/search/#search-users
       def search_users(query, options = {})
         search "search/users", query, options
       end

data/lib/octokit/client/stats.rb

@@ -3,14 +3,14 @@ module Octokit
 
     # Methods for the Repository Statistics API
     #
-    # @see http://developer.github.com/v3/repos/statistics/
+    # @see https://developer.github.com/v3/repos/statistics/
     module Stats
 
       # Get contributors list with additions, deletions, and commit counts
       #
       # @param repo [String, Hash, Repository] A GitHub repository
       # @return [Array<Sawyer::Resource>] Array of contributor stats
-      # @see http://developer.github.com/v3/repos/statistics/#contributors
+      # @see https://developer.github.com/v3/repos/statistics/#contributors
       # @example Get contributor stats for octokit
       #   @client.contributors_stats('octokit/octokit.rb')
       def contributors_stats(repo, options = {})
@@ -23,7 +23,7 @@ module Octokit
       # @param repo [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 http://developer.github.com/v3/repos/statistics/#get-the-last-year-of-commit-activity-data
+      # @see https://developer.github.com/v3/repos/statistics/#get-the-last-year-of-commit-activity-data
       # @example Get commit activity for octokit
       #   @client.commit_activity_stats('octokit/octokit.rb')
       def commit_activity_stats(repo, options = {})
@@ -35,7 +35,7 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository
       # @return [Array<Sawyer::Resource>] Weekly aggregate of the number of additions
       #   and deletions pushed to a repository.
-      # @see http://developer.github.com/v3/repos/statistics/#code-frequency
+      # @see https://developer.github.com/v3/repos/statistics/#code-frequency
       # @example Get code frequency stats for octokit
       #   @client.code_frequency_stats('octokit/octokit.rb')
       def code_frequency_stats(repo, options = {})
@@ -49,7 +49,7 @@ module Octokit
       #   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
       #   subtract all from owner.
-      # @see http://developer.github.com/v3/repos/statistics/#participation
+      # @see https://developer.github.com/v3/repos/statistics/#participation
       # @example Get weekly commit counts for octokit
       #   @client.participation_stats("octokit/octokit.rb")
       def participation_stats(repo, options = {})
@@ -61,7 +61,7 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository
       # @return [Array<Array>] Arrays containing the day number, hour number, and
       #   number of commits
-      # @see http://developer.github.com/v3/repos/statistics/#punch-card
+      # @see https://developer.github.com/v3/repos/statistics/#punch-card
       # @example Get octokit punch card
       #   @octokit.punch_card_stats
       def punch_card_stats(repo, options = {})

data/lib/octokit/client/statuses.rb

@@ -3,7 +3,7 @@ module Octokit
 
     # Methods for the Commit Statuses API
     #
-    # @see http://developer.github.com/v3/repos/statuses/
+    # @see https://developer.github.com/v3/repos/statuses/
     module Statuses
       COMBINED_STATUS_MEDIA_TYPE = "application/vnd.github.she-hulk-preview+json"
 
@@ -12,7 +12,7 @@ module Octokit
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param sha [String] The SHA1 for the commit
       # @return [Array<Sawyer::Resource>] A list of statuses
-      # @see http://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref
+      # @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
       end
@@ -39,7 +39,7 @@ module Octokit
       # @option options [String] :target_url A link to more details about this status
       # @option options [String] :description A short human-readable description of this status
       # @return [Sawyer::Resource] A status
-      # @see http://developer.github.com/v3/repos/statuses/#create-a-status
+      # @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

data/lib/octokit/client/users.rb

@@ -3,7 +3,7 @@ module Octokit
 
     # Methods for the Users API
     #
-    # @see http://developer.github.com/v3/users/
+    # @see https://developer.github.com/v3/users/
     module Users
 
       # List all GitHub users
@@ -15,7 +15,7 @@ module Octokit
       # @option options [Integer] :since The integer ID of the last User that
       #   you’ve seen.
       #
-      # @see http://developer.github.com/v3/users/#get-all-users
+      # @see https://developer.github.com/v3/users/#get-all-users
       #
       # @return [Array<Sawyer::Resource>] List of GitHub users.
       def all_users(options = {})
@@ -26,8 +26,8 @@ module Octokit
       #
       # @param user [String] A GitHub user name.
       # @return [Sawyer::Resource]
-      # @see http://developer.github.com/v3/users/#get-a-single-user
-      # @see http://developer.github.com/v3/users/#get-the-authenticated-user
+      # @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 = {})
@@ -44,7 +44,7 @@ module Octokit
       # @param app_id [String] Client Id we received when our application was registered with GitHub. Defaults to client_id.
       # @param app_secret [String] Client Secret we received when our application was registered with GitHub. Defaults to client_secret.
       # @return [Sawyer::Resource] Hash holding the access token.
-      # @see http://developer.github.com/v3/oauth/#web-application-flow
+      # @see https://developer.github.com/v3/oauth/#web-application-flow
       # @example
       #   Octokit.exchange_code_for_token('aaaa', 'xxxx', 'yyyy', {:accept => 'application/json'})
       def exchange_code_for_token(code, app_id = client_id, app_secret = client_secret, options = {})
@@ -83,7 +83,7 @@ module Octokit
       # @option options [Boolean] :hireable
       # @option options [String] :bio
       # @return [Sawyer::Resource]
-      # @see http://developer.github.com/v3/users/#update-the-authenticated-user
+      # @see https://developer.github.com/v3/users/#update-the-authenticated-user
       # @example
       #   Octokit.update_user(:name => "Erik Michaels-Ober", :email => "sferik@gmail.com", :company => "Code for America", :location => "San Francisco", :hireable => false)
       def update_user(options)
@@ -94,7 +94,7 @@ module Octokit
       #
       # @param user [String] Username of the user whose list of followers you are getting.
       # @return [Array<Sawyer::Resource>] Array of hashes representing users followers.
-      # @see http://developer.github.com/v3/users/followers/#list-followers-of-a-user
+      # @see https://developer.github.com/v3/users/followers/#list-followers-of-a-user
       # @example
       #   Octokit.followers('pengwynn')
       def followers(user=login, options = {})
@@ -105,7 +105,7 @@ module Octokit
       #
       # @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.
-      # @see http://developer.github.com/v3/users/followers/#list-users-followed-by-another-user
+      # @see https://developer.github.com/v3/users/followers/#list-users-followed-by-another-user
       # @example
       #   Octokit.following('pengwynn')
       def following(user=login, options = {})
@@ -123,8 +123,8 @@ module Octokit
       #   @param user [String] Username of first user
       #   @param target [String] Username of the target user
       # @return [Boolean] True following target user, false otherwise.
-      # @see http://developer.github.com/v3/users/followers/#check-if-you-are-following-a-user
-      # @see http://developer.github.com/v3/users/followers/#check-if-one-user-follows-another
+      # @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
       # @example
       #   @client.follows?('pengwynn')
       # @example
@@ -146,7 +146,7 @@ module Octokit
       #
       # @param user [String] Username of the user to follow.
       # @return [Boolean] True if follow was successful, false otherwise.
-      # @see http://developer.github.com/v3/users/followers/#follow-a-user
+      # @see https://developer.github.com/v3/users/followers/#follow-a-user
       # @example
       #   @client.follow('holman')
       def follow(user, options = {})
@@ -159,7 +159,7 @@ module Octokit
       #
       # @param user [String] Username of the user to unfollow.
       # @return [Boolean] True if unfollow was successful, false otherwise.
-      # @see http://developer.github.com/v3/users/followers/#unfollow-a-user
+      # @see https://developer.github.com/v3/users/followers/#unfollow-a-user
       # @example
       #   @client.unfollow('holman')
       def unfollow(user, options = {})
@@ -173,16 +173,11 @@ module Octokit
       # @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>.
       # @return [Array<Sawyer::Resource>] Array of hashes representing repositories starred by user.
-      # @see http://developer.github.com/v3/activity/starring/#list-repositories-being-starred
+      # @see https://developer.github.com/v3/activity/starring/#list-repositories-being-starred
       # @example
       #   Octokit.starred('pengwynn')
       def starred(user=login, options = {})
-        if user == login && user_authenticated?
-          path = "user/starred"
-        else
-          path = "users/#{user}/starred"
-        end
-        paginate path, options
+        paginate user_path(user, 'starred'), options
       end
 
       # Check if you are starring a repo.
@@ -191,7 +186,7 @@ module Octokit
       #
       # @param repo [String, Hash, Repository] A GitHub repository
       # @return [Boolean] True if you are following the repo, false otherwise.
-      # @see http://developer.github.com/v3/activity/starring/#check-if-you-are-starring-a-repository
+      # @see https://developer.github.com/v3/activity/starring/#check-if-you-are-starring-a-repository
       # @example
       #   @client.starred?('pengwynn/octokit')
       def starred?(repo, options = {})
@@ -208,7 +203,7 @@ module Octokit
       #
       # @param key_id [Integer] Key to retreive.
       # @return [Sawyer::Resource] Hash representing the key.
-      # @see http://developer.github.com/v3/users/keys/#get-a-single-public-key
+      # @see https://developer.github.com/v3/users/keys/#get-a-single-public-key
       # @example
       #   @client.key(1)
       # @example Retrieve public key contents
@@ -230,7 +225,7 @@ module Octokit
       # Requires authenticated client.
       #
       # @return [Array<Sawyer::Resource>] Array of hashes representing public keys.
-      # @see http://developer.github.com/v3/users/keys/#list-your-public-keys
+      # @see https://developer.github.com/v3/users/keys/#list-your-public-keys
       # @example
       #   @client.keys
       def keys(options = {})
@@ -242,7 +237,7 @@ module Octokit
       # Requires authenticated client.
       #
       # @return [Array<Sawyer::Resource>] Array of hashes representing public keys.
-      # @see http://developer.github.com/v3/users/keys/#list-public-keys-for-a-user
+      # @see https://developer.github.com/v3/users/keys/#list-public-keys-for-a-user
       # @example
       #   @client.user_keys('pengwynn'
       def user_keys(user, options = {})
@@ -257,7 +252,7 @@ module Octokit
       # @param title [String] Title to give reference to the public key.
       # @param key [String] Public key.
       # @return [Sawyer::Resource] Hash representing the newly added public key.
-      # @see http://developer.github.com/v3/users/keys/#create-a-public-key
+      # @see https://developer.github.com/v3/users/keys/#create-a-public-key
       # @example
       #   @client.add_key('Personal projects key', 'ssh-rsa AAA...')
       def add_key(title, key, options = {})
@@ -273,7 +268,7 @@ module Octokit
       # @option options [String] :title
       # @option options [String] :key
       # @return [Sawyer::Resource] Hash representing the updated public key.
-      # @see http://developer.github.com/v3/users/keys/#update-a-public-key
+      # @see https://developer.github.com/v3/users/keys/#update-a-public-key
       # @example
       #   @client.update_key(1, :title => 'new title', :key => "ssh-rsa BBB")
       def update_key(key_id, options = {})
@@ -286,7 +281,7 @@ module Octokit
       #
       # @param id [String] Id of the public key to remove.
       # @return [Boolean] True if removal was successful, false otherwise.
-      # @see http://developer.github.com/v3/users/keys/#delete-a-public-key
+      # @see https://developer.github.com/v3/users/keys/#delete-a-public-key
       # @example
       #   @client.remove_key(1)
       def remove_key(id, options = {})
@@ -298,7 +293,7 @@ module Octokit
       # Requires authenticated client.
       #
       # @return [Array<String>] Array of email addresses.
-      # @see http://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user
+      # @see https://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user
       # @example
       #   @client.emails
       def emails(options = {})
@@ -311,7 +306,7 @@ module Octokit
       #
       # @param email [String] Email address to add to the user.
       # @return [Array<String>] Array of all email addresses of the user.
-      # @see http://developer.github.com/v3/users/emails/#add-email-addresses
+      # @see https://developer.github.com/v3/users/emails/#add-email-addresses
       # @example
       #   @client.add_email('new_email@user.com')
       def add_email(email, options = {})
@@ -325,7 +320,7 @@ module Octokit
       #
       # @param email [String] Email address to remove.
       # @return [Array<String>] Array of all email addresses of the user.
-      # @see http://developer.github.com/v3/users/emails/#delete-email-addresses
+      # @see https://developer.github.com/v3/users/emails/#delete-email-addresses
       # @example
       #   @client.remove_email('old_email@user.com')
       def remove_email(email)
@@ -339,20 +334,25 @@ module Octokit
       #
       # @return [Array<Sawyer::Resource>] Array of repositories.
       #
-      # @see http://developer.github.com/v3/activity/watching/#list-repositories-being-watched
+      # @see https://developer.github.com/v3/activity/watching/#list-repositories-being-watched
       #
       # @example
       #   @client.subscriptions("pengwynn")
       def subscriptions(user=login, options = {})
-        if user == login && user_authenticated?
-          path = "user/subscriptions"
-        else
-          path = "users/#{user}/subscriptions"
-        end
-        paginate path, options
+        paginate user_path(user, 'subscriptions'), options
       end
       alias :watched :subscriptions
 
     end
+
+    private
+    # convenience method for constructing a user specific path, if the user is logged in
+    def user_path(user, path)
+      if user == login && user_authenticated?
+        "user/#{path}"
+      else
+        "users/#{user}/#{path}"
+      end
+    end
   end
 end

data/lib/octokit/configurable.rb

@@ -4,20 +4,20 @@ module Octokit
   # in {Default}
   module Configurable
     # @!attribute [w] access_token
-    #   @see http://developer.github.com/v3/oauth/
+    #   @see https://developer.github.com/v3/oauth/
     #   @return [String] OAuth2 access token for authentication
     # @!attribute api_endpoint
     #   @return [String] Base URL for API requests. default: https://api.github.com/
     # @!attribute auto_paginate
     #   @return [Boolean] Auto fetch next page of results until rate limit reached
     # @!attribute client_id
-    #   @see http://developer.github.com/v3/oauth/
+    #   @see https://developer.github.com/v3/oauth/
     #   @return [String] Configure OAuth app key
     # @!attribute [w] client_secret
-    #   @see http://developer.github.com/v3/oauth/
+    #   @see https://developer.github.com/v3/oauth/
     #   @return [String] Configure OAuth app secret
     # @!attribute default_media_type
-    #   @see http://developer.github.com/v3/media/
+    #   @see https://developer.github.com/v3/media/
     #   @return [String] Configure preferred media type (for API versioning, for example)
     # @!attribute connection_options
     #   @see https://github.com/lostisland/faraday

data/lib/octokit/error.rb

@@ -218,4 +218,8 @@ module Octokit
 
   # Raised when client fails to provide valid Content-Type
   class MissingContentType < ArgumentError; end
+
+  # Raised when a method requires an application client_id
+  # and secret but none is provided
+  class ApplicationCredentialsRequired < StandardError; end
 end

data/lib/octokit/rate_limit.rb

@@ -11,7 +11,7 @@ module Octokit
   # @!attribute [w] resets_in
   #   @return [Fixnum] Number of seconds when rate limit resets
   #
-  # @see http://developer.github.com/v3/#rate-limiting
+  # @see https://developer.github.com/v3/#rate-limiting
   class RateLimit < Struct.new(:limit, :remaining, :resets_at, :resets_in)
 
     # Get rate limit info from HTTP response

data/lib/octokit/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,34 +10,34 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-27 00:00:00.000000000 Z
+date: 2014-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: sawyer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.3
 description: Simple wrapper for the GitHub API
@@ -49,7 +49,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .document
+- ".document"
 - CONTRIBUTING.md
 - LICENSE.md
 - README.md
@@ -114,12 +114,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []