octodoggy 4.6.2

data/lib/octokit/gist.rb

@@ -0,0 +1,36 @@
+module Octokit
+
+  # Class to parse and create Gist URLs
+  class Gist
+
+    # !@attribute id
+    #   @return [String] Gist ID
+    attr_accessor :id
+
+    # Instantiate {Gist} object from Gist URL
+    # @ return [Gist]
+    def self.from_url(url)
+      Gist.new(URI.parse(url).path[1..-1])
+    end
+
+    def initialize(gist)
+      case gist
+      when Integer, String
+        @id = gist.to_s
+      end
+    end
+
+    # Gist ID
+    # @return [String]
+    def to_s
+      @id
+    end
+
+    # Gist URL
+    # @return [String]
+    def url
+      "https://gist.github.com/#{@id}"
+    end
+
+  end
+end

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 Integer 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/organization.rb

@@ -0,0 +1,17 @@
+module Octokit
+  # GitHub organization class to generate API path urls
+  class Organization
+    # Get the api path for an organization
+    #
+    # @param org [String, Integer] GitHub organization login or id
+    # @return [String] Organization Api path
+    def self.path org
+      case org
+      when String
+        "orgs/#{org}"
+      when Integer
+        "organizations/#{org}"
+      end
+    end
+  end
+end

data/lib/octokit/preview.rb

@@ -0,0 +1,38 @@
+module Octokit
+
+  # Default setup options for preview features
+  module Preview
+
+    PREVIEW_TYPES = {
+      :branch_protection      => 'application/vnd.github.loki-preview+json'.freeze,
+      :migrations             => 'application/vnd.github.wyandotte-preview+json'.freeze,
+      :licenses               => 'application/vnd.github.drax-preview+json'.freeze,
+      :source_imports         => 'application/vnd.github.barred-rock-preview'.freeze,
+      :reactions              => 'application/vnd.github.squirrel-girl-preview'.freeze,
+      :repository_invitations => 'application/vnd.github.swamp-thing-preview+json'.freeze,
+      :issue_timelines        => 'application/vnd.github.mockingbird-preview+json'.freeze,
+      :pages                  => 'application/vnd.github.mister-fantastic-preview+json'.freeze,
+      :projects               => 'application/vnd.github.inertia-preview+json'.freeze,
+      :traffic                => 'application/vnd.github.spiderman-preview'.freeze,
+      :org_membership         => 'application/vnd.github.korra-preview'.freeze,
+      :reviews                => 'application/vnd.github.black-cat-preview'.freeze,
+      :integrations           => 'application/vnd.github.machine-man-preview+json'.freeze
+    }
+
+    def ensure_api_media_type(type, options)
+      if options[:accept].nil?
+        options[:accept] = PREVIEW_TYPES[type]
+        warn_preview(type)
+      end
+      options
+    end
+
+    def warn_preview(type)
+      octokit_warn <<-EOS
+WARNING: The preview version of the #{type.to_s.capitalize} API is not yet suitable for production use.
+You can avoid this message by supplying an appropriate media type in the 'Accept' request
+header.
+EOS
+    end
+  end
+end

data/lib/octokit/rate_limit.rb

@@ -0,0 +1,33 @@
+module Octokit
+
+  # Class for API Rate Limit info
+  #
+  # @!attribute [w] limit
+  #   @return [Integer] Max tries per rate limit period
+  # @!attribute [w] remaining
+  #   @return [Integer] Remaining tries per rate limit period
+  # @!attribute [w] resets_at
+  #   @return [Time] Indicates when rate limit resets
+  # @!attribute [w] resets_in
+  #   @return [Integer] Number of seconds when rate limit resets
+  #
+  # @see https://developer.github.com/v3/#rate-limiting
+  class RateLimit < Struct.new(:limit, :remaining, :resets_at, :resets_in)
+
+    # Get rate limit info from HTTP response
+    #
+    # @param response [#headers] HTTP response
+    # @return [RateLimit]
+    def self.from_response(response)
+      info = new
+      if response && !response.headers.nil?
+        info.limit = (response.headers['X-RateLimit-Limit'] || 1).to_i
+        info.remaining = (response.headers['X-RateLimit-Remaining'] || 1).to_i
+        info.resets_at = Time.at((response.headers['X-RateLimit-Reset'] || Time.now).to_i)
+        info.resets_in = [(info.resets_at - Time.now).to_i, 0].max
+      end
+
+      info
+    end
+  end
+end

data/lib/octokit/repo_arguments.rb

@@ -0,0 +1,19 @@
+module Octokit
+
+  # Class to extract options from Ruby arguments for
+  # Repository-related methods
+  class RepoArguments < Arguments
+
+    # !@attribute [r] repo
+    #   @return [Repository]
+    attr_reader :repo
+
+    def initialize(args)
+      arguments = super(args)
+      @repo = arguments.shift
+
+      arguments
+    end
+
+  end
+end

