octokit 4.2.0 → 9.2.0

data/lib/octokit/client/notifications.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Notifications API
     #
     # @see https://developer.github.com/v3/activity/notifications/
     module Notifications
-
       # List your notifications
       #
       # @param options [Hash] Optional parameters
@@ -24,7 +24,7 @@ module Octokit
       # @example Get all notifications since a certain time.
       #   @client.notifications({all: true, since: '2012-10-09T23:39:01Z'})
       def notifications(options = {})
-        paginate "notifications", options
+        paginate 'notifications', options
       end
 
       # List your notifications in a repository
@@ -48,7 +48,7 @@ module Octokit
       def repository_notifications(repo, options = {})
         paginate "#{Repository.path repo}/notifications", options
       end
-      alias :repo_notifications :repository_notifications
+      alias repo_notifications repository_notifications
 
       # Mark notifications as read
       #
@@ -66,7 +66,7 @@ module Octokit
       # @example
       #   @client.mark_notifications_as_read
       def mark_notifications_as_read(options = {})
-        request :put, "notifications", options
+        request :put, 'notifications', options
 
         last_response.status == 205
       end
@@ -91,7 +91,7 @@ module Octokit
 
         last_response.status == 205
       end
-      alias :mark_repo_notifications_as_read :mark_repository_notifications_as_read
+      alias mark_repo_notifications_as_read mark_repository_notifications_as_read
 
       # List notifications for a specific thread
       #
@@ -108,14 +108,10 @@ module Octokit
       # Mark thread as read
       #
       # @param thread_id [Integer] Id of the thread to update.
-      # @param options [Hash] Optional parameters.
-      # @option options [Boolean] :unread Changes the unread status of the
-      #   threads.
-      # @option options [Boolean] :read Inverse of 'unread'.
       # @return [Boolean] True if updated, false otherwise.
       # @see https://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read
       # @example
-      #   @client.mark_thread_as_ready(1, :read => false)
+      #   @client.mark_thread_as_read(1, :read => false)
       def mark_thread_as_read(thread_id, options = {})
         request :patch, "notifications/threads/#{thread_id}", options
 

