notion_ruby_mapping 0.3.3 → 0.5.0

data/env.yml.sample

@@ -1,15 +1,2 @@
 ---
 notion_token: "secret_XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
-top_page: "c01166c613ae45cbb96818b4ef2f5a77"
-unpermitted_page: "4a6eb31244204fecb488da11f3caf871"
-database: "c37a2c66e3aa4a0da44773de3b80c253"
-unpermitted_database: "668d797c76fa49349b05ad288df2d136"
-h1block: "0250fb6d600142eca4c74efb8794fc6b"
-unpermitted_block: "0c940186ab704351bb342d16f0635d49"
-db_first_page: "dcdc805c85fa4155a55c20fc28771af7"
-db_second_page: "6601e719a39a460c908e8909467fcccf"
-db_update_page: "206ffaa277744a99baf593e28730240c"
-user_hkob: "2200a911-6a96-44bb-bd38-6bfb1e01b9f6"
-parent1_page: "860753bb6d1f48de96211fa6e0e31f82"
-parent_database: "1d6b1040a9fb48d99a3d041429816e9f"
-created_database: "c7697137d49f49c2bbcdd6a665c4f921"

data/examples/change_title.md

@@ -23,4 +23,4 @@ page.save # API access
 print page.title # -> JKL
 ```
 ---
-[Return to README.md](../README.md#2-example-code)
+[Return to README.md](../README.md)

data/examples/renumbering_pages.md

@@ -12,9 +12,9 @@ db.query_database(tp.filter_is_not_empty.ascending(tp)).each.with_index(1) do |p
 end
 ```
 
-| After execution                               |
-|-----------------------------------------------|
+| After execution                                  |
+|--------------------------------------------------|
 | ![After exuecution](../images/serial_number.png) |
 
 ---
-[Return to README.md](../README.md#2-example-code)
+[Return to README.md](../README.md)

data/examples/set_icon_to_all_icon_unsettled_pages.md

@@ -22,9 +22,9 @@ db.query_database.each do |page|
 end
 ```
 
-|Before execution|After execution|
-|---|---|
-|![Before execution](../images/pre_set_icon.png)|![After execution](../images/post_set_icon.png)|
+| Before execution                                | After execution                                 |
+|-------------------------------------------------|-------------------------------------------------|
+| ![Before execution](../images/pre_set_icon.png) | ![After execution](../images/post_set_icon.png) |
 
 ---
-[Return to README.md](../README.md#2-example-code)
+[Return to README.md](../README.md)

data/lib/notion_ruby_mapping/{base.rb → blocks/base.rb}

@@ -2,20 +2,21 @@
 
 module NotionRubyMapping
   # Notion Base object (Parent of Page / Database / List)
+  # The Public API method has a link to the API references.
   class Base
-    #### Public announced methods
-
     # @param [Hash, nil] json
     # @param [String, nil] id
     # @param [Array<Property, Class, String>] assign
     def initialize(json: nil, id: nil, assign: [], parent: nil)
       @nc = NotionCache.instance
       @json = json
-      @id = @nc.hex_id(id || json && @json["id"])
+      @id = @nc.hex_id(id || @json && @json["id"])
+      @archived = @json && @json["archived"]
+      @has_children = @json && @json["has_children"]
       @new_record = true unless parent.nil?
-      raise StandardError, "Unknown id" if !is_a?(List) && @id.nil? && parent.nil?
+      raise StandardError, "Unknown id" if !is_a?(List) && !is_a?(Block) && @id.nil? && parent.nil?
 
-      @payload = Payload.new(parent && {"parent" => parent})
+      @payload = Payload.new(!is_a?(Block) && parent && {"parent" => parent})
       @property_cache = nil
       @created_time = nil
       @last_edited_time = nil
@@ -26,9 +27,40 @@ module NotionRubyMapping
     end
     attr_reader :json, :id
 
+    # @param [Hash, Notion::Messages] json
+    # @return [NotionRubyMapping::Base]
+    def self.create_from_json(json)
+      case json["object"]
+      when "page"
+        Page.new json: json
+      when "database"
+        Database.new json: json
+      when "list"
+        List.new json: json
+      when "block"
+        Block.decode_block json
+      else
+        raise StandardError, json.inspect
+      end
+    end
+
+    # @param [Object] method
+    # @param [Object] path
+    # @param [nil] json
+    def self.dry_run_script(method, path, json = nil)
+      shell = [
+        "#!/bin/sh\ncurl #{method == :get ? "" : "-X #{method.to_s.upcase}"} 'https://api.notion.com/#{path}'",
+        "  -H 'Notion-Version: 2022-02-22'",
+        "  -H 'Authorization: Bearer '\"$NOTION_API_KEY\"''",
+      ]
+      shell << "  -H 'Content-Type: application/json'" if %i[post patch].include?(method)
+      shell << "  --data '#{JSON.generate json}'" if json
+      shell.join(" \\\n")
+    end
+
     # @param [String] key
     # @return [NotionRubyMapping::PropertyCache, Hash] obtained Page value or PropertyCache
-    def [](key)
+    def get(key)
       unless @json
         raise StandardError, "Unknown id" if @id.nil?
 
@@ -42,9 +74,85 @@ module NotionRubyMapping
       end
     end
 
+    # @param [Array<Block>] blocks
+    # @param [Boolean] dry_run
+    # @return [NotionRubyMapping::Block, String]
+    # @see https://www.notion.so/hkob/Page-d359650e3ca94424af8359a24147b9a0#44bbf83d852c419485c5efe9fe1558fb
+    # @see https://www.notion.so/hkob/Block-689ad4cbff50404d8a1baf67b6d6d78d#2c47f7fedae543cf8566389ba1677132
+    def append_block_children(*blocks, dry_run: false)
+      raise StandardError, "This block can have no children." unless page? || (block? && can_have_children)
+
+      only_one = blocks.length == 1
+      json = {
+        "children" => Array(blocks).map do |block|
+          assert_parent_children_pair block
+          block.block_json
+        end,
+      }
+      if dry_run
+        path = @nc.append_block_children_page_path(id)
+        self.class.dry_run_script :patch, path, json
+      else
+        response = @nc.append_block_children_request @id, json
+        raise StandardError, response unless response["results"]
+
+        answers = response["results"].map { |sub_json| Block.new json: sub_json }
+        only_one ? answers.first : answers
+      end
+    end
+
+    # @param [NotionRubyMapping::Block] block
+    def assert_parent_children_pair(block)
+      raise StandardError, "the argument is not a block." unless block.block?
+
+      raise StandardError, "#{type} cannot have children." if block? && !@can_have_children
+
+      return if block.can_append
+
+      bt = block.type
+      raise StandardError, "Internal file block can not append." if bt == "file"
+
+      raise StandardError, "Column block can only append column_list block" unless bt == "column" &&
+                                                                                   block? && type == "column_list"
+    end
+
+    # @param [NotionRubyMapping::Property] klass
+    # @param [String] title
+    # @return [NotionRubyMapping::Property] generated property
+    def assign_property(klass, title)
+      @property_cache ||= PropertyCache.new({}, base_type: database? ? :database : :page)
+      property = if database?
+                   klass.new(title, will_update: new_record?, base_type: :database)
+                 else
+                   klass.new(title, will_update: true, base_type: :page)
+                 end
+      @property_cache.add_property property
+      property
+    end
+
+    # @return [TrueClass, FalseClass] true if Block object
+    def block?
+      is_a? Block
+    end
+
+    # @param [NotionRubyMapping::Query] query
+    # @param [Boolean] dry_run
+    # @return [NotionRubyMapping::List, String]
+    def children(query = Query.new, dry_run: false)
+      if dry_run
+        path = @nc.block_children_page_path(id) + query.query_string
+        self.class.dry_run_script :get, path
+      elsif @children
+        @children
+      else
+        response = @nc.block_children_request @id, query.query_string
+        @children = List.new json: response, parent: self, query: query
+      end
+    end
+
     # @return [NotionRubyMapping::CreatedTimeProperty]
     def created_time
-      @created_time ||= CreatedTimeProperty.new("__timestamp__")
+      @created_time ||= CreatedTimeProperty.new("__timestamp__", json: self["created_time"])
     end
 
     # @return [TrueClass, FalseClass] true if Database object
@@ -53,16 +161,28 @@ module NotionRubyMapping
     end
 
     # @return [Hash, nil] obtained Hash
+    # @see https://www.notion.so/hkob/Page-d359650e3ca94424af8359a24147b9a0#e13d526bd709451e9b06fd32e8d07fcd
     def icon
       self["icon"]
     end
 
+    # @return [String (frozen)]
+    def inspect
+      "#{self.class.name}-#{@id}"
+    end
+
+    # @return [Hash] json properties
+    def json_properties
+      @json && @json["properties"]
+    end
+
     # @return [NotionRubyMapping::LastEditedTimeProperty]
     def last_edited_time
-      @last_edited_time ||= LastEditedTimeProperty.new("__timestamp__")
+      @last_edited_time ||= LastEditedTimeProperty.new("__timestamp__", json: self["last_edited_time"])
     end
 
     # @return [Boolean] true if new record
+    # @see https://www.notion.so/hkob/Page-d359650e3ca94424af8359a24147b9a0#307af6e40d3840c59f8a82513a572d51
     def new_record?
       @new_record
     end
@@ -73,6 +193,7 @@ module NotionRubyMapping
     end
 
     # @return [NotionRubyMapping::PropertyCache] get or created PropertyCache object
+    # @see https://www.notion.so/hkob/Page-d359650e3ca94424af8359a24147b9a0#8f0b28e09dd74e2a9ff06126c48d64d4
     def properties
       unless @property_cache
         unless @json
@@ -85,70 +206,6 @@ module NotionRubyMapping
       @property_cache
     end
 
-    # @return [NotionRubyMapping::Base, String]
-    def save(dry_run: false)
-      if dry_run
-        @new_record ? create(dry_run: true) : update(dry_run: true)
-      else
-        @new_record ? create : update
-        @property_cache.clear_will_update
-        @payload.clear
-        self
-      end
-    end
-
-    # @param [String] emoji
-    # @param [String] url
-    # @return [NotionRubyMapping::Base]
-    def set_icon(emoji: nil, url: nil)
-      @payload.set_icon(emoji: emoji, url: url) if page? || database?
-      self
-    end
-
-    # @return [String] title
-    def title
-      properties.select { |p| p.is_a? TitleProperty }.map(&:full_text).join ""
-    end
-
-    ### Not public announced methods
-
-    # @param [Hash, Notion::Messages] json
-    # @return [NotionRubyMapping::Base]
-    def self.create_from_json(json)
-      case json["object"]
-      when "page"
-        Page.new json: json
-      when "database"
-        Database.new json: json
-      when "list"
-        List.new json: json
-      when "block"
-        Block.new json: json
-      else
-        raise StandardError, json.inspect
-      end
-    end
-
-    # @param [NotionRubyMapping::Property] klass
-    # @param [String] title
-    # @return [NotionRubyMapping::Property] generated property
-    def assign_property(klass, title)
-      @property_cache ||= PropertyCache.new({}, base_type: database? ? :database : :page)
-
-      property = if database?
-                   klass.new(title, will_update: new_record?, base_type: :database)
-                 else
-                   klass.new(title, will_update: true, base_type: :page)
-                 end
-      @property_cache.add_property property
-      property
-    end
-
-    # @return [NotionRubyMapping::List]
-    def children
-      @children ||= @nc.block_children(id)
-    end
-
     # @return [Hash] created json for update page
     def property_values_json
       @payload.property_values_json @property_cache
@@ -173,10 +230,42 @@ module NotionRubyMapping
       self
     end
 
+    # @param [Boolean] dry_run
+    # @return [NotionRubyMapping::Base, String]
+    # @see https://www.notion.so/hkob/Page-d359650e3ca94424af8359a24147b9a0#277085c8439841c798a4b94eae9a7326
+    def save(dry_run: false)
+      if dry_run
+        @new_record ? create(dry_run: true) : update(dry_run: true)
+      else
+        @new_record ? create : update
+        @property_cache.clear_will_update unless block?
+        @payload.clear
+        self
+      end
+    end
+
+    # @param [String] emoji
+    # @param [String] url
+    # @return [NotionRubyMapping::Base]
+    # @see https://www.notion.so/hkob/Page-d359650e3ca94424af8359a24147b9a0#62eea67af7824496820c6bb903503540
+    # @see https://www.notion.so/hkob/Page-d359650e3ca94424af8359a24147b9a0#e13d526bd709451e9b06fd32e8d07fcd
+    def set_icon(emoji: nil, url: nil)
+      @payload.set_icon(emoji: emoji, url: url) if page? || database?
+      self
+    end
+
+    # @return [FalseClass] return false except block
+    def synced_block_original?
+      false
+    end
+
     # @param [Hash] json
     # @return [NotionRubyMapping::Base]
     def update_json(json)
-      raise StandardError, json.inspect unless json["object"] != "error" && (@json.nil? || @json["type"] == json["type"])
+      unless json["object"] != "error" && (@json.nil? || @json["type"] == json["type"])
+        raise StandardError,
+              json.inspect
+      end
 
       @json = json
       @id = @nc.hex_id(@json["id"])
@@ -184,25 +273,7 @@ module NotionRubyMapping
       self
     end
 
-    # protected
-    # @return [Hash] json properties
-    def json_properties
-      @json && @json["properties"]
-    end
-
-    # @param [Object] method
-    # @param [Object] path
-    # @param [nil] json
-    def self.dry_run_script(method, path, json = nil)
-      shell = [
-        "#!/bin/sh\ncurl #{method == :get ? "" : "-X #{method.to_s.upcase}"} 'https://api.notion.com/#{path}'",
-        "  -H 'Notion-Version: 2022-02-22'",
-        "  -H 'Authorization: Bearer '\"$NOTION_API_KEY\"''",
-      ]
-      shell << "  -H 'Content-Type: application/json'" unless path == :get
-      shell << "  --data '#{JSON.generate json}'" if json
-      shell.join(" \\\n")
-    end
+    ### Not public announced methods
 
     protected
 

data/lib/notion_ruby_mapping/blocks/block.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class Block < Base
+    ### Public announced methods
+
+    # @see https://www.notion.so/hkob/BreadcrumbBlock-3d0905b858524cdd8c868f80fd5d089a#d3b517be0c4b4825bed98206ce3ef41a
+    # @see https://www.notion.so/hkob/DividerBlock-d943b964dc4d4eff8f1d24ee0684e29e#f0ac8179c9a044bf95b87de1eb338413
+    def initialize(json: nil, id: nil, parent: nil)
+      super
+      @can_have_children = false
+      @can_append = true
+    end
+    attr_reader :can_have_children, :can_append, :type, :rich_text_array, :url, :caption, :color, :language
+
+    def self.type2class(type, has_children = false)
+      @type2class ||= {
+        false => {
+          "bookmark" => BookmarkBlock,
+          "breadcrumb" => BreadcrumbBlock,
+          "bulleted_list_item" => BulletedListItemBlock,
+          "callout" => CalloutBlock,
+          "child_database" => ChildDatabaseBlock,
+          "child_page" => ChildPageBlock,
+          "code" => CodeBlock,
+          "column" => ColumnBlock,
+          "column_list" => ColumnListBlock,
+          "divider" => DividerBlock,
+          "embed" => EmbedBlock,
+          "equation" => EquationBlock,
+          "file" => FileBlock,
+          "heading_1" => Heading1Block,
+          "heading_2" => Heading2Block,
+          "heading_3" => Heading3Block,
+          "image" => ImageBlock,
+          "link_preview" => LinkPreviewBlock,
+          "link_to_page" => LinkToPageBlock,
+          "numbered_list_item" => NumberedListItemBlock,
+          "paragraph" => ParagraphBlock,
+          "pdf" => PdfBlock,
+          "quote" => QuoteBlock,
+          "synced_block" => SyncedBlock,
+          "table" => TableBlock,
+          "table_row" => TableRowBlock,
+          "table_of_contents" => TableOfContentsBlock,
+          "template" => TemplateBlock,
+          "to_do" => ToDoBlock,
+          "toggle" => ToggleBlock,
+          "video" => VideoBlock,
+        },
+        true => {
+          "heading_1" => ToggleHeading1Block,
+          "heading_2" => ToggleHeading2Block,
+          "heading_3" => ToggleHeading3Block,
+        }
+      }
+      @klass = @type2class[has_children][type] || @type2class[false][type] || Block
+    end
+
+    def self.decode_block(json)
+      type2class(json["type"], json["has_children"]).new json: json
+    end
+
+    # @see https://www.notion.so/hkob/Block-689ad4cbff50404d8a1baf67b6d6d78d#298916c7c379424682f39ff09ee38544
+    # @param [String] id
+    # @return [NotionRubyMapping::Block]
+    def self.find(id, dry_run: false)
+      nc = NotionCache.instance
+      if dry_run
+        Base.dry_run_script :get, nc.block_path(id)
+      else
+        nc.block id
+      end
+    end
+
+    # @param [Boolean] not_update false when update
+    # @return [Hash{String (frozen)->Hash}]
+    def block_json(not_update: true)
+      ans = {"type" => type}
+      ans["object"] = "block"
+      ans["archived"] = true if @archived
+      ans
+    end
+
+    # @return [Hash{String (frozen)->Array<Hash{String (frozen)->Hash}>}]
+    def children_block_json
+      {"children" => [block_json]}
+    end
+
+    # @return [NotionRubyMapping::RichTextArray]
+    def decode_block_caption
+      @caption = RichTextArray.new "caption", json: @json[type]["caption"]
+    end
+
+    # @return [String]
+    def decode_color
+      @color = @json[type]["color"]
+    end
+
+    # @return [NotionRubyMapping::RichTextArray]
+    def decode_block_rich_text_array
+      @rich_text_array = RichTextArray.new "rich_text", json: @json[type]["rich_text"]
+    end
+
+    # @param [Boolean] dry_run
+    # @return [NotionRubyMapping::Base, String]
+    def destroy(dry_run: false)
+      if dry_run
+        Base.dry_run_script :delete, @nc.block_path(@id)
+      else
+        @nc.destroy_block id
+      end
+    end
+
+    # @return [NotionRubyMapping::Base, String]
+    def update(dry_run: false)
+      if dry_run
+        dry_run_script :patch, @nc.block_path(@id), :update_block_json
+      else
+        update_json @nc.update_block_request(@id, update_block_json)
+      end
+    end
+
+    # @return [Hash]
+    def update_block_json
+      @payload.update_block_json type, block_json(not_update: false)
+    end
+
+    protected
+
+    def add_sub_blocks(sub_blocks)
+      @sub_blocks = Array(sub_blocks) if sub_blocks
+      @can_have_children = true
+    end
+
+    # @param [String] type
+    # @param [String] color
+    def rich_text_array_and_color(type, text_info, color = "default")
+      @rich_text_array = RichTextArray.rich_text_array type, text_info
+      @color = color
+      self
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/bookmark_block.rb

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

data/lib/notion_ruby_mapping/blocks/breadcrumb_block.rb

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

data/lib/notion_ruby_mapping/blocks/bulleted_list_item_block.rb

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

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