github_api 0.15.0 → 0.19.0

data/lib/github_api/client/repos/branches.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+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

data/lib/github_api/client/repos/branches/protections.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+
+require_relative '../../../api'
+
+module Github
+  # The Branch Protections API
+  class Client::Repos::Branches::Protections < API
+    VALID_PROTECTION_PARAM_NAMES = %w[
+      required_status_checks
+      required_pull_request_reviews
+      enforce_admins
+      restrictions
+      accept
+    ].freeze
+
+    # Get a single branch's protection
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.branches.protections.get 'user', 'repo', 'branch'
+    #
+    # @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] :required_status_checks
+    #   Required.
+    # @input params [String] :enforce_admins
+    #   Required.
+    # @input params [String] :restrictions
+    #   Required.
+    # @input params [String] :required_pull_request_reviews
+    #   Required.
+    # Look to the branch protection API to see how to use these
+    # https://developer.github.com/v3/repos/branches/#update-branch-protection
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.branches.protections.edit 'user', 'repo', 'branch',
+    #     required_pull_request_reviews: {dismiss_stale_reviews: false}
+    #
+    # @api public
+    def edit(*args)
+      arguments(args, required: [:user, :repo, :branch]) do
+        permit VALID_PROTECTION_PARAM_NAMES
+      end
+
+      put_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', 'branch'
+    #
+    # @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
+    alias :remove :delete
+  end # Client::Repos::Branches::Protections
+end # Github

data/lib/github_api/client/repos/collaborators.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::Repos::Collaborators < API
     # List collaborators
@@ -21,7 +23,6 @@ module Github
     # @api public
     def list(*args)
       arguments(args, required: [:user, :repo])
-      params = arguments.params
 
       response = get_request("/repos/#{arguments.user}/#{arguments.repo}/collaborators", arguments.params)
       return response unless block_given?

data/lib/github_api/client/repos/comments.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::Repos::Comments < API
 
@@ -81,7 +83,6 @@ module Github
     # @api public
     def create(*args)
       arguments(args, required: [:user, :repo, :sha]) do
-        permit VALID_COMMENT_OPTIONS
         assert_required REQUIRED_COMMENT_OPTIONS
       end
 

data/lib/github_api/client/repos/commits.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::Repos::Commits < API
 

data/lib/github_api/client/repos/contents.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   # These API methods let you retrieve the contents of files within a repository
   # as Base64 encoded content.
@@ -31,6 +33,23 @@ module Github
       get_request("/repos/#{arguments.user}/#{arguments.repo}/readme", arguments.params)
     end
 
+    # Get the LICENSE
+    #
+    # This method returns the contents of the repository's license file, if one is detected.
+    #
+    # @param [Hash] params
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.contents.license 'user-name', 'repo-name'
+    #
+    # @api public
+    def license(*args)
+      arguments(args, required: [:user, :repo])
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/license", arguments.params)
+    end
+    
     # Get contents
     #
     # This method returns the contents of any file or directory in a repository.
@@ -64,12 +83,12 @@ module Github
     #
     # @param [Hash] params
     # @option params [String] :path
-    #   Requried string. The content path
+    #   Required string. The content path
     # @option params [String]
     # @option params [String] :message
-    #   Requried string. The commit message.
+    #   Required string. The commit message.
     # @option params [String] :content
-    #   Requried string. The new file content, which will be Base64 encoded
+    #   Required string. The new file content, which will be Base64 encoded
     # @option params [String] :branch
     #   The branch name. If not provided, uses the repository’s
     #   default branch (usually master)
@@ -235,7 +254,10 @@ module Github
       archive_format = params.delete('archive_format') || 'tarball'
       ref            = params.delete('ref') || 'master'
 
-      get_request("/repos/#{arguments.user}/#{arguments.repo}/#{archive_format}/#{ref}", params)
+      disable_redirects do
+        response = get_request("/repos/#{arguments.user}/#{arguments.repo}/#{archive_format}/#{ref}", params)
+        response.headers.location
+      end
     end
   end # Client::Repos::Contents
 end # Github

data/lib/github_api/client/repos/deployments.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::Repos::Deployments < API
 
@@ -22,7 +24,7 @@ module Github
 
     # List deployments on a repository
     #
-    # @xample
+    # @example
     #  github = Github.new
     #  github.repos.deployments.list 'user-name', 'repo-name'
     #  github.repos.deployments.list 'user-name', 'repo-name' { |deployment| ... }

data/lib/github_api/client/repos/downloads.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::Repos::Downloads < API
 