data/lib/octokit/client/oauth_applications.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Octokit
+  class Client
+    # Methods for the OauthApplications API
+    #
+    # @see https://developer.github.com/v3/apps/oauth_applications
+    module OauthApplications
+      # Check if a token is valid.
+      #
+      # Applications can check if a token is valid without rate limits.
+      #
+      # @param access_token [String] 40 character GitHub OAuth access token
+      #
+      # @return [Sawyer::Resource] A single authorization for the authenticated user
+      # @see https://developer.github.com/v3/apps/oauth_applications/#check-a-token
+      #
+      # @example
+      #  client = Octokit::Client.new(:client_id => 'abcdefg12345', :client_secret => 'secret')
+      #  client.check_token('deadbeef1234567890deadbeef987654321')
+      def check_token(access_token, options = {})
+        options[:access_token] = access_token
+
+        key    = options.delete(:client_id)     || client_id
+        secret = options.delete(:client_secret) || client_secret
+
+        as_app(key, secret) do |app_client|
+          app_client.post "applications/#{client_id}/token", options
+        end
+      end
+      alias check_application_authorization check_token
+
+      # Reset a token
+      #
+      # Applications can reset a token without requiring a user to re-authorize.
+      #
+      # @param access_token [String] 40 character GitHub OAuth access token
+      #
+      # @return [Sawyer::Resource] A single authorization for the authenticated user
+      # @see https://developer.github.com/v3/apps/oauth_applications/#reset-a-token
+      #
+      # @example
+      #  client = Octokit::Client.new(:client_id => 'abcdefg12345', :client_secret => 'secret')
+      #  client.reset_token('deadbeef1234567890deadbeef987654321')
+      def reset_token(access_token, options = {})
+        options[:access_token] = access_token
+
+        key    = options.delete(:client_id)     || client_id
+        secret = options.delete(:client_secret) || client_secret
+
+        as_app(key, secret) do |app_client|
+          app_client.patch "applications/#{client_id}/token", options
+        end
+      end
+      alias reset_application_authorization reset_token
+
+      # Delete an app token
+      #
+      # Applications can revoke (delete) a token
+      #
+      # @param access_token [String] 40 character GitHub OAuth access token
+      #
+      # @return [Boolean] Result
+      # @see https://developer.github.com/v3/apps/oauth_applications/#delete-an-app-token
+      #
+      # @example
+      #  client = Octokit::Client.new(:client_id => 'abcdefg12345', :client_secret => 'secret')
+      #  client.delete_app_token('deadbeef1234567890deadbeef987654321')
+      def delete_app_token(access_token, options = {})
+        options[:access_token] = access_token
+
+        key    = options.delete(:client_id)     || client_id
+        secret = options.delete(:client_secret) || client_secret
+
+        begin
+          as_app(key, secret) do |app_client|
+            app_client.delete "applications/#{client_id}/token", options
+            app_client.last_response.status == 204
+          end
+        rescue Octokit::NotFound
+          false
+        end
+      end
+      alias delete_application_authorization delete_app_token
+      alias revoke_application_authorization delete_app_token
+
+      # Delete an app authorization
+      #
+      # OAuth application owners can revoke a grant for their OAuth application and a specific user.
+      #
+      # @param access_token [String] 40 character GitHub OAuth access token
+      #
+      # @return [Boolean] Result
+      # @see https://developer.github.com/v3/apps/oauth_applications/#delete-an-app-token
+      #
+      # @example
+      #  client = Octokit::Client.new(:client_id => 'abcdefg12345', :client_secret => 'secret')
+      #  client.delete_app_authorization('deadbeef1234567890deadbeef987654321')
+      def delete_app_authorization(access_token, options = {})
+        options[:access_token] = access_token
+
+        key    = options.delete(:client_id)     || client_id
+        secret = options.delete(:client_secret) || client_secret
+
+        begin
+          as_app(key, secret) do |app_client|
+            app_client.delete "applications/#{client_id}/grant", options
+            app_client.last_response.status == 204
+          end
+        rescue Octokit::NotFound
+          false
+        end
+      end
+    end
+  end
+end

data/lib/octokit/client/objects.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Git Data API
     #
     # @see https://developer.github.com/v3/git/
     module Objects
-
       # Get a single tree, fetching information about its root-level objects
       #
       # Pass <tt>:recursive => true</tt> in <tt>options</tt> to fetch information about all of the tree's objects, including those in subdirectories.
@@ -38,7 +38,7 @@ module Octokit
       #   tree.sha # => "cd8274d15fa3ae2ab983129fb037999f264ba9a7"
       #   tree.tree.first.path # => "file.rb"
       def create_tree(repo, tree, options = {})
-        parameters = { :tree => tree }
+        parameters = { tree: tree }
         post "#{Repository.path repo}/git/trees", options.merge(parameters)
       end
 
@@ -74,10 +74,10 @@ module Octokit
       # @example Create a blob containing <tt>foo bar baz</tt>, encoded using base64
       #   require "base64"
       #   Octokit.create_blob("octocat/Hello-World", Base64.encode64("foo bar baz"), "base64")
-      def create_blob(repo, content, encoding="utf-8", options = {})
+      def create_blob(repo, content, encoding = 'utf-8', options = {})
         parameters = {
-          :content => content,
-          :encoding => encoding
+          content: content,
+          encoding: encoding
         }
         blob = post "#{Repository.path repo}/git/blobs", options.merge(parameters)
 
@@ -124,14 +124,14 @@ module Octokit
       #   )
       def create_tag(repo, tag, message, object_sha, type, tagger_name, tagger_email, tagger_date, options = {})
         options.merge!(
-          :tag => tag,
-          :message => message,
-          :object => object_sha,
-          :type => type,
-          :tagger => {
-            :name => tagger_name,
-            :email => tagger_email,
-            :date => tagger_date
+          tag: tag,
+          message: message,
+          object: object_sha,
+          type: type,
+          tagger: {
+            name: tagger_name,
+            email: tagger_email,
+            date: tagger_date
           }
         )
         post "#{Repository.path repo}/git/tags", options