notion_ruby_mapping 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5b7a318012d2d18a8c1f1d522c3704b1fd3ddc0061bd2e85757a4cca40ca18b
-  data.tar.gz: 56d75c3db55a73139925aaba7239a5a1ac1c782144146e78daa8d52343398be8
+  metadata.gz: 00e3fdb4888f3e3c321215b91e3bb281e2b7683be35109f258b653febca4b697
+  data.tar.gz: 90ffb01da47b66c38b6bf0300b7e53f0302e7ce194ec35dba140a807b38e5239
 SHA512:
-  metadata.gz: ea1203ec3ae1e7d555ce4e0b0d52f745d0cf605e8393ad270c137fbf0f04ee03ff5ad3eff75082e093e3a019fdb02464e2dd0485e41dc038aa1b6ce23485ba30
-  data.tar.gz: 34ce113ef60881ea04ac4636e500e1c542bd1fbdcdde6ceb55fc1080e677ae90cb44ce6bf7bf79a26c50f98c73b086356f607db81d0acc920e91c57057336f76
+  metadata.gz: 41ba458e34fc7f322c470e2a3a3a2b47cc091811267ed014066fc3eea5a9f29d99e48ce6d3e8e3a166cda06682612bd9429b42f2dea70c9072404fa66a76c311
+  data.tar.gz: 5f4205dd334fc5d31bf1e56f2e5ca4cc769feff7f3d5310e9b56c1b93658d837341786936eb1641f5f84cb3fc903c342a3a019cd340d39c837370be6e54d6a04

data/README.md

@@ -101,7 +101,11 @@ NotionCache.instance.create_client token
 
 db = Database.new id: database_id
 db.query_database.each do |page|
-  p page.set_icon(emoji: "💿").id unless page.icon
+  unless page.icon
+    page.set_icon(emoji: "💿")
+    page.save
+    p page.id
+  end
 end
 ```
 
@@ -119,7 +123,7 @@ tp = db.properties["TextTitle"]
 query = tp.filter_is_not_empty.ascending(tp)
 db.query_database(tp.filter_is_not_empty.ascending(tp)).each.with_index(1) do |page, index|
   page.properties["NumberTitle"].number = index
-  page.update
+  page.save
 end
 ```
 
@@ -138,7 +142,7 @@ page = Page.find page_id # API access
 print page.title # -> ABC\nDEF
 tp = page.properties["Title"]
 tp[1].text = "GHI"
-page.update # API access
+page.save # API access
 print page.title # -> ABC\nGHI
 ```
 
@@ -148,7 +152,7 @@ print page.title # -> ABC\nGHI
 page = Page.new id: page_id, assign: [TitleProperty, "Title"]
 tp = page.properties["Title"]
 tp << TextObject.new("JKL")
-page.update # API access
+page.save # API access
 print page.title # -> JKL
 ```
 
@@ -209,9 +213,10 @@ to.text = "ABC" # TextObject can set text by ".text="
 # or tp[1].text = "ABC"
 
 np.number = 3.14159
+page.save # Notion API call
 ```
 
-After update some properties, `page.update` method sends `update page API` and replace the page information using the response of API.
+After update some properties, `page.save` method sends `Notion API` and replace the page information using the response of API.
 
 ```Ruby
 page.update # Notion API call
@@ -221,19 +226,27 @@ page.update # Notion API call
 
 `page.set_icon` can change the page icon using emoji or external url.
 
+[Breaking change on v0.2.2] `page.set_icon` has no longer calling the Notion API.
+Please use `page.save` after `page.set_icon` if you want to update or create the page.
+
 ```Ruby
 # both methods call Notion API
 obj.set_icon emoji: "💿" # set emoji
+obj.save
+
 obj.set_icon url: "https://cdn.profile-image.st-hatena.com/users/hkob/profile.png" # set external url
+obj.save
 ```
 
 #### 4.1.4 other methods
 
+- `page.save` call Notion API, and so on and replace object information.
+- `page.new_record?` returns true if the page was generated by `create_child_page`.
 - `page.title` returns plain_text string of `Title`.
 - `page.icon` returns JSON hash for the page icon.
 - `page[key]` returns a hash or an array object except "properties".
 
-### 4.2 Page
+### 4.2 Database
 
 #### 4.2.1 Retrieve a database
 
@@ -532,7 +545,15 @@ query13 = tp.filter_starts_with("A").ascending(tp)
 [{"property" => "tp", "direction" => "ascending"}]
 ```
 
-#### 4.2.3 Update database
+#### 4.2.3 Create child page
+
+`create_child_page` creates a child page object of the database.
+
+```Ruby
+page = db.create_child_page TitleProperty, "Name"
+```
+
+#### 4.2.4 Update database
 
 === under construction ===
 

data/env.yml.sample

@@ -11,3 +11,4 @@ db_second_page: "6601e719a39a460c908e8909467fcccf"
 db_update_page: "206ffaa277744a99baf593e28730240c"
 user_hkob: "2200a911-6a96-44bb-bd38-6bfb1e01b9f6"
 parent1_page: "860753bb6d1f48de96211fa6e0e31f82"
+parent_database: "1d6b1040a9fb48d99a3d041429816e9f"

data/lib/notion_ruby_mapping/base.rb

@@ -6,13 +6,14 @@ module NotionRubyMapping
     # @param [Hash, nil] json
     # @param [String, nil] id
     # @param [Array<Property, Class, String>] assign
-    def initialize(json: nil, id: nil, assign: [])
+    def initialize(json: nil, id: nil, assign: [], parent: nil)
       @nc = NotionCache.instance
       @json = json
       @id = @nc.hex_id(id || json && @json["id"])
-      raise StandardError, "Unknown id" if !is_a?(List) && @id.nil?
+      @new_record = true unless parent.nil?
+      raise StandardError, "Unknown id" if !is_a?(List) && @id.nil? && parent.nil?
 
-      @payload = nil
+      @payload = Payload.new(parent && {"parent" => parent})
       @property_cache = nil
       assign.each_slice(2) { |(klass, key)| assign_property(klass, key) }
     end
@@ -35,9 +36,8 @@ module NotionRubyMapping
       end
     end
 
-    # @return [NotionRubyMapping::Payload] get or created Payload object
-    def payload
-      @payload ||= Payload.new
+    def new_record?
+      @new_record
     end
 
     # @return [NotionRubyMapping::PropertyCache] get or created PropertyCache object
@@ -63,6 +63,11 @@ module NotionRubyMapping
       update_json reload_json
       self
     end
+    
+   # @return [NotionRubyMapping::Base]
+    def save
+      @new_record ? create : update
+    end
 
     # @return [Hash] json properties
     def json_properties
@@ -86,7 +91,7 @@ module NotionRubyMapping
     end
 
     def restore_from_json
-      payload.clear
+      @payload.clear
       return if (ps = @json["properties"]).nil?
 
       properties.json = json_properties
@@ -102,8 +107,7 @@ module NotionRubyMapping
     # @return [NotionRubyMapping::Base]
     def set_icon(emoji: nil, url: nil)
       if is_a?(Page) || is_a?(Database)
-        payload.set_icon(emoji: emoji, url: url)
-        update
+        @payload.set_icon(emoji: emoji, url: url)
       end
       self
     end
@@ -142,7 +146,7 @@ module NotionRubyMapping
 
     # @return [Hash] created json
     def property_values_json
-      payload.property_values_json @property_cache&.property_values_json
+      @payload.property_values_json @property_cache&.property_values_json
     end
   end
 end

data/lib/notion_ruby_mapping/database.rb

@@ -18,6 +18,12 @@ module NotionRubyMapping
       update_json @nc.update_database_request(@id, property_values_json)
     end
 
+    # @param [Array<Property, Class, String>] assign
+    # @return [NotionRubyMapping::Base]
+    def create_child_page(*assign)
+      Page.new assign: assign, parent: {"database_id" => @id}
+    end
+
     protected
 
     # @return [Hash]

data/lib/notion_ruby_mapping/list.rb

@@ -8,6 +8,7 @@ module NotionRubyMapping
     def initialize(json: nil, id: nil, database: nil, query: nil)
       super(json: json, id: id)
       @has_more = @json["has_more"]
+      @load_all_contents = !@has_more
       @database = database
       @query = query
       @index = 0
@@ -18,30 +19,34 @@ module NotionRubyMapping
     def each
       return enum_for(:each) unless block_given?
 
-      unless @has_content # re-exec
-        @query.start_cursor = nil
-        @json = @database.query_database @query
-        @index = 0
-        @has_more = @json["has_more"]
-        @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 @database
-            @query.start_cursor = @json["next_cursor"]
+      if @database
+        unless @has_content # re-exec
+          unless @load_all_contents
+            @query.start_cursor = nil
             @json = @database.query_database @query
-            @index = 0
             @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 @database
+              @query.start_cursor = @json["next_cursor"]
+              @json = @database.query_database @query
+              @index = 0
+              @has_more = @json["has_more"]
+            else
+              @has_content = false
+            end
           else
             @has_content = false
           end
-        else
-          @has_content = false
         end
       end
     end

data/lib/notion_ruby_mapping/notion_cache.rb

@@ -42,6 +42,11 @@ module NotionRubyMapping
       "v1/pages/#{page_id}"
     end
 
+    # @return [String (frozen)] page_path
+    def pages_path
+      "v1/pages"
+    end
+
     # @param [String] database_id
     # @return [String (frozen)] page_path
     def database_path(database_id)
@@ -124,6 +129,12 @@ module NotionRubyMapping
       request :patch, "v1/pages/#{page_id}", payload
     end
 
+    # @param [Hash] payload
+    # @return [Hash] response
+    def create_page_request(payload)
+      request :post, "v1/pages", payload
+    end
+
     # @param [String] id id string with "-"
     # @return [String] id without "-"
     def hex_id(id)

data/lib/notion_ruby_mapping/page.rb

@@ -7,11 +7,17 @@ module NotionRubyMapping
       NotionCache.instance.page id
     end
 
-    # @return [NotionRubyMapping::Base]
+    # @return [NotionRubyMapping::Base]46G
     def update
       update_json @nc.update_page_request(@id, property_values_json)
     end
 
+    # @return [NotionRubyMapping::Base]
+    def create
+      @new_record = false
+      update_json @nc.create_page_request(property_values_json)
+    end
+
     protected
 
     # @return [Hash]

data/lib/notion_ruby_mapping/payload.rb

@@ -3,8 +3,8 @@
 module NotionRubyMapping
   # Payload class
   class Payload
-    def initialize
-      @json = {}
+    def initialize(json)
+      @json = json || {}
     end
 
     # @param [String] emoji

data/lib/notion_ruby_mapping/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module NotionRubyMapping
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
   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.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Hiroyuki KOBAYASHI
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-14 00:00:00.000000000 Z
+date: 2022-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday