add the functions for branches and protections

fluke · fluke · commit a89bb30bf3f7 · 2017-06-13T18:07:36.000+05:30
diff --git a/lib/github_api/client/repos.rb b/lib/github_api/client/repos.rb
@@ -4,6 +4,7 @@ module Github
   class Client::Repos < API
     # Load all the modules after initializing Repos to avoid superclass mismatch
     require_all 'github_api/client/repos',
+      'branches',
       'collaborators',
       'comments',
       'commits',
@@ -87,6 +88,9 @@ class Client::Repos < API
     # Access to Repos::Statuses API
     namespace :statuses
 
+    # Access to Repos::Branches API
+    namespace :branches
+
     # List repositories for the authenticated user
     #
     # @example
@@ -356,14 +360,14 @@ def delete(*args)
     #   repos.branches 'user-name', 'repo-name'
     #
     # @api public
-    def branches(*args)
-      arguments(args, required: [:user, :repo])
+    # def branches(*args)
+    #   arguments(args, required: [:user, :repo])
 
-      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/branches", arguments.params)
-      return response unless block_given?
-      response.each { |el| yield el }
-    end
-    alias :list_branches :branches
+    #   response = get_request("/repos/#{arguments.user}/#{arguments.repo}/branches", arguments.params)
+    #   return response unless block_given?
+    #   response.each { |el| yield el }
+    # end
+    # alias :list_branches :branches
 
     # Get branch
     #
@@ -373,11 +377,11 @@ def branches(*args)
     #   github.repos.branch user: 'user-name', repo: 'repo-name', branch: 'branch-name'
     #   github.repos(user: 'user-name', repo: 'repo-name', branch: 'branch-name').branch
     # @api public
-    def branch(*args)
-      arguments(args, required: [:user, :repo, :branch])
+    # def branch(*args)
+    #   arguments(args, required: [:user, :repo, :branch])
 
-      get_request("/repos/#{arguments.user}/#{arguments.repo}/branches/#{arguments.branch}", arguments.params)
-    end
+    #   get_request("/repos/#{arguments.user}/#{arguments.repo}/branches/#{arguments.branch}", arguments.params)
+    # end
 
     # List contributors
     #
diff --git a/lib/github_api/client/repos/branches.rb b/lib/github_api/client/repos/branches.rb
@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+module Github
+  class Client::Repos::Branches < API
+    require_all 'github_api/client/repos/branches', 'protections'
+
+    # Access to Repos::Branches::Protections API
+    namespace :protections
+
+    # List branches
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.branches.list 'user-name', 'repo-name'
+    #   github.repos(user: 'user-name', repo: 'repo-name').branches.list
+    #
+    # @example
+    #   repos = Github::Repos.new
+    #   repos.branches.list 'user-name', 'repo-name'
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo])
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/branches", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get branch
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.branches.get 'user-name', 'repo-name', 'branch-name'
+    #   github.repos.branches.get user: 'user-name', repo: 'repo-name', branch: 'branch-name'
+    #   github.repos(user: 'user-name', repo: 'repo-name', branch: 'branch-name').branches.get
+    # @api public
+    def get(*args)
+      arguments(args, required: [:user, :repo, :branch])
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/branches/#{arguments.branch}", arguments.params)
+    end
+    alias :find :get
+  end # Client::Repos::Branches
+end # Github
diff --git a/lib/github_api/client/repos/branches/protections.rb b/lib/github_api/client/repos/branches/protections.rb
@@ -0,0 +1,67 @@
+# encoding: utf-8
+
+module Github
+  # The Branch Protections API
+  class Client::Repos::Branches::Protections < API
+
+    VALID_PROTECTION_PARAM_NAMES = %w[
+      required_status_checks
+      enforce_admins
+      restrictions
+    ].freeze
+
+    # Get a single branch protection
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.branches.protections.get 'user', 'repo', 'id'
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:user, :repo, :branch])
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/branches/#{arguments.branch}/protection", arguments.params)
+    end
+    alias :find :get
+
+    # Edit a branch protection
+    #
+    # Users with push access to the repository can edit a branch protection.
+    #
+    # @param [Hash] params
+    # @input params [String] :name
+    #   Required. The file name of the asset.
+    # @input params [String] :label
+    #   An alternate short description of the asset.
+    #   Used in place of the filename.
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.branches.protections.edit 'user', 'repo', 'id',
+    #     name: "foo-1.0.0-osx.zip",
+    #     label: "Mac binary"
+    #
+    # @api public
+    def edit(*args)
+      arguments(args, required: [:user, :repo, :branch]) do
+        permit VALID_PROTECTION_PARAM_NAMES
+      end
+
+      patch_request("/repos/#{arguments.user}/#{arguments.repo}/branches/#{arguments.branch}/protection", arguments.params)
+    end
+    alias :update :edit
+
+    # Delete a branch protection
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.branches.protections.delete 'user', 'repo', 'id'
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:user, :repo, :branch])
+
+      delete_request("/repos/#{arguments.user}/#{arguments.repo}/branches/#{arguments.branch}/protection", arguments.params)
+    end
+  end # Client::Repos::Branches::Protections
+end # Github
