notion_ruby_mapping 0.6.0 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edf72d3f2ccbc741e909ce3c8eb1a8604da6404730862751a9fb2bea1af9865c
-  data.tar.gz: de74bbb3f8821f93ec806f5e6854d54fa42fc5e3b915d33975b3ae8b2f4d4a28
+  metadata.gz: b295b0ba6b110a2f9e2f559e251490005a446abd71d2b7cc67903f9b0e2e504a
+  data.tar.gz: 8b6d1ed3f4c53973c8391981cef7044628ba22894dd42f8b23364f9a995326d9
 SHA512:
-  metadata.gz: 410633c4128a8b41182c40527fde6df1752d199ef6921e8f3b9416537979f3b3bf42eb40434a6c4ecf022c7da919c5d6431b327dfdf3def302bb645c0e2d458c
-  data.tar.gz: c5a6d6211363c59a2e8c14d9f27526a73b3537ab588ba4d81b7307a852cb376f209beac3ef49cb9d7028e0f59a193ce3aadd9d37a2a3433443959ba4ea6ba55e
+  metadata.gz: 5d3e718b49fceea38ee34be30161496d9023158631b24a633408af4b9eb5f5507ae85484c74a4f0094a7e1d8aaa47c851cc2d47af128e45814d98a5c1f5a21f4
+  data.tar.gz: 95b5374a44768b1454d550abcad6343c06d24333d787045d5317ba91ef0a1f0a1ddb273879ca28e928e2808180b7acbd144a4e8f19c52cb7208d565083d19906

data/README.md

@@ -83,6 +83,11 @@ NotionCache.instance.create_client ENV["NOTION_API_TOKEN"] # from environment
 1. [Set icon to all icon unsettled pages](examples/set_icon_to_all_icon_unsettled_pages.md)
 1. [Renumbering pages](examples/renumbering_pages.md)
 1. [Change title](examples/change_title.md)
+1. [Create erDiagram from Notion database](tools/createErDiagram.rb)
+```shell
+Usage:
+  ruby tools/createErDiagram.rb database_id code_block_id
+```
 
 ### 2.5 API reference
 
@@ -90,6 +95,9 @@ NotionCache.instance.create_client ENV["NOTION_API_TOKEN"] # from environment
 
 ## 3. ChangeLog
 
+- 2022/8/9 [v0.6.3] update createErDiagram.rb (Fixed a bug with non-ASCII database titles)
+- 2022/8/7 [v0.6.2] add comment_object support
+- 2022/7/28 [v0.6.1] added createErDiagram.rb
 - 2022/7/22 [v0.6.0] updates for Notion-Version 2022-06-28 (lazy retrieve property values, retrieve page/database/block parent, single_property/dual_property for RelationProperty)
 - 2022/6/24 [v0.5.5] add file_names= to FileProperty
 - 2022/6/23 [v0.5.4] add update 'is_inline' and 'description' for database object

data/lib/notion_ruby_mapping/blocks/base.rb

@@ -58,6 +58,24 @@ module NotionRubyMapping
       shell.join(" \\\n")
     end
 
+    def comments(query = nil, dry_run: false)
+      if page? || block?
+        if dry_run
+          self.class.dry_run_script :get, @nc.retrieve_comments_path(@id)
+        else
+          ans = {}
+          List.new(comment_parent: self,
+                   json: @nc.retrieve_comments_request(@id, query),
+                   query: query).each do |comment|
+            dt_id = comment.discussion_id
+            dt = ans[dt_id] ||= DiscussionThread.new dt_id
+            dt.comments << comment
+          end
+          ans
+        end
+      end
+    end
+
     # @param [String] key
     # @return [NotionRubyMapping::PropertyCache, Hash] obtained Page value or PropertyCache
     def get(key)
@@ -264,11 +282,7 @@ module NotionRubyMapping
         @new_record ? create(dry_run: true) : update(dry_run: true)
       else
         @new_record ? create : update
