github_api2 1.0.0

data/lib/github_api2/client/meta.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require_relative '../api'
+
+module Github
+  class Client::Meta < API
+    # Get meta information about GitHub.com, the service.
+    #
+    # @example
+    #   Github.meta.get
+    #
+    # @api public
+    def get(*args)
+      arguments(*args)
+
+      get_request("/meta", arguments.params)
+    end
+  end # Client::Meta
+end # Github

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

@@ -0,0 +1,182 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  # The Organizations Hooks API manages the post-receive web and
+  # service hooks for an organization.
+  class Client::Orgs::Hooks < API
+
+    REQUIRED_PARAMS = %w( name config ).freeze # :nodoc:
+
+    # List organization hooks
+    #
+    # @see https://developer.github.com/v3/orgs/hooks/#list-hooks
+    #
+    # @example
+    #   github = Github.new
+    #   github.orgs.hooks.list 'org-name'
+    #   github.orgs.hooks.list 'org-name' { |hook| ... }
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:org_name])
+
+      response = get_request("/orgs/#{arguments.org_name}/hooks", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias_method :all, :list
+
+    # Get a single hook
+    #
+    # @see https://developer.github.com/v3/orgs/hooks/#get-single-hook
+    #
+    # @example
+    #   github = Github.new
+    #   github.orgs.hooks.get 'org-name', 'hook-id'
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:org_name, :id])
+
+      get_request("/orgs/#{arguments.org_name}/hooks/#{arguments.id}",
+                  arguments.params)
+    end
+    alias_method :find, :get
+
+    # Create a hook
+    #
+    # @see https://developer.github.com/v3/orgs/hooks/#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".or instance, if the library doesn't get updated to permit a given parameter the api call won't work, however if we skip permission all together, the endpoint should always work provided the actual resource path doesn't change. I'm in the process of completely removing the permit functionality.
+    #
+    # @example
+    #   github = Github.new
+    #   github.orgs.hooks.create 'org-name',
+    #     name:  "web",
+    #     active: true,
+    #     config: {
+    #       url: "http://something.com/webhook"
+    #     }
+    #   }
+    #
+    # @api public
+    def create(*args)
+      arguments(args, required: [:org_name]) do
+        assert_required REQUIRED_PARAMS
+      end
+
+      post_request("/orgs/#{arguments.org_name}/hooks", arguments.params)
+    end
+
+    # Edit a hook
+    #
+    # @see https://developer.github.com/v3/orgs/hooks/#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.orgs.hooks.edit 'org-name', 'hook-id',
+    #    "name" => "campfire",
+    #    "active" =>  true,
+    #    "config" =>  {
+    #      "subdomain" => "github",
+    #      "room" =>  "Commits",
+    #      "token" => "abc123"
+    #    }
+    #
+    # @api public
+    def edit(*args)
+      arguments(args, required: [:org_name, :id]) do
+        assert_required REQUIRED_PARAMS
+      end
+
+      patch_request("/orgs/#{arguments.org_name}/hooks/#{arguments.id}",
+                    arguments.params)
+    end
+
+    # Ping a hook
+    #
+    # This will trigger a ping event to be sent to the hook.
+    #
+    # @see https://developer.github.com/v3/orgs/hooks/#ping-a-hook
+    #
+    # @example
+    #   github = Github.new
+    #   github.orgs.hooks.ping 'org-name', 'hook-id'
+    #
+    # @api public
+    def ping(*args)
+      arguments(args, required: [:org_name, :id])
+
+      post_request("/orgs/#{arguments.org_name}/hooks/#{arguments.id}/pings",
+                   arguments.params)
+    end
+
+    # Delete a hook
+    #
+    # @see https://developer.github.com/v3/orgs/hooks/#delete-a-hook
+    #
+    # @example
+    #   github = Github.new
+    #   github.orgs.hooks.delete 'org-name', 'hook-id'
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:org_name, :id])
+
+      delete_request("/orgs/#{arguments.org_name}/hooks/#{arguments.id}",
+                     arguments.params)
+    end
+  end # Client::Orgs::Hooks
+end # Github

data/lib/github_api2/client/orgs/members.rb

