lingfennan-github_api 0.18.2

data/lib/github_api/normalizer.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+module Github
+  # Normalize client-supplied parameter keys.
+  module Normalizer
+    # Turns any keys from nested hashes including nested arrays into strings
+    def normalize!(params)
+      case params
+      when Hash
+        params.keys.each do |k|
+          params[k.to_s] = params.delete(k)
+          normalize!(params[k.to_s])
+        end
+      when Array
+        params.map! do |el|
+          normalize!(el)
+        end
+      end
+      params
+    end
+  end # Normalizer
+end # Github

data/lib/github_api/null_encoder.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require 'faraday'
+
+module Github
+
+  # Skip encoding of the key nested parameters
+  module NullParamsEncoder
+    if defined?(Faraday::NestedParamsEncoder)
+      class << self
+        Faraday::NestedParamsEncoder.singleton_methods do |m|
+          define_method m, ::Faraday::NestedParamsEncoder.method(m).to_proc
+        end
+      end
+    end
+
+    def self.escape(s)
+      s.to_s
+    end
+
+    def self.unescape(s)
+      s.to_s
+    end
+  end # NullEncoder
+end # Github

data/lib/github_api/page_iterator.rb

@@ -0,0 +1,138 @@
+# encoding: utf-8
+
+require 'uri'
+
+require_relative 'constants'
+require_relative 'paged_request'
+require_relative 'utils/url'
+
+module Github
+  # A class responsible for requesting resources through page links
+  #
+  # @api private
+  class PageIterator
+    include Github::Constants
+    include Github::Utils::Url
+    include Github::PagedRequest
+
+    # Setup attribute accesor for all the link types
+    ATTRIBUTES = [META_FIRST, META_NEXT, META_PREV, META_LAST]
+
+    DEFAULT_SHA = 'master'
+
+    ATTRIBUTES.each do |attr|
+      attr_accessor :"#{attr}_page_uri", :"#{attr}_page"
+    end
+
+    attr_reader :current_api
+
+    def initialize(links, current_api)
+      @links       = links
+      @current_api = current_api
+      update_page_links(@links)
+    end
+
+    def next?
+      next_page == 0 || !next_page_uri.nil?
+    end
+
+    def count
+      parse_query(URI(last_page_uri).query)['page'] if last_page_uri
+    end
+
+    # Perform http get request for the first resource
+    #
+    def first
+      perform_request(first_page_uri) if first_page_uri
+    end
+
+    # Perform http get request for the next resource
+    #
+    def next
+      perform_request(next_page_uri) if next?
+    end
+
+    # Perform http get request for the previous resource
+    #
+    def prev
+      perform_request(prev_page_uri) if prev_page_uri
+    end
+
+    # Perform http get request for the last resource
+    #
+    def last
+      perform_request(last_page_uri) if last_page_uri
+    end
+
+    # Returns the result for a specific page.
+    #
+    def get_page(page_number)
+      # Find URI that we can work with, if we cannot get the first or the
+      # last page URI then there is only one page.
+      page_uri = first_page_uri || last_page_uri
+      return nil unless page_uri
+
+      perform_request(page_uri, page_number)
+    end
+
+    private
+
+    def perform_request(page_uri_path, page_number = nil)
+      page_uri = URI(page_uri_path)
+      params = parse_query(page_uri.query)
+
+      if page_number
+        params['page'] = page_number
+      elsif next_page < 1
+        sha = sha(params)
+        params['sha'] = sha if sha
+      else
+        params['page'] = parse_page_number(page_uri_path)
+      end
+      params['per_page'] = parse_per_page_number(page_uri_path)
+
+      response = page_request(page_uri.path, params)
+      update_page_links response.links
+      response
+    end
+
+    def sha(params)
+      return params['last_sha'] if params.keys.include?('last_sha')
+      return DEFAULT_SHA if params.keys.include?('sha')
+    end
+
+    def parse_per_page_number(uri) # :nodoc:
+      parse_page_params(uri, PARAM_PER_PAGE)
+    end
+
+    def parse_page_number(uri) # :nodoc:
+      parse_page_params(uri, PARAM_PAGE)
+    end
+
+    # Extracts query string parameter for given name
+    def parse_page_params(uri, attr) # :nodoc:
+      return -1 if uri.nil? || uri.empty?
+      parsed = nil
+      begin
+        parsed = URI.parse(uri)
+      rescue URI::Error
+        return -1
+      end
+      param = parse_query_for_param(parsed.query, attr)
+      return -1 if param.nil? || param.empty?
+      begin
+        return param.to_i
+      rescue ArgumentError
+        return -1
+      end
+    end
+
+    # Wholesale update of all link attributes
+    def update_page_links(links) # :nodoc:
+      ATTRIBUTES.each do |attr|
+        send(:"#{attr}_page_uri=", links.send(:"#{attr}"))
+        send(:"#{attr}_page=", parse_page_number(links.send(:"#{attr}")))
+      end
+    end
+  end # PageIterator
+end # Github

data/lib/github_api/page_links.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+
+require_relative 'constants'
+
+module Github
+  # Determines the links in the current response link header to be used
+  # to find the links to other pages of request responses. These will
+  # only be present if the result set size exceeds the per page limit.
+  #
+  # @api private
+  class PageLinks
+    include Github::Constants
+
+    DELIM_LINKS = ','.freeze # :nodoc:
+
+    # Hold the extracted values for URI from the Link header
+    # for the first, last, next and previous page.
+    attr_accessor :first, :last, :next, :prev
+
+    LINK_REGEX = /<([^>]+)>; rel=\"([^\"]+)\"/
+
+    # Parses links from executed request
+    #
+    # @param [Hash] response_headers
+    #
+    # @api private
+    def initialize(response_headers)
+      link_header = response_headers[HEADER_LINK]
+      if link_header && link_header =~ /(next|first|last|prev)/
+        extract_links(link_header)
+      else
+        # When on the first page
+        self.next = response_headers[HEADER_NEXT]
+        self.last = response_headers[HEADER_LAST]
+      end
+    end
+
+    private
+
+    def extract_links(link_header)
+      link_header.split(DELIM_LINKS).each do |link|
+        LINK_REGEX.match(link.strip) do |match|
+          url_part, meta_part = match[1], match[2]
+          next if !url_part || !meta_part
+          assign_url_part(meta_part, url_part)
+        end
+      end
+    end
+
+    def assign_url_part(meta_part, url_part)
+      case meta_part
+      when META_FIRST
+        self.first = url_part
+      when META_LAST
+        self.last = url_part
+      when META_NEXT
+        self.next = url_part
+      when META_PREV
+        self.prev = url_part
+      end
+    end
+  end # PageLinks
+end # Github

data/lib/github_api/paged_request.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require_relative 'constants'
+
+module Github
+
+  # A module that adds http get request to response pagination
+  module PagedRequest
+    include Github::Constants
+
+    FIRST_PAGE = 1 # Default request page if none provided
+
+    PER_PAGE   = 30 # Default number of items as specified by API
+
+    NOT_FOUND  = -1 # Either page or per_page parameter not present
+
+    # Check if current api instance has default per_page param set,
+    # otherwise use global default.
+    #
+    def default_page_size
+      current_api.per_page ? current_api.per_page : PER_PAGE
+    end
+
+    def default_page
+      current_api.page ? current_api.page : FIRST_PAGE
+    end
+
+    # Perform http get request with pagination parameters
+    #
+    def page_request(path, params={})
+      if params[PARAM_PER_PAGE] == NOT_FOUND
+        params[PARAM_PER_PAGE] = default_page_size
+      end
+      if params[PARAM_PAGE] && params[PARAM_PAGE] == NOT_FOUND
+        params[PARAM_PAGE] = default_page
+      end
+
+      current_api.get_request(path, ParamsHash.new(params))
+    end
+
+  end # PagedRequest
+end # Github

data/lib/github_api/pagination.rb

@@ -0,0 +1,115 @@
+# encoding: utf-8
+
+require_relative 'constants'
+require_relative 'page_links'
+require_relative 'page_iterator'
+
+module Github
+  # A module that decorates response with pagination helpers
+  module Pagination
+    include Github::Constants
+
+    # Return page links
+    def links
+      @links = Github::PageLinks.new(env[:response_headers])
+    end
+
+    # Retrive number of total pages base on current :per_page parameter
+    def count_pages
+      page_iterator.count.to_i
+    end
+
+    # Iterate over results set pages by automatically calling `next_page`
+    # until all pages are exhausted. Caution needs to be exercised when
+    # using this feature - 100 pages iteration will perform 100 API calls.
+    # By default this is off. You can set it on the client, individual API
+    # instances or just per given request.
+    #
+    def auto_paginate(auto=false)
+      if (current_api.auto_pagination? || auto) && self.body.is_a?(Array)
+        resources_bodies = []
+        each_page { |resource| resources_bodies += resource.body }
+        self.body = resources_bodies
+      end
+      self
+    end
+
+    # Iterator like each for response pages. If there are no pages to
+    # iterate over this method will return current page.
+    def each_page
+      yield self
+      while page_iterator.next?
+        yield next_page
+      end
+    end
+
+    # Retrives the result of the first page. Returns <tt>nil</tt> if there is
+    # no first page - either because you are already on the first page
+    # or there are no pages at all in the result.
+    def first_page
+      first_request = page_iterator.first
+      self.instance_eval { @env = first_request.env } if first_request
+      first_request
+    end
+
+    # Retrives the result of the next page. Returns <tt>nil</tt> if there is
+    # no next page or no pages at all.
+    def next_page
+      next_request = page_iterator.next
+      self.instance_eval { @env = next_request.env } if next_request
+      next_request
+    end
+
+    # Retrives the result of the previous page. Returns <tt>nil</tt> if there is
+    # no previous page or no pages at all.
+    def prev_page
+      prev_request = page_iterator.prev
+      self.instance_eval { @env = prev_request.env } if prev_request
+      prev_request
+    end
+    alias :previous_page :prev_page
+
+    # Retrives the result of the last page. Returns <tt>nil</tt> if there is
+    # no last page - either because you are already on the last page,
+    # there is only one page or there are no pages at all in the result.
+    def last_page
+      last_request = page_iterator.last
+      self.instance_eval { @env = last_request.env } if last_request
+      last_request
+    end
+
+    # Retrives a specific result for a page given page number.
+    # The <tt>page_number</tt> parameter is not validate, hitting a page
+    # that does not exist will return Github API error. Consequently, if
+    # there is only one page, this method returns nil
+    def page(page_number)
+      request = page_iterator.get_page(page_number)
+      self.instance_eval { @env = request.env } if request
+      request
+    end
+
+    # Returns <tt>true</tt> if there is another page in the result set,
+    # otherwise <tt>false</tt>
+    def has_next_page?
+      page_iterator.next?
+    end
+
+    # Handle pagination params when they are not passed directly
+    #
+    def self.per_page_as_param(per_page_config)
+      params = {}
+      if (per_page_config != Github::Configuration.property_set[:per_page])
+        params[:per_page] = per_page_config unless per_page_config.nil?
+      end
+      params
+    end
+
+    private
+
+    # Internally used page iterator
+    def page_iterator # :nodoc:
+      @page_iterator = Github::PageIterator.new(links, current_api)
+    end
+
+  end # Pagination
+end # Github

data/lib/github_api/parameter_filter.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+require_relative 'params_hash'
+require_relative 'validations'
+
+module Github
+  # Allows you to specify parameters keys which will be preserved
+  # in parameters hash and its subhashes. Any keys from the nested
+  # hash that do not match will be removed.
+  module ParameterFilter
+
+    # Removes any keys from nested hashes that don't match predefiend keys
+    #
+    def filter!(keys, params, options={:recursive => true})  # :nodoc:
+      case params
+      when Hash, ParamsHash
+        params.keys.each do |k, v|
+          unless (keys.include?(k) or Github::Validations::VALID_API_KEYS.include?(k))
+            params.delete(k)
+          else
+            filter!(keys, params[k]) if options[:recursive]
+          end
+        end
+      when Array
+        params.map! do |el|
+          filter!(keys, el) if options[:recursive]
+        end
+      else
+        params
+      end
+      return params
+    end
+
+  end # Filter
+end # Github