data/lib/github_api/client/repos/forks.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::Repos::Forks < API
     # List repository forks
@@ -11,8 +13,10 @@ module Github
     #
     # @example
     #   github = Github.new
-    #   github.repos.forks.list 'user-name', 'repo-name'
-    #   github.repos.forks.list 'user-name', 'repo-name' { |fork| ... }
+    #   github.repos.forks.list('user-name', 'repo-name')
+    #   github.repos.forks.list('user-name', 'repo-name') { |fork|
+    #     #...
+    #   }
     #
     # @api public
     def list(*args)

data/lib/github_api/client/repos/hooks.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   # The Repository Hooks API manages the post-receive web and
   # service hooks for a repository.

data/lib/github_api/client/repos/invitations.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Repos::Invitations < API
+    # List repo invitations
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.invitations.list 'user-name', 'repo-name'
+    #
+    # @example
+    #  github.repos.invitations.list 'user-name', 'repo-name' { |cbr| .. }
+    #
+    # @return [Array]
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo])
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/invitations", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Deletes a repo invitation
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.invitations.delete 'user-name', 'repo-name', 'invitation-id'
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:user, :repo, :id])
+
+      delete_request("/repos/#{arguments.user}/#{arguments.repo}/invitations/#{arguments.id}", arguments.params)
+    end
+  end
+end

data/lib/github_api/client/repos/keys.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::Repos::Keys < API
     # List deploy keys

data/lib/github_api/client/repos/merging.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   # The Repo Merging API supports merging branches in a repository. This
   # accomplishes essentially the same thing as merging one branch into another

data/lib/github_api/client/repos/pages.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   # The Pages API retrieves information about your GitHub Pages configuration,
   # and the statuses of your builds. Information about the site and the builds

data/lib/github_api/client/repos/projects.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative '../../api'
+
+module Github
+  class Client::Repos::Projects < API
+    PREVIEW_MEDIA = "application/vnd.github.inertia-preview+json".freeze # :nodoc:
+
+    # List a repo's projects
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.projects.list owner: 'owner-name', repo: 'repo-name'
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.projects.list state: 'open', owner: 'owner-name', repo: 'repo-name'
+    #
+    # @example
+    #  github.repos.projects.list owner: 'owner-name', repo: 'repo-name' { |cbr| .. }
+    #
+    # @return [Array]
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:owner, :repo])
+      params = arguments.params
+
+      params["accept"] ||= PREVIEW_MEDIA
+
+      response = get_request("/repos/#{arguments.owner}/#{arguments.repo}/projects", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Create a new project for the specified repo
+    #
+    # @param [Hash] params
+    # @option params [String] :name
+    #   Required string - The name of the project.
+    # @option params [String] :body
+    #   Optional string - The body of the project.
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.projects.create 'owner-name', 'repo-name', name: 'project-name'
+    #  github.repos.projects.create name: 'project-name', body: 'project-body', owner: 'owner-name', repo: 'repo-name'
+    #
+    # @api public
+    def create(*args)
+      arguments(args, required: [:owner, :repo]) do
+        assert_required %w[ name ]
+      end
+      params = arguments.params
+
+      params["accept"] ||= PREVIEW_MEDIA
+
+      post_request("/repos/#{arguments.owner}/#{arguments.repo}/projects", params)
+    end
+  end # Projects
+end # Github

data/lib/github_api/client/repos/pub_sub_hubbub.rb

@@ -1,11 +1,11 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::Repos::PubSubHubbub < API
-    OPTIONS = {
-      :headers => {
-        CONTENT_TYPE => 'application/x-www-form-urlencoded'
-      }
+    HEADERS = {
+      CONTENT_TYPE => 'application/x-www-form-urlencoded'
     }
 
     # Subscribe to existing topic/event through pubsubhubbub
@@ -29,7 +29,7 @@ module Github
     def subscribe(*args)
       params = arguments(args, required: [:topic, :callback]).params
       _merge_action!("subscribe", arguments.topic, arguments.callback, params)
-      params['options'] = OPTIONS
+      params['headers'] = HEADERS
 
       post_request("/hub", params)
     end
@@ -56,7 +56,7 @@ module Github
     def unsubscribe(*args)
       params = arguments(args, required: [:topic, :callback]).params
       _merge_action!("unsubscribe", arguments.topic, arguments.callback, params)
-      params['options'] = OPTIONS
+      params['headers'] = HEADERS
 
       post_request("/hub", params)
     end