@@ -0,0 +1,142 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Orgs::Members < API
+    # List members
+    #
+    # List all users who are members of an organization. A member is a user
+    # that belongs to at least 1 team in the organization.
+    # If the authenticated user is also a member of this organization then
+    # both concealed and public members will be returned.
+    # Otherwise only public members are returned.
+    #
+    # @see https://developer.github.com/v3/orgs/members/#members-list
+    #
+    # @param [Hash] params
+    # @option params [String] :filter
+    #   Filter members returned in the list. Can be one of:
+    #   * 2fa_disabled: Members without two-factor authentication enabled.
+    #   Available for owners of organizations with private repositories.
+    #   * all: All members the authenticated user can see.
+    #   Default: all
+    # @option params [String] :role
+    #   Filter members returned by their role. Can be one of:
+    #     * all: All members of the organization, regardless of role.
+    #     * admin: Organization owners.
+    #     * member: Non-owner organization members.
+    #
+    # @example
+    #   github = Github.new
+    #   github.orgs.members.list 'org-name'
+    #   github.orgs.members.list 'org-name' { |memb| ... }
+    #
+    # List public members
+    #
+    # @see https://developer.github.com/v3/orgs/members/#public-members-list
+    #
+    # Members of an organization can choose to have their
+    # membership publicized or not.
+    #
+    # @example
+    #  github = Github.new
+    #  github.orgs.members.list 'org-name', public: true
+    #  github.orgs.members.list 'org-name', public: true { |memb| ... }
+    #
+    # @api public
+    def list(*args)
+      params = arguments(args, required: [:org_name]).params
+      org_name = arguments.org_name
+
+      response = if params.delete('public')
+                   get_request("/orgs/#{org_name}/public_members", params)
+                 else
+                   get_request("/orgs/#{org_name}/members", params)
+                 end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias_method :all, :list
+
+    # Check if user is, publicly or privately, a member of an organization
+    #
+    # @example
+    #   github = Github.new
+    #   github.orgs.members.member? 'org-name', 'member-name'
+    #
+    # Check if a user is a public member of an organization
+    #
+    # @example
+    #   github = Github.new
+    #   github.orgs.members.member? 'org-name', 'member-name', public: true
+    #
+    # @api public
+    def member?(*args)
+      params   = arguments(args, required: [:org_name, :user]).params
+      org_name = arguments.org_name
+      user     = arguments.user
+
+      response = if params.delete('public')
+                   get_request("/orgs/#{org_name}/public_members/#{user}", params)
+                 else
+                   get_request("/orgs/#{org_name}/members/#{user}", params)
+                 end
+      response.status == 204
+    rescue Github::Error::NotFound
+      false
+    end
+    # Remove a member
+    #
+    # Removing a user from this list will remove them from all teams and
+    # they will no longer have any access to the organization's repositories.
+    #
+    # @see https://developer.github.com/v3/orgs/members/#remove-a-member
+    #
+    # @example
+    #   github = Github.new
+    #   github.orgs.members.remove 'org-name', 'member-name'
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:org_name, :user])
+
+      delete_request("/orgs/#{arguments.org_name}/members/#{arguments.user}",
+                     arguments.params)
+    end
+    alias_method :remove, :delete
+
+    # Publicize a user's membership
+    #
+    # @see https://developer.github.com/v3/orgs/members/#publicize-a-users-membership
+    #
+    # @example
+    #   github = Github.new oauth_token: '...'
+    #   github.orgs.members.publicize 'org-name', 'member-name'
+    #
+    # @api public
+    def publicize(*args)
+      arguments(args, required: [:org_name, :user])
+
+      put_request("/orgs/#{arguments.org_name}/public_members/#{arguments.user}", arguments.params)
+    end
+    alias_method :make_public, :publicize
+    alias_method :publicize_membership, :publicize
+
+    # Conceal a user's membership
+    #
+    # @see https://developer.github.com/v3/orgs/members/#conceal-a-users-membership
+    #
+    # @example
+    #   github = Github.new oauth_token: '...'
+    #   github.orgs.members.conceal 'org-name', 'member-name'
+    #
+    # @api public
+    def conceal(*args)
+      arguments(args, required: [:org_name, :user])
+
+      delete_request("/orgs/#{arguments.org_name}/public_members/#{arguments.user}", arguments.params)
+    end
+    alias_method :conceal_membership, :conceal
+  end # Client::Orgs::Members
+end # Github

data/lib/github_api2/client/orgs/memberships.rb

@@ -0,0 +1,131 @@
+# 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

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative '../../api'
+
+module Github
+  class Client::Orgs::Projects < API
+    PREVIEW_MEDIA = "application/vnd.github.inertia-preview+json".freeze # :nodoc:
+
+    # List your organization projects
+    #
+    # @see List your organization projects
+    #
+    # @example
+    #   github = Github.new 'org-name'
+    #   github.orgs.projects.list 'org-name' { |project| ... }
+    #
+    # @example
+    #  github = Github.new
+    #  github.orgs.projects.list 'org-name', state: 'closed'
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:org_name])
+      params = arguments.params
+
+      params["accept"] ||= PREVIEW_MEDIA
+
+      response = get_request("/orgs/#{arguments.org_name}/projects", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias_method :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.create 'owner-name', 'repo-name', name: 'project-name'
+    #  github.repos.create name: 'project-name', body: 'project-body', owner: 'owner-name', repo: 'repo-name'
+    def create(*args)
+      arguments(args, required: [:org_name]) do
+        assert_required %w[ name ]
+      end
+      params = arguments.params
+
+      params["accept"] ||= PREVIEW_MEDIA
+
+      post_request("/orgs/#{arguments.org_name}/projects", params)
+    end
+  end # Projects
+end # Github