github_api 0.4.11 → 0.5.0.rc1

data/lib/github_api/repos.rb

@@ -15,15 +15,6 @@ module Github
       :Watching      => 'watching',
       :PubSubHubbub  => 'pub_sub_hubbub'
 
-    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
-    include Github::Repos::PubSubHubbub
-
     DEFAULT_REPO_OPTIONS = {
       "homepage"   => "https://github.com",
       "private"    => false,
@@ -40,6 +31,7 @@ module Github
       has_issues
       has_wiki
       has_downloads
+      team_id
     ].freeze
 
     VALID_REPO_TYPES = %w[ all public private member ].freeze
@@ -49,22 +41,62 @@ module Github
       super(options)
     end
 
+    # Access to Repos::Collaborators API
+    def collaborators
+      @collaborators ||= ApiFactory.new 'Repos::Collaborators'
+    end
+
+    # Access to Repos::Commits API
+    def commits
+      @commits ||= ApiFactory.new 'Repos::Commits'
+    end
+
+    # Access to Repos::Downloads API
+    def downloads
+      @downloads ||= ApiFactory.new 'Repos::Downloads'
+    end
+
+    # Access to Repos::Forks API
+    def forks
+      @forks ||= ApiFactory.new 'Repos::Forks'
+    end
+
+    # Access to Repos::Hooks API
+    def hooks
+      @hooks ||= ApiFactory.new 'Repos::Hooks'
+    end
+
+    # Access to Repos::Keys API
+    def keys
+      @keys ||= ApiFactory.new 'Repos::Keys'
+    end
+
+    # Access to Repos::Watchin API
+    def watching
+      @watching ||= ApiFactory.new 'Repos::Watching'
+    end
+
+    # Access to Repos::Watchin API
+    def pubsubhubbub
+      @pubsubhubbub ||= ApiFactory.new 'Repos::PubSubHubbub'
+    end
+
     # List branches
     #
     # = Examples
     #
-    #   @github = Github.new
-    #   @github.repos.branches 'user-name', 'repo-name'
+    #   github = Github.new
+    #   github.repos.branches 'user-name', 'repo-name'
     #
-    #   @repos = Github::Repos.new
-    #   @repos.branches 'user-name', 'repo-name'
+    #   repos = Github::Repos.new
+    #   repos.branches 'user-name', 'repo-name'
     #
     def branches(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}/branches", params)
