notion_ruby_mapping 0.6.6 → 0.6.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1a2aa2a4c8880559f3a314967335cfd4f008b9884890111b6d5edfcb0f6251c
-  data.tar.gz: 52ece830f67e3373f653f60dcee81b1076c5ab095eb9d53bb4d0e3340c76bc7c
+  metadata.gz: 1372e3b57aef4a44d060751e07ba15bd224d23b974ff46426ac4e40a10c0b0b6
+  data.tar.gz: b6310155b12dcb73f022bd9415667c67b8a78246377622128fb0bcd2eccb4bd9
 SHA512:
-  metadata.gz: 7b70e9092468ef61744ec120e499402daf214e35d5c86158d4b44fc3fb9d7262e6d5b82e6763b20554f843996a9d614bd181b09baad66f2533fa1a076b15555b
-  data.tar.gz: e618b6066d6d17e4564cdfbadda3b3f0d7b598740f5b3ed1c2a9c2b640d28284cfa8ecfc1676fb0de6be0d604cd24670856ce112e049fbe5a91ac44b4404b05b
+  metadata.gz: 01a32f40c022b5916891409b823bf76efd02414520e14eb98dc1f7ec49901fcc60fd085c845fe71f0b38a5d3776e32a6c9bce4e5c2efb5edce750f2b24a66ff8
+  data.tar.gz: 06babf96d0c07ccc74c2ab24ccf55500ed8c75506c2e5c0c95837968795af8192eea3e773ca153254048a63204ed6fed4996a1a25f74ced78187d52114c4ca4a

data/README.md

@@ -92,6 +92,8 @@ NotionCache.instance.create_client ENV["NOTION_API_TOKEN"] # from environment
 
 ## 3. ChangeLog
 
+- 2022/11/13 [v0.6.8] remove error checking for start and end dates, add Users.all, and change Rollup and Formula query specification
+- 2022/9/2 [v0.6.7] add support for Status property, is_toggleable for headings block, and page property values
 - 2022/8/10 [v0.6.6] Bug fix(notionSitemap.rb): Skip if child page is empty.
 - 2022/8/10 [v0.6.5] add notionSitemap.rb, rename createErDiagram to notionErDiagram, and move them to exe directory
 - 2022/8/9 [v0.6.4] url can be entered instead of page_id, block_id and database_id

data/lib/notion_ruby_mapping/blocks/base.rb

@@ -60,7 +60,7 @@ module NotionRubyMapping
       end
     end
 
-    # @param [Object] method
+    # @param [Symbol] method
     # @param [Object] path
     # @param [nil] json
     def self.dry_run_script(method, path, json = nil)
@@ -82,6 +82,7 @@ module NotionRubyMapping
       end
     end
 
+    # @param [Boolean] dry_run true if dry_run
     def comments(query = nil, dry_run: false)
       return unless page? || block?
 
@@ -89,7 +90,7 @@ module NotionRubyMapping
         self.class.dry_run_script :get, @nc.retrieve_comments_path(@id)
       else
         ans = {}
-        List.new(comment_parent: self,
+        List.new(type: :comment_parent, value: self,
                  json: @nc.retrieve_comments_request(@id, query),
                  query: query).each do |comment|
           dt_id = comment.discussion_id
@@ -117,7 +118,7 @@ module NotionRubyMapping
     end
 
     # @param [Array<Block>] blocks
-    # @param [Boolean] dry_run
+    # @param [Boolean] dry_run true if dry_run
     # @return [NotionRubyMapping::Block, String]
     # @see https://www.notion.so/hkob/Page-d359650e3ca94424af8359a24147b9a0#44bbf83d852c419485c5efe9fe1558fb
     # @see https://www.notion.so/hkob/Block-689ad4cbff50404d8a1baf67b6d6d78d#2c47f7fedae543cf8566389ba1677132
@@ -180,7 +181,7 @@ module NotionRubyMapping
     end
 
     # @param [NotionRubyMapping::Query] query
-    # @param [Boolean] dry_run
+    # @param [Boolean] dry_run true if dry_run
     # @return [NotionRubyMapping::List, String]
     def children(query = Query.new, dry_run: false)
       if dry_run
@@ -190,7 +191,7 @@ module NotionRubyMapping
         @children
       else
         response = @nc.block_children_request @id, query.query_string
-        @children = List.new json: response, parent: self, query: query
+        @children = List.new json: response, type: :parent, value: self, query: query
       end
     end
 
@@ -236,6 +237,7 @@ module NotionRubyMapping
       is_a? Page
     end
 
+    # @param [Boolean] dry_run true if dry_run
     def parent(dry_run: false)
       parent_json = @json && @json["parent"]
       raise StandardError, "Unknown parent" if parent_json.nil?
@@ -298,7 +300,7 @@ module NotionRubyMapping
       self
     end
 
-    # @param [Boolean] dry_run
+    # @param [Boolean] dry_run true if dry_run
     # @return [NotionRubyMapping::Base, NotionRubyMapping::Database, String]
     # @see https://www.notion.so/hkob/Page-d359650e3ca94424af8359a24147b9a0#277085c8439841c798a4b94eae9a7326
     def save(dry_run: false)

data/lib/notion_ruby_mapping/blocks/block.rb

@@ -64,6 +64,7 @@ module NotionRubyMapping
 
     # @see https://www.notion.so/hkob/Block-689ad4cbff50404d8a1baf67b6d6d78d#298916c7c379424682f39ff09ee38544
     # @param [String] id
+    # @param [Boolean] dry_run true if dry_run
     # @return [NotionRubyMapping::Block]
     def self.find(id, dry_run: false)
       nc = NotionCache.instance
@@ -104,7 +105,7 @@ module NotionRubyMapping
       @rich_text_array = RichTextArray.new "rich_text", json: @json[type]["rich_text"]
     end
 
-    # @param [Boolean] dry_run
+    # @param [Boolean] dry_run true if dry_run
     # @return [NotionRubyMapping::Base, String]
     def destroy(dry_run: false)
       if dry_run
@@ -114,6 +115,7 @@ module NotionRubyMapping
       end
     end
 
+    # @param [Boolean] dry_run true if dry_run
     # @return [NotionRubyMapping::Base, String]
     def update(dry_run: false)
       if dry_run

data/lib/notion_ruby_mapping/blocks/database.rb

@@ -6,6 +6,7 @@ module NotionRubyMapping
     ### Public announced methods
 
     # @param [String] id
+    # @param [Boolean] dry_run true if dry_run
     # @return [NotionRubyMapping::Database, String]
     # @see https://www.notion.so/hkob/Database-1462b24502424539a4231bedc07dc2f5#58ba9190fd544432a9e2a5823d6c33b7
     def self.find(id, dry_run: false)
@@ -49,6 +50,7 @@ module NotionRubyMapping
     end
 
     # @param [Array<Property, Class, String>] assign
+    # @param [Boolean] dry_run true if dry_run
     # @return [NotionRubyMapping::Base]
     # @see https://www.notion.so/hkob/Database-1462b24502424539a4231bedc07dc2f5#c217ce78020a4de79b720790fce3092d
     def create_child_page(*assign, dry_run: false)
@@ -97,6 +99,7 @@ module NotionRubyMapping
     end
 
     # @param [NotionRubyMapping::Query] query object
+    # @param [Boolean] dry_run true if dry_run
     # @return [NotionRubyMapping::List, String]
     # @see https://www.notion.so/hkob/Database-1462b24502424539a4231bedc07dc2f5#6bd9acf62c454f64bc555c8828057e6b
     def query_database(query = Query.new, dry_run: false)
@@ -104,7 +107,7 @@ module NotionRubyMapping
         Base.dry_run_script :post, @nc.query_database_path(@id), query.query_json
       else
         response = @nc.database_query_request @id, query
-        List.new json: response, database: self, query: query
+        List.new json: response, type: :database, value: self, query: query
       end
     end
 
@@ -130,6 +133,7 @@ module NotionRubyMapping
 
     protected
 
+    # @param [Boolean] dry_run true if dry_run
     def create(dry_run: false)
       if dry_run
         dry_run_script :post, @nc.databases_path, :property_schema_json
@@ -145,6 +149,7 @@ module NotionRubyMapping
       @nc.database_request @id
     end
 
+    # @param [Boolean] dry_run true if dry_run
     # @return [NotionRubyMapping::Base, String]
     def update(dry_run: false)
       if dry_run

data/lib/notion_ruby_mapping/blocks/heading1_block.rb

@@ -14,5 +14,13 @@ module NotionRubyMapping
     def type
       "heading_1"
     end
+
+    # @param [Boolean] not_update false when update
+    # @return [Hash{String (frozen)->Hash}]
+    def block_json(not_update: true)
+      ans = super
+      ans[type]["is_toggleable"] = false
+      ans
+    end
   end
 end

data/lib/notion_ruby_mapping/blocks/heading2_block.rb

@@ -14,5 +14,13 @@ module NotionRubyMapping
     def type
       "heading_2"
     end
+
+    # @param [Boolean] not_update false when update
+    # @return [Hash{String (frozen)->Hash}]
+    def block_json(not_update: true)
+      ans = super
+      ans[type]["is_toggleable"] = false
+      ans
+    end
   end
 end

data/lib/notion_ruby_mapping/blocks/heading3_block.rb

@@ -14,5 +14,13 @@ module NotionRubyMapping
     def type
       "heading_3"
     end
+
+    # @param [Boolean] not_update false when update
+    # @return [Hash{String (frozen)->Hash}]
+    def block_json(not_update: true)
+      ans = super
+      ans[type]["is_toggleable"] = false
+      ans
+    end
   end
 end

data/lib/notion_ruby_mapping/blocks/list.rb

@@ -5,14 +5,23 @@ module NotionRubyMapping
   class List < Base
     include Enumerable
 
-    def initialize(json: nil, id: nil, database: nil, parent: nil, property: nil, comment_parent: nil, query: nil)
+    def initialize(json: nil, id: nil, type: nil, value: 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
+
+      case type
+      when :comment_parent
+        @comment_parent = value
+      when :database
+        @database = value
+      when :parent
+        @parent = value
+      when :property
+        @property = value
+      when :user_object
+        @user_object = true
+      end
       @query = query
       @index = 0
       @has_content = true
@@ -60,6 +69,11 @@ module NotionRubyMapping
                  query: -> { @nc.retrieve_comments_request @comment_parent.id, @query },
                  create_object: ->(json) { CommentObject.new json: json },
                  &block
+      elsif @user_object
+        each_sub base: @user_object,
+                 query: -> { @nc.users_request @query.query_json },
+                 create_object: ->(json) { UserObject.new json: json },
+                 &block
       end
       self
     end

data/lib/notion_ruby_mapping/blocks/page.rb

@@ -6,6 +6,7 @@ module NotionRubyMapping
     ### Public announced methods
 
     # @param [String] id
+    # @param [Boolean] dry_run true if dry_run
     # @return [NotionRubyMapping::Page, String]
     # @see https://www.notion.so/hkob/Page-d359650e3ca94424af8359a24147b9a0#7d868b8b81c3473082bbdc7370813a4a
     def self.find(id, dry_run: false)
@@ -24,6 +25,7 @@ module NotionRubyMapping
       get key
     end
 
+    # @param [Boolean] dry_run true if dry_run
     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}})
@@ -47,7 +49,8 @@ module NotionRubyMapping
 
     # @param [String] title
     # @param [Array<String, Property>] assigns
-    # @return [NotionRubyMapping::Database]
+    # @param [Boolean] dry_run true if dry_run
+    # @return [NotionRubyMapping::Database, String]
     # @see https://www.notion.so/hkob/Page-d359650e3ca94424af8359a24147b9a0#e3f1d21e0f724f589e48431468772eed
     def create_child_database(title, *assigns, dry_run: false)
       build_child_database(title, *assigns).save dry_run: dry_run
@@ -56,12 +59,13 @@ module NotionRubyMapping
     # @return [String] title
     # @see https://www.notion.so/hkob/Page-d359650e3ca94424af8359a24147b9a0#2ff7209055f346fbbda454cdbb40b1c8
     def title
-      tp = properties.select { |p| (p.is_a?(TitleProperty)) || (p.is_a?(Property) && p.property_id == "title") }
+      tp = properties.select { |p| p.is_a?(TitleProperty) || (p.is_a?(Property) && p.property_id == "title") }
       tp.map(&:full_text).join ""
     end
 
     protected
 
+    # @param [Boolean] dry_run true if dry_run
     # @return [NotionRubyMapping::Base, String]
     def create(dry_run: false)
       if dry_run
@@ -77,6 +81,7 @@ module NotionRubyMapping
       @nc.page_request @id
     end
 
+    # @param [Boolean] dry_run true if dry_run
     # @return [NotionRubyMapping::Base, String]
     def update(dry_run: false)
       if dry_run

data/lib/notion_ruby_mapping/blocks/toggle_heading1_block.rb

@@ -7,5 +7,13 @@ module NotionRubyMapping
     def type
       "heading_1"
     end
+
+    # @param [Boolean] not_update false when update
+    # @return [Hash{String (frozen)->Hash}]
+    def block_json(not_update: true)
+      ans = super
+      ans[type]["is_toggleable"] = true
+      ans
+    end
   end
 end

data/lib/notion_ruby_mapping/blocks/toggle_heading2_block.rb

@@ -7,5 +7,13 @@ module NotionRubyMapping
     def type
       "heading_2"
     end
+
+    # @param [Boolean] not_update false when update
+    # @return [Hash{String (frozen)->Hash}]
+    def block_json(not_update: true)
+      ans = super
+      ans[type]["is_toggleable"] = true
+      ans
+    end
   end
 end

data/lib/notion_ruby_mapping/blocks/toggle_heading3_block.rb

@@ -7,5 +7,13 @@ module NotionRubyMapping
     def type
       "heading_3"
     end
+
+    # @param [Boolean] not_update false when update
+    # @return [Hash{String (frozen)->Hash}]
+    def block_json(not_update: true)
+      ans = super
+      ans[type]["is_toggleable"] = true
+      ans
+    end
   end
 end

data/lib/notion_ruby_mapping/controllers/discussion_thread.rb

@@ -11,7 +11,7 @@ module NotionRubyMapping
     attr_reader :discussion_id, :comments
 
     # @param [String] text_objects
-    # @param [Boolean] dry_run
+    # @param [Boolean] dry_run true if 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

data/lib/notion_ruby_mapping/controllers/notion_cache.rb

@@ -284,5 +284,40 @@ module NotionRubyMapping
     def update_page_request(page_id, payload)
       request :patch, page_path(page_id), payload
     end
+
+    # @param [String] id user_id (with or without "-")
+    # @return [NotionRubyMapping::UserObject] UserObject object or nil
+    def user(id)
+      UserObject.new json: user_request(id)
+    end
+
+    # @param [String] user_id
+    # @return [String (frozen)] user_path
+    def user_path(user_id)
+      "v1/users/#{user_id}"
+    end
+
+    # @param [String] user_id
+    # @return [Hash] response
+    def user_request(user_id)
+      request :get, user_path(user_id)
+    end
+
+    # @return [Array<NotionRubyMapping::UserObject>] UserObject array
+    def users
+      List.new json: users_request, type: :user_object, value: true
+    end
+
+    # @return [String (frozen)] user_path
+    def users_path(option = "")
+      "v1/users#{option}"
+    end
+
+    # @param [String] user_id
+    # @param [NotionRubyMapping::Query] query query object
+    # @return [Hash] response
+    def users_request(query = Query.new)
+      request :get, users_path, query.query_json
+    end
   end
 end

data/lib/notion_ruby_mapping/controllers/property_cache.rb

@@ -48,6 +48,10 @@ module NotionRubyMapping
       end
     end
 
+    def inspect
+      "PropertyCache"
+    end
+
     # @return [Hash] created property values json
     def property_values_json
       @properties.each_with_object({}) do |(_, property), ans|

data/lib/notion_ruby_mapping/objects/comment_object.rb

@@ -16,7 +16,7 @@ module NotionRubyMapping
       end
       @will_update = false
     end
-    attr_reader :will_update, :text_objects
+    attr_reader :will_update, :text_objects, :json
 
     def discussion_id
       NotionCache.instance.hex_id @json["discussion_id"]

data/lib/notion_ruby_mapping/objects/user_object.rb

@@ -6,11 +6,38 @@ module NotionRubyMapping
     # @param [String] user_id
     # @return [TextObject]
     def initialize(user_id: nil, json: {})
-      @user_id = user_id || json && json["id"]
+      @user_id = NotionCache.instance.hex_id(user_id || json && json["id"])
       @json = json
       @will_update = false
     end
-    attr_reader :will_update, :user_id
+    attr_reader :will_update, :user_id, :json
+
+    # @param [Boolean] dry_run true if dry_run
+    def self.all(dry_run: false)
+      nc = NotionCache.instance
+      if dry_run
+        Base.dry_run_script :get, nc.users_path
+      else
+        nc.users
+      end
+    end
+
+    # @param [String] user_id
+    # @param [Boolean] dry_run true if dry_run
+    # @return [NotionRubyMapping::UserObject, String]
+    def self.find(user_id, dry_run: false)
+      nc = NotionCache.instance
+      if dry_run
+        Base.dry_run_script :get, nc.user_path(user_id)
+      else
+        nc.user user_id
+      end
+    end
+
+    # @param [Boolean] dry_run true if dry_run
+    def self.find_me(dry_run: false)
+      find "me", dry_run: dry_run
+    end
 
     # @param [UserObject, String] uo
     # @return [UserObject] self or created UserObject
@@ -22,6 +49,11 @@ module NotionRubyMapping
       end
     end
 
+    # @return [String (frozen)]
+    def inspect
+      "#{self.class.name}-#{@user_id}"
+    end
+
     # @return [String]
     def name
       @json["name"]
@@ -36,7 +68,7 @@ module NotionRubyMapping
     end
 
     def user_id=(new_user_id)
-      @user_id = new_user_id
+      @user_id = NotionCache.instance.hex_id new_user_id
       @will_update = true
     end
   end

data/lib/notion_ruby_mapping/properties/checkbox_property.rb

@@ -10,7 +10,7 @@ module NotionRubyMapping
 
     ## Common methods
 
-    # @return [Boolean, Hash]
+    # @return [Boolean, Hash, nil]
     # @see https://www.notion.so/hkob/CheckboxProperty-ac1edbdb8e264af5ad1432b522b429fd#20da1bf0cbcc4d4eb22d9125386522c2
     def checkbox
       @json
@@ -33,8 +33,9 @@ module NotionRubyMapping
 
     # @param [String] name Property name
     # @param [Boolean, Hash] json
-    def initialize(name, will_update: false, base_type: :page, property_cache: nil, json: nil)
-      super name, will_update: will_update, base_type: base_type, property_cache: property_cache
+    def initialize(name, will_update: false, base_type: :page, property_id: nil, property_cache: nil, json: nil)
+      super name, will_update: will_update, base_type: base_type, property_id: property_id,
+                  property_cache: property_cache
       @json = if database?
                 json || {}
               else

data/lib/notion_ruby_mapping/properties/created_by_property.rb

@@ -22,8 +22,10 @@ module NotionRubyMapping
     # @param [String] name Property name
     # @param [String] user_id user_id (optional)
     # @param [Hash] json json (optional)
-    def initialize(name, will_update: false, base_type: :page, json: nil, user_id: nil, property_cache: nil)
-      super name, will_update: will_update, base_type: base_type, property_cache: property_cache
+    def initialize(name, will_update: false, base_type: :page, json: nil, user_id: nil, property_id: nil,
+                   property_cache: nil)
+      super name, will_update: will_update, base_type: base_type, property_id: property_id,
+                  property_cache: property_cache
       @json = if database?
                 json || {}
               else

data/lib/notion_ruby_mapping/properties/created_time_property.rb

@@ -21,8 +21,9 @@ module NotionRubyMapping
 
     # @param [String] name Property name
     # @param [String] json created_time value (optional)
-    def initialize(name, will_update: false, base_type: :page, json: nil, property_cache: nil)
-      super name, will_update: will_update, base_type: base_type, property_cache: property_cache
+    def initialize(name, will_update: false, base_type: :page, json: nil, property_id: nil, property_cache: nil)
+      super name, will_update: will_update, base_type: base_type, property_id: property_id,
+                  property_cache: property_cache
       @json = json
       @json ||= {} if database?
     end