appfolio/gemsurance

View on GitHub
lib/gemsurance/gem_info_retriever.rb

Summary

Maintainability
A
2 hrs
Test Coverage
require 'json'

module Gemsurance
  class GemInfoRetriever
    class GemInfo
      GEM_ATTRIBUTES = [:name, :current_version, :newest_version, :in_gem_file, :homepage_uri, :source_code_uri, :documentation_uri, :status, :vulnerabilities]
      STATUS_OUTDATED   = 'outdated'
      STATUS_CURRENT    = 'current'
      STATUS_VULNERABLE = 'vulnerable'

      attr_reader :name, :current_version, :newest_version, :in_gem_file, :vulnerabilities,
                  :homepage_uri, :source_code_uri, :documentation_uri, :status

      def initialize(name, current_version, newest_version, in_gem_file, homepage_uri, source_code_uri, documentation_uri, status = STATUS_CURRENT)
        @name = name
        @current_version = current_version
        @newest_version = newest_version
        @in_gem_file = in_gem_file
        @homepage_uri = homepage_uri
        @documentation_uri = documentation_uri
        @source_code_uri = source_code_uri
        @status = status
        @vulnerabilities = []
      end

      def add_vulnerability!(vulnerability)
        @status = STATUS_VULNERABLE
        @vulnerabilities << vulnerability
      end

      def outdated?
        @status == STATUS_OUTDATED
      end

      def current?
        @status == STATUS_CURRENT
      end

      def vulnerable?
        @status == STATUS_VULNERABLE
      end

      def ==(other)
        @name == other.name &&
          @current_version == other.current_version &&
          @newest_version == other.newest_version &&
          @status == other.instance_variable_get(:@status) &&
          @vulnerabilities == other.vulnerabilities
      end

      def to_csv
        formatted_values.to_csv
      end

      def to_hash
        {
          'in_gem_file' =>  in_gem_file,
          'bundle_version' =>  current_version.to_s,
          'newest_version' =>  newest_version.to_s,
          'status' => human_status,
          'homepage_url' =>  homepage_uri,
          'source_code_url' =>  source_code_uri,
          'documentation_url' =>  documentation_uri,
          'vulnerabilities' => vulns_to_hash
        }
      end

      private

      def formatted_values
        GEM_ATTRIBUTES.map do |attr|
          if attr == :vulnerabilities
            if @vulnerabilities.empty?
              ''
            else
              @vulnerabilities.map { |vuln| vuln.attributes }.to_json
            end
          elsif attr == :status
            human_status
          else
            self.send(attr).to_s
          end
        end
      end

      def human_status
        if vulnerable?
          return 'vulnerable'
        elsif outdated?
          return 'outofdate'
        elsif current?
          return 'uptodate'
        else
          return 'unknown'
        end
      end

      def vulns_to_hash
        return nil if vulnerabilities.empty?

        vulnerabilities.map do |vulnerability|
          {
            'title' => vulnerability.title,
            'cve' =>  vulnerability.cve,
            'url' =>  vulnerability.url,
            'patched_versions' =>  (vulnerability.patched_versions || []).join(', ')
          }
        end
      end
    end

    def initialize(specs, dependencies, bundle_definition)
      @specs = specs
      @dependencies = dependencies
      @bundle_definition = bundle_definition
    end

    def retrieve(options = {})
      gem_infos = []

      @specs.each do |current_spec|
        active_spec = @bundle_definition.index[current_spec.name].sort_by { |b| b.version }

        if !current_spec.version.prerelease? && !options[:pre] && active_spec.size > 1
          active_spec = active_spec.delete_if { |b| b.respond_to?(:version) && b.version.prerelease? }
        end

        active_spec = active_spec.last
        next if active_spec.nil?

        gem_outdated = Gem::Version.new(active_spec.version) > Gem::Version.new(current_spec.version)
        git_outdated = current_spec.git_version != active_spec.git_version

        info = ::Gems.info(active_spec.name)
        homepage_uri      = info['homepage_uri']
        documentation_uri = info['documentation_uri']
        source_code_uri   = info['source_code_uri']

        # TODO: handle git versions
        # spec_version    = "#{active_spec.version}#{active_spec.git_version}"
        # current_version = "#{current_spec.version}#{current_spec.git_version}"
        in_gem_file = @dependencies.any?{|d| d.name == active_spec.name}
        if gem_outdated || git_outdated
          gem_infos << GemInfo.new(active_spec.name, current_spec.version, active_spec.version, in_gem_file, homepage_uri, documentation_uri, source_code_uri, GemInfo::STATUS_OUTDATED)
        else
          gem_infos << GemInfo.new(active_spec.name, current_spec.version, current_spec.version, in_gem_file, homepage_uri, documentation_uri, source_code_uri)
        end
      end
      gem_infos
    end
  end
end