github_api2 1.0.0

data/lib/github_api2/client/repos/contents.rb

@@ -0,0 +1,263 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  # These API methods let you retrieve the contents of files within a repository
+  # as Base64 encoded content.
+  class Client::Repos::Contents < API
+
+    REQUIRED_CONTENT_OPTIONS = %w[ path message content ]
+
+    # Get the README
+    #
+    # This method returns the preferred README for a repository.
+    #
+    # @param [Hash] params
+    # @option params [String] :ref
+    #   The name of the commit/branch/tag.
+    #   Default: the repository’s default branch (usually master)
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.contents.readme 'user-name', 'repo-name'
+    #
+    # @example
+    #   content = Github::Client::Repos::Contents.new user: 'user-name', repo: 'repo-name'
+    #   content.readme
+    #
+    # @api public
+    def readme(*args)
+      arguments(args, required: [:user, :repo])
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/readme", arguments.params)
+    end
+
+    # Get the LICENSE
+    #
+    # This method returns the contents of the repository's license file, if one is detected.
+    #
+    # @param [Hash] params
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.contents.license 'user-name', 'repo-name'
+    #
+    # @api public
+    def license(*args)
+      arguments(args, required: [:user, :repo])
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/license", arguments.params)
+    end
+    
+    # Get contents
+    #
+    # This method returns the contents of any file or directory in a repository.
+    #
+    # @param [Hash] params
+    # @option params [String] :path
+    #   The content path.
+    # @option params [String] :ref
+    #   The name of the commit/branch/tag.
+    #   Default: the repository’s default branch (usually master)
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.contents.get 'user-name', 'repo-name', 'path'
+    #
+    # @example
+    #   github = Github.new user: 'user-name', repo: 'repo-name'
+    #   github.repos.contents.get path: 'README.md'
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:user, :repo, :path])
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/contents/#{arguments.path}", arguments.params)
+    end
+    alias :find :get
+
+    # Create a file
+    #
+    # This method creates a new file in a repository
+    #
+    # @param [Hash] params
+    # @option params [String] :path
+    #   Required string. The content path
+    # @option params [String]
+    # @option params [String] :message
+    #   Required string. The commit message.
+    # @option params [String] :content
+    #   Required string. The new file content, which will be Base64 encoded
+    # @option params [String] :branch
+    #   The branch name. If not provided, uses the repository’s
+    #   default branch (usually master)
+    #
+    # Optional Parameters
+    #
+    # The :author section is optional and is filled in with the
+    # :committer information if omitted. If the :committer
+    # information is omitted, the authenticated user’s information is used.
+    #
+    # You must provide values for both :name and :email, whether
+    # you choose to use :author or :committer. Otherwise, you’ll
+    # receive a 500 status code.
+    #
+    # Both the author and commiter parameters have the same keys:
+    #
+    # @option params [String] :name
+    #   The name of the author (or commiter) of the commit
+    # @option params [String] :email
+    #   The email of the author (or commiter) of the commit
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.contents.create 'user-name', 'repo-name', 'path',
+    #     path: 'hello.rb',
+    #     content: "puts 'hello ruby'",
+    #     message: "my commit message"
+    #
+    # @api public
+    def create(*args)
+      arguments(args, required: [:user, :repo, :path]) do
+        assert_required REQUIRED_CONTENT_OPTIONS
+      end
+      params = arguments.params
+      params.strict_encode64('content')
+
+      put_request("/repos/#{arguments.user}/#{arguments.repo}/contents/#{arguments.path}", params)
+    end
+
+    # Update a file
+    #
+    # This method updates a file in a repository
+    #
+    # @param [Hash] params
+    # @option params [String] :path
+    #   Requried string. The content path
+    # @option params [String]
+    # @option params [String] :message
+    #   Requried string. The commit message.
+    # @option params [String] :content
+    #   Requried string. The new file content, which will be Base64 encoded
+    # @option params [String] :sha
+    #   Required string. The blob SHA of the file being replaced.
+    # @option params [String] :branch
+    #   The branch name. If not provided, uses the repository’s
+    #   default branch (usually master)
+    #
+    # Optional Parameters
+    #
+    # The :author section is optional and is filled in with the
+    # :committer information if omitted. If the :committer
+    # information is omitted, the authenticated user’s information is used.
+    #
+    # You must provide values for both :name and :email, whether
+    # you choose to use :author or :committer. Otherwise, you’ll
+    # receive a 500 status code.
+    #
+    # Both the author and commiter parameters have the same keys:
+    #
+    # @option params [String] :name
+    #   The name of the author (or commiter) of the commit
+    # @option params [String] :email
+    #   The email of the author (or commiter) of the commit
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.contents.update 'user-name', 'repo-name', 'path',
+    #     path: 'hello.rb',
+    #     content: "puts 'hello ruby again'",
+    #     message: "my commit message",
+    #     sha: "25b0bef9e404bd2e3233de26b7ef8cbd86d0e913"
+    #
+    # @api public
+    def update(*args)
+      create(*args)
+    end
+
+    # Delete a file
+    #
+    # This method deletes a file in a repository
+    #
+    # @param [Hash] params
+    # @option params [String] :path
+    #   Requried string. The content path
+    # @option params [String]
+    # @option params [String] :message
+    #   Requried string. The commit message.
+    # @option params [String] :sha
+    #   Required string. The blob SHA of the file being replaced.
+    # @option params [String] :branch
+    #   The branch name. If not provided, uses the repository’s
+    #   default branch (usually master)
+    #
+    # Optional Parameters
+    #
+    # The :author section is optional and is filled in with the
+    # :committer information if omitted. If the :committer
+    # information is omitted, the authenticated user’s information is used.
+    #
+    # You must provide values for both :name and :email, whether
+    # you choose to use :author or :committer. Otherwise, you’ll
+    # receive a 500 status code.
+    #
+    # Both the author and commiter parameters have the same keys:
+    #
+    # @option params [String] :name
+    #   The name of the author (or commiter) of the commit
+    # @option params [String] :email
+    #   The email of the author (or commiter) of the commit
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.contents.delete 'user-name', 'repo-name', 'path',
+    #    path: 'hello.rb',
+    #    message: "delete hello.rb file",
+    #    sha: "329688480d39049927147c162b9d2deaf885005f"
+    #
+    def delete(*args)
+      arguments(args, required: [:user, :repo, :path]) do
+        assert_required %w[ path message sha ]
+      end
+
+      delete_request("/repos/#{arguments.user}/#{arguments.repo}/contents/#{arguments.path}", arguments.params)
+    end
+
+    # Get archive link
+    #
+    # This method will return a 302 to a URL to download a tarball or zipball
+    # archive for a repository. Please make sure your HTTP framework is configured
+    # to follow redirects or you will need to use the Location header to make
+    # a second GET request.
+    #
+    # @note
+    #   For private repositories, these links are temporary and expire quickly.
+    #
+    # @param [Hash] params
+    # @input params [String] :archive_format
+    #   Required string. Either tarball or zipball. Default: tarball
+    # @input params [String] :ref
+    #   Optional string. A valid Git reference.
+    #   Default: the repository’s default branch (usually master)
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.contents.archive 'user-name', 'repo-name',
+    #    archive_format: "tarball",
+    #    ref: "master"
+    #
+    # @api public
+    def archive(*args)
+      arguments(args, required: [:user, :repo])
+      params         = arguments.params
+      archive_format = params.delete('archive_format') || 'tarball'
+      ref            = params.delete('ref') || 'master'
+
+      disable_redirects do
+        response = get_request("/repos/#{arguments.user}/#{arguments.repo}/#{archive_format}/#{ref}", params)
+        response.headers.location
+      end
+    end
+  end # Client::Repos::Contents
+end # Github

data/lib/github_api2/client/repos/deployments.rb

@@ -0,0 +1,138 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Repos::Deployments < API
+
+    VALID_DEPLOYMENTS_OPTIONS = %w[
+      ref
+      auto_merge
+      required_contexts
+      payload
+      environment
+      description
+    ]
+
+    VALID_STATUS_OPTIONS = %w[
+      state
+      target_url
+      description
+    ]
+
+    PREVIEW_MEDIA = 'application/vnd.github.cannonball-preview+json'.freeze # :nodoc:
+
+    # List deployments on a repository
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.deployments.list 'user-name', 'repo-name'
+    #  github.repos.deployments.list 'user-name', 'repo-name' { |deployment| ... }
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo])
+      params = arguments.params
+      params['accept'] ||= PREVIEW_MEDIA
+
+      response = get_request("repos/#{arguments.user}/#{arguments.repo}/deployments", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Create a deployment
+    #
+    # @param [Hash] params
+    # @option params [String] :ref
+    #   Required string. The ref to deploy. This can be a branch, tag, or sha.
+    # @option params [Boolean] :auto_merge
+    #   Optional boolean. Merge the default branch into the requested.
+    # @option params [Array] :required_contexts
+    #   Optional array of status contexts verified against commit status checks.
+    #   If this parameter is omitted from the parameters then all unique
+    #   contexts will be verified before a deployment is created. To bypass
+    #   checking entirely pass an empty array. Defaults to all unique contexts.
+    # @option params [String] :payload
+    #   Optional JSON payload with extra information about the deployment.
+    #   Default: ""
+    # @option params [String] :payload
+    #   Optional String. Name for the target deployment environment (e.g.,
+    #   production, staging, qa). Default: "production"
+    # @option params [String] :description
+    #   Optional string. Optional short description.
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.deployments.create 'user-name', 'repo-name', ref: '...'
+    #  github.repos.deployments.create
+    #     'user-name',
+    #     'repo-name',
+    #     ref: '...',
+    #     description: 'New deploy',
+    #     force: true
+    #
+    # @api public
+    def create(*args)
+      arguments(args, required: [:user, :repo]) do
+        permit VALID_DEPLOYMENTS_OPTIONS
+        assert_required %w[ ref ]
+      end
+      params = arguments.params
+      params['accept'] ||= PREVIEW_MEDIA
+
+      post_request("repos/#{arguments.user}/#{arguments.repo}/deployments", arguments.params)
+    end
+
+    # List the statuses of a deployment.
+    #
+    # @param [Hash] params
+    # @option params [String] :id
+    #   Required string. Id of the deployment being queried.
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.deployments.statuses 'user-name', 'repo-name', DEPLOYMENT_ID
+    #  github.repos.deployments.statuses 'user-name', 'repo-name', DEPLOYMENT_ID { |status| ... }
+    #
+    # @api public
+    def statuses(*args)
+      arguments(args, required: [:user, :repo, :id])
+      params = arguments.params
+      params['accept'] ||= PREVIEW_MEDIA
+
+      statuses = get_request("repos/#{arguments.user}/#{arguments.repo}/deployments/#{arguments.id}/statuses", params)
+      return statuses unless block_given?
+      statuses.each { |status| yield status }
+    end
+
+    # Create a deployment status
+    #
+    # @param [Hash] params
+    # @option params [String] :id
+    #   Required string. Id of the deployment being referenced.
+    # @option params [String] :state
+    #   Required string. State of the deployment. Can be one of:
+    #   pending, success, error, or failure.
+    # @option params [String] :target_url
+    #   Optional string. The URL associated with the status.
+    # @option params [String] :description
+    #   Optional string. A short description of the status.
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.deployments.create_status 'user-name', 'repo-name', DEPLOYMENT_ID, state: '...'
+    #
+    # @api public
+    def create_status(*args)
+      arguments(args, required: [:user, :repo, :id]) do
+        assert_required %w[ state ]
+        permit VALID_STATUS_OPTIONS
+      end
+      params = arguments.params
+      params['accept'] ||= PREVIEW_MEDIA
+
+      post_request("repos/#{arguments.user}/#{arguments.repo}/deployments/#{arguments.id}/statuses", params)
+    end
+  end # Client::Repos::Deployments
+end # Github

data/lib/github_api2/client/repos/downloads.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Repos::Downloads < API
+
+    REQUIRED_PARAMS = %w[ name size ].freeze
+
+    VALID_DOWNLOAD_PARAM_NAMES = %w[
+      name
+      size
+      description
+      content_type
+    ].freeze
+
+    # List downloads for a repository
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.downloads.list 'user-name', 'repo-name'
+    #   github.repos.downloads.list 'user-name', 'repo-name' { |downl| ... }
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo])
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/downloads", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single download
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.downloads.get 'user-name', 'repo-name', 'download-id'
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:user, :repo, :id])
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/downloads/#{arguments.id}", arguments.params)
+    end
+    alias :find :get
+
+    # Delete download from a repository
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.downloads.delete 'user-name', 'repo-name', 'download-id'
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:user, :repo, :id])
+
+      delete_request("/repos/#{arguments.user}/#{arguments.repo}/downloads/#{arguments.id}", arguments.params)
+    end
+    alias :remove :delete
+  end # Repos::Downloads
+end # Github

data/lib/github_api2/client/repos/forks.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Repos::Forks < API
+    # List repository forks
+    #
+    # @param [Hash] params
+    # @input params [String] :sort
+    #   The sort order. Can be either newest, oldest, or stargazers.
+    #   Default: newest
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.forks.list('user-name', 'repo-name')
+    #   github.repos.forks.list('user-name', 'repo-name') { |fork|
+    #     #...
+    #   }
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo])
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/forks", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Create a fork for the authenticated user
+    #
+    # @param [Hash] params
+    # @input params [String] :organization
+    #   The organization login. The repository will be forked into
+    #   this organization.
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.forks.create 'user-name', 'repo-name',
+    #     organization: "github"
+    #
+    # @api public
+    def create(*args)
+      arguments(args, required: [:user, :repo])
+
+      post_request("/repos/#{arguments.user}/#{arguments.repo}/forks", arguments.params)
+    end
+  end # Client::Repos::Forks
+end # Github