notion_ruby_mapping 0.3.3 → 0.5.0

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/{database.rb → blocks/database.rb}

@@ -7,6 +7,7 @@ module NotionRubyMapping
 
     # @param [String] id
     # @return [NotionRubyMapping::Database, String]
+    # @see https://www.notion.so/hkob/Database-1462b24502424539a4231bedc07dc2f5#58ba9190fd544432a9e2a5823d6c33b7
     def self.find(id, dry_run: false)
       nc = NotionCache.instance
       if dry_run
@@ -16,9 +17,16 @@ module NotionRubyMapping
       end
     end
 
-    # @return [NotionRubyMapping::Property]
+    # @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]
+    # @see https://www.notion.so/hkob/Database-1462b24502424539a4231bedc07dc2f5#c9d24269123c444295af88b9b27074a9
     def add_property(klass, title)
       prop = assign_property klass, title
       yield prop if block_given?
@@ -29,7 +37,8 @@ module NotionRubyMapping
 
     # @param [Array<Property, Class, String>] assign
     # @return [NotionRubyMapping::Base]
-    def create_child_page(*assign)
+    # @see https://www.notion.so/hkob/Database-1462b24502424539a4231bedc07dc2f5#c217ce78020a4de79b720790fce3092d
+    def build_child_page(*assign)
       assign = properties.map { |p| [p.class, p.name] }.flatten if assign.empty?
       page = Page.new assign: assign, parent: {"database_id" => @id}
       pp = page.properties
@@ -38,38 +47,62 @@ module NotionRubyMapping
       page
     end
 
+    # @param [Array<Property, Class, String>] assign
+    # @return [NotionRubyMapping::Base]
+    # @see https://www.notion.so/hkob/Database-1462b24502424539a4231bedc07dc2f5#c217ce78020a4de79b720790fce3092d
+    def create_child_page(*assign, dry_run: false)
+      assign = properties.map { |p| [p.class, p.name] }.flatten if assign.empty?
+      page = Page.new assign: assign, parent: {"database_id" => @id}
+      pp = page.properties
+      pp.clear_will_update
+      yield page, pp if block_given?
+      page.save dry_run: dry_run
+    end
+
     # @return [NotionRubyMapping::RichTextArray]
+    # @see https://www.notion.so/hkob/Database-1462b24502424539a4231bedc07dc2f5#217a7d988c404d68b270c4874a9117b4
     def database_title
       @database_title ||= RichTextArray.new "title", json: (self["title"]), will_update: new_record?
     end
 
+    # @return [Hash] created json for property schemas (for create database)
     def property_schema_json
       @payload.property_schema_json @property_cache, database_title
     end
 
-    # @return [Hash] created json for update database
+    # @return [Hash] created json for property values
     def property_values_json
       @payload.property_values_json @property_cache, database_title
     end
 
     # @param [NotionRubyMapping::Query] query object
     # @return [NotionRubyMapping::List, String]
+    # @see https://www.notion.so/hkob/Database-1462b24502424539a4231bedc07dc2f5#6bd9acf62c454f64bc555c8828057e6b
     def query_database(query = Query.new, dry_run: false)
       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
 
-    # @param [Array] names
+    # @param [Array] property_names
     # @return [Array<NotionRubyMapping::Property>]
-    def remove_properties(*names)
-      names.map { |n| properties[n] }.each(&:remove)
+    # @see https://www.notion.so/hkob/Database-1462b24502424539a4231bedc07dc2f5#5d15354be2604141adfbf78d14d49942
+    def remove_properties(*property_names)
+      property_names.map { |n| properties[n] }.each(&:remove)
+    end
+
+    # @param [String] old_property_name
+    # @param [String] new_property_name
+    # @return [NotionRubyMapping::Database]
+    def rename_property(old_property_name, new_property_name)
+      properties[old_property_name].new_name = new_property_name
+      self
     end
 
-    # @return [Hash] created json for update database
+    # @return [Hash] created json for property schemas (for update database)
     def update_property_schema_json
       @payload.update_property_schema_json @property_cache, database_title
     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/{list.rb → blocks/list.rb}

