octokit 2.7.2 → 3.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bb0abde4b6ce638afc6c962f04dbee820d5af42
-  data.tar.gz: a7bbbfa2fa6f2654736ea7a403af7f348323ea39
+  metadata.gz: ba2a0b7ef2fe7ccfc4d47d20101e1bf1df5352b6
+  data.tar.gz: 00d6d398a4682911be8b46d7cc0e0a5320afbdd4
 SHA512:
-  metadata.gz: 34a5e2a2dc261137f83b151593ab573455e7b60fefeb35c90bb6ab7c971797433f84d897f34e2c0924c8b5ce8d59662c35f584c28f2b3e884133d18b551bb995
-  data.tar.gz: a00b6f83733e4ac7abe948748f53d370546bcb02bced8b30adc77322418d17cfa3a5d496b1b20f0ba2df22b30f942f6f3038c2b9faef1d7c53df985e5d52f068
+  metadata.gz: d754b8c098880c8e738ba09b2c96db93e5ec70961cb8b3a9b20876ebf6f3034f70f662bf63f6268f596d5aaa740c6fb06996db714148319a1e20d95028ba4f9d
+  data.tar.gz: 8c164081ca60967730307c8d98dd1822cb0bc3ada9876cd192ca39d9ac790881e7424f53b1762929b64078bd374211d215a5c0ee65708c64c68fbe122ee70dd1

data/CONTRIBUTING.md

@@ -9,11 +9,12 @@
 5. Implement your feature or bug fix.
 6. Run `script/test`. If your specs fail, return to step 5.
 7. Run `open coverage/index.html`. If your changes are not completely covered
-   by your tests, return to step 3.
+   by your tests, return to step 4.
 8. Add documentation for your feature or bug fix.
 9. Run `bundle exec rake doc:yard`. If your changes are not 100% documented, go
    back to step 8.
-10. Add, commit, and push your changes.
+10. Add, commit, and push your changes. For documentation-only fixes, please
+    add "[ci skip]" to your commit message to avoid needless CI builds.
 11. [Submit a pull request.][pr]
 
 [fork]: https://help.github.com/articles/fork-a-repo

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2013 Wynn Netherland, Adam Stacoviak, Erik Michaels-Ober
+Copyright (c) 2009-2014 Wynn Netherland, Adam Stacoviak, Erik Michaels-Ober
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -54,7 +54,7 @@ or
 
 ```ruby
 # Provide authentication credentials
-client = Octokit::Client.new :login => 'defunkt', :password => 'c0d3b4ssssss!'
+client = Octokit::Client.new(:login => 'defunkt', :password => 'c0d3b4ssssss!')
 # Fetch the current user
 client.user
 ```
@@ -129,7 +129,7 @@ To use an access token with the Octokit client, just pass it in lieu of your
 username and password:
 
 ```ruby
-client = Octokit::Client.new :access_token => "<your 40 char token>"
+client = Octokit::Client.new(:access_token => "<your 40 char token>")
 
 user = client.user
 user.login
@@ -141,7 +141,7 @@ that you can use for subsequent calls.
 
 ### Two-Factor Authentication
 
-[Two-Factor Authentication](https://help.github.com/articles/about-two-factor-authentication) brings added security to the account by requiring more information to login. 
+[Two-Factor Authentication](https://help.github.com/articles/about-two-factor-authentication) brings added security to the account by requiring more information to login.
 
 Using two-factor authentication for API calls is as simple as adding the [required header](http://developer.github.com/v3/auth/#working-with-two-factor-authentication) as an option:
 
@@ -177,7 +177,7 @@ machine api.github.com
 You can now create a client with those credentials:
 
 ```ruby
