notion_ruby_mapping 0.6.8 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1372e3b57aef4a44d060751e07ba15bd224d23b974ff46426ac4e40a10c0b0b6
-  data.tar.gz: b6310155b12dcb73f022bd9415667c67b8a78246377622128fb0bcd2eccb4bd9
+  metadata.gz: 378e8aecdacdabc3fd951939783195ed13f2e56665a202a8fe3cf9a2d66e0fab
+  data.tar.gz: d92c738818763b3d4d49d06e1f7c326ec2fc60e5214162a8185c4f7a8c3f501a
 SHA512:
-  metadata.gz: 01a32f40c022b5916891409b823bf76efd02414520e14eb98dc1f7ec49901fcc60fd085c845fe71f0b38a5d3776e32a6c9bce4e5c2efb5edce750f2b24a66ff8
-  data.tar.gz: 06babf96d0c07ccc74c2ab24ccf55500ed8c75506c2e5c0c95837968795af8192eea3e773ca153254048a63204ed6fed4996a1a25f74ced78187d52114c4ca4a
+  metadata.gz: 0dd2673402bbe54ccd135331c3476f4009af7c68411895f2244288eae761c8975e5bb7e9e39d14ba5d2fc58b96cb38c8dd4f401de2a422d0ebfaeff4c29277ed
+  data.tar.gz: 331fadb7063f5d72c049a7f84907174b3470be179340539796772e31a3ff61dd10222d1638d26688c67fe8470501235c3025c2ebda46ba8942e404cc256aad91

data/README.md

@@ -1,97 +1,131 @@
 # notion_ruby_mapping
 
-Notion Ruby mapping is currently under development.
+Notion Ruby Mapping is a library that makes it easy to access data on Notion using Ruby.  It is currently under development.
 
