notion_ruby_mapping 1.0.0 → 2.0.0

data/lib/notion_ruby_mapping/objects/file_object.rb

@@ -5,56 +5,79 @@ module NotionRubyMapping
   class FileObject
     # @param [String] url
     # @return [TextObject]
-    def initialize(url: nil, json: {})
+    def initialize(url: nil, file_upload_object: nil, json: {})
       if url
-        @type = :external
+        @type = "external"
         @url = url
+      elsif file_upload_object
+        @type = "file_upload"
+        @file_upload_object = file_upload_object
       elsif json
-        @type = json[:type].to_sym
-        @url = json[@type][:url]
-        @expiry_time = json[@type][:expiry_time]
+        @type = json["type"]
+        @url = json[@type]["url"]
+        @expiry_time = json[@type]["expiry_time"]
       else
         raise StandardError, "FileObject requires url: or json:"
       end
       @will_update = false
     end
-    attr_reader :will_update, :url, :type
+    attr_reader :will_update, :url, :type, :file_upload_object
 
-    # @param [FileObject, String] uo
+    # @param [FileObject, FileUploadObject, String] url_or_fuo_or_fo
     # @return [FileObject] self or created FileObject
     # @see https://www.notion.so/hkob/FileObject-6218c354e985423a90904f47a985be33#54b37c567e1d4dfcab06f6d8f8fd412e
-    def self.file_object(url_or_fo)
-      if url_or_fo.is_a? FileObject
-        url_or_fo
+    def self.file_object(url_or_fuo_or_fo)
+      if url_or_fuo_or_fo.is_a? FileUploadObject
+        FileObject.new file_upload_object: url_or_fuo_or_fo
+      elsif url_or_fuo_or_fo.is_a? FileObject
+        url_or_fuo_or_fo
       else
-        FileObject.new url: url_or_fo
+        FileObject.new url: url_or_fuo_or_fo
       end
     end
 
     # @return [TrueClass, FalseClass] true if "type" is "external"
     def external?
-      @type == :external
+      @type == "external"
+    end
+
+    # @param [FileUploadObject] fuo
+    def file_upload_object=(fuo)
+      @file_upload_object = fuo
+      @type = "file_upload"
+      @url = nil
+      @expiry_time = nil
+      @will_update = true
     end
 
     # @param [String] url
     # @see https://www.notion.so/hkob/FileObject-6218c354e985423a90904f47a985be33#6b841f75d0234a1aac93fb54348abb96
     def url=(url)
       @url = url
-      @type = :external
+      @type = "external"
       @expiry_time = nil
       @will_update = true
     end
 
     # @return [Hash]
     def property_values_json
-      ans = {
-        type: @type.to_s,
-        @type => {
-          url: @url,
-        },
-      }
-      ans[@type][:expiry_time] = @expiry_time if @expiry_time
-      ans
+      if @type == "file_upload"
+        {
+          "type" => @type.to_s,
+          @type => {
+            "id" => @file_upload_object.id,
+          },
+        }
+      else
+        ans = {
+          "type" => @type.to_s,
+          @type => {
+            "url" => @url,
+          },
+        }
+        ans[@type]["expiry_time"] = @expiry_time if @expiry_time
+        ans
+      end
     end
   end
 end

data/lib/notion_ruby_mapping/objects/file_upload_object.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+class FileUploadObject
+  MAX_SIZE = 10 * 1024 * 1024 # 10 MB
+  # @param [String] id
+  def initialize(fname:, external_url: nil)
+    @fname = fname
+    if external_url
+      payload = {mode: "external_url", external_url: external_url, filename: fname}
+      create payload
+    else
+      raise StandardError, "FileUploadObject requires a valid file name: #{fname}" unless File.exist?(fname)
+
+      @file_size = File.size fname
+      @number_of_parts = (@file_size - 1) / MAX_SIZE + 1
+      payload = if @number_of_parts == 1
+                  {}
+                else
+                  {number_of_parts: @number_of_parts, mode: "multi_part",
+                   filename: File.basename(@fname)}
+                end
+      create payload
+      if @number_of_parts == 1
+        single_file_upload
+      else
+        @temp_files = FileUploadObject.split_to_small_files(@fname, MAX_SIZE)
+        @temp_files.each_with_index do |temp_file, i|
+          single_file_upload temp_file.path, i + 1
+          temp_file.close
+          temp_file.unlink
+        end
+        NotionRubyMapping::NotionCache.instance.complete_a_file_upload_request @id
+      end
+    end
+  end
+  attr_reader :id, :fname
+
+  # @return [FileUploadObject]
+  def create(payload)
+    nc = NotionRubyMapping::NotionCache.instance
+    response = nc.create_file_upload_request(payload)
+    @id = nc.hex_id response["id"]
+  end
+
+  # @param [String] fname
+  # @param [Integer, NilClass] part_number
+  def single_file_upload(fname = @fname, part_number = 0)
+    if @number_of_parts > 1
+      options = {"part_number" => part_number}
+      status = "pending"
+    else
+      options = {}
+      status = "uploaded"
+    end
+    nc = NotionRubyMapping::NotionCache.instance
+    response = nc.file_upload_request fname, @id, options
+    return if nc.hex_id(response["id"]) == @id && response["status"] == status
+
+    raise StandardError, "File upload failed: #{response}"
+  end
+
+  def self.split_to_small_files(org_file, max_size = MAX_SIZE)
+    raise StandardError, "File does not exist: #{org_file}" unless File.exist?(org_file)
+
+    temp_files = []
+    File.open(org_file, "rb") do |file|
+      until file.eof?
+        chunk = file.read(max_size)
+        temp_file = Tempfile.new("part_")
+        temp_file.binmode
+        temp_file.write(chunk)
+        temp_file.rewind
+        temp_files << temp_file
+      end
+    end
+    temp_files
+  end
+end

data/lib/notion_ruby_mapping/objects/mention_object.rb

@@ -5,16 +5,16 @@ module NotionRubyMapping
   class MentionObject < RichTextObject
     # @return [MentionObject]
     def initialize(options = {})
-      super :mention, options
-      return unless (url = options[:link_preview])
+      super "mention", options
+      return unless (url = options["link_preview"])
 
-      @options[:href] = url
-      @options[:plain_text] = url
+      @options["href"] = url
+      @options["plain_text"] = url
     end
 
     # @return [String, NilClass]
     def page_id
-      @options[:page_id]
+      @options["page_id"]
     end
 
     # @return [String (frozen)]
@@ -23,69 +23,69 @@ module NotionRubyMapping
     end
 
     def partial_property_values_json
-      if @options.key? :user_id
+      if @options.key? "user_id"
         {
-          type: "user",
-          user: {
-            object: "user",
-            id: @options[:user_id],
+          "type" => "user",
+          "user" => {
+            "object" => "user",
+            "id" => @options["user_id"],
           },
         }
-      elsif @options.key? :page_id
+      elsif @options.key? "page_id"
         {
-          type: "page",
-          page: {
-            id: @options[:page_id],
+          "type" => "page",
+          "page" => {
+            "id" => @options["page_id"],
           },
         }
-      elsif @options.key? :database_id
+      elsif @options.key? "database_id"
         {
-          type: "database",
-          database: {
-            id: @options[:database_id],
+          "type" => "database",
+          "database" => {
+            "id" => @options["database_id"],
           },
         }
-      elsif @options.key? :start
+      elsif @options.key? "start"
         {
-          type: "date",
-          date: @options.slice(:start, :end, :time_zone),
+          "type" => "date",
+          "date" => @options.slice("start", "end", "time_zone"),
         }
-      elsif @options.key? :template_mention
-        sub = case @options[:template_mention]&.to_sym
-              when :today
-                @options[:plain_text] = "@Today"
+      elsif @options.key? "template_mention"
+        sub = case @options["template_mention"]
+              when "today"
+                @options["plain_text"] = "@Today"
                 {
-                  type: :template_mention_date,
-                  template_mention_date: "today",
+                  "type" => "template_mention_date",
+                  "template_mention_date" => "today",
                 }
-              when :now
-                @options[:plain_text] = "@Now"
+              when "now"
+                @options["plain_text"] = "@Now"
                 {
-                  type: :template_mention_date,
-                  template_mention_date: "now",
+                  "type" => "template_mention_date",
+                  "template_mention_date" => "now",
                 }
               else
-                @options[:plain_text] = "@Me"
+                @options["plain_text"] = "@Me"
                 {
-                  type: :template_mention_user,
-                  template_mention_user: "me",
+                  "type" => "template_mention_user",
+                  "template_mention_user" => "me",
                 }
               end
         {
-          type: :template_mention,
-          template_mention: sub,
+          "type" => "template_mention",
+          "template_mention" => sub,
         }
-      elsif @options.key? :link_preview
+      elsif @options.key? "link_preview"
         {
-          type: :link_preview,
-          link_preview: {
-            url: @options[:link_preview],
+          "type" => "link_preview",
+          "link_preview" => {
+            "url" => @options["link_preview"],
           },
         }
-      elsif @options.key? :href
+      elsif @options.key? "href"
         {
-          type: :link_mention,
-          link_mention: @options.slice(:href, :icon_url, :link_provider, :thumbnail_url, :title),
+          "type" => "link_mention",
+          "link_mention" => @options.slice("href", "icon_url", "link_provider", "thumbnail_url", "title"),
         }
       else
         raise StandardError, "Irregular mention type: #{@options.keys}"

data/lib/notion_ruby_mapping/objects/rich_text_object.rb

@@ -3,7 +3,7 @@
 module NotionRubyMapping
   # RichTextObject
   class RichTextObject
-    # @param [Symbol] type
+    # @param [String] type
     # @return [TextObject]
     def initialize(type, options = {})
       if instance_of?(RichTextObject)
@@ -11,45 +11,45 @@ module NotionRubyMapping
               "RichTextObject is abstract class.  Please use TextObject."
       end
 
-      @type = type.to_sym
+      @type = type
       @options = options
     end
     attr_reader :will_update, :options
 
     def self.create_from_json(json)
-      type = json[:type]&.to_sym
-      options = (json[:annotations] || {}).merge(json.slice(:plain_text, :href))
+      type = json["type"]
+      options = (json["annotations"] || {}).merge(json.slice("plain_text", "href"))
       case type
-      when :text
-        TextObject.new json[:plain_text], options
-      when :equation
-        EquationObject.new json[:equation][:expression], options
-      when :mention
-        mention = json[:mention]
-        case mention[:type]&.to_sym
-        when :user
-          MentionObject.new options.merge({user_id: mention[:user][:id]})
-        when :page
-          MentionObject.new options.merge({page_id: mention[:page][:id]})
-        when :database
-          MentionObject.new options.merge({database_id: mention[:database][:id]})
-        when :date
-          MentionObject.new options.merge(mention[:date].slice(:start, :end, :time_zone))
-        when :template_mention
-          template_mention = mention[:template_mention]
-          case template_mention[:type].to_sym
-          when :template_mention_date
-            MentionObject.new options.merge({template_mention: template_mention[:template_mention_date]})
+      when "text"
+        TextObject.new json["plain_text"], options
+      when "equation"
+        EquationObject.new json["equation"]["expression"], options
+      when "mention"
+        mention = json["mention"]
+        case mention["type"]
+        when "user"
+          MentionObject.new options.merge({"user_id" => mention["user"]["id"]})
+        when "page"
+          MentionObject.new options.merge({"page_id" => mention["page"]["id"]})
+        when "database"
+          MentionObject.new options.merge({"database_id" => mention["database"]["id"]})
+        when "date"
+          MentionObject.new options.merge(mention["date"].slice("start", "end", "time_zone"))
+        when "template_mention"
+          template_mention = mention["template_mention"]
+          case template_mention["type"]
+          when "template_mention_date"
+            MentionObject.new options.merge({"template_mention" => template_mention["template_mention_date"]})
           else
-            MentionObject.new options.merge({template_mention: template_mention[:template_mention_user]})
+            MentionObject.new options.merge({"template_mention" => template_mention["template_mention_user"]})
           end
-        when :link_preview
-          MentionObject.new options.merge({link_preview: mention[:link_preview][:url]})
-        when :link_mention
-          lm_keys = %i[href icon_url link_provider thumbnail_url title]
-          MentionObject.new options.merge(mention[:link_mention].slice(*lm_keys))
+        when "link_preview"
+          MentionObject.new options.merge({"link_preview" => mention["link_preview"]["url"]})
+        when "link_mention"
+          lm_keys = %w[href icon_url link_provider thumbnail_url title]
+          MentionObject.new options.merge(mention["link_mention"].slice(*lm_keys))
         else
-          raise StandardError, "Unknown mention type: #{mention[:type]}"
+          raise StandardError, "Unknown mention type: #{mention["type"]}"
         end
       else
         raise StandardError, json
@@ -69,10 +69,10 @@ module NotionRubyMapping
     # @return [Hash{String (frozen)->Object}]
     def property_values_json
       {
-        type: @type.to_s,
+        "type" => @type,
         @type => partial_property_values_json,
-        plain_text: @options[:plain_text],
-        href: @options[:href],
+        "plain_text" => @options["plain_text"],
+        "href" => @options["href"],
       }.merge annotations_json
     end
 
@@ -85,7 +85,7 @@ module NotionRubyMapping
     # @return [String] input text
     def href=(url)
       @will_update = true
-      @options[:href] = url
+      @options["href"] = url
     end
 
     # @param [String, RichTextObject] value
@@ -98,50 +98,50 @@ module NotionRubyMapping
     # @return [Boolean] input flag
     def bold=(flag)
       @will_update = true
-      @options[:bold] = flag
+      @options["bold"] = flag
     end
 
     # @param [Boolean] flag
     # @return [Boolean] input flag
     def italic=(flag)
       @will_update = true
-      @options[:italic] = flag
+      @options["italic"] = flag
     end
 
     # @param [Boolean] flag
     # @return [Boolean] input flag
     def strikethrough=(flag)
       @will_update = true
-      @options[:strikethrough] = flag
+      @options["strikethrough"] = flag
     end
 
     # @param [Boolean] flag
     # @return [Boolean] input flag
     def underline=(flag)
       @will_update = true
-      @options[:underline] = flag
+      @options["underline"] = flag
     end
 
     # @param [Boolean] flag
     # @return [Boolean] input flag
     def code=(flag)
       @will_update = true
-      @options[:code] = flag
+      @options["code"] = flag
     end
 
     # @param [String] color
     # @return [String] input color
     def color=(color)
       @will_update = true
-      @options[:color] = color
+      @options["color"] = color
     end
 
     protected
 
     # @return [Hash, Hash{String (frozen)->Hash}]
     def annotations_json
-      annotations = @options.slice(*%i[bold italic strikethrough underline code color])
-      annotations.empty? ? {} : {annotations: annotations}
+      annotations = @options.slice(*%w[bold italic strikethrough underline code color])
+      annotations.empty? ? {} : {"annotations" => annotations}
     end
   end
 end

data/lib/notion_ruby_mapping/objects/text_object.rb

@@ -6,7 +6,7 @@ module NotionRubyMapping
     # @param [String] text
     # @return [TextObject]
     def initialize(text, options = {})
-      super :text, {plain_text: text}.merge(options)
+      super "text", {"plain_text" => text}.merge(options)
       @text = text
       @will_update = false
     end
@@ -20,17 +20,17 @@ module NotionRubyMapping
         @text = value.text
       else
         @text = value
-        @options[:plain_text] = value
+        @options["plain_text"] = value
       end
     end
 
     protected
 
     def partial_property_values_json
-      url = @options[:href]
+      url = @options["href"]
       {
-        content: @text,
-        link: url ? {url: url} : nil,
+        "content" => @text,
+        "link" => url ? {"url" => url} : nil,
       }
     end
   end

data/lib/notion_ruby_mapping/objects/user_object.rb

@@ -6,7 +6,7 @@ module NotionRubyMapping
     # @param [String] user_id
     # @return [TextObject]
     def initialize(user_id: nil, json: {})
-      @user_id = NotionCache.instance.hex_id(user_id || json && json[:id])
+      @user_id = NotionCache.instance.hex_id(user_id || json && json["id"])
       @json = json
       @will_update = false
     end
@@ -56,14 +56,14 @@ module NotionRubyMapping
 
     # @return [String]
     def name
-      @json[:name]
+      @json["name"]
     end
 
     # @return [Hash]
     def property_values_json
       {
-        object: "user",
-        id: @user_id,
+        "object" => "user",
+        "id" => @user_id,
       }
     end
 

data/lib/notion_ruby_mapping/properties/button_property.rb

@@ -3,7 +3,7 @@
 module NotionRubyMapping
   # Button property
   class ButtonProperty < Property
-    TYPE = :button
+    TYPE = "button"
 
     ### Public announced methods
 
@@ -16,7 +16,7 @@ module NotionRubyMapping
 
     # @param [String, Symbol] name Property name
     # @param [Boolean, Hash] json
-    def initialize(name, will_update: false, base_type: :page, property_id: nil, property_cache: nil, json: nil)
+    def initialize(name, will_update: false, base_type: "page", property_id: nil, property_cache: nil, json: nil)
       super name, will_update: will_update, base_type: base_type, property_id: property_id,
                   property_cache: property_cache
       @json = json
@@ -27,7 +27,7 @@ module NotionRubyMapping
     # @return [Hash]
     def property_values_json
       assert_page_property __method__
-      {@name => {button: @json, type: "button"}}
+      {@name => {"button" => @json, "type" => "button"}}
     end
   end
 end

data/lib/notion_ruby_mapping/properties/checkbox_property.rb

@@ -4,7 +4,7 @@ module NotionRubyMapping
   # Checkbox property
   class CheckboxProperty < Property
     include EqualsDoesNotEqual
-    TYPE = :checkbox
+    TYPE = "checkbox"
 
     ### Public announced methods
 
@@ -33,7 +33,7 @@ module NotionRubyMapping
 
     # @param [String, Symbol] name Property name
     # @param [Boolean, Hash] json
-    def initialize(name, will_update: false, base_type: :page, property_id: nil, property_cache: nil, json: nil)
+    def initialize(name, will_update: false, base_type: "page", property_id: nil, property_cache: nil, json: nil)
       super name, will_update: will_update, base_type: base_type, property_id: property_id,
                   property_cache: property_cache
       @json = if database?
@@ -48,7 +48,7 @@ module NotionRubyMapping
     # @return [Hash]
     def property_values_json
       assert_page_property __method__
-      {@name => {checkbox: @json, type: "checkbox"}}
+      {@name => {"checkbox" => @json, "type" => "checkbox"}}
     end
   end
 end

data/lib/notion_ruby_mapping/properties/created_by_property.rb

@@ -3,7 +3,7 @@
 module NotionRubyMapping
   # CreatedByProperty
   class CreatedByProperty < MultiProperty
-    TYPE = :created_by
+    TYPE = "created_by"
 
     ### Public announced methods
 
@@ -22,7 +22,7 @@ module NotionRubyMapping
     # @param [String, Symbol] name Property name
     # @param [String] user_id user_id (optional)
     # @param [Hash] json json (optional)
-    def initialize(name, will_update: false, base_type: :page, json: nil, user_id: nil, property_id: nil,
+    def initialize(name, will_update: false, base_type: "page", json: nil, user_id: nil, property_id: nil,
                    property_cache: nil)
       super name, will_update: will_update, base_type: base_type, property_id: property_id,
                   property_cache: property_cache
@@ -36,7 +36,7 @@ module NotionRubyMapping
     # @param [Hash] json
     def update_from_json(json)
       @will_update = false
-      cb = json[:created_by]
+      cb = json["created_by"]
       @json = database? ? cb : UserObject.new(json: cb)
     end
 

data/lib/notion_ruby_mapping/properties/created_time_property.rb

@@ -3,7 +3,7 @@
 module NotionRubyMapping
   # CreatedTimeProperty
   class CreatedTimeProperty < DateBaseProperty
-    TYPE = :created_time
+    TYPE = "created_time"
 
     ### Public announced methods
 
@@ -21,7 +21,7 @@ module NotionRubyMapping
 
     # @param [String, Symbol] name Property name
     # @param [String] json created_time value (optional)
-    def initialize(name, will_update: false, base_type: :page, json: nil, property_id: nil, property_cache: nil)
+    def initialize(name, will_update: false, base_type: "page", json: nil, property_id: nil, property_cache: nil)
       super name, will_update: will_update, base_type: base_type, property_id: property_id,
                   property_cache: property_cache
       @json = json