brand.dev 0.0.1.pre.alpha.0

data/lib/brand_dev/resources/brand.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Resources
+    class Brand
+      # Retrieve brand data by domain
+      #
+      # @overload retrieve(domain:, force_language: nil, request_options: {})
+      #
+      # @param domain [String] Domain name to retrieve brand data for
+      #
+      # @param force_language [Symbol, BrandDev::Models::BrandRetrieveParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data
+      #
+      # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [BrandDev::Models::BrandRetrieveResponse]
+      #
+      # @see BrandDev::Models::BrandRetrieveParams
+      def retrieve(params)
+        parsed, options = BrandDev::BrandRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "brand/retrieve",
+          query: parsed,
+          model: BrandDev::Models::BrandRetrieveResponse,
+          options: options
+        )
+      end
+
+      # Endpoint specially designed for platforms that want to identify transaction data
+      # by the transaction title.
+      #
+      # @overload identify_from_transaction(transaction_info:, request_options: {})
+      #
+      # @param transaction_info [String] Transaction information to identify the brand
+      #
+      # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [BrandDev::Models::BrandIdentifyFromTransactionResponse]
+      #
+      # @see BrandDev::Models::BrandIdentifyFromTransactionParams
+      def identify_from_transaction(params)
+        parsed, options = BrandDev::BrandIdentifyFromTransactionParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "brand/transaction_identifier",
+          query: parsed,
+          model: BrandDev::Models::BrandIdentifyFromTransactionResponse,
+          options: options
+        )
+      end
+
+      # Retrieve brand data by stock ticker (e.g. AAPL, TSLA, etc.)
+      #
+      # @overload retrieve_by_ticker(ticker:, request_options: {})
+      #
+      # @param ticker [String] Stock ticker symbol to retrieve brand data for (e.g. AAPL, TSLA, etc.)
+      #
+      # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [BrandDev::Models::BrandRetrieveByTickerResponse]
+      #
+      # @see BrandDev::Models::BrandRetrieveByTickerParams
+      def retrieve_by_ticker(params)
+        parsed, options = BrandDev::BrandRetrieveByTickerParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "brand/retrieve-by-ticker",
+          query: parsed,
+          model: BrandDev::Models::BrandRetrieveByTickerResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {BrandDev::Models::BrandRetrieveNaicsParams} for more details.
+      #
+      # Endpoint to classify any brand into a 2022 NAICS code.
+      #
+      # @overload retrieve_naics(input:, request_options: {})
+      #
+      # @param input [String] Brand domain or title to retrieve NAICS code for. If a valid domain is provided
+      #
+      # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [BrandDev::Models::BrandRetrieveNaicsResponse]
+      #
+      # @see BrandDev::Models::BrandRetrieveNaicsParams
+      def retrieve_naics(params)
+        parsed, options = BrandDev::BrandRetrieveNaicsParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "brand/naics",
+          query: parsed,
+          model: BrandDev::Models::BrandRetrieveNaicsResponse,
+          options: options
+        )
+      end
+
+      # Search brands by query
+      #
+      # @overload search(query:, request_options: {})
+      #
+      # @param query [String] Query string to search brands
+      #
+      # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<BrandDev::Models::BrandSearchResponseItem>]
+      #
+      # @see BrandDev::Models::BrandSearchParams
+      def search(params)
+        parsed, options = BrandDev::BrandSearchParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "brand/search",
+          query: parsed,
+          model: BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandSearchResponseItem],
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [BrandDev::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/brand_dev/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BrandDev
+  VERSION = "0.0.1.pre.alpha.0"
+end

data/lib/brand_dev.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# Standard libraries.
+# rubocop:disable Lint/RedundantRequireStatement
+require "English"
+require "cgi"
+require "date"
+require "erb"
+require "etc"
+require "json"
+require "net/http"
+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 "brand_dev/version"
+require_relative "brand_dev/internal/util"
+require_relative "brand_dev/internal/type/converter"
+require_relative "brand_dev/internal/type/unknown"
+require_relative "brand_dev/internal/type/boolean"
+require_relative "brand_dev/internal/type/file_input"
+require_relative "brand_dev/internal/type/enum"
+require_relative "brand_dev/internal/type/union"
+require_relative "brand_dev/internal/type/array_of"
+require_relative "brand_dev/internal/type/hash_of"
+require_relative "brand_dev/internal/type/base_model"
+require_relative "brand_dev/internal/type/base_page"
+require_relative "brand_dev/internal/type/request_parameters"
+require_relative "brand_dev/internal"
+require_relative "brand_dev/request_options"
+require_relative "brand_dev/file_part"
+require_relative "brand_dev/errors"
+require_relative "brand_dev/internal/transport/base_client"
+require_relative "brand_dev/internal/transport/pooled_net_requester"
+require_relative "brand_dev/client"
+require_relative "brand_dev/models/brand_identify_from_transaction_params"
+require_relative "brand_dev/models/brand_identify_from_transaction_response"
+require_relative "brand_dev/models/brand_retrieve_by_ticker_params"
+require_relative "brand_dev/models/brand_retrieve_by_ticker_response"
+require_relative "brand_dev/models/brand_retrieve_naics_params"
+require_relative "brand_dev/models/brand_retrieve_naics_response"
+require_relative "brand_dev/models/brand_retrieve_params"
+require_relative "brand_dev/models/brand_retrieve_response"
+require_relative "brand_dev/models/brand_search_params"
+require_relative "brand_dev/models/brand_search_response"
+require_relative "brand_dev/models"
+require_relative "brand_dev/resources/brand"

data/manifest.yaml

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

data/rbi/brand_dev/client.rbi

@@ -0,0 +1,49 @@
+# typed: strong
+
+module BrandDev
+  class Client < BrandDev::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(BrandDev::Resources::Brand) }
+    attr_reader :brand
+
+    # @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["BRAND_DEV_API_KEY"]`
+      api_key: ENV["BRAND_DEV_API_KEY"],
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["BRAND_DEV_BASE_URL"]`
+      base_url: ENV["BRAND_DEV_BASE_URL"],
+      # Max number of retries to attempt after a failed retryable request.
+      max_retries: BrandDev::Client::DEFAULT_MAX_RETRIES,
+      timeout: BrandDev::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: BrandDev::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: BrandDev::Client::DEFAULT_MAX_RETRY_DELAY
+    )
+    end
+  end
+end

data/rbi/brand_dev/errors.rbi

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

data/rbi/brand_dev/file_part.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module BrandDev
+  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(String),
+        content_type: T.nilable(String)
+      ).returns(T.attached_class)
+    end
+    def self.new(content, filename: nil, content_type: nil)
+    end
+  end
+end