notion_ruby_mapping 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d2f6819154bd2ae6fb448cd36d06311d20e6ba29a0e2e4fda6584d49ca58732
-  data.tar.gz: 042e30bda77b5c21a3226a37579254e52eb19d537abaa94a5233238846ba6a76
+  metadata.gz: 20cd62581513083b2b99d6fad57d3486fc855bf390f96ba01da263fa47e16029
+  data.tar.gz: da20deff5ce1e53cbbe7d2cda86550676eea088fe1fee890385490b07cfa55ad
 SHA512:
-  metadata.gz: 69419656c3c728d5472aade37de759a2a9b58124cd6856df7ecfa9b0838f5755af84f80a9936434a82991a7418a9f33de6188c87b20afff32573565c64ea5099
-  data.tar.gz: '093e56922c2f2aef5b6efd45043472e165b8bc3d04cce3613b9d1f363d779adca495982c818091e067dc9413107afbd26371ba73676d4def61b8abc1e1ea83b8'
+  metadata.gz: 68fd906fb46c5957d5eb48a41f41752c61a8fb40a7283dfa9ec3e4a95173c38401a966f24707893bdc1ded47ed76606990031488e2100eac234e4e53197de005
+  data.tar.gz: d79d601217f69788eee522185868e5ded0e44598a60e9a4e4173c98b4df96c262c7516893e8f3829ac5d202491cad6c1548bb4de53d1646a691dacc6e8d3a6c8

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.1"
+  VERSION = "0.6.2"
   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

@@ -36,7 +36,7 @@ until dbs.empty?
   append_database(text, db)
   db.properties.select { |p| p.is_a? RelationProperty }.each_with_index do |p, i|
     new_db = Database.find p.relation_database_id
-    text << "#{db_title db} ||--o{ #{db_title new_db} : r#{i}"
+    text << "#{db_title db} |o--o{ #{db_title new_db} : r#{i}"
     dbs << new_db unless finished[new_db]
   end
   text << ""

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notion_ruby_mapping
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Hiroyuki KOBAYASHI
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-28 00:00:00.000000000 Z
+date: 2022-08-07 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