galaxy-ruby 0.2.0

data/lib/galaxy-ruby/models/planet_delte_image_params.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ScalarGalaxy
+  module Models
+    # @see ScalarGalaxy::Resources::Planets#delte_image
+    class PlanetDelteImageParams < ScalarGalaxy::Internal::Type::BaseModel
+      extend ScalarGalaxy::Internal::Type::RequestParameters::Converter
+      include ScalarGalaxy::Internal::Type::RequestParameters
+
+      # @!attribute planet_id
+      #
+      #   @return [Integer]
+      required :planet_id, Integer
+
+      # @!attribute image
+      #   The image file to upload
+      #
+      #   @return [Pathname, StringIO, IO, String, ScalarGalaxy::FilePart, nil]
+      optional :image, ScalarGalaxy::Internal::Type::FileInput
+
+      # @!method initialize(planet_id:, image: nil, request_options: {})
+      #   @param planet_id [Integer]
+      #
+      #   @param image [Pathname, StringIO, IO, String, ScalarGalaxy::FilePart] The image file to upload
+      #
+      #   @param request_options [ScalarGalaxy::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/galaxy-ruby/models/planet_delte_image_response.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module ScalarGalaxy
+  module Models
+    # @see ScalarGalaxy::Resources::Planets#delte_image
+    class PlanetDelteImageResponse < ScalarGalaxy::Internal::Type::BaseModel
+      # @!attribute file_size
+      #   Size of the uploaded image in bytes
+      #
+      #   @return [Integer, nil]
+      optional :file_size, Integer, api_name: :fileSize
+
+      # @!attribute image_url
+      #   The URL where the uploaded image can be accessed
+      #
+      #   @return [String, nil]
+      optional :image_url, String, api_name: :imageUrl
+
+      # @!attribute message
+      #
+      #   @return [String, nil]
+      optional :message, String
+
+      # @!attribute mime_type
+      #   The content type of the uploaded image
+      #
+      #   @return [String, nil]
+      optional :mime_type, String, api_name: :mimeType
+
+      # @!attribute uploaded_at
+      #   Timestamp when the image was uploaded
+      #
+      #   @return [Time, nil]
+      optional :uploaded_at, Time, api_name: :uploadedAt
+
+      # @!method initialize(file_size: nil, image_url: nil, message: nil, mime_type: nil, uploaded_at: nil)
+      #   @param file_size [Integer] Size of the uploaded image in bytes
+      #
+      #   @param image_url [String] The URL where the uploaded image can be accessed
+      #
+      #   @param message [String]
+      #
+      #   @param mime_type [String] The content type of the uploaded image
+      #
+      #   @param uploaded_at [Time] Timestamp when the image was uploaded
+    end
+  end
+end

data/lib/galaxy-ruby/models/planet_list_all_data_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ScalarGalaxy
+  module Models
+    # @see ScalarGalaxy::Resources::Planets#list_all_data
+    class PlanetListAllDataParams < ScalarGalaxy::Internal::Type::BaseModel
+      extend ScalarGalaxy::Internal::Type::RequestParameters::Converter
+      include ScalarGalaxy::Internal::Type::RequestParameters
+
+      # @!attribute limit
+      #   The number of items to return
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute offset
+      #   The number of items to skip before starting to collect the result set
+      #
+      #   @return [Integer, nil]
+      optional :offset, Integer
+
+      # @!method initialize(limit: nil, offset: nil, request_options: {})
+      #   @param limit [Integer] The number of items to return
+      #
+      #   @param offset [Integer] The number of items to skip before starting to collect the result set
+      #
+      #   @param request_options [ScalarGalaxy::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/galaxy-ruby/models/planet_list_all_data_response.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module ScalarGalaxy
+  module Models
+    # @see ScalarGalaxy::Resources::Planets#list_all_data
+    class PlanetListAllDataResponse < ScalarGalaxy::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<Object>, nil]
+      optional :data, ScalarGalaxy::Internal::Type::ArrayOf[ScalarGalaxy::Internal::Type::Unknown]
+
+      # @!attribute meta
+      #
+      #   @return [ScalarGalaxy::Models::PlanetListAllDataResponse::Meta, nil]
+      optional :meta, -> { ScalarGalaxy::Models::PlanetListAllDataResponse::Meta }
+
+      # @!method initialize(data: nil, meta: nil)
+      #   @param data [Array<Object>]
+      #   @param meta [ScalarGalaxy::Models::PlanetListAllDataResponse::Meta]
+
+      # @see ScalarGalaxy::Models::PlanetListAllDataResponse#meta
+      class Meta < ScalarGalaxy::Internal::Type::BaseModel
+        # @!attribute limit
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!attribute next_
+        #
+        #   @return [String, nil]
+        optional :next_, String, api_name: :next, nil?: true
+
+        # @!attribute offset
+        #
+        #   @return [Integer, nil]
+        optional :offset, Integer
+
+        # @!attribute total
+        #
+        #   @return [Integer, nil]
+        optional :total, Integer
+
+        # @!method initialize(limit: nil, next_: nil, offset: nil, total: nil)
+        #   @param limit [Integer]
+        #   @param next_ [String, nil]
+        #   @param offset [Integer]
+        #   @param total [Integer]
+      end
+    end
+  end
+end

data/lib/galaxy-ruby/models/planet_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ScalarGalaxy
+  module Models
+    # @see ScalarGalaxy::Resources::Planets#retrieve
+    class PlanetRetrieveParams < ScalarGalaxy::Internal::Type::BaseModel
+      extend ScalarGalaxy::Internal::Type::RequestParameters::Converter
+      include ScalarGalaxy::Internal::Type::RequestParameters
+
+      # @!attribute planet_id
+      #
+      #   @return [Integer]
+      required :planet_id, Integer
+
+      # @!method initialize(planet_id:, request_options: {})
+      #   @param planet_id [Integer]
+      #   @param request_options [ScalarGalaxy::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/galaxy-ruby/models/planet_update_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ScalarGalaxy
+  module Models
+    # @see ScalarGalaxy::Resources::Planets#update
+    class PlanetUpdateParams < ScalarGalaxy::Models::Planet
+      extend ScalarGalaxy::Internal::Type::RequestParameters::Converter
+      include ScalarGalaxy::Internal::Type::RequestParameters
+
+      # @!attribute planet_id
+      #
+      #   @return [Integer]
+      required :planet_id, Integer
+
+      # @!method initialize(planet_id:, request_options: {})
+      #   @param planet_id [Integer]
+      #   @param request_options [ScalarGalaxy::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/galaxy-ruby/models/unwrap_webhook_event.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ScalarGalaxy
+  module Models
+    module UnwrapWebhookEvent
+      extend ScalarGalaxy::Internal::Type::Union
+
+      variant -> { ScalarGalaxy::NewPlanetWebhookEvent }
+
+      # @!method self.variants
+      #   @return [Array(ScalarGalaxy::Models::NewPlanetWebhookEvent)]
+    end
+  end
+end

data/lib/galaxy-ruby/models/user.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ScalarGalaxy
+  module Models
+    # @see ScalarGalaxy::Resources::Authentication#create_user
+    class User < ScalarGalaxy::Internal::Type::BaseModel
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      response_only do
+        # @!attribute id
+        #
+        #   @return [Integer, nil]
+        optional :id, Integer
+      end
+
+      # @!method initialize(id: nil, name: nil)
+      #   A user
+      #
+      #   @param id [Integer]
+      #   @param name [String]
+    end
+  end
+end

data/lib/galaxy-ruby/models/webhook_unwrap_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ScalarGalaxy
+  module Models
+    # @see ScalarGalaxy::Resources::Webhooks#unwrap
+    class WebhookUnwrapParams < ScalarGalaxy::Internal::Type::BaseModel
+      extend ScalarGalaxy::Internal::Type::RequestParameters::Converter
+      include ScalarGalaxy::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [ScalarGalaxy::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/galaxy-ruby/models.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module ScalarGalaxy
+  [ScalarGalaxy::Internal::Type::BaseModel, *ScalarGalaxy::Internal::Type::BaseModel.subclasses].each do |cls|
+    cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, ScalarGalaxy::Internal::AnyHash) } }
+  end
+
+  ScalarGalaxy::Internal::Util
+    .walk_namespaces(ScalarGalaxy::Models)
+    .each do |mod|
+      case mod
+      in ScalarGalaxy::Internal::Type::Enum | ScalarGalaxy::Internal::Type::Union
+        mod.constants.each do |name|
+          case mod.const_get(name)
+          in true | false
+            mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } }
+            mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
+          in Integer
+            mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } }
+            mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
+          in Float
+            mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } }
+            mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
+          in Symbol
+            mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } }
+            mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
+          else
+          end
+        end
+      else
+      end
+    end
+
+  ScalarGalaxy::Internal::Util
+    .walk_namespaces(ScalarGalaxy::Models)
+    .lazy
+    .grep(ScalarGalaxy::Internal::Type::Union)
+    .each do |mod|
+      const = :Variants
+      next if mod.sorbet_constant_defined?(const)
+
+      mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
+    end
+
+  AuthenticationCreateTokenParams = ScalarGalaxy::Models::AuthenticationCreateTokenParams
+
+  AuthenticationCreateUserParams = ScalarGalaxy::Models::AuthenticationCreateUserParams
+
+  AuthenticationListMeParams = ScalarGalaxy::Models::AuthenticationListMeParams
+
+  CelestialBody = ScalarGalaxy::Models::CelestialBody
+
+  CelestialBodyCreateParams = ScalarGalaxy::Models::CelestialBodyCreateParams
+
+  Credentials = ScalarGalaxy::Models::Credentials
+
+  NewPlanetWebhookEvent = ScalarGalaxy::Models::NewPlanetWebhookEvent
+
+  Planet = ScalarGalaxy::Models::Planet
+
+  PlanetCreateParams = ScalarGalaxy::Models::PlanetCreateParams
+
+  PlanetDeleteParams = ScalarGalaxy::Models::PlanetDeleteParams
+
+  PlanetDelteImageParams = ScalarGalaxy::Models::PlanetDelteImageParams
+
+  PlanetListAllDataParams = ScalarGalaxy::Models::PlanetListAllDataParams
+
+  PlanetRetrieveParams = ScalarGalaxy::Models::PlanetRetrieveParams
+
+  PlanetUpdateParams = ScalarGalaxy::Models::PlanetUpdateParams
+
+  UnwrapWebhookEvent = ScalarGalaxy::Models::UnwrapWebhookEvent
+
+  User = ScalarGalaxy::Models::User
+
+  WebhookUnwrapParams = ScalarGalaxy::Models::WebhookUnwrapParams
+end

data/lib/galaxy-ruby/request_options.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module ScalarGalaxy
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < ScalarGalaxy::Internal::Type::BaseModel
+    # @api private
+    #
+    # @param opts [ScalarGalaxy::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in ScalarGalaxy::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #   sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #   `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, ScalarGalaxy::Internal::Type::HashOf[ScalarGalaxy::Internal::Type::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #   `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, ScalarGalaxy::Internal::Type::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #   generated as part of the normal request.
+    #
+    #   @return [Object, nil]
+    optional :extra_body, ScalarGalaxy::Internal::Type::HashOf[ScalarGalaxy::Internal::Type::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
+
+    define_sorbet_constant!(:OrHash) do
+      T.type_alias { T.any(ScalarGalaxy::RequestOptions, ScalarGalaxy::Internal::AnyHash) }
+    end
+  end
+end

data/lib/galaxy-ruby/resources/authentication.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module ScalarGalaxy
+  module Resources
+    # Some endpoints are public, but some require authentication. We provide all the
+    # required endpoints to create an account and authorize yourself.
+    class Authentication
+      # Yeah, this is the boring security stuff. Just get your super secret token and
+      # move on.
+      #
+      # @overload create_token(email:, password:, request_options: {})
+      #
+      # @param email [String]
+      # @param password [String]
+      # @param request_options [ScalarGalaxy::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ScalarGalaxy::Models::AuthenticationCreateTokenResponse]
+      #
+      # @see ScalarGalaxy::Models::AuthenticationCreateTokenParams
+      def create_token(params)
+        parsed, options = ScalarGalaxy::AuthenticationCreateTokenParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "auth/token",
+          body: parsed,
+          model: ScalarGalaxy::Models::AuthenticationCreateTokenResponse,
+          options: options
+        )
+      end
+
+      # Time to create a user account, eh?
+      #
+      # @overload create_user(email:, password:, name: nil, request_options: {})
+      #
+      # @param email [String]
+      # @param password [String]
+      # @param name [String]
+      # @param request_options [ScalarGalaxy::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ScalarGalaxy::Models::User]
+      #
+      # @see ScalarGalaxy::Models::AuthenticationCreateUserParams
+      def create_user(params)
+        parsed, options = ScalarGalaxy::AuthenticationCreateUserParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "user/signup",
+          body: parsed,
+          model: ScalarGalaxy::User,
+          options: options
+        )
+      end
+
+      # Find yourself they say. That's what you can do here.
+      #
+      # @overload list_me(request_options: {})
+      #
+      # @param request_options [ScalarGalaxy::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ScalarGalaxy::Models::User]
+      #
+      # @see ScalarGalaxy::Models::AuthenticationListMeParams
+      def list_me(params = {})
+        @client.request(
+          method: :get,
+          path: "me",
+          model: ScalarGalaxy::User,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [ScalarGalaxy::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/galaxy-ruby/resources/celestial_bodies.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ScalarGalaxy
+  module Resources
+    # Celestial bodies are the planets and satellites in the Scalar Galaxy.
+    class CelestialBodies
+      # Stars, moons, comets, the occasional rogue asteroid — if it glows or drifts
+      # through the void, you can add it here.
+      #
+      # @overload create(celestial_body:, request_options: {})
+      #
+      # @param celestial_body [ScalarGalaxy::Models::Planet, ScalarGalaxy::Models::CelestialBody::Satellite]
+      # @param request_options [ScalarGalaxy::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ScalarGalaxy::Models::Planet, ScalarGalaxy::Models::CelestialBody::Satellite]
+      #
+      # @see ScalarGalaxy::Models::CelestialBodyCreateParams
+      def create(params)
+        parsed, options = ScalarGalaxy::CelestialBodyCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "celestial-bodies",
+          body: parsed[:celestial_body],
+          model: ScalarGalaxy::CelestialBody,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [ScalarGalaxy::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end