notion_ruby_mapping 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86b66f1eaec34561d2542a0b460490cc162820c03bb386d75fdb796f7ad89477
-  data.tar.gz: 2fc5d80b0123377c7dbbfdc59f20ad03596a9fdedbc4cf49d50ca6bdf9d428e1
+  metadata.gz: 68d4b404cfe0798695934594f05049482f5436f15e0f2eb7c82125031ce3f340
+  data.tar.gz: b179b7d3530ec7f323023f5ec3ada9057f7e402f87a87c65579482c015184c62
 SHA512:
-  metadata.gz: af591e9e313309fb5028cec7073b28d8e0afa40e47b5f1cd2a5fd3129e7747897c451b45461bd10be40b0619f1e9e61b286feaad7cf23ce38e71b3f90afb3eab
-  data.tar.gz: 63abcef6e721e96e0219c516abfae21bb6d66d11e78ce67a495be459c9b7eba57112ae1c41b85f9de42a68c3d26aeb678c4423c4440035bed651013241b2f450
+  metadata.gz: 35b3b4ec135b729ba8f93e5d583f0e717e75cb6f0bd75779433948ef671b4bfa9cf22346e1a222d473f506b90a1a24efaa4fca856cd533448d773a710160f421
+  data.tar.gz: 92ef1a7218a0551195dae18a9bbbb3f82f440ba6fd2b8af49bcb578c5f21bf9417644750bc5297133d0ddd789987123f5e6dbd024bb7cb8b5b19a3a4c0764758

data/README.md

