lingfennan-github_api 0.18.2

data/lib/github_api/client/authorizations.rb

@@ -0,0 +1,142 @@
+# encoding: utf-8
+
+require_relative '../api'
+
+module Github
+  # OAuth Authorizations API
+  class Client::Authorizations < API
+
+    require_all 'github_api/client/authorizations', 'app'
+
+    # Access to Authorizations::App API
+    namespace :app
+
+    # List authorizations
+    #
+    # @see https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations
+    #
+    # @example
+    #   github = Github.new basic_auth: 'login:password'
+    #   github.auth.list
+    #   github.auth.list { |auth| ... }
+    #
+    # @api public
+    def list(*args)
+      raise_authentication_error unless authenticated?
+      arguments(args)
+
+      response = get_request('/authorizations', arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias_method :all, :list
+
+    # Get a single authorization
+    #
+    # @see https://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization
+    #
+    # @example
+    #  github = Github.new basic_auth: 'login:password'
+    #  github.oauth.get 'authorization-id'
+    #
+    # @return [ResponseWrapper]
+    #
+    # @api public
+    def get(*args)
+      raise_authentication_error unless authenticated?
+      arguments(args, required: [:id])
+
+      get_request("/authorizations/#{arguments.id}", arguments.params)
+    end
+    alias_method :find, :get
+
+    # Create a new authorization
+    #
+    # @see https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization
+    #
+    # @param [Hash] params
+    # @option params [Array[String]] :scopes
+    #   A list of scopes that this authorization is in.
+    # @option params [String] :note
+    #   Required. A note to remind you what the OAuth token is for.
+    # @option params [String] :note_url
+    #   A URL to remind you what the OAuth token is for.
+    # @option params [String] :client_id
+    #   The 20 character OAuth app client key for which to create the token.
+    # @option params [String] :client_secret
+    #   The 40 character OAuth app client secret for which to create the token.
+    # @option params [String] :fingerprint
+    #   A unique string to distinguish an authorization from others
+    #   created for the same client ID and user.
+    #
+    # @example
+    #   github = Github.new basic_auth: 'login:password'
+    #   github.oauth.create scopes: ["public_repo"], note: 'amdmin script'
+    #
+    # @api public
+    def create(*args)
+      raise_authentication_error unless authenticated?
+      arguments(args) do
+        assert_required :note, :scopes
+      end
+
+      post_request('/authorizations', arguments.params)
+    end
+
+    # Update an existing authorization
+    #
+    # @see https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization
+    #
+    # @param [Hash] inputs
+    # @option inputs [Array] :scopes
+    #   Optional array - A list of scopes that this authorization is in.
+    # @option inputs [Array] :add_scopes
+    #   Optional array - A list of scopes to add to this authorization.
+    # @option inputs [Array] :remove_scopes
+    #   Optional array - A list of scopes to remove from this authorization.
+    # @option inputs [String] :note
+    #   Optional string - A note to remind you what the OAuth token is for.
+    # @optoin inputs [String] :note_url
+    #   Optional string - A URL to remind you what the OAuth token is for.
+    # @option params [String] :fingerprint
+    #   A unique string to distinguish an authorization from others
+    #   created for the same client ID and user.
+    #
+    # @example
+    #   github = Github.new basic_auth: 'login:password'
+    #   github.oauth.update "authorization-id", add_scopes: ["repo"]
+    #
+    # @api public
+    def update(*args)
+      raise_authentication_error unless authenticated?
+      arguments(args, required: [:id])
+
+      patch_request("/authorizations/#{arguments.id}", arguments.params)
+    end
+    alias_method :edit, :update
+
+    # Delete an authorization
+    #
+    # @see https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization
+    #
+    # @example
+    #   github = Github.new
+    #   github.oauth.delete 'authorization-id'
+    #
+    # @api public
+    def delete(*args)
+      raise_authentication_error unless authenticated?
+      arguments(args, required: [:id])
+
+      delete_request("/authorizations/#{arguments.id}", arguments.params)
+    end
+    alias_method :remove, :delete
+
+    protected
+
+    def raise_authentication_error
+      raise ArgumentError, 'You can only access your own tokens' \
+                           ' via Basic Authentication'
+    end
+  end # Client::Authorizations
+end # Github

data/lib/github_api/client/authorizations/app.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Authorizations::App < Client::Authorizations
+    # Get-or-create an authorization for a specific app
+    #
+    # @see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app
+    #
+    # @param [Hash] params
+    # @option params [String] client_secret
+    #  The 40 character OAuth app client secret associated with the client
+    #  ID specified in the URL.
+    # @option params [Array] :scopes
+    #   Optional array - A list of scopes that this authorization is in.
+    # @option params [String] :note
+    #   Optional string - A note to remind you what the OAuth token is for.
+    # @option params [String] :note_url
+    #   Optional string - A URL to remind you what the OAuth token is for.
+    #
+    # @example
+    #   github = Github.new
+    #   github.oauth.app.create 'client-id', client_secret: '...'
+    #
+    # @api public
+    def create(*args)
+      raise_authentication_error unless authenticated?
+      arguments(args, required: [:client_id])
+
+      if arguments.client_id
+        put_request("/authorizations/clients/#{arguments.client_id}", arguments.params)
+      else
+        raise raise_app_authentication_error
+      end
+    end
+
+    # Check if an access token is a valid authorization for an application
+    #
+    # @example
+    #   github = Github.new basic_auth: "client_id:client_secret"
+    #   github.oauth.app.check 'client_id', 'access-token'
+    #
+    # @api public
+    def check(*args)
+      raise_authentication_error unless authenticated?
+      params = arguments(args, required: [:client_id, :access_token]).params
+
+      if arguments.client_id
+        begin
+          get_request("/applications/#{arguments.client_id}/tokens/#{arguments.access_token}", params)
+        rescue Github::Error::NotFound
+          nil
+        end
+      else
+        raise raise_app_authentication_error
+      end
+    end
+
+    # Revoke all authorizations for an application
+    #
+    # @example
+    #  github = Github.new basic_auth: "client_id:client_secret"
+    #  github.oauth.app.delete 'client-id'
+    #
+    # Revoke an authorization for an application
+    #
+    # @example
+    #  github = Github.new basic_auth: "client_id:client_secret"
+    #  github.oauth.app.delete 'client-id', 'access-token'
+    #
+    # @api public
+    def delete(*args)
+      raise_authentication_error unless authenticated?
+      params = arguments(args, required: [:client_id]).params
+
+      if arguments.client_id
+        if access_token = (params.delete('access_token') || args[1])
+          delete_request("/applications/#{arguments.client_id}/tokens/#{access_token}", params)
+        else
+          # Revokes all tokens
+          delete_request("/applications/#{arguments.client_id}/tokens", params)
+        end
+      else
+        raise raise_app_authentication_error
+      end
+    end
+    alias :remove :delete
+    alias :revoke :delete
+
+    protected
+
+    def raise_app_authentication_error
+      raise ArgumentError, 'To create authorization for the app, ' +
+        'you need to provide client_id argument and client_secret parameter'
+    end
+  end # Client::Authorizations::App
+end # Github

data/lib/github_api/client/emojis.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require_relative '../api'
+
+module Github
+  class Client::Emojis < API
+    # Lists all the emojis.
+    #
+    # @example
+    #   Github.emojis.list
+    #
+    # @api public
+    def list(*args)
+      arguments(args)
+
+      get_request("/emojis", arguments.params)
+    end
+  end # Client::Emojis
+end # Github

data/lib/github_api/client/gists.rb

@@ -0,0 +1,289 @@
+# encoding: utf-8
+
+require_relative '../api'
+
+module Github
+  class Client::Gists < API
+
+    require_all 'github_api/client/gists', 'comments'
+
+    # Access to Gists::Comments API
+    namespace :comments
+
+    # List a user's gists
+    #
+    # @see https://developer.github.com/v3/gists/#list-a-users-gists
+    #
+    # @example
+    #  github = Github.new
+    #  github.gists.list user: 'user-name'
+    #
+    # List the authenticated user’s gists or if called anonymously,
+    # this will returns all public gists
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.gists.list
+    #
+    # List all public gists
+    #
+    # @see https://developer.github.com/v3/gists/#list-all-public-gists
+    #
+    #  github = Github.new
+    #  github.gists.list :public
+    #
+    # @return [Hash]
+    #
+    # @api public
+    def list(*args)
+      params = arguments(args).params
+
+      response = if (user = params.delete('user'))
+        get_request("/users/#{user}/gists", params)
+      elsif args.map(&:to_s).include?('public')
+        get_request("/gists/public", params)
+      else
+        get_request("/gists", params)
+      end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias_method :all, :list
+
+    # List the authenticated user's starred gists
+    #
+    # @see https://developer.github.com/v3/gists/#list-starred-gists
+    #
+    # @example
+    #   github = Github.new oauth_token: '...'
+    #   github.gists.starred
+    #
+    # @return [Hash]
+    #
+    # @api public
+    def starred(*args)
+      arguments(args)
+      response = get_request("/gists/starred", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # Get a single gist
+    #
+    # @see https://developer.github.com/v3/gists/#get-a-single-gist
+    #
+    # @example
+    #   github = Github.new
+    #   github.gists.get 'gist-id'
+    #
+    # Get a specific revision of gist
+    #
+    # @see https://developer.github.com/v3/gists/#get-a-specific-revision-of-a-gist
+    #
+    # @example
+    #   github = Github.new
+    #   github.gists.get 'gist-id', sha: '
+    #
+    # @return [Hash]
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:id])
+
+      if (sha = arguments.params.delete('sha'))
+        get_request("/gists/#{arguments.id}/#{sha}")
+      else
+        get_request("/gists/#{arguments.id}", arguments.params)
+      end
+    end
+    alias_method :find, :get
+
+    # Create a gist
+    #
+    # @see https://developer.github.com/v3/gists/#create-a-gist
+    #
+    # @param [Hash] params
+    # @option params [String] :description
+    #   Optional string
+    # @option params [Boolean] :public
+    #   Required boolean
+    # @option params [Hash] :files
+    #   Required hash - Files that make up this gist.
+    #   The key of which should be a required string filename and
+    #   the value another required hash with parameters:
+    #     @option files [String] :content
+    #       Required string - File contents.
+    #
+    # @example
+    #  github = Github.new
+    #  github.gists.create
+    #    description: 'the description for this gist',
+    #    public: true,
+    #    files: {
+    #      'file1.txt' => {
+    #         content: 'String file contents'
+    #       }
+    #    }
+    #
+    # @return [Hash]
+    #
+    # @api public
+    def create(*args)
+      arguments(args)
+
+      post_request("/gists", arguments.params)
+    end
+
+    # Edit a gist
+    #
+    # @see https://developer.github.com/v3/gists/#edit-a-gist
+    #
+    # @param [Hash] params
+    # @option [String] :description
+    #   Optional string
+    # @option [Hash] :files
+    #   Optional hash - Files that make up this gist.
+    #   The key of which should be a optional string filename and 
+    #   the value another optional hash with parameters:
+    #     @option [String] :content
+    #       Updated string - Update file contents.
+    #     @option [String] :filename
+    #       Optional string - New name for this file.
+    #
+    # @xample
+    #  github = Github.new oauth_token: '...'
+    #  github.gists.edit 'gist-id',
+    #    description: 'the description for this gist',
+    #    files: {
+    #      'file1.txt' => {
+    #         content: 'Updated file contents'
+    #       },
+    #      'old_name.txt' => {
+    #         filename: 'new_name.txt',
+    #         content: 'modified contents'
+    #       },
+    #      'new_file.txt' => {
+    #         content: 'a new file contents'
+    #       },
+    #       'delete_the_file.txt' => nil
+    #    }
+    #
+    # @return [Hash]
+    #
+    # @api public
+    def edit(*args)
+      arguments(args, required: [:id])
+
+      patch_request("/gists/#{arguments.id}", arguments.params)
+    end
+
+    # List gist commits
+    #
+    # @see https://developer.github.com/v3/gists/#list-gist-commits
+    #
+    # @example
+    #  github = Github.new
+    #  github.gists.commits 'gist-id'
+    #
+    # @api public
+    def commits(*args)
+      arguments(args, required: [:id])
+
+      response = get_request("/gists/#{arguments.id}/commits")
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # Star a gist
+    #
+    # @see https://developer.github.com/v3/gists/#star-a-gist
+    #
+    # @example
+    #  github = Github.new
+    #  github.gists.star 'gist-id'
+    #
+    # @api public
+    def star(*args)
+      arguments(args, required: [:id])
+
+      put_request("/gists/#{arguments.id}/star", arguments.params)
+    end
+
+    # Unstar a gist
+    #
+    # @see https://developer.github.com/v3/gists/#unstar-a-gist
+    #
+    # @xample
+    #  github = Github.new
+    #  github.gists.unstar 'gist-id'
+    #
+    # @api public
+    def unstar(*args)
+      arguments(args, required: [:id])
+
+      delete_request("/gists/#{arguments.id}/star", arguments.params)
+    end
+
+    # Check if a gist is starred
+    #
+    # @see https://developer.github.com/v3/gists/#check-if-a-gist-is-starred
+    #
+    # @example
+    #   github = Github.new
+    #   github.gists.starred? 'gist-id'
+    #
+    # @api public
+    def starred?(*args)
+      arguments(args, required: [:id])
+      get_request("/gists/#{arguments.id}/star", arguments.params)
+      true
+    rescue Github::Error::NotFound
+      false
+    end
+
+    # Fork a gist
+    #
+    # @example
+    #  github = Github.new
+    #  github.gists.fork 'gist-id'
+    #
+    # @api public
+    def fork(*args)
+      arguments(args, required: [:id])
+
+      post_request("/gists/#{arguments.id}/forks", arguments.params)
+    end
+
+    # List gist forks
+    #
+    # @see https://developer.github.com/v3/gists/#list-gist-forks
+    #
+    # @example
+    #   github = Github.new
+    #   github.gists.forks 'gist-id'
+    #
+    # @api public
+    def forks(*args)
+      arguments(args, required: [:id])
+
+      response = get_request("/gists/#{arguments.id}/forks")
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # Delete a gist
+    #
+    # @see https://developer.github.com/v3/gists/#delete-a-gist
+    #
+    # @example
+    #  github = Github.new
+    #  github.gists.delete 'gist-id'
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:id])
+
+      delete_request("/gists/#{arguments.id}", arguments.params)
+    end
+  end # Gists
+end # Github