github_api 0.4.11 → 0.5.0.rc1

data/lib/github_api/repos/commits.rb

@@ -1,8 +1,7 @@
 # encoding: utf-8
 
 module Github
-  class Repos
-    module Commits
+  class Repos::Commits < API
 
       REQUIRED_COMMENT_PARAMS = %w[
         body
@@ -12,6 +11,23 @@ module Github
         position
       ].freeze
 
+      # Compares two commits
+      #
+      # = Examples
+      #  github = Github.new
+      #  github.repos.commits.compare
+      #    'user-name',
+      #    'repo-name',
+      #    'v0.4.8',
+      #    'master'
+      #
+      def compare(user_name, repo_name, base, head, params={})
+        _validate_presence_of base, head
+        _normalize_params_keys(params)
+
+        get_request("/repos/#{user_name}/#{repo_name}/compare/#{base}...#{head}", params)
+      end
+
       # Creates a commit comment
       #
       # = Inputs
@@ -22,8 +38,8 @@ module Github
       # * <tt>:position</tt> - Required number - Line index in the diff to comment on.
       #
       # = Examples
-      #  @github = Github.new
-      #  @github.repos.create_comment 'user-name', 'repo-name', 'sha-key', 
+      #  github = Github.new
+      #  github.repos.commits.create_comment 'user-name', 'repo-name', 'sha-key', 
       #    "body" => "Nice change",
       #    "commit_id" => "6dcb09b5b57875f334f61aebed695e2e4193db5e",
       #    "line" => 1,
@@ -40,15 +56,14 @@ module Github
 
         _validate_inputs(REQUIRED_COMMENT_PARAMS, params)
 
-        post("/repos/#{user}/#{repo}/commits/#{sha}/comments", params)
+        post_request("/repos/#{user}/#{repo}/commits/#{sha}/comments", params)
       end
-      alias :create_commit_comment :create_comment
 
       # Deletes a commit comment
       #
       # = Examples
-      #  @github = Github.new
-      #  @github.repos.delete_comment 'user-name', 'repo-name', 'comment-id'
+      #  github = Github.new
+      #  github.repos.commits.delete_comment 'user-name', 'repo-name', 'comment-id'
       #
       def delete_comment(user_name, repo_name, comment_id, params={})
         _update_user_repo_params(user_name, repo_name)
@@ -56,9 +71,8 @@ module Github
         _validate_presence_of comment_id
         _normalize_params_keys(params)
 
