notion_ruby_mapping 0.2.3 → 0.3.0

data/lib/notion_ruby_mapping/number_property.rb

@@ -8,28 +8,89 @@ module NotionRubyMapping
     include IsEmptyIsNotEmpty
     TYPE = "number"
 
+    ### Public announced methods
+
+    ## Common methods
+
+    # @return [Numeric, Hash]
+    def number
+      @json
+    end
+
+    ## Database property only methods
+
+    # @return [String] new or settled format
+    def format
+      assert_database_property __method__
+      @json["format"]
+    end
+
+    # @param [String] format
+    # @return [String] settled format
+    def format=(format)
+      assert_database_property __method__
+      @will_update = true
+      @json["format"] = format
+    end
+
+    ## Page property only methods
+
+    # @param [Numeric] num
+    # @return [Numeric] settled number
+    def number=(num)
+      assert_page_property __method__
+      @will_update = true
+      @json = num
+    end
+
+    ### Not public announced methods
+
+    ## Common methods
+
     # @param [String] name Property name
-    # @param [Float, Integer] number Number value (optional)
-    def initialize(name, will_update: false, number: nil)
-      super name, will_update: will_update
-      @number = number
+    # @param [Float, Integer, Hash] json Number value or format Hash
+    def initialize(name, will_update: false, base_type: :page, json: nil, format: nil)
+      super name, will_update: will_update, base_type: base_type
+      @json = json
+      @json ||= {"format" => (format || "number")} if database?
     end
-    attr_reader :number
 
     # @param [Hash] json
+    # @return [NotionRubyMapping::NumberProperty]
     def update_from_json(json)
       @will_update = false
-      @number = json["number"]
+      @json = json["number"]
+      self
+    end
+
+    ## Database property only methods
+
+    # @return [Hash]
+    def update_property_schema_json
+      assert_database_property __method__
+      ans = super
+      return ans if ans != {} || !@will_update
+
+      ans[@name] ||= {}
+      ans[@name]["number"] = @json
+      ans
     end
 
+    ## Page property only methods
+
     # @return [Hash]
     def property_values_json
-      {@name => {"number" => @number, "type" => "number"}}
+      assert_page_property __method__
+      {@name => {"number" => @json, "type" => "number"}}
     end
 
-    def number=(num)
-      @will_update = true
-      @number = num
+    protected
+
+    ## Database property only methods
+
+    # @return [Hash]
+    def property_schema_json_sub
+      {"format" => format}
     end
   end
 end

data/lib/notion_ruby_mapping/page.rb

@@ -3,26 +3,48 @@
 module NotionRubyMapping
   # Notion page object
   class Page < Base
-    def self.find(id)
-      NotionCache.instance.page id
-    end
+    ### Public announced methods
 
-    # @return [NotionRubyMapping::Base]46G
-    def update
-      update_json @nc.update_page_request(@id, property_values_json)
+    # @param [String] id
+    # @return [NotionRubyMapping::Page, String]
+    def self.find(id, dry_run: false)
+      nc = NotionCache.instance
+      if dry_run
+        Base.dry_run_script :get, nc.page_path(id)
+      else
+        nc.page id
+      end
     end
 
-    # @return [NotionRubyMapping::Base]
-    def create
-      @new_record = false
-      update_json @nc.create_page_request(property_values_json)
+    def create_child_database(title, *assign)
+      Database.new json: {"title" => [TextObject.new(title).property_values_json]},
+                   assign: assign, parent: {"type" => "page_id", "page_id" => @id}
     end
 
     protected
 
+    # @return [NotionRubyMapping::Base, String]
+    def create(dry_run: false)
+      if dry_run
+        dry_run_script :post, @nc.pages_path, :property_values_json
+      else
+        @new_record = false
+        update_json @nc.create_page_request(property_values_json)
+      end
+    end
+
     # @return [Hash]
     def reload_json
       @nc.page_request @id
     end
+
+    # @return [NotionRubyMapping::Base, String]
+    def update(dry_run: false)
+      if dry_run
+        dry_run_script :patch, @nc.page_path(@id), :property_values_json
+      else
+        update_json @nc.update_page_request(@id, property_values_json)
+      end
+    end
   end
 end

data/lib/notion_ruby_mapping/payload.rb

@@ -22,10 +22,28 @@ module NotionRubyMapping
       self
     end
 
+    # @param [Hash] json
+    def merge_property(json)
+      @json["properties"] ||= {}
+      @json["properties"].merge!(json)
+    end
+
+    # @return [Hash] created json
+    # @param [Object] others
+    def property_values_json(*others)
+      others.compact.reduce({}) { |hash, o| hash.merge o.property_values_json }.merge @json
+    end
+
+    # @return [Hash] created json
+    # @param [Object] others
+    def property_schema_json(*others)
+      others.compact.reduce({}) { |hash, o| hash.merge o.property_schema_json }.merge @json
+    end
+
     # @return [Hash] created json
-    # @param [Hash] optional_json
-    def property_values_json(optional_json = nil)
-      @json.merge(optional_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] {}

data/lib/notion_ruby_mapping/people_property.rb

@@ -5,41 +5,69 @@ module NotionRubyMapping
   class PeopleProperty < MultiProperty
     TYPE = "people"
 
+    ### Public announced methods
+
+    ## Common methods
+
+    # @return [Array, Hash]
+    def people
+      @json
+    end
+
+    ## Page property only methods
+
+    # @param [String, NotionRubyMapping::UserObject] user_or_user_id
+    # @return [Array<UserObject>]
+    def add_person(user_or_user_id)
+      @will_update = true
+      @json << UserObject.user_object(user_or_user_id)
+    end
+
+    # @param [Hash] people
+    # @return [Array, nil] replaced array
+    def people=(people)
+      @will_update = true
+      @json = people ? Array(people).map { |uo| UserObject.user_object(uo) } : []
+    end
+
+    ### Not public announced methods
+
+    ## Common methods
+
     # @param [String] name
     # @param [Hash] json
     # @param [Array] people ids for people
-    def initialize(name, will_update: false, json: nil, people: nil)
-      super name, will_update: will_update
-      @people = if people
-                  Array(people).map { |uo| UserObject.user_object(uo) }
-                elsif json
-                  json.map { |p| UserObject.new json: p }
-                else
-                  []
-                end
+    def initialize(name, will_update: false, base_type: :page, json: nil, people: nil)
+      super name, will_update: will_update, base_type: base_type
+      @json = if database?
+                {}
+              elsif people
+                Array(people).map { |uo| UserObject.user_object(uo) }
+              elsif json
+                json.map { |p| UserObject.new json: p }
+              else
+                []
+              end
     end
 
+    ## Page property only methods
+
     # @return [Hash] created json
     def property_values_json
+      assert_page_property __method__
       {
         @name => {
           "type" => "people",
-          "people" => @people.map(&:property_values_json),
+          "people" => @json.map(&:property_values_json),
         },
       }
     end
 
-    # @param [Hash] json
+    # @param [Array] json
+    # @return [Hash, Array]
     def update_from_json(json)
       @will_update = false
-      @people = json["people"].map { |pjson| UserObject.new json: pjson }
-    end
-
-    # @param [Hash] people
-    # @return [Array, nil] settled array
-    def people=(people)
-      @will_update = true
-      @people = people ? Array(people).map { |uo| UserObject.user_object(uo) } : []
+      @json = database? ? {} : json["people"].map { |p_json| UserObject.new json: p_json }
     end
   end
 end

data/lib/notion_ruby_mapping/phone_number_property.rb

@@ -9,28 +9,39 @@ module NotionRubyMapping
     include IsEmptyIsNotEmpty
     TYPE = "phone_number"
 
+    ### Public announced methods
+
+    ## Common methods
+
+    # @return [String, Hash, nil] phone number (Page), {} (Database)
+    def phone_number
+      @json
+    end
+
+    ## Page property only methods
+
+    def phone_number=(phone_number)
+      @will_update = true
+      @json = phone_number
+    end
+
+    ### Not public announced methods
+
+    ## Common methods
+
     # @param [String] name Property name
     # @param [String] phone_number phone_number value (optional)
-    def initialize(name, will_update: false, phone_number: nil)
-      super name, will_update: will_update
-      @phone_number = phone_number
+    def initialize(name, will_update: false, base_type: :page, json: nil)
+      super name, will_update: will_update, base_type: base_type
+      @json = database? ? {} : json
     end
-    attr_reader :phone_number
 
-    # @param [Hash] json
-    def update_from_json(json)
-      @will_update = false
-      @phone_number = json["phone_number"]
-    end
+    ## Page property only methods
 
     # @return [Hash]
     def property_values_json
-      {@name => {"phone_number" => @phone_number, "type" => "phone_number"}}
-    end
-
-    def phone_number=(phone_number)
-      @will_update = true
-      @phone_number = phone_number
+      assert_page_property __method__
+      {@name => {"phone_number" => @json, "type" => "phone_number"}}
     end
   end
 end

data/lib/notion_ruby_mapping/property.rb

@@ -3,16 +3,87 @@
 module NotionRubyMapping
   # abstract class for property
   class Property
+    ### Public announced methods
+
+    ## Common methods
+
+    attr_reader :name, :will_update
+
+    ## Database property only methods
+
+    # @param [String] new_name
+    def new_name=(new_name)
+      assert_database_property __method__
+      @will_update = true
+      @new_name = new_name
+    end
+
+    # @return [NotionRubyMapping::Property] self
+    def remove
+      assert_database_property __method__
+      @will_update = true
+      @remove = true
+      self
+    end
+
+    ### Not public announced methods
+
+    ## Common methods
+
     # @param [String] name Property name
     # @return [Property] generated Property object
-    def initialize(name, will_update: false)
+    def initialize(name, will_update: false, base_type: :page)
       @name = name
       @will_update = will_update
+      @base_type = base_type
+      @create = false
+      @remove = false
+      @new_name = nil
+      @json = nil
+    end
+
+    # @param [String] name
+    # @param [Hash] input_json
+    # @return [NotionRubyMapping::Property, nil] generated Property object
+    def self.create_from_json(name, input_json, base_type = :page)
+      raise StandardError, "Property not found: #{name}:#{input_json}" if input_json.nil?
+
+      type = input_json["type"]
+      klass = {
+        "checkbox" => CheckboxProperty,
+        "created_time" => CreatedTimeProperty,
+        "date" => DateProperty,
+        "formula" => FormulaProperty,
+        "last_edited_time" => LastEditedTimeProperty,
+        "rollup" => RollupProperty,
+        "email" => EmailProperty,
+        "files" => FilesProperty,
+        "created_by" => CreatedByProperty,
+        "last_edited_by" => LastEditedByProperty,
+        "multi_select" => MultiSelectProperty,
+        "people" => PeopleProperty,
+        "relation" => RelationProperty,
+        "number" => NumberProperty,
+        "phone_number" => PhoneNumberProperty,
+        "select" => SelectProperty,
+        "title" => TitleProperty,
+        "rich_text" => RichTextProperty,
+        "url" => UrlProperty,
+      }[type]
+      raise StandardError, "Irregular property type: #{type}" unless klass
+
+      klass.new name, json: input_json[type], base_type: base_type
     end
-    attr_reader :name
 
-    # @return [TrueClass, FalseClass]
-    attr_reader :will_update
+    # @return [FalseClass]
+    def clear_will_update
+      @will_update = false
+    end
+
+    # @return [TrueClass, FalseClass] true if database property
+    def database?
+      @base_type == :database
+    end
 
     # @param [String] key query parameter
     # @param [Object] value query value
@@ -25,64 +96,76 @@ module NotionRubyMapping
       end
     end
 
+    # @return [TrueClass, FalseClass] true if page property
+    def page?
+      @base_type == :page
+    end
+
+    # @param [Hash] json
+    def update_from_json(json)
+      @will_update = false
+      @json = json[type]
+    end
+
     # @return [Symbol] property type
     def type
       self.class::TYPE
     end
 
-    # @param [String] name
-    # @param [Hash] input_json
-    # @return [NotionRubyMapping::Property, nil] generated Property object
-    def self.create_from_json(name, input_json)
-      raise StandardError, "Property not found: #{name}:#{input_json}" if input_json.nil?
+    ## Database property only methods
+
+    # @param [Symbol, nil] method
+    def assert_database_property(method)
+      raise StandardError, "#{method} can execute only Database property." unless database?
+    end
+
+    # @return [Hash]
+    def property_schema_json
+      assert_database_property __method__
+      {@name => {type => property_schema_json_sub}}
+    end
 
-      case input_json["type"]
-      when "number"
-        NumberProperty.new name, number: input_json["number"]
-      when "select"
-        SelectProperty.new name, json: input_json["select"]
-      when "multi_select"
-        MultiSelectProperty.new name, json: input_json["multi_select"]
-      when "date"
-        DateProperty.new name, json: input_json["date"]
-      when "title"
-        TitleProperty.new name, json: input_json["title"]
-      when "rich_text"
-        RichTextProperty.new name, json: input_json["rich_text"]
-      when "checkbox"
-        CheckboxProperty.new name, checkbox: input_json["checkbox"]
-      when "people"
-        PeopleProperty.new name, json: input_json["people"]
-      when "email"
-        EmailProperty.new name, email: input_json["email"]
-      when "url"
-        UrlProperty.new name, url: input_json["url"]
-      when "phone_number"
-        PhoneNumberProperty.new name, phone_number: input_json["phone_number"]
-      when "files"
-        FilesProperty.new name, json: input_json["files"]
-      when "created_time"
-        CreatedTimeProperty.new name, created_time: input_json["created_time"]
-      when "last_edited_time"
-        LastEditedTimeProperty.new name, last_edited_time: input_json["last_edited_time"]
-      when "created_by"
-        CreatedByProperty.new name, json: input_json["created_by"]
-      when "last_edited_by"
-        LastEditedByProperty.new name, json: input_json["last_edited_by"]
-      when "formula"
-        FormulaProperty.new name, json: input_json["formula"]
-      when "rollup"
-        RollupProperty.new name, json: input_json["rollup"]
-      when "relation"
-        RelationProperty.new name, json: input_json["relation"]
+    # @return [Hash]
+    def update_property_schema_json
+      assert_database_property __method__
+      if @remove
+        {@name => nil}
+      elsif @new_name
+        {@name => {"name" => @new_name}}
       else
-        raise StandardError, "Irregular property type: #{input_json["type"]}"
+        {}
       end
     end
+
+    ## Page property only methods
+
+    # @param [Symbol, nil] method
+    def assert_page_property(method)
+      raise StandardError, "#{method} can execute only Page property." unless @base_type == :page
+    end
+
+    ## Page property only methods
+
+    # @return [Hash] {} created_time cannot be updated
+    def property_values_json
+      assert_page_property __method__
+      {}
+    end
+
+    protected
+
+    ## Database property only methods
+
+    # @return [Hash]
+    def property_schema_json_sub
+      {}
+    end
   end
 
   # module for make query of equals and does_not_equal
   module EqualsDoesNotEqual
+    ### Public announced methods
+
     # @param [String, Number] value Query value
     # @return [NotionRubyMapping::Query] generated Query object
     def filter_equals(value, rollup = nil, rollup_type = nil)
@@ -98,6 +181,8 @@ module NotionRubyMapping
 
   # module for make query of contains and does_not_contain
   module ContainsDoesNotContain
+    ### Public announced methods
+
     # @param [String] value Query value
     # @return [NotionRubyMapping::Query] generated Query object
     def filter_contains(value, rollup = nil, rollup_type = nil)
@@ -113,6 +198,8 @@ module NotionRubyMapping
 
   # module for make query of starts_with and ends_with
   module StartsWithEndsWith
+    ### Public announced methods
+
     # @param [String] value Query value
     # @return [NotionRubyMapping::Query] generated Query object
     def filter_starts_with(value, rollup = nil, rollup_type = nil)
@@ -128,6 +215,8 @@ module NotionRubyMapping
 
   # module for make query of is_empty and is_not_empty
   module IsEmptyIsNotEmpty
+    ### Public announced methods
+
     # @return [NotionRubyMapping::Query] generated Query object
     def filter_is_empty(rollup = nil, rollup_type = nil)
       make_filter_query "is_empty", true, rollup, rollup_type
@@ -141,6 +230,8 @@ module NotionRubyMapping
 
   # module for make query of starts_with and ends_with
   module GreaterThanLessThan
+    ### Public announced methods
+
     # @param [Number] value Query value
     # @return [NotionRubyMapping::Query] generated Query object
     def filter_greater_than(value, rollup = nil, rollup_type = nil)

data/lib/notion_ruby_mapping/property_cache.rb

@@ -4,16 +4,17 @@ module NotionRubyMapping
   # PropertyCache class
   class PropertyCache
     include Enumerable
-    def initialize(json = {})
+    def initialize(json = {}, base_type: :page)
       @properties = {}
       @json = json
+      @base_type = base_type
     end
     attr_writer :json
 
     # @param [String] key
     # @return [Property] Property for key
     def [](key)
-      @properties[key] ||= Property.create_from_json key, @json[key]
+      @properties[key] ||= Property.create_from_json key, @json[key], @base_type
     end
 
     # @param [Array] key
@@ -44,7 +45,14 @@ module NotionRubyMapping
       self
     end
 
-    # @return [Hash] created json
+
+    def clear_will_update
+      @properties.each do |_, property|
+        property.clear_will_update
+      end
+    end
+
+    # @return [Hash] created property values json
     def property_values_json
       @properties.each_with_object({}) do |(_, property), ans|
         if property.will_update
@@ -53,5 +61,25 @@ module NotionRubyMapping
         end
       end
     end
+
+    # @return [Hash] created property schema json
+    def property_schema_json
+      @properties.each_with_object({}) do |(_, property), ans|
+        if property.will_update
+          ans["properties"] ||= {}
+          ans["properties"].merge! property.property_schema_json
+        end
+      end
+    end
+
+    # @return [Hash] created update property schema json
+    def update_property_schema_json
+      @properties.each_with_object({}) do |(_, property), ans|
+        if property.will_update
+          ans["properties"] ||= {}
+          ans["properties"].merge! property.update_property_schema_json
+        end
+      end
+    end
   end
 end

data/lib/notion_ruby_mapping/query.rb

@@ -49,5 +49,15 @@ module NotionRubyMapping
       @sort << {key => property.name, "direction" => "descending"}
       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
+    end
   end
 end