nomius 0.1.0

data/lib/nomius/detector/domain_org_detector.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "uri"
+require_relative "base_domain_name_detector"
+
+module Nomius
+  class Detector
+    # Check .org domain name availability
+    class DomainOrgDetector < BaseDomainNameDetector
+      def tld
+        ".org"
+      end
+    end
+  end
+end

data/lib/nomius/detector/github_detector.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "base_url_detector"
+
+module Nomius
+  class Detector
+    # Check name availability for https://github.com/
+    class GithubDetector < BaseURLDetector
+      BASE_URL = "https://github.com"
+
+      def detector_name
+        "GitHub.com"
+      end
+
+      def detector_short_name
+        "GH"
+      end
+
+      private
+
+      def uri
+        "#{BASE_URL}/#{name.name}"
+      end
+    end
+  end
+end

data/lib/nomius/detector/npmjs_detector.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "base_url_detector"
+
+module Nomius
+  class Detector
+    # Check name availability for https://www.npmjs.com/
+    class NpmjsDetector < BaseURLDetector
+      BASE_URL = "https://registry.npmjs.org"
+
+      def detector_name
+        "NPMjs.com"
+      end
+
+      def detector_short_name
+        "npm"
+      end
+
+      private
+
+      def uri
+        "#{BASE_URL}/#{name.name}"
+      end
+    end
+  end
+end

data/lib/nomius/detector/pypi_detector.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "base_url_detector"
+
+module Nomius
+  class Detector
+    # Check name availability for https://pypi.org/
+    class PypiDetector < BaseURLDetector
+      BASE_URL = "https://pypi.org/project"
+
+      def detector_name
+        "PyPi.org"
+      end
+
+      def detector_short_name
+        "pip"
+      end
+
+      private
+
+      def uri
+        "#{BASE_URL}/#{name.name}"
+      end
+    end
+  end
+end

data/lib/nomius/detector/rubygems_detector.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "base_url_detector"
+
+module Nomius
+  class Detector
+    # Check name availability for https://rubygems.org/
+    class RubygemsDetector < BaseURLDetector
+      BASE_URL = "https://rubygems.org/api/v1/gems"
+
+      def detector_name
+        "RubyGems.org"
+      end
+
+      def detector_short_name
+        "gem"
+      end
+
+      private
+
+      def uri
+        "#{BASE_URL}/#{name.name}"
+      end
+    end
+  end
+end

data/lib/nomius/detector/util/http_requester.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday/retry"
+require "faraday/follow_redirects"
+
+require_relative "../../version"
+
+module Nomius
+  class Detector
+    class Util
+      # Encapsulates HTTP request handling.
+      # Using Faraday gem. But could be easily replaced with any other HTTP client.
+      class HTTPRequester
+        # rubocop:disable Lint/EmptyClass
+        class OK; end
+        class NotFound; end
+        class Unresolved; end
+        # rubocop:enable Lint/EmptyClass
+
+        HEADERS = {
+          "User-Agent" => "Nomius/#{Nomius::VERSION}"
+        }.freeze
+
+        FALLBACK_STATUS = Unresolved
+
+        RESPONSE_STATUS_RESOLVER = {
+          200 => OK,
+          404 => NotFound
+        }.freeze
+
+        RETRY_STATUSES = [
+          400, 401, 403, 408, 409, 418, 425, 429,
+          500, 502, 503, 504
+        ].freeze
+
+        RETRY_OPTIONS = {
+          max: 5,
+          interval: 1,
+          interval_randomness: 0.5,
+          backoff_factor: 2,
+          retry_statuses: RETRY_STATUSES
+        }.freeze
+
+        attr_reader :uri, :logger
+
+        def self.response_status(uri:, logger:)
+          new(uri: uri, logger: logger).response_status
+        end
+
+        def initialize(uri:, logger:)
+          @uri = uri.to_s
+          @logger = logger
+        end
+
+        def response_status
+          # HEAD request is used to avoid downloading the whole page.
+          response = connection.head
+
+          unless RESPONSE_STATUS_RESOLVER.key?(response.status)
+            logger.log_error(message: uri, details: response.to_hash.to_json)
+          end
+
+          RESPONSE_STATUS_RESOLVER.fetch(response.status, FALLBACK_STATUS)
+        end
+
+        private
+
+        def connection
+          @connection ||= Faraday.new(url: uri, headers: HEADERS) do |faraday|
+            faraday.request :retry, RETRY_OPTIONS
+            faraday.response :follow_redirects
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nomius/detector.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "detector/dockerhub_detector"
+require_relative "detector/domain_com_detector"
+require_relative "detector/domain_org_detector"
+require_relative "detector/github_detector"
+require_relative "detector/npmjs_detector"
+require_relative "detector/pypi_detector"
+require_relative "detector/rubygems_detector"
+
+module Nomius
+  # Detectors
+  class Detector
+    DETECTORS = [
+      DomainComDetector,
+      DomainOrgDetector,
+      GithubDetector,
+      DockerhubDetector,
+      NpmjsDetector,
+      PypiDetector,
+      RubygemsDetector
+    ].freeze
+
+    def self.all
+      DETECTORS
+    end
+  end
+end

data/lib/nomius/logger/silent.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Nomius
+  class Logger
+    # Silent logger
+    class Silent
+      def start_batch_processing(_count)
+        # Intentionally do nothing
+      end
+
+      def batch_record_processing(_name)
+        # Intentionally do nothing
+        yield
+      end
+
+      def log_detector_status
+        # Intentionally do nothing
+        yield
+      end
+
+      def log_info(_message)
+        # Intentionally do nothing
+      end
+
+      def log_error(message: "", details: "")
+        warn message
+        warn details
+      end
+    end
+  end
+end

data/lib/nomius/logger/verbose.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "tty-progressbar"
+require_relative "../status/formatter/mark"
+
+module Nomius
+  class Logger
+    # Verbose logger
+    class Verbose
+      def start_batch_processing(count)
+        @progress_bar = TTY::ProgressBar.new("[:bar] :current/:total ET::elapsed ETA::eta") do |config|
+          config.total = count
+          config.interval = 5
+        end
+      end
+
+      def batch_record_processing(name)
+        log_info("Processing #{name.name}...")
+        result = yield
+        log_info("")
+        progress_bar.advance
+
+        result
+      end
+
+      def log_detector_status
+        status = yield
+        log_info("#{status.detector.detector_short_name}  #{Status::Formatter::Mark.for(status)}")
+
+        status
+      end
+
+      def log_info(message)
+        progress_bar.log(message)
+      end
+
+      def log_error(message: "", details: "")
+        warn message
+        warn details
+      end
+
+      private
+
+      attr_reader :progress_bar
+    end
+  end
+end

data/lib/nomius/logger.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "logger/silent"
+require_relative "logger/verbose"
+
+module Nomius
+  # Logger factory
+  class Logger
+    LOGGER_BY_SILENT = {
+      true => Silent,
+      false => Verbose
+    }.freeze
+
+    def self.for(silent: false)
+      LOGGER_BY_SILENT.fetch(silent).new
+    end
+  end
+end

data/lib/nomius/name.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Nomius
+  # Name object
+  class Name
+    attr_reader :name, :comment
+
+    def self.for(name)
+      return name if name.is_a?(self)
+
+      new(name: name.to_s)
+    end
+
+    def initialize(name:, comment: "")
+      @name = name.to_s.strip.downcase
+      @comment = comment.to_s.strip.downcase
+      validate!
+    end
+
+    private
+
+    def validate!
+      raise ArgumentError, "Name cannot be blank" if name.empty?
+    end
+  end
+end

data/lib/nomius/status/available.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Nomius
+  module Status
+    # Status for name available.
+    class Available < Base
+      def available?
+        true
+      end
+
+      def unavailalbe?
+        false
+      end
+
+      def unresolved?
+        false
+      end
+    end
+  end
+end

data/lib/nomius/status/base.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Nomius
+  module Status
+    # Status for available domains.
+    class Base
+      attr_reader :name, :detector, :exception
+
+      def initialize(name:, detector:, exception: nil)
+        @name = name
+        @detector = detector
+        @exception = exception
+      end
+    end
+  end
+end

data/lib/nomius/status/formatter/ascii_mark.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "../available"
+require_relative "../unavailable"
+require_relative "../unresolved"
+
+module Nomius
+  module Status
+    module Formatter
+      # Generate status text for Status
+      class ASCIIMark
+        STATUS_MAPPER = {
+          Status::Available => "+",
+          Status::Unavailable => "-",
+          Status::Unresolved => "?"
+        }.freeze
+
+        def self.for(status)
+          STATUS_MAPPER.fetch(status.class)
+        end
+      end
+    end
+  end
+end

data/lib/nomius/status/formatter/mark.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "../available"
+require_relative "../unavailable"
+require_relative "../unresolved"
+
+module Nomius
+  module Status
+    module Formatter
+      # Generate status mark for Status
+      class Mark
+        STATUS_MAPPER = {
+          Status::Available => "✅",
+          Status::Unavailable => "❌",
+          Status::Unresolved => "❓"
+        }.freeze
+
+        def self.for(status)
+          STATUS_MAPPER.fetch(status.class)
+        end
+      end
+    end
+  end
+end

data/lib/nomius/status/unavailable.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Nomius
+  module Status
+    # Status for name unavailable.
+    class Unavailable < Base
+      def available?
+        false
+      end
+
+      def unavailalbe?
+        true
+      end
+
+      def unresolved?
+        false
+      end
+    end
+  end
+end

data/lib/nomius/status/unresolved.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Nomius
+  module Status
+    # Status for name availability unresolved. Should be checked manually.
+    class Unresolved < Base
+      def available?
+        false
+      end
+
+      def unavailalbe?
+        false
+      end
+
+      def unresolved?
+        true
+      end
+    end
+  end
+end

data/lib/nomius/status.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "status/available"
+require_relative "status/unavailable"
+require_relative "status/unresolved"

data/lib/nomius/version.rb

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

data/lib/nomius.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "nomius/bulk_checker"
+require_relative "nomius/checker"
+require_relative "nomius/detector"
+require_relative "nomius/logger"
+require_relative "nomius/name"
+require_relative "nomius/status"
+require_relative "nomius/version"
+
+# Nomius
+module Nomius
+end