notion_ruby_mapping 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0262f773e54fec1b483554fb0d616706725ad422c10ce0830deeaf610ada1915
-  data.tar.gz: 554e4b2e4750f2b574fbfc73b77d23825a57ae92bc715fe1e977fcf56882efb8
+  metadata.gz: c557600e1d6f89386696ffeadd7b3169fc0f3bfd19cc9aab29ce4e401d5b8969
+  data.tar.gz: 3dc90d601a14e96bc6c65b44a75231095cc52a7efc89067b5e37653133e546cf
 SHA512:
-  metadata.gz: 504081f42de292dd7b462ed4565cfbc5c39ed6197c76d743081ffd847f5917328f5dbf63b50c1d7524f9fedc9457a12518a90422803996760256a4ac7f0aa549
-  data.tar.gz: cd069974312f74381d12605632e9782705c859e6f698fe76641f8917fbe259a758cdfac748dbde23888e8b6cdb0a472b32c68ccce9678598c6768f47a48b5a61
+  metadata.gz: 3177e1c978dfda8968986afc96c4456a3842112d5de4d8b661074be3aaf3eb3a75b87297ac3b5701874091ac3444e8d88782747efa4ffbab02f3299875363d47
+  data.tar.gz: 3ad09dca8a9f818e35b8f8b1c611f89273efc4c9b34a78daf5fb34232372f5827afe5e307011380fa47263bc2de694461339d4b27793e4b2cb1af0fecdf75f6f

data/README.md

@@ -1,8 +1,28 @@
 # NotionRubyMapping
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/notion_ruby_mapping`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Notion Ruby mapping is currently under development.
+
+Development note is here. → [Idea note of "notion_ruby_mapping"](https://www.notion.so/hkob/Idea-note-of-notion_ruby_mapping-3b0a3bb3c171438a830f9579d41df501)
+
+## Table of Contents
+- [NotionRubyMapping](#notionrubymapping)
+  - [Installation](#installation)
+  - [Example code](#example-code)
+  - [Usage](#usage)
+    - [Create a New Integration](#create-a-new-integration)
+    - [Create client](#create-client)
+    - [Classes](#classes)
+      - [Base class](#base-class)
+      - [Database class](#database-class)
+      - [Query class](#query-class)
+      - [Page class](#page-class)
+      - [List class](#list-class)
+      - [Block class](#block-class)
+  - [ChangeLog](#changelog)
+  - [Contributing](#contributing)
+  - [License](#license)
+  - [Code of Conduct](#code-of-conduct)
+  - [Acknowledgements](#acknowledgements)
 
 ## Installation
 
@@ -20,6 +40,38 @@ Or install it yourself as:
 
     $ gem install notion_ruby_mapping
 
+## Example code
+
+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
+
+Database.query(database_id).each do |page|
+  p page.set_icon(emoji: "💿").id unless page.icon
+end
+```
+
+The following code sets serial numbers to the pages whose title is not empty in ascending order of titles.
+```Ruby
+tp = RichTextProperty.new("TextTitle")
+Database.query(database_id, tp.filter_is_not_empty.ascending(tp)).each.with_index(1) do |page, index|
+  page.properties["NumberTitle"].number = index
+  page.update
+end
+
+```
+
+|Before execution|After execution|
+|---|---|
+|![Before execution](images/pre_set_icon.png)|![After execution](images/post_set_icon.png)|
+
 ## Usage
 
 ### Create a New Integration
@@ -35,6 +87,23 @@ Please create a client (notion-ruby-client) before you use the following class.
 
 ### Classes
 
+#### Base class (Abstract class for Database / Page / Block / List)
+
+- Set icon (only Database / Page)
+
+```Ruby
+obj.set_icon emoji: "💿" # set emoji
+obj.set_icon url: "https://cdn.profile-image.st-hatena.com/users/hkob/profile.png" # set external url
+```
+
+- Get values and properties
+
+```Ruby
+obj.icon # obtain icon json
+obj["icon"] # same as obj.icon
+obj.properties["NumberTitle"]
+```
+
 #### Database class
 
 - Retrieve a database
@@ -50,7 +119,7 @@ Database.query("c37a2c66-e3aa-4a0d-a447-73de3b80c253") # retrieves all pages
 Database.query("c37a2c66-e3aa-4a0d-a447-73de3b80c253", query) # retrieves using query
 ```
 
-#### Query class
+#### Query class and related *Property class
 
 Query object can be generated from the following Property objects.
 For example, in order to obtain the pages whose title starts with "A" and ordered by ascending,
@@ -149,14 +218,14 @@ query1 = tp.filter_starts_with("start")
 
 # Result of query1.filter
 {
-  and: [
+  "and" => [
     {
-      property: "tp",
-      title: {starts_with: "start"},
+      "property" => "tp",
+      "title" => {"starts_with" => "start"},
     },
     {
-      property: "np",
-      number: {greater_than: 100},
+      "property" => "np",
+      "number" => {"greater_than" => 100},
     },
   ],
 }
@@ -170,18 +239,18 @@ query2 = tp.filter_starts_with("start")
 
 # Result of query2.filter
 {
-  and: [
+  "and" => [
     {
-      property: "tp",
-      title: {starts_with: "start"},
+      "property" => "tp",
+      "title" => {"starts_with" => "start"},
     },
     {
-      property: "np",
-      number: {greater_than: 100},
+      "property" => "np",
+      "number" => {"greater_than" => 100},
     },
     {
-      property: "cp",
-      checkbox: {equals: true},
+      "property" => "cp",
+      "checkbox" => {"equals" => true},
     },
   ],
 }
@@ -194,14 +263,14 @@ query3 = tp.filter_starts_with("start")
 
 # Result of query3.filter
 {
-  or: [
+  "or" => [
     {
-      property: "tp",
-      title: {starts_with: "start"},
+      "property" => "tp",
+      "title" => {"starts_with" => "start"},
     },
     {
-      property: "np",
-      number: {greater_than: 100},
+      "property" => "np",
+      "number" => {"greater_than" => 100},
     },
   ],
 }
@@ -215,18 +284,18 @@ query4 = tp.filter_starts_with("start")
 
 # Result of query4.filter
 {
-  or: [
+  "or" => [
     {
-      property: "tp",
-      title: {starts_with: "start"},
+      "property" => "tp",
+      "title" => {"starts_with" => "start"},
     },
     {
-      property: "np",
-      number: {greater_than: 100},
+      "property" => "np",
+      "number" => {"greater_than" => 100},
     },
     {
-      property: "cp",
-      checkbox: {equals: true},
+      "property" => "cp",
+      "checkbox" => {"equals" => true},
     },
   ],
 }
@@ -240,22 +309,22 @@ query5 = tp.filter_starts_with("start")
 
 # Result of query5.filter
 {
-  or: [
+  "or" => [
     {
-      and: [
+      "and" => [
         {
-          property: "tp",
-          title: {starts_with: "start"},
+          "property" => "tp",
+          "title" => {"starts_with" => "start"},
         },
         {
-          property: "np",
-          number: {greater_than: 100},
+          "property" => "np",
+          "number" => {"greater_than" => 100},
         },
       ],
     },
     {
-      property: "cp",
-      checkbox: {equals: true},
+      "property" => "cp",
+      "checkbox" => {"equals" => true},
     },
   ],
 }
@@ -269,22 +338,22 @@ query6 = tp.filter_starts_with("start")
 
 # Result of query6.filter
 {
-  and: [
+  "and" => [
     {
-      or: [
+      "or" => [
         {
-          property: "tp",
-          title: {starts_with: "start"},
+          "property" => "tp",
+          "title" => {"starts_with" => "start"},
         },
         {
-          property: "np",
-          number: {greater_than: 100},
+          "property" => "np",
+          "number" => {"greater_than" => 100},
         },
       ],
     },
     {
-      property: "cp",
-      checkbox: {equals: true},
+      "property" => "cp",
+      "checkbox" => {"equals" => true},
     },
   ],
 }
@@ -297,28 +366,28 @@ query7 = np.filter_greater_than(100).and(np.filter_less_than(200))
 
 # Result of query7.filter
 {
-  or: [
+  "or" => [
     {
-      and: [
+      "and" => [
         {
-          property: "np",
-          number: {greater_than: 100},
+          "property" => "np",
+          "number" => {"greater_than" => 100},
         },
         {
-          property: "np",
-          number: {less_than: 200},
+          "property" => "np",
+          "number" => {"less_than" => 200},
         },
       ],
     },
     {
-      and: [
+      "and" => [
         {
-          property: "np",
-          number: {greater_than: 300},
+          "property" => "np",
+          "number" => {"greater_than" => 300},
         },
         {
-          property: "np",
-          number: {less_than: 400},
+          "property" => "np",
+          "number" => {"less_than" => 400},
         },
       ],
     },
@@ -335,24 +404,35 @@ query11 = Query.new.descending letp
 query12 = Query.new.ascending(tp).descending letp
 
 # Result of query8.sort
-[{property: "tp", direction: "ascending"}]
+[{"property" => "tp", "direction" => "ascending"}]
 
 # Result of query9.sort
-[{timestamp: "letp", direction: "ascending"}]
+[{"timestamp" => "letp", "direction" => "ascending"}]
 
 # Result of query10.sort
-[{property: "tp", direction: "descending"}]
+[{"property" => "tp", "direction" => "descending"}]
 
 # Result of query11.sort
-[{timestamp: "letp", direction: "descending"}]
+[{"timestamp" => "letp", "direction" => "descending"}]
 
 # Result of query12.sort
 [
-  {property: "tp", direction: "ascending"},
-  {timestamp: "letp", direction: "descending"},
+  {"property" => "tp", "direction" => "ascending"},
+  {"timestamp" => "letp", "direction" => "descending"},
 ]
 ```
 
+- filter with sort
+```Ruby
+query13 = tp.filter_starts_with("A").ascending(tp)
+
+# Result of query13.filter
+{"property" => "tp", "title" => {"starts_with" => "start"}},
+
+# Result of query13.sort
+[{"property" => "tp", "direction" => "ascending"}]
+```
+
 #### Page class
 
 - Retrieve a page
@@ -360,16 +440,38 @@ query12 = Query.new.ascending(tp).descending letp
 page = Page.find("c01166c6-13ae-45cb-b968-18b4ef2f5a77")
 ```
 
-- Retrieve block children (List object)
+- Update values and properties
+
+Page properties can update in the following three ways.
+
+  1. update the property directory (fastest: one API call only)
 ```Ruby
-children = page.children
+page = Page.new id: page_id
+np = NumberProperty.new "NumberTitle", number: 3.14
+page.add_property_for_update np
+page.update # update page API call
+print page
+```
+
+  2. update the loaded page (easy but slow: two API call)
+```Ruby
+page = Page.find first_page_id # retrieve page API call
+page.properties["NumberTitle"].number = 2022
+page.update # update page API call
+print page
 ```
 
-- Set icon
+  3. update the unloaded page using autoload (easy but slow: two API call)
+```Ruby
+page = Page.new id: first_page_id
+page.properties["NumberTitle"].number = 12345 # retrieve page API call (autoload)
+page.update # update page API call
+print page
+```
 
+- Retrieve block children (List object)
 ```Ruby
-page.set_icon emoji: "💿"
-page.set_icon url: "https://cdn.profile-image.st-hatena.com/users/hkob/profile.png"
+children = page.children
 ```
 
 #### List class
@@ -381,19 +483,21 @@ list.each do |obj| # obj's class is Page or Block
 end
 ```
 
-### Block class
+#### Block class
 
 Not implemented
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## ChangeLog
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+- 2022/2/17 added Page#properties, Page#add_property_for_update, Page#update
+- 2022/2/16 added PropertyCache and Payload class
+- 2022/2/14 added Database#set_icon
+- 2022/2/13 added Page#set_icon
+- 2022/2/13 First commit
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/notion_ruby_mapping. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/notion_ruby_mapping/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/hkob/notion_ruby_mapping. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/notion_ruby_mapping/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 

data/env.yml.sample

@@ -0,0 +1,6 @@
+---
+notion_token: "secret_XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+top_page: "c01166c613ae45cbb96818b4ef2f5a77"
+database: "c37a2c66e3aa4a0da44773de3b80c253"
+h1block: "0250fb6d600142eca4c74efb8794fc6b"
+db_first_page: "dcdc805c85fa4155a55c20fc28771af7"

data/lib/notion_ruby_mapping/base.rb

@@ -7,11 +7,13 @@ module NotionRubyMapping
       @nc = NotionCache.instance
       @json = json
       @id = @nc.hex_id(id || @json["id"])
+      @payload = nil
+      @property_cache = nil
     end
     attr_reader :json, :id
 
-    # @param [Object] json
-    # @return [NotionRubyMapping::Block, NotionRubyMapping::List, NotionRubyMapping::Database, NotionRubyMapping::Page]
+    # @param [Hash, Notion::Messages] json
+    # @return [NotionRubyMapping::Base]
     def self.create_from_json(json)
       case json["object"]
       when "page"
@@ -27,23 +29,94 @@ module NotionRubyMapping
       end
     end
 
+    # @return [NotionRubyMapping::Payload] get or created Payload object
+    def payload
+      @payload ||= Payload.new
+    end
+
+    # @return [NotionRubyMapping::PropertyCache] get or created PropertyCache object
+    def properties
+      unless @property_cache
+        unless @json
+          return nil if @id.nil?
+
+          update_json reload
+        end
+        @property_cache = PropertyCache.new json_properties
+      end
+      @property_cache
+   end
+
+    # @return [Hash] json properties
+    def json_properties
+      @json && @json["properties"]
+    end
+
     # @return [NotionRubyMapping::List]
     def children
       @children ||= @nc.block_children(id)
     end
 
+    # @param [Hash] json
+    # @return [NotionRubyMapping::Base]
     def update_json(json)
       if @json.nil? || @json["type"] == json["type"]
         @json = json
+        @id = @nc.hex_id(@json["id"])
         clear_object
       end
+      self
     end
 
+    # @return [NotionRubyMapping::Base]
     def clear_object
+      @payload = nil
+      @property_cache = nil
+      self
+    end
+
+    # @param [String] emoji
+    # @param [String] url
+    # @return [NotionRubyMapping::Base]
+    def set_icon(emoji: nil, url: nil)
+      if self.is_a?(Page) || self.is_a?(Database)
+        payload.set_icon(emoji: emoji, url: url)
+        update
+      end
+      self
     end
+    
+    # @param [String] key
+    # @return [NotionRubyMapping::PropertyCache, Hash] obtained Page value or PropertyCache
+    def [](key)
+      unless @json
+        return nil if @id.nil?
 
+        update_json reload
+      end
+      case key
+      when "properties"
+        properties
+      else
+        @json[key]
+      end
+    end
+
+    # @return [Hash, nil] obtained Hash
     def icon
-      @json["icon"]
+      self["icon"]
+    end
+
+    # @param [Property] property Property object for udpate or create
+    # @return [NotionRubyMapping::Base]
+    def add_property_for_update(property)
+      properties.add_property property, will_update: true
+      self
+    end
+
+    # @return [Hash] created json
+    def create_json
+      payload.create_json @property_cache&.create_json
     end
   end
 end

data/lib/notion_ruby_mapping/checkbox_property.rb

@@ -4,6 +4,6 @@ module NotionRubyMapping
   # Checkbox property
   class CheckboxProperty < Property
     include EqualsDoesNotEqual
-    TYPE = :checkbox
+    TYPE = "checkbox"
   end
 end

data/lib/notion_ruby_mapping/created_by_property.rb

@@ -2,6 +2,6 @@
 
 module NotionRubyMapping
   class CreatedByProperty < MultiProperty
-    TYPE = :created_by
+    TYPE = "created_by"
   end
 end

data/lib/notion_ruby_mapping/created_time_property.rb

@@ -2,6 +2,6 @@
 
 module NotionRubyMapping
   class CreatedTimeProperty < DateBaseProperty
-    TYPE = :created_time
+    TYPE = "created_time"
   end
 end

data/lib/notion_ruby_mapping/database.rb

@@ -3,13 +3,22 @@
 module NotionRubyMapping
   # Notion database
   class Database < Base
-    def self.find(key)
-      NotionCache.instance.database key
+    def self.find(id)
+      NotionCache.instance.database id
     end
 
+    # @param [String] id database_id (with or without "-")
+    # @param [NotionRubyMapping::Query] query object
     def self.query(id, query = nil)
       query ||= Query.new
       NotionCache.instance.database_query(id, query)
     end
+
+    # @param [String] id database_id (with or without "-")
+    # @param [Payload] payload
+    def update
+      update_json @nc.update_database @id, @payload.create_json
+    end
   end
 end
+

data/lib/notion_ruby_mapping/date_base_property.rb

@@ -23,51 +23,51 @@ module NotionRubyMapping
     end
 
     def filter_equals(value)
-      make_filter_query :equals, value_str(value)
+      make_filter_query "equals", value_str(value)
     end
 
     def filter_does_not_equal(value)
-      make_filter_query :does_not_equal, value_str(value)
+      make_filter_query "does_not_equal", value_str(value)
     end
 
     def filter_before(value)
-      make_filter_query :before, value_str(value)
+      make_filter_query "before", value_str(value)
     end
 
     def filter_after(value)
-      make_filter_query :after, value_str(value)
+      make_filter_query "after", value_str(value)
     end
 
     def filter_on_or_before(value)
-      make_filter_query :on_or_before, value_str(value)
+      make_filter_query "on_or_before", value_str(value)
     end
 
     def filter_on_or_after(value)
-      make_filter_query :on_or_after, value_str(value)
+      make_filter_query "on_or_after", value_str(value)
     end
 
     def filter_past_week
-      make_filter_query :past_week, {}
+      make_filter_query "past_week", {}
     end
 
     def filter_past_month
-      make_filter_query :past_month, {}
+      make_filter_query "past_month", {}
     end
 
     def filter_past_year
-      make_filter_query :past_year, {}
+      make_filter_query "past_year", {}
     end
 
     def filter_next_week
-      make_filter_query :next_week, {}
+      make_filter_query "next_week", {}
     end
 
     def filter_next_month
