github_api2 1.0.0

data/lib/github_api2/utils/url.rb

@@ -0,0 +1,63 @@
+# encoding:utf-8
+
+require 'cgi'
+require 'addressable/uri'
+
+module Github
+  module Utils
+    module Url
+      extend self
+
+      DEFAULT_QUERY_SEP = /[&;] */n
+
+      KEY_VALUE_SEP = '='.freeze
+
+      def escape_uri(s) Addressable::URI.escape(s.to_s) end
+
+      def escape(s) CGI.escape(s.to_s) end
+
+      def unescape(s) CGI.unescape(s.to_s) end
+
+      def normalize(s) Addressable::URI.parse(s.to_s).normalize.path end
+
+      def build_query(params)
+        params.map { |k, v|
+          if v.class == Array
+            build_query(v.map { |x| [k, x] })
+          else
+            v.nil? ? escape(k) : "#{escape(k)}=#{escape(v)}"
+          end
+        }.join("&")
+      end
+
+      def parse_query(query_string)
+        return '' if query_string.nil? || query_string.empty?
+        params = {}
+
+        query_string.split(DEFAULT_QUERY_SEP).each do |part|
+          k, v = part.split(KEY_VALUE_SEP, 2).map { |el| unescape(el) }
+
+          if cur = params[k]
+            if cur.class == Array
+              params[k] << v
+            else
+              params[k] = [cur, v]
+            end
+          else
+            params[k] = v
+          end
+        end
+        params
+      end
+
+      def parse_query_for_param(query_string, name)
+        parse_query(query_string).each do |key, val|
+          return val.first if (name == key) && val.is_a?(Array)
+          return val if (name == key)
+        end
+        return nil
+      end
+
+    end # Url
+  end # Utils
+end # Github

data/lib/github_api2/validations/format.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+require_relative '../error/client_error'
+
+module Github
+  module Validations
+    module Format
+
+      # Ensures that value for a given key is of the correct form whether
+      # matching regular expression or set of predefined values.
+      #
+      def assert_valid_values(permitted, params)
+        params.each do |k, v|
+          next unless permitted.keys.include?(k)
+          if permitted[k].is_a?(Array) && !permitted[k].include?(params[k])
+            raise Github::Error::UnknownValue.new(k,v, permitted[k].join(', '))
+
+          elsif permitted[k].is_a?(Regexp) && !(permitted[k] =~ params[k])
+            raise Github::Error::UnknownValue.new(k,v, permitted[k])
+          end
+        end
+      end
+
+    end # Format
+  end # Validations
+end # Github

data/lib/github_api2/validations/presence.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+require_relative '../error/client_error'
+
+module Github
+  module Validations
+    # A mixin to help validate presence of non-empty values
+    module Presence
+
+      # Ensure that essential arguments are present before request is made.
+      #
+      # == Parameters
+      #  Hash/Array of arguments to be checked against nil and empty string
+      #
+      # == Example
+      #  assert_presence_of user: '...', repo: '...'
+      #  assert_presence_of user, repo
+      #
+      def assert_presence_of(*args)
+        hash = args.last.is_a?(::Hash) ? args.pop : {}
+
+        errors = hash.select { |key, val| val.to_s.empty? }
+        raise Github::Error::Validations.new(errors) unless errors.empty?
+
+        args.each do |arg|
+          raise ArgumentError, "parameter cannot be nil" if arg.nil?
+        end
+      end
+
+    end # Presence
+  end # Validations
+end # Github

data/lib/github_api2/validations/required.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require_relative '../error/client_error'
+
+module Github
+  module Validations
+    module Required
+      # Validate all keys present in a provided hash against required set,
+      # on mismatch raise Github::Error::RequiredParams
+      # Note that keys need to be in the same format i.e. symbols or strings,
+      # otherwise the comparison will fail.
+      #
+      # @api public
+      def assert_required_keys(*required, provided)
+        required.flatten.all? { |key|
+          provided.deep_key?(key.to_s)
+        } || (raise Github::Error::RequiredParams.new(provided, required))
+      end
+    end # Required
+  end # Validations
+end # Github

data/lib/github_api2/validations/token.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+module Github
+  module Validations
+    module Token
+
+      TOKEN_REQUIRED = [
+        'get /user',
+        'get /user/emails',
+        'get /user/followers',
+        'get /user/following',
+        'get /user/keys',
+        'get /user/repos',
+        'patch /user',
+        'post /user/emails',
+        'post /user/keys',
+        'post /user/repos'
+      ]
+
+      TOKEN_REQUIRED_REGEXP = [
+        /repos\/.*\/.*\/comments/,
+      ]
+
+      # Ensures that required authentication token is present before
+      # request is sent.
+      #
+      def validates_token_for(method, path)
+        return true unless TOKEN_REQUIRED.grep("#{method} #{path}").empty?
+
+        token_required = false
+        TOKEN_REQUIRED_REGEXP.each do |regex|
+          if "#{method} #{path}" =~ regex
+            token_required = true
+          end
+        end
+        return token_required
+      end
+
+    end # Token
+  end # Validations
+end # Github