data/lib/octokit/repository.rb

@@ -0,0 +1,93 @@
+module Octokit
+
+  # Class to parse GitHub repository owner and name from
+  # URLs and to generate URLs
+  class Repository
+    attr_accessor :owner, :name, :id
+    NAME_WITH_OWNER_PATTERN = /\A[\w.-]+\/[\w.-]+\z/i
+
+    # Instantiate from a GitHub repository URL
+    #
+    # @return [Repository]
+    def self.from_url(url)
+      new URI.parse(url).path[1..-1].
+        gsub(/^repos\//,'').
+        split('/', 3)[0..1].
+        join('/')
+    end
+
+    # @raise [Octokit::InvalidRepository] if the repository
+    #   has an invalid format
+    def initialize(repo)
+      case repo
+      when Integer
+        @id = repo
+      when NAME_WITH_OWNER_PATTERN
+        @owner, @name = repo.split("/")
+      when Repository
+        @owner = repo.owner
+        @name = repo.name
+      when Hash
+        @name = repo[:repo] ||= repo[:name]
+        @owner = repo[:owner] ||= repo[:user] ||= repo[:username]
+      else
+        raise_invalid_repository!
+      end
+      if @owner && @name
+        validate_owner_and_name!
+      end
+    end
+
+    # Repository owner/name
+    # @return [String]
+    def slug
+      "#{@owner}/#{@name}"
+    end
+    alias :to_s :slug
+
+    # @return [String] Repository API path
+    def path
+      return named_api_path if @owner && @name
+      return id_api_path if @id
+    end
+
+    # Get the api path for a repo
+    # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+    # @return [String] Api path.
+    def self.path repo
+      new(repo).path
+    end
+
+    # @return [String] Api path for owner/name identified repos
+    def named_api_path
+      "repos/#{slug}"
+    end
+
+    # @return [String] Api path for id identified repos
+    def id_api_path
+      "repositories/#{@id}"
+    end
+
+    # Repository URL based on {Octokit::Client#web_endpoint}
+    # @return [String]
+    def url
+      "#{Octokit.web_endpoint}#{slug}"
+    end
+
+    alias :user :owner
+    alias :username :owner
+    alias :repo :name
+
+    private
+
+      def validate_owner_and_name!
+        if @owner.include?('/') || @name.include?('/') || !url.match(URI::ABS_URI)
+          raise_invalid_repository!
+        end
+      end
+
+      def raise_invalid_repository!
+        raise Octokit::InvalidRepository, "Invalid Repository. Use user/repo format."
+      end
+  end
+end

data/lib/octokit/response/feed_parser.rb

@@ -0,0 +1,21 @@
+require 'faraday'
+
+module Octokit
+
+  module Response
+
+    # Parses RSS and Atom feed responses.
+    class FeedParser < Faraday::Response::Middleware
+
+      private
+
+      def on_complete(env)
+        if env[:response_headers]["content-type"] =~ /(\batom|\brss)/
+          require 'rss'
+          env[:body] = RSS::Parser.parse env[:body]
+        end
+      end
+
+    end
+  end
+end

data/lib/octokit/response/raise_error.rb

@@ -0,0 +1,21 @@
+require 'faraday'
+require 'octokit/error'
+
+module Octokit
+  # Faraday response middleware
+  module Response
+
+    # This class raises an Octokit-flavored exception based
+    # HTTP status codes returned by the API
+    class RaiseError < Faraday::Response::Middleware
+
+      private
+
+      def on_complete(response)
+        if error = Octokit::Error.from_response(response)
+          raise error
+        end
+      end
+    end
+  end
+end

data/lib/octokit/user.rb

@@ -0,0 +1,19 @@
+module Octokit
+  # GitHub user class to generate API path urls
+  class User
+    # Get the api path for a user
+    #
+    # @param user [String, Integer] GitHub user login or id
+    # @return [String] User Api path
+    def self.path user
+      case user
+      when String
+        "users/#{user}"
+      when Integer
+        "user/#{user}"
+      else
+        "user"
+      end
+    end
+  end
+end

data/lib/octokit/version.rb

@@ -0,0 +1,17 @@
+module Octokit
+  # Current major release.
+  # @return [Integer]
+  MAJOR = 4
+
+  # Current minor release.
+  # @return [Integer]
+  MINOR = 6
+
+  # Current patch level.
+  # @return [Integer]
+  PATCH = 2
+
+  # Full release version.
+  # @return [String]
+  VERSION = [MAJOR, MINOR, PATCH].join('.').freeze
+end