+      response = get_request("/repos/#{user}/#{repo}/branches", params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -80,10 +112,12 @@ module Github
     #  <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
+    #  <tt>:org</tt> Optional string - The organisation in which this repository will be created
+    #  <tt>:team_id</tt> Optional number - The id of the team that will be granted access to this repository. This is only valid when creating a repo in an organization
     #
     # = Examples
-    #  @github = Github.new
-    #  @github.repos.create_repo "name" => 'repo-name'
+    #  github = Github.new
+    #  github.repos.create "name" => 'repo-name'
     #    "description": "This is your first repo",
     #    "homepage": "https://github.com",
     #    "private": false,
@@ -95,10 +129,10 @@ module Github
     # must be a member of this organisation
     #
     # Examples:
-    #   @github = Github.new :oauth_token => '...'
-    #   @github.repos.create_repo :name => 'repo-name', :org => 'organisation-name'
+    #   github = Github.new :oauth_token => '...'
+    #   github.repos.create :name => 'repo-name', :org => 'organisation-name'
     #
-    def create_repo(*args)
+    def create(*args)
       params = args.last.is_a?(Hash) ? args.pop : {}
       _normalize_params_keys(params)
       _filter_params_keys(VALID_REPO_OPTIONS + %w[ org ], params)
@@ -111,12 +145,11 @@ module Github
 
       # Requires authenticated user
       if (org = params.delete("org"))
-        post("/orgs/#{org}/repos", DEFAULT_REPO_OPTIONS.merge(params))
+        post_request("/orgs/#{org}/repos", DEFAULT_REPO_OPTIONS.merge(params))
       else
-        post("/user/repos", DEFAULT_REPO_OPTIONS.merge(params))
+        post_request("/user/repos", DEFAULT_REPO_OPTIONS.merge(params))
       end
     end
-    alias :create_repository :create_repo
 
     # List contributors
     #
@@ -125,17 +158,17 @@ module Github
     #
     # = Examples
     #
-    #  @github = Github.new
-    #  @github.repos.contributors 'user-name','repo-name'
-    #  @github.repos.contributors 'user-name','repo-name' { |cont| ... }
+    #  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={})
+    def contributors(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(['anon'], params)
 
-      response = get("/repos/#{user}/#{repo}/contributors", params)
+      response = get_request("/repos/#{user}/#{repo}/contributors", params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -155,10 +188,14 @@ module Github
     #
     # = 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", :private => false, :has_issues => true })
+    #  github = Github.new
+    #  github.repos.edit '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_name=nil, repo_name=nil, params={})
+    def edit(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
 
@@ -169,39 +206,37 @@ module Github
         raise ArgumentError, "Required params are: #{%w[ :name ] }"
       end
 
-      patch("/repos/#{user}/#{repo}", DEFAULT_REPO_OPTIONS.merge(params))
+      patch_request("/repos/#{user}/#{repo}", DEFAULT_REPO_OPTIONS.merge(params))
     end
-    alias :edit_repository :edit_repo
 
     # Get a repository
     #
     # = Examples
-    #  @github = Github.new
-    #  @github.repos.get_repo('user-name', 'repo-name')
+    #  github = Github.new
+    #  github.repos.get 'user-name', 'repo-name'
     #
-    def get_repo(user_name=nil, repo_name=nil, params={})
+    def get(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)
 
-      get("/repos/#{user}/#{repo}", params)
+      get_request("/repos/#{user}/#{repo}", params)
     end
-    alias :get_repository :get_repo
-
+    alias :find :get
 
     # List languages
     #
     # = Examples
-    #  @github = Github.new
-    #  @github.repos.languages('user-name', 'repo-name')
-    #  @github.repos.languages('user-name', 'repo-name') { |lang| ... }
+    #  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={})
+    def languages(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}/languages", params)
+      response = get_request("/repos/#{user}/#{repo}/languages", params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -210,57 +245,56 @@ module Github
     # List repositories for the authenticated user
     #
     # = Examples
-    #   @github = Github.new :oauth_token => '...'
-    #   @github.repos.list_repos
-    #   @github.repos.list_repos { |repo| ... }
+    #   github = Github.new :oauth_token => '...'
+    #   github.repos.list
+    #   github.repos.list { |repo| ... }
     #
     # List public repositories for the specified user.
     #
     # = Examples
     #   github = Github.new
-    #   github.repos.list_repos :user => 'user-name'
-    #   github.repos.list_repos :user => 'user-name', { |repo| ... }
+    #   github.repos.list :user => 'user-name'
+    #   github.repos.list :user => 'user-name', { |repo| ... }
     #
     # List repositories for the specified organisation.
     #
     # = Examples
-    #  @github = Github.new
-    #  @github.repos.list_repos :org => 'org-name'
-    #  @github.repos.list_repos :org => 'org-name', { |repo| ... }
+    #  github = Github.new
+    #  github.repos.list :org => 'org-name'
+    #  github.repos.list :org => 'org-name', { |repo| ... }
     #
-    def repos(*args)
+    def list(*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)
 
       response = if (user_name = params.delete("user"))
-        get("/users/#{user_name}/repos", params)
+        get_request("/users/#{user_name}/repos", params)
       elsif (org_name = params.delete("org"))
-        get("/orgs/#{org_name}/repos", params)
+        get_request("/orgs/#{org_name}/repos", params)
       else
         # For authenticated user
-        get("/user/repos", params)
+        get_request("/user/repos", params)
       end
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :list_repos :repos
-    alias :list_repositories :repos
+    alias :all :list
 
     # List tags
     #
     # = Examples
-    #   @github = Github.new
-    #   @github.repos.tags('user-name', 'repo-name')
-    #   @github.repos.tags('user-name', 'repo-name') { |tag| ... }
+    #   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={})
+    def tags(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}/tags", params)
+      response = get_request("/repos/#{user}/#{repo}/tags", params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -271,16 +305,16 @@ module Github
     # List teams
     #
     # == Examples
-    #   @github = Github.new
-    #   @github.repos.teams('user-name', 'repo-name')
-    #   @github.repos.teams('user-name', 'repo-name') { |team| ... }
+    #   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={})
+    def teams(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}/teams", params)
+      response = get_request("/repos/#{user}/#{repo}/teams", params)
       return response unless block_given?
       response.each { |el| yield el }
     end

data/lib/github_api/repos/collaborators.rb

@@ -1,81 +1,77 @@
 # encoding: utf-8
 
 module Github
-  class Repos
-    module Collaborators
+  class Repos::Collaborators < API
 
-      # 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_name, repo_name, collaborator, params={})
-        _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
-        _validate_presence_of collaborator
-        _normalize_params_keys(params)
+    # Add collaborator
+    #
+    # Examples:
+    #  github = Github.new
+    #  github.collaborators.add 'user', 'repo', 'collaborator'
+    #
+    #  collaborators = Github::Repos::Collaborators.new
+    #  collaborators.add 'user', 'repo', 'collaborator'
+    #
+    def add(user_name, repo_name, collaborator, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of collaborator
+      _normalize_params_keys(params)
 
-        put("/repos/#{user}/#{repo}/collaborators/#{collaborator}", params)
-      end
-      alias :add_collab :add_collaborator
+      put_request("/repos/#{user}/#{repo}/collaborators/#{collaborator}", params)
+    end
+    alias :<< :add
 
-      # 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, params={})
-        _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
-        _validate_presence_of collaborator
-        _normalize_params_keys(params)
+    # 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, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of collaborator
+      _normalize_params_keys(params)
 
-        get("/repos/#{user}/#{repo}/collaborators/#{collaborator}", params)
-        true
-      rescue Github::Error::NotFound
-        false
-      end
+      get_request("/repos/#{user}/#{repo}/collaborators/#{collaborator}", params)
+      true
+    rescue Github::Error::NotFound
+      false
+    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, repo_name, params={})
-        _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless (user? && repo?)
-        _normalize_params_keys(params)
+    # List collaborators
+    #
+    # Examples:
+    #  github = Github.new
+    #  github.repos.collaborators.list 'user-name', 'repo-name'
+    #  github.repos.collaborators.list 'user-name', 'repo-name' { |cbr| .. }
+    #
+    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}/collaborators", params)
-        return response unless block_given?
-        response.each { |el| yield el }
-      end
-      alias :list_collaborators :collaborators
-      alias :collabs :collaborators
+      response = get_request("/repos/#{user}/#{repo}/collaborators", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
 
-      # Removes collaborator
-      #
-      # Examples:
-      #  @github = Github.new
-      #  @github.repos.remove_collaborator 'user', 'repo', 'collaborator'
-      #
-      def remove_collaborator(user_name, repo_name, collaborator, params={})
-        _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
-        _validate_presence_of collaborator
-        _normalize_params_keys(params)
+    # Removes collaborator
+    #
+    # Examples:
+    #  github = Github.new
+    #  github.repos.collaborators.remove 'user', 'repo', 'collaborator'
+    #
+    def remove(user_name, repo_name, collaborator, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of collaborator
+      _normalize_params_keys(params)
 
-        delete("/repos/#{user}/#{repo}/collaborators/#{collaborator}", params)
-      end
-      alias :remove_collab :remove_collaborator
+      delete_request("/repos/#{user}/#{repo}/collaborators/#{collaborator}", params)
+    end
 
-    end # Collaborators
-  end # Repos
+  end # Repos::Collaborators
 end # Github