data/lib/github_api2/validations.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+require_relative 'validations/format'
+require_relative 'validations/presence'
+require_relative 'validations/required'
+require_relative 'validations/token'
+
+module Github
+  module Validations
+    include Presence
+    include Format
+    include Token
+    include Required
+
+    VALID_API_KEYS = [
+      'page',
+      'per_page',
+      'auto_pagination',
+      'jsonp_callback'
+    ]
+  end # Validation
+end # Github

data/lib/github_api2/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Github
+  VERSION = "1.0.0"
+end # Github

data/lib/github_api2.rb

@@ -0,0 +1,92 @@
+# encoding: utf-8
+
+require 'pp' if ENV['DEBUG']
+
+require 'faraday'
+require_relative 'github_api2/ext/faraday'
+
+module Github
+  LIBNAME = 'github_api2'
+
+  LIBDIR = File.expand_path("../#{LIBNAME}", __FILE__)
+
+  class << self
+    # The client configuration
+    #
+    # @return [Configuration]
+    #
+    # @api public
+    def configuration
+      @configuration ||= Configuration.new
+    end
+    alias_method :config, :configuration
+
+    # Configure options
+    #
+    # @example
+    #   Github.configure do |c|
+    #     c.some_option = true
+    #   end
+    #
+    # @yield the configuration block
+    # @yieldparam configuration [Github::Configuration]
+    #   the configuration instance
+    #
+    # @return [nil]
+    #
+    # @api public
+    def configure
+      yield configuration
+    end
+
+    # Alias for Github::Client.new
+    #
+    # @param [Hash] options
+    #   the configuration options
+    #
+    # @return [Github::Client]
+    #
+    # @api public
+    def new(options = {}, &block)
+      Client.new(options, &block)
+    end
+
+    # Default middleware stack that uses default adapter as specified
+    # by configuration setup
+    #
+    # @return [Proc]
+    #
+    # @api private
+    def default_middleware(options = {})
+      Middleware.default(options)
+    end
+
+    # Delegate to Github::Client
+    #
+    # @api private
+    def method_missing(method_name, *args, &block)
+      if new.respond_to?(method_name)
+        new.send(method_name, *args, &block)
+      elsif configuration.respond_to?(method_name)
+        Github.configuration.send(method_name, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to?(method_name, include_private = false)
+      new.respond_to?(method_name, include_private) ||
+      configuration.respond_to?(method_name) ||
+      super(method_name, include_private)
+    end
+  end
+end # Github
+
+require_relative 'github_api2/api'
+require_relative 'github_api2/client'
+require_relative 'github_api2/configuration'
+require_relative 'github_api2/deprecation'
+require_relative 'github_api2/core_ext/array'
+require_relative 'github_api2/core_ext/hash'
+require_relative 'github_api2/middleware'
+require_relative 'github_api2/version'

metadata

@@ -0,0 +1,363 @@
+--- !ruby/object:Gem::Specification
+name: github_api2
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jacob Marquez
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.2
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: descendants_tracker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: ' Ruby client that supports all of the GitHub API methods. It"s build
+  in a modular way, that is, you can either instantiate the whole api wrapper Github.new
+  or use parts of it e.i. Github::Client::Repos.new if working solely with repositories
+  is your main concern. Intuitive query methods allow you easily call API endpoints.
+  This version of github_api is intended to provide support for Oauth 2.x. '
+email:
+- jacobmarq@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+- CHANGELOG.md
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/github_api2.rb
+- lib/github_api2/api.rb
+- lib/github_api2/api/actions.rb
+- lib/github_api2/api/arguments.rb
+- lib/github_api2/api/config.rb
+- lib/github_api2/api/config/property.rb
+- lib/github_api2/api/config/property_set.rb
+- lib/github_api2/api/factory.rb
+- lib/github_api2/authorization.rb
+- lib/github_api2/client.rb
+- lib/github_api2/client/activity.rb
+- lib/github_api2/client/activity/events.rb
+- lib/github_api2/client/activity/feeds.rb
+- lib/github_api2/client/activity/notifications.rb
+- lib/github_api2/client/activity/starring.rb
+- lib/github_api2/client/activity/watching.rb
+- lib/github_api2/client/authorizations.rb
+- lib/github_api2/client/authorizations/app.rb
+- lib/github_api2/client/emojis.rb
+- lib/github_api2/client/gists.rb
+- lib/github_api2/client/gists/comments.rb
+- lib/github_api2/client/git_data.rb
+- lib/github_api2/client/git_data/blobs.rb
+- lib/github_api2/client/git_data/commits.rb
+- lib/github_api2/client/git_data/references.rb
+- lib/github_api2/client/git_data/tags.rb
+- lib/github_api2/client/git_data/trees.rb
+- lib/github_api2/client/gitignore.rb
+- lib/github_api2/client/issues.rb
+- lib/github_api2/client/issues/assignees.rb
+- lib/github_api2/client/issues/comments.rb
+- lib/github_api2/client/issues/events.rb
+- lib/github_api2/client/issues/labels.rb
+- lib/github_api2/client/issues/milestones.rb
+- lib/github_api2/client/markdown.rb
+- lib/github_api2/client/meta.rb
+- lib/github_api2/client/orgs.rb
+- lib/github_api2/client/orgs/hooks.rb
+- lib/github_api2/client/orgs/members.rb
+- lib/github_api2/client/orgs/memberships.rb
+- lib/github_api2/client/orgs/projects.rb
+- lib/github_api2/client/orgs/teams.rb
+- lib/github_api2/client/projects.rb
+- lib/github_api2/client/projects/cards.rb
+- lib/github_api2/client/projects/columns.rb
+- lib/github_api2/client/pull_requests.rb
+- lib/github_api2/client/pull_requests/comments.rb
+- lib/github_api2/client/pull_requests/reviews.rb
+- lib/github_api2/client/repos.rb
+- lib/github_api2/client/repos/branches.rb
+- lib/github_api2/client/repos/branches/protections.rb
+- lib/github_api2/client/repos/collaborators.rb
+- lib/github_api2/client/repos/comments.rb
+- lib/github_api2/client/repos/commits.rb
+- lib/github_api2/client/repos/contents.rb
+- lib/github_api2/client/repos/deployments.rb
+- lib/github_api2/client/repos/downloads.rb
+- lib/github_api2/client/repos/forks.rb
+- lib/github_api2/client/repos/hooks.rb
+- lib/github_api2/client/repos/invitations.rb
+- lib/github_api2/client/repos/keys.rb
+- lib/github_api2/client/repos/merging.rb
+- lib/github_api2/client/repos/pages.rb
+- lib/github_api2/client/repos/projects.rb
+- lib/github_api2/client/repos/pub_sub_hubbub.rb
+- lib/github_api2/client/repos/releases.rb
+- lib/github_api2/client/repos/releases/assets.rb
+- lib/github_api2/client/repos/releases/tags.rb
+- lib/github_api2/client/repos/statistics.rb
+- lib/github_api2/client/repos/statuses.rb
+- lib/github_api2/client/say.rb
+- lib/github_api2/client/scopes.rb
+- lib/github_api2/client/search.rb
+- lib/github_api2/client/search/legacy.rb
+- lib/github_api2/client/users.rb
+- lib/github_api2/client/users/emails.rb
+- lib/github_api2/client/users/followers.rb
+- lib/github_api2/client/users/keys.rb
+- lib/github_api2/configuration.rb
+- lib/github_api2/connection.rb
+- lib/github_api2/constants.rb
+- lib/github_api2/core_ext/array.rb
+- lib/github_api2/core_ext/hash.rb
+- lib/github_api2/deprecation.rb
+- lib/github_api2/error.rb
+- lib/github_api2/error/client_error.rb
+- lib/github_api2/error/service_error.rb
+- lib/github_api2/ext/faraday.rb
+- lib/github_api2/mash.rb
+- lib/github_api2/middleware.rb
+- lib/github_api2/mime_type.rb
+- lib/github_api2/normalizer.rb
+- lib/github_api2/null_encoder.rb
+- lib/github_api2/page_iterator.rb
+- lib/github_api2/page_links.rb
+- lib/github_api2/paged_request.rb
+- lib/github_api2/pagination.rb
+- lib/github_api2/parameter_filter.rb
+- lib/github_api2/params_hash.rb
+- lib/github_api2/rate_limit.rb
+- lib/github_api2/request.rb
+- lib/github_api2/request/basic_auth.rb
+- lib/github_api2/request/jsonize.rb
+- lib/github_api2/request/oauth2.rb
+- lib/github_api2/request/verbs.rb
+- lib/github_api2/response.rb
+- lib/github_api2/response/atom_parser.rb
+- lib/github_api2/response/follow_redirects.rb
+- lib/github_api2/response/header.rb
+- lib/github_api2/response/jsonize.rb
+- lib/github_api2/response/mashify.rb
+- lib/github_api2/response/raise_error.rb
+- lib/github_api2/response/xmlize.rb
+- lib/github_api2/response_wrapper.rb
+- lib/github_api2/ssl_certs/cacerts.pem
+- lib/github_api2/utils/url.rb
+- lib/github_api2/validations.rb
+- lib/github_api2/validations/format.rb
+- lib/github_api2/validations/presence.rb
+- lib/github_api2/validations/required.rb
+- lib/github_api2/validations/token.rb
+- lib/github_api2/version.rb
+homepage: http://jacobmarq.github.io/github/
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Additional support for Piotr's ruby client for the official GitHub API
+test_files: []