@@ -5,27 +5,57 @@ module NotionRubyMapping
   class List < Base
     include Enumerable
 
-    def initialize(json: nil, id: nil, database: nil, query: nil)
+    def initialize(json: nil, id: nil, database: nil, parent: nil, query: nil)
       super(json: json, id: id)
       @has_more = @json["has_more"]
       @load_all_contents = !@has_more
       @database = database
+      @parent = parent
       @query = query
       @index = 0
       @has_content = true
     end
     attr_reader :has_more
 
-    ### Public announced methods
-
+    # @return [NotionRubyMapping::List, Enumerator]
+    # @see https://www.notion.so/hkob/List-9a0b32335e0d48849a785ce5e162c760#12e1c261a0944a4095776b7515bef4a1
     def each
       return enum_for(:each) unless block_given?
 
-      if @database
+      if @parent
+        unless @has_content
+          unless @load_all_contents
+            @query.start_cursor = nil
+            @json = @parent.children @query
+            @has_more = @json["has_more"]
+          end
+          @index = 0
+          @has_content = true
+        end
+
+        while @has_content
+          if @index < results.length
+            object = Base.create_from_json(results[@index])
+            @index += 1
+            yield object
+          elsif @has_more
+            if @parent
+              @query.start_cursor = @json["next_cursor"]
+              @json = @parent.children @query
+              @index = 0
+              @has_more = @json["has_more"]
+            else
+              @has_content = false
+            end
+          else
+            @has_content = false
+          end
+        end
+      elsif @database
         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
@@ -40,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
@@ -51,6 +81,7 @@ module NotionRubyMapping
           end
         end
       end
+      self
     end
 
     private

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion page object
+  class Page < Base
+    ### Public announced methods
+
+    # @param [String] id
+    # @return [NotionRubyMapping::Page, String]
+    # @see https://www.notion.so/hkob/Page-d359650e3ca94424af8359a24147b9a0#7d868b8b81c3473082bbdc7370813a4a
+    def self.find(id, dry_run: false)
+      nc = NotionCache.instance
+      if dry_run
+        Base.dry_run_script :get, nc.page_path(id)
+      else
+        nc.page id
+      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]
+    # @see https://www.notion.so/hkob/Page-d359650e3ca94424af8359a24147b9a0#2e8ca5408afb4f83a92b7b84c0dc9903
+    def build_child_database(title, *assigns)
+      db = Database.new json: {"title" => [TextObject.new(title).property_values_json]},
+                        assign: assigns, parent: {"type" => "page_id", "page_id" => @id}
+      yield db, db.properties if block_given?
+      db
+    end
+
+    def create_child_database(title, *assigns, dry_run: false)
+      build_child_database title, *assigns
+      db = Database.new json: {"title" => [TextObject.new(title).property_values_json]},
+                        assign: assigns, parent: {"type" => "page_id", "page_id" => @id}
+      yield db, db.properties
+      db.save dry_run: dry_run
+    end
+
+    # @return [String] title
+    # @see https://www.notion.so/hkob/Page-d359650e3ca94424af8359a24147b9a0#2ff7209055f346fbbda454cdbb40b1c8
+    def title
+      properties.select { |p| p.is_a? TitleProperty }.map(&:full_text).join ""
+    end
+
+    protected
+
+    # @return [NotionRubyMapping::Base, String]
+    def create(dry_run: false)
+      if dry_run
+        dry_run_script :post, @nc.pages_path, :property_values_json
+      else
+        @new_record = false
+        update_json @nc.create_page_request(property_values_json)
+      end
+    end
+
+    # @return [Hash]
+    def reload_json
+      @nc.page_request @id
+    end
+
+    # @return [NotionRubyMapping::Base, String]
+    def update(dry_run: false)
+      if dry_run
+        dry_run_script :patch, @nc.page_path(@id), :property_values_json
+      else
+        update_json @nc.update_page_request(@id, property_values_json)
+      end
+    end
+  end
+end