-Development note is here. → [Idea note of "notion_ruby_mapping"](https://www.notion.so/hkob/Idea-note-of-notion_ruby_mapping-3b0a3bb3c171438a830f9579d41df501)
+Notion Ruby Mapping は Ruby で Notion 上のデータを簡単にアクセスできるようにするライブラリです。現在開発中です。
+
+Development note is here.
+
+開発ノートは以下の URL にあります。
+
+→ [Idea note of "notion_ruby_mapping"](https://www.notion.so/hkob/Idea-note-of-notion_ruby_mapping-3b0a3bb3c171438a830f9579d41df501)
 
 ## Table of Contents
 
-- [notion_ruby_mapping](#notion_ruby_mapping)
+- [notion\_ruby\_mapping](#notion_ruby_mapping)
   - [Table of Contents](#table-of-contents)
-  - [0. Changes](#0-changes)
-    - [0.1 Changes in v0.6.0](#01-changes-in-v060)
-    - [0.2 Changes in v0.5.0](#02-changes-in-v050)
-  - [1. Installation](#1-installation)
-  - [2. How to use](#2-how-to-use)
-    - [2.1 Create a New Integration](#21-create-a-new-integration)
-    - [2.2 Create client](#22-create-client)
-    - [2.3 Sample codes](#23-sample-codes)
-    - [2.4. Another example code (Use case)](#24-another-example-code-use-case)
-    - [2.5 API reference](#25-api-reference)
+  - [0. History of Major Changes / 主な変更履歴](#0-history-of-major-changes--主な変更履歴)
+    - [0.1 Changes in v0.7.0](#01-changes-in-v070)
+    - [0.2 Changes in v0.6.0](#02-changes-in-v060)
+    - [0.3 Changes in v0.5.0](#03-changes-in-v050)
+  - [1. Installation / インストール方法](#1-installation--インストール方法)
+  - [2. How to use / 利用方法](#2-how-to-use--利用方法)
+    - [2.1 Create a New Integration / インテグレーションの作成](#21-create-a-new-integration--インテグレーションの作成)
+    - [2.2 Set your integration token / インテグレーショントークンの設定](#22-set-your-integration-token--インテグレーショントークンの設定)
+    - [2.3 Sample codes / サンプルコード](#23-sample-codes--サンプルコード)
+    - [2.4. Another example code (Use case) / その他の使用例 (ユースケース)](#24-another-example-code-use-case--その他の使用例-ユースケース)
+    - [2.5 API reference / API リファレンス](#25-api-reference--api-リファレンス)
   - [3. ChangeLog](#3-changelog)
-  - [4. Contributing](#4-contributing)
-  - [5. License](#5-license)
-  - [6. Code of Conduct](#6-code-of-conduct)
+  - [4. Contributing / 貢献](#4-contributing--貢献)
+  - [5. License / ライセンス](#5-license--ライセンス)
+  - [6. Code of Conduct / 行動規範](#6-code-of-conduct--行動規範)
+
+## 0. History of Major Changes / 主な変更履歴
+
+### 0.1 Changes in v0.7.0
 
-## 0. Changes
+Since the number of Japanese users has increased, we decided to include Japanese as well.  In addition, we have simplified the method of setting up integration tokens.
 
-### 0.1 Changes in v0.6.0
+日本のユーザが増えたので、日本語も併記することにしました。また、インテグレーショントークンの設定方法を簡単にしました。
+
+### 0.2 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.
+~~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.~~
+
+NotionRubyMapping v0.6.0 は、Notion-Version 2022-06-28 に対応しました。
+~~ 2022-06-28 では、ページを取得する際にプロパティ値を返さなくなりました。NotionRubyMapping は、一時的に Property Object を作成し、値が必要なときにプロパティ項目を取得する API を呼び出します。そのため、ユーザーはこの違いを意識する必要はなく、既存のスクリプトはそのまま動作するはずです。~~
 
-### 0.2 Changes in v0.5.0
+### 0.3 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
+NotionRubyMapping v0.5.0 では、ブロック更新をサポートするようになりました。
+効率化のため、Blockクラスの下にサブクラスが提供されています。そのため、v0.4.0で使用していたスクリプトとは互換性がなくなりました。
+
+## 1. Installation / インストール方法
 
 Add this line to your application's Gemfile:
 
+アプリケーションのGemfileに次の行を追加します。:
+
 ```ruby
 gem 'notion_ruby_mapping'
 ```
 
 And then execute:
 
+そして以下を実行してください:
+
 ```shell
 bundle install
 ```
 
 Or install it yourself as:
 
+または、自分でインストールすることもできます。:
+
 ```shell
 gem install notion_ruby_mapping
 ```
 
-## 2. How to use
+## 2. How to use / 利用方法
 
-### 2.1 Create a New Integration
+### 2.1 Create a New Integration / インテグレーションの作成
 
 Please check [Notion documentation](https://developers.notion.com/docs#getting-started).
 
-### 2.2 Create client
+[Notion documentation](https://developers.notion.com/docs#getting-started) を読んでください。
+
+### 2.2 Set your integration token / インテグレーショントークンの設定
+
+From v0.7.0, it can be set with `NotionRubymapping.configuration`.
 
-Please create a client (notion-ruby-client) before you use the following class.
+v0.7.0 から `NotionRubyMapping.configuration` で設定できるようになりました。
+
+```ruby
+NotionRubyMapping.configuration do |config|
+    config.notion_token = "secret_XXXXXXXXXXXXXXXXXXXX" # write directly
+    config.wait = 0
+end
+```
 
-```Ruby
-NotionCache.instance.create_client "secret_XXXXXXXXXXXXXXXXXXXX" # write directly
-NotionCache.instance.create_client ENV["NOTION_API_TOKEN"] # from environment
+```ruby
+NotionRubyMapping.configuration { |c| c.notion_token = ENV["NOTION_API_TOKEN"] } # from environment
 ```
 
-### 2.3 Sample codes
+### 2.3 Sample codes / サンプルコード
 
-1. [Database and page access sample](https://www.notion.so/hkob/Database-and-page-access-sample-d30033e707194faf995741167eb2b6f8)
-2. [Append block children sample](https://www.notion.so/hkob/Append-block-children-sample-3867910a437340be931cf7f2c06443c6)
-3. [Update block sample](https://www.notion.so/hkob/update-block-sample-5568c1c36fe84f12b83edfe2dda83028)
+1. [Database and page access sample / データベースとページのアクセスサンプル](https://www.notion.so/hkob/Database-and-page-access-sample-d30033e707194faf995741167eb2b6f8)
+2. [Append block children sample / 子ブロック要素の追加サンプル](https://www.notion.so/hkob/Append-block-children-sample-3867910a437340be931cf7f2c06443c6)
+3. [Update block sample / ブロック要素の更新サンプル](https://www.notion.so/hkob/update-block-sample-5568c1c36fe84f12b83edfe2dda83028)
 
-### 2.4. Another example code (Use case)
+### 2.4. Another example code (Use case) / その他の使用例 (ユースケース)
 
-1. [Set icon to all icon unsettled pages](examples/set_icon_to_all_icon_unsettled_pages.md)
-2. [Renumbering pages](examples/renumbering_pages.md)
-3. [Change title](examples/change_title.md)
-4. [Create ER Diagram from Notion database](https://www.notion.so/hkob/notionErDiagram-Sample-1720c2199c534ca08138cde38f31f710)
-5. [Create Sitemap from Notion pages](https://www.notion.so/hkob/NotionSitemap-sample-14e195c83d024c5382aab09210916c87)
+1. [Set icon to all icon unsettled pages / 全てのページのアイコンを同一に設定](examples/set_icon_to_all_icon_unsettled_pages.md)
+2. [Renumbering pages / ページのナンバリング](examples/renumbering_pages.md)
+3. [Change title / タイトルの変更](examples/change_title.md)
+4. [Create ER Diagram from Notion database / Notion データベースの ER 図を作成](https://www.notion.so/hkob/notionErDiagram-Sample-1720c2199c534ca08138cde38f31f710)
+5. [Create Sitemap from Notion pages / Notion page からサイトマップを作成](https://www.notion.so/hkob/NotionSitemap-sample-14e195c83d024c5382aab09210916c87)
 
-### 2.5 API reference
+### 2.5 API reference / API リファレンス
 
 1. [Notion Ruby Mapping Public API reference](https://www.notion.so/hkob/Notion-Ruby-Mapping-Public-API-reference-4091aca15b664299b63e6253b7601fec)
 
 ## 3. ChangeLog
 
+- 2022/11/28 [v0.7.0] add this_week filter and NotionRubyMapping.configure
 - 2022/11/13 [v0.6.8] remove error checking for start and end dates, add Users.all, and change Rollup and Formula query specification
 - 2022/9/2 [v0.6.7] add support for Status property, is_toggleable for headings block, and page property values
 - 2022/8/10 [v0.6.6] Bug fix(notionSitemap.rb): Skip if child page is empty.
@@ -127,14 +161,20 @@ NotionCache.instance.create_client ENV["NOTION_API_TOKEN"] # from environment
 - 2022/2/13 added Page#set_icon
 - 2022/2/13 First commit
 
-## 4. Contributing
+## 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](https://github.com/hkob/notion_ruby_mapping/blob/main/CODE_OF_CONDUCT.md).
 
-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](https://github.com/[USERNAME]/notion_ruby_mapping/blob/main/CODE_OF_CONDUCT.md).
+バグレポートとプルリクエストは、<https://github.com/hkob/notion_ruby_mapping>のGithubで大歓迎です。このプロジェクトは、コラボレーションのための安全で居心地の良いスペースであることを目的としており、貢献者は[行動規範](https://github.com/hkob/notion_ruby_mapping/blob/main/code_of_conduct.md)を遵守することが期待されています。
 
-## 5. License
+## 5. License / ライセンス
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## 6. Code of Conduct
+GEMは、[MITライセンス](https://opensource.org/licenses/mit)の条件の下でオープンソースとして入手できます。
+
+## 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](https://github.com/hkob/notion_ruby_mapping/blob/main/CODE_OF_CONDUCT.md).
 
-Everyone interacting in the NotionRubyMapping project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/notion_ruby_mapping/blob/main/CODE_OF_CONDUCT.md).
+NotionRubyMappingプロジェクトのコードベース、問題トラッカー、チャットルーム、メーリングリストで対話する全員が[行動規範](https://github.com/hkob/notion_ruby_mapping/blob/main/code_of_conduct.md)に従うことが期待されています。

data/lib/notion_ruby_mapping/controllers/notion_cache.rb

@@ -20,11 +20,12 @@ module NotionRubyMapping
         builder.adapter Faraday.default_adapter
       end
       @notion_token = nil
-      @wait = 0
+      @wait = 0.3333
       @debug = false
     end
     attr_reader :object_hash
     attr_writer :client # for test only
+    attr_accessor :notion_token, :wait, :debug
 
     # @param [String] block_id
     # @return [String (frozen)] block_path
@@ -239,7 +240,7 @@ module NotionRubyMapping
     # @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
+      raise "Please call `NotionRubyMapping.configure' before using other methods" unless @notion_token
 
       sleep @wait
       response = @client.send(method) do |request|

data/lib/notion_ruby_mapping/properties/date_base_property.rb

@@ -137,6 +137,14 @@ module NotionRubyMapping
       make_filter_query "past_year", {}, condition: condition, another_type: another_type
     end
 
+    # @param [String] condition Rollup name
+    # @param [String] another_type Rollup type
+    # @return [NotionRubyMapping::Query] generated Query object
+    # @see
+    def filter_this_week(condition: nil, another_type: nil)
+      make_filter_query "this_week", {}, condition: condition, another_type: another_type
+    end
+
     # @param [String] condition Rollup name
     # @param [String] another_type Rollup type
     # @return [NotionRubyMapping::Query] generated Query object

data/lib/notion_ruby_mapping/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module NotionRubyMapping
-  VERSION = "0.6.8"
+  VERSION = "0.7.0"
   NOTION_VERSION = "2022-06-28"
 end

data/lib/notion_ruby_mapping.rb

@@ -25,3 +25,11 @@ require_relative "notion_ruby_mapping/version"
     require_relative "notion_ruby_mapping/#{key}/#{klass}"
   end
 end
+
+module NotionRubyMapping
+  def configure
+    yield NotionRubyMapping::NotionCache.instance
+  end
+  module_function :configure
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notion_ruby_mapping
 version: !ruby/object:Gem::Version
-  version: 0.6.8
+  version: 0.7.0
 platform: ruby
 authors:
 - Hiroyuki KOBAYASHI
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-12 00:00:00.000000000 Z
+date: 2022-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday