octokit 1.18.0 → 1.19.0

data/lib/octokit/client/say.rb

@@ -0,0 +1,14 @@
+module Octokit
+  class Client
+    module Say
+
+      def say(text=nil)
+        options = {}
+        options[:s] = text if text
+        get "/octocat", options
+      end
+      alias :octocat :say
+
+    end
+  end
+end

data/lib/octokit/client/statuses.rb

@@ -9,7 +9,7 @@ module Octokit
       # @return [Array] A list of statuses
       # @see http://developer.github.com/v3/repos/status
       def statuses(repo, sha, options={})
-        get("repos/#{Repository.new(repo)}/statuses/#{sha}", options, 3)
+        get("repos/#{Repository.new(repo)}/statuses/#{sha}", options)
       end
       alias :list_statuses :statuses
 
@@ -22,7 +22,7 @@ module Octokit
       # @see http://developer.github.com/v3/repos/status
       def create_status(repo, sha, state, options={})
         options.merge!(:state => state)
-        post("repos/#{Repository.new(repo)}/statuses/#{sha}", options, 3)
+        post("repos/#{Repository.new(repo)}/statuses/#{sha}", options)
       end
     end
   end

data/lib/octokit/client/users.rb

@@ -1,9 +1,5 @@
 module Octokit
   class Client
-    #@todo Add support for getting a single public key by id.
-    #  http://developer.github.com/v3/users/keys/#get-a-single-public-key
-    #@todo Add support for updating a public key.
-    #  http://developer.github.com/v3/users/keys/#update-a-public-key
     module Users
 
       # Search for user.
@@ -14,7 +10,7 @@ module Octokit
       # @example
       #   Octokit.search_users('pengwynn')
       def search_users(search, options={})
-        get("legacy/user/search/#{search}", options, 3)['users']
+        get("legacy/user/search/#{search}", options)['users']
       end
 
       # Get a single user
@@ -26,9 +22,23 @@ module Octokit
       #   Octokit.user("sferik")
       def user(user=nil)
         if user
-          get("users/#{user}", {}, 3)
+          get "users/#{user}", {}
         else
-          get("user", {}, 3)
+          get "user", {}
+        end
+      end
+
+      # Validate user username and password
+      #
+      # @param options [Hash] User credentials
+      # @option options [String] :login GitHub login
+      # @option options [String] :password GitHub password
+      # @return [Boolean] True if credentials are valid
+      def validate_credentials(options = {})
+        begin
+          !self.class.new(options).user.nil?
+        rescue Octokit::Unauthorized
+          false
         end
       end
 
@@ -46,7 +56,7 @@ module Octokit
       # @example
       #   Octokit.user(:name => "Erik Michaels-Ober", :email => "sferik@gmail.com", :company => "Code for America", :location => "San Francisco", :hireable => false)
       def update_user(options)
-        patch("user", options, 3)
+        patch("user", options)
       end
 
       # Get a user's followers.
@@ -57,7 +67,7 @@ module Octokit
       # @example
       #   Octokit.followers('pengwynn')
       def followers(user=login, options={})
-        get("users/#{user}/followers", options, 3)
+        get("users/#{user}/followers", options)
       end
 
       # Get list of users a user is following.
@@ -68,13 +78,13 @@ module Octokit
       # @example
       #   Octokit.following('pengwynn')
       def following(user=login, options={})
-        get("users/#{user}/following", options, 3)
+        get("users/#{user}/following", options)
       end
 
       # Check if you are following a user.
       #
       # Requries an authenticated client.
-      # 
+      #
       # @param user [String] Username of the user that you want to check if you are following.
       # @return [Boolean] True if you are following the user, false otherwise.
       # @see Octokit::Client
@@ -86,7 +96,7 @@ module Octokit
         user = args.first
         user ||= login
         return if user.nil?
-        get("user/following/#{target}", {}, 3, true, raw=true).status == 204
+        request(:get, "user/following/#{target}").status == 204
       rescue Octokit::NotFound
         false
       end
@@ -102,7 +112,7 @@ module Octokit
       # @example
       #   @client.follow('holman')
       def follow(user, options={})
-        put("user/following/#{user}", options, 3, true, raw=true).status == 204
+        request(:put, "user/following/#{user}", options).status == 204
       end
 
       # Unfollow a user.
@@ -116,7 +126,7 @@ module Octokit
       # @example
       #   @client.unfollow('holman')
       def unfollow(user, options={})
-        delete("user/following/#{user}", options, 3, true, raw=true).status == 204
+        request(:delete, "user/following/#{user}", options).status == 204
       end
 
       # Get list of repos starred by a user.
@@ -127,7 +137,7 @@ module Octokit
       # @example
       #   Octokit.starred('pengwynn')
       def starred(user=login, options={})
-        get("users/#{user}/starred", options, 3)
+        get("users/#{user}/starred", options)
       end
 
       # Check if you are starring a repo.
@@ -142,13 +152,13 @@ module Octokit
       # @example
       #   @client.starred?('pengwynn', 'octokit')
       def starred?(user, repo, options={})
-        get("user/starred/#{user}/#{repo}", options, 3, true, raw=true).status == 204
+        request(:get, "user/starred/#{user}/#{repo}", options).status == 204
       rescue Octokit::NotFound
         false
       end
 
       # Get list of repos watched by a user.
-      # 
+      #
       # Legacy, using github.beta media type. Use `Users#starred` instead.
       #
       # @param user [String] Username of the user to get the list of repositories they are watching.
@@ -158,7 +168,34 @@ module Octokit
       # @example
       #   Octokit.watched('pengwynn')
       def watched(user=login, options={})
-        get("users/#{user}/watched", options, 3)
+        get("users/#{user}/watched", options)
+      end
+
+      # Get a public key.
+      #
+      # Note, when using dot notation to retrieve the values, ruby will return
+      # the hash key for the public keys value instead of the actual value, use
+      # symbol or key string to retrieve the value. See example.
+      #
+      # Requires authenticated client.
+      #
+      # @param key_id [Integer] Key to retreive.
+      # @param [Hashie::Mash] Hash representing the key.
+      # @see http://developer.github.com/v3/users/keys/#get-a-single-public-key
+      # @example
+      #   @client.key(1)
+      # @example Retrieve public key contents
+      #   public_key = @client.key(1)
+      #   public_key.key
+      #   # => Error
+      #
+      #   public_key[:key]
+      #   # => "ssh-rsa AAA..."
+      #
+      #   public_key['key']
+      #   # => "ssh-rsa AAA..."
+      def key(key_id, options={})
+        get("user/keys/#{key_id}", options)
       end
 
       # Get list of public keys for user.
@@ -171,7 +208,7 @@ module Octokit
       # @example
       #   @client.keys
       def keys(options={})
-        get("user/keys", options, 3)
+        get("user/keys", options)
       end
 
       # Add public key to user account.
@@ -186,7 +223,23 @@ module Octokit
       # @example
       #   @client.add_key('Personal projects key', 'ssh-rsa AAA...')
       def add_key(title, key, options={})
-        post("user/keys", options.merge({:title => title, :key => key}), 3)
+        post("user/keys", options.merge({:title => title, :key => key}))
+      end
+
+      # Update a public key
+      #
+      # Requires authenticated client
+      #
+      # @param key_id [Integer] Id of key to update.
+      # @param options [Hash] Hash containing attributes to update.
+      # @option options [String] :title
+      # @option options [String] :key
+      # @return [Hashie::Mash] Hash representing the updated public key.
+      # @see http://developer.github.com/v3/users/keys/#update-a-public-key
+      # @example
+      #   @client.update_key(1, :title => 'new title', :key => "ssh-rsa BBB")
+      def update_key(key_id, options={})
+        patch("/user/keys/#{key_id}", options)
       end
 
       # Remove a public key from user account.
@@ -200,7 +253,7 @@ module Octokit
       # @example
       #   @client.remove_key(1)
       def remove_key(id, options={})
-        delete("user/keys/#{id}", options, 3, true, raw=true).status == 204
+        request(:delete, "user/keys/#{id}", options).status == 204
       end
 
       # List email addresses for a user.
@@ -213,7 +266,7 @@ module Octokit
       # @example
       #   @client.emails
       def emails(options={})
-        get("user/emails", options, 3)
+        get("user/emails", options)
       end
 
       # Add email address to user.
@@ -227,7 +280,7 @@ module Octokit
       # @example
       #   @client.add_email('new_email@user.com')
       def add_email(email, options={})
-        post("user/emails", options.merge({:email => email}), 3)
+        post("user/emails", options.merge({:email => email}))
       end
 
       # Remove email from user.
@@ -241,8 +294,23 @@ module Octokit
       # @example
       #   @client.remove_email('old_email@user.com')
       def remove_email(email, options={})
-        delete("user/emails", options.merge({:email => email}), 3, true, raw=true).status == 204
+        request(:delete, "user/emails", options.merge({:email => email})).status == 204
+      end
+
+      # List repositories being watched by a user.
+      #
+      # @param user [String] User's GitHub username.
+      #
+      # @return [Array<Hashie::Mashie>] Array of repositories.
+      #
+      # @see http://developer.github.com/v3/activity/watching/#list-repositories-being-watched
+      #
+      # @example
+      #   @client.subscriptions("pengwynn")
+      def subscriptions(user=login, options={})
+        get("users/#{user}/subscriptions", options)
       end
+
     end
   end
 end

data/lib/octokit/connection.rb

@@ -6,43 +6,43 @@ module Octokit
   module Connection
     private
 
-    def connection(authenticate=true, raw=false, version=3, force_urlencoded=false)
-      case version
-      when 3
-        url = Octokit.api_endpoint
-      end
-
+    def connection(options={})
       options = {
+        :authenticate => true,
+        :force_urlencoded => false,
+        :raw => false,
         :ssl => { :verify => false },
-        :url => url,
-      }
+        :url => Octokit.api_endpoint
+      }.merge(options)
 
-      options[:proxy] = proxy unless proxy.nil?
+      if !proxy.nil?
+        options.merge!(:proxy => proxy)
+      end
 
-      options.merge!(:params => {:access_token => oauth_token}) if oauthed? && !authenticated?
-      options.merge!(:params => unauthed_rate_limit_params) if !oauthed? && !authenticated? && unauthed_rate_limited?
+      if !oauthed? && !authenticated? && unauthed_rate_limited?
+        options.merge!(:params => unauthed_rate_limit_params)
+      end
 
       # TODO: Don't build on every request
       connection = Faraday.new(options) do |builder|
-        if version >= 3 && !force_urlencoded
-          builder.request :json
-        else
-          builder.request :url_encoded
-        end
+
+        builder.request :json
 
         builder.use Faraday::Response::RaiseOctokitError
+        builder.use FaradayMiddleware::FollowRedirects
+        builder.use FaradayMiddleware::Mashify
 
-        unless raw
-          builder.use FaradayMiddleware::Mashify
-          builder.use FaradayMiddleware::ParseJson
-        end
+        builder.use FaradayMiddleware::ParseJson, :content_type => /\bjson$/
 
         faraday_config_block.call(builder) if faraday_config_block
 
         builder.adapter *adapter
       end
 
-      connection.basic_auth authentication[:login], authentication[:password] if authenticate and authenticated?
+      if options[:authenticate] and authenticated?
+        connection.basic_auth authentication[:login], authentication[:password]
+      end
+
       connection
     end
   end