-        if block?
-
-        else
-          @property_cache.clear_will_update
-        end
+        @property_cache.clear_will_update if page?
         @payload.clear
         self
       end

data/lib/notion_ruby_mapping/blocks/list.rb

@@ -5,13 +5,14 @@ module NotionRubyMapping
   class List < Base
     include Enumerable
 
-    def initialize(json: nil, id: nil, database: nil, parent: nil, property: nil, query: nil)
+    def initialize(json: nil, id: nil, database: nil, parent: nil, property: nil, comment_parent: nil, query: nil)
       super(json: json, id: id)
       @has_more = @json["has_more"]
       @load_all_contents = !@has_more
       @database = database
       @parent = parent
       @property = property
+      @comment_parent = comment_parent
       @query = query
       @index = 0
       @has_content = true
@@ -20,105 +21,86 @@ module NotionRubyMapping
 
     # @return [NotionRubyMapping::List, Enumerator]
     # @see https://www.notion.so/hkob/List-9a0b32335e0d48849a785ce5e162c760#12e1c261a0944a4095776b7515bef4a1
-    def each
-      return enum_for(:each) unless block_given?
-
+    def each(&block)
+      return enum_for(:each) if block.nil?
       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
+        each_sub base: @page,
+                 query: -> { @parent.children @query },
+                 create_object: ->(json) { Base.create_from_json json },
+                 &block
       elsif @database
-        unless @has_content # re-exec
-          unless @load_all_contents
-            @query.start_cursor = nil
-            @json = @nc.database_query_request @database.id, @query
-            @has_more = @json["has_more"]
-          end
-          @index = 0
-          @has_content = true
-        end
+        each_sub base: @database,
+                 query: -> { @nc.database_query_request @database.id, @query },
+                 create_object: ->(json) { Base.create_from_json json },
+                 &block
+      elsif @property
+        each_sub base: @property,
+                 query: -> do
+                   @nc.page_property_request @property.property_cache.page_id,
+                                             @property.property_id,
+                                             @query.query_json
+                 end,
+                 create_object: ->(json) do
+                   case json["type"]
+                   when "people"
+                     UserObject.new json: json["people"]
+                   when "relation"
+                     json["relation"]["id"]
+                   when "rich_text"
+                     RichTextObject.create_from_json json["rich_text"]
+                   when "title"
+                     RichTextObject.create_from_json json["title"]
+                   else
+                     json
+                   end
+                 end,
+                 &block
+      elsif @comment_parent
+        each_sub base: @comment_parent,
+                 query: -> { @nc.retrieve_comments_request @comment_parent.id, @query },
+                 create_object: ->(json) { CommentObject.new json: json },
+                 &block
+      end
+      self
+    end
 
-        while @has_content
-          if @index < results.length
-            object = Base.create_from_json(results[@index])
-            @index += 1
-            yield object
-          elsif @has_more
-            if @database
-              @query.start_cursor = @json["next_cursor"]
-              @json = @nc.database_query_request @database.id, @query
-              @index = 0
-              @has_more = @json["has_more"]
-            else
-              @has_content = false
-            end
-          else
-            @has_content = false
-          end
+    private
+
+    # @param [NotionRubyMapping::Page, NotionRubyMapping::Block] base page or block
+    # @param [Proc] query
+    # @param [Proc] create_object
+    # @param [Proc] block
+    def each_sub(base:, query:, create_object:, &block)
+      unless @has_content
+        unless @load_all_contents
+          @query.start_cursor = nil
+          @json = query.call
+          @has_more = @json["has_more"]
         end
-      elsif @property
-        while @has_content
-          if @index < results.length
-            json = results[@index]
-            object = case json["type"]
-                     when "people"
-                       UserObject.new json: json["people"]
-                     when "relation"
-                       json["relation"]["id"]
-                     when "rich_text"
-                       RichTextObject.create_from_json json["rich_text"]
-                     when "title"
-                       RichTextObject.create_from_json json["title"]
-                     else
-                       json
-                     end
-            @index += 1
-            yield object
-          elsif @has_more
-            if @property
-              @query ||= Query.new
-              @query.start_cursor = @json["next_cursor"]
-              @json = NotionCache.instance.page_property_request @property.property_cache.page_id, @property.property_id, @query.query_json
-              @index = 0
-              @has_more = @json["has_more"]
-            else
-              @has_content = false
-            end
+        @index = 0
+        @has_content = true
+      end
+
+      while @has_content
+        if @index < results.length
+          object = create_object.call results[@index]
+          @index += 1
+          block.call object
+        elsif @has_more
+          if base
+            @query.start_cursor = @json["next_cursor"]
+            @json = query.call
+            @index = 0
+            @has_more = @json["has_more"]
           else
             @has_content = false
           end
+        else
+          @has_content = false
         end
       end
-      self
     end
 
-    private
-
     # @return [Hash]
     def results
       @json["results"]

data/lib/notion_ruby_mapping/blocks/page.rb

@@ -23,6 +23,16 @@ module NotionRubyMapping
       get key
     end
 
+    def append_comment(text_objects, dry_run: false)
+      rto = RichTextArray.new "rich_text", text_objects: text_objects, will_update: true
+      json = rto.property_schema_json.merge({"parent" => {"page_id" => @id}})
+      if dry_run
+        self.class.dry_run_script :post, @nc.comments_path, json
+      else
+        CommentObject.new json: (@nc.append_comment_request json)
+      end
+    end
+
     # @param [String] title
     # @param [Array<String, Property>] assigns
     # @return [NotionRubyMapping::Database]

data/lib/notion_ruby_mapping/controllers/discussion_thread.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # DiscussionThread
+  class DiscussionThread
+    # @param [String] discussion_id
+    def initialize(discussion_id)
+      @discussion_id = discussion_id
+      @comments = []
+    end
+    attr_reader :discussion_id, :comments
+
+    # @param [String] text_objects
+    # @param [Boolean] dry_run
+    # @return [String, NotionRubyMapping::CommentObject]
+    def append_comment(text_objects, dry_run: false)
+      rto = RichTextArray.new "rich_text", text_objects: text_objects, will_update: true
+      nc = NotionCache.instance
+      json = rto.property_schema_json.merge({"discussion_id" => @discussion_id})
+      if dry_run
+        Base.dry_run_script :post, nc.comments_path, json
+      else
+        CommentObject.new json: (nc.append_comment_request json)
+      end
+    end
+  end
+end

data/lib/notion_ruby_mapping/controllers/notion_cache.rb

@@ -45,6 +45,10 @@ module NotionRubyMapping
       request :patch, append_block_children_block_path(id), payload
     end
 
+    def append_comment_request(json)
+      request :post, comments_path, json
+    end
+
     # @param [String] id block_id (with or without "-")
     # @return [NotionRubyMapping::Base] Block object or nil
     def block(id)
@@ -81,6 +85,11 @@ module NotionRubyMapping
       @object_hash = {}
     end
 
+    # @return [String (frozen)]
+    def comments_path
+      "v1/comments"
+    end
+
     # @param [String] notion_token
     # @return [NotionRubyMapping::NotionCache] self (NotionCache.instance)
     def create_client(notion_token, wait: 0.3333, debug: false)
@@ -214,6 +223,17 @@ module NotionRubyMapping
       "v1/databases/#{database_id}/query"
     end
 
+    # @param [String] block_id
+    def retrieve_comments_path(block_id)
+      "v1/comments?block_id=#{block_id}"
+    end
+
+    # @param [String] block_id
+    # @param [NotionRubyMapping::Query, NilClass] query
+    def retrieve_comments_request(block_id, query)
+      request :get, retrieve_comments_path(block_id), (query&.query_json || {})
+    end
+
     # @param [Symbol] method
     # @param [String] path
     # @param [Hash] options

