notion_ruby_mapping 0.2.3 → 0.3.0

data/env.yml.sample

@@ -12,3 +12,4 @@ db_update_page: "206ffaa277744a99baf593e28730240c"
 user_hkob: "2200a911-6a96-44bb-bd38-6bfb1e01b9f6"
 parent1_page: "860753bb6d1f48de96211fa6e0e31f82"
 parent_database: "1d6b1040a9fb48d99a3d041429816e9f"
+created_database: "c7697137d49f49c2bbcdd6a665c4f921"

data/examples/change_title.md

@@ -0,0 +1,26 @@
+# Change title
+
+The following code update the page title.
+
+#### Pattern 1 (replace existing text partially)
+
+```Ruby
+page = Page.find page_id # API access
+print page.title # -> ABC\nDEF
+tp = page.properties["Title"]
+tp[1].text = "GHI"
+page.save # API access
+print page.title # -> ABC\nGHI
+```
+
+#### Pattern 2 (replace all text)
+
+```Ruby
+page = Page.new id: page_id, assign: [TitleProperty, "Title"]
+tp = page.properties["Title"]
+tp << TextObject.new("JKL")
+page.save # API access
+print page.title # -> JKL
+```
+---
+[Return to README.md](../README.md#2-example-code)

data/examples/renumbering_pages.md

@@ -0,0 +1,20 @@
+# Renumbering pages
+
+The following code sets serial numbers to the pages whose title is not empty in ascending order of titles.
+
+```Ruby
+db = Database.new id: database_id, assign: [RichTextProperty, "TextTitle"]
+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.save
+end
+```
+
+| After execution                               |
+|-----------------------------------------------|
+| ![After exuecution](../images/serial_number.png) |
+
+---
+[Return to README.md](../README.md#2-example-code)

data/examples/set_icon_to_all_icon_unsettled_pages.md

@@ -0,0 +1,30 @@
+# Set icon to all icon unsettled pages
+
+The following code sets a "💿" icon on all unset pages in the database.
+
+```Ruby
+require "notion_ruby_mapping"
+
+include NotionRubyMapping
+
+token = ENV["NOTION_API_TOKEN"]
+database_id = ENV["DATABASE_ID"]
+
+NotionCache.instance.create_client token
+
+db = Database.new id: database_id
+db.query_database.each do |page|
+  unless page.icon
+    page.set_icon(emoji: "💿")
+    page.save
+    p page.id
+  end
+end
+```
+
+|Before execution|After execution|
+|---|---|
+|![Before execution](../images/pre_set_icon.png)|![After execution](../images/post_set_icon.png)|
+
+---
+[Return to README.md](../README.md#2-example-code)

data/lib/notion_ruby_mapping/base.rb

@@ -3,6 +3,8 @@
 module NotionRubyMapping
   # Notion Base object (Parent of Page / Database / List)
   class Base
+    #### Public announced methods
+
     # @param [Hash, nil] json
     # @param [String, nil] id
     # @param [Array<Property, Class, String>] assign
@@ -15,31 +17,53 @@ module NotionRubyMapping
 
       @payload = Payload.new(parent && {"parent" => parent})
       @property_cache = nil
+      @created_time = nil
+      @last_edited_time = nil
       assign.each_slice(2) { |(klass, key)| assign_property(klass, key) }
     end
     attr_reader :json, :id
 
-    # @param [Hash, Notion::Messages] json
-    # @return [NotionRubyMapping::Base]
-    def self.create_from_json(json)
-      case json["object"]
-      when "page"
-        Page.new json: json
-      when "database"
-        Database.new json: json
-      when "list"
-        List.new json: json
-      when "block"
-        Block.new json: json
+    # @param [String] key
+    # @return [NotionRubyMapping::PropertyCache, Hash] obtained Page value or PropertyCache
+    def [](key)
+      unless @json
+        raise StandardError, "Unknown id" if @id.nil?
+
+        reload
+      end
+      case key
+      when "properties"
+        properties
       else
-        raise StandardError, json.inspect
+        @json[key]
       end
     end
 
+    # @return [NotionRubyMapping::CreatedTimeProperty]
+    def created_time
+      @created_time ||= CreatedTimeProperty.new("title")
+    end
+
+    # @return [TrueClass, FalseClass] true if Database object
+    def database?
+      is_a? Database
+    end
+
+    # @return [Hash, nil] obtained Hash
+    def icon
+      self["icon"]
+    end
+
+    # @return [Boolean] true if new record
     def new_record?
       @new_record
     end
 
+    # @return [TrueClass, FalseClass] true if Page object
+    def page?
+      is_a? Page
+    end
+
     # @return [NotionRubyMapping::PropertyCache] get or created PropertyCache object
     def properties
       unless @property_cache
@@ -48,30 +72,68 @@ module NotionRubyMapping
 
           reload
         end
-        @property_cache = PropertyCache.new json_properties
+        @property_cache = PropertyCache.new json_properties, base_type: database? ? :database : :page
       end
       @property_cache
     end
 
+    # @return [NotionRubyMapping::Base, String]
+    def save(dry_run: false)
+      if dry_run
+        @new_record ? create(dry_run: true) : update(dry_run: true)
+      else
+        @new_record ? create : update
+        @property_cache.clear_will_update
+        @payload.clear
+        self
+      end
+    end
+
+    # @param [String] emoji
+    # @param [String] url
+    # @return [NotionRubyMapping::Base]
+    def set_icon(emoji: nil, url: nil)
+      @payload.set_icon(emoji: emoji, url: url) if page? || database?
+      self
+    end
+
     # @return [String] title
     def title
       properties.select { |p| p.is_a? TitleProperty }.map(&:full_text).join ""
     end
 
-    # @return [NotionRubyMapping::Base] reloaded self
-    def reload
-      update_json reload_json
-      self
-    end
-    
-   # @return [NotionRubyMapping::Base]
-    def save
-      @new_record ? create : update
+    ### Not public announced methods
+
+    # @param [Hash, Notion::Messages] json
+    # @return [NotionRubyMapping::Base]
+    def self.create_from_json(json)
+      case json["object"]
+      when "page"
+        Page.new json: json
+      when "database"
+        Database.new json: json
+      when "list"
+        List.new json: json
+      when "block"
+        Block.new json: json
+      else
+        raise StandardError, json.inspect
+      end
     end
 
-    # @return [Hash] json properties
-    def json_properties
-      @json && @json["properties"]
+    # @param [NotionRubyMapping::Property] klass
+    # @param [String] title
+    # @return [NotionRubyMapping::Property] generated property
+    def assign_property(klass, title)
+      @property_cache ||= PropertyCache.new({}, base_type: database? ? :database : :page)
+
+      property = if database?
+                   klass.new(title, will_update: new_record?, base_type: :database)
+                 else
+                   klass.new(title, will_update: true, base_type: :page)
+                 end
+      @property_cache.add_property property
+      property
     end
 
     # @return [NotionRubyMapping::List]
@@ -79,74 +141,65 @@ module NotionRubyMapping
       @children ||= @nc.block_children(id)
     end
 
-    # @param [Hash] json
-    # @return [NotionRubyMapping::Base]
-    def update_json(json)
-      raise StandardError, json.inspect unless json["object"] != "error" && @json.nil? || @json["type"] == json["type"]
+    # @return [Hash] created json for update page
+    def property_values_json
+      @payload.property_values_json @property_cache
+    end
 
-      @json = json
-      @id = @nc.hex_id(@json["id"])
-      restore_from_json
+    # @return [NotionRubyMapping::Base] reloaded self
+    def reload
+      update_json reload_json
       self
     end
 
+    # @return [NotionRubyMapping::Base]
     def restore_from_json
-      @payload.clear
       return if (ps = @json["properties"]).nil?
 
       properties.json = json_properties
-      return unless is_a? Page
+      return unless is_a?(Page) || is_a?(Database)
 
       ps.each do |key, json|
         properties[key].update_from_json json
       end
+      self
     end
 
-    # @param [String] emoji
-    # @param [String] url
+    # @param [Hash] json
     # @return [NotionRubyMapping::Base]
-    def set_icon(emoji: nil, url: nil)
-      if is_a?(Page) || is_a?(Database)
-        @payload.set_icon(emoji: emoji, url: url)
-      end
+    def update_json(json)
+      raise StandardError, json.inspect unless json["object"] != "error" && @json.nil? || @json["type"] == json["type"]
+
+      @json = json
+      @id = @nc.hex_id(@json["id"])
+      restore_from_json
       self
     end
 
-    # @param [String] key
-    # @return [NotionRubyMapping::PropertyCache, Hash] obtained Page value or PropertyCache
-    def [](key)
-      unless @json
-        raise StandardError, "Unknown id" if @id.nil?
-
-        reload
-      end
-      case key
-      when "properties"
-        properties
-      else
-        @json[key]
-      end
+    # protected
+    # @return [Hash] json properties
+    def json_properties
+      @json && @json["properties"]
     end
 
-    # @return [Hash, nil] obtained Hash
-    def icon
-      self["icon"]
+    # @param [Object] method
+    # @param [Object] path
+    # @param [nil] json
+    def self.dry_run_script(method, path, json = nil)
+      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\"''"
+      ]
+      shell << "  -H 'Content-Type: application/json'" unless path == :get
+      shell << "  --data '#{JSON.generate json}'" if json
+      shell.join("\\ \n")
     end
 
-    # @param [Property, Class] klass
-    # @param [String] title
-    # @return [Property] generated property
-    def assign_property(klass, title)
-      @property_cache ||= PropertyCache.new {}
-
-      property = klass.new(title, will_update: true)
-      @property_cache.add_property property
-      property
-    end
+    protected
 
-    # @return [Hash] created json
-    def property_values_json
-      @payload.property_values_json @property_cache&.property_values_json
+    def dry_run_script(method, path, json_method)
+      self.class.dry_run_script method, path, send(json_method)
     end
   end
 end

data/lib/notion_ruby_mapping/checkbox_property.rb

@@ -6,30 +6,45 @@ module NotionRubyMapping
     include EqualsDoesNotEqual
     TYPE = "checkbox"
 
-    # @param [String] name Property name
-    # @param [Boolean] checkbox Number value (optional)
-    def initialize(name, will_update: false, checkbox: false)
-      super name, will_update: will_update
-      @checkbox = checkbox
+    ### Public announced methods
+
+    ## Common methods
+
+    # @return [Boolean, Hash]
+    def checkbox
+      @json
     end
-    attr_reader :checkbox
+
+    ## Page property only methods
 
     # @param [Boolean] flag
     # @return [TrueClass, FalseClass] settled value
     def checkbox=(flag)
       @will_update = true
-      @checkbox = flag
+      @json = flag
     end
 
-    # @param [Hash] json
-    def update_from_json(json)
-      @will_update = false
-      @checkbox = json["checkbox"]
+    ### Not public announced methods
+
+    ## Common methods
+
+    # @param [String] name Property name
+    # @param [Boolean, Hash] json
+    def initialize(name, will_update: false, base_type: :page, json: nil)
+      super name, will_update: will_update, base_type: base_type
+      @json = if database?
+                json || {}
+              else
+                json || false
+              end
     end
 
+    ## Page property only methods
+
     # @return [Hash]
     def property_values_json
-      {@name => {"checkbox" => @checkbox, "type" => "checkbox"}}
+      assert_page_property __method__
+      {@name => {"checkbox" => @json, "type" => "checkbox"}}
     end
   end
 end

data/lib/notion_ruby_mapping/created_by_property.rb

@@ -5,24 +5,36 @@ module NotionRubyMapping
   class CreatedByProperty < MultiProperty
     TYPE = "created_by"
 
+    ### Public announced methods
+
+    ## Common methods
+
+    # @return [NotionRubyMapping::UserObject, Hash]
+    def created_by
+      @json
+    end
+
+    ### Not public announced methods
+
+    ## Common methods
+
     # @param [String] name Property name
     # @param [String] user_id user_id (optional)
     # @param [Hash] json json (optional)
-    def initialize(name, json: nil, user_id: nil)
-      super name, will_update: false
-      @user = UserObject.new user_id: user_id, json: json
+    def initialize(name, will_update: false, base_type: :page, json: nil, user_id: nil)
+      super name, will_update: will_update, base_type: base_type
+      @json = if database?
+                json || {}
+              else
+                UserObject.new user_id: user_id, json: json
+              end
     end
-    attr_reader :user
 
     # @param [Hash] json
     def update_from_json(json)
       @will_update = false
-      @user = UserObject.new json: json["created_by"]
-    end
-
-    # @return [Hash] {} created_time cannot be updated
-    def property_values_json
-      {}
+      cb = json["created_by"]
+      @json = database? ? cb : UserObject.new(json: cb)
     end
   end
 end

data/lib/notion_ruby_mapping/created_time_property.rb

@@ -5,23 +5,25 @@ module NotionRubyMapping
   class CreatedTimeProperty < DateBaseProperty
     TYPE = "created_time"
 
-    # @param [String] name Property name
-    # @param [String] created_time created_time value (optional)
-    def initialize(name, created_time: nil)
-      super name, will_update: false
-      @created_time = created_time
-    end
-    attr_reader :created_time
+    ### Public announced methods
+
+    ## Common methods
 
-    # @param [Hash] json
-    def update_from_json(json)
-      @will_update = false
-      @created_time = json["created_time"]
+    # @return [Date, Hash]
+    def created_time
+      @json
     end
 
-    # @return [Hash] {} created_time cannot be updated
-    def property_values_json
-      {}
+    ### Not public announced methods
+
+    ## Common methods
+
+    # @param [String] name Property name
+    # @param [String] json created_time value (optional)
+    def initialize(name, will_update: false, base_type: :page, json: nil)
+      super name, will_update: will_update, base_type: base_type
+      @json = json
+      @json ||= {} if database?
     end
   end
 end

data/lib/notion_ruby_mapping/database.rb

@@ -3,19 +3,28 @@
 module NotionRubyMapping
   # Notion database
   class Database < Base
-    def self.find(id)
-      NotionCache.instance.database id
-    end
+    ### Public announced methods
 
-    # @param [NotionRubyMapping::Query] query object
-    def query_database(query = Query.new)
-      response = @nc.database_query @id, query
-      List.new json: response, database: self, query: query
+    # @param [String] id
+    # @return [NotionRubyMapping::Database, String]
+    def self.find(id, dry_run: false)
+      nc = NotionCache.instance
+      if dry_run
+        dry_run_script :get, nc.database_path(id)
+      else
+        nc.database id
+      end
     end
 
-    # @return [NotionRubyMapping::Base]
-    def update
-      update_json @nc.update_database_request(@id, property_values_json)
+    # @return [NotionRubyMapping::Property]
+    # @param [Class] klass
+    # @param [String] title
+    def add_property(klass, title)
+      prop = assign_property klass, title
+      yield prop if block_given?
+      @payload.merge_property prop.property_schema_json
+      prop.clear_will_update
+      prop
     end
 
     # @param [Array<Property, Class, String>] assign
@@ -24,11 +33,66 @@ module NotionRubyMapping
       Page.new assign: assign, parent: {"database_id" => @id}
     end
 
+    # @return [NotionRubyMapping::RichTextArray]
+    def database_title
+      @database_title ||= RichTextArray.new "title", json: (self["title"]), will_update: new_record?
+    end
+
+    def property_schema_json
+      @payload.property_schema_json @property_cache, database_title
+    end
+
+    # @return [Hash] created json for update database
+    def property_values_json
+      @payload.property_values_json @property_cache, database_title
+    end
+
+    # @param [NotionRubyMapping::Query] query object
+    # @return [NotionRubyMapping::List, String]
+    def query_database(query = Query.new, dry_run: false)
+      if dry_run
+        Base.dry_run_script :post, @nc.query_database_path(@id), query.query_json
+      else
+        response = @nc.database_query @id, query
+        List.new json: response, database: self, query: query
+      end
+    end
+
+    # @param [Array] names
+    # @return [Array<NotionRubyMapping::Property>]
+    def remove_properties(*names)
+      names.map { |n| properties[n] }.each(&:remove)
+    end
+
+    # @return [Hash] created json for update database
+    def update_property_schema_json
+      @payload.update_property_schema_json @property_cache, database_title
+    end
+
     protected
 
+    def create(dry_run: false)
+      if dry_run
+        dry_run_script :post, @nc.databases_path, :property_schema_json
+      else
+        json = @nc.create_database_request(property_schema_json)
+        @new_record = false
+        update_json json
+      end
+    end
+
     # @return [Hash]
     def reload_json
       @nc.database_request @id
     end
+
+    # @return [NotionRubyMapping::Base, String]
+    def update(dry_run: false)
+      if dry_run
+        dry_run_script :patch, @nc.database_path(@id), :update_property_schema_json
+      else
+        update_json @nc.update_database_request(@id, update_property_schema_json)
+      end
+    end
   end
 end