lingfennan-github_api 0.18.2

data/lib/github_api/client/markdown.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+require_relative '../api'
+
+module Github
+  class Client::Markdown < API
+
+    # Render an arbritrary Markdown document
+    #
+    # = Parameters
+    #  <tt>:text</tt> - Required string - The Markdown text to render
+    #  <tt>:mode<tt> - Optional string - The rendering mode
+    #    * <tt>markdown</tt> to render a document as plain Markdown, just
+    #                        like README files are rendered.
+    #    * <tt>gfm</tt> to render a document as user-content, e.g. like user
+    #      comments or issues are rendered. In GFM mode, hard line breaks are
+    #      always taken into account, and issue and user mentions are
+    #      linked accordingly.
+    #  <tt>:context<tt> - Optional string - The repository context, only taken
+    #                     into account when rendering as <tt>gfm</tt>
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.markdown.render
+    #    "text": "Hello world github/linguist#1 **cool**, and #1!",
+    #    "mode": "gfm",
+    #    "context": "github/gollum"
+    #
+    def render(*args)
+      arguments(args) do
+        assert_required ['text']
+      end
+      params = arguments.params
+      params['raw'] = true
+
+      post_request("markdown", arguments.params)
+    end
+
+    # Render a Markdown document in raw mode
+    #
+    # = Input
+    #  The raw API it not JSON-based. It takes a Markdown document as plaintext
+    #  <tt>text/plain</tt> or <tt>text/x-markdown</tt> and renders it as plain
+    #  Markdown without a repository context (just like a README.md file is
+    #  rendered – this is the simplest way to preview a readme online)
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.markdown.render_raw "Hello github/linguist#1 **cool**, and #1!",
+    #    "accept": "text/plain",
+    #
+    def render_raw(*args)
+      params = arguments(args).params
+      params['data'] = args.shift
+      params['raw'] = true
+      params['accept'] = params.fetch('accept') { 'text/plain' }
+
+      post_request("markdown/raw", params)
+    end
+
+  end # Markdown
+end # Github

data/lib/github_api/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_api/client/orgs.rb

@@ -0,0 +1,127 @@
+# encoding: utf-8
+
+require_relative '../api'
+
+module Github
+  # Organizations API
+  class Client::Orgs < API
+
+    require_all 'github_api/client/orgs',
+                'hooks',
+                'members',
+                'memberships',
+                'projects',
+                'teams'
+
+    # Access to Client::Orgs::Hooks API
+    namespace :hooks
+
+    # Access to Client::Orgs::Members API
+    namespace :members
+
+    # Access to Client::Orgs::Memberships API
+    namespace :memberships
+
+    # Access to Client::Orgs::Projects API
+    namespace :projects
+
+    # Access to Client::Orgs::Teams API
+    namespace :teams
+
+    # List all organizations
+    #
+    # Lists all organizations, in the order that they were created on GitHub.
+    #
+    # @see https://developer.github.com/v3/orgs/#list-all-organizations
+    #
+    # @param [Hash] params
+    # @option params [String] :since
+    #   The integer ID of the last Organization that you've seen.
+    #
+    # @example
+    #   github = Github.new
+    #   github.orgs.list :every
+    #
+    # List all public organizations for a user.
+    #
+    # @see https://developer.github.com/v3/orgs/#list-user-organizations
+    #
+    # @example
+    #   github = Github.new
+    #   github.orgs.list user: 'user-name'
+    #
+    # List public and private organizations for the authenticated user.
+    #
+    # @example
+    #   github = Github.new oauth_token: '..'
+    #   github.orgs.list
+    #
+    # @api public
+    def list(*args)
+      params = arguments(args).params
+
+      if (user_name = params.delete('user'))
+        response = get_request("/users/#{user_name}/orgs", params)
+      elsif args.map(&:to_s).include?('every')
+        response = get_request('/organizations', params)
+      else
+        # For the authenticated user
+        response = get_request('/user/orgs', params)
+      end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias_method :all, :list
+
+    # Get properties for a single organization
+    #
+    # @see https://developer.github.com/v3/orgs/#get-an-organization
+    #
+    # @example
+    #  github = Github.new
+    #  github.orgs.get 'github'
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:org_name])
+
+      get_request("/orgs/#{arguments.org_name}", arguments.params)
+    end
+    alias_method :find, :get
+
+    # Edit organization
+    #
+    # @see https://developer.github.com/v3/orgs/#edit-an-organization
+    #
+    # @param [Hash] params
+    # @option params [String] :billing_email
+    #   Billing email address. This address is not publicized.
+    # @option params [String] :company
+    #   The company name
+    # @option params [String] :email
+    #   The publicly visible email address
+    # @option params [String] :location
+    #   The location
+    # @option params [String] :name
+    #   The shorthand name of the company.
+    # @option params [String] :description
+    #   The description of the company.
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.orgs.edit 'github',
+    #    billing_email: "support@github.com",
+    #    blog: "https://github.com/blog",
+    #    company: "GitHub",
+    #    email: "support@github.com",
+    #    location: "San Francisco",
+    #    name: "github"
+    #
+    # @api public
+    def edit(*args)
+      arguments(args, required: [:org_name])
+
+      patch_request("/orgs/#{arguments.org_name}", arguments.params)
+    end
+  end # Orgs
+end # Github

data/lib/github_api/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_api/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