-      make_filter_query :next_month, {}
+      make_filter_query "next_month", {}
     end
 
     def filter_next_year
-      make_filter_query :next_year, {}
+      make_filter_query "next_year", {}
     end
   end
 end

data/lib/notion_ruby_mapping/date_property.rb

@@ -2,6 +2,6 @@
 
 module NotionRubyMapping
   class DateProperty < DateBaseProperty
-    TYPE = :date
+    TYPE = "date"
   end
 end

data/lib/notion_ruby_mapping/email_property.rb

@@ -2,6 +2,6 @@
 
 module NotionRubyMapping
   class EmailProperty < TextProperty
-    TYPE = :email
+    TYPE = "email"
   end
 end

data/lib/notion_ruby_mapping/files_property.rb

@@ -4,6 +4,6 @@ module NotionRubyMapping
   # Select property
   class FilesProperty < Property
     include IsEmptyIsNotEmpty
-    TYPE = :files
+    TYPE = "files"
   end
 end

data/lib/notion_ruby_mapping/formula_property.rb

@@ -6,6 +6,6 @@ module NotionRubyMapping
     include ContainsDoesNotContain
     include StartsWithEndsWith
     include GreaterThanLessThan
-    TYPE = :formula
+    TYPE = "formula"
   end
 end

data/lib/notion_ruby_mapping/last_edited_by_property.rb

@@ -2,6 +2,6 @@
 
 module NotionRubyMapping
   class LastEditedByProperty < MultiProperty
-    TYPE = :last_edited_by
+    TYPE = "last_edited_by"
   end
 end

data/lib/notion_ruby_mapping/last_edited_time_property.rb

@@ -2,6 +2,6 @@
 
 module NotionRubyMapping
   class LastEditedTimeProperty < DateBaseProperty
-    TYPE = :last_edited_time
+    TYPE = "last_edited_time"
   end
 end

data/lib/notion_ruby_mapping/multi_select_property.rb

@@ -3,6 +3,6 @@
 module NotionRubyMapping
   # MultiSelect property
   class MultiSelectProperty < MultiProperty
-    TYPE = :multi_select
+    TYPE = "multi_select"
   end
 end

data/lib/notion_ruby_mapping/notion_cache.rb

@@ -38,40 +38,52 @@ module NotionRubyMapping
 
       begin
         json = yield(@client)
-        p json
         @object_hash[key] = Base.create_from_json json
       rescue StandardError
         nil
       end
     end
 
-    # @param [String] id
+    # @param [String] id page_id (with or without "-")
+    # @return [Hash] obtained json
+    def page_json(id)
+      sleep @wait
+      @client.page page_id: id
+    end
+
+    # @param [String] id page_id (with or without "-")
     # @return [NotionRubyMapping::Page, nil] Page object or nil
     def page(id)
-      object_for_key(id) do
-        sleep @wait
-        @client.page page_id: id
-      end
+      object_for_key(id) { page_json id }
     end
 
-    # @param [String] id
+    # @param [String] id database_id (with or without "-")
+    # @return [Hash] obtained json
+    def database_json(id)
+      sleep @wait
+      @client.database database_id: id
+    end
+
+    # @param [String] id database_id (with or without "-")
     # @return [NotionRubyMapping::Database, nil] Database object or nil
     def database(id)
-      object_for_key(id) do
-        sleep @wait
-        @client.database database_id: id
-      end
+      object_for_key(id) { database_json id }
     end
 
-    # @param [String] id
-    # @return [NotionRubyMapping::Block, nil]
+    # @param [String] id block_id (with or without "-")
+    # @return [Hash] obtained json
+    def block_json(id)
+      sleep @wait
+      @client.block block_id: id
+    end
+    # @param [String] id block_id (with or without "-")
+    # @return [NotionRubyMapping::Block, nil] Block object or nil
     def block(id)
-      object_for_key(id) do
-        sleep @wait
-        @client.block block_id: id
-      end
+      object_for_key(id) { block_json id }
     end
 
+    # @param [String] id page_id / block_id (with or without "-")
+    # @return [NotionRubyMapping::List] List object
     def block_children(id)
       array = []
       sleep @wait
@@ -81,20 +93,33 @@ module NotionRubyMapping
       Base.create_from_json({"object" => "list", "results" => array})
     end
 
+    # @param [String] id page_id / block_id (with or without "-")
+    # @param [NotionRubyMapping::Query] query query object
+    # @return [NotionRubyMapping::List] List object
     def database_query(id, query)
       array = []
       parameters = {database_id: id, sleep_interval: @wait, max_retries: 20}
       parameters[:filter] = query.filter unless query.filter.empty?
-      parameters[:sort] = query.sort unless query.sort.empty?
-      @client.database_query(**parameters) do |page|
+      parameters[:sorts] = query.sort unless query.sort.empty?
+
+      @client.database_query(parameters) do |page|
         array.concat page.results
       end
       Base.create_from_json({"object" => "list", "results" => array})
     end
 
+    # @param [String] id page_id (with or without "-")
+    # @param [Hash] payload
     def update_page(id, payload)
       sleep @wait
       @client.update_page payload.merge({page_id: id})
     end
+
+    # @param [String] id page_id (with or without "-")
+    # @param [Hash] payload
+    def update_database(id, payload)
+      sleep @wait
+      @client.update_database payload.merge({database_id: id})
+    end
   end
 end

data/lib/notion_ruby_mapping/number_property.rb

@@ -6,6 +6,23 @@ module NotionRubyMapping
     include EqualsDoesNotEqual
     include GreaterThanLessThan
     include IsEmptyIsNotEmpty
-    TYPE = :number
+    TYPE = "number"
+
+    # @param [String] name Property name
+    # @param [Number, Fixnum] number Number value (optional)
+    # @param [String] format Format string (optional, default: "number")
+    def initialize(name, number: nil)
+      super(name)
+      @number = number
+    end
+
+    def create_json
+      {"type" => "number", "number" => @number}
+    end
+
+    def number=(n)
+      @will_update = true
+      @number = n
+    end
   end
 end

data/lib/notion_ruby_mapping/page.rb

@@ -7,10 +7,15 @@ module NotionRubyMapping
       NotionCache.instance.page key
     end
 
-    def set_icon(emoji: nil, url: nil)
-      payload = emoji ? {type: :emoji, emoji: emoji} : {type: :external, external: {url: url}}
-      update_json @nc.update_page(id, {icon: payload})
-      self
+    # @param [String] id page_id (with or without "-")
+    # @param [Payload] payload
+    def update
+      update_json @nc.update_page(@id, create_json)
+    end
+    
+    # @return [Hash]
+    def reload
+      @nc.page_json @id
     end
   end
 end

data/lib/notion_ruby_mapping/payload.rb

@@ -0,0 +1,28 @@
+module NotionRubyMapping
+  class Payload
+    def initialize
+      @json = {}
+    end
+
+    # @param [String] emoji
+    # @param [String] url
+    # @return [NotionRubyMapping::Payload] updated Payload
+    def set_icon(emoji: nil, url: nil)
+      payload = if emoji
+                  {"type" => "emoji", "emoji" => emoji}
+                elsif url
+                  {"type" => "external", "external" => {"url" => url}}
+                else
+                  {}
+                end
+      @json["icon"] = payload
+      self
+    end
+
+    # @return [Hash] created json
+    # @param optional [Hash] optional_json
+    def create_json(optional_json = nil)
+      @json.merge(optional_json || {})
+    end
+  end
+end

data/lib/notion_ruby_mapping/people_property.rb

@@ -2,6 +2,6 @@
 
 module NotionRubyMapping
   class PeopleProperty < MultiProperty
-    TYPE = :people
+    TYPE = "people"
   end
 end

data/lib/notion_ruby_mapping/phone_number_property.rb

@@ -2,6 +2,6 @@
 
 module NotionRubyMapping
   class PhoneNumberProperty < TextProperty
-    TYPE = :phone_number
+    TYPE = "phone_number"
   end
 end

data/lib/notion_ruby_mapping/property.rb

@@ -3,86 +3,122 @@
 module NotionRubyMapping
   # abstract class for property
   class Property
+    # @param [String] name Property name
+    # @return [Property] generated Property object
     def initialize(name)
       @name = name
+      @will_update = false
     end
     attr_reader :name
+    attr_accessor :will_update
 
-    # @param [Symbol] key query parameter
+    # @param [String] key query parameter
     # @param [Object] value query value
     # @return [NotionRubyMapping::Query] generated Query object
     def make_filter_query(key, value)
-      Query.new(filter: {property: @name, type => {key => value}})
+      Query.new(filter: {"property" => @name, type => {key => value}})
     end
 
     # @return [Symbol] property type
     def type
       self.class::TYPE
     end
+
+    # @param [String] key
+    # @param [Hash] json
+    # @return [NotionRubyMapping::NumberProperty, nil] generated Property object
+    def self.create_from_json(key, json)
+      case json["type"]
+      when "number"
+        NumberProperty.new key, number: json["number"]
+      else
+        nil
+      end
+    end
   end
 
   # module for make query of equals and does_not_equal
   module EqualsDoesNotEqual
-    # @param [String, Number] value
-    # @return [Object]
+    # @param [String, Number] value Query value
+    # @return [NotionRubyMapping::Query] generated Query object
     def filter_equals(value)
-      make_filter_query :equals, value
+      make_filter_query "equals", value
     end
 
+    # @param [String, Number] value Query value
+    # @return [NotionRubyMapping::Query] generated Query object
     def filter_does_not_equal(value)
-      make_filter_query :does_not_equal, value
+      make_filter_query "does_not_equal", value
     end
   end
 
   # module for make query of contains and does_not_contain
   module ContainsDoesNotContain
+    # @param [String] value Query value
+    # @return [NotionRubyMapping::Query] generated Query object
     def filter_contains(value)
-      make_filter_query :contains, value
+      make_filter_query "contains", value
     end
 
+    # @param [String] value Query value
+    # @return [NotionRubyMapping::Query] generated Query object
     def filter_does_not_contain(value)
-      make_filter_query :does_not_contain, value
+      make_filter_query "does_not_contain", value
     end
   end
 
   # module for make query of starts_with and ends_with
   module StartsWithEndsWith
+    # @param [String] value Query value
+    # @return [NotionRubyMapping::Query] generated Query object
     def filter_starts_with(value)
-      make_filter_query :starts_with, value
+      make_filter_query "starts_with", value
     end
 
+    # @param [String] value Query value
+    # @return [NotionRubyMapping::Query] generated Query object
     def filter_ends_with(value)
-      make_filter_query :ends_with, value
+      make_filter_query "ends_with", value
     end
   end
 
   # module for make query of is_empty and is_not_empty
   module IsEmptyIsNotEmpty
+    # @return [NotionRubyMapping::Query] generated Query object
     def filter_is_empty
-      make_filter_query :is_empty, true
+      make_filter_query "is_empty", true
     end
 
+    # @return [NotionRubyMapping::Query] generated Query object
     def filter_is_not_empty
-      make_filter_query :is_not_empty, true
+      make_filter_query "is_not_empty", true
     end
   end
 
   # module for make query of starts_with and ends_with
   module GreaterThanLessThan
+    # @param [Number] value Query value
+    # @return [NotionRubyMapping::Query] generated Query object
     def filter_greater_than(value)
-      make_filter_query :greater_than, value
+      make_filter_query "greater_than", value
     end
 
+    # @param [Number] value Query value
+    # @return [NotionRubyMapping::Query] generated Query object
     def filter_less_than(value)
-      make_filter_query :less_than, value
+      make_filter_query "less_than", value
     end
 
+    # @param [Number] value Query value
+    # @return [NotionRubyMapping::Query] generated Query object
     def filter_greater_than_or_equal_to(value)
-      make_filter_query :greater_than_or_equal_to, value
+      make_filter_query "greater_than_or_equal_to", value
     end
 
+    # @param [Number] value Query value
+    # @return [NotionRubyMapping::Query] generated Query object
     def filter_less_than_or_equal_to(value)
-      make_filter_query :less_than_or_equal_to, value
+      make_filter_query "less_than_or_equal_to", value
     end
   end
 end

data/lib/notion_ruby_mapping/property_cache.rb

@@ -0,0 +1,38 @@
+module NotionRubyMapping
+  class PropertyCache
+    def initialize(json = {})
+      @properties = {}
+      @json = json
+    end
+
+    # @param [String] key
+    # @return [Property] Property for key
+    def [](key)
+      ans = @properties[key]
+      unless ans
+        if @json && @json[key]
+          @properties[key] = Property.create_from_json key, @json[key]
+        end
+      end
+      @properties[key]
+    end
+
+    # @param [Property] property added Property
+    # @param [FalseClass] will_update true if the property value will update to Notion
+    def add_property(property, will_update: false)
+      @properties[property.name] = property
+      property.will_update = true if will_update
+      self
+    end
+
+    # @return [Hash] created json
+    def create_json
+      @properties.each_with_object({}) do |(key, property), ans|
+        if property.will_update
+          ans["properties"] ||= {}
+          ans["properties"][key] = property.create_json
+        end
+      end
+    end
+  end
+end

data/lib/notion_ruby_mapping/query.rb

@@ -12,10 +12,10 @@ module NotionRubyMapping
     # @param [Query] other_query other query
     # @return [NotionRubyMapping::Query] updated self (Query object)
     def and(other_query)
-      if @filter.key? :and
-        @filter[:and] << other_query.filter
+      if @filter.key? "and"
+        @filter["and"] << other_query.filter
       else
-        @filter = {and: [@filter, other_query.filter]}
+        @filter = {"and" => [@filter, other_query.filter]}
       end
       self
     end