-client = Octokit::Client.new :netrc => true
+client = Octokit::Client.new(:netrc => true)
 client.login
 # => "defunkt"
 ```
@@ -482,6 +482,7 @@ implementations:
 * Ruby 1.9.2
 * Ruby 1.9.3
 * Ruby 2.0.0
+* Ruby 2.1.0
 
 If something doesn't work on one of these Ruby versions, it's a bug.
 
@@ -516,4 +517,24 @@ Constraint][pvc] with two digits of precision. For example:
 
 ## License
 
-{include:file:LICENSE.md}
+Copyright (c) 2009-2014 Wynn Netherland, Adam Stacoviak, Erik Michaels-Ober
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/lib/octokit/client.rb

@@ -11,6 +11,7 @@ require 'octokit/client/commits'
 require 'octokit/client/commit_comments'
 require 'octokit/client/contents'
 require 'octokit/client/downloads'
+require 'octokit/client/deployments'
 require 'octokit/client/emojis'
 require 'octokit/client/events'
 require 'octokit/client/feeds'
@@ -26,6 +27,7 @@ require 'octokit/client/milestones'
 require 'octokit/client/notifications'
 require 'octokit/client/objects'
 require 'octokit/client/organizations'
+require 'octokit/client/pages'
 require 'octokit/client/pub_sub_hubbub'
 require 'octokit/client/pull_requests'
 require 'octokit/client/rate_limit'
@@ -52,6 +54,7 @@ module Octokit
     include Octokit::Client::Commits
     include Octokit::Client::CommitComments
     include Octokit::Client::Contents
+    include Octokit::Client::Deployments
     include Octokit::Client::Downloads
     include Octokit::Client::Emojis
     include Octokit::Client::Events
@@ -68,6 +71,7 @@ module Octokit
     include Octokit::Client::Notifications
     include Octokit::Client::Objects
     include Octokit::Client::Organizations
+    include Octokit::Client::Pages
     include Octokit::Client::PubSubHubbub
     include Octokit::Client::PullRequests
     include Octokit::Client::RateLimit
@@ -82,7 +86,7 @@ module Octokit
     include Octokit::Client::Users
 
     # Header keys that can be passed in options hash to {#get},{#head}
-    CONVENIENCE_HEADERS = Set.new [:accept, :content_type]
+    CONVENIENCE_HEADERS = Set.new([:accept, :content_type])
 
     def initialize(options = {})
       # Use options passed in, but fall back to module defaults
@@ -183,7 +187,7 @@ module Octokit
     # @param block [Block] Block to perform the data concatination of the
     #   multiple requests. The block is called with two parameters, the first
     #   contains the contents of the requests so far and the second parameter
-    #   contains the latest response. 
+    #   contains the latest response.
     # @return [Sawyer::Resource]
     def paginate(url, options = {}, &block)
       opts = parse_query_and_convenience_headers(options.dup)
@@ -236,7 +240,7 @@ module Octokit
     #
     # @return [Sawyer::Response]
     def last_response
-      @last_response
+      @last_response if defined? @last_response
     end
 
     private
@@ -254,7 +258,7 @@ module Octokit
         options[:query].merge! application_authentication
       end
 
-      @last_response = response = agent.call(method, URI.encode(path.to_s), data, options)
+      @last_response = response = agent.call(method, URI::Parser.new.escape(path.to_s), data, options)
       response.data
     end
 

data/lib/octokit/client/authorizations.rb

@@ -3,7 +3,7 @@ module Octokit
 
     # Methods for the Authorizations API
     #
-    # @see http://developer.github.com/v3/oauth/#oauth-authorizations-api
+    # @see http://developer.github.com/v3/oauth_authorizations/#oauth-authorizations-api
     module Authorizations
 
       # List the authenticated user's authorizations
@@ -13,7 +13,7 @@ module Octokit
       # Basic Authentication.
       #
       # @return [Array<Sawyer::Resource>] A list of authorizations for the authenticated user
-      # @see http://developer.github.com/v3/oauth/#list-your-authorizations
+      # @see http://developer.github.com/v3/oauth_authorizations/#list-your-authorizations
       # @example List authorizations for user ctshryock
       #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
       #  client.authorizations
@@ -27,7 +27,7 @@ module Octokit
       # Basic Authentication.
       #
       # @return [Sawyer::Resource] A single authorization for the authenticated user
-      # @see http://developer.github.com/v3/oauth/#get-a-single-authorization
+      # @see http://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization
       # @example Show authorization for user ctshryock's Travis auth
       #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
       #  client.authorization(999999)
@@ -50,7 +50,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/#create-a-new-authorization
+      # @see http://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization
       # @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"})
@@ -84,7 +84,7 @@ module Octokit
       # @option options [String] :note_url A URL to remind you what app the OAuth token is for.
       #
       # @return [Sawyer::Resource] A single (updated) authorization for the authenticated user
-      # @see http://developer.github.com/v3/oauth/#update-a-new-authorization
+      # @see http://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization
       # @see http://developer.github.com/v3/oauth/#scopes for available scopes
       # @example Update the authorization for user ctshryock's project Zoidberg
       #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
@@ -101,7 +101,7 @@ module Octokit
       # @param number [Number] An existing Authorization ID
       #
       # @return [Boolean] Success
-      # @see http://developer.github.com/v3/oauth/#delete-an-authorization
+      # @see http://developer.github.com/v3/oauth_authorizations/#delete-an-authorization
       # @example Delete an authorization
       #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
       #  client.delete_authorization(999999)
@@ -138,13 +138,7 @@ module Octokit
     # @see http://developer.github.com/v3/oauth/#web-application-flow
     # @example
     #   @client.authorize_url('xxxx')
-    def authorize_url(*args)
-      arguments = Arguments.new(args)
-      options   = arguments.options
-      app_id = arguments.shift || client_id
-      if app_secret = arguments.shift
-        warn "client_secret is not required for this method"
-      end
+    def authorize_url(app_id = client_id, options = {})
       authorize_url = options.delete(:endpoint) || Octokit.web_endpoint
       authorize_url += "login/oauth/authorize?client_id=" + app_id
 

data/lib/octokit/client/commit_comments.rb

@@ -46,16 +46,16 @@ module Octokit
       # @return [Sawyer::Resource] Commit comment
       # @see http://developer.github.com/v3/repos/comments/#create-a-commit-comment
       # @example Create a commit comment
-      #   commit = Octokit.create_commit_comment("octocat/Hello-World", "827efc6d56897b048c772eb4087f854f46256132", "My comment message", "README.md", 10, 1)
-      #   commit.commit_id # => "827efc6d56897b048c772eb4087f854f46256132"
-      #   commit.body # => "My comment message"
-      #   commit.path # => "README.md"
-      #   commit.line # => 10
-      #   commit.position # => 1
+      #   comment = Octokit.create_commit_comment("octocat/Hello-World", "827efc6d56897b048c772eb4087f854f46256132", "My comment message", "README.md", 10, 1)
+      #   comment.commit_id # => "827efc6d56897b048c772eb4087f854f46256132"
+      #   comment.id # => 54321
+      #   comment.body # => "My comment message"
+      #   comment.path # => "README.md"
+      #   comment.line # => 10
+      #   comment.position # => 1
       def create_commit_comment(repo, sha, body, path=nil, line=nil, position=nil, options = {})
         params = {
           :body => body,
-          :commit_id => sha,
           :path => path,
           :line => line,
           :position => position
@@ -71,9 +71,9 @@ module Octokit
       # @return [Sawyer::Resource] Updated commit comment
       # @see http://developer.github.com/v3/repos/comments/#update-a-commit-comment
       # @example Update a commit comment
-      #   commit = Octokit.update_commit_comment("octocat/Hello-World", "860296", "Updated commit comment")
-      #   commit.id # => 860296
-      #   commit.body # => "Updated commit comment"
+      #   comment = Octokit.update_commit_comment("octocat/Hello-World", "860296", "Updated commit comment")
+      #   comment.id # => 860296
+      #   comment.body # => "Updated commit comment"
       def update_commit_comment(repo, id, body, options = {})
         params = {
           :body => body

data/lib/octokit/client/commits.rb

@@ -50,7 +50,6 @@ module Octokit
         arguments = Octokit::RepoArguments.new(args)
         date   = parse_date(arguments.shift)
         params = arguments.options
-        end_date = date + 1
         params.merge!(:since => iso8601(date))
         sha_or_branch = arguments.pop
         if sha_or_branch
@@ -77,7 +76,6 @@ module Octokit
         arguments = Octokit::RepoArguments.new(args)
         date   = parse_date(arguments.shift)
         params = arguments.options
-        end_date = date + 1
         params.merge!(:until => iso8601(date))
         sha_or_branch = arguments.pop
         if sha_or_branch
@@ -189,91 +187,6 @@ module Octokit
         post "repos/#{Repository.new(repo)}/git/commits", options.merge(params)
       end
 
-      # List all commit comments
-      #
-      # @param repo [String, Hash, Repository] A GitHub repository
-      # @return [Array] An array of hashes representing comments
-      # @see http://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository
-      def list_commit_comments(repo, options = {})
-        get "repos/#{Repository.new(repo)}/comments", options
-      end
-
-      # List comments for a single commit
-      #
-      # @param repo [String, Hash, Repository] A GitHub repository
-      # @param sha [String] The SHA of the commit whose comments will be fetched
-      # @return [Array] An array of hashes representing comments
-      # @see http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit
-      def commit_comments(repo, sha, options = {})
-        get "repos/#{Repository.new(repo)}/commits/#{sha}/comments", options
-      end
-
-      # Get a single commit comment
-      #
-      # @param repo [String, Hash, Repository] A GitHub repository
-      # @param id [String] The ID of the comment to fetch
-      # @return [Sawyer::Resource] A hash representing the comment
-      # @see http://developer.github.com/v3/repos/comments/#get-a-single-commit-comment
-      def commit_comment(repo, id, options = {})
-        get "repos/#{Repository.new(repo)}/comments/#{id}", options
-      end
-
-      # Create a commit comment
-      #
-      # @param repo [String, Hash, Repository] A GitHub repository
-      # @param sha [String] Sha of the commit to comment on
-      # @param body [String] Message
-      # @param path [String] Relative path of file to comment on
-      # @param line [Integer] Line number in the file to comment on
-      # @param position [Integer] Line index in the diff to comment on
-      # @return [Sawyer::Resource] A hash representing the new commit comment
-      # @see http://developer.github.com/v3/repos/comments/#create-a-commit-comment
-      # @example Create a commit comment
-      #   commit = Octokit.create_commit_comment("octocat/Hello-World", "827efc6d56897b048c772eb4087f854f46256132", "My comment message", "README.md", 10, 1)
-      #   commit.commit_id # => "827efc6d56897b048c772eb4087f854f46256132"
-      #   commit.body # => "My comment message"
-      #   commit.path # => "README.md"
-      #   commit.line # => 10
-      #   commit.position # => 1
-      def create_commit_comment(repo, sha, body, path=nil, line=nil, position=nil, options = {})
-        params = {
-          :body => body,
-          :commit_id => sha,
-          :path => path,
-          :line => line,
-          :position => position
-        }
-        post "repos/#{Repository.new(repo)}/commits/#{sha}/comments", options.merge(params)
-      end
-
-      # Update a commit comment
-      #
-      # @param repo [String, Hash, Repository] A GitHub repository
-      # @param id [String] The ID of the comment to update
-      # @param body [String] Message
-      # @return [Sawyer::Resource] A hash representing the updated commit comment
-      # @see http://developer.github.com/v3/repos/comments/#update-a-commit-comment
-      # @example Update a commit comment
-      #   commit = Octokit.update_commit_comment("octocat/Hello-World", "860296", "Updated commit comment")
-      #   commit.id # => 860296
-      #   commit.body # => "Updated commit comment"
-      def update_commit_comment(repo, id, body, options = {})
-        params = {
-          :body => body
-        }
-        patch "repos/#{Repository.new(repo)}/comments/#{id}", options.merge(params)
-      end
-
-      # Delete a commit comment
-      #
-      # @param repo [String, Hash, Repository] A GitHub repository
-      # @param id [String] The ID of the comment to delete
-      # @return [nil] nil
-      # @see http://developer.github.com/v3/repos/comments/#delete-a-commit-comment
-      def delete_commit_comment(repo, id, options = {})
-        boolean_from_response :delete, "repos/#{Repository.new(repo)}/comments/#{id}", options
-      end
-
       # Compare two commits
       #
       # @param repo [String, Hash, Repository] A GitHub repository

data/lib/octokit/client/contents.rb

@@ -17,7 +17,7 @@ module Octokit
       # @example Get the readme file for a repo
       #   Octokit.readme("octokit/octokit.rb")
       def readme(repo, options={})
-        get "repos/#{Repository.new repo}/readme", options
+        get "repos/#{Repository.new(repo)}/readme", options
       end
 
       # Receive a listing of a repository folder or the contents of a file
@@ -31,7 +31,7 @@ module Octokit
       #   Octokit.contents("octokit/octokit.rb", :path => 'lib/octokit.rb')
       def contents(repo, options={})
         repo_path = options.delete :path
-        url = "repos/#{Repository.new repo}/contents/#{repo_path}"
+        url = "repos/#{Repository.new(repo)}/contents/#{repo_path}"
         get url, options
       end
       alias :content :contents
@@ -62,7 +62,7 @@ module Octokit
         if content.nil? && file = options.delete(:file)
           case file
           when String
-            if File.exists?(file)
+            if File.exist?(file)
               file = File.open(file, "r")
               content = file.read
               file.close
@@ -72,12 +72,12 @@ module Octokit
             file.close
           end
         end
-        raise ArgumentError.new "content or :file option required" if content.nil?
+        raise ArgumentError.new("content or :file option required") if content.nil?
         options[:content] = Base64.respond_to?(:strict_encode64) ?
           Base64.strict_encode64(content) :
           Base64.encode64(content).delete("\n") # Ruby 1.9.2
         options[:message] = message
-        url = "repos/#{Repository.new repo}/contents/#{path}"
+        url = "repos/#{Repository.new(repo)}/contents/#{path}"
         put url, options
       end
       alias :create_content :create_contents
@@ -133,7 +133,7 @@ module Octokit
       def delete_contents(repo, path, message, sha, options = {})
         options[:message] = message
         options[:sha] = sha
-        url = "repos/#{Repository.new repo}/contents/#{path}"
+        url = "repos/#{Repository.new(repo)}/contents/#{path}"
         delete url, options
       end
       alias :delete_content :delete_contents
@@ -152,7 +152,7 @@ module Octokit
       def archive_link(repo, options={})
         repo_ref = options.delete :ref
         format = (options.delete :format) || 'tarball'
-        url = "repos/#{Repository.new repo}/#{format}/#{repo_ref}"
+        url = "repos/#{Repository.new(repo)}/#{format}/#{repo_ref}"
         request :head, url, options
 
         last_response.headers['Location']

data/lib/octokit/client/deployments.rb

@@ -0,0 +1,83 @@
+module Octokit
+  class Client
+
+    # Methods for the Deployments API
+    #
+    # @see http://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 [String, Repository, Hash] A GitHub repository
+      # @return [Array<Sawyer::Resource>] A list of deployments
+      # @see http://developer.github.com/v3/repos/deployments/#list-deployments
+      def deployments(repo, options = {})
+        options = ensure_deployments_api_media_type(options)
+        get("repos/#{Repository.new(repo)}/deployments", options)
+      end
+      alias :list_deployments :deployments
+
+      # Create a deployment for a ref
+      #
+      # @param repo [String, Repository, Hash] A GitHub repository
+      # @param ref [String] The ref 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 [String] :description Optional short description.
+      # @return [Sawyer::Resource] A deployment
+      # @see http://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("repos/#{Repository.new(repo)}/deployments", options)
+      end
+
+      # List all statuses for a Deployment
+      #
+      # @param deployment_url [String] A URL for a deployment resource
+      # @return [Array<Sawyer::Resource>] A list of deployment statuses
+      # @see http://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
+      alias :list_deployment_statuses :deployment_statuses
+
+      # Create a deployment status for a Deployment
+      #
+      # @param deployment_url [String] A URL for a deployment resource
+      # @param state [String] The state: pending, success, failure, error
+      # @return [Sawyer::Resource] A deployment status
+      # @see http://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
+        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