notion_ruby_mapping 0.4.1 → 0.5.0

data/lib/notion_ruby_mapping/blocks/callout_block.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class CalloutBlock < Block
+    # @param [RichTextArray, String, Array<String>, RichTextObject, Array<RichTextObject>] text_info
+    # @param [String] emoji
+    # @param [String] file_url
+    # @param [String] color
+    # @param [NotionRubyMapping::Block, Array<NotionRubyMapping::Block>, nil] sub_blocks
+    def initialize(text_info = nil, emoji: nil, file_url: nil, sub_blocks: nil, color: "default", json: nil, id: nil,
+                   parent: nil)
+      super(json: json, id: id, parent: parent)
+      if @json
+        decode_block_rich_text_array
+        decode_color
+      else
+        rich_text_array_and_color "rich_text", text_info, color
+        @emoji = EmojiObject.emoji_object emoji if emoji
+        @file_object = FileObject.file_object file_url if file_url
+        add_sub_blocks sub_blocks
+      end
+      @can_have_children = true
+    end
+
+    # @see https://www.notion.so/hkob/CalloutBlock-0eb8b64bea664bc89fad706a866a6e26#db689d47cbcc44359a5ade17ca754cdd
+    # @see https://www.notion.so/hkob/CalloutBlock-0eb8b64bea664bc89fad706a866a6e26#4314e4d50617485f8d0fc3505c5b3e9b
+    attr_reader :color, :rich_text_array
+
+    # @param [Boolean] not_update false when update
+    # @return [Hash{String (frozen)->Hash}]
+    def block_json(not_update: true)
+      ans = super
+      ans[type] = @rich_text_array.update_property_schema_json not_update
+      ans[type]["color"] = @color
+      ans[type]["icon"] = @emoji.property_values_json if @emoji
+      ans[type]["icon"] = @file_object.property_values_json if @file_object
+      ans[type]["children"] = @sub_blocks.map(&:block_json) if @sub_blocks
+      ans
+    end
+
+    # @param [String] new_color
+    # @see https://www.notion.so/hkob/CalloutBlock-0eb8b64bea664bc89fad706a866a6e26#b3598e385c2d4a23ada506441a7f0f32
+    def color=(new_color)
+      @color = new_color
+      @payload.add_update_block_key "color"
+    end
+
+    # @return [String, nil]
+    # @see https://www.notion.so/hkob/CalloutBlock-0eb8b64bea664bc89fad706a866a6e26#611496b7fd96499882fad138ef248b04
+    def emoji
+      @emoji&.emoji
+    end
+
+    # @param [String] emoji
+    # @see https://www.notion.so/hkob/CalloutBlock-0eb8b64bea664bc89fad706a866a6e26#0bd030c398184f94b819358830c2e26d
+    def emoji=(emoji)
+      @emoji = EmojiObject.emoji_object emoji
+      @file_object = nil
+      @payload.add_update_block_key "icon"
+    end
+
+    # @return [String]
+    # @see https://www.notion.so/hkob/CalloutBlock-0eb8b64bea664bc89fad706a866a6e26#57a8fc88f2ee49f7963942ad30cbca04
+    def file_url
+      @file_object&.url
+    end
+
+    # @param [String] url
+    # @see https://www.notion.so/hkob/CalloutBlock-0eb8b64bea664bc89fad706a866a6e26#041dd676bbfb442699229486fd30370a
+    def file_url=(url)
+      @file_object = FileObject.file_object url
+      @emoji = nil
+      @payload.add_update_block_key "icon"
+    end
+
+    # @return [String (frozen)]
+    def type
+      "callout"
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/child_base_block.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class ChildBaseBlock < Block
+    def initialize(json: nil, id: nil, parent: nil)
+      super
+      @title = @json[type]["title"]
+      @can_append = false
+      @can_append = false
+    end
+
+    # @param [Boolean] not_update false when update
+    # @return [Hash{String (frozen)->Hash}]
+    def block_json(not_update: true)
+      ans = super
+      ans[type] = {"title" => @title}
+      ans
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/child_database_block.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class ChildDatabaseBlock < ChildBaseBlock
+    # @return [String (frozen)]
+    def type
+      "child_database"
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/child_page_block.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class ChildPageBlock < ChildBaseBlock
+    # @return [String (frozen)]
+    def type
+      "child_page"
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/code_block.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class CodeBlock < Block
+    # @param [RichTextArray, String, Array<String>, RichTextObject, Array<RichTextObject>] text_info
+    # @param [RichTextArray, String, Array<String>, RichTextObject, Array<RichTextObject>] caption
+    # @param [String] language
+    # @see https://www.notion.so/hkob/CodeBlock-3a25869f60394b3f902c1ed0bf5ce1c9#7777d9b785234278876d7bf6842dd8a2
+    def initialize(text_info = nil, caption: [], language: "shell", json: nil, id: nil, parent: nil)
+      super(json: json, id: id, parent: parent)
+      if @json
+        decode_block_rich_text_array
+        decode_block_caption
+        @language = json[type]["language"] || "shell"
+      else
+        rich_text_array_and_color "rich_text", text_info
+        @caption = RichTextArray.rich_text_array "caption", caption
+        @language = language
+      end
+    end
+
+    # @see https://www.notion.so/hkob/CodeBlock-3a25869f60394b3f902c1ed0bf5ce1c9#282b6ca100a14841b849ab24519647f3
+    # @see https://www.notion.so/hkob/CodeBlock-3a25869f60394b3f902c1ed0bf5ce1c9#6321da9df4f04ccdbddddcd93b1afbe2
+    # @see https://www.notion.so/hkob/CodeBlock-3a25869f60394b3f902c1ed0bf5ce1c9#9de0cd82fb594a3a8d12095d9e21ea8d
+    attr_reader :caption, :language, :rich_text_array
+
+    # @param [Boolean] not_update false when update
+    # @return [Hash{String (frozen)->Hash}]
+    def block_json(not_update: true)
+      ans = super
+      ans[type] = @rich_text_array.update_property_schema_json(not_update).merge(
+        @caption.update_property_schema_json(not_update),
+      )
+      ans[type]["language"] = @language
+      ans
+    end
+
+    # @param [String] new_language
+    def language=(new_language)
+      @language = new_language
+      @payload.add_update_block_key "language"
+    end
+
+    # @return [String (frozen)]
+    def type
+      "code"
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/column_block.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class ColumnBlock < Block
+    # @param [NotionRubyMapping::Block, Array<NotionRubyMapping::Block>, nil] sub_blocks
+    # @see https://www.notion.so/hkob/ColumnBlock-91cb314fc6594ff6b0c77c1eae6c7fab#4b4486cdf26a474eab1c92f9c6ea8a91
+    def initialize(sub_blocks = [], json: nil, id: nil, parent: nil)
+      super(json: json, id: id, parent: parent)
+      add_sub_blocks sub_blocks unless json
+      @can_have_children = true
+      @can_append = false
+    end
+
+    # @return [String (frozen)]
+    def type
+      "column"
+    end
+
+    # @param [Boolean] not_update false when update
+    # @return [Hash{String (frozen)->Hash}]
+    def block_json(not_update: true)
+      ans = super
+      ans[type] = {}
+      ans[type]["children"] = @sub_blocks.map(&:block_json) if @sub_blocks
+      ans
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/column_list_block.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class ColumnListBlock < Block
+    # @param [Array<Array<NotionRubyMapping::Block, Array<NotionRubyMapping::Block>>>] array_of_sub_blocks
+    # @return [NotionRubyMapping::Block]
+    # @see https://www.notion.so/hkob/ColumnListBlock-78d12860099f4e7d89b65c446bd314ba#6e1c97e1b5da45038232f43994e4d7e5
+    def initialize(array_of_sub_blocks = [], json: nil, id: nil, parent: nil)
+      super(json: json, id: id, parent: parent)
+      unless json
+        raise StandardError, "The column_list must have at least 2 columns." if array_of_sub_blocks.count < 2
+
+        @columns = array_of_sub_blocks.map { |sub_blocks| ColumnBlock.new(sub_blocks) }
+      end
+      @can_have_children = true
+    end
+
+    # @return [String (frozen)]
+    def type
+      "column_list"
+    end
+
+    # @param [Boolean] not_update false when update
+    # @return [Hash{String (frozen)->Hash}]
+    def block_json(not_update: true)
+      ans = super
+      ans[type] = {}
+      ans[type]["children"] = @columns.map(&:block_json) if @columns
+      ans
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/database.rb

