octokit 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f629afcf00490756d9918174b9c80cff0afe64ab
-  data.tar.gz: 7e27860c840368c6285551ca8354a563d6542922
+  metadata.gz: 8c21feeb271532d08aa8fab12592183f7b641475
+  data.tar.gz: 54713209e7ff15a840bde44b91f20ef838f411d1
 SHA512:
-  metadata.gz: 810ded7876d09f26e4a77ce387cc20db3a7e4c439d948d9bc5f6543dd62be4dca6b3ac1932683c35ebb78ef91a5876e696f1db201f352239261f15609575b07f
-  data.tar.gz: 44cf44e3501922f0bf8ff533c7f053355cd77f1e76df6df36de132367cad3147f5e3e72e85223cf74be62cdc4d7e55c144a931e5662d2f249585267ca2577236
+  metadata.gz: 73e5cd0618ca59735e3edfca2f76d264dc32f964cd48fdeeee738480fbf2f0ffeab399e6ebeb73f3707b8ec94043f54070811e5d6eb2b17ca62aa584652bc0f2
+  data.tar.gz: 78266ae30f9cd5e5f85a4b13c81bd0903854fb94a89c44eff851413b872d2bc40043a53a20e625faaa4659a21def7c7a32e3fbc8a53434f01b9cfbec92ab79fe

data/README.md

