phoebe 0.1.0.pre.alpha.1

data/lib/phoebe.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+# Standard libraries.
+# rubocop:disable Lint/RedundantRequireStatement
+require "English"
+require "base64"
+require "cgi"
+require "date"
+require "erb"
+require "etc"
+require "json"
+require "net/http"
+require "openssl"
+require "pathname"
+require "rbconfig"
+require "securerandom"
+require "set"
+require "stringio"
+require "time"
+require "uri"
+# rubocop:enable Lint/RedundantRequireStatement
+
+# We already ship the preferred sorbet manifests in the package itself.
+# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
+if Object.const_defined?(:Tapioca) &&
+   caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
+   ARGV.none?(/dsl/)
+  return
+end
+
+# Gems.
+require "connection_pool"
+
+# Package files.
+require_relative "phoebe/version"
+require_relative "phoebe/internal/util"
+require_relative "phoebe/internal/type/converter"
+require_relative "phoebe/internal/type/unknown"
+require_relative "phoebe/internal/type/boolean"
+require_relative "phoebe/internal/type/file_input"
+require_relative "phoebe/internal/type/enum"
+require_relative "phoebe/internal/type/union"
+require_relative "phoebe/internal/type/array_of"
+require_relative "phoebe/internal/type/hash_of"
+require_relative "phoebe/internal/type/base_model"
+require_relative "phoebe/internal/type/base_page"
+require_relative "phoebe/internal/type/request_parameters"
+require_relative "phoebe/internal"
+require_relative "phoebe/request_options"
+require_relative "phoebe/file_part"
+require_relative "phoebe/errors"
+require_relative "phoebe/internal/transport/base_client"
+require_relative "phoebe/internal/transport/pooled_net_requester"
+require_relative "phoebe/client"
+require_relative "phoebe/models/data/observation"
+require_relative "phoebe/models/data/observations/geo/recent/notable_list_params"
+require_relative "phoebe/models/data/observations/geo/recent/notable_list_response"
+require_relative "phoebe/models/data/observations/geo/recent/specie_list_params"
+require_relative "phoebe/models/data/observations/geo/recent/specie_list_response"
+require_relative "phoebe/models/data/observations/geo/recent_list_params"
+require_relative "phoebe/models/data/observations/geo/recent_list_response"
+require_relative "phoebe/models/data/observations/nearest/geo_specie_list_params"
+require_relative "phoebe/models/data/observations/nearest/geo_specie_list_response"
+require_relative "phoebe/models/data/observations/recent/historic_list_params"
+require_relative "phoebe/models/data/observations/recent/historic_list_response"
+require_relative "phoebe/models/data/observations/recent/notable_list_params"
+require_relative "phoebe/models/data/observations/recent/notable_list_response"
+require_relative "phoebe/models/data/observations/recent/specie_retrieve_params"
+require_relative "phoebe/models/data/observations/recent/specie_retrieve_response"
+require_relative "phoebe/models/data/observations/recent_list_params"
+require_relative "phoebe/models/data/observations/recent_list_response"
+require_relative "phoebe/models/product/checklist_view_params"
+require_relative "phoebe/models/product/checklist_view_response"
+require_relative "phoebe/models/product/list_retrieve_params"
+require_relative "phoebe/models/product/list_retrieve_response"
+require_relative "phoebe/models/product/lists/historical_retrieve_params"
+require_relative "phoebe/models/product/lists/historical_retrieve_response"
+require_relative "phoebe/models/product/species_list_list_params"
+require_relative "phoebe/models/product/species_list_list_response"
+require_relative "phoebe/models/product/stat_retrieve_params"
+require_relative "phoebe/models/product/stat_retrieve_response"
+require_relative "phoebe/models/product/top100_retrieve_params"
+require_relative "phoebe/models/product/top100_retrieve_response"
+require_relative "phoebe/models/ref/hotspot/geo_retrieve_params"
+require_relative "phoebe/models/ref/hotspot/geo_retrieve_response"
+require_relative "phoebe/models/ref/hotspot/info_retrieve_params"
+require_relative "phoebe/models/ref/hotspot/info_retrieve_response"
+require_relative "phoebe/models/ref/hotspot_list_params"
+require_relative "phoebe/models/ref/hotspot_list_response"
+require_relative "phoebe/models/ref/region/adjacent_list_params"
+require_relative "phoebe/models/ref/region/adjacent_list_response"
+require_relative "phoebe/models/ref/region/info_retrieve_params"
+require_relative "phoebe/models/ref/region/info_retrieve_response"
+require_relative "phoebe/models/ref/region/list_list_params"
+require_relative "phoebe/models/ref/region/list_list_response"
+require_relative "phoebe/models/ref/taxonomy/ebird_retrieve_params"
+require_relative "phoebe/models/ref/taxonomy/ebird_retrieve_response"
+require_relative "phoebe/models/ref/taxonomy/form_list_params"
+require_relative "phoebe/models/ref/taxonomy/form_list_response"
+require_relative "phoebe/models/ref/taxonomy/locale_list_params"
+require_relative "phoebe/models/ref/taxonomy/locale_list_response"
+require_relative "phoebe/models/ref/taxonomy/species_group_list_params"
+require_relative "phoebe/models/ref/taxonomy/species_group_list_response"
+require_relative "phoebe/models/ref/taxonomy/version_list_params"
+require_relative "phoebe/models/ref/taxonomy/version_list_response"
+require_relative "phoebe/models"
+require_relative "phoebe/resources/data"
+require_relative "phoebe/resources/data/observations"
+require_relative "phoebe/resources/data/observations/geo"
+require_relative "phoebe/resources/data/observations/geo/recent"
+require_relative "phoebe/resources/data/observations/geo/recent/notable"
+require_relative "phoebe/resources/data/observations/geo/recent/species"
+require_relative "phoebe/resources/data/observations/nearest"
+require_relative "phoebe/resources/data/observations/nearest/geo_species"
+require_relative "phoebe/resources/data/observations/recent"
+require_relative "phoebe/resources/data/observations/recent/historic"
+require_relative "phoebe/resources/data/observations/recent/notable"
+require_relative "phoebe/resources/data/observations/recent/species"
+require_relative "phoebe/resources/product"
+require_relative "phoebe/resources/product/checklist"
+require_relative "phoebe/resources/product/lists"
+require_relative "phoebe/resources/product/lists/historical"
+require_relative "phoebe/resources/product/species_list"
+require_relative "phoebe/resources/product/stats"
+require_relative "phoebe/resources/product/top100"
+require_relative "phoebe/resources/ref"
+require_relative "phoebe/resources/ref/hotspot"
+require_relative "phoebe/resources/ref/hotspot/geo"
+require_relative "phoebe/resources/ref/hotspot/info"
+require_relative "phoebe/resources/ref/region"
+require_relative "phoebe/resources/ref/region/adjacent"
+require_relative "phoebe/resources/ref/region/info"
+require_relative "phoebe/resources/ref/region/list"
+require_relative "phoebe/resources/ref/taxonomy"
+require_relative "phoebe/resources/ref/taxonomy/ebird"
+require_relative "phoebe/resources/ref/taxonomy/forms"
+require_relative "phoebe/resources/ref/taxonomy/locales"
+require_relative "phoebe/resources/ref/taxonomy/species_groups"
+require_relative "phoebe/resources/ref/taxonomy/versions"

data/manifest.yaml

@@ -0,0 +1,17 @@
+dependencies:
+  - English
+  - base64
+  - cgi
+  - date
+  - erb
+  - etc
+  - json
+  - net/http
+  - openssl
+  - pathname
+  - rbconfig
+  - securerandom
+  - set
+  - stringio
+  - time
+  - uri

data/rbi/phoebe/client.rbi

@@ -0,0 +1,55 @@
+# typed: strong
+
+module Phoebe
+  class Client < Phoebe::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES = 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
+
+    DEFAULT_INITIAL_RETRY_DELAY = T.let(0.5, Float)
+
+    DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
+
+    sig { returns(String) }
+    attr_reader :api_key
+
+    sig { returns(Phoebe::Resources::Data) }
+    attr_reader :data
+
+    sig { returns(Phoebe::Resources::Product) }
+    attr_reader :product
+
+    sig { returns(Phoebe::Resources::Ref) }
+    attr_reader :ref
+
+    # @api private
+    sig { override.returns(T::Hash[String, String]) }
+    private def auth_headers
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    sig do
+      params(
+        api_key: T.nilable(String),
+        base_url: T.nilable(String),
+        max_retries: Integer,
+        timeout: Float,
+        initial_retry_delay: Float,
+        max_retry_delay: Float
+      ).returns(T.attached_class)
+    end
+    def self.new(
+      # Defaults to `ENV["EBIRD_API_KEY"]`
+      api_key: ENV["EBIRD_API_KEY"],
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["PHOEBE_BASE_URL"]`
+      base_url: ENV["PHOEBE_BASE_URL"],
+      # Max number of retries to attempt after a failed retryable request.
+      max_retries: Phoebe::Client::DEFAULT_MAX_RETRIES,
+      timeout: Phoebe::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: Phoebe::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: Phoebe::Client::DEFAULT_MAX_RETRY_DELAY
+    )
+    end
+  end
+end

data/rbi/phoebe/errors.rbi

@@ -0,0 +1,205 @@
+# typed: strong
+
+module Phoebe
+  module Errors
+    class Error < StandardError
+      sig { returns(T.nilable(StandardError)) }
+      attr_accessor :cause
+    end
+
+    class ConversionError < Phoebe::Errors::Error
+      sig { returns(T.nilable(StandardError)) }
+      def cause
+      end
+
+      # @api private
+      sig do
+        params(
+          on: T::Class[StandardError],
+          method: Symbol,
+          target: T.anything,
+          value: T.anything,
+          cause: T.nilable(StandardError)
+        ).returns(T.attached_class)
+      end
+      def self.new(on:, method:, target:, value:, cause: nil)
+      end
+    end
+
+    class APIError < Phoebe::Errors::Error
+      sig { returns(URI::Generic) }
+      attr_accessor :url
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :status
+
+      sig { returns(T.nilable(T::Hash[String, String])) }
+      attr_accessor :headers
+
+      sig { returns(T.nilable(T.anything)) }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: T.nilable(Integer),
+          headers: T.nilable(T::Hash[String, String]),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: nil
+      )
+      end
+    end
+
+    class APIConnectionError < Phoebe::Errors::APIError
+      sig { returns(NilClass) }
+      attr_accessor :status
+
+      sig { returns(NilClass) }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Connection error."
+      )
+      end
+    end
+
+    class APITimeoutError < Phoebe::Errors::APIConnectionError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Request timed out."
+      )
+      end
+    end
+
+    class APIStatusError < Phoebe::Errors::APIError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.for(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
+      end
+
+      sig { returns(Integer) }
+      attr_accessor :status
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
+      end
+    end
+
+    class BadRequestError < Phoebe::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
+
+    class AuthenticationError < Phoebe::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
+
+    class PermissionDeniedError < Phoebe::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
+
+    class NotFoundError < Phoebe::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
+
+    class ConflictError < Phoebe::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < Phoebe::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
+
+    class RateLimitError < Phoebe::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < Phoebe::Errors::APIStatusError
+      HTTP_STATUS = T.let((500..), T::Range[Integer])
+    end
+  end
+end

data/rbi/phoebe/file_part.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module Phoebe
+  class FilePart
+    sig { returns(T.any(Pathname, StringIO, IO, String)) }
+    attr_reader :content
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :content_type
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :filename
+
+    # @api private
+    sig { returns(String) }
+    private def read
+    end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_json(*a)
+    end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_yaml(*a)
+    end
+
+    sig do
+      params(
+        content: T.any(Pathname, StringIO, IO, String),
+        filename: T.nilable(T.any(Pathname, String)),
+        content_type: T.nilable(String)
+      ).returns(T.attached_class)
+    end
+    def self.new(content, filename: nil, content_type: nil)
+    end
+  end
+end