octokit 3.0.0.pre → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba2a0b7ef2fe7ccfc4d47d20101e1bf1df5352b6
-  data.tar.gz: 00d6d398a4682911be8b46d7cc0e0a5320afbdd4
+  metadata.gz: 3127ed71ac877e994dfeaae2386caba2cfe91d38
+  data.tar.gz: aeb738769c892c656de0d0971e18763de18f8e3a
 SHA512:
-  metadata.gz: d754b8c098880c8e738ba09b2c96db93e5ec70961cb8b3a9b20876ebf6f3034f70f662bf63f6268f596d5aaa740c6fb06996db714148319a1e20d95028ba4f9d
-  data.tar.gz: 8c164081ca60967730307c8d98dd1822cb0bc3ada9876cd192ca39d9ac790881e7424f53b1762929b64078bd374211d215a5c0ee65708c64c68fbe122ee70dd1
+  metadata.gz: d14f5d8127f946870995ff7a92ccb31945ef90da7b82fce8878f921bf53c8a1ce8e285c2dc13eeae12189d7416673136b98bba1813b77b1a8cabc647323a3d9b
+  data.tar.gz: 69f7d0a715685c0506a25b44bc44533fb7baff7a815db31587a8ce260f9b7445a4d9a13995a64667d05afc538a4636deec7bb2a4d588921c06592951e520ae3a

data/README.md

