notion_ruby_mapping 0.3.3 → 0.5.0

data/lib/notion_ruby_mapping/{notion_cache.rb → controllers/notion_cache.rb}

@@ -11,6 +11,7 @@ module NotionRubyMapping
 
     ### initialize
 
+    # @see https://www.notion.so/hkob/NotionCache-65e1599864d6425686d495a5a4b3a623#dca210788f114cf59464090782c073bf
     def initialize
       @object_hash = {}
       @client = Faraday::Connection.new "https://api.notion.com" do |builder|
@@ -25,38 +26,42 @@ module NotionRubyMapping
     attr_reader :object_hash
     attr_writer :client # for test only
 
-    # @param [String] notion_token
-    # @return [NotionRubyMapping::NotionCache] self (NotionCache.instance)
-    def create_client(notion_token, wait: 0.3333, debug: false)
-      @notion_token = notion_token
-      @wait = wait
-      @debug = debug
-      self
+    # @param [String] block_id
+    # @return [String (frozen)] block_path
+    def append_block_children_block_path(block_id)
+      "v1/blocks/#{block_id}/children"
     end
 
-    ### create path methods
-
-    # @param [String] database_id
+    # @param [String] page_id
     # @return [String (frozen)] page_path
-    def database_path(database_id)
-      "v1/databases/#{database_id}"
+    def append_block_children_page_path(page_id)
+      "v1/blocks/#{page_id}/children"
     end
 
-    # @param [String] database_id
-    # @return [String (frozen)] page_path
-    def databases_path
-      "v1/databases"
+    # @param [String] id
+    # @param [Hash] payload
+    # @return [Hash]
+    def append_block_children_request(id, payload)
+      request :patch, append_block_children_block_path(id), payload
+    end
+
+    # @param [String] id block_id (with or without "-")
+    # @return [NotionRubyMapping::Base] Block object or nil
+    def block(id)
+      object_for_key(id) { block_request id }
     end
 
     # @param [String] page_id
     # @return [String (frozen)] page_path
-    def page_path(page_id)
-      "v1/pages/#{page_id}"
+    def block_children_page_path(page_id, query_string = "")
+      "v1/blocks/#{page_id}/children#{query_string}"
     end
 
-    # @return [String (frozen)] page_path
-    def pages_path
-      "v1/pages"
+    # @param [String] id
+    # @param [String] query_string
+    # @return [Hash]
+    def block_children_request(id, query_string)
+      request :get, block_children_page_path(id, query_string)
     end
 
     # @param [String] block_id
@@ -65,92 +70,97 @@ module NotionRubyMapping
       "v1/blocks/#{block_id}"
     end
 
-    # @param [String] database_id
-    # @return [String (frozen)] page_path
-    def query_database_path(database_id)
-      "v1/databases/#{database_id}/query"
+    # @param [String] block_id
+    # @return [Hash] response
+    def block_request(block_id)
+      request :get, block_path(block_id)
     end
 
-    ### Notion API call
-
-    # @param [Symbol] method
-    # @param [String] path
-    # @param [Hash] options
-    # @return [Hash] response hash
-    def request(method, path, options = {})
-      raise "Please call `NotionCache.create_client' before using other methods" unless @notion_token
+    # @return [Hash]
+    def clear_object_hash
+      @object_hash = {}
+    end
 
-      sleep @wait
-      response = @client.send(method) do |request|
-        request.headers["Authorization"] = "Bearer #{@notion_token}"
-        request.headers["Notion-Version"] = NotionRubyMapping::NOTION_VERSION
-        case method
-        when :get, :delete
-          request.url path, options
-        when :post, :put, :patch
-          request.headers["Content-Type"] = "application/json"
-          request.path = path
-          request.body = options.to_json unless options.empty?
-        else
-          raise StandardError, "Unknown method: #{method}"
-        end
-        request.options.merge!(options.delete(:request)) if options.key? :request
-      end
-      p response.body if @debug
-      response.body
+    # @param [String] notion_token
+    # @return [NotionRubyMapping::NotionCache] self (NotionCache.instance)
+    def create_client(notion_token, wait: 0.3333, debug: false)
+      @notion_token = notion_token
+      @wait = wait
+      @debug = debug
+      self
     end
 
-    # @param [String] page_id
+    # @param [Hash] payload
     # @return [Hash] response
-    def page_request(page_id)
-      request :get, page_path(page_id)
+    def create_database_request(payload)
+      request :post, databases_path, payload
     end
 
-    # @param [String] database_id
+    # @param [Hash] payload
     # @return [Hash] response
-    def database_request(database_id)
-      request :get, database_path(database_id)
+    def create_page_request(payload)
+      request :post, "v1/pages", payload
     end
 
-    def database_query_request(database_id, payload)
-      request :post, "v1/databases/#{database_id}/query", payload
+    # @param [String] id database_id (with or without "-")
+    # @return [NotionRubyMapping::Base] Database object or nil
+    def database(id)
+      object_for_key(id) { database_request id }
     end
 
-    # @param [String] block_id
-    # @return [Hash] response
-    def block_request(block_id)
-      request :get, block_path(block_id)
+    # @param [String] database_id
+    # @return [String (frozen)] page_path
+    def database_path(database_id)
+      "v1/databases/#{database_id}"
+    end
+
+    # @param [String] id page_id / block_id (with or without "-")
+    # @param [NotionRubyMapping::Query] query query object
+    # @return [NotionRubyMapping::Base] List object
+    # def database_query(id, query)
+    #   Base.create_from_json database_query_request(id, query.query_json)
+    # end
+
+    # @param [String] database_id (with or without "-")
+    # @param [NotionRubyMapping::Query] query query object
+    def database_query_request(database_id, query)
+      request :post, "v1/databases/#{database_id}/query", query.query_json
     end
 
     # @param [String] database_id
     # @return [Hash] response
-    def update_database_request(database_id, payload)
-      request :patch, "v1/databases/#{database_id}", payload
+    def database_request(database_id)
+      request :get, database_path(database_id)
     end
 
-    # @param [String] page_id
-    # @param [Hash] payload
-    # @return [Hash] response
-    def update_page_request(page_id, payload)
-      request :patch, "v1/pages/#{page_id}", payload
+    # @return [String (frozen)] page_path
+    def databases_path
+      "v1/databases"
     end
 
-    # @param [Hash] payload
-    # @return [Hash] response
-    def create_page_request(payload)
-      request :post, "v1/pages", payload
+    # @param [String] id
+    # @return [NotionRubyMapping::Base]
+    def destroy_block(id)
+      Base.create_from_json destroy_block_request(id)
     end
 
-    def create_database_request(payload)
-      request :post, databases_path, payload
+    # @param [String] id
+    # @return [Hash]
+    def destroy_block_request(id)
+      request :delete, block_path(id)
     end
 
     # @param [String] id id string with "-"
     # @return [String] id without "-"
+    # @see https://www.notion.so/hkob/NotionCache-65e1599864d6425686d495a5a4b3a623#a2d70a2e019c4c17898aaa1a36580f1d
     def hex_id(id)
       id&.gsub "-", ""
     end
 
+    def inspect
+      "NotionCache"
+    end
+
     # @param [String] id id (with or without "-")
     # @return [NotionRubyMapping::Base]
     def object_for_key(id)
@@ -167,46 +177,78 @@ module NotionRubyMapping
       object_for_key(id) { page_request id }
     end
 
-    # @param [String] id database_id (with or without "-")
-    # @return [NotionRubyMapping::Base] Database object or nil
-    def database(id)
-      object_for_key(id) { database_request id }
+    # @param [String] page_id
+    # @return [String (frozen)] page_path
+    def page_path(page_id)
+      "v1/pages/#{page_id}"
     end
 
-    # @param [String] id block_id (with or without "-")
-    # @return [NotionRubyMapping::Base] Block object or nil
-    def block(id)
-      object_for_key(id) { block_request id }
+    # @param [String] page_id
+    # @return [Hash] response
+    def page_request(page_id)
+      request :get, page_path(page_id)
     end
 
-    # @param [String] id page_id / block_id (with or without "-")
-    # @return [NotionRubyMapping::Base] List object
-    def block_children(id)
-      array = []
+    # @return [String (frozen)] page_path
+    def pages_path
+      "v1/pages"
+    end
+
+    # @param [String] database_id
+    # @return [String (frozen)] page_path
+    def query_database_path(database_id)
+      "v1/databases/#{database_id}/query"
+    end
+
+    # @param [Symbol] method
+    # @param [String] path
+    # @param [Hash] options
+    # @return [Hash] response hash
+    def request(method, path, options = {})
+      raise "Please call `NotionCache.create_client' before using other methods" unless @notion_token
+
       sleep @wait
-      @client.block_children(block_id: id, sleep_interval: @wait, max_retries: 20) do |page|
-        array.concat page.results
+      response = @client.send(method) do |request|
+        request.headers["Authorization"] = "Bearer #{@notion_token}"
+        request.headers["Notion-Version"] = NotionRubyMapping::NOTION_VERSION
+        case method
+        when :get, :delete
+          request.url path, options
+        when :post, :put, :patch
+          request.headers["Content-Type"] = "application/json"
+          request.path = path
+          request.body = options.to_json unless options.empty?
+        else
+          raise StandardError, "Unknown method: #{method}"
+        end
+        request.options.merge!(options.delete(:request)) if options.key? :request
       end
-      Base.create_from_json({"object" => "list", "results" => array})
+      p response.body if @debug
+      response.body
     end
 
-    # @param [String] id page_id / block_id (with or without "-")
-    # @param [NotionRubyMapping::Query] query query object
-    # @return [NotionRubyMapping::Base] List object
-    def database_query(id, query)
-      Base.create_from_json database_query_request(id, query.query_json)
+    def update_block_request(block_id, payload)
+      request :patch, block_path(block_id), payload
     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})
+    # def update_database(id, payload)
+    #   sleep @wait
+    #   @client.update_database payload.merge({database_id: id})
+    # end
+
+    # @param [String] database_id
+    # @return [Hash] response
+    def update_database_request(database_id, payload)
+      request :patch, database_path(database_id), payload
     end
 
-    # @return [Hash]
-    def clear_object_hash
-      @object_hash = {}
+    # @param [String] page_id
+    # @param [Hash] payload
+    # @return [Hash] response
+    def update_page_request(page_id, payload)
+      request :patch, page_path(page_id), payload
     end
   end
 end

data/lib/notion_ruby_mapping/{payload.rb → controllers/payload.rb}

@@ -5,21 +5,17 @@ module NotionRubyMapping
   class Payload
     def initialize(json)
       @json = json || {}
+      @update_block_key = []
     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
+    # @param [String] key
+    def add_update_block_key(key)
+      @update_block_key << key
+    end
+
+    # @return [Hash] {}
+    def clear
+      @json = {}
     end
 
     # @param [Hash] json
@@ -40,15 +36,33 @@ module NotionRubyMapping
       others.compact.reduce({}) { |hash, o| hash.merge o.property_schema_json }.merge @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
+
+    def update_block_json(type, json)
+      sub_json = json[type]
+      ans = {type => sub_json.slice(*@update_block_key)}
+      ans[type]["caption"] = sub_json["caption"] if sub_json["caption"]
+      ans[type]["rich_text"] = sub_json["rich_text"] if sub_json["rich_text"]
+      ans
+    end
+
     # @return [Hash] created json
     # @param [Object] others
     def update_property_schema_json(*others)
       others.compact.reduce({}) { |hash, o| hash.merge o.update_property_schema_json }.merge @json
     end
-
-    # @return [Hash] {}
-    def clear
-      @json = {}
-    end
   end
 end

data/lib/notion_ruby_mapping/{property_cache.rb → controllers/property_cache.rb}

@@ -13,22 +13,20 @@ module NotionRubyMapping
 
     # @param [String] key
     # @return [Property] Property for key
+    # @see https://www.notion.so/hkob/PropertyCache-2451fa64a814432db4809831cc77ba25#9709e2b2a7a0479f9951291a501f65c8
     def [](key)
       @properties[key] ||= Property.create_from_json key, @json[key], @base_type
     end
 
-    # @param [Array] key
-    # @return [Array]
-    def values_at(*key)
-      generate_all_properties
-      @properties.values_at(*key)
+    # @param [Property] property added Property
+    def add_property(property)
+      @properties[property.name] = property
+      self
     end
 
-    def generate_all_properties
-      if @json.empty?
-        @properties.values
-      else
-        @json.keys.map { |key| self[key] }
+    def clear_will_update
+      @properties.each do |_, property|
+        property.clear_will_update
       end
     end
 
@@ -39,16 +37,11 @@ module NotionRubyMapping
       generate_all_properties.each(&block)
     end
 
-    # @param [Property] property added Property
-    def add_property(property)
-      @properties[property.name] = property
-      self
-    end
-
-
-    def clear_will_update
-      @properties.each do |_, property|
-        property.clear_will_update
+    def generate_all_properties
+      if @json.empty?
+        @properties.values
+      else
+        @json.keys.map { |key| self[key] }
       end
     end
 
@@ -81,5 +74,13 @@ module NotionRubyMapping
         end
       end
     end
+
+    # @param [Array] key
+    # @return [Array]
+    # @see https://www.notion.so/hkob/PropertyCache-2451fa64a814432db4809831cc77ba25#6eb10d1d85784063a30feb225f47ede3
+    def values_at(*key)
+      generate_all_properties
+      @properties.values_at(*key)
+    end
   end
 end

data/lib/notion_ruby_mapping/{query.rb → controllers/query.rb}

@@ -12,24 +12,13 @@ module NotionRubyMapping
     attr_reader :filter, :sort, :page_size
     attr_accessor :start_cursor
 
-    # @param [Query] other_query other query
+    # @param [Query] another_query other query
     # @return [NotionRubyMapping::Query] updated self (Query object)
-    def and(other_query)
+    def and(another_query)
       if @filter.key? "and"
-        @filter["and"] << other_query.filter
+        @filter["and"] << another_query.filter
       else
-        @filter = {"and" => [@filter, other_query.filter]}
-      end
-      self
-    end
-
-    # @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
-      else
-        @filter = {"or" => [@filter, other_query.filter]}
+        @filter = {"and" => [@filter, another_query.filter]}
       end
       self
     end
@@ -50,14 +39,33 @@ module NotionRubyMapping
       self
     end
 
+    # @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
+      else
+        @filter = {"or" => [@filter, other_query.filter]}
+      end
+      self
+    end
+
     # @return [Hash]
     def query_json
       parameters = {}
-      parameters[:filter] = filter unless filter.empty?
-      parameters[:sorts] = sort unless sort.empty?
-      parameters[:start_cursor] = start_cursor if start_cursor
-      parameters[:page_size] = page_size if page_size
+      parameters[:filter] = @filter unless @filter.empty?
+      parameters[:sorts] = @sort unless @sort.empty?
+      parameters[:start_cursor] = @start_cursor if @start_cursor
+      parameters[:page_size] = @page_size if @page_size
       parameters
     end
+
+    # @return [String (frozen)]
+    def query_string
+      ans = []
+      ans << "page_size=#{@page_size}" if @page_size
+      ans << "start_cursor=#{@start_cursor}" if @start_cursor
+      ans.empty? ? "" : "?#{ans.join("&")}"
+    end
   end
 end