@@ -8,6 +8,7 @@ Development note is here. → [Idea note of "notion_ruby_mapping"](https://www.n
 
 - [notion_ruby_mapping](#notion_ruby_mapping)
   - [Table of Contents](#table-of-contents)
+  - [0. Changes in v0.5.0](#0-changes-in-v050)
   - [1. Installation](#1-installation)
   - [2. How to use](#2-how-to-use)
     - [2.1 Create a New Integration](#21-create-a-new-integration)
@@ -19,7 +20,11 @@ Development note is here. → [Idea note of "notion_ruby_mapping"](https://www.n
   - [4. Contributing](#4-contributing)
   - [5. License](#5-license)
   - [6. Code of Conduct](#6-code-of-conduct)
-  - [7. Acknowledgements](#7-acknowledgements)
+
+## 0. Changes in v0.5.0
+
+NotionRubyMapping v.0.5.0 now supports block updates.
+For efficiency, subclasses are provided under Block class. As a result, they are no longer compatible with the scripts used in v0.4.0.
 
 ## 1. Installation
 
@@ -60,6 +65,7 @@ NotionCache.instance.create_client ENV["NOTION_API_TOKEN"] # from environment
 
 1. [Database and page access sample](https://www.notion.so/hkob/Database-and-page-access-sample-d30033e707194faf995741167eb2b6f8)
 1. [Append block children sample](https://www.notion.so/hkob/Append-block-children-sample-3867910a437340be931cf7f2c06443c6)
+1. [Update block sample](https://www.notion.so/hkob/update-block-sample-5568c1c36fe84f12b83edfe2dda83028)
 
 ### 2.4. Another example code (Use case)
 
@@ -73,17 +79,18 @@ NotionCache.instance.create_client ENV["NOTION_API_TOKEN"] # from environment
 
 ## 3. ChangeLog
 
-- added append_block_children
-- added retrieve_block spec
-- 2022/4/29 Change directory structure, TEST_IDs are moved from env.yml to TestConnection's constants
+- 2022/6/5 [v0.5.1] bug fix for append_block_children.  added synced_block_original to SyncedBlock
+- 2022/6/4 [v0.5.0]  added subclasses of the block class and update_block API support
+- 2022/5/19 [v0.4.1] added delete_block
+- 2022/4/29 [v0.4.0] Change directory structure, TEST_IDs are moved from env.yml to TestConnection's constants, added retrieve_block spec, added append_block_children
 - 2022/4/27 added Base#children
-- 2022/3/27 create_child_page can receive a block for initialization.
-- 2022/3/27 properties of a created child page are automatically assigned using the parent database.
-- 2022/3/25 added create_child_database, update_database, add_property, rename_property and remove_property
-- 2022/3/17 added template_mention objects, tools/an command
-- 2022/3/16 added database.create_child_page and base.save instead of base.update/create
+- 2022/3/27 [v0.3.3] create_child_page can receive a block for initialization.
+- 2022/3/27 [v0.3.2] properties of a created child page are automatically assigned using the parent database.
+- 2022/3/25 [v0.3.0] added create_child_database, update_database, add_property, rename_property and remove_property
+- 2022/3/17 [v0.2.3] added template_mention objects, tools/an command
+- 2022/3/16 [v0.2.2] added database.create_child_page and base.save instead of base.update/create
 - 2022/3/15 Fixed not to reload from API when all contents are loaded
-- 2022/3/14 Exclude notion-ruby-client, update Property values, update for Notion-Version 2022-02-22
+- 2022/3/14 [v0.2.0] Exclude notion-ruby-client, update Property values, update for Notion-Version 2022-02-22
 - 2022/2/25 add_property_for_update -> assign_property, update README.md
 - 2022/2/20 add support for MultiSelectProperty
 - 2022/2/19 add support for SelectProperty
@@ -105,7 +112,3 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## 6. Code of Conduct
 
 Everyone interacting in the NotionRubyMapping project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/notion_ruby_mapping/blob/main/CODE_OF_CONDUCT.md).
-
-## 7. Acknowledgements
-
-The code depends on [notion-ruby-client](https://github.com/orbit-love/notion-ruby-client).

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/blocks/base.rb

@@ -4,14 +4,15 @@ module NotionRubyMapping
   # Notion Base object (Parent of Page / Database / List)
   # The Public API method has a link to the API references.
   class Base
-
     # @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) && !is_a?(Block) && @id.nil? && parent.nil?
 
@@ -37,7 +38,7 @@ module NotionRubyMapping
       when "list"
         List.new json: json
       when "block"
-        Block.new(json: json).decode_block
+        Block.decode_block json
       else
         raise StandardError, json.inspect
       end
@@ -52,14 +53,14 @@ module NotionRubyMapping
         "  -H 'Notion-Version: 2022-02-22'",
         "  -H 'Authorization: Bearer '\"$NOTION_API_KEY\"''",
       ]
-      shell << "  -H 'Content-Type: application/json'" unless path == :get
+      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?
 
@@ -73,8 +74,8 @@ module NotionRubyMapping
       end
     end
 
-    # @param [String] url
-    # @param [RichTextArray, String, Array<String>, RichTextObject, Array<RichTextObject>] caption
+    # @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
@@ -86,7 +87,7 @@ module NotionRubyMapping
         "children" => Array(blocks).map do |block|
           assert_parent_children_pair block
           block.block_json
-        end
+        end,
       }
       if dry_run
         path = @nc.append_block_children_page_path(id)
@@ -95,7 +96,7 @@ module NotionRubyMapping
         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 }
+        answers = response["results"].map { |sub_json| Block.create_from_json sub_json }
         only_one ? answers.first : answers
       end
     end
@@ -112,7 +113,7 @@ module NotionRubyMapping
       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? && self.type == "columu_list"
+                                                                                   block? && type == "column_list"
     end
 
     # @param [NotionRubyMapping::Property] klass
@@ -149,13 +150,6 @@ module NotionRubyMapping
       end
     end
 
-    # @return [NotionRubyMapping::Block]
-    def create_child_breadcrumb
-      raise StandardError unless page? || (block? && can_have_children)
-
-      Block.new(parent: self).breadcrumb
-    end
-
     # @return [NotionRubyMapping::CreatedTimeProperty]
     def created_time
       @created_time ||= CreatedTimeProperty.new("__timestamp__", json: self["created_time"])
@@ -172,6 +166,11 @@ module NotionRubyMapping
       self["icon"]
     end
 
+    # @return [String (frozen)]
+    def inspect
+      "#{self.class.name}-#{@id}"
+    end
+
     # @return [Hash] json properties
     def json_properties
       @json && @json["properties"]
@@ -231,6 +230,7 @@ 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)
@@ -238,7 +238,7 @@ module NotionRubyMapping
         @new_record ? create(dry_run: true) : update(dry_run: true)
       else
         @new_record ? create : update
-        @property_cache.clear_will_update
+        @property_cache.clear_will_update unless block?
         @payload.clear
         self
       end
@@ -254,14 +254,18 @@ module NotionRubyMapping
       self
     end
 
-    def description
-      "#{self.class.name}-#{@id}"
+    # @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"])