notion_ruby_mapping 0.3.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d23747cdc47703e365e86a5d25d712ea5f11230d0c91b7f9f2d47e48ff6776c
-  data.tar.gz: 7144a79367f716eb887c34bab7eeeb95125854a3294615f7ea4693cd24b7667b
+  metadata.gz: e1d0dd6fcc42d250f8da729a07d788c2f2dd49739cc8810edde17c4eea913f06
+  data.tar.gz: d9c7822db6b4d40505626d95e7e947c8436ca9d2ff0d61409cf15dba30adb97d
 SHA512:
-  metadata.gz: e24af3a6728a7971c1a78f049adba2869a7efc9b36cfe35c60dfb23480943916795383abbe3c8d85e18af1dd3fc4a777b207646278858c2f095cd678277b500c
-  data.tar.gz: d1dceae5b59b71145652dcfb111dd6f82d85ef03ded827a5ae6074c48fccd0dc9a5534484ce55f06b891c09abd94df3467d0ef8576212895e24b699facace115
+  metadata.gz: b568105ff9e1acb644432233c3d2e8de8c7b3151d27f014a331437b90459d3afde4e25f4fd2a0e429149f781fe01cb77664fd12ac00e5990ab64780a031faf1d
+  data.tar.gz: 1f5871c01afe0aae9d15a978b3dfc85ed641b5017210247dc9e80b451afb857e15f0404aaefe3983a27596759a1e7bc4997c21d3c970742d342e6948f035bfd6

data/README.md

@@ -6,7 +6,7 @@ Development note is here. → [Idea note of "notion_ruby_mapping"](https://www.n
 
 ## Table of Contents
 
-- [notion\_ruby\_mapping](#notion_ruby_mapping)
+- [notion_ruby_mapping](#notion_ruby_mapping)
   - [Table of Contents](#table-of-contents)
   - [1. Installation](#1-installation)
   - [2. Example code](#2-example-code)
@@ -31,6 +31,7 @@ Development note is here. → [Idea note of "notion_ruby_mapping"](https://www.n
       - [4.2.6 Add a database property](#426-add-a-database-property)
       - [4.2.7 Rename a database property](#427-rename-a-database-property)
       - [4.2.8 Remove database properties](#428-remove-database-properties)
+      - [4.2.9 other methods](#429-other-methods)
     - [4.3 List class](#43-list-class)
     - [4.4 Block class](#44-block-class)
     - [4.5 Property classes](#45-property-classes)
@@ -133,12 +134,13 @@ page = Page.find "c01166c6-13ae-45cb-b968-18b4ef2f5a77" # Notion API call
 ```
 
 - result of dry run
+
 ```bash
 #!/bin/sh
-curl  'https://api.notion.com/v1/pages/c01166c6-13ae-45cb-b968-18b4ef2f5a77'\
-  -H 'Notion-Version: 2022-02-22'\
-  -H 'Authorization: Bearer '"$NOTION_API_KEY"''\
-  -H 'Content-Type: application/json'⏎
+curl  'https://api.notion.com/v1/pages/c01166c6-13ae-45cb-b968-18b4ef2f5a77' \
+  -H 'Notion-Version: 2022-02-22' \
+  -H 'Authorization: Bearer '"$NOTION_API_KEY"'' \
+  -H 'Content-Type: application/json'
 ```
 
 `Page.new(id)` creates a Page object without the Notion API.  Since Page.new does not acquire property information, so you need to assign yourself.
@@ -217,7 +219,7 @@ db = Database.find "c37a2c66-e3aa-4a0d-a447-73de3b80c253" # Notion API call
 curl  'https://api.notion.com/v1/databases/c37a2c66-e3aa-4a0d-a447-73de3b80c253'\
   -H 'Notion-Version: 2022-02-22'\
   -H 'Authorization: Bearer '"$NOTION_API_KEY"''\
-  -H 'Content-Type: application/json'⏎
+  -H 'Content-Type: application/json'
 ```
 
 `Database.new(id)` creates a Database object without the Notion API.  Since Database.new does not acquire property information, so you need to assign yourself.
@@ -522,18 +524,22 @@ print db.query_database query, dry_run: true
 
 ```
 
-
 #### 4.2.3 Create child page
 
-`create_child_page` creates a child page object of the database.  After setting some properties, please call `page.save` to send page information to Notion.
+`create_child_page` creates a child page object of the database.  After setting some properties, please call `page.save` to send page information to Notion.  Properties of the created child page are automatically assigned using the parent database.  if a block is provided, the method will yield the new Page object and the properties (PropertyCache object) to that block for initialization.
 
 ```Ruby
-page = db.create_child_page TitleProperty, "Name"
-page.properties["Name"] << "New Page"
+page = db.create_child_page do |p, pp|
+  # p is the new Page object
+  # pp is the properties of the new Page object (PropertyCache Object)
+  p.set_icon emoji: "🎉"
+  pp["Name"] << "New Page"
+end
 page.save
 ```
 
 - result of dry run
+
 ```bash
 #!/bin/sh
 curl -X POST 'https://api.notion.com/v1/pages'\
@@ -546,6 +552,7 @@ curl -X POST 'https://api.notion.com/v1/pages'\
 #### 4.2.4 Create database
 
 `create_child_database` method of an existing page creates a child database object.  Some properties of the database can be arrange the option.  Here is a sample script for creating a database that set all types of properties.
+
 ```Ruby
 page = Page.find "a sample page id"
 db = parent_page.create_child_database "New database title",
@@ -666,6 +673,19 @@ curl -X PATCH 'https://api.notion.com/v1/databases/c7697137d49f49c2bbcdd6a665c4f
   --data '{"properties":{"renamed number property":null,"renamed url property":null}}'
 ```
 
+#### 4.2.9 other methods
+
+- `Database.find id, dry_run: true` create shell script for verification.
+- `db.save` call Notion API, and so on and replace object information.
+- `db.save dry_run: true` create shell script for verification.
+- `db.new_record?` returns true if the database was generated by `create_child_database`.
+- `db.database_title` returns plain_text string of `Database`.
+- `db.title` returns plain_text string of `TitleProperty`.
+- `db.icon` returns JSON hash for the page icon.
+- `db[key]` returns a hash or an array object except "properties".
+- `db.created_time` returns CreatedTimeProperty for filter
+- `db.last_edited_time` returns LastEditedTimeProperty for filter
+
 ### 4.3 List class
 
 `db.query_database` and other API list results returns a List object.
@@ -1016,7 +1036,6 @@ p rp.property_values_json
 # Result => {"rp"=>{"type"=>"relation", "relation"=>[{"id"=>"R2"}, {"id"=>"R3"}]}}
 ```
 
-
 #### 4.5.4 create or update values for Database properties
 
 Retrieving Database object with `find` method has database properties of XXXProperties with values.  On the other hand, Assigned Database object has also XXXProperties, but they don't have any information for databases.
@@ -1046,6 +1065,7 @@ print sp.property_schema_json
 ```
 
 If you want to edit existing values, you should access `edit_select_options` array.  It sets `will_update` flag to true.
+
 ```Ruby
 sp.edit_select_options[0]["name"] = "new S1"
 p sp.property_values_json
@@ -1064,6 +1084,7 @@ print msp.property_schema_json
 ```
 
 If you want to edit existing values, you should access `edit_multi_select_options` array.  It sets `will_update` flag to true.
+
 ```Ruby
 msp.edit_multi_select_options[0]["name"] = "new MS1"
 p msp.property_values_json
@@ -1251,6 +1272,8 @@ textMentionObjects = RichTextArray.new "title", [TextObject.new("A TextObject"),
 
 ## 6. ChangeLog
 
+- 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

data/lib/notion_ruby_mapping/base.rb

@@ -19,7 +19,10 @@ module NotionRubyMapping
       @property_cache = nil
       @created_time = nil
       @last_edited_time = nil
+      return if assign.empty?
+
       assign.each_slice(2) { |(klass, key)| assign_property(klass, key) }
+      @json ||= {}
     end
     attr_reader :json, :id
 
@@ -41,7 +44,7 @@ module NotionRubyMapping
 
     # @return [NotionRubyMapping::CreatedTimeProperty]
     def created_time
-      @created_time ||= CreatedTimeProperty.new("title")
+      @created_time ||= CreatedTimeProperty.new("__timestamp__")
     end
 
     # @return [TrueClass, FalseClass] true if Database object
@@ -54,6 +57,11 @@ module NotionRubyMapping
       self["icon"]
     end
 
+    # @return [NotionRubyMapping::LastEditedTimeProperty]
+    def last_edited_time
+      @last_edited_time ||= LastEditedTimeProperty.new("__timestamp__")
+    end
+
     # @return [Boolean] true if new record
     def new_record?
       @new_record
@@ -168,7 +176,7 @@ module NotionRubyMapping
     # @param [Hash] json
     # @return [NotionRubyMapping::Base]
     def update_json(json)
-      raise StandardError, json.inspect unless json["object"] != "error" && @json.nil? || @json["type"] == json["type"]
+      raise StandardError, json.inspect unless json["object"] != "error" && (@json.nil? || @json["type"] == json["type"])
 
       @json = json
       @id = @nc.hex_id(@json["id"])
@@ -189,11 +197,11 @@ module NotionRubyMapping
       shell = [
         "#!/bin/sh\ncurl #{method == :get ? "" : "-X #{method.to_s.upcase}"} 'https://api.notion.com/#{path}'",
         "  -H 'Notion-Version: 2022-02-22'",
-        "  -H 'Authorization: Bearer '\"$NOTION_API_KEY\"''"
+        "  -H 'Authorization: Bearer '\"$NOTION_API_KEY\"''",
       ]
       shell << "  -H 'Content-Type: application/json'" unless path == :get
       shell << "  --data '#{JSON.generate json}'" if json
-      shell.join("\\ \n")
+      shell.join(" \\\n")
     end
 
     protected

data/lib/notion_ruby_mapping/database.rb

@@ -30,7 +30,12 @@ module NotionRubyMapping
     # @param [Array<Property, Class, String>] assign
     # @return [NotionRubyMapping::Base]
     def create_child_page(*assign)
-      Page.new assign: assign, parent: {"database_id" => @id}
+      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
     end
 
     # @return [NotionRubyMapping::RichTextArray]

data/lib/notion_ruby_mapping/property.rb

@@ -91,6 +91,8 @@ module NotionRubyMapping
     def make_filter_query(key, value, rollup = nil, rollup_type = nil)
       if rollup
         Query.new filter: {"property" => @name, rollup => {rollup_type => {key => value}}}
+      elsif @name == "__timestamp__"
+        Query.new filter: {"timestamp" => type, type => {key => value}}
       else
         Query.new filter: {"property" => @name, type => {key => value}}
       end

data/lib/notion_ruby_mapping/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module NotionRubyMapping
-  VERSION = "0.3.0"
+  VERSION = "0.3.3"
   NOTION_VERSION = "2022-02-22"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notion_ruby_mapping
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Hiroyuki KOBAYASHI
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-25 00:00:00.000000000 Z
+date: 2022-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday