octokit 3.8.0 → 4.0.0

data/lib/octokit/middleware/follow_redirects.rb

@@ -0,0 +1,131 @@
+require 'faraday'
+require 'set'
+
+# Adapted from lostisland/faraday_middleware. Trimmed down to just the logic
+# that we need for octokit.rb.
+#
+# https://github.com/lostisland/faraday_middleware/blob/138766e/lib/faraday_middleware/response/follow_redirects.rb
+
+module Octokit
+
+  module Middleware
+
+    # Public: Exception thrown when the maximum amount of requests is exceeded.
+    class RedirectLimitReached < Faraday::Error::ClientError
+      attr_reader :response
+
+      def initialize(response)
+        super "too many redirects; last one to: #{response['location']}"
+        @response = response
+      end
+    end
+
+    # Public: Follow HTTP 301, 302, 303, and 307 redirects.
+    #
+    # For HTTP 303, the original GET, POST, PUT, DELETE, or PATCH request gets
+    # converted into a GET. For HTTP 301, 302, and 307, the HTTP method remains
+    # unchanged.
+    #
+    # This middleware currently only works with synchronous requests; i.e. it
+    # doesn't support parallelism.
+    class FollowRedirects < Faraday::Middleware
+      # HTTP methods for which 30x redirects can be followed
+      ALLOWED_METHODS = Set.new [:head, :options, :get, :post, :put, :patch, :delete]
+
+      # HTTP redirect status codes that this middleware implements
+      REDIRECT_CODES  = Set.new [301, 302, 303, 307]
+
+      # Keys in env hash which will get cleared between requests
+      ENV_TO_CLEAR    = Set.new [:status, :response, :response_headers]
+
+      # Default value for max redirects followed
+      FOLLOW_LIMIT = 3
+
+      # Regex that matches characters that need to be escaped in URLs, sans
+      # the "%" character which we assume already represents an escaped
+      # sequence.
+      URI_UNSAFE = /[^\-_.!~*'()a-zA-Z\d;\/?:@&=+$,\[\]%]/
+
+      # Public: Initialize the middleware.
+      #
+      # options - An options Hash (default: {}):
+      #           :limit               - A Fixnum redirect limit (default: 3).
+      def initialize(app, options = {})
+        super(app)
+        @options = options
+
+        @convert_to_get = Set.new [303]
+      end
+
+      def call(env)
+        perform_with_redirection(env, follow_limit)
+      end
+
+      private
+
+      def convert_to_get?(response)
+        ![:head, :options].include?(response.env[:method]) &&
+          @convert_to_get.include?(response.status)
+      end
+
+      def perform_with_redirection(env, follows)
+        request_body = env[:body]
+        response = @app.call(env)
+
+        response.on_complete do |response_env|
+          if follow_redirect?(response_env, response)
+            raise(RedirectLimitReached, response) if follows.zero?
+            new_request_env = update_env(response_env, request_body, response)
+            response = perform_with_redirection(new_request_env, follows - 1)
+          end
+        end
+        response
+      end
+
+      def update_env(env, request_body, response)
+        original_url = env[:url]
+        env[:url] += safe_escape(response["location"])
+        unless same_host?(original_url, env[:url])
+          env[:request_headers].delete("Authorization")
+        end
+
+        if convert_to_get?(response)
+          env[:method] = :get
+          env[:body] = nil
+        else
+          env[:body] = request_body
+        end
+
+        ENV_TO_CLEAR.each { |key| env.delete(key) }
+
+        env
+      end
+
+      def follow_redirect?(env, response)
+        ALLOWED_METHODS.include?(env[:method]) &&
+          REDIRECT_CODES.include?(response.status)
+      end
+
+      def follow_limit
+        @options.fetch(:limit, FOLLOW_LIMIT)
+      end
+
+      def same_host?(original_url, redirect_url)
+        original_uri = Addressable::URI.parse(original_url)
+        redirect_uri = Addressable::URI.parse(redirect_url)
+
+        redirect_uri.host.nil? || original_uri.host == redirect_uri.host
+      end
+
+      # Internal: Escapes unsafe characters from a URL which might be a path
+      # component only or a fully-qualified URI so that it can be joined onto a
+      # URI:HTTP using the `+` operator. Doesn't escape "%" characters so to not
+      # risk double-escaping.
+      def safe_escape(uri)
+        uri.to_s.gsub(URI_UNSAFE) { |match|
+          "%" + match.unpack("H2" * match.bytesize).join("%").upcase
+        }
+      end
+    end
+  end
+end

data/lib/octokit/repository.rb

@@ -27,6 +27,8 @@ module Octokit
       when Hash
         @name = repo[:repo] ||= repo[:name]
         @owner = repo[:owner] ||= repo[:user] ||= repo[:username]
+      else
+        raise ArgumentError, "Invalid Repository. Use user/repo format."
       end
     end
 

data/lib/octokit/version.rb

@@ -1,11 +1,11 @@
 module Octokit
   # Current major release.
   # @return [Integer]
-  MAJOR = 3
+  MAJOR = 4
 
   # Current minor release.
   # @return [Integer]
-  MINOR = 8
+  MINOR = 0
 
   # Current patch level.
   # @return [Integer]

data/lib/octokit/warnable.rb

@@ -0,0 +1,17 @@
+module Octokit
+
+  # Allows warnings to be suppressed via environment variable.
+  module Warnable
+
+    # 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
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 3.8.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-19 00:00:00.000000000 Z
+date: 2015-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -63,7 +63,6 @@ files:
 - lib/octokit.rb
 - lib/octokit/arguments.rb
 - lib/octokit/authentication.rb
-- lib/octokit/backports/uri.rb
 - lib/octokit/client.rb
 - lib/octokit/client/authorizations.rb
 - lib/octokit/client/commit_comments.rb
@@ -80,6 +79,7 @@ files:
 - lib/octokit/client/issues.rb
 - lib/octokit/client/labels.rb
 - lib/octokit/client/legacy_search.rb
+- lib/octokit/client/licenses.rb
 - lib/octokit/client/markdown.rb
 - lib/octokit/client/meta.rb
 - lib/octokit/client/milestones.rb
@@ -100,9 +100,18 @@ files:
 - lib/octokit/client/statuses.rb
 - lib/octokit/client/users.rb
 - lib/octokit/configurable.rb
+- lib/octokit/connection.rb
 - lib/octokit/default.rb
+- lib/octokit/enterprise_admin_client.rb
+- lib/octokit/enterprise_admin_client/admin_stats.rb
+- lib/octokit/enterprise_admin_client/license.rb
+- lib/octokit/enterprise_admin_client/search_indexing.rb
+- lib/octokit/enterprise_admin_client/users.rb
+- lib/octokit/enterprise_management_console_client.rb
+- lib/octokit/enterprise_management_console_client/management_console.rb
 - lib/octokit/error.rb
 - lib/octokit/gist.rb
+- lib/octokit/middleware/follow_redirects.rb
 - lib/octokit/organization.rb
 - lib/octokit/rate_limit.rb
 - lib/octokit/repo_arguments.rb
@@ -111,6 +120,7 @@ files:
 - lib/octokit/response/raise_error.rb
 - lib/octokit/user.rb
 - lib/octokit/version.rb
+- lib/octokit/warnable.rb
 - octokit.gemspec
 homepage: https://github.com/octokit/octokit.rb
 licenses:
@@ -132,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.5
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Ruby toolkit for working with the GitHub API

data/lib/octokit/backports/uri.rb

@@ -1,56 +0,0 @@
-# :stopdoc:
-
-# Stolen from ruby core's uri/common.rb, with modifications to support 1.8.x
-#
-# https://github.com/ruby/ruby/blob/trunk/lib/uri/common.rb
-#
-#
-
-module URI
-  TBLENCWWWCOMP_ = {} # :nodoc:
-  256.times do |i|
-    TBLENCWWWCOMP_[i.chr] = '%%%02X' % i
-  end
-  TBLENCWWWCOMP_[' '] = '+'
-  TBLENCWWWCOMP_.freeze
-  TBLDECWWWCOMP_ = {} # :nodoc:
-  256.times do |i|
-    h, l = i>>4, i&15
-    TBLDECWWWCOMP_['%%%X%X' % [h, l]] = i.chr
-    TBLDECWWWCOMP_['%%%x%X' % [h, l]] = i.chr
-    TBLDECWWWCOMP_['%%%X%x' % [h, l]] = i.chr
-    TBLDECWWWCOMP_['%%%x%x' % [h, l]] = i.chr
-  end
-  TBLDECWWWCOMP_['+'] = ' '
-  TBLDECWWWCOMP_.freeze
-
-  # Encode given +s+ to URL-encoded form data.
-  #
-  # This method doesn't convert *, -, ., 0-9, A-Z, _, a-z, but does convert SP
-  # (ASCII space) to + and converts others to %XX.
-  #
-  # This is an implementation of
-  # http://www.w3.org/TR/html5/forms.html#url-encoded-form-data
-  #
-  # See URI.decode_www_form_component, URI.encode_www_form
-  def self.encode_www_form_component(s)
-    str = s.to_s
-    if RUBY_VERSION < "1.9" && $KCODE =~ /u/i
-      str.gsub(/([^ a-zA-Z0-9_.-]+)/) do
-        '%' + $1.unpack('H2' * Rack::Utils.bytesize($1)).join('%').upcase
-      end.tr(' ', '+')
-    else
-      str.gsub(/[^*\-.0-9A-Z_a-z]/) {|m| TBLENCWWWCOMP_[m]}
-    end
-  end
-
-  # Decode given +str+ of URL-encoded form data.
-  #
-  # This decodes + to SP.
-  #
-  # See URI.encode_www_form_component, URI.decode_www_form
-  def self.decode_www_form_component(str, enc=nil)
-    raise ArgumentError, "invalid %-encoding (#{str})" unless /\A(?:%[0-9a-fA-F]{2}|[^%])*\z/ =~ str
-    str.gsub(/\+|%[0-9a-fA-F]{2}/) {|m| TBLDECWWWCOMP_[m]}
-  end
-end