notion_ruby_mapping 0.4.1 → 0.5.0

data/lib/notion_ruby_mapping/blocks/table_block.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class TableBlock < Block
+    # @param [Integer] table_width
+    # @param [Boolean] has_column_header
+    # @param [Boolean] has_row_header
+    # @param [Array<Array<Object>>] table_rows
+    # @param [Hash] json
+    # @param [Integer] id
+    # @param [Integer] parent
+    def initialize(table_width: nil, has_column_header: false, has_row_header: false, table_rows: nil, json: nil, id: nil,
+                   parent: nil)
+      super json: json, id: id, parent: parent
+      if @json
+        sub_json = @json[type]
+        @has_column_header = sub_json["has_column_header"]
+        @has_row_header = sub_json["has_row_header"]
+        @table_width = sub_json["table_width"]
+      else
+        @table_width = table_width
+        @has_column_header = has_column_header
+        @has_row_header = has_row_header
+        if table_rows
+          @table_rows = table_rows.map do |table_row|
+            TableRowBlock.new table_row, @table_width
+          end
+        end
+      end
+      @can_have_children = true
+    end
+
+    def block_json(not_update: true)
+      ans = super
+      ans[type] = {
+        "has_column_header" => @has_column_header,
+        "has_row_header" => @has_row_header,
+        "table_width" => @table_width,
+      }
+      ans[type]["children"] = @table_rows.map(&:block_json) if @table_rows
+      ans
+    end
+
+    # @return [String (frozen)]
+    def type
+      "table"
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/table_of_contents_block.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  # @param [String] color
+  class TableOfContentsBlock < Block
+    def initialize(color = "default", json: nil, id: nil, parent: nil)
+      super(json: json, id: id, parent: parent)
+      if @json
+        decode_color
+      else
+        @color = color
+      end
+    end
+
+    def color=(new_color)
+      @color = new_color
+      @payload.add_update_block_key "color"
+    end
+
+    # @return [String (frozen)]
+    def type
+      "table_of_contents"
+    end
+
+    # @param [Boolean] not_update false when update
+    # @return [Hash{String (frozen)->Hash}]
+    def block_json(not_update: true)
+      ans = super
+      ans[type] = {"color" => @color}
+      ans
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/table_row_block.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class TableRowBlock < Block
+    # @param [Array<Array<String, TextObject>>] array_array_of_text_objects
+    # @param [Integer] table_width
+    def initialize(array_array_of_text_objects = [], table_width = 3, json: nil, id: nil, parent: nil)
+      super json: json, id: id, parent: parent
+      if @json
+        @cells = @json[type]["cells"].map { |cell| cell.map { |to| RichTextObject.create_from_json to } }
+      else
+        cc = array_array_of_text_objects.count
+        raise StandardError, "table width must be #{table_width} (given array size is #{cc}" unless table_width == cc
+
+        @cells = array_array_of_text_objects.map do |cell|
+          Array(cell).map { |text_info| TextObject.text_object text_info }
+        end
+      end
+      @can_have_children = false
+    end
+
+    def block_json(not_update: true)
+      ans = super
+      ans[type] = {"cells" => @cells.map { |cell| Array(cell).map(&:property_values_json) }}
+      ans
+    end
+
+    # @return [String (frozen)]
+    def type
+      "table_row"
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/template_block.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class TemplateBlock < Block
+    # @param [RichTextArray, String, Array<String>, RichTextObject, Array<RichTextObject>] text_info
+    # @param [NotionRubyMapping::Block, Array<NotionRubyMapping::Block>, nil] sub_blocks
+    def initialize(text_info = nil, sub_blocks: nil, json: nil, id: nil, parent: nil)
+      super(json: json, id: id, parent: parent)
+      if @json
+        decode_block_rich_text_array
+      else
+        rich_text_array_and_color "rich_text", text_info, nil
+        add_sub_blocks sub_blocks
+      end
+      @can_have_children = true
+    end
+
+    attr_reader :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]["children"] = @sub_blocks.map(&:block_json) if @sub_blocks
+      ans
+    end
+
+    def type
+      "template"
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/text_sub_block_color_base_block.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class TextSubBlockColorBaseBlock < Block
+    # @param [RichTextArray, String, Array<String>, RichTextObject, Array<RichTextObject>, nil] text_info
+    # @param [String] color
+    # @param [NotionRubyMapping::Block, Array<NotionRubyMapping::Block>, nil] sub_blocks
+    def initialize(text_info = nil, sub_blocks: nil, color: "default", json: nil, id: nil, parent: nil)
+      raise StandardError, "TextSubBlockColorBaseBlock is abstract class" if instance_of?(TextSubBlockColorBaseBlock)
+
+      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
+        add_sub_blocks sub_blocks
+      end
+      @can_have_children = true
+    end
+
+    # @see https://www.notion.so/hkob/BulletedListItemBlock-ac4978f4efbb40109f0fb3bd00f43476#36d044b3db734fc5b0e21c07d829cb81
+    # @see https://www.notion.so/hkob/BulletedListItemBlock-ac4978f4efbb40109f0fb3bd00f43476#cef80016457e46e7bb178f063e4981de
+    attr_reader :color, :rich_text_array
+
+    # @param [String] new_color
+    # @see https://www.notion.so/hkob/BulletedListItemBlock-ac4978f4efbb40109f0fb3bd00f43476#2d59111c9e434dfa99d294cc9a74e468
+    def color=(new_color)
+      @color = new_color
+      @payload.add_update_block_key "color"
+      @rich_text_array.will_update = true
+    end
+
+    # @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]["children"] = @sub_blocks.map(&:block_json) if @sub_blocks
+      ans
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/to_do_block.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class ToDoBlock < TextSubBlockColorBaseBlock
+    # @param [RichTextArray, String, Array<String>, RichTextObject, Array<RichTextObject>] text_info
+    # @param [Boolean] checked
+    # @param [NotionRubyMapping::Block, Array<NotionRubyMapping::Block>, nil] sub_blocks
+    # @param [String] color
+    def initialize(text_info = nil, checked = false, sub_blocks: nil, color: "default", json: nil, id: nil, parent: nil)
+      super(text_info, sub_blocks: sub_blocks, color: color, json: json, id: id, parent: parent)
+      @checked = if @json
+                   @json[type]["checked"]
+                 else
+                   checked
+                 end
+    end
+
+    # @see https://www.notion.so/hkob/ToDoBlock-9e4d863244b541869d91c84620e190d4#a4550dc684de43d2be171d4abbbea7ce
+    attr_reader :checked
+
+    # @param [Boolean] not_update false when update
+    # @return [Hash{String (frozen)->Hash}]
+    def block_json(not_update: true)
+      ans = super
+      ans[type]["checked"] = @checked
+      ans
+    end
+
+    # @param [Boolean] new_checked
+    # @see https://www.notion.so/hkob/ToDoBlock-9e4d863244b541869d91c84620e190d4#8ef8b12721914cccb17790879bdc2fbf
+    def checked=(new_checked)
+      @checked = new_checked
+      @payload.add_update_block_key "checked"
+    end
+
+    # @return [String (frozen)]
+    def type
+      "to_do"
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/toggle_block.rb

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

data/lib/notion_ruby_mapping/blocks/toggle_heading1_block.rb

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

data/lib/notion_ruby_mapping/blocks/toggle_heading2_block.rb

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

data/lib/notion_ruby_mapping/blocks/toggle_heading3_block.rb

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

data/lib/notion_ruby_mapping/blocks/url_base_block.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class UrlBaseBlock < Block
+    # @param [Sting] url
+    def initialize(url, json: nil, id: nil, parent: nil)
+      raise StandardError, "UrlBaseBlock is abstract class" if instance_of?(UrlBaseBlock)
+
+      super(json: json, id: id, parent: parent)
+      @url = if @json
+               @json[type]["url"]
+             else
+               url
+             end
+    end
+
+    attr_reader :url
+
+    # @param [Boolean] not_update false when update
+    # @return [Hash{String (frozen)->Hash}]
+    def block_json(not_update: true)
+      ans = super
+      ans[type] = {"url" => @url}
+      ans
+    end
+
+    # @param [String] str
+    def url=(str)
+      @url = str
+      @payload.add_update_block_key "url"
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/url_caption_base_block.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class UrlCaptionBaseBlock < Block
+    # @param [Sting] url
+    # @param [RichTextArray, String, Array<String>, RichTextObject, Array<RichTextObject>] caption
+    # @see https://www.notion.so/hkob/BookmarkBlock-f2a8c15ad469436c966f74b58dcacbd4#845a1349bf5a4392b427199d6f327557
+    # @see https://www.notion.so/hkob/EmbedBlock-57c31e7d8e1d41669eb30f27e1c41035#3421ddd6f27f4ebea4c7e4450f81b866
+    def initialize(url = nil, caption: [], json: nil, id: nil, parent: nil)
+      raise StandardError, "UrlCaptionBaseBlock is abstract class" if instance_of?(UrlCaptionBaseBlock)
+
+      super(json: json, id: id, parent: parent)
+      if @json
+        @url = @json[type]["url"]
+        decode_block_caption
+      else
+        @url = url
+        @caption = RichTextArray.rich_text_array "caption", caption
+      end
+    end
+
+    # @see https://www.notion.so/hkob/BookmarkBlock-f2a8c15ad469436c966f74b58dcacbd4#bb6ff9f5dbdc4d52bbf8cdea89fc66de
+    # @see https://www.notion.so/hkob/BookmarkBlock-f2a8c15ad469436c966f74b58dcacbd4#eabb5436af464f77865e4a223da72329
+    # @see https://www.notion.so/hkob/EmbedBlock-57c31e7d8e1d41669eb30f27e1c41035#f28b77ca0b634acc8e606f954c516ae9
+    # @see https://www.notion.so/hkob/EmbedBlock-57c31e7d8e1d41669eb30f27e1c41035#3df6808f8eed43c7bc07ced53cbce6ba
+    attr_reader :caption, :url
+
+    # @param [Boolean] not_update false when update
+    # @return [Hash{String (frozen)->Hash}]
+    def block_json(not_update: true)
+      ans = super
+      ans[type] = @caption.update_property_schema_json not_update
+      ans[type]["url"] = @url
+      ans
+    end
+
+    # @param [String] str
+    # @see https://www.notion.so/hkob/BookmarkBlock-f2a8c15ad469436c966f74b58dcacbd4#054829bf342f40aea4fa6bd23820fbcb
+    # @see https://www.notion.so/hkob/EmbedBlock-57c31e7d8e1d41669eb30f27e1c41035#25ece6bfce0749f8b4bbecc6ba7feedc
+    def url=(str)
+      @url = str
+      @payload.add_update_block_key "url"
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/video_block.rb

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