@@ -23,10 +23,10 @@ module NotionRubyMapping
     # @param [Query] other_query other query
     # @return [NotionRubyMapping::Query] updated self (Query object)
     def or(other_query)
-      if @filter.key? :or
-        @filter[:or] << other_query.filter
+      if @filter.key? "or"
+        @filter["or"] << other_query.filter
       else
-        @filter = {or: [@filter, other_query.filter]}
+        @filter = {"or" => [@filter, other_query.filter]}
       end
       self
     end
@@ -34,16 +34,16 @@ module NotionRubyMapping
     # @param [NotionRubyMapping::Property] property
     # @return [NotionRubyMapping::Query] updated self (Query object)
     def ascending(property)
-      key = property.is_a?(LastEditedTimeProperty) || property.is_a?(CreatedTimeProperty) ? :timestamp : :property
-      @sort << {key => property.name, direction: "ascending"}
+      key = property.is_a?(LastEditedTimeProperty) || property.is_a?(CreatedTimeProperty) ? "timestamp" : "property"
+      @sort << {key => property.name, "direction" => "ascending"}
       self
     end
 
     # @param [NotionRubyMapping::Property] property
     # @return [NotionRubyMapping::Query] updated self (Query object)
     def descending(property)
-      key = property.is_a?(LastEditedTimeProperty) || property.is_a?(CreatedTimeProperty) ? :timestamp : :property
-      @sort << {key => property.name, direction: "descending"}
+      key = property.is_a?(LastEditedTimeProperty) || property.is_a?(CreatedTimeProperty) ? "timestamp" : "property"
+      @sort << {key => property.name, "direction" => "descending"}
       self
     end
   end

data/lib/notion_ruby_mapping/relation_property.rb

@@ -3,6 +3,6 @@
 module NotionRubyMapping
   # MultiSelect property
   class RelationProperty < MultiProperty
-    TYPE = :relation
+    TYPE = "relation"
   end
 end

data/lib/notion_ruby_mapping/rich_text_property.rb

@@ -2,6 +2,6 @@
 
 module NotionRubyMapping
   class RichTextProperty < TextProperty
-    TYPE = :rich_text
+    TYPE = "rich_text"
   end
 end

data/lib/notion_ruby_mapping/select_property.rb

@@ -5,6 +5,6 @@ module NotionRubyMapping
   class SelectProperty < Property
     include EqualsDoesNotEqual
     include IsEmptyIsNotEmpty
-    TYPE = :select
+    TYPE = "select"
   end
 end

data/lib/notion_ruby_mapping/title_property.rb

@@ -2,6 +2,6 @@
 
 module NotionRubyMapping
   class TitleProperty < TextProperty
-    TYPE = :title
+    TYPE = "title"
   end
 end

data/lib/notion_ruby_mapping/url_property.rb

@@ -2,6 +2,6 @@
 
 module NotionRubyMapping
   class UrlProperty < TextProperty
-    TYPE = :url
+    TYPE = "url"
   end
 end

data/lib/notion_ruby_mapping/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NotionRubyMapping
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/notion_ruby_mapping.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+require "yaml"
+
 %w[version notion_cache base page database list block property text_property title_property rich_text_property
    url_property email_property phone_number_property number_property checkbox_property select_property
    multi_property multi_select_property date_base_property date_property created_time_property last_edited_time_property
    people_property created_by_property last_edited_by_property files_property relation_property formula_property
-   query].each do |k|
+   query payload property_cache.rb].each do |k|
   require_relative "notion_ruby_mapping/#{k}"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notion_ruby_mapping
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Hiroyuki KOBAYASHI
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-14 00:00:00.000000000 Z
+date: 2022-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: notion-ruby-client
@@ -112,6 +112,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- env.yml.sample
+- images/post_set_icon.png
+- images/pre_set_icon.png
 - lib/notion_ruby_mapping.rb
 - lib/notion_ruby_mapping/base.rb
 - lib/notion_ruby_mapping/block.rb
@@ -132,9 +135,11 @@ files:
 - lib/notion_ruby_mapping/notion_cache.rb
 - lib/notion_ruby_mapping/number_property.rb
 - lib/notion_ruby_mapping/page.rb
+- lib/notion_ruby_mapping/payload.rb
 - lib/notion_ruby_mapping/people_property.rb
 - lib/notion_ruby_mapping/phone_number_property.rb
 - lib/notion_ruby_mapping/property.rb
+- lib/notion_ruby_mapping/property_cache.rb
 - lib/notion_ruby_mapping/query.rb
 - lib/notion_ruby_mapping/relation_property.rb
 - lib/notion_ruby_mapping/rich_text_property.rb