data/lib/notion_ruby_mapping/{rich_text_array.rb → controllers/rich_text_array.rb}

@@ -19,6 +19,32 @@ module NotionRubyMapping
                            end
       @will_update = will_update
     end
+    attr_writer :will_update
+
+    def self.rich_text_array(key, text_objects = nil)
+      if text_objects.nil?
+        RichTextArray.new key
+      elsif text_objects.is_a? RichTextArray
+        text_objects
+      else
+        RichTextArray.new key, text_objects: text_objects
+      end
+    end
+
+    # @param [String, RichTextObject] to
+    # @return [NotionRubyMapping::RichTextObject] added RichTextObject
+    def <<(to)
+      @will_update = true
+      rto = RichTextObject.text_object(to)
+      @rich_text_objects << rto
+      rto
+    end
+
+    # @param [Numeric] index index number
+    # @return [RichTextObject] selected RichTextObject
+    def [](index)
+      @rich_text_objects[index]
+    end
 
     # @param [Array] json
     # @return [Array] RichTextArray
@@ -46,6 +72,17 @@ module NotionRubyMapping
       map(&:text).join ""
     end
 
+    def rich_text_objects=(text_info)
+      @will_update = true
+      @rich_text_objects = if text_info.is_a? RichTextArray
+                             text_info.filter { true }
+                           else
+                             Array(text_info).map do |to|
+                               RichTextObject.text_object to
+                             end
+                           end
+    end
+
     def property_values_json
       will_update ? @rich_text_objects.map(&:property_values_json) : []
     end
@@ -54,28 +91,13 @@ module NotionRubyMapping
       will_update ? {@key => @rich_text_objects.map(&:property_values_json)} : {}
     end
 
-    def update_property_schema_json
-      will_update ? {@key => @rich_text_objects.map(&:property_values_json)} : {}
+    def update_property_schema_json(flag = false)
+      flag || will_update ? {@key => @rich_text_objects.map(&:property_values_json)} : {}
     end
 
     # @return [TrueClass, FalseClass] true if it will update
     def will_update
       @will_update || @rich_text_objects.map(&:will_update).any?
     end
-
-    # @param [String, RichTextObject] to
-    # @return [NotionRubyMapping::RichTextObject] added RichTextObject
-    def <<(to)
-      @will_update = true
-      rto = RichTextObject.text_object(to)
-      @rich_text_objects << rto
-      rto
-    end
-
-    # @param [Numeric] index index number
-    # @return [RichTextObject] selected RichTextObject
-    def [](index)
-      @rich_text_objects[index]
-    end
   end
 end

data/lib/notion_ruby_mapping/objects/emoji_object.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # TextObject
+  class EmojiObject
+    # @param [String] emoji
+    # @return [TextObject]
+    def initialize(emoji: nil, json: {})
+      @emoji = emoji || json && json["emoji"]
+      @will_update = false
+    end
+    attr_reader :will_update, :emoji
+
+    # @param [EmojiObject, String] uo
+    # @return [EmojiObject] self or created EmojiObject
+    # @see https://www.notion.so/hkob/EmojiObject-4a0d41a10a81490f82471059c5b39b1b#959b7d74c1a54e488b39a96ac8f634e5
+    def self.emoji_object(emoji_or_eo)
+      if emoji_or_eo.is_a? EmojiObject
+        emoji_or_eo
+      else
+        EmojiObject.new emoji: emoji_or_eo
+      end
+    end
+
+    # @param [String] emoji
+    # @see https://www.notion.so/hkob/EmojiObject-4a0d41a10a81490f82471059c5b39b1b#b0520d80de084c1c99e8595db9d36542
+    def emoji=(emoji)
+      @emoji = emoji
+      @will_update = true
+    end
+
+    # @return [Hash]
+    def property_values_json
+      {
+        "type" => "emoji",
+        "emoji" => @emoji,
+      }
+    end
+  end
+end