data/lib/notion_ruby_mapping/controllers/notion_cache.rb

@@ -11,7 +11,6 @@ module NotionRubyMapping
 
     ### initialize
 
-
     # @see https://www.notion.so/hkob/NotionCache-65e1599864d6425686d495a5a4b3a623#dca210788f114cf59464090782c073bf
     def initialize
       @object_hash = {}
@@ -27,7 +26,7 @@ module NotionRubyMapping
     attr_reader :object_hash
     attr_writer :client # for test only
 
-    # @param [String] page_id
+    # @param [String] block_id
     # @return [String (frozen)] block_path
     def append_block_children_block_path(block_id)
       "v1/blocks/#{block_id}/children"
@@ -118,12 +117,14 @@ module NotionRubyMapping
     # @param [String] id page_id / block_id (with or without "-")
     # @param [NotionRubyMapping::Query] query query object
     # @return [NotionRubyMapping::Base] List object
-    def database_query(id, query)
-      Base.create_from_json database_query_request(id, query.query_json)
-    end
+    # def database_query(id, query)
+    #   Base.create_from_json database_query_request(id, query.query_json)
+    # end
 
-    def database_query_request(database_id, payload)
-      request :post, "v1/databases/#{database_id}/query", payload
+    # @param [String] database_id (with or without "-")
+    # @param [NotionRubyMapping::Query] query query object
+    def database_query_request(database_id, query)
+      request :post, "v1/databases/#{database_id}/query", query.query_json
     end
 
     # @param [String] database_id
@@ -132,32 +133,34 @@ module NotionRubyMapping
       request :get, database_path(database_id)
     end
 
-    # @param [String] database_id
     # @return [String (frozen)] page_path
     def databases_path
       "v1/databases"
     end
 
+    # @param [String] id
     # @return [NotionRubyMapping::Base]
     def destroy_block(id)
       Base.create_from_json destroy_block_request(id)
     end
 
-    # @param [Hash] response
+    # @param [String] id
+    # @return [Hash]
     def destroy_block_request(id)
       request :delete, block_path(id)
     end
 
-    def inspect
-      "NotionCache"
-    end
-
     # @param [String] id id string with "-"
     # @return [String] id without "-"
+    # @see https://www.notion.so/hkob/NotionCache-65e1599864d6425686d495a5a4b3a623#a2d70a2e019c4c17898aaa1a36580f1d
     def hex_id(id)
       id&.gsub "-", ""
     end
 
+    def inspect
+      "NotionCache"
+    end
+
     # @param [String] id id (with or without "-")
     # @return [NotionRubyMapping::Base]
     def object_for_key(id)
@@ -224,25 +227,28 @@ module NotionRubyMapping
       response.body
     end
 
+    def update_block_request(block_id, payload)
+      request :patch, block_path(block_id), payload
+    end
+
     # @param [String] id page_id (with or without "-")
     # @param [Hash] payload
-    def update_database(id, payload)
-      sleep @wait
-      @client.update_database payload.merge({database_id: id})
-    end
+    # def update_database(id, payload)
+    #   sleep @wait
+    #   @client.update_database payload.merge({database_id: id})
+    # end
 
     # @param [String] database_id
     # @return [Hash] response
     def update_database_request(database_id, payload)
-      request :patch, "v1/databases/#{database_id}", payload
+      request :patch, database_path(database_id), payload
     end
 
     # @param [String] page_id
     # @param [Hash] payload
     # @return [Hash] response
     def update_page_request(page_id, payload)
-      request :patch, "v1/pages/#{page_id}", payload
+      request :patch, page_path(page_id), payload
     end
-
   end
 end

data/lib/notion_ruby_mapping/controllers/payload.rb

@@ -5,21 +5,17 @@ module NotionRubyMapping
   class Payload
     def initialize(json)
       @json = json || {}
+      @update_block_key = []
     end
 
-    # @param [String] emoji
-    # @param [String] url
-    # @return [NotionRubyMapping::Payload] updated Payload
-    def set_icon(emoji: nil, url: nil)
-      payload = if emoji
-                  {"type" => "emoji", "emoji" => emoji}
-                elsif url
-                  {"type" => "external", "external" => {"url" => url}}
-                else
-                  {}
-                end
-      @json["icon"] = payload
-      self
+    # @param [String] key
+    def add_update_block_key(key)
+      @update_block_key << key
+    end
+
+    # @return [Hash] {}
+    def clear
+      @json = {}
     end
 
     # @param [Hash] json
@@ -40,15 +36,33 @@ module NotionRubyMapping
       others.compact.reduce({}) { |hash, o| hash.merge o.property_schema_json }.merge @json
     end
 