@@ -285,6 +285,10 @@ Octokit.api_endpoint
 # => "http://api.github.dev"
 ```
 
+Deprecation warnings and API endpoints in development preview warnings are
+printed to STDOUT by default, these can be disabled by setting the ENV
+`OCTOKIT_SILENT=true`.
+
 ## Hypermedia agent
 
 Starting in version 2.0, Octokit is [hypermedia][]-enabled. Under the hood,

data/lib/octokit/authentication.rb

@@ -60,13 +60,13 @@ module Octokit
       creds = info[netrc_host]
       if creds.nil?
         # creds will be nil if there is no netrc for this end point
-        warn "Error loading credentials from netrc file for #{api_endpoint}"
+        octokit_warn "Error loading credentials from netrc file for #{api_endpoint}"
       else
         self.login = creds.shift
         self.password = creds.shift
       end
     rescue LoadError
-      warn "Please install netrc gem for .netrc support"
+      octokit_warn "Please install netrc gem for .netrc support"
     end
 
   end

data/lib/octokit/client.rb

@@ -300,5 +300,14 @@ module Octokit
       opts
     end
 
+    # Wrapper around Kernel#warn to print warnings unless
+    # OCTOKIT_SILENT is set to true.
+    #
+    # @return [nil]
+    def octokit_warn(*message)
+      unless ENV['OCTOKIT_SILENT']
+        warn message
+      end
+    end
   end
 end

data/lib/octokit/client/authorizations.rb

@@ -51,6 +51,7 @@ module Octokit
       # @return [Sawyer::Resource] A single authorization for the authenticated user
       # @see http://developer.github.com/v3/oauth/#scopes Available scopes
       # @see http://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization
+      # @see http://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app
       # @example Create a new authorization for user ctshryock's project Zoidberg
       #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
       #  client.create_authorization({:scopes => ["public_repo","gist"], :note => "Why not Zoidberg?", :note_url=> "https://en.wikipedia.org/wiki/Zoidberg"})

data/lib/octokit/client/contents.rb

@@ -42,7 +42,7 @@ module Octokit
       #   @param repo [String, Repository, Hash] A GitHub repository
       #   @param path [String] A path for the new content
       #   @param message [String] A commit message for adding the content
-      #   @param optional content [String] The Base64-encoded content for the file
+      #   @param optional content [String] The content for the file
       #   @option options [String] :branch The branch on which to add the content
       #   @option options [String] :file Path or Ruby File object for content
       # @return [Sawyer::Resource] The contents and commit info for the addition
@@ -51,7 +51,7 @@ module Octokit
       #   Octokit.create_contents("octokit/octokit.rb",
       #                    "lib/octokit.rb",
       #                    "Adding content",
-      #                    "asdf9as0df9asdf8as0d9f8==...",
+      #                    "File content",
       #                    :branch => "my-new-feature")
       def create_contents(*args)
         options = args.last.is_a?(Hash) ? args.pop : {}
@@ -91,7 +91,7 @@ module Octokit
       #   @param path [String] A path for the content to update
       #   @param message [String] A commit message for updating the content
       #   @param sha [String] The _blob sha_ of the content to update
-      #   @param content [String] The Base64-encoded content for the file
+      #   @param content [String] The content for the file
       #   @option options [String] :branch The branch on which to update the content
       #   @option options [String] :file Path or Ruby File object for content
       # @return [Sawyer::Resource] The contents and commit info for the update
@@ -101,7 +101,7 @@ module Octokit
       #                    "lib/octokit.rb",
       #                    "Updating content",
       #                    "7eb95f97e1a0636015df3837478d3f15184a5f49",
-      #                    "asdf9as0df9asdf8as0d9f8==...",
+      #                    "File content",
       #                    :branch => "my-new-feature")
       def update_contents(*args)
         options = args.last.is_a?(Hash) ? args.pop : {}

data/lib/octokit/client/deployments.rb

@@ -72,7 +72,7 @@ module Octokit
       end
 
       def warn_deployments_preview
-        warn <<-EOS
+        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

data/lib/octokit/client/pull_requests.rb

@@ -26,7 +26,7 @@ module Octokit
         opts = arguments.options
         repo = arguments.shift
         if state = arguments.shift
-          warn "DEPRECATED: Client#pull_requests: Passing state as positional argument is deprecated. Please use :state => '#{state}'"
+          octokit_warn "DEPRECATED: Client#pull_requests: Passing state as positional argument is deprecated. Please use :state => '#{state}'"
           opts[:state] = state if state
         end
         paginate "repos/#{Repository.new(repo)}/pulls", opts

data/lib/octokit/client/rate_limit.rb

@@ -23,7 +23,7 @@ module Octokit
       # @see http://developer.github.com/v3/rate_limit/#rate-limit
       # @return [Fixnum] Number of requests remaining in this period
       def rate_limit_remaining(options = {})
-        puts "Deprecated: Please use .rate_limit.remaining"
+        octokit_warn "Deprecated: Please use .rate_limit.remaining"
         rate_limit.remaining
       end
       alias ratelimit_remaining rate_limit_remaining
@@ -43,7 +43,7 @@ module Octokit
       # @see http://developer.github.com/v3/rate_limit/#rate-limit
       # @return [Fixnum] Number of requests remaining in this period
       def rate_limit_remaining!(options = {})
-        puts "Deprecated: Please use .rate_limit!.remaining"
+        octokit_warn "Deprecated: Please use .rate_limit!.remaining"
         rate_limit!.remaining
       end
       alias ratelimit_remaining! rate_limit_remaining!

data/lib/octokit/client/repositories.rb

@@ -50,13 +50,17 @@ module Octokit
       alias :update_repository :edit_repository
       alias :update :edit_repository
 
-      # List repositories
+      # List user repositories
       #
       # If username is not supplied, repositories for the current
-      # authenticated user are returned
+      #   authenticated user are returned.
       #
+      # @note If the username provided is a GitHub organization, only the
+      #   organization's public repositories will be listed. For retrieving
+      #   organization repositories the {Organizations#organization_repositories}
+      #   method should be used instead.
       # @see http://developer.github.com/v3/repos/#list-your-repositories
-			# @see http://developer.github.com/v3/repos/#list-user-repositories
+      # @see http://developer.github.com/v3/repos/#list-user-repositories
       # @param username [String] Optional username for which to list repos
       # @return [Array<Sawyer::Resource>] List of repositories
       def repositories(username=nil, options = {})
@@ -484,7 +488,7 @@ module Octokit
       #
       # @param repo [String, Hash, Repository] A GitHub repository.
       # @return [Array<Sawyer::Resource>] Array of hashes representing hooks.
-      # @see http://developer.github.com/v3/repos/hooks/#list
+      # @see http://developer.github.com/v3/repos/hooks/#list-hooks
       # @example
       #   @client.hooks('octokit/octokit.rb')
       def hooks(repo, options = {})

data/lib/octokit/client/statuses.rb

@@ -5,6 +5,7 @@ module Octokit
     #
     # @see http://developer.github.com/v3/repos/statuses/
     module Statuses
+      COMBINED_STATUS_MEDIA_TYPE = "application/vnd.github.she-hulk-preview+json"
 
       # List all statuses for a given commit
       #
@@ -17,17 +18,50 @@ module Octokit
       end
       alias :list_statuses :statuses
 
+      # Get the combined status for a ref
+      #
+      # @param repo [String, Repository, Hash] a GitHub repository
+      # @param ref  [String] A Sha or Ref to fetch the status of
+      # @return [Sawyer::Resource] The combined status for the commit
+      # @see https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref
+      def combined_status(repo, ref, options = {})
+        ensure_combined_status_api_media_type(options)
+        get "repos/#{Repository.new(repo)}/commits/#{ref}/status", options
+      end
+      alias :status :combined_status
+
       # Create status for a commit
       #
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param sha [String] The SHA1 for the commit
       # @param state [String] The state: pending, success, failure, error
+      # @option options [String] :context A context to differentiate this status from others
+      # @option options [String] :target_url A link to more details about this status
+      # @option options [String] :description A short human-readable description of this status
       # @return [Sawyer::Resource] A status
       # @see http://developer.github.com/v3/repos/statuses/#create-a-status
       def create_status(repo, sha, state, options = {})
         options.merge!(:state => state)
         post "repos/#{Repository.new(repo)}/statuses/#{sha}", options
       end
+
+      private
+
+      def ensure_combined_status_api_media_type(options = {})
+        unless options[:accept]
+          options[:accept] = COMBINED_STATUS_MEDIA_TYPE
+          warn_combined_status_preview
+        end
+        options
+      end
+
+      def warn_combined_status_preview
+        octokit_warn <<-EOS
+WARNING: The preview version of the combined status API is not yet suitable
+for production use. You can avoid this message by supplying an appropriate
+media type in the 'Accept' header. See the blog post for details http://git.io/wtsdaA
+EOS
+      end
     end
   end
 end

data/lib/octokit/client/users.rb

@@ -41,8 +41,8 @@ module Octokit
       # Retrieve the access_token.
       #
       # @param code [String] Authorization code generated by GitHub.
-      # @param app_id [String] Client Id we received when our application was registered with GitHub.
-      # @param app_secret [String] Client Secret we received when our application was registered with GitHub.
+      # @param app_id [String] Client Id we received when our application was registered with GitHub. Defaults to client_id.
+      # @param app_secret [String] Client Secret we received when our application was registered with GitHub. Defaults to client_secret.
       # @return [Sawyer::Resource] Hash holding the access token.
       # @see http://developer.github.com/v3/oauth/#web-application-flow
       # @example

data/lib/octokit/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 3.0.0.pre
+  version: 3.0.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-06 00:00:00.000000000 Z
+date: 2014-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -119,9 +119,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: 1.3.5
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.3