piotrmurach/github

# encoding: utf-8

require_relative '../../api'

module Github
  class Client::Orgs::Memberships < API
    # List your organization memberships
    #
    # @see List your organization memberships
    #
    # @example
    #   github = Github.new
    #   github.orgs.memberships.list
    #
    # @api public
    def list(*args)
      arguments(args)

      response = get_request('/user/memberships/orgs', arguments.params)
      return response unless block_given?
      response.each { |el| yield el }
    end
    alias_method :all, :list

    # Get organization membership
    #
    # In order to get a user's membership with an organization,
    # the authenticated user must be an organization owner.
    #
    # @see https://developer.github.com/v3/orgs/members/#get-organization-membership
    # @param [String] :org
    # @param [String] :username
    #
    # @example
    #   github = Github.new oauth_toke: '...'
    #   github.orgs.memberships.get 'orgname', username: 'piotr'
    #
    # Get your organization membership
    #
    # @see https://developer.github.com/v3/orgs/members/#get-your-organization-membership
    #
    # @example
    #   github = Github.new oauth_token
    #   github.orgs.memberships.get 'orgname'
    #
    # @api public
    def get(*args)
      arguments(args, required: [:org_name])
      params = arguments.params

      if (username = params.delete('username'))
        get_request("/orgs/#{arguments.org_name}/memberships/#{username}", params)
      else
        get_request("/user/memberships/orgs/#{arguments.org_name}", params)
      end
    end
    alias_method :find, :get

    # Add/update user's membership with organization
    #
    # In order to create or update a user's membership with an organization,
    # the authenticated user must be an organization owner.
    #
    # @see https://developer.github.com/v3/orgs/members/#add-or-update-organization-membership
    #
    # @param [String] :org
    # @param [String] :username
    # @param [Hash] options
    # @option options [String] :role
    #   Required. The role to give the user in the organization. Can be one of:
    #     * admin - The user will become an owner of the organization.
    #     * member - The user will become a non-owner member of the organization.
    #
    # @example
    #   github = Github.new oauth_token: '...'
    #   github.orgs.memberships.add 'org-name', 'member-name', role: 'role'
    #
    # @api public
    def create(*args)
      arguments(args, required: [:org_name, :username]) do
        assert_required :role
      end

      put_request("/orgs/#{arguments.org_name}/memberships/#{arguments.username}",
                  arguments.params)
    end
    alias_method :update, :create
    alias_method :add, :create

    # Edit your organization membership
    #
    # @see https://developer.github.com/v3/orgs/members/#edit-your-organization-membership
    # @param [String] :org
    # @param [Hash] params
    # @option params [String] :state
    #   Required. The state that the membership should be in.
    #   Only "active" will be accepted.
    #
    # @example
    #   github = Github.new oauth_token: '...'
    #   github.orgs.memberships.edit 'org-name', state: 'active'
    #
    # @api public
    def edit(*args)
      arguments(args, required: [:org_name]) do
        assert_required :state
      end

      patch_request("/user/memberships/orgs/#{arguments.org_name}",
                    arguments.params)
    end

    # Remove organization membership
    #
    # @see https://developer.github.com/v3/orgs/members/#remove-organization-membership
    # @param [String] :org
    # @param [String] :username
    #
    # @example
    #   github = Github.new oauth_token: '...'
    #   github.orgs.memberships.remove 'orgname', 'username'
    #
    # @api public
    def delete(*args)
      arguments(args, required: [:org_name, :username])

      delete_request("/orgs/#{arguments.org_name}/memberships/#{arguments.username}", arguments.params)
    end
    alias_method :remove, :delete
  end # Client::Orgs::Memberships
end # Github