github_api 0.11.3 → 0.12.0

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

@@ -0,0 +1,135 @@
+# encoding: utf-8
+
+module Github
+  class Client::Repos::Deployments < API
+
+    VALID_DEPLOYMENTS_OPTIONS = %w[
+      ref
+      auto_merge
+      required_contexts
+      payload
+      environment
+      description
+    ]
+
+    VALID_STATUS_OPTIONS = %w[
+      target_url
+      description
+    ]
+
+    PREVIEW_MEDIA = 'application/vnd.github.cannonball-preview+json'.freeze # :nodoc:
+
+    # List deployments on a repository
+    #
+    # @xample
+    #  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_api/client/repos/downloads.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+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_api/client/repos/forks.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+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

data/lib/github_api/client/repos/hooks.rb

@@ -0,0 +1,212 @@
+# encoding: utf-8
+
+module Github
+  # The Repository Hooks API manages the post-receive web and
+  # service hooks for a repository.
+  class Client::Repos::Hooks < API
+
+    VALID_HOOK_PARAM_NAMES = %w[
+      name
+      config
+      active
+      events
+      add_events
+      remove_events
+    ].freeze # :nodoc:
+
+    # Active hooks can be configured to trigger for one or more events.
+    # The default event is push. The available events are:
+    VALID_HOOK_PARAM_VALUES = {
+      'events' => %w[
+        push
+        issues
+        issue_comment
+        commit_comment
+        pull_request
+        gollum
+        watch
+        download
+        fork
+        fork_apply
+        member
+        public
+      ]
+    }.freeze # :nodoc:
+
+    REQUIRED_PARAMS = %w[ name config ].freeze # :nodoc:
+
+    # List repository hooks
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.hooks.list 'user-name', 'repo-name'
+    #   github.repos.hooks.list 'user-name', 'repo-name' { |hook| ... }
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo])
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/hooks", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single hook
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.hooks.get 'user-name', 'repo-name', 'hook-id'
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:user, :repo, :id])
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/hooks/#{arguments.id}", arguments.params)
+    end
+    alias :find :get
+
+    # Create a hook
+    #
+    # @param [Hash] params
+    # @input params [String] :name
+    #   Required. The name of the service that is being called.
+    # @input params [Hash] :config
+    #   Required. Key/value pairs to provide settings for this hook.
+    #   These settings vary between the services and are defined in
+    #   the github-services repository. Booleans are stored internally
+    #   as “1” for true, and “0” for false. Any JSON true/false values
+    #   will be converted automatically.
+    # @input params [Array] :events
+    #   Determines what events the hook is triggered for. Default: ["push"]
+    # @input params [Boolean] :active
+    #   Determines whether the hook is actually triggered on pushes.
+    #
+    # To create a webhook, the following fields are required by the config:
+    #
+    # @input config [String] :url
+    #   A required string defining the URL to which the payloads
+    #   will be delivered.
+    # @input config [String] :content_type
+    #   An optional string defining the media type used to serialize
+    #   the payloads. Supported values include json and form.
+    #   The default is form.
+    # @input config [String] :secret
+    #   An optional string that’s passed with the HTTP requests as
+    #   an X-Hub-Signature header. The value of this header is
+    #   computed as the HMAC hex digest of the body,
+    #   using the secret as the key.
+    # @input config [String] :insecure_ssl
+    #   An optional string that determines whether the SSL certificate
+    #   of the host for url will be verified when delivering payloads.
+    #   Supported values include "0" (verification is performed) and
+    #   "1" (verification is not performed). The default is "0".
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.hooks.create 'user-name', 'repo-name',
+    #     name:  "web",
+    #     active: true,
+    #     config: {
+    #       url: "http://something.com/webhook"
+    #     }
+    #   }
+    #
+    # @api public
+    def create(*args)
+      arguments(args, required: [:user, :repo]) do
+        permit VALID_HOOK_PARAM_NAMES, recursive: false
+        assert_required REQUIRED_PARAMS
+      end
+
+      post_request("/repos/#{arguments.user}/#{arguments.repo}/hooks", arguments.params)
+    end
+
+    # Edit a hook
+    #
+    # @param [Hash] params
+    # @input params [Hash] :config
+    #   Required. Key/value pairs to provide settings for this hook.
+    #   These settings vary between the services and are defined in
+    #   the github-services repository. Booleans are stored internally
+    #   as “1” for true, and “0” for false. Any JSON true/false values
+    #   will be converted automatically.
+    # @input params [Array] :events
+    #   Determines what events the hook is triggered for. Default: ["push"]
+    # @input params [Array] :add_events
+    #   Determines a list of events to be added to the list of events
+    #   that the Hook triggers for.
+    # @input params [Array] :remove_events
+    #   Determines a list of events to be removed from the list of
+    #   events that the Hook triggers for.
+    # @input params [Boolean] :active
+    #   Determines whether the hook is actually triggered on pushes.
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.hooks.edit 'user-name', 'repo-name', 'hook-id',
+    #    "name" => "campfire",
+    #    "active" =>  true,
+    #    "config" =>  {
+    #      "subdomain" => "github",
+    #      "room" =>  "Commits",
+    #      "token" => "abc123"
+    #    }
+    #
+    # @api public
+    def edit(*args)
+      arguments(args, required: [:user, :repo, :id]) do
+        permit VALID_HOOK_PARAM_NAMES, recursive: false
+        assert_required REQUIRED_PARAMS
+      end
+
+      patch_request("/repos/#{arguments.user}/#{arguments.repo}/hooks/#{arguments.id}", arguments.params)
+    end
+
+    # Test a hook
+    #
+    # This will trigger the hook with the latest push to the current
+    # repository if the hook is subscribed to push events. If the hook
+    # is not subscribed to push events, the server will respond with 204
+    # but no test POST will be generated.
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.hooks.test 'user-name', 'repo-name', 'hook-id'
+    #
+    # @api public
+    def test(*args)
+      arguments(args, required: [:user, :repo, :id])
+
+      post_request("/repos/#{arguments.user}/#{arguments.repo}/hooks/#{arguments.id}/tests", arguments.params)
+    end
+
+    # Ping a hook
+    #
+    # This will trigger a ping event to be sent to the hook.
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.hooks.ping 'user-name', 'repo-name', 'hook-id'
+    #
+    # @api public
+    def ping(*args)
+      arguments(args, required: [:user, :repo, :id])
+
+      post_request("/repos/#{arguments.user}/#{arguments.repo}/hooks/#{arguments.id}/pings", arguments.params)
+    end
+
+    # Delete a hook
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.hooks.delete 'user-name', 'repo-name', 'hook-id'
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:user, :repo, :id])
+
+      delete_request("/repos/#{arguments.user}/#{arguments.repo}/hooks/#{arguments.id}", arguments.params)
+    end
+  end # Client::Repos::Hooks
+end # Github