data/lib/octokit/request.rb

@@ -2,69 +2,79 @@ require 'multi_json'
 
 module Octokit
   module Request
-    def delete(path, options={}, version=api_version, authenticate=true, raw=false, force_urlencoded=false)
-      request(:delete, path, options, version, authenticate, raw, force_urlencoded)
-    end
 
-    def get(path, options={}, version=api_version, authenticate=true, raw=false, force_urlencoded=false)
-      request(:get, path, options, version, authenticate, raw, force_urlencoded)
+    def delete(path, options={})
+      request(:delete, path, options).body
     end
 
-    def patch(path, options={}, version=api_version, authenticate=true, raw=false, force_urlencoded=false)
-      request(:patch, path, options, version, authenticate, raw, force_urlencoded)
-    end
+    def get(path, options={})
+      response = request(:get, path, options)
+      body = response.body
+
+      if auto_traversal && body.is_a?(Array)
+        while next_url = links(response)["next"]
+          response = request(:get, next_url, options)
+          body += response.body
+        end
+      end
 
-    def post(path, options={}, version=api_version, authenticate=true, raw=false, force_urlencoded=false)
-      request(:post, path, options, version, authenticate, raw, force_urlencoded)
+      body
     end
 
-    def put(path, options={}, version=api_version, authenticate=true, raw=false, force_urlencoded=false)
-      request(:put, path, options, version, authenticate, raw, force_urlencoded)
+    def patch(path, options={})
+      request(:patch, path, options).body
     end
 
-    def ratelimit
-      headers = get("rate_limit",{}, api_version, true, true).headers
-      return headers["X-RateLimit-Limit"].to_i
+    def post(path, options={})
+      request(:post, path, options).body
     end
-    alias rate_limit ratelimit
 
-    def ratelimit_remaining
-      headers = get("rate_limit",{}, api_version, true, true).headers
-      return headers["X-RateLimit-Remaining"].to_i
+    def put(path, options={})
+      request(:put, path, options).body
     end
-    alias rate_limit_remaining ratelimit_remaining
 
     private
 
-    def request(method, path, options, version, authenticate, raw, force_urlencoded)
+    def request(method, path, options={})
       path.sub(%r{^/}, '') #leading slash in path fails in github:enterprise
-      response = connection(authenticate, raw, version, force_urlencoded).send(method) do |request|
+
+      token = options.delete(:access_token) ||
+              options.delete(:oauth_token)  ||
+              oauth_token
+
+      conn_options = {
+        :authenticate => token.nil?
+      }
+
+      response = connection(conn_options).send(method) do |request|
+
+        request.headers['Accept'] =  options.delete(:accept) || 'application/vnd.github.beta+json'
+
+        if token
+          request.headers[:authorization] = "token #{token}"
+        end
+
         case method
-        when :delete, :get
+        when :get
           if auto_traversal && per_page.nil?
             self.per_page = 100
           end
           options.merge!(:per_page => per_page) if per_page
           request.url(path, options)
+        when :delete, :head
+          request.url(path, options)
         when :patch, :post, :put
           request.path = path
-          if 3 == version && !force_urlencoded
-            request.body = MultiJson.dump(options) unless options.empty?
-          else
-            request.body = options unless options.empty?
-          end
+          request.body = MultiJson.dump(options) unless options.empty?
         end
 
-        request.headers['Host'] = Octokit.request_host if Octokit.request_host
-      end
+        if Octokit.request_host
+          request.headers['Host'] = Octokit.request_host
+        end
 
-      if raw
-        response
-      elsif auto_traversal && ( next_url = links(response)["next"] )
-        response.body + request(method, next_url, options, version, authenticate, raw, force_urlencoded)
-      else
-        response.body
       end
+
+      response
     end
 
     def links(response)
@@ -75,5 +85,6 @@ module Octokit
 
       Hash[ *links.flatten ]
     end
+
   end
 end