octokit 3.5.2 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b21490afb50e6acd65ac6cb66475251aeeb6e85a
-  data.tar.gz: 331fd29bac0ba67105639ea7b0aef72a79f25c5d
+  metadata.gz: 59f95926a49217f6e7b37fafcfbb8f67c3514187
+  data.tar.gz: e3815c01033df0d167d677c6cef0d0e4f7f72e84
 SHA512:
-  metadata.gz: 9de481f7dece4a7cc630c1df9429b6ebd8bff26dfe4c2bbe76edfb62abd274495c5cbcf9ed4fc530258003e83b025e346890c44477c50ccaaf77694571f22f2a
-  data.tar.gz: 7d211ac73a89747179c67eededac39cc9a71fbd3135ec0a366d29ebdb29175a5448eb4e5a4b0ef746cd0af0efe0dd36af70a611f3cb5a9cd44c8829fea04d3f9
+  metadata.gz: 42798186a228a4dd0e72aebe2df3c05da5d36a342884e86fa71cb813eed8aa598a37b54263834510856683824d244b8225e7d4067a77a78ab36ea92b42d51840
+  data.tar.gz: b9d1a869713cd29d287fc1614d93784574d3641035ddd43d1e7de484e9a0cd4fbe14673482efafedefbd1a8ec54f8d97aa91f99ead7405fa7675f5308445d3e9

data/README.md

@@ -566,7 +566,7 @@ Constraint][pvc] with two digits of precision. For example:
     spec.add_dependency 'octokit', '~> 3.0'
 
 [semver]: http://semver.org/
