Sha256: af6d8b76bb781b8087cf61cea24c2614e88c6b633ffacd602fd3a1673b41fd65

Contents?: true

Size: 1.48 KB

Versions: 16

Compression:

Stored size: 1.48 KB

Contents

# encoding: utf-8

module Github
  # When you create a new GitHub repository via the API, you can specify a
  # .gitignore template to apply to the repository upon creation.
  class Client::Gitignore < API
    # List all templates available to pass as an option
    # when creating a repository.
    #
    # @see https://developer.github.com/v3/gitignore/#listing-available-templates
    #
    # @example
    #  github = Github.new
    #  github.gitignore.list
    #  github.gitignore.list { |template| ... }
    #
    # @api public
    def list(*args)
      arguments(args)

      response = get_request("/gitignore/templates", arguments.params)
      return response unless block_given?
      response.each { |el| yield el }
    end
    alias :all :list

    # Get a single template
    #
    # @see https://developer.github.com/v3/gitignore/#get-a-single-template
    #
    # @example
    #  github = Github.new
    #  github.gitignore.get "template-name"
    #
    # Use the raw media type to get the raw contents.
    #
    # @examples
    #  github = Github.new
    #  github.gitignore.get "template-name", accept: 'applicatin/vnd.github.raw'
    #
    # @api public
    def get(*args)
      arguments(args, required: [:name])
      params = arguments.params

      if (media = params.delete('accept'))
        params['accept'] = media
        params['raw'] = true
      end

      get_request("/gitignore/templates/#{arguments.name}", params)
    end
    alias :find :get
  end # Client::Gitignore
end # Github

Version data entries

16 entries across 16 versions & 1 rubygems

Version Path
github_api-0.17.0 lib/github_api/client/gitignore.rb
github_api-0.16.0 lib/github_api/client/gitignore.rb
github_api-0.15.0 lib/github_api/client/gitignore.rb
github_api-0.14.5 lib/github_api/client/gitignore.rb
github_api-0.14.4 lib/github_api/client/gitignore.rb
github_api-0.14.3 lib/github_api/client/gitignore.rb
github_api-0.14.2 lib/github_api/client/gitignore.rb
github_api-0.14.1 lib/github_api/client/gitignore.rb
github_api-0.14.0 lib/github_api/client/gitignore.rb
github_api-0.13.1 lib/github_api/client/gitignore.rb
github_api-0.13.0 lib/github_api/client/gitignore.rb
github_api-0.12.4 lib/github_api/client/gitignore.rb
github_api-0.12.3 lib/github_api/client/gitignore.rb
github_api-0.12.2 lib/github_api/client/gitignore.rb
github_api-0.12.1 lib/github_api/client/gitignore.rb
github_api-0.12.0 lib/github_api/client/gitignore.rb