-        delete("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
+        delete_request("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
       end
-      alias :delete_commit_comment :delete_comment
 
       # List commits on a repository
       #
@@ -67,37 +81,35 @@ module Github
       # * <tt>:path</tt>  Optional string. Only commits containing this file path will be returned
       #
       # = Examples
-      #  @github = Github.new
-      #  @github.repos.commits 'user-name', 'repo-name', :sha => '...'
-      #  @github.repos.commits 'user-name', 'repo-name', :sha => '...' { |commit| ... }
+      #  github = Github.new
+      #  github.repos.commits.list 'user-name', 'repo-name', :sha => '...'
+      #  github.repos.commits.list 'user-name', 'repo-name', :sha => '...' { |commit| ... }
       #
-      def commits(user_name=nil, repo_name=nil, params={})
+      def list(user_name, repo_name, 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(%w[ sha path], params)
 
-        response = get("/repos/#{user}/#{repo}/commits", params)
+        response = get_request("/repos/#{user}/#{repo}/commits", params)
         return response unless block_given?
         response.each { |el| yield el }
       end
-      alias :list_commits :commits
-      alias :list_repo_commits :commits
-      alias :list_repository_commits :commits
+      alias :all :list
 
       # List commit comments for a repository
       #
       # = Examples
-      #  @github = Github.new
-      #  @github.repos.repo_comments 'user-name', 'repo-name'
-      #  @github.repos.repo_comments 'user-name', 'repo-name' { |com| ... }
+      #  github = Github.new
+      #  github.repos.commits.repo_comments 'user-name', 'repo-name'
+      #  github.repos.commits.repo_comments 'user-name', 'repo-name' { |com| ... }
       #
-      def repo_comments(user_name=nil, repo_name=nil, params={})
+      def repo_comments(user_name, repo_name, 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}/comments", params)
+        response = get_request("/repos/#{user}/#{repo}/comments", params)
         return response unless block_given?
         response.each { |el| yield el }
       end
@@ -107,8 +119,8 @@ module Github
       # List comments for a single commit
       #
       # = Examples
-      #  @github = Github.new
-      #  @github.repos.commit_comments 'user-name', 'repo-name', '6dcb09b5b57875f334f61aebed695e2e4193db5e'
+      #  github = Github.new
+      #  github.repos.commits.commit_comments 'user-name', 'repo-name', '6dcb09b5b57875f334f61aebed695e2e4193db5e'
       #
       def commit_comments(user_name, repo_name, sha, params={})
         _update_user_repo_params(user_name, repo_name)
@@ -116,7 +128,7 @@ module Github
         _validate_presence_of sha
         _normalize_params_keys(params)
 
-        response = get("/repos/#{user}/#{repo}/commits/#{sha}/comments", params)
+        response = get_request("/repos/#{user}/#{repo}/commits/#{sha}/comments", params)
         return response unless block_given?
         response.each { |el| yield el }
       end
@@ -126,23 +138,23 @@ module Github
       #
       # = Examples
       #  @github = Github.new
-      #  @github.repos.commit 'user-name', 'repo-name', '6dcb09b5b57875f334f61aebed6')
+      #  @github.repos.commits.get 'user-name', 'repo-name', '6dcb09b5b57875f334f61aebed6')
       #
-      def commit(user_name, repo_name, sha, params={})
+      def get(user_name, repo_name, sha, params={})
         _update_user_repo_params(user_name, repo_name)
         _validate_user_repo_params(user, repo) unless user? && repo?
         _validate_presence_of sha
         _normalize_params_keys(params)
 
-        get("/repos/#{user}/#{repo}/commits/#{sha}", params)
+        get_request("/repos/#{user}/#{repo}/commits/#{sha}", params)
       end
-      alias :get_commit :commit
+      alias :find :get
 
       # Gets a single commit comment
       #
       # = Examples
-      #  @github = Github.new
-      #  @github.repos.commit_comment 'user-name', 'repo-name', 'comment-id'
+      #  github = Github.new
+      #  github.repos.commits.commit_comment 'user-name', 'repo-name', 'comment-id'
       #
       def commit_comment(user_name, repo_name, comment_id, params={})
         _update_user_repo_params(user_name, repo_name)
@@ -150,7 +162,7 @@ module Github
         _validate_presence_of comment_id
         _normalize_params_keys(params)
 
-        get("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
+        get_request("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
       end
       alias :get_commit_comment :commit_comment
 
@@ -160,9 +172,9 @@ module Github
       # * <tt>:body</tt> - Required string.
       #
       # = Examples
-      #  @github = Github.new
-      #  @github.repos.update_comment 'user-name', 'repo-name', 'comment-id',
-      #    "body" => "Nice change"
+      #  github = Github.new
+      #  github.repos.commits.update_comment 'user-name', 'repo-name',
+      #    'comment-id', "body" => "Nice change"
       #
       def update_comment(user_name, repo_name, comment_id, params={})
         _update_user_repo_params(user_name, repo_name)
@@ -172,9 +184,8 @@ module Github
         _normalize_params_keys(params)
         _validate_inputs(%w[ body ], params)
 
-        patch("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
+        patch_request("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
       end
 
-    end # Commits
-  end # Repos
+  end # Repos::Commits
 end # Github

data/lib/github_api/repos/downloads.rb

@@ -3,114 +3,111 @@
 require 'github_api/s3_uploader'
 
 module Github
-  class Repos
-    module Downloads
-
-      REQUIRED_PARAMS = %w[ name size ]
-
-      VALID_DOWNLOAD_PARAM_NAMES = %w[
-        name
-        size
-        description
-        content_type
-      ].freeze
-
-      # List downloads for a repository
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.repos.downloads 'user-name', 'repo-name'
-      #  @github.repos.downloads 'user-name', 'repo-name' { |downl| ... }
-      #
-      def downloads(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}/downloads", params)
-        return response unless block_given?
-        response.each { |el| yield el }
-      end
-      alias :list_downloads :downloads
-      alias :get_downloads :downloads
-
-      # Get a single download
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.repos.download 'user-name', 'repo-name'
-      #
-      def download(user_name, repo_name, download_id, params={})
-        _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
-        _validate_presence_of download_id
-        _normalize_params_keys(params)
-
-        get("/repos/#{user}/#{repo}/downloads/#{download_id}", params)
-      end
-      alias :get_download :download
-
-      # Delete download from a repository
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.repos.delete_download 'user-name', 'repo-name', 'download-id'
-      #
-      def delete_download(user_name, repo_name, download_id, params={})
-        _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
-        _validate_presence_of download_id
-        _normalize_params_keys(params)
-
-        delete("/repos/#{user}/#{repo}/downloads/#{download_id}", params)
-      end
-
-      # Creating a new download is a two step process.
-      # You must first create a new download resource using this method.
-      # Response from this method is to be used in #upload method.
-      #
-      # = Inputs
-      # * <tt>:name</tt> - Required string - name of the file that is being created.
-      # * <tt>:size</tt> - Required number - size of file in bytes.
-      # * <tt>:description</tt> - Optional string
-      # * <tt>:content_type</tt> - Optional string
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.repos.create_download 'user-name', 'repo-name',
-      #    "name" =>  "new_file.jpg",
-      #    "size" => 114034,
-      #    "description" => "Latest release",
-      #    "content_type" => "text/plain"
-      #
-      def create_download(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_DOWNLOAD_PARAM_NAMES, params)
-        _validate_inputs(REQUIRED_PARAMS, params)
-
-        post("/repos/#{user}/#{repo}/downloads", params)
-      end
-
-      # Upload a file to Amazon, using the reponse instance from
-      # Github::Repos::Downloads#create_download. This can be done by passing
-      # the response object as an argument to upload method.
-      #
-      # = Parameters
-      # * <tt>resource</tt> - Required resource of the create_download call.
-      # * <tt>:filename</tt> - Required filename, a path to a file location.
-      #
-      def upload(resource, filename)
-        _validate_presence_of resource, filename
-
-        response = Github::S3Uploader.new(resource, filename).send
-        response.body
-      end
-      alias :upload_to_s3 :upload
-      alias :upload_to_amazon :upload
-
-    end # Downloads
-  end # Repos
+  class Repos::Downloads < API
+
+    REQUIRED_PARAMS = %w[ name size ]
+
+    VALID_DOWNLOAD_PARAM_NAMES = %w[
+      name
+      size
+      description
+      content_type
+    ].freeze
+
+    # List downloads for a repository
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.downloads.list 'user-name', 'repo-name'
+    #  github.repos.downloads.list 'user-name', 'repo-name' { |downl| ... }
+    #
+    def list(user_name, repo_name, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _normalize_params_keys(params)
+
+      response = get_request("/repos/#{user}/#{repo}/downloads", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single download
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.downloads.get 'user-name', 'repo-name', 'download-id'
+    #
+    def get(user_name, repo_name, download_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of download_id
+      _normalize_params_keys(params)
+
+      get_request("/repos/#{user}/#{repo}/downloads/#{download_id}", params)
+    end
+    alias :find :get
+
+    # Delete download from a repository
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.downloads.delete 'user-name', 'repo-name', 'download-id'
+    #
+    def delete(user_name, repo_name, download_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of download_id
+      _normalize_params_keys(params)
+
+      delete_request("/repos/#{user}/#{repo}/downloads/#{download_id}", params)
+    end
+
+    # Creating a new download is a two step process.
+    # You must first create a new download resource using this method.
+    # Response from this method is to be used in #upload method.
+    #
+    # = Inputs
+    # * <tt>:name</tt> - Required string - name of the file that is being created.
+    # * <tt>:size</tt> - Required number - size of file in bytes.
+    # * <tt>:description</tt> - Optional string
+    # * <tt>:content_type</tt> - Optional string
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.downloads.create 'user-name', 'repo-name',
+    #    "name" =>  "new_file.jpg",
+    #    "size" => 114034,
+    #    "description" => "Latest release",
+    #    "content_type" => "text/plain"
+    #
+    def create(user_name, repo_name, 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_DOWNLOAD_PARAM_NAMES, params)
+      _validate_inputs(REQUIRED_PARAMS, params)
+
+      post_request("/repos/#{user}/#{repo}/downloads", params)
+    end
+
+    # Upload a file to Amazon, using the reponse instance from
+    # Github::Repos::Downloads#create_download. This can be done by passing
+    # the response object as an argument to upload method.
+    #
+    # = Parameters
+    # * <tt>resource</tt> - Required resource of the create_download call.
+    # * <tt>:filename</tt> - Required filename, a path to a file location.
+    #
+    def upload(resource, filename)
+      _validate_presence_of resource, filename
+
+      response = Github::S3Uploader.new(resource, filename).send
+      response.body
+    end
+    alias :upload_to_s3 :upload
+    alias :upload_to_amazon :upload
+
+  end # Repos::Downloads
 end # Github

data/lib/github_api/repos/forks.rb

@@ -1,48 +1,47 @@
 # encoding: utf-8
 
 module Github
-  class Repos
-    module Forks
+  class Repos::Forks < API
 
-      # List repository forks
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.repos.forks 'user-name', 'repo-name'
-      #  @github.repos.forks 'user-name', 'repo-name' { |hook| ... }
-      #
-      def forks(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)
+    # List repository forks
+    #
+    # = Parameters
+    # * <tt>:sort</tt> - newest, oldest, watchers, default: newest
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.forks.list 'user-name', 'repo-name'
+    #  github.repos.forks.list 'user-name', 'repo-name' { |hook| ... }
+    #
+    def list(user_name, repo_name, 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}/forks", params)
-        return response unless block_given?
-        response.each { |el| yield el }
-      end
-      alias :repo_forks :forks
-      alias :repository_forks :forks
+      response = get_request("/repos/#{user}/#{repo}/forks", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
 
-      # Create a fork for the authenticated user
-      #
-      # = Inputs
-      # * <tt>:org</tt> - Optional string - the name of the service that is being called.
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.repos.create_fork 'user-name', 'repo-name',
-      #    "org" =>  "github"
-      #
-      def create_fork(user_name=nil, repo_name=nil, params={})
-        _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
+    # Create a fork for the authenticated user
+    #
+    # = Inputs
+    # * <tt>:org</tt> - Optional string - the name of the service that is being called.
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.forks.create 'user-name', 'repo-name',
+    #    "org" =>  "github"
+    #
+    def create(user_name, repo_name, 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(%w[ org ], params)
 
-        _normalize_params_keys(params)
-        _filter_params_keys(%w[ org ], params)
+      post_request("/repos/#{user}/#{repo}/forks", params)
+    end
 
-        post("/repos/#{user}/#{repo}/forks", params)
-      end
-
-    end # Forks
-  end # Repos
+  end # Repos::Forks
 end # Github