data/lib/notion_ruby_mapping/objects/comment_object.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # CommentObject
+  class CommentObject
+    # @param [String] text_objects
+    def initialize(text_objects: nil, json: {})
+      if text_objects
+        @text_objects = RichTextArray.new "rich_text", text_objects: text_objects
+        @json = {}
+      elsif json
+        @json = json
+        @text_objects = RichTextArray.new "rich_text", json: json["rich_text"]
+      else
+        raise StandardError, "Either text_objects or json is required CommentObject"
+      end
+      @will_update = false
+    end
+    attr_reader :will_update, :text_objects
+
+    def discussion_id
+      NotionCache.instance.hex_id @json["discussion_id"]
+    end
+
+    # @return [String] full_text
+    def full_text
+      @text_objects.full_text
+    end
+  end
+end

data/lib/notion_ruby_mapping/properties/property.rb

@@ -107,6 +107,7 @@ module NotionRubyMapping
           "people" => PeopleProperty,
           "phone_number" => PhoneNumberProperty,
           "select" => SelectProperty,
+          "status" => StatusProperty,
           "title" => TitleProperty,
           "rich_text" => RichTextProperty,
           "url" => UrlProperty,

data/lib/notion_ruby_mapping/properties/status_property.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Status property
+  class StatusProperty < Property
+    TYPE = "status"
+
+    ### Public announced methods
+
+    ## Common methods
+
+    def status
+      @json
+    end
+
+    ### Not public announced methods
+
+    ## Common methods
+
+    # @param [String] name Property name
+    # @param [Boolean, Hash] json
+    def initialize(name, will_update: false, base_type: :page, property_cache: nil, json: {})
+      super name, will_update: will_update, base_type: base_type, property_cache: property_cache
+      @json = json
+    end
+
+    ## Page property only methods
+
+    # @return [Hash]
+    def property_values_json
+      assert_page_property __method__
+      {}
+      #{@name => {"status" => @json, "type" => "status"}}
+    end
+  end
+end

data/lib/notion_ruby_mapping/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module NotionRubyMapping
-  VERSION = "0.6.0"
+  VERSION = "0.6.3"
   NOTION_VERSION = "2022-06-28"
 end

data/lib/notion_ruby_mapping.rb

@@ -12,13 +12,14 @@ require_relative "notion_ruby_mapping/version"
              link_preview_block link_to_page_block numbered_list_item_block paragraph_block pdf_block quote_block
              synced_block table_block table_row_block table_of_contents_block template_block to_do_block
              toggle_block video_block],
-  controllers: %w[notion_cache payload property_cache query rich_text_array],
-  objects: %w[rich_text_object emoji_object equation_object file_object mention_object text_object user_object],
+  controllers: %w[notion_cache payload property_cache query rich_text_array discussion_thread],
+  objects: %w[rich_text_object emoji_object equation_object file_object mention_object text_object user_object
+              comment_object],
   properties: %w[property checkbox_property multi_property created_by_property date_base_property created_time_property
                  date_property email_property files_property formula_property last_edited_by_property
                  last_edited_time_property multi_select_property number_property people_property phone_number_property
-                 relation_property text_property rich_text_property rollup_property select_property title_property
-                 url_property],
+                 relation_property text_property rich_text_property rollup_property select_property status_property
+                 title_property url_property],
 }.each do |key, values|
   values.each do |klass|
     require_relative "notion_ruby_mapping/#{key}/#{klass}"

data/tools/createErDiagram.rb