-[pvc]: http://docs.rubygems.org/read/chapter/16#page74
+[pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
 
 ## License
 

data/lib/octokit/client/deployments.rb

@@ -6,15 +6,12 @@ module Octokit
     # @see https://developer.github.com/v3/repos/commits/deployments/
     module Deployments
 
-      DEPLOYMENTS_PREVIEW_MEDIA_TYPE = "application/vnd.github.cannonball-preview+json".freeze
-
       # List all deployments for a repository
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
       # @return [Array<Sawyer::Resource>] A list of deployments
       # @see https://developer.github.com/v3/repos/deployments/#list-deployments
       def deployments(repo, options = {})
-        options = ensure_deployments_api_media_type(options)
         get("#{Repository.path repo}/deployments", options)
       end
       alias :list_deployments :deployments
@@ -23,14 +20,15 @@ module Octokit
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
       # @param ref [String] The ref to deploy
+      # @option options [String] :task Used by the deployment system to allow different execution paths. Defaults to "deploy".
       # @option options [String] :payload Meta info about the deployment
-      # @option options [String] :force Optional parameter to bypass any ahead/behind checks or commit status checks. Default: false
-      # @option options [String] :auto_merge Optional parameter to merge the default branch into the requested deployment branch if necessary. Default: false
+      # @option options [Boolean] :auto_merge Optional parameter to merge the default branch into the requested deployment branch if necessary. Default: true
+      # @option options [Array<String>] :required_contexts Optional array of status contexts verified against commit status checks.
+      # @option options [String] :environment Optional name for the target deployment environment (e.g., production, staging, qa). Default: "production"
       # @option options [String] :description Optional short description.
       # @return [Sawyer::Resource] A deployment
       # @see https://developer.github.com/v3/repos/deployments/#create-a-deployment
       def create_deployment(repo, ref, options = {})
-        options = ensure_deployments_api_media_type(options)
         options[:ref] = ref
         post("#{Repository.path repo}/deployments", options)
       end
@@ -41,7 +39,6 @@ module Octokit
       # @return [Array<Sawyer::Resource>] A list of deployment statuses
       # @see https://developer.github.com/v3/repos/deployments/#list-deployment-statuses
       def deployment_statuses(deployment_url, options = {})
-        options = ensure_deployments_api_media_type(options)
         deployment = get(deployment_url, :accept => options[:accept])
         get(deployment.rels[:statuses].href, options)
       end
@@ -54,30 +51,10 @@ module Octokit
       # @return [Sawyer::Resource] A deployment status
       # @see https://developer.github.com/v3/repos/deployments/#create-a-deployment-status
       def create_deployment_status(deployment_url, state, options = {})
-        options = ensure_deployments_api_media_type(options)
         deployment = get(deployment_url, :accept => options[:accept])
         options[:state] = state.to_s.downcase
         post(deployment.rels[:statuses].href, options)
       end
-
-      private
-
-      def ensure_deployments_api_media_type(options = {})
-        if options[:accept].nil?
-          options[:accept] = DEPLOYMENTS_PREVIEW_MEDIA_TYPE
-          warn_deployments_preview
-        end
-
-        options
-      end
-
-      def warn_deployments_preview
-        octokit_warn <<-EOS
-WARNING: The preview version of the Deployments API is not yet suitable for production use.
-You can avoid this message by supplying an appropriate media type in the 'Accept' request
-header. See the blog post for details: http://git.io/o2XZRA
-EOS
-      end
     end
   end
 end

data/lib/octokit/client/issues.rb

@@ -143,21 +143,45 @@ module Octokit
 
       # Update an issue
       #
-      # @param repo [Integer, String, Repository, Hash] A GitHub repository
-      # @param number [Integer] Number ID of the issue
-      # @param title [String] Updated title for the issue
-      # @param body [String] Updated body of the issue
-      # @param options [Hash] A customizable set of options.
-      # @option options [String] :assignee User login.
-      # @option options [Integer] :milestone Milestone number.
-      # @option options [String] :labels List of comma separated Label names. Example: <tt>bug,ui,@high</tt>.
-      # @option options [String] :state State of the issue. <tt>open</tt> or <tt>closed</tt>
+      # @overload update_issue(repo, number, title, body, options)
+      #   @param repo [Integer, String, Repository, Hash] A GitHub repository
+      #   @param number [Integer] Number ID of the issue
+      #   @param title [String] Updated title for the issue
+      #   @param body [String] Updated body of the issue
+      #   @param options [Hash] A customizable set of options.
+      #   @option options [String] :assignee User login.
+      #   @option options [Integer] :milestone Milestone number.
+      #   @option options [String] :labels List of comma separated Label names. Example: <tt>bug,ui,@high</tt>.
+      #   @option options [String] :state State of the issue. <tt>open</tt> or <tt>closed</tt>
+      #
+      # @overload update_issue(repo, number, options)
+      #   @param repo [Integer, String, Repository, Hash] A GitHub repository
+      #   @param number [Integer] Number ID of the issue
+      #   @param options [Hash] A customizable set of options.
+      #   @option options [String] :title Updated title for the issue
+      #   @option options [String] :body Updated body of the issue
+      #   @option options [String] :assignee User login.
+      #   @option options [Integer] :milestone Milestone number.
+      #   @option options [String] :labels List of comma separated Label names. Example: <tt>bug,ui,@high</tt>.
+      #   @option options [String] :state State of the issue. <tt>open</tt> or <tt>closed</tt>
       # @return [Sawyer::Resource] The updated Issue
       # @see https://developer.github.com/v3/issues/#edit-an-issue
+      #
       # @example Change the title of Issue #25
-      #   Octokit.update_issue("octokit/octokit.rb", "25", "A new title", "the same body"")
-      def update_issue(repo, number, title, body, options = {})
-        patch "#{Repository.path repo}/issues/#{number}", options.merge({:title => title, :body => body})
+      #   Octokit.update_issue("octokit/octokit.rb", "25", "A new title", "the same body")
+      #
+      # @example Change only the assignee of Issue #25
+      #   Octokit.update_issue("octokit/octokit.rb", "25", :assignee => "pengwynn")
+      def update_issue(repo, number, *args)
+        arguments = Arguments.new(args)
+        opts = arguments.options
+
+        if arguments.length > 0
+          opts[:title] = arguments.shift
+          opts[:body] = arguments.shift
+        end
+
+        patch "#{Repository.path repo}/issues/#{number}", opts
       end
 
       # Get all comments attached to issues for the repository

data/lib/octokit/client/pull_requests.rb

@@ -56,6 +56,9 @@ module Octokit
       # @param title [String] Title for the pull request
       # @param body [String] The body for the pull request. Supports GFM.
       # @return [Sawyer::Resource] The newly created pull request
+      # @example
+      #   @client.create_pull_request("octokit/octokit.rb", "master", "feature-branch",
+      #     "Pull Request title", "Pull Request body")
       def create_pull_request(repo, base, head, title, body, options = {})
         pull = {
           :base  => base,

data/lib/octokit/error.rb

@@ -2,7 +2,7 @@ module Octokit
   # Custom error class for rescuing from all GitHub errors
   class Error < StandardError
 
-    # Returns the appropriate Octokit::Error sublcass based
+    # Returns the appropriate Octokit::Error subclass based
     # on status and response message
     #
     # @param [Hash] response HTTP response

data/lib/octokit/rate_limit.rb

@@ -24,7 +24,7 @@ module Octokit
         info.limit = (response.headers['X-RateLimit-Limit'] || 1).to_i
         info.remaining = (response.headers['X-RateLimit-Remaining'] || 1).to_i
         info.resets_at = Time.at((response.headers['X-RateLimit-Reset'] || Time.now).to_i)
-        info.resets_in = (info.resets_at - Time.now).to_i
+        info.resets_in = [(info.resets_at - Time.now).to_i, 0].max
       end
 
       info

data/lib/octokit/version.rb

@@ -2,6 +2,6 @@ module Octokit
 
   # Current version
   # @return [String]
-  VERSION = "3.5.2".freeze
+  VERSION = "3.6.0".freeze
 
 end

data/octokit.gemspec

@@ -5,7 +5,7 @@ require 'octokit/version'
 
 Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.0'
-  spec.add_dependency 'sawyer', '~> 0.5.3'
+  spec.add_dependency 'sawyer', '>= 0.5.3', '~> 0.6.0'
   spec.authors = ["Wynn Netherland", "Erik Michaels-Ober", "Clint Shryock"]
   spec.description = %q{Simple wrapper for the GitHub API}
   spec.email = ['wynn.netherland@gmail.com', 'sferik@gmail.com', 'clint@ctshryock.com']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 3.5.2
+  version: 3.6.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-28 00:00:00.000000000 Z
+date: 2014-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,16 +30,22 @@ dependencies:
   name: sawyer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.3
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.3
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 description: Simple wrapper for the GitHub API
 email:
 - wynn.netherland@gmail.com