github_api 0.3.5 → 0.3.6

data/lib/github_api/orgs/members.rb

@@ -0,0 +1,120 @@
+# encoding: utf-8
+
+module Github
+  class Orgs
+    module Members
+
+      # 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.
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.orgs.members 'org-name'
+      #  @github.orgs.members 'org-name' { |memb| ... }
+      #
+      def members(org_name, params={})
+        _validate_presence_of org_name
+        _normalize_params_keys(params)
+        response = get("/orgs/#{org_name}/members", params)
+        return response unless block_given?
+        response.each { |el| yield el }
+      end
+      alias :list_members :members
+
+      # Check if user is a member of an organization
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.orgs.member? 'org-name', 'member-name'
+      #
+      def member?(org_name, member_name, params={})
+        _validate_presence_of org_name, member_name
+        _normalize_params_keys(params)
+        get("/orgs/#{org_name}/members/#{member_name}", params)
+        true
+      rescue Github::ResourceNotFound
+        false
+      end
+      alias :is_member? :member?
+
+      # 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.
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.orgs.delete_member 'org-name', 'member-name'
+      #
+      def delete_member(org_name, member_name, params={})
+        _validate_presence_of org_name, member_name
+        _normalize_params_keys(params)
+        delete("/orgs/#{org_name}/members/#{member_name}", params)
+      end
+      alias :remove_member :delete_member
+
+      # List public members
+      # Members of an organization can choose to have their membership publicized or not.
+      # = Examples
+      #  @github = Github.new
+      #  @github.orgs.public_members 'org-name'
+      #  @github.orgs.public_members 'org-name' { |memb| ... }
+      #
+      def public_members(org_name, params={})
+        _validate_presence_of org_name
+        _normalize_params_keys(params)
+        response = get("/orgs/#{org_name}/public_members", params)
+        return response unless block_given?
+        response.each { |el| yield el }
+      end
+      alias :list_public_members :public_members
+
+      # Get if a user is a public member of an organization
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.orgs.public_member? 'org-name', 'member-name'
+      #
+      def public_member?(org_name, member_name, params={})
+        _validate_presence_of org_name, member_name
+        _normalize_params_keys(params)
+        get("/orgs/#{org_name}/public_members/#{member_name}", params)
+        true
+      rescue Github::ResourceNotFound
+        false
+      end
+
+      # Publicize a user’s membership
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.orgs.publicize 'org-name', 'member-name'
+      #
+      def publicize(org_name, member_name, params={})
+        _validate_presence_of org_name, member_name
+        _normalize_params_keys(params)
+        put("/orgs/#{org_name}/public_members/#{member_name}", params)
+      end
+      alias :make_public :publicize
+      alias :publicize_membership :publicize
+
+      # Conceal a user’s membership
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.orgs.conceal 'org-name', 'member-name'
+      #
+      def conceal(org_name, member_name, params={})
+        _validate_presence_of org_name, member_name
+        _normalize_params_keys(params)
+        delete("/orgs/#{org_name}/public_members/#{member_name}", params)
+      end
+      alias :conceal_membership :conceal
+
+    end # Members
+  end # Orgs
+end # Github

data/lib/github_api/orgs/teams.rb

@@ -0,0 +1,245 @@
+# encoding: utf-8
+
+module Github
+  class Orgs
+    # All actions against teams require at a minimum an authenticated user
+    # who is a member of the owner’s team in the :org being managed.
+    # Api calls that require explicit permissions are noted.
+    module Teams
+
+      VALID_TEAM_PARAM_NAMES = %w[ name repo_names permission ].freeze
+      VALID_TEAM_PARAM_VALUES = {
+        'permission' => %w[ pull push admin ].freeze
+      }
+
+      # List teams
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.orgs.teams 'org-name'
+      #
+      def teams(org_name, params={})
+        _validate_presence_of org_name
+        _normalize_params_keys(params)
+
+        response = get("/orgs/#{org_name}/teams", params)
+        return response unless block_given?
+        response.each { |el| yield el }
+      end
+      alias :list_teams :teams
+
+      # Get a team
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.orgs.team 'team-name'
+      #
+      def team(team_name, params={})
+        _validate_presence_of team_name
+        _normalize_params_keys(params)
+
+        get("/teams/#{team_name}", params)
+      end
+      alias :get_team :team
+
+      # Create a team
+      #
+      # In order to create a team, the authenticated user must be an owner of<tt>:org</tt>.
+      # = Inputs
+      #  <tt>:name</tt> - Required string
+      #  <tt>:repo_names</tt> - Optional array of strings
+      #  <tt>:permission</tt> - Optional string
+      #    * <tt>pull</tt> - team members can pull, but not push or administor this repositories. Default
+      #    * <tt>push</tt> - team members can pull and push, but not administor this repositores.
+      #    * <tt>admin</tt> - team members can pull, push and administor these repositories.
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.orgs.create_team 'org-name',
+      #    "name" => "new team",
+      #    "permission" => "push",
+      #    "repo_names" => [
+      #      "github/dotfiles"
+      #     ]
+      #
+      def create_team(org_name, params={})
+        _validate_presence_of org_name
+        _normalize_params_keys(params)
+        _filter_params_keys(VALID_TEAM_PARAM_NAMES, params)
+        _validate_params_values(VALID_TEAM_PARAM_VALUES, params)
+
+        raise ArgumentError, "Required params are: :name" unless _validate_inputs(%w[ name ], params)
+
+        post("/orgs/#{org_name}/teams", params)
+      end
+
+      # Edit a team
+      # In order to edit a team, the authenticated user must be an owner of the org that the team is associated with.
+      #
+      # = Inputs
+      #  <tt>:name</tt> - Required string
+      #  <tt>:permission</tt> - Optional string
+      #    * <tt>pull</tt> - team members can pull, but not push or administor this repositories. Default
+      #    * <tt>push</tt> - team members can pull and push, but not administor this repositores.
+      #    * <tt>admin</tt> - team members can pull, push and administor these repositories.
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.orgs.edit_team 'team-name',
+      #    "name" => "new team name",
+      #    "permission" => "push"
+      #
+      def edit_team(team_name, params={})
+        _validate_presence_of team_name
+        _normalize_params_keys(params)
+        _filter_params_keys(VALID_TEAM_PARAM_NAMES, params)
+        _validate_params_values(VALID_TEAM_PARAM_VALUES, params)
+
+        raise ArgumentError, "Required params are: :name" unless _validate_inputs(%w[ name ], params)
+
+        patch("/teams/#{team_name}", params)
+      end
+
+      # Delete a team
+      # In order to delete a team, the authenticated user must be an owner of the org that the team is associated with
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.orgs.delete_team 'team-name'
+      #
+      def delete_team(team_name, params={})
+        _validate_presence_of team_name
+        _normalize_params_keys(params)
+        delete("/teams/#{team_name}", params)
+      end
+
+      # List team members
+      # In order to list members in a team, the authenticated user must be a member of the team.
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.orgs.team_members 'team-name'
+      #  @github.orgs.team_members 'team-name' { |member| ... }
+      #
+      def team_members(team_name, params={})
+        _validate_presence_of team_name
+        _normalize_params_keys(params)
+
+        response = get("/teams/#{team_name}/members", params)
+        return response unless block_given?
+        response.each { |el| yield el }
+      end
+      alias :list_team_members :team_members
+
+      # Check if a user is a member of a team
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.orgs.team_member? 'team-name', 'user-name'
+      #
+      def team_member?(team_name, member_name, params={})
+        _validate_presence_of team_name, member_name
+        _normalize_params_keys(params)
+        get("/teams/#{team_name}/members/#{member_name}", params)
+        true
+      rescue Github::ResourceNotFound
+        false
+      end
+
+      # Add a team member
+      # In order to add a user to a team, the authenticated user must have ‘admin’ permissions to the team or be an owner of the org that the team is associated with.
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.orgs.add_team_member 'team-name', 'user-name'
+      #
+      def add_team_member(team_name, member_name, params={})
+        _validate_presence_of team_name, member_name
+        _normalize_params_keys(params)
+        put("/teams/#{team_name}/members/#{member_name}", params)
+      end
+      alias :add_member :add_team_member
+
+      # Remove a team member
+      # In order to remove a user from a team, the authenticated user must
+      # have ‘admin’ permissions to the team or be an owner of the org that
+      # the team is associated with.
+      # note: This does not delete the user, it just remove them from the team.
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.orgs.remove_team_member 'team-name', 'member-name'
+      #
+      def remove_team_member(team_name, member_name, params={})
+        _validate_presence_of team_name, member_name
+        _normalize_params_keys(params)
+        delete("/teams/#{team_name}/members/#{member_name}", params)
+      end
+      alias :remove_member :remove_team_member
+
+      # List team repositories
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.orgs.team_repos 'team-name'
+      #
+      def team_repos(team_name, params={})
+        _validate_presence_of team_name
+        _normalize_params_keys(params)
+
+        response = get("/teams/#{team_name}/repos", params)
+        return response unless block_given?
+        response.each { |el| yield el }
+      end
+      alias :team_repositories :team_repos
+
+      # Check if a repository belongs to a team
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.orgs.team_repo? 'team-name', 'user-name', 'repo-name'
+      #
+      def team_repo?(team_name, user_name, repo_name, params={})
+        _validate_presence_of team_name, user_name, repo_name
+        _normalize_params_keys(params)
+        get("/teams/#{team_name}/repos/#{user_name}/#{repo_name}", params)
+        true
+      rescue Github::ResourceNotFound
+        false
+      end
+      alias :team_repository? :team_repo?
+
+      # Add a team repository
+      # In order to add a repo to a team, the authenticated user must be
+      # an owner of the org that the team is associated with.
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.orgs.add_team_repo 'team-name', 'user-name', 'repo-name'
+      #
+      def add_team_repo(team_name, user_name, repo_name, params={})
+        _validate_presence_of team_name, user_name, repo_name
+        _normalize_params_keys(params)
+        put("/teams/#{team_name}/repos/#{user_name}/#{repo_name}", params)
+      end
+      alias :add_team_repository :add_team_repo
+
+      # Remove a team repository
+      # In order to add a repo to a team, the authenticated user must be
+      # an owner of the org that the team is associated with. 
+      # note: This does not delete the repo, it just removes it from the team.
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.orgs.remove_team_repo 'team-name', 'user-name', 'repo-name'
+      #
+      def remove_team_repo(team_name, user_name, repo_name, params={})
+        _validate_presence_of team_name, user_name, repo_name
+        _normalize_params_keys(params)
+        delete("/teams/#{team_name}/repos/#{user_name}/#{repo_name}", params)
+      end
+      alias :remove_team_repository :remove_team_repo
+
+    end # Teams
+  end # Orgs
+end # Github

data/lib/github_api/pull_requests.rb

@@ -0,0 +1,224 @@
+# encoding: utf-8
+
+module Github
+  class PullRequests < API
+    extend AutoloadHelper
+
+    autoload_all 'github_api/pull_requests',
+      :Comments => 'comments'
+
+    include Github::PullRequests::Comments
+
+    VALID_REQUEST_PARAM_NAMES = %w[
+      title
+      body
+      base
+      head
+      state
+      issue
+      commit_message
+      mime_type
+      resource
+    ].freeze
+
+    VALID_REQUEST_PARAM_VALUES = {
+      'state' => %w[ open closed ]
+    }
+
+    # Creates new Gists API
+    def initialize(options = {})
+      super(options)
+    end
+
+    # List pull requests
+    #
+    # = Examples
+    #  @github = Github.new :user => 'user-name', :repo => 'repo-name'
+    #  @github.pull_requests.pull_requests
+    #  @github.pull_requests.pull_requests { |req| ... }
+    #
+    #  @pull_reqs = Github::PullRequests.new
+    #  @pull_reqs.pull_requests 'user-name', 'repo-name'
+    #
+    def pull_requests(user_name=nil, repo_name=nil, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless (user? && repo?)
+
+      _normalize_params_keys(params)
+      _filter_params_keys(VALID_REQUEST_PARAM_NAMES, params)
+      _merge_mime_type(:pull_request, params)
+      _validate_params_values(VALID_REQUEST_PARAM_VALUES, params)
+
+      response = get("/repos/#{user}/#{repo}/pulls", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # Get a single pull request
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.pull_requests.pull_request 'user-name', 'repo-name', 'request-id'
+    #
+    #  @pull_reqs = Github::PullRequests.new
+    #  @pull_reqs.pull_request 'user-name', 'repo-name', 'request-id'
+    #
+    def pull_request(user_name, repo_name, request_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of request_id
+
+      _normalize_params_keys(params)
+      _merge_mime_type(:pull_request, params)
+
+      get("/repos/#{user}/#{repo}/pulls/#{request_id}", params)
+    end
+
+    # Create a pull request
+    #
+    # = Inputs
+    # * <tt>:title</tt> - Required string
+    # * <tt>:body</tt> - Optional string
+    # * <tt>:base</tt> - Required string - The branch you want your changes pulled into.
+    # * <tt>:head</tt> - Required string - The branch where your changes are implemented.
+    # note: head and base can be either a sha or a branch name.
+    # Typically you would namespace head with a user like this: username:branch.
+    # = Alternative Input
+    # You can also create a Pull Request from an existing Issue by passing
+    # an Issue number instead of <tt>title</tt> and <tt>body</tt>.
+    # * <tt>issue</tt> - Required number - Issue number in this repository to turn into a Pull Request.
+    #
+    # = Examples
+    #  @github = Github.new :oauth_token => '...'
+    #  @github.pull_requests.create_request 'user-name', 'repo-name',
+    #    "title" => "Amazing new feature",
+    #    "body" => "Please pull this in!",
+    #    "head" => "octocat:new-feature",
+    #    "base" => "master"
+    #
+    # alternatively
+    #
+    #  @github.pull_requests.create_request 'user-name', 'repo-name',
+    #    "issue" => "5",
+    #    "head" => "octocat:new-feature",
+    #    "base" => "master"
+    #
+    def create_request(user_name=nil, repo_name=nil, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+
+      _normalize_params_keys(params)
+      _merge_mime_type(:pull_request, params)
+      _filter_params_keys(VALID_REQUEST_PARAM_NAMES, params)
+
+      post("/repos/#{user}/#{repo}/pulls", params)
+    end
+
+    # Update a pull request
+    #
+    # = Inputs
+    # * <tt>:title</tt> - Optional string
+    # * <tt>:body</tt> - Optional string
+    # * <tt>:state</tt> - Optional string - State of this Pull Request. Valid values are <tt>open</tt> and <tt>closed</tt>.
+    #
+    # = Examples
+    #  @github = Github.new :oauth_token => '...'
+    #  @github.pull_requests.update_request 'user-name', 'repo-name', 'request-id'
+    #    "title" => "Amazing new title",
+    #    "body" => "Update body",
+    #    "state" => "open",
+    #
+    def update_request(user_name, repo_name, request_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of request_id
+
+      _normalize_params_keys(params)
+      _filter_params_keys(VALID_REQUEST_PARAM_NAMES, params)
+      _merge_mime_type(:pull_request, params)
+      _validate_params_values(VALID_REQUEST_PARAM_VALUES, params)
+
+      patch("/repos/#{user}/#{repo}/pulls/#{request_id}", params)
+    end
+
+    # List commits on a pull request
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.pull_requests.request_commits 'user-name', 'repo-name', 'request-id'
+    #
+    def request_commits(user_name, repo_name, request_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of request_id
+
+      _normalize_params_keys(params)
+      _merge_mime_type(:pull_request, params)
+
+      response = get("/repos/#{user}/#{repo}/pulls/#{request_id}/commits", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # List pull requests files
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.pull_requests.request_files 'user-name', 'repo-name', 'request-id'
+    #
+    def request_files(user_name, repo_name, request_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of request_id
+
+      _normalize_params_keys(params)
+      _merge_mime_type(:pull_request, params)
+
+      response = get("/repos/#{user}/#{repo}/pulls/#{request_id}/files", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # Check if pull request has been merged
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.pull_requests.merged? 'user-name', 'repo-name', 'request-id'
+    #
+    def merged?(user_name, repo_name, request_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of request_id
+
+      _normalize_params_keys(params)
+      _merge_mime_type(:pull_request, params)
+
+      get("/repos/#{user}/#{repo}/pulls/#{request_id}/merge", params)
+      true
+    rescue Github::ResourceNotFound
+      false
+    end
+
+    # Merge a pull request(Merge Button)
+    #
+    # = Inputs
+    #  <tt>:commit_message</tt> - Optional string - The message that will be used for the merge commit
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.pull_requests.request_files 'user-name', 'repo-name', 'request-id'
+    #
+    def merge(user_name, repo_name, request_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of request_id
+
+      _normalize_params_keys(params)
+      _merge_mime_type(:pull_request, params)
+      _filter_params_keys(VALID_REQUEST_PARAM_NAMES, params)
+
+      put("/repos/#{user}/#{repo}/pulls/#{request_id}/merge", params)
+    end
+
+  end # PullRequests
+end # Github