@@ -17,6 +17,12 @@ module NotionRubyMapping
       end
     end
 
+    # @param [String] key
+    # @return [NotionRubyMapping::PropertyCache, Hash] obtained Page value or PropertyCache
+    def [](key)
+      get key
+    end
+
     # @param [Class] klass
     # @param [String] title
     # @return [NotionRubyMapping::Property]
@@ -76,7 +82,7 @@ module NotionRubyMapping
       if dry_run
         Base.dry_run_script :post, @nc.query_database_path(@id), query.query_json
       else
-        response = @nc.database_query @id, query
+        response = @nc.database_query_request @id, query
         List.new json: response, database: self, query: query
       end
     end

data/lib/notion_ruby_mapping/blocks/divider_block.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class DividerBlock < Block
+    # @param [Boolean] not_update false when update
+    # @return [Hash{String (frozen)->Hash}]
+    def block_json(not_update: true)
+      ans = super
+      ans[type] = {}
+      ans
+    end
+
+    # @return [String (frozen)]
+    def type
+      "divider"
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/embed_block.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class EmbedBlock < UrlCaptionBaseBlock
+    # @return [String (frozen)]
+    def type
+      "embed"
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/equation_block.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class EquationBlock < Block
+    # @param [String, NotionRubyMapping::EquationObject] expression
+    # @see https://www.notion.so/hkob/EquationBlock-df0f823dc5ac41b798052f161dd6540c#cfcd2ceb77194c0e915500b429e8b91b
+    def initialize(expression = nil, json: nil, id: nil, parent: nil)
+      super(json: json, id: id, parent: parent)
+      @equation_object = if @json
+                           EquationObject.equation_object @json[type]["expression"]
+                         else
+                           EquationObject.equation_object expression
+                         end
+    end
+
+    # @param [Boolean] not_update false when update
+    # @return [Hash{String (frozen)->Hash}]
+    def block_json(not_update: true)
+      ans = super
+      ans[type] = {"expression" => @equation_object.expression}
+      ans
+    end
+
+    # @return [String]
+    # @see https://www.notion.so/hkob/EquationBlock-df0f823dc5ac41b798052f161dd6540c#da3e9d93ffac4d84854be3342b4bf3fe
+    def expression
+      @equation_object&.expression
+    end
+
+    # @param [String] new_expression
+    # @see https://www.notion.so/hkob/EquationBlock-df0f823dc5ac41b798052f161dd6540c#f05e3b2c82914cea9f05e9e6644647e1
+    def expression=(new_expression)
+      @equation_object = EquationObject.equation_object new_expression
+      @payload.add_update_block_key "expression"
+    end
+
+    # @return [String (frozen)]
+    def type
+      "equation"
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/file_base_block.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class FileBaseBlock < Block
+    # @param [String, nil] url
+    # @param [RichTextArray, String, Array<String>, RichTextObject, Array<RichTextObject>, nil] caption
+    # @see https://www.notion.so/hkob/FileBlock-08f2aa6948364d00b92beacaac9a619c#ace53d2e6ff2404f937179ae1e966e98
+    # @see https://www.notion.so/hkob/ImageBlock-806b3d2a9a2c4bf5a5aca6e3fbc8a7e2#4cb790b8b5c847acab4341d55e4fa66a
+    def initialize(url = nil, caption: [], json: nil, id: nil, parent: nil)
+      super(json: json, id: id, parent: parent)
+      if @json
+        @file_object = FileObject.new json: @json[type]
+        decode_block_caption
+        @can_append = @file_object.external?
+      else
+        @file_object = FileObject.file_object url
+        @caption = RichTextArray.rich_text_array "caption", caption
+      end
+    end
+
+    # @see https://www.notion.so/hkob/FileBlock-08f2aa6948364d00b92beacaac9a619c#158487a7e1644fae8778dcff59869356
+    # @see https://www.notion.so/hkob/ImageBlock-806b3d2a9a2c4bf5a5aca6e3fbc8a7e2#19a4aa3e06514bbe84be9d3b8a45a20f
+    attr_reader :caption
+
+    # @param [Boolean] not_update false when update
+    # @return [Hash{String (frozen)->Hash}]
+    def block_json(not_update: true)
+      ans = super
+      ans[type] = @file_object.property_values_json
+      ans[type].merge! @caption.update_property_schema_json(not_update) if @caption
+      ans
+    end
+
+    # @return [String]
+    # @see https://www.notion.so/hkob/FileBlock-08f2aa6948364d00b92beacaac9a619c#d3e7d31b7b274955aa7603163867fa57
+    # @see https://www.notion.so/hkob/ImageBlock-806b3d2a9a2c4bf5a5aca6e3fbc8a7e2#01e1883119f14c5f9f7f6823793e72ec
+    def url
+      @file_object&.url
+    end
+
+    # @param [String] url
+    # @see https://www.notion.so/hkob/FileBlock-08f2aa6948364d00b92beacaac9a619c#23497b8eb2214c45b3d5881796f984cb
+    # @see https://www.notion.so/hkob/ImageBlock-806b3d2a9a2c4bf5a5aca6e3fbc8a7e2#61598d260b6140f2a359f7d22ea2548a
+    def url=(url)
+      @file_object.url = url
+      @payload.add_update_block_key "external"
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/file_block.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class FileBlock < FileBaseBlock
+    # @return [String (frozen)]
+    def type
+      "file"
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/heading1_block.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class Heading1Block < TextSubBlockColorBaseBlock
+    # @param [RichTextArray, String, Array<String>, RichTextObject, Array<RichTextObject>, nil] text_info
+    # @param [String] color
+    def initialize(text_info = nil, color: nil, json: nil, id: nil, parent: nil)
+      super(text_info, color: color, json: json, id: id, parent: parent)
+      @can_have_children = false
+    end
+
+    # @return [String (frozen)]
+    def type
+      "heading_1"
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/heading2_block.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class Heading2Block < TextSubBlockColorBaseBlock
+    # @param [RichTextArray, String, Array<String>, RichTextObject, Array<RichTextObject>] text_info
+    # @param [String] color
+    def initialize(text_info = nil, color: nil, json: nil, id: nil, parent: nil)
+      super(text_info, color: color, json: json, id: id, parent: parent)
+      @can_have_children = false
+    end
+
+    # @return [String (frozen)]
+    def type
+      "heading_2"
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/heading3_block.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class Heading3Block < TextSubBlockColorBaseBlock
+    # @param [RichTextArray, String, Array<String>, RichTextObject, Array<RichTextObject>] text_info
+    # @param [String] color
+    def initialize(text_info = nil, color: nil, json: nil, id: nil, parent: nil)
+      super(text_info, color: color, json: json, id: id, parent: parent)
+      @can_have_children = false
+    end
+
+    # @return [String (frozen)]
+    def type
+      "heading_3"
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/image_block.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class ImageBlock < FileBaseBlock
+    # @return [String (frozen)]
+    def type
+      "image"
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/link_preview_block.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class LinkPreviewBlock < UrlBaseBlock
+    def initialize(url = nil, json: nil, id: nil, parent: nil)
+      super
+      @can_append = false
+    end
+
+    # @return [String (frozen)]
+    def type
+      "link_preview"
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/link_to_page_block.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class LinkToPageBlock < Block
+    # @param [String] page_id
+    # @param [String] database_id
+    # @see https://www.notion.so/hkob/LinkToPageBlock-e6d09d4742a24fb6bf1101b14a288ff5#d46a2f4288b04cbdbd1b4679f70b7642
+    def initialize(page_id: nil, database_id: nil, json: nil, id: nil, parent: nil)
+      super(json: json, id: id, parent: parent)
+      if @json
+        @page_id, @database_id = @json[type].values_at(*%w[page_id database_id])
+      else
+        @page_id = page_id
+        @database_id = database_id
+      end
+    end
+
+    # @see https://www.notion.so/hkob/LinkToPageBlock-e6d09d4742a24fb6bf1101b14a288ff5#f0ccbad5a94248baa658efc26d9c0ca3
+    # @see https://www.notion.so/hkob/LinkToPageBlock-e6d09d4742a24fb6bf1101b14a288ff5#1444263ecc7d402c8a18f4dd32a14956
+    attr_reader :database_id, :page_id
+
+    # @param [Boolean] not_update false when update
+    # @return [Hash{String (frozen)->Hash}]
+    def block_json(not_update: true)
+      ans = super
+      ans[type] = if @page_id
+                    {"type" => "page_id", "page_id" => @page_id}
+                  else
+                    {"type" => "database_id", "database_id" => @database_id}
+                  end
+      ans
+    end
+
+    # @return [String (frozen)]
+    def type
+      "link_to_page"
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/list.rb

@@ -17,7 +17,6 @@ module NotionRubyMapping
     end
     attr_reader :has_more
 
-
     # @return [NotionRubyMapping::List, Enumerator]
     # @see https://www.notion.so/hkob/List-9a0b32335e0d48849a785ce5e162c760#12e1c261a0944a4095776b7515bef4a1
     def each
@@ -56,7 +55,7 @@ module NotionRubyMapping
         unless @has_content # re-exec
           unless @load_all_contents
             @query.start_cursor = nil
-            @json = @database.query_database @query
+            @json = @nc.database_query_request @database.id, @query
             @has_more = @json["has_more"]
           end
           @index = 0
@@ -71,7 +70,7 @@ module NotionRubyMapping
           elsif @has_more
             if @database
               @query.start_cursor = @json["next_cursor"]
-              @json = @database.query_database @query
+              @json = @nc.database_query_request @database.id, @query
               @index = 0
               @has_more = @json["has_more"]
             else

data/lib/notion_ruby_mapping/blocks/numbered_list_item_block.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class NumberedListItemBlock < TextSubBlockColorBaseBlock
+    # @return [String (frozen)]
+    def type
+      "numbered_list_item"
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/page.rb

@@ -17,6 +17,12 @@ module NotionRubyMapping
       end
     end
 
