github_api2 1.0.0

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

@@ -0,0 +1,214 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+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

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

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Repos::Invitations < API
+    # List repo invitations
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.invitations.list 'user-name', 'repo-name'
+    #
+    # @example
+    #  github.repos.invitations.list 'user-name', 'repo-name' { |cbr| .. }
+    #
+    # @return [Array]
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo])
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/invitations", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Deletes a repo invitation
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.invitations.delete 'user-name', 'repo-name', 'invitation-id'
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:user, :repo, :id])
+
+      delete_request("/repos/#{arguments.user}/#{arguments.repo}/invitations/#{arguments.id}", arguments.params)
+    end
+  end
+end

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

@@ -0,0 +1,104 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Repos::Keys < API
+    # List deploy keys
+    #
+    # @see https://developer.github.com/v3/repos/keys/#list
+    #
+    # @param [String] :user
+    # @param [String :repo
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.keys.list 'user-name', 'repo-name'
+    #   github.repos.keys.list 'user-name', 'repo-name' { |key| ... }
+    #
+    # @example
+    #   keys = Github::Repos::Keys.new user: 'user-name', repo: 'repo-name'
+    #   keys.list
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo])
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/keys",
+                             arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias_method :all, :list
+
+    # Get a key
+    #
+    # @see https://developer.github.com/v3/repos/keys/#get
+    #
+    # @param [String] :user
+    # @param [String] :repo
+    # @param [Integer] :id
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.keys.get 'user-name', 'repo-name', 'key-id'
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:user, :repo, :id])
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/keys/#{arguments.id}", arguments.params)
+    end
+    alias_method :find, :get
+
+    # Create a key
+    #
+    # @see https://developer.github.com/v3/repos/keys/#create
+    #
+    # @param [String] :user
+    # @param [String] :repo
+    # @param [Hash] params
+    # @option params [String] :title
+    #   Required string.
+    # @option params [String] :key
+    #   Required string.
+    # @option params [String] :read_only
+    #   If true, the key will only be able to read repository contents.
+    #   Otherwise, the key will be able to read and write.
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.keys.create 'user-name', 'repo-name',
+    #     title: "octocat@octomac",
+    #     key:  "ssh-rsa AAA..."
+    #
+    # @api public
+    def create(*args)
+      arguments(args, required: [:user, :repo])
+
+      post_request("/repos/#{arguments.user}/#{arguments.repo}/keys",
+                   arguments.params)
+    end
+    alias_method :add, :create
+
+    # Delete key
+    #
+    # @see https://developer.github.com/v3/repos/keys/#delete
+    #
+    # @param [String] :user
+    # @param [String] :repo
+    # @param [Integer] :id
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.keys.delete 'user-name', 'repo-name', 'key-id'
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:user, :repo, :id])
+
+      delete_request("/repos/#{arguments.user}/#{arguments.repo}/keys/#{arguments.id}", arguments.params)
+    end
+    alias_method :remove, :delete
+  end # Client::Repos::Keys
+end # Github

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

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  # The Repo Merging API supports merging branches in a repository. This
+  # accomplishes essentially the same thing as merging one branch into another
+  # in a local repository and then pushing to GitHub.
+  class Client::Repos::Merging < API
+
+    VALID_MERGE_PARAM_NAMES = %w[
+      base
+      head
+      commit_message
+    ].freeze # :nodoc:
+
+    REQUIRED_MERGE_PARAMS = %w[ base head ].freeze # :nodoc:
+
+    # Perform a merge
+    #
+    # @param [Hash] params
+    # @input params [String] :base
+    #   Required. The name of the base branch that the head will be merged into.
+    # @input params [String] :head
+    #   Required. The head to merge. This can be a branch name or a commit SHA1.
+    # @input params [String] :commit_message
+    #   Commit message to use for the merge commit.
+    #   If omitted, a default message will be used.
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.merging.merge 'user', 'repo',
+    #     base: "master",
+    #     head: "cool_feature",
+    #     commit_message: "Shipped cool_feature!"
+    #
+    # @api public
+    def merge(*args)
+      arguments(args, required: [:user, :repo]) do
+        permit VALID_MERGE_PARAM_NAMES
+        assert_required REQUIRED_MERGE_PARAMS
+      end
+
+      post_request("/repos/#{arguments.user}/#{arguments.repo}/merges", arguments.params)
+    end
+  end # Client::Repos::Merging
+end # Github

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

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  # The Pages API retrieves information about your GitHub Pages configuration,
+  # and the statuses of your builds. Information about the site and the builds
+  # can only be accessed by authenticated owners, even though the websites
+  # are public.
+  class Client::Repos::Pages < API
+
+    # List Pages builds
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.pages.list owner: 'owner-name', repo: 'repo-name'
+    #
+    #  github = Github.new
+    #  github.repos.pages.list :latest, owner: 'owner-name', repo: 'repo-name'
+    # @api public
+    def list(*args)
+      arguments(args, required: [:owner, :repo])
+
+      response = if args.map(&:to_s).include?('latest')
+        get_request("/repos/#{arguments.owner}/#{arguments.repo}/pages/builds/latest", arguments.params)
+      else
+        get_request("/repos/#{arguments.owner}/#{arguments.repo}/pages/builds", arguments.params)
+      end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get information about a Pages site
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.pages.get owner: 'owner-name', repo: 'repo-name'
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:owner, :repo])
+
+      get_request("/repos/#{arguments.owner}/#{arguments.repo}/pages", arguments.params)
+    end
+    alias :find :get
+  end # Client::Repos::Pages
+end # Github

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative '../../api'
+
+module Github
+  class Client::Repos::Projects < API
+    PREVIEW_MEDIA = "application/vnd.github.inertia-preview+json".freeze # :nodoc:
+
+    # List a repo's projects
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.projects.list owner: 'owner-name', repo: 'repo-name'
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.projects.list state: 'open', owner: 'owner-name', repo: 'repo-name'
+    #
+    # @example
+    #  github.repos.projects.list owner: 'owner-name', repo: 'repo-name' { |cbr| .. }
+    #
+    # @return [Array]
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:owner, :repo])
+      params = arguments.params
+
+      params["accept"] ||= PREVIEW_MEDIA
+
+      response = get_request("/repos/#{arguments.owner}/#{arguments.repo}/projects", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Create a new project for the specified repo
+    #
+    # @param [Hash] params
+    # @option params [String] :name
+    #   Required string - The name of the project.
+    # @option params [String] :body
+    #   Optional string - The body of the project.
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.projects.create 'owner-name', 'repo-name', name: 'project-name'
+    #  github.repos.projects.create name: 'project-name', body: 'project-body', owner: 'owner-name', repo: 'repo-name'
+    #
+    # @api public
+    def create(*args)
+      arguments(args, required: [:owner, :repo]) do
+        assert_required %w[ name ]
+      end
+      params = arguments.params
+
+      params["accept"] ||= PREVIEW_MEDIA
+
+      post_request("/repos/#{arguments.owner}/#{arguments.repo}/projects", params)
+    end
+  end # Projects
+end # Github

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

@@ -0,0 +1,133 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Repos::PubSubHubbub < API
+    HEADERS = {
+      CONTENT_TYPE => 'application/x-www-form-urlencoded'
+    }
+
+    # Subscribe to existing topic/event through pubsubhubbub
+    #
+    # @param [Hash] params
+    # @input params [String] :topic
+    #   Required string. The URI of the GitHub repository to subscribe to.
+    #   The path must be in the format of /:user/:repo/events/:event.
+    # @input params [String] :callback
+    #   Required string - The URI to receive the updates to the topic.
+    #
+    # @example
+    #  github = Github.new oauth_token: 'token'
+    #  github.repos.pubsubhubbub.subscribe
+    #    'https://github.com/:user/:repo/events/push',
+    #    'github://Email?address=peter-murach@gmail.com',
+    #    verify: 'sync',
+    #    secret: '...'
+    #
+    # @api public
+    def subscribe(*args)
+      params = arguments(args, required: [:topic, :callback]).params
+      _merge_action!("subscribe", arguments.topic, arguments.callback, params)
+      params['headers'] = HEADERS
+
+      post_request("/hub", params)
+    end
+
+    # Unsubscribe from existing topic/event through pubsubhubbub
+    #
+    # @param [Hash] params
+    # @input params [String] :topic
+    #   Required string. The URI of the GitHub repository to
+    #   unsubscribe from. The path must be in the format of
+    #   /:user/:repo/events/:event.
+    # @input params [String] :callback
+    #   Required string. The URI to unsubscribe the topic from.
+    #
+    # @example
+    #   github = Github.new oauth_token: 'token'
+    #   github.repos.pubsubhubbub.unsubscribe
+    #     'https://github.com/:user/:repo/events/push',
+    #     'github://Email?address=peter-murach@gmail.com',
+    #     verify: 'sync',
+    #     secret: '...'
+    #
+    # @api public
+    def unsubscribe(*args)
+      params = arguments(args, required: [:topic, :callback]).params
+      _merge_action!("unsubscribe", arguments.topic, arguments.callback, params)
+      params['headers'] = HEADERS
+
+      post_request("/hub", params)
+    end
+
+    # Subscribe repository to service hook through pubsubhubbub
+    #
+    # @param [Hash] params
+    # @input params [String] :event
+    #   Required hash key for the type of event. The default event is push.
+    #
+    # @example
+    #   github = Github.new oauth_token: '...'
+    #   github.repos.pubsubhubbub.subscribe_service 'user-name', 'repo-name',
+    #    'campfire',
+    #     subdomain: 'github',
+    #     room: 'Commits',
+    #     token: 'abc123',
+    #     event: 'watch'
+    #
+    # @api public
+    def subscribe_service(*args)
+      params   = arguments(args, required: [:user, :repo, :service]).params
+      event    = params.delete('event') || 'push'
+      topic    = "#{site}/#{arguments.user}/#{arguments.repo}/events/#{event}"
+      callback = "github://#{arguments.service}?#{params.serialize}"
+
+      subscribe(topic, callback)
+    end
+    alias :subscribe_repository :subscribe_service
+    alias :subscribe_repo :subscribe_service
+
+    # Subscribe repository to service hook through pubsubhubbub
+    #
+    # @param [Hash] params
+    # @input params [String] :event
+    #   Optional hash key for the type of event. The default event is push.
+    #
+    # @example
+    #   github = Github.new oauth_token: '...'
+    #   github.repos.pubsubhubbub.unsubscribe_service 'user-name', 'repo-name',
+    #     'campfire'
+    #
+    # @example
+    #   github.repos.pubsubhubbub.unsubscribe_service
+    #     user: 'user-name',
+    #     repo: 'repo-name',
+    #     service: 'service-name'
+    #
+    # @api public
+    def unsubscribe_service(*args)
+      params   = arguments(args, required: [:user, :repo, :service]).params
+      event    = params.delete('event') || 'push'
+      topic    = "#{site}/#{arguments.user}/#{arguments.repo}/events/#{event}"
+      callback = "github://#{arguments.service}"
+
+      unsubscribe(topic, callback)
+    end
+    alias :unsubscribe_repository :unsubscribe_service
+    alias :unsubscribe_repo :unsubscribe_service
+
+    private
+
+    def _merge_action!(action, topic, callback, params) # :nodoc:
+      options = {
+        "hub.mode"     => action.to_s,
+        "hub.topic"    => topic.to_s,
+        "hub.callback" => callback,
+        "hub.verify"   => params.delete('verify') || 'sync',
+        "hub.secret"   => params.delete('secret') || ''
+      }
+      params.merge! options
+    end
+  end # Client::Repos::PubSubHubbub
+end # Github