@@ -195,7 +195,7 @@ user = client.users 'defunkt'
 Many GitHub API resources are [paginated][]. While you may be tempted to start
 adding `:page` parameters to your calls, the API returns links to the next,
 previous, and last pages for you in the `Link` response header as [Hypermedia
-link relations](docs/hypermedia.md).
+link relations](#hypermedia-agent).
 
 ```ruby
 issues = Octokit.issues 'rails/rails', :per_page => 100

data/lib/octokit/client/authorizations.rb

@@ -46,7 +46,7 @@ module Octokit
       # @option options [String] :note_url A URL to remind you what app the OAuth token is for.
       # @option options [Boolean] :idempotent If true, will return an existing authorization if one has already been created.
       # @option options [String] :client_id  Client Id we received when our application was registered with GitHub.
-      # @option options [String] :client_id  Client Secret we received when our application was registered with GitHub.
+      # @option options [String] :client_secret  Client Secret we received when our application was registered with GitHub.
       #
       # @return [Sawyer::Resource] A single authorization for the authenticated user
       # @see http://developer.github.com/v3/oauth/#scopes Available scopes

data/lib/octokit/client/releases.rb

@@ -6,6 +6,7 @@ module Octokit
     # @see http://developer.github.com/v3/repos/releases/
     module Releases
 
+      # @private
       PREVIEW_MEDIA_TYPE = "application/vnd.github.manifold-preview".freeze
 
       # List releases for a repository
@@ -15,6 +16,7 @@ module Octokit
       # @see http://developer.github.com/v3/repos/releases/#list-releases-for-a-repository
       def releases(repo, options = {})
         options[:accept] ||= PREVIEW_MEDIA_TYPE
+        warn_releases_preview
         paginate "repos/#{Repository.new(repo)}/releases", options
       end
       alias :list_releases :releases
@@ -32,6 +34,7 @@ module Octokit
       # @see http://developer.github.com/v3/repos/releases/#create-a-release
       def create_release(repo, tag_name, options = {})
         options[:accept] ||= PREVIEW_MEDIA_TYPE
+        warn_releases_preview
         opts = options.merge(:tag_name => tag_name)
         post "repos/#{Repository.new(repo)}/releases", opts
       end
@@ -43,13 +46,13 @@ module Octokit
       # @see http://developer.github.com/v3/repos/releases/#get-a-single-release
       def release(url, options = {})
         options[:accept] ||= PREVIEW_MEDIA_TYPE
+        warn_releases_preview
         get url, options
       end
 
       # Update a release
       #
       # @param url [String] URL for the release as returned from .releases
-      # @param tag_name [String] Git tag from which to create release
       # @option options [String] :target_commitish Specifies the commitish value that determines where the Git tag is created from.
       # @option options [String] :name Name for the release
       # @option options [String] :body Content for release notes
@@ -59,6 +62,7 @@ module Octokit
       # @see http://developer.github.com/v3/repos/releases/#edit-a-release
       def update_release(url, options = {})
         options[:accept] ||= PREVIEW_MEDIA_TYPE
+        warn_releases_preview
         patch url, options
       end
       alias :edit_release :update_release
@@ -70,6 +74,7 @@ module Octokit
       # @see http://developer.github.com/v3/repos/releases/#delete-a-release
       def delete_release(url, options = {})
         options[:accept] ||= PREVIEW_MEDIA_TYPE
+        warn_releases_preview
         boolean_from_response(:delete, url, options)
       end
 
@@ -80,19 +85,21 @@ module Octokit
       # @see http://developer.github.com/v3/repos/releases/#list-assets-for-a-release
       def release_assets(release_url, options = {})
         options[:accept] ||= PREVIEW_MEDIA_TYPE
+        warn_releases_preview
         paginate release(release_url).rels[:assets].href, options
       end
 
       # Upload a release asset
       #
       # @param release_url [String] URL for the release as returned from .releases
-      # @param file [String] Path to file to upload
+      # @param path_or_file [String] Path to file to upload
       # @option options [String] :content_type The MIME type for the file to upload
       # @option options [String] :name The name for the file
       # @return [Sawyer::Resource] The release asset
       # @see http://developer.github.com/v3/repos/releases/#upload-a-release-asset
       def upload_asset(release_url, path_or_file, options = {})
         options[:accept] ||= PREVIEW_MEDIA_TYPE
+        warn_releases_preview
         file = path_or_file.respond_to?(:read) ? path_or_file : File.new(path_or_file, "r+b")
         options[:content_type] ||= content_type_from_file(file)
         raise Octokit::MissingContentType.new if options[:content_type].nil?
@@ -114,6 +121,7 @@ module Octokit
       # @see http://developer.github.com/v3/repos/releases/#get-a-single-release-asset
       def release_asset(asset_url, options = {})
         options[:accept] ||= PREVIEW_MEDIA_TYPE
+        warn_releases_preview
         get(asset_url, options)
       end
 
@@ -126,6 +134,7 @@ module Octokit
       # @see http://developer.github.com/v3/repos/releases/#get-a-single-release-asset
       def update_release_asset(asset_url, options = {})
         options[:accept] ||= PREVIEW_MEDIA_TYPE
+        warn_releases_preview
         patch(asset_url, options)
       end
       alias :edit_release_asset :update_release_asset
@@ -137,6 +146,7 @@ module Octokit
       # @see http://developer.github.com/v3/repos/releases/#delete-a-release-asset
       def delete_release_asset(asset_url, options = {})
         options[:accept] ||= PREVIEW_MEDIA_TYPE
+        warn_releases_preview
         boolean_from_response(:delete, asset_url, options)
       end
 
@@ -151,6 +161,13 @@ module Octokit
         msg = "Please pass content_type or install mime-types gem to guess content type from file"
         raise Octokit::MissingContentType.new msg
       end
+
+      def warn_releases_preview
+        warn <<-EOS
+WARNING: The preview version of the Releases API is not yet suitable for production use.
+See the blog post for details: http://git.io/gMY9sA
+EOS
+      end
     end
   end
 end

data/lib/octokit/error.rb

@@ -18,6 +18,7 @@ module Octokit
                   when 403      then error_for_403(body)
                   when 404      then Octokit::NotFound
                   when 406      then Octokit::NotAcceptable
+                  when 409      then Octokit::Conflict
                   when 415      then Octokit::UnsupportedMediaType
                   when 422      then Octokit::UnprocessableEntity
                   when 400..499 then Octokit::ClientError
@@ -184,6 +185,9 @@ module Octokit
   # Raised when GitHub returns a 406 HTTP status code
   class NotAcceptable < ClientError; end
 
+  # Raised when GitHub returns a 409 HTTP status code
+  class Conflict < ClientError; end
+
   # Raised when GitHub returns a 414 HTTP status code
   class UnsupportedMediaType < ClientError; end
 

data/lib/octokit/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-07 00:00:00.000000000 Z
+date: 2013-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler