notion_ruby_mapping 0.1.0

data/lib/notion_ruby_mapping/base.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion Base object (Parent of Page / Database / List)
+  class Base
+    def initialize(json: nil, id: nil)
+      @nc = NotionCache.instance
+      @json = json
+      @id = @nc.hex_id(id || @json["id"])
+    end
+    attr_reader :json, :id
+
+    # @param [Object] json
+    # @return [NotionRubyMapping::Block, NotionRubyMapping::List, NotionRubyMapping::Database, NotionRubyMapping::Page]
+    def self.create_from_json(json)
+      case json["object"]
+      when "page"
+        Page.new json: json
+      when "database"
+        Database.new json: json
+      when "list"
+        List.new json: json
+      when "block"
+        Block.new json: json
+      else
+        throw Notion::Api::Errors::ObjectNotFound
+      end
+    end
+
+    # @return [NotionRubyMapping::List]
+    def children
+      @children ||= @nc.block_children(id)
+    end
+
+    def update_json(json)
+      if @json.nil? || @json["type"] == json["type"]
+        @json = json
+        clear_object
+      end
+    end
+
+    def clear_object
+    end
+
+    def icon
+      @json["icon"]
+    end
+  end
+end

data/lib/notion_ruby_mapping/block.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class Block < Base
+    def self.find(key)
+      NotionCache.instance.block key
+    end
+  end
+end

data/lib/notion_ruby_mapping/checkbox_property.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Checkbox property
+  class CheckboxProperty < Property
+    include EqualsDoesNotEqual
+    TYPE = :checkbox
+  end
+end

data/lib/notion_ruby_mapping/created_by_property.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  class CreatedByProperty < MultiProperty
+    TYPE = :created_by
+  end
+end

data/lib/notion_ruby_mapping/created_time_property.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  class CreatedTimeProperty < DateBaseProperty
+    TYPE = :created_time
+  end
+end

data/lib/notion_ruby_mapping/database.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion database
+  class Database < Base
+    def self.find(key)
+      NotionCache.instance.database key
+    end
+
+    def self.query(id, query = nil)
+      query ||= Query.new
+      NotionCache.instance.database_query(id, query)
+    end
+  end
+end

data/lib/notion_ruby_mapping/date_base_property.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "date"
+
+module NotionRubyMapping
+  # Date base property (date, created_time, last_edited_time)
+  class DateBaseProperty < Property
+    include IsEmptyIsNotEmpty
+
+    # @param [Date, Time, DateTime, String] obj
+    # @return [String] iso8601 format string
+    def value_str(obj)
+      case obj
+      when Date
+        obj.iso8601
+      when Time
+        obj.strftime("%Y-%m-%dT%H:%M:%S%:z")
+      when DateTime
+        obj.iso8601
+      else
+        obj
+      end
+    end
+
+    def filter_equals(value)
+      make_filter_query :equals, value_str(value)
+    end
+
+    def filter_does_not_equal(value)
+      make_filter_query :does_not_equal, value_str(value)
+    end
+
+    def filter_before(value)
+      make_filter_query :before, value_str(value)
+    end
+
+    def filter_after(value)
+      make_filter_query :after, value_str(value)
+    end
+
+    def filter_on_or_before(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)
+    end
+
+    def filter_past_week
+      make_filter_query :past_week, {}
+    end
+
+    def filter_past_month
+      make_filter_query :past_month, {}
+    end
+
+    def filter_past_year
+      make_filter_query :past_year, {}
+    end
+
+    def filter_next_week
+      make_filter_query :next_week, {}
+    end
+
+    def filter_next_month
+      make_filter_query :next_month, {}
+    end
+
+    def filter_next_year
+      make_filter_query :next_year, {}
+    end
+  end
+end

data/lib/notion_ruby_mapping/date_property.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  class DateProperty < DateBaseProperty
+    TYPE = :date
+  end
+end

data/lib/notion_ruby_mapping/email_property.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  class EmailProperty < TextProperty
+    TYPE = :email
+  end
+end

data/lib/notion_ruby_mapping/files_property.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Select property
+  class FilesProperty < Property
+    include IsEmptyIsNotEmpty
+    TYPE = :files
+  end
+end

data/lib/notion_ruby_mapping/formula_property.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Formula property
+  class FormulaProperty < DateBaseProperty
+    include ContainsDoesNotContain
+    include StartsWithEndsWith
+    include GreaterThanLessThan
+    TYPE = :formula
+  end
+end

data/lib/notion_ruby_mapping/last_edited_by_property.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  class LastEditedByProperty < MultiProperty
+    TYPE = :last_edited_by
+  end
+end

data/lib/notion_ruby_mapping/last_edited_time_property.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  class LastEditedTimeProperty < DateBaseProperty
+    TYPE = :last_edited_time
+  end
+end

data/lib/notion_ruby_mapping/list.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion List object
+  class List < Base
+    include Enumerable
+
+    def each
+      return enum_for(:each) unless block_given?
+
+      json["results"].each do |block_json|
+        yield Base.create_from_json(block_json)
+      end
+    end
+  end
+end

data/lib/notion_ruby_mapping/multi_property.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # MultiSelect property
+  class MultiProperty < Property
+    include ContainsDoesNotContain
+    include IsEmptyIsNotEmpty
+  end
+end

data/lib/notion_ruby_mapping/multi_select_property.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # MultiSelect property
+  class MultiSelectProperty < MultiProperty
+    TYPE = :multi_select
+  end
+end

data/lib/notion_ruby_mapping/notion_cache.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "singleton"
+require "notion"
+
+module NotionRubyMapping
+  # singleton class of caching Notion objects
+  class NotionCache
+    include Singleton
+
+    def initialize
+      @object_hash = {}
+      @client = nil
+      @wait = 0
+    end
+    attr_reader :object_hash, :client
+    attr_accessor :use_cache
+
+    # @param [String] notion_token
+    # @return [NotionRubyMapping::NotionCache] self (NotionCache.instance)
+    def create_client(notion_token, wait = 0.3333)
+      @client ||= Notion::Client.new token: notion_token
+      @wait = wait
+      self
+    end
+
+    # @param [String] id id string with "-"
+    # @return [String] id without "-"
+    def hex_id(id)
+      id&.gsub "-", ""
+    end
+
+    # @param [String] id id (with or without "-")
+    # @return [NotionRubyMapping::Block, NotionRubyMapping::List, NotionRubyMapping::Database, NotionRubyMapping::Page, nil]
+    def object_for_key(id)
+      key = hex_id(id)
+      return @object_hash[key] if @object_hash.key? key
+
+      begin
+        json = yield(@client)
+        p json
+        @object_hash[key] = Base.create_from_json json
+      rescue StandardError
+        nil
+      end
+    end
+
+    # @param [String] id
+    # @return [NotionRubyMapping::Page, nil] Page object or nil
+    def page(id)
+      object_for_key(id) do
+        sleep @wait
+        @client.page page_id: id
+      end
+    end
+
+    # @param [String] id
+    # @return [NotionRubyMapping::Database, nil] Database object or nil
+    def database(id)
+      object_for_key(id) do
+        sleep @wait
+        @client.database database_id: id
+      end
+    end
+
+    # @param [String] id
+    # @return [NotionRubyMapping::Block, nil]
+    def block(id)
+      object_for_key(id) do
+        sleep @wait
+        @client.block block_id: id
+      end
+    end
+
+    def block_children(id)
+      array = []
+      sleep @wait
+      @client.block_children(block_id: id, sleep_interval: @wait, max_retries: 20) do |page|
+        array.concat page.results
+      end
+      Base.create_from_json({"object" => "list", "results" => array})
+    end
+
+    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|
+        array.concat page.results
+      end
+      Base.create_from_json({"object" => "list", "results" => array})
+    end
+
+    def update_page(id, payload)
+      sleep @wait
+      @client.update_page payload.merge({page_id: id})
+    end
+  end
+end

data/lib/notion_ruby_mapping/number_property.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Number property
+  class NumberProperty < Property
+    include EqualsDoesNotEqual
+    include GreaterThanLessThan
+    include IsEmptyIsNotEmpty
+    TYPE = :number
+  end
+end

data/lib/notion_ruby_mapping/page.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion page object
+  class Page < Base
+    def self.find(key)
+      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
+    end
+  end
+end

data/lib/notion_ruby_mapping/people_property.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  class PeopleProperty < MultiProperty
+    TYPE = :people
+  end
+end

data/lib/notion_ruby_mapping/phone_number_property.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  class PhoneNumberProperty < TextProperty
+    TYPE = :phone_number
+  end
+end

data/lib/notion_ruby_mapping/property.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # abstract class for property
+  class Property
+    def initialize(name)
+      @name = name
+    end
+    attr_reader :name
+
+    # @param [Symbol] 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}})
+    end
+
+    # @return [Symbol] property type
+    def type
+      self.class::TYPE
+    end
+  end
+
+  # module for make query of equals and does_not_equal
+  module EqualsDoesNotEqual
+    # @param [String, Number] value
+    # @return [Object]
+    def filter_equals(value)
+      make_filter_query :equals, value
+    end
+
+    def filter_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
+    def filter_contains(value)
+      make_filter_query :contains, value
+    end
+
+    def filter_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
+    def filter_starts_with(value)
+      make_filter_query :starts_with, value
+    end
+
+    def filter_ends_with(value)
+      make_filter_query :ends_with, value
+    end
+  end
+
+  # module for make query of is_empty and is_not_empty
+  module IsEmptyIsNotEmpty
+    def filter_is_empty
+      make_filter_query :is_empty, true
+    end
+
+    def filter_is_not_empty
+      make_filter_query :is_not_empty, true
+    end
+  end
+
+  # module for make query of starts_with and ends_with
+  module GreaterThanLessThan
+    def filter_greater_than(value)
+      make_filter_query :greater_than, value
+    end
+
+    def filter_less_than(value)
+      make_filter_query :less_than, value
+    end
+
+    def filter_greater_than_or_equal_to(value)
+      make_filter_query :greater_than_or_equal_to, value
+    end
+
+    def filter_less_than_or_equal_to(value)
+      make_filter_query :less_than_or_equal_to, value
+    end
+  end
+end

data/lib/notion_ruby_mapping/query.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Query object
+  class Query
+    def initialize(filter: {}, sort: [])
+      @filter = filter
+      @sort = sort
+    end
+    attr_reader :filter, :sort
+
+    # @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
+      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]}
+      end
+      self
+    end
+
+    # @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"}
+      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"}
+      self
+    end
+  end
+end

data/lib/notion_ruby_mapping/relation_property.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # MultiSelect property
+  class RelationProperty < MultiProperty
+    TYPE = :relation
+  end
+end

data/lib/notion_ruby_mapping/rich_text_property.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  class RichTextProperty < TextProperty
+    TYPE = :rich_text
+  end
+end

data/lib/notion_ruby_mapping/select_property.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Select property
+  class SelectProperty < Property
+    include EqualsDoesNotEqual
+    include IsEmptyIsNotEmpty
+    TYPE = :select
+  end
+end

data/lib/notion_ruby_mapping/text_property.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Text property
+  class TextProperty < Property
+    include EqualsDoesNotEqual
+    include ContainsDoesNotContain
+    include StartsWithEndsWith
+    include IsEmptyIsNotEmpty
+  end
+end

data/lib/notion_ruby_mapping/title_property.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  class TitleProperty < TextProperty
+    TYPE = :title
+  end
+end

data/lib/notion_ruby_mapping/url_property.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  class UrlProperty < TextProperty
+    TYPE = :url
+  end
+end

data/lib/notion_ruby_mapping/version.rb

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

data/lib/notion_ruby_mapping.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+%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|
+  require_relative "notion_ruby_mapping/#{k}"
+end