notion_ruby_mapping

Notion Ruby mapping is currently under development.

Development note is here. → Idea note of "notion_ruby_mapping"

notion_ruby_mapping

0. Changes

0.1 Changes in v0.6.0

NotionRubyMapping v0.6.0 now supports Notion-Version 2022-06-28. In 2022-06-28, property values are no longer returned when retrieving pages. NotionRubyMapping temporarily creates a Property Object and calls the retrieve a property item API when a value is needed. Therefore, users do not need to be aware of any differences, and existing scripts should work as they are.

0.2 Changes in v0.5.0

NotionRubyMapping v0.5.0 now supports block updates. For efficiency, subclasses are provided under Block class. As a result, they are no longer compatible with the scripts used in v0.4.0.

1. Installation

Add this line to your application's Gemfile:

gem 'notion_ruby_mapping'

And then execute:

bundle install

Or install it yourself as:

gem install notion_ruby_mapping

2. How to use

2.1 Create a New Integration

Please check Notion documentation.

2.2 Create client

Please create a client (notion-ruby-client) before you use the following class.

NotionCache.instance.create_client "secret_XXXXXXXXXXXXXXXXXXXX" # write directly
NotionCache.instance.create_client ENV["NOTION_API_TOKEN"] # from environment

2.3 Sample codes

2.4. Another example code (Use case)

2.5 API reference

Notion Ruby Mapping Public API reference

3. ChangeLog

2022/7/22 [v0.6.0] updates for Notion-Version 2022-06-28 (lazy retrieve property values, retrieve page/database/block parent, single_property/dual_property for RelationProperty)
2022/6/24 [v0.5.5] add file_names= to FileProperty
2022/6/23 [v0.5.4] add update 'is_inline' and 'description' for database object
2022/6/14 [v0.5.3] add time zone for query database by Date (before, after, on_or_before, on_or_after)
2022/6/8 [v0.5.2] Change query database filter for date with time zone
2022/6/5 [v0.5.1] bug fix for append_block_children. added synced_block_original to SyncedBlock
2022/6/4 [v0.5.0] added subclasses of the block class and update_block API support
2022/5/19 [v0.4.1] added delete_block
2022/4/29 [v0.4.0] Change directory structure, TEST_IDs are moved from env.yml to TestConnection's constants, added retrieve_block spec, added append_block_children
2022/4/27 added Base#children
2022/3/27 [v0.3.3] create_child_page can receive a block for initialization.
2022/3/27 [v0.3.2] properties of a created child page are automatically assigned using the parent database.
2022/3/25 [v0.3.0] added create_child_database, update_database, add_property, rename_property and remove_property
2022/3/17 [v0.2.3] added template_mention objects, tools/an command
2022/3/16 [v0.2.2] added database.create_child_page and base.save instead of base.update/create
2022/3/15 Fixed not to reload from API when all contents are loaded
2022/3/14 [v0.2.0] Exclude notion-ruby-client, update Property values, update for Notion-Version 2022-02-22
2022/2/25 add_property_for_update -> assign_property, update README.md
2022/2/20 add support for MultiSelectProperty
2022/2/19 add support for SelectProperty
2022/2/17 added Page#properties, Page#add_property_for_update, Page#update
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

4. Contributing

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.

5. License

The gem is available as open source under the terms of the MIT License.

6. Code of Conduct

Everyone interacting in the NotionRubyMapping project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.