@@ -0,0 +1,57 @@
+#! /usr/bin/env ruby
+
+require "notion_ruby_mapping"
+include NotionRubyMapping
+
+def append_database(text, db, db_titles)
+  base_title = db_title db
+  normalize_db_title(db, db_titles) if db_titles[db].nil?
+  text << "#{db_titles[db]} {"
+  text << %(  Database title "#{base_title}") unless base_title == db_titles[db]
+  db.properties.reject { |p| p.is_a? RelationProperty }.each_with_index do |p, i|
+    class_name = p.class.name.split("::").last.sub /Property/, ""
+    text << %(  #{class_name} p#{i} "#{p.name}")
+  end
+  text << "}\n"
+end
+
+def normalize_db_title(db, db_titles)
+  base_title = db_title db
+  db_titles[db] = base_title.gsub(/[\w\d\-_]+/, "").empty? ? base_title : "d#{db_titles.count}"
+end
+
+def db_title(db)
+  db.database_title.full_text.gsub " ", "_"
+end
+
+if ARGV.length < 2
+  print "Usage: createErDiagram.rb top_database_id code_block_id"
+  exit
+end
+database_id, code_block_id = ARGV
+NotionCache.instance.create_client ENV["NOTION_API_KEY"]
+block = Block.find code_block_id
+unless block.is_a? CodeBlock
+  print "#{code_block_id} is not CodeBlock's id"
+  exit
+end
+dbs = [Database.find(database_id)]
+text = %w[erDiagram]
+
+finished = {}
+db_titles = {}
+until dbs.empty?
+  db = dbs.shift
+  finished[db] = true
+  append_database(text, db, db_titles)
+  db.properties.select { |pp| pp.is_a? RelationProperty }.each_with_index do |pp, i|
+    new_db = Database.find pp.relation_database_id
+    normalize_db_title(new_db, db_titles) if db_titles[new_db].nil?
+    text << "#{db_titles[db]} |o--o{ #{db_titles[new_db]} : r#{i}"
+    dbs << new_db unless finished[new_db]
+  end
+  text << ""
+end
+block.rich_text_array.rich_text_objects = text.join("\n  ")
+block.language = "mermaid"
+block.save

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notion_ruby_mapping
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.3
 platform: ruby
 authors:
 - Hiroyuki KOBAYASHI
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-22 00:00:00.000000000 Z
+date: 2022-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -192,11 +192,13 @@ files:
 - lib/notion_ruby_mapping/blocks/url_base_block.rb
 - lib/notion_ruby_mapping/blocks/url_caption_base_block.rb
 - lib/notion_ruby_mapping/blocks/video_block.rb
+- lib/notion_ruby_mapping/controllers/discussion_thread.rb
 - lib/notion_ruby_mapping/controllers/notion_cache.rb
 - lib/notion_ruby_mapping/controllers/payload.rb
 - lib/notion_ruby_mapping/controllers/property_cache.rb
 - lib/notion_ruby_mapping/controllers/query.rb
 - lib/notion_ruby_mapping/controllers/rich_text_array.rb
+- lib/notion_ruby_mapping/objects/comment_object.rb
 - lib/notion_ruby_mapping/objects/emoji_object.rb
 - lib/notion_ruby_mapping/objects/equation_object.rb
 - lib/notion_ruby_mapping/objects/file_object.rb
@@ -224,6 +226,7 @@ files:
 - lib/notion_ruby_mapping/properties/rich_text_property.rb
 - lib/notion_ruby_mapping/properties/rollup_property.rb
 - lib/notion_ruby_mapping/properties/select_property.rb
+- lib/notion_ruby_mapping/properties/status_property.rb
 - lib/notion_ruby_mapping/properties/text_property.rb
 - lib/notion_ruby_mapping/properties/title_property.rb
 - lib/notion_ruby_mapping/properties/url_property.rb
@@ -231,6 +234,7 @@ files:
 - notion_ruby_mapping.gemspec
 - sig/notion_ruby_mapping.rbs
 - tools/an
+- tools/createErDiagram.rb
 homepage: https://github.com/hkob/notion_ruby_mapping.git
 licenses:
 - MIT