github_api 0.1.0.pre

data/lib/github_api/pull_requests/comments.rb

@@ -0,0 +1,134 @@
+# encoding: utf-8
+
+module Github
+  class PullRequests
+    module Comments
+
+      VALID_REQUEST_COM_PARAM_NAMES = %w[
+        body
+        commit_id
+        path
+        position
+        in_reply_to
+      ].freeze
+
+      # List comments on a pull request
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.pull_requests.request_comments 'user-name', 'repo-name', 'request-id'
+      #
+      def request_comments(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)
+
+        response = get("/repos/#{user}/#{repo}/pulls/#{request_id}/comments", params)
+        return response unless block_given?
+        response.each { |el| yield el }
+      end
+
+      # Get a single comment for pull requests
+      # = Examples
+      #  @github = Github.new
+      #  @github.pull_requests.request_comment 'user-name', 'repo-name', 'comment-id'
+      #
+      def request_comment(user_name, repo_name, comment_id, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of comment_id
+        _normalize_params_keys(params)
+
+        get("/repos/#{user}/#{repo}/pulls/comments/#{comment_id}", params)
+      end
+
+      # Create a pull request comment
+      #
+      # = Inputs
+      # * <tt>:body</tt> - Required string
+      # * <tt>:commit_id</tt> - Required string - sha of the commit to comment on.
+      # * <tt>:path</tt> - Required string - Relative path of the file to comment on.
+      # * <tt>:position</tt> - Required number - Line index in the diff to comment on
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.pull_requests.create_request_comment 'user-name', 'repo-name', 'request-id', "body" => "Nice change",
+      #   "commit_id" => "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+      #   "path" => "file1.txt",
+      #   "position" => 4
+      #
+      # = Alternative Inputs
+      # Instead of passing commit_id, path, and position you can reply to
+      # an existing Pull Request Comment like this
+      # * <tt>:body</tt> - Required string
+      # * <tt>:in_reply_to</tt> - Required number - comment id to reply to.
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.pull_requests.create_request_comment 'user-name', 'repo-name', 'request-id', "body" => "Nice change",
+      #   "in_reply_to" => 4
+      #
+      def create_request_comment(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_COM_PARAM_NAMES, params)
+        _validate_reply_to(params)
+
+        post("/repos/#{user}/#{repo}/pulls/#{request_id}/comments", params)
+      end
+
+      # Edit a pull request comment
+      #
+      # = Inputs
+      # * <tt>:body</tt> - Required string
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.pull_requests.edit_request_comment 'user-name', 'repo-name', 'comment-id', "body" => "Nice change",
+      #
+      def edit_request_comment(user_name, repo_name, comment_id, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of comment_id
+
+        _normalize_params_keys(params)
+        _filter_params_keys(VALID_REQUEST_COM_PARAM_NAMES, params)
+
+        patch("/repos/#{user}/#{repo}/pulls/comments/#{comment_id}", params)
+      end
+
+      # Delete a pull request comment
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.pull_requests.delete_request_comment 'user-name', 'repo-name',
+      #     'comment-id'
+      #
+      def delete_request_comment(user_name, repo_name, comment_id, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of comment_id
+        _normalize_params_keys(params)
+
+        delete("/repos/#{user}/#{repo}/pulls/comments/#{comment_id}", params)
+      end
+
+    private
+
+      # To let user know that the params supplied are wrong before request is made
+      def _validate_reply_to(params)
+        if params['in_reply_to'] && !_validate_inputs(%w[ body in_reply_to ], params)
+          raise ArgumentError, "Required params are: #{%w[ body in_reply_to].join(',')}"
+
+        elsif !_validate_inputs(VALID_REQUEST_COM_PARAM_NAMES - %w[ in_reply_to ], params)
+          raise ArgumentError, "Required params are: #{VALID_REQUEST_COM_PARAM_NAMES.join(', ')}"
+        end
+      end
+
+    end # Comments
+  end # PullRequests
+end # Github

data/lib/github_api/repos.rb

@@ -0,0 +1,256 @@
+# encoding: utf-8
+
+module Github
+  class Repos < API
+    extend AutoloadHelper
+
+    # Load all the modules after initializing Repos to avoid superclass mismatch
+    autoload_all 'github_api/repos',
+      :Collaborators => 'collaborators',
+      :Commits       => 'commits',
+      :Downloads     => 'downloads',
+      :Forks         => 'forks',
+      :Hooks         => 'hooks',
+      :Keys          => 'keys',
+      :Watching      => 'watching'
+
+    include Github::Repos::Collaborators
+    include Github::Repos::Commits
+    include Github::Repos::Downloads
+    include Github::Repos::Forks
+    include Github::Repos::Hooks
+    include Github::Repos::Keys
+    include Github::Repos::Watching
+
+    DEFAULT_REPO_OPTIONS = {
+      "homepage"   => "https://github.com",
+      "public"     => true,
+      "has_issues" => true,
+      "has_wiki"   => true,
+      "has_downloads" => true
+    }
+
+    VALID_REPO_OPTIONS = %w[
+      name
+      description
+      homepage
+      public
+      has_issues
+      has_wiki
+      has_downloads
+    ].freeze
+
+    VALID_REPO_TYPES = %w[ all public private member ]
+
+    # Creates new Repos API
+    def initialize(options = {})
+      super(options)
+    end
+
+    # List branches
+    #
+    # = Examples
+    #
+    #   @github = Github.new
+    #   @github.repos.branches 'user-name', 'repo-name'
+    #
+    #   @repos = Github::Repos.new
+    #   @repos.branches 'user-name', 'repo-name'
+    #
+    def branches(user_name=nil, repo_name=nil, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless (user? && repo?)
+
+      response = get("/repos/#{user}/#{repo}/branches", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # Create a new repository for the autheticated user.
+    #
+    # = Parameters
+    #  <tt>:name</tt> - Required string
+    #  <tt>:description</tt> - Optional string
+    #  <tt>:homepage</tt> - Optional string
+    #  <tt>:public</tt> - Optional boolean - true to create public repo, false to create a private one
+    #  <tt>:has_issues</tt> - Optional boolean - <tt>true</tt> to enable issues for this repository, <tt>false</tt> to disable them
+    #  <tt>:has_wiki</tt> - Optional boolean - <tt>true</tt> to enable the wiki for this repository, <tt>false</tt> to disable it. Default is <tt>true</tt>
+    #  <tt>:has_downloads</tt> Optional boolean - <tt>true</tt> to enable downloads for this repository
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.repos.create_repo :name => 'my_repo_name'
+    #
+    # Create a new repository in this organisation. The authenticated user 
+    # must be a member of this organisation
+    #
+    # Examples:
+    #   @github = Github.new :oauth_token => '...'
+    #   @github.repos.create_repo(:name => 'my-repo-name', :org => 'my-organisation')
+    #
+    def create_repo(*args)
+      params = args.last.is_a?(Hash) ? args.pop : {}
+      _normalize_params_keys(params)
+      _filter_params_keys(VALID_REPO_OPTIONS + %w[ org ], params)
+
+      raise ArgumentError, "Required params are: :name" unless _validate_inputs(%w[ name ], params)
+
+      # Requires authenticated user
+      if (org = params.delete("org"))
+        post("/orgs/#{org}/repos", DEFAULT_REPO_OPTIONS.merge(params))
+      else
+        post("/user/repos", DEFAULT_REPO_OPTIONS.merge(params))
+      end
+    end
+
+    # List contributors
+    #
+    # = Parameters
+    #  <tt>:anon</tt> - Optional flag. Set to 1 or true to include anonymous contributors.
+    #
+    # = Examples
+    #
+    #  @github = Github.new
+    #  @github.repos.contributors('user-name','repo-name')
+    #  @github.repos.contributors('user-name','repo-name') { |cont| ... }
+    #
+    def contributors(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(['anon'], params)
+
+      response = get("/repos/#{user}/#{repo}/contributors", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # Edit a repository
+    #
+    # = Parameters
+    # * <tt>:name</tt> Required string
+    # * <tt>:description</tt>   Optional string
+    # * <tt>:homepage</tt>      Optional string
+    # * <tt>:public</tt>        Optional boolean - true to create public repo, false to create a private one
+    # * <tt>:has_issues</tt>    Optional boolean - <tt>true</tt> to enable issues for this repository, <tt>false</tt> to disable them
+    # * <tt>:has_wiki</tt>      Optional boolean - <tt>true</tt> to enable the wiki for this repository, <tt>false</tt> to disable it. Default is <tt>true</tt>
+    # * <tt>:has_downloads</tt> Optional boolean - <tt>true</tt> to enable downloads for this repository
+    #
+    # = Examples
+    #
+    #  @github = Github.new
+    #  @github.repos.edit_repo('user-name', 'repo-name', { :name => 'hello-world', :description => 'This is your first repo', :homepage => "https://github.com", :public => true, :has_issues => true })
+    #
+    def edit_repo(user=nil, repo=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_REPO_OPTIONS, params)
+
+      raise ArgumentError, "Required params are: #{%w[ :name ] }" unless _validate_inputs(%w[ name ], params)
+
+      patch("/repos/#{user}/#{repo}", DEFAULT_REPO_OPTIONS.merge(params))
+    end
+
+    # Get a repository
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.repos.get_repo('user-name', 'repo-name')
+    #
+    def get_repo(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)
+
+      get("/repos/#{user}/#{repo}", params)
+    end
+
+    # List languages
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.repos.languages('user-name', 'repo-name')
+    #  @github.repos.languages('user-name', 'repo-name') { |lang| ... }
+    #
+    def languages(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)
+
+      response = get("/repos/#{user}/#{repo}/languages", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # List repositories for the authenticated user
+    #
+    # = Examples
+    #   @github = Github.new { :consumer_key => ... }
+    #   @github.repos.list_repos
+    #
+    # List public repositories for the specified user.
+    #
+    # = Examples
+    #   github = Github.new
+    #   github.repos.list_repos(:user => 'user-name')
+    #
+    # List repositories for the specified organisation.
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.repos.list_repos(:org => 'org-name')
+    #
+    def list_repos(*args)
+      params = args.last.is_a?(Hash) ? args.pop : {}
+      _normalize_params_keys(params)
+      _merge_user_into_params!(params) unless params.has_key?('user')
+      _filter_params_keys(%w[ org user type ], params)
+
+      if (user_name = params.delete("user"))
+        get("/users/#{user_name}/repos")
+      elsif (org_name = params.delete("org"))
+        get("/users/#{org_name}/repos", params)
+      else
+        # For authenticated user
+        get("/user/repos", params)
+      end
+    end
+
+    # List tags
+    #
+    # = Examples
+    #   @github = Github.new
+    #   @github.repos.tags('user-name', 'repo-name')
+    #   @github.repos.tags('user-name', 'repo-name') { |tag| ... }
+    #
+    def tags(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)
+
+      response = get("/repos/#{user}/#{repo}/tags", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # List teams
+    #
+    # == Examples
+    #   @github = Github.new
+    #   @github.repos.teams('user-name', 'repo-name')
+    #   @github.repos.teams('user-name', 'repo-name') { |team| ... }
+    #
+    def teams(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)
+
+      response = get("/repos/#{user}/#{repo}/teams", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+  end # Repos
+end # Github

data/lib/github_api/repos/collaborators.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+module Github
+  class Repos
+    module Collaborators
+      
+      # Add collaborator
+      #
+      # Examples:
+      #  @github = Github.new
+      #  @github.collaborators.add_collaborator('user', 'repo', 'collaborator') 
+      #
+      #  @repos = Github::Repos.new
+      #  @repos.add_collaborator('user', 'repo', 'collaborator')
+      #
+      def add_collaborator(user, repo, collaborator)
+        put("/repos/#{user}/#{repo}/collaborators/#{collaborator}")
+      end
+      
+      
+      # Checks if user is a collaborator for a given repository
+      #
+      # Examples:
+      #  @github = Github.new
+      #  @github.collaborators.collaborator?('user', 'repo', 'collaborator')
+      #
+      def collaborator?(user_name, repo_name, collaborator)
+        get("/repos/#{user}/#{repo}/collaborators/#{collaborator}")
+      end
+
+      # List collaborators
+      #
+      # Examples:
+      #   @github = Github.new
+      #   @github.repos.collaborators('user-name', 'repo-name')
+      #   @github.repos.collaborators('user-name', 'repo-name') { |cbr| .. }
+      #
+      def collaborators(user_name=nil, repo_name=nil)
+        _update_user_repo_params(user_name, repo_name)      
+        _validate_user_repo_params(user, repo) unless (user? && repo?)
+        
+        response = get("/repos/#{user}/#{repo}/collaborators")
+        return response unless block_given?
+        response.each { |el| yield el }
+      end
+      
+      # Removes collaborator
+      #
+      # Examples:
+      #  @github = Github.new
+      #  @github.collaborators.remove('user', 'repo', 'collaborator')
+      #
+      def remove_collabolator(user, repo, collaborator) 
+        delete("/repos/#{user}/#{repo}/collaborators/#{user}")
+      end
+
+    end # Collaborators
+  end # Repos
+end # Github