+    # @param [String] emoji
+    # @param [String] url
+    # @return [NotionRubyMapping::Payload] updated Payload
+    def set_icon(emoji: nil, url: nil)
+      payload = if emoji
+                  {"type" => "emoji", "emoji" => emoji}
+                elsif url
+                  {"type" => "external", "external" => {"url" => url}}
+                else
+                  {}
+                end
+      @json["icon"] = payload
+      self
+    end
+
+    def update_block_json(type, json)
+      sub_json = json[type]
+      ans = {type => sub_json.slice(*@update_block_key)}
+      ans[type]["caption"] = sub_json["caption"] if sub_json["caption"]
+      ans[type]["rich_text"] = sub_json["rich_text"] if sub_json["rich_text"]
+      ans
+    end
+
     # @return [Hash] created json
     # @param [Object] others
     def update_property_schema_json(*others)
       others.compact.reduce({}) { |hash, o| hash.merge o.update_property_schema_json }.merge @json
     end
-
-    # @return [Hash] {}
-    def clear
-      @json = {}
-    end
   end
 end

data/lib/notion_ruby_mapping/controllers/query.rb

@@ -12,7 +12,7 @@ module NotionRubyMapping
     attr_reader :filter, :sort, :page_size
     attr_accessor :start_cursor
 
-    # @param [Query] other_query other query
+    # @param [Query] another_query other query
     # @return [NotionRubyMapping::Query] updated self (Query object)
     def and(another_query)
       if @filter.key? "and"

data/lib/notion_ruby_mapping/controllers/rich_text_array.rb

@@ -72,6 +72,17 @@ module NotionRubyMapping
       map(&:text).join ""
     end
 
+    def rich_text_objects=(text_info)
+      @will_update = true
+      @rich_text_objects = if text_info.is_a? RichTextArray
+                             text_info.filter { true }
+                           else
+                             Array(text_info).map do |to|
+                               RichTextObject.text_object to
+                             end
+                           end
+    end
+
     def property_values_json
       will_update ? @rich_text_objects.map(&:property_values_json) : []
     end
@@ -80,8 +91,8 @@ module NotionRubyMapping
       will_update ? {@key => @rich_text_objects.map(&:property_values_json)} : {}
     end
 
-    def update_property_schema_json
-      will_update ? {@key => @rich_text_objects.map(&:property_values_json)} : {}
+    def update_property_schema_json(flag = false)
+      flag || will_update ? {@key => @rich_text_objects.map(&:property_values_json)} : {}
     end
 
     # @return [TrueClass, FalseClass] true if it will update

data/lib/notion_ruby_mapping/objects/rich_text_object.rb

@@ -14,7 +14,7 @@ module NotionRubyMapping
       @type = type
       @options = options
     end
-    attr_reader :will_update
+    attr_reader :will_update, :options
 
     def self.create_from_json(json)
       type = json["type"]
@@ -73,7 +73,7 @@ module NotionRubyMapping
       }.merge annotations_json
     end
 
-    # @param [String, RichTextObject] value
+    # @param [String] url
     # @return [String] input text
     def href=(url)
       @will_update = true
@@ -130,9 +130,6 @@ module NotionRubyMapping
 
     protected
 
-    # @return [Hash] options
-    attr_reader :options
-
     # @return [Hash, Hash{String (frozen)->Hash}]
     def annotations_json
       annotations = @options.slice(*%w[bold italic strikethrough underline code color])

data/lib/notion_ruby_mapping/properties/created_by_property.rb

@@ -10,6 +10,7 @@ module NotionRubyMapping
     ## Common methods
 
     # @return [NotionRubyMapping::UserObject, Hash]
+    # @see https://www.notion.so/hkob/CreatedByProperty-945fa6be1c014da2b7e55a2b76e37b57#d9c4a8d19b9b4ec5952dc86c9e4a25a8
     def created_by
       @json
     end