+    # @param [String] key
+    # @return [NotionRubyMapping::PropertyCache, Hash] obtained Page value or PropertyCache
+    def [](key)
+      get key
+    end
+
     # @param [String] title
     # @param [Array<String, Property>] assigns
     # @return [NotionRubyMapping::Database]

data/lib/notion_ruby_mapping/blocks/paragraph_block.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class ParagraphBlock < TextSubBlockColorBaseBlock
+    # @return [String (frozen)]
+    def type
+      "paragraph"
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/pdf_block.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class PdfBlock < FileBaseBlock
+    # @return [String (frozen)]
+    def type
+      "pdf"
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/quote_block.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class QuoteBlock < TextSubBlockColorBaseBlock
+    # @return [String (frozen)]
+    def type
+      "quote"
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/synced_block.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class SyncedBlock < Block
+    # @param [String] block_id
+    # @param [NotionRubyMapping::Block, Array<NotionRubyMapping::Block>, nil] sub_blocks
+    def initialize(block_id: nil, sub_blocks: nil, json: nil, id: nil, parent: nil)
+      super json: json, id: id, parent: parent
+      if @json
+        synced_from = @json[type]["synced_from"]
+        @block_id = synced_from && @nc.hex_id(synced_from["block_id"])
+      else
+        @block_id = block_id
+        add_sub_blocks sub_blocks
+      end
+      @can_have_children = @block_id.nil?
+    end
+
+    attr_reader :block_id
+
+    def block_json(not_update: true)
+      ans = super
+      ans[type] = {"synced_from" => @block_id ? {"type" => "block_id", "block_id" => @nc.hex_id(@block_id)} : nil}
+      ans[type]["children"] = @sub_blocks.map(&:block_json) if @sub_blocks
+      ans
+    end
+
+    # @return [Boolean] true if synced_block & block_id is nil
+    def synced_block_original?
+      @type == "synced_block" && @block_id.nil?
+    end
+
+    # @return [String, nil]
+    def synced_block_original_id
+      @type == "synced_block" && @block_id
+    end
+
+    # @return [String (frozen)]
+    def type
+      "synced_block"
+    end
+  end
+end