tilda-ruby 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81e7f289cd4f261e9a7550b6b1ad5621b69204e30519704c2026260bc9aa9843
-  data.tar.gz: 76bd31c3c1b6c0e146c5b7a279f21f860738678c5b7a0e3afd1f361beb2049b8
+  metadata.gz: d49a419e74d08866bf0143341d119f6f970aeb479b426af5a74807490d95b956
+  data.tar.gz: 6d15013ccdedffa4e2de38bd36653cff897553c5fa45106937ab0d698b39dc0a
 SHA512:
-  metadata.gz: 8f53922eafa8eef06edf84a43c05a15550f01442421219eabf0462cc73767dabdcc348fea3d3de335b756386aa43cbc6a549ab6d69ac8512f07666b7928db50b
-  data.tar.gz: c19d02368bb871f273c27fa3d1d0da4ecba3d648e757b8ea21ab56eafeb64fa399b3b58bc2d45a02ba4bf4dc32fb6f372df403ee1a0c4f62ea99528a94788647
+  metadata.gz: 27e85e0270b5b4a91735dcf13ccd9ef64bec40ca3365f181d5d5ac5c7d6285d77eb95fe1981c32f3a9102344773508e03b17ee8f18f9fc275658a4a13f66a791
+  data.tar.gz: 6e126c67dbf72928db8e7a1bf215d2fe09fe7101e8b4d8354d8117db9b5ac3d16c71cf55685ecbd14292071c4806f32371286fdb4f2d02816b131cedbce986f7

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 0.1.0 (2026-02-25)
+
+Full Changelog: [v0.0.2...v0.1.0](https://github.com/Hexlet/tilda-ruby/compare/v0.0.2...v0.1.0)
+
+### Features
+
+* **api:** api update ([47ee2ad](https://github.com/Hexlet/tilda-ruby/commit/47ee2adb8d2970bc21e6f341e9bceecd0aae75e3))
+
+
+### Chores
+
+* **internal:** remove mock server code ([8167f07](https://github.com/Hexlet/tilda-ruby/commit/8167f076541164d8a4293a5114d01e71a6535368))
+* update mock server docs ([ddc83e5](https://github.com/Hexlet/tilda-ruby/commit/ddc83e5cddb26e1b0a38489a663297e22bf16d01))
+
 ## 0.0.2 (2026-02-14)
 
 Full Changelog: [v0.0.1...v0.0.2](https://github.com/Hexlet/tilda-ruby/compare/v0.0.1...v0.0.2)

data/README.md

@@ -8,6 +8,8 @@ It is generated with [Stainless](https://www.stainless.com/).
 
 Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/tilda-ruby).
 
+The REST API documentation can be found on [help-ru.tilda.cc](https://help-ru.tilda.cc/api).
+
 ## Installation
 
 To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
@@ -15,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "tilda-ruby", "~> 0.0.2"
+gem "tilda-ruby", "~> 0.1.0"
 ```
 
 <!-- x-release-please-end -->
@@ -26,13 +28,11 @@ gem "tilda-ruby", "~> 0.0.2"
 require "bundler/setup"
 require "tilda_ruby"
 
-tilda = TildaRuby::Client.new(
-  api_key: ENV["TILDA_API_KEY"] # This is the default and can be omitted
-)
+tilda = TildaRuby::Client.new(publickey: "My Publickey", secretkey: "My Secretkey")
 
-getpage = tilda.getpage.retrieve(pageid: "REPLACE_ME")
+projects = tilda.projects.list
 
-puts(getpage)
+puts(projects)
 ```
 
 ### Handling errors
@@ -41,7 +41,7 @@ When the library is unable to connect to the API, or if the API returns a non-su
 
 ```ruby
 begin
-  getpage = tilda.getpage.retrieve(pageid: "REPLACE_ME")
+  project = tilda.projects.list
 rescue TildaRuby::Errors::APIConnectionError => e
   puts("The server could not be reached")
   puts(e.cause)  # an underlying Exception, likely raised within `net/http`
@@ -84,7 +84,7 @@ tilda = TildaRuby::Client.new(
 )
 
 # Or, configure per-request:
-tilda.getpage.retrieve(pageid: "REPLACE_ME", request_options: {max_retries: 5})
+tilda.projects.list(request_options: {max_retries: 5})
 ```
 
 ### Timeouts
@@ -98,7 +98,7 @@ tilda = TildaRuby::Client.new(
 )
 
 # Or, configure per-request:
-tilda.getpage.retrieve(pageid: "REPLACE_ME", request_options: {timeout: 5})
+tilda.projects.list(request_options: {timeout: 5})
 ```
 
 On timeout, `TildaRuby::Errors::APITimeoutError` is raised.
@@ -128,9 +128,8 @@ You can send undocumented parameters to any endpoint, and read undocumented resp
 Note: the `extra_` parameters of the same name overrides the documented parameters.
 
 ```ruby
-getpage =
-  tilda.getpage.retrieve(
-    pageid: "REPLACE_ME",
+projects =
+  tilda.projects.list(
     request_options: {
       extra_query: {my_query_parameter: value},
       extra_body: {my_body_parameter: value},
@@ -138,7 +137,7 @@ getpage =
     }
   )
 
-puts(getpage[:my_undocumented_property])
+puts(projects[:my_undocumented_property])
 ```
 
 #### Undocumented request params
@@ -176,18 +175,18 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio
 You can provide typesafe request parameters like so:
 
 ```ruby
-tilda.getpage.retrieve(pageid: "REPLACE_ME")
+tilda.projects.list
 ```
 
 Or, equivalently:
 
 ```ruby
 # Hashes work, but are not typesafe:
-tilda.getpage.retrieve(pageid: "REPLACE_ME")
+tilda.projects.list
 
 # You can also splat a full Params class:
-params = TildaRuby::GetpageRetrieveParams.new(pageid: "REPLACE_ME")
-tilda.getpage.retrieve(**params)
+params = TildaRuby::ProjectListParams.new
+tilda.projects.list(**params)
 ```
 
 ## Versioning

data/lib/tilda_ruby/client.rb

@@ -15,42 +15,49 @@ module TildaRuby
     # Default max retry delay in seconds.
     DEFAULT_MAX_RETRY_DELAY = 8.0
 
+    # Tilda API public key
     # @return [String, nil]
-    attr_reader :api_key
+    attr_reader :publickey
 
-    # @return [TildaRuby::Resources::Getpage]
-    attr_reader :getpage
-
-    # @return [TildaRuby::Resources::Getpageexport]
-    attr_reader :getpageexport
-
-    # @return [TildaRuby::Resources::Getpagefull]
-    attr_reader :getpagefull
+    # Tilda API secret key
+    # @return [String, nil]
+    attr_reader :secretkey
 
-    # @return [TildaRuby::Resources::Getpagefullexport]
-    attr_reader :getpagefullexport
+    # @return [TildaRuby::Resources::Projects]
+    attr_reader :projects
 
-    # @return [TildaRuby::Resources::Getpageslist]
-    attr_reader :getpageslist
+    # @return [TildaRuby::Resources::Pages]
+    attr_reader :pages
 
-    # @return [TildaRuby::Resources::Getprojectinfo]
-    attr_reader :getprojectinfo
+    # @return [TildaRuby::Resources::Export]
+    attr_reader :export
 
-    # @return [TildaRuby::Resources::Getprojectslist]
-    attr_reader :getprojectslist
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def auth_query
+      {**public_key_auth, **secret_key_auth}
+    end
 
     # @api private
     #
     # @return [Hash{String=>String}]
-    private def auth_headers
-      return {} if @api_key.nil?
+    private def public_key_auth
+      {"publickey" => @publickey}
+    end
 
-      {"authorization" => "Bearer #{@api_key}"}
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def secret_key_auth
+      {"secretkey" => @secretkey}
     end
 
     # Creates and returns a new client for interacting with the API.
     #
-    # @param api_key [String, nil] Defaults to `ENV["TILDA_API_KEY"]`
+    # @param publickey [String, nil] Tilda API public key
+    #
+    # @param secretkey [String, nil] Tilda API secret key
     #
     # @param base_url [String, nil] Override the default base URL for the API, e.g.,
     # `"https://api.example.com/v2/"`. Defaults to `ENV["TILDA_BASE_URL"]`
@@ -63,7 +70,8 @@ module TildaRuby
     #
     # @param max_retry_delay [Float]
     def initialize(
-      api_key: ENV["TILDA_API_KEY"],
+      publickey: nil,
+      secretkey: nil,
       base_url: ENV["TILDA_BASE_URL"],
       max_retries: self.class::DEFAULT_MAX_RETRIES,
       timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
@@ -72,7 +80,8 @@ module TildaRuby
     )
       base_url ||= "https://api.tildacdn.info"
 
-      @api_key = api_key&.to_s
+      @publickey = publickey&.to_s
+      @secretkey = secretkey&.to_s
 
       super(
         base_url: base_url,
@@ -82,13 +91,9 @@ module TildaRuby
         max_retry_delay: max_retry_delay
       )
 
-      @getpage = TildaRuby::Resources::Getpage.new(client: self)
-      @getpageexport = TildaRuby::Resources::Getpageexport.new(client: self)
-      @getpagefull = TildaRuby::Resources::Getpagefull.new(client: self)
-      @getpagefullexport = TildaRuby::Resources::Getpagefullexport.new(client: self)
-      @getpageslist = TildaRuby::Resources::Getpageslist.new(client: self)
-      @getprojectinfo = TildaRuby::Resources::Getprojectinfo.new(client: self)
-      @getprojectslist = TildaRuby::Resources::Getprojectslist.new(client: self)
+      @projects = TildaRuby::Resources::Projects.new(client: self)
+      @pages = TildaRuby::Resources::Pages.new(client: self)
+      @export = TildaRuby::Resources::Export.new(client: self)
     end
   end
 end

data/lib/tilda_ruby/internal/transport/base_client.rb

@@ -218,7 +218,7 @@ module TildaRuby
         # @api private
         #
         # @return [Hash{String=>String}]
-        private def auth_headers = {}
+        private def auth_query = {}
 
         # @api private
         #
@@ -272,11 +272,10 @@ module TildaRuby
 
           path = TildaRuby::Internal::Util.interpolate_path(uninterpolated_path)
 
-          query = TildaRuby::Internal::Util.deep_merge(req[:query].to_h, opts[:extra_query].to_h)
+          query = TildaRuby::Internal::Util.deep_merge(auth_query, req[:query].to_h, opts[:extra_query].to_h)
 
           headers = TildaRuby::Internal::Util.normalized_headers(
             @headers,
-            auth_headers,
             req[:headers].to_h,
             opts[:extra_headers].to_h
           )

data/lib/tilda_ruby/internal/type/base_model.rb

@@ -438,10 +438,10 @@ module TildaRuby
         # @return [Hash{Symbol=>Object}]
         #
         # @example
-        #   # `error` is a `TildaRuby::Error`
-        #   error => {
-        #     status: status,
-        #     message: message
+        #   # `image_mapping` is a `TildaRuby::ImageMapping`
+        #   image_mapping => {
+        #     from: from,
+        #     to: to
         #   }
         def deconstruct_keys(keys)
           (keys || self.class.known_fields.keys)

data/lib/tilda_ruby/internal/type/union.rb

@@ -6,14 +6,14 @@ module TildaRuby
       # @api private
       #
       # @example
-      #   # `getpage_retrieve_response` is a `TildaRuby::Models::GetpageRetrieveResponse`
-      #   case getpage_retrieve_response
-      #   when TildaRuby::Models::GetpageRetrieveResponse::UnionMember0
-      #     puts(getpage_retrieve_response.result)
-      #   when TildaRuby::Error
-      #     puts(getpage_retrieve_response.status)
+      #   # `project_retrieve_response` is a `TildaRuby::Models::ProjectRetrieveResponse`
+      #   case project_retrieve_response
+      #   when TildaRuby::Models::ProjectRetrieveResponse::UnionMember0
+      #     puts(project_retrieve_response.result)
+      #   when TildaRuby::Models::ProjectRetrieveResponse::ErrorResponse
+      #     puts(project_retrieve_response.status)
       #   else
-      #     puts(getpage_retrieve_response)
+      #     puts(project_retrieve_response)
       #   end
       module Union
         include TildaRuby::Internal::Type::Converter

data/lib/tilda_ruby/models/css_asset.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module TildaRuby
+  module Models
+    class CssAsset < TildaRuby::Internal::Type::BaseModel
+      # @!attribute from
+      #
+      #   @return [String]
+      required :from, String
+
+      # @!attribute to
+      #
+      #   @return [String]
+      required :to, String
+
+      # @!method initialize(from:, to:)
+      #   @param from [String]
+      #   @param to [String]
+    end
+  end
+end

data/lib/tilda_ruby/models/{getpagefull_retrieve_params.rb → export_retrieve_full_params.rb}

@@ -2,8 +2,8 @@
 
 module TildaRuby
   module Models
-    # @see TildaRuby::Resources::Getpagefull#retrieve
-    class GetpagefullRetrieveParams < TildaRuby::Internal::Type::BaseModel
+    # @see TildaRuby::Resources::Export#retrieve_full
+    class ExportRetrieveFullParams < TildaRuby::Internal::Type::BaseModel
       extend TildaRuby::Internal::Type::RequestParameters::Converter
       include TildaRuby::Internal::Type::RequestParameters
 

data/lib/tilda_ruby/models/export_retrieve_full_response.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module TildaRuby
+  module Models
+    # @see TildaRuby::Resources::Export#retrieve_full
+    module ExportRetrieveFullResponse
+      extend TildaRuby::Internal::Type::Union
+
+      variant -> { TildaRuby::Models::ExportRetrieveFullResponse::UnionMember0 }
+
+      variant -> { TildaRuby::Models::ExportRetrieveFullResponse::ErrorResponse }
+
+      class UnionMember0 < TildaRuby::Internal::Type::BaseModel
+        # @!attribute result
+        #
+        #   @return [TildaRuby::Models::PageExportFull]
+        required :result, -> { TildaRuby::PageExportFull }
+
+        # @!attribute status
+        #
+        #   @return [Symbol, TildaRuby::Models::ExportRetrieveFullResponse::UnionMember0::Status]
+        required :status, enum: -> { TildaRuby::Models::ExportRetrieveFullResponse::UnionMember0::Status }
+
+        # @!method initialize(result:, status:)
+        #   @param result [TildaRuby::Models::PageExportFull]
+        #   @param status [Symbol, TildaRuby::Models::ExportRetrieveFullResponse::UnionMember0::Status]
+
+        # @see TildaRuby::Models::ExportRetrieveFullResponse::UnionMember0#status
+        module Status
+          extend TildaRuby::Internal::Type::Enum
+
+          FOUND = :FOUND
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      class ErrorResponse < TildaRuby::Internal::Type::BaseModel
+        # @!attribute status
+        #
+        #   @return [Symbol, TildaRuby::Models::ExportRetrieveFullResponse::ErrorResponse::Status]
+        required :status, enum: -> { TildaRuby::Models::ExportRetrieveFullResponse::ErrorResponse::Status }
+
+        # @!attribute message
+        #
+        #   @return [String, nil]
+        optional :message, String
+
+        # @!method initialize(status:, message: nil)
+        #   @param status [Symbol, TildaRuby::Models::ExportRetrieveFullResponse::ErrorResponse::Status]
+        #   @param message [String]
+
+        # @see TildaRuby::Models::ExportRetrieveFullResponse::ErrorResponse#status
+        module Status
+          extend TildaRuby::Internal::Type::Enum
+
+          ERROR = :ERROR
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @!method self.variants
+      #   @return [Array(TildaRuby::Models::ExportRetrieveFullResponse::UnionMember0, TildaRuby::Models::ExportRetrieveFullResponse::ErrorResponse)]
+    end
+  end
+end

data/lib/tilda_ruby/models/{getpage_retrieve_params.rb → export_retrieve_params.rb}

@@ -2,8 +2,8 @@
 
 module TildaRuby
   module Models
-    # @see TildaRuby::Resources::Getpage#retrieve
-    class GetpageRetrieveParams < TildaRuby::Internal::Type::BaseModel
+    # @see TildaRuby::Resources::Export#retrieve
+    class ExportRetrieveParams < TildaRuby::Internal::Type::BaseModel
       extend TildaRuby::Internal::Type::RequestParameters::Converter
       include TildaRuby::Internal::Type::RequestParameters
 

data/lib/tilda_ruby/models/export_retrieve_response.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module TildaRuby
+  module Models
+    # @see TildaRuby::Resources::Export#retrieve
+    module ExportRetrieveResponse
+      extend TildaRuby::Internal::Type::Union
+
+      variant -> { TildaRuby::Models::ExportRetrieveResponse::UnionMember0 }
+
+      variant -> { TildaRuby::Models::ExportRetrieveResponse::ErrorResponse }
+
+      class UnionMember0 < TildaRuby::Internal::Type::BaseModel
+        # @!attribute result
+        #
+        #   @return [TildaRuby::Models::PageExportBody]
+        required :result, -> { TildaRuby::PageExportBody }
+
+        # @!attribute status
+        #
+        #   @return [Symbol, TildaRuby::Models::ExportRetrieveResponse::UnionMember0::Status]
+        required :status, enum: -> { TildaRuby::Models::ExportRetrieveResponse::UnionMember0::Status }
+
+        # @!method initialize(result:, status:)
+        #   @param result [TildaRuby::Models::PageExportBody]
+        #   @param status [Symbol, TildaRuby::Models::ExportRetrieveResponse::UnionMember0::Status]
+
+        # @see TildaRuby::Models::ExportRetrieveResponse::UnionMember0#status
+        module Status
+          extend TildaRuby::Internal::Type::Enum
+
+          FOUND = :FOUND
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      class ErrorResponse < TildaRuby::Internal::Type::BaseModel
+        # @!attribute status
+        #
+        #   @return [Symbol, TildaRuby::Models::ExportRetrieveResponse::ErrorResponse::Status]
+        required :status, enum: -> { TildaRuby::Models::ExportRetrieveResponse::ErrorResponse::Status }
+
+        # @!attribute message
+        #
+        #   @return [String, nil]
+        optional :message, String
+
+        # @!method initialize(status:, message: nil)
+        #   @param status [Symbol, TildaRuby::Models::ExportRetrieveResponse::ErrorResponse::Status]
+        #   @param message [String]
+
+        # @see TildaRuby::Models::ExportRetrieveResponse::ErrorResponse#status
+        module Status
+          extend TildaRuby::Internal::Type::Enum
+
+          ERROR = :ERROR
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @!method self.variants
+      #   @return [Array(TildaRuby::Models::ExportRetrieveResponse::UnionMember0, TildaRuby::Models::ExportRetrieveResponse::ErrorResponse)]
+    end
+  end
+end

data/lib/tilda_ruby/models/js_asset.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module TildaRuby
+  module Models
+    class JsAsset < TildaRuby::Internal::Type::BaseModel
+      # @!attribute from
+      #
+      #   @return [String]
+      required :from, String
+
+      # @!attribute to
+      #
+      #   @return [String]
+      required :to, String
+
+      # @!attribute attrs
+      #
+      #   @return [Array<String>, nil]
+      optional :attrs, TildaRuby::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(from:, to:, attrs: nil)
+      #   @param from [String]
+      #   @param to [String]
+      #   @param attrs [Array<String>]
+    end
+  end
+end

data/lib/tilda_ruby/models/page_body.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module TildaRuby
+  module Models
+    class PageBody < TildaRuby::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute alias_
+      #
+      #   @return [String]
+      required :alias_, String, api_name: :alias
+
+      # @!attribute date
+      #
+      #   @return [String]
+      required :date, String
+
+      # @!attribute descr
+      #
+      #   @return [String]
+      required :descr, String
+
+      # @!attribute featureimg
+      #
+      #   @return [String]
+      required :featureimg, String
+
+      # @!attribute filename
+      #
+      #   @return [String]
+      required :filename, String
+
+      # @!attribute html
+      #
+      #   @return [String]
+      required :html, String
+
+      # @!attribute img
+      #
+      #   @return [String]
+      required :img, String
+
+      # @!attribute projectid
+      #
+      #   @return [String]
+      required :projectid, String
+
+      # @!attribute published
+      #
+      #   @return [String]
+      required :published, String
+
+      # @!attribute sort
+      #
+      #   @return [String]
+      required :sort, String
+
+      # @!attribute title
+      #
+      #   @return [String]
+      required :title, String
+
+      # @!attribute css
+      #
+      #   @return [Array<String>, nil]
+      optional :css, TildaRuby::Internal::Type::ArrayOf[String]
+
+      # @!attribute js
+      #
+      #   @return [Array<String>, nil]
+      optional :js, TildaRuby::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(id:, alias_:, date:, descr:, featureimg:, filename:, html:, img:, projectid:, published:, sort:, title:, css: nil, js: nil)
+      #   @param id [String]
+      #   @param alias_ [String]
+      #   @param date [String]
+      #   @param descr [String]
+      #   @param featureimg [String]
+      #   @param filename [String]
+      #   @param html [String]
+      #   @param img [String]
+      #   @param projectid [String]
+      #   @param published [String]
+      #   @param sort [String]
+      #   @param title [String]
+      #   @param css [Array<String>]
+      #   @param js [Array<String>]
+    end
+  end
+end