github_api 0.14.5 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46047e4b717b4da3c22007f7cae889de3c7170fa
-  data.tar.gz: bb7c81cd821cbfbb0620d0c1a93095606720d23b
+  metadata.gz: 9312a6593c2f32bcc8b408beca9259a0747a70be
+  data.tar.gz: 9d5e113c5690642ef9fb0d9269ccc42d54421bd1
 SHA512:
-  metadata.gz: e95e4a12984c0dd8075f0d7ed0dabbe3ee2b6f8755e2d4ca192ed8835c83dd9a2999ad2d20d2d1fd3c36ec6972cf743472960180f44f35d0d0c2b5b05766fdcf
-  data.tar.gz: 6e12ab65ced01db43a703362537650c43b125c35cd16ee872b65120f246ed546157dab5330991a93c62c65823a012d254b21eed2bf486c8e8351fef5c2a92a90
+  metadata.gz: 15f1895fc1e726e678f67298e0489c681da59b2e0737c4baba47baa74dfe998ac8d76e0bd02f6f9bdf304fb8043694f70c15e77b670427d1cafa2cb2db4c35cb
+  data.tar.gz: e4e76f0e15c2ad51905fca1d8072072c689f8a80758e3f86b26bf8004e66fb58bea975393345dc8852d9bcfca495ae2bd195261f075b6cbbd5188087f2124c72

data/README.md

@@ -1,7 +1,9 @@
 <div align="center">
   <a href="http://piotrmurach.github.io/github/"><img width="136" src="https://github.com/piotrmurach/github/raw/master/icons/github_api.png" alt="github api logo" /></a>
 </div>
+
 # GithubAPI
+
 [![Gem Version](https://badge.fury.io/rb/github_api.svg)][gem]
 [![Build Status](https://secure.travis-ci.org/piotrmurach/github.svg?branch=master)][travis]
 [![Code Climate](https://codeclimate.com/github/piotrmurach/github/badges/gpa.svg)][codeclimate]

data/lib/github_api/client/git_data/references.rb

@@ -122,7 +122,7 @@ module Github
     # @example
     #  github = Github.new
     #  github.git_data.references.delete 'user-name', 'repo-name',
-    #    ref: "refs/heads/master"
+    #    "heads/master"
     #
     # @api public
     def delete(*args)

data/lib/github_api/client/git_data/tags.rb

@@ -4,6 +4,7 @@ module Github
   class Client::GitData::Tags < API
     # This tags api only deals with tag objects -
     # so only annotated tags, not lightweight tags.
+    # Refer https://developer.github.com/v3/git/tags/#parameters
 
     VALID_TAG_PARAM_NAMES = %w[
       tag
@@ -13,8 +14,6 @@ module Github
       name
       email
       date
-      sha
-      url
       tagger
     ].freeze
 

data/lib/github_api/client/pull_requests.rb

@@ -3,10 +3,12 @@
 module Github
   class Client::PullRequests < API
 
-    require_all 'github_api/client/pull_requests', 'comments'
+    require_all 'github_api/client/pull_requests', 'comments', 'reviews'
 
     # Access to PullRequests::Comments API
     namespace :comments
+    # Access to PullRequests::Reviews API
+    namespace :reviews
 
     # List pull requests
     #
@@ -171,8 +173,9 @@ module Github
     #   Optional string - The message that will be used for the merge commit
     # @option params [String] :sha
     #   Optional string - The SHA that pull request head must match to allow merge
-    # @option params [Boolean] :squash
-    #   Optional boolean - Commit a single commit to the head branch.
+    # @option params [String] :merge_method
+    #   Optional string - Merge method to use.
+    #   Valid values are merge, squash, and rebase. Default is merge.
     #
     # @example
     #  github = Github.new

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

@@ -58,7 +58,7 @@ module Github
     def get(*args)
       arguments(args, required: [:user, :repo, :number])
 
-      get_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/comments/#{arguments.number}", arguments.params)
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/comments", arguments.params)
     end
     alias_method :find, :get
 

data/lib/github_api/client/pull_requests/reviews.rb

@@ -0,0 +1,156 @@
+# encoding: utf-8
+
+module Github
+  class Client::PullRequests::Reviews < API
+    PREVIEW_MEDIA = "application/vnd.github.black-cat-preview+json".freeze # :nodoc:
+
+    # List reviews on a pull request
+    #
+    # @example
+    #   github = Github.new
+    #   github.pull_requests.reviews.list 'user-name', 'repo-name', number: 'pull-request-number'
+    #
+    # List pull request reviews in a repository
+    #
+    # @example
+    #   github = Github.new
+    #   github.pull_requests.reviews.list 'user-name', 'repo-name', number: 'pull-request-number'
+    #   github.pull_requests.reviews.list 'user-name', 'repo-name', number: 'pull-request-number' { |comm| ... }
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo, :number])
+      params = arguments.params
+
+      params["accept"] ||= PREVIEW_MEDIA
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/reviews", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias_method :all, :list
+
+    # Get a single review for pull requests
+    #
+    # @example
+    #   github = Github.new
+    #   github.pull_requests.reviews.get 'user-name', 'repo-name', 'number', 'id'
+    #
+    # @example
+    #   github.pull_requests.reviews.get
+    #     user: 'user-name',
+    #     repo: 'repo-name',
+    #     number: 1,
+    #     id: 80
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:user, :repo, :number, :id])
+
+      params             = arguments.params
+      params["accept"] ||= PREVIEW_MEDIA
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/reviews/#{arguments.id}", params)
+    end
+    alias_method :find, :get
+
+    # Create a pull request review
+    #
+    # @param [Hash] params
+    # @option params [String] :event
+    #   Required string - The review action (event) to perform; can be one of
+    #   APPROVE, REQUEST_CHANGES, or COMMENT. If left blank, the API returns
+    #   HTTP 422 (Unrecognizable entity) and the review is left PENDING
+    # @option params [String] :body
+    #   Optional string. The text of the review.
+    # @option params [Array] :comments
+    #   Optional array of draft review comment objects. An array of comments
+    #   part of the review.
+    #
+    # @example
+    #  github = Github.new
+    #  github.pull_requests.reviews.create 'user-name', 'repo-name', 'number',
+    #    body: "Nice change",
+    #    event: "APPROVE",
+    #    comments: [
+    #      {
+    #        path: 'path/to/file/commented/on',
+    #        position: 10,
+    #        body:     'This looks good.'
+    #      }
+    #    ]
+    #
+    # @api public
+    def create(*args)
+      arguments(args, required: [:user, :repo, :number])
+
+      params             = arguments.params
+      params["accept"] ||= PREVIEW_MEDIA
+
+      post_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/reviews", params)
+    end
+
+    # Update a pull request review
+    #
+    # @param [Hash] params
+    # @option params [String] :state
+    #   Required string - The review action (event) to perform; can be one of
+    #   APPROVE, REQUEST_CHANGES, or COMMENT. If left blank, the API returns
+    #   HTTP 422 (Unrecognizable entity) and the review is left PENDING
+    # @optoin params [String] :body
+    #   Optional string
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.pull_requests.reviews.update 'user-name', 'repo-name', 'number', 'review-id'
+    #    body: "Update body",
+    #    event: "APPROVE"
+    #
+    # @api public
+    def update(*args)
+      arguments(args, required: [:user, :repo, :number, :id])
+      params = arguments.params
+
+      params["accept"] ||= PREVIEW_MEDIA
+
+      post_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/reviews/#{arguments.id}/events", params)
+    end
+
+    # @option params [String] :message
+    #   Optional string - Reason for dismissal
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.pull_requests.reviews.dismiss 'user-name', 'repo-name', 'number', 'review-id'
+    #    message: "I can't get to this right now."
+    #
+    # @api public
+    def dismiss(*args)
+      arguments(args, required: [:user, :repo, :number, :id])
+      params = arguments.params
+
+      params["accept"] ||= PREVIEW_MEDIA
+
+      put_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/reviews/#{arguments.id}/dismissals", params)
+    end
+
+    # List comments on a pull request review
+    #
+    # @example
+    #  github = Github.new
+    #  github.pull_requests.revieiws.comments 'user-name', 'repo-name', 'number', 'review-id'
+    #
+    # @api public
+    def comments(*args)
+      arguments(args, required: [:user, :repo, :number, :id])
+      params = arguments.params
+
+      params["accept"] ||= PREVIEW_MEDIA
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/reviews/#{arguments.id}/comments", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+  end
+end

data/lib/github_api/client/repos.rb

@@ -20,14 +20,6 @@ module Github
       'statistics',
       'statuses'
 
-    DEFAULT_REPO_OPTIONS = {
-      "homepage"   => "https://github.com",
-      "private"    => false,
-      "has_issues" => true,
-      "has_wiki"   => true,
-      "has_downloads" => true
-    }.freeze
-
     REQUIRED_REPO_OPTIONS = %w[ name ]
 
     VALID_REPO_OPTIONS = %w[
@@ -166,6 +158,21 @@ module Github
     end
     alias :find :get
 
+    # Get a repository
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.get_by_id 'repo-id'
+    #  github.repos.get_by_id id: 'repo-id'
+    #  github.repos(id: 'repo-id').get_by_id
+    #
+    def get_by_id(*args)
+      arguments(args, required: [:id])
+
+      get_request("/repositories/#{arguments.id}", arguments.params)
+    end
+    alias :find_by_id :get_by_id
+
     # Create a new repository for the autheticated user.
     #
     # @param [Hash] params
@@ -229,9 +236,9 @@ module Github
 
       # Requires authenticated user
       if (org = params.delete('org') || org)
-        post_request("/orgs/#{org}/repos", params.merge_default(DEFAULT_REPO_OPTIONS))
+        post_request("/orgs/#{org}/repos", params)
       else
-        post_request('/user/repos', params.merge_default(DEFAULT_REPO_OPTIONS))
+        post_request("/user/repos", params)
       end
     end
 
@@ -313,7 +320,7 @@ module Github
         assert_required %w[ name ]
       end
 
-      patch_request("/repos/#{arguments.user}/#{arguments.repo}", arguments.params.merge_default(DEFAULT_REPO_OPTIONS))
+      patch_request("/repos/#{arguments.user}/#{arguments.repo}", arguments.params)
     end
 
     # Delete a repository

data/lib/github_api/response/mashify.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 require 'faraday'
+require 'hashie'
 
 module Github
   class Response::Mashify < Response

data/lib/github_api/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Github
-  VERSION = "0.14.5"
+  VERSION = "0.15.0"
 end # Github

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_api
 version: !ruby/object:Gem::Version
-  version: 0.14.5
+  version: 0.15.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-07 00:00:00.000000000 Z
+date: 2017-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -86,6 +86,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -104,16 +124,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.0'
 description: " Ruby client that supports all of the GitHub API methods. It's build
   in a modular way, that is, you can either instantiate the whole api wrapper Github.new
   or use parts of it e.i. Github::Client::Repos.new if working solely with repositories
@@ -170,6 +190,7 @@ files:
 - lib/github_api/client/orgs/teams.rb
 - lib/github_api/client/pull_requests.rb
 - lib/github_api/client/pull_requests/comments.rb
+- lib/github_api/client/pull_requests/reviews.rb
 - lib/github_api/client/repos.rb
 - lib/github_api/client/repos/collaborators.rb
 - lib/github_api/client/repos/comments.rb