notionrb 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '09efbfad64cfa84174611740e68c801b0e5737b5ed5187b35cf9a6a01c2f0491'
+  data.tar.gz: 024443e093523b3162d157be7221fb9fb2ed510d7d1168d2c5c3c3abba983d99
+SHA512:
+  metadata.gz: 65f13a6b761a0ef4f865da6b62c9132446fdb8d49709d1f11cd1114840148945c319738031ccf9c6527a4ff7da527813238ff9f70514f217a66bc30ea32a61e6
+  data.tar.gz: 1f16e90f654bb20e41252bd26f1a80407c02ae69050d5775c5e94c929078eb0c231aa24d006b9bcaf392936e2b55a0304aa8b4c2e44bce02ff658bec66e4e778

data/.devcontainer/Dockerfile

@@ -0,0 +1,5 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.191.1/containers/ruby/.devcontainer/base.Dockerfile
+
+# [Choice] Ruby version: 3, 3.0, 2, 2.7, 2.6
+ARG VARIANT="3.0"
+FROM mcr.microsoft.com/vscode/devcontainers/ruby:0-${VARIANT}

data/.devcontainer/boot.sh

@@ -0,0 +1 @@
+bundle install

data/.devcontainer/devcontainer.json

@@ -0,0 +1,30 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.191.1/containers/ruby
+{
+	"name": "Ruby",
+	"build": {
+		"dockerfile": "Dockerfile",
+		"context": "..",
+		"args": {
+			// Update 'VARIANT' to pick a Ruby version: 3, 3.0, 2, 2.7, 2.6
+			"VARIANT": "2.7",
+		}
+	},
+
+	// Set *default* container specific settings.json values on container create.
+	"settings": {},
+
+	// Add the IDs of extensions you want installed when the container is created.
+	"extensions": [
+		"rebornix.Ruby"
+	],
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": ".devcontainer/boot.sh",
+
+	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "vscode"
+}

data/.github/workflows/ci.yml

@@ -0,0 +1,15 @@
+on: [push, pull_request]
+name: Continuous Integration
+jobs:
+  test:
+    strategy:
+      matrix:
+        ruby: [2.6, 2.7, '3.0', 3.1, 3.2]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby }}
+      - run: bundle exec rake spec

data/.github/workflows/rubocop.yml

@@ -0,0 +1,17 @@
+name: RuboCop
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+        bundler-cache: true # 'bundle install' and cache
+    - name: Run RuboCop
+      run: bundle exec rake rubocop

data/.gitignore

@@ -0,0 +1,7 @@
+.env
+pkg
+Gemfile.lock
+.DS_Store
+.bundle
+.idea
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,55 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  DisplayCopNames: true
+  Exclude:
+    - bin/**/*
+    - vendor/**/*
+    - lib/notion/web/api/notion-api-ref/**/*
+    - lib/notion/web/api/endpoints/* # Auto-generated
+    - lib/notion/web/api/errors.rb # Auto-generated
+    - spec/notion/web/api/endpoints/* # Auto-generated
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 250
+
+Layout/LineLength:
+  Max: 128
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 5
+
+Style/Documentation:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - lib/notion-ruby-client.rb # Required to match gemspec name

data/.rubocop_todo.yml

@@ -0,0 +1,86 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2021-04-25 19:55:01 +0200 using RuboCop version 0.82.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Layout/EmptyLines:
+  Exclude:
+    - 'scratchpad.rb'
+    - 'spec/spec_helper.rb'
+
+# Offense count: 5
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: native, lf, crlf
+Layout/EndOfLine:
+  Exclude:
+    - 'Rakefile'
+    - 'spec/notion/config_spec.rb'
+    - 'spec/notion/version_spec.rb'
+    - 'spec/spec_helper.rb'
+    - 'spec/support/token.rb'
+
+# Offense count: 26
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: final_newline, final_blank_line
+Layout/TrailingEmptyLines:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Lint/NonDeterministicRequireOrder:
+  Exclude:
+    - 'spec/spec_helper.rb'
+
+# Offense count: 1
+Lint/UselessAssignment:
+  Exclude:
+    - 'scratchpad.rb'
+
+# Offense count: 2
+# Configuration parameters: IgnoredMethods.
+Metrics/AbcSize:
+  Max: 30
+
+# Offense count: 2
+# Configuration parameters: IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+# Offense count: 4
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 23
+
+# Offense count: 2
+# Configuration parameters: IgnoredMethods.
+Metrics/PerceivedComplexity:
+  Max: 9
+
+# Offense count: 2
+# Configuration parameters: AllowedChars.
+Style/AsciiComments:
+  Exclude:
+    - 'lib/notion/api/endpoints/pages.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'scratchpad.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'lib/notion/api/endpoints/pages.rb'
+    - 'lib/notion/api/endpoints/users.rb'

data/CHANGELOG.md

@@ -0,0 +1,144 @@
+### 1.3.0 (unreleased)
+
+#### Breaking changes
+
+- Bump the Notion API version to `2025-09-03`. Databases can now contain multiple data sources; querying and schema updates happen against a data source id, not a database id.
+
+#### New
+
+- Add support for the Data sources endpoints: `data_source_query`, `create_data_source`, `update_data_source`, `data_source`.
+- `create_page` accepts `parent: { data_source_id: ... }`.
+- `create_database` accepts `initial_data_source:` (still accepts a bare `properties:` for backward compatibility, wrapped automatically).
+
+#### Deprecated
+
+- `database_query` now logs a deprecation warning; use `data_source_query`.
+
+### 1.2.2 (2023-10-02)
+
+#### Improved
+
+- Remove `dotenv` as a runtime dependency (@sinsoku, #49)
+- Remove the outdated mention of the List Databases enpoint in the README (@soruma, #48)
+
+### 1.2.1 (2023-02-26)
+
+#### New
+
+- Add support for creating a page as child of another page (thanks @TABeauchat!)
+
+### 1.2.0 (2023-02-26)
+
+#### New
+
+- Add support for the following new endpoints (thanks @themoffatt!):
+  - [Create comment](https://developers.notion.com/reference/create-a-comment)
+  - [Retrieve comments](https://developers.notion.com/reference/retrieve-a-comment)
+
+### 1.1.0 (2023-02-23)
+
+#### Breaking changes
+
+- Remove support for ruby 2.5
+- Remove the `activesupport` dependency. Add `gem 'activesupport'` to your Gemfile if you required ActiveSupport via this library.
+
+#### Other
+
+- Upgrade Faraday to v2 (thanks @Tao-Galasse!)
+
+### 1.0.0 (2022-03-30)
+
+#### New
+
+- Add support for the following new endpoints:
+  - [Delete a block](https://developers.notion.com/reference/get-block-children)
+  - [Retrieve your token's bot user](https://developers.notion.com/reference/get-self)
+  - [Retrieve a page property item](https://developers.notion.com/reference/retrieve-a-page-property)
+- Update Notion API Version to `2022-02-22` (thanks @hkob!)
+- Remove the following deprecated endpoint:
+  - [List databases](https://developers.notion.com/reference/get-databases)
+- Add Codespaces and CONTRIBUTING.md command for better DX
+- Overhauled documentation
+
+### Upgrade instructions
+
+- Please refer to the Notion Changelog to see breaking changes for version `2022-02-22`: https://developers.notion.com/changelog/releasing-notion-version-2022-02-22
+
+### 1.0.0-beta2 (2022-03-24)
+
+#### Fixed
+
+Fixed compat with Rails 7
+
+### 1.0.0-beta1 (2022-03-24)
+
+#### New
+
+- Add support for the following new endpoints:
+  - [Delete a block](https://developers.notion.com/reference/get-block-children)
+  - [Retrieve your token's bot user](https://developers.notion.com/reference/get-self)
+  - [Retrieve a page property item](https://developers.notion.com/reference/retrieve-a-page-property)
+- Update Notion API Version to `2022-02-22` (thanks @hkob!)
+- Remove the following deprecated endpoint:
+  - [List databases](https://developers.notion.com/reference/get-databases)
+- Add Codespaces and CONTRIBUTING.md command for better DX
+- Overhauled documentation
+
+#### Upgrade instructions
+
+- Please refer to the Notion Changelog to see breaking changes for version `2022-02-22`: https://developers.notion.com/changelog/releasing-notion-version-2022-02-22
+
+### 0.1.0-beta1 (2021-08-29)
+
+#### New
+
+- Add support for the following new endpoints:
+  - [Update database](https://developers.notion.com/reference/update-a-database)
+  - [Update page](https://developers.notion.com/reference/patch-page)
+  - [Retrieve a block](https://developers.notion.com/reference/retrieve-a-block)
+  - [Update a block](https://developers.notion.com/reference/update-a-block)
+  - [Search](https://developers.notion.com/reference/search)
+- Update Notion API Version to `2021-08-16`
+- Add `bin/console` command for better DX
+- Overhauled documentation
+
+#### Upgrade instructions
+
+- Please refer to the Notion Changelog to see breaking changes for version `2021-08-16`
+- Regarding this gem, a lot of `id` parameters got renamed to `block_id`, `page_id`, `user_id` and `database_id`. You might need to rename those in your code as well.
+
+### 0.0.8 (2021-07-27)
+
+- Bump `Notion-Version` header to `2021-05-13` (@H0R15H0)
+- Add support for the new Create database endpoint (@H0R15H0)
+
+### 0.0.7 (2021-06-17)
+
+- Fixes the query parameter for fetching a page resource
+
+### 0.0.6 (2021-06-09)
+
+- Added `Notion-Version` required header to all requests
+
+### 0.0.5 (2020-04-25)
+
+- Added support for Blocks endpoints
+
+### 0.0.4 (2020-04-25)
+
+- Added specs and a CI process with GitHub Actions
+- Added support for GET /databases, POST /databases/<:id>/query endpoints
+- Added support for `content` when creating a page
+
+### 0.0.3 (2020-01-30)
+
+- The gem now covers all available endpoints to date
+- Better error handling and logging
+
+### 0.0.2 (2020-01-29)
+
+- Fixed blocking bug present in 0.0.1
+
+### 0.0.1 (2020-01-29)
+
+- Initial alpha public release. Suffers from a bug that prevents installation.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+nicolas@orbit.love.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

data/CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# CONTRIBUTING
+
+_This project is intended to be a safe, welcoming space for collaboration. By participating in this project you agree to abide by the [Contributor Code of Conduct](CODE_OF_CONDUCT.md)._
+
+Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
+
+## Running the project
+
+### GitHub Codespaces
+
+This repository includes configuration for GitHub Codespaces, making it easy to set up a cloud-based development environment. Follow [GitHub's guide](https://docs.github.com/en/codespaces/developing-in-codespaces/creating-a-codespace#creating-a-codespace) to get started.
+
+The Codespaces environment has the dependencies all installed, and should be ready to tinker with. Once your Codespace is set up, you can check that everything works as intended by running the specs:
+
+```
+bundle exec rake
+```
+
+### Running the project locally
+
+You can also install the project on your machine:
+
+```
+git clone https://github.com/phacks/notion-ruby-client.git
+cd notion-ruby-client
+# if you do not have bundler installed already, run
+# $ gem install bundle
+# to install it
+bundle install
+```
+
+You can check that everything works as intended by running the specs:
+
+```
+bundle exec rake
+```
+
+## Interactive console
+
+You can run
+
+```
+bin/console
+```
+
+to start an IRB (interactive Ruby console) session with all the gem files loaded.
+Usually, you’d start such sessions by defining your `client`:
+
+```
+client = Notion::Client.new(token: <Your Notion API token>)
+```

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    notionrb (1.3.0)
+      faraday (>= 2.0)
+      faraday-mashify (>= 0.1.1)
+      faraday-multipart (>= 1.0.4)
+      hashie (~> 5)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    base64 (0.3.0)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    dotenv (2.8.1)
+    faraday (2.8.1)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-mashify (0.1.1)
+      faraday (~> 2.0)
+      hashie
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (3.0.2)
+    hashdiff (1.0.1)
+    hashie (5.0.0)
+    jaro_winkler (1.5.4)
+    multipart-post (2.3.0)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (0.82.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    rubocop-rspec (1.39.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    timecop (0.9.4)
+    unicode-display_width (1.7.0)
+    vcr (6.0.0)
+    webmock (3.13.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-20
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  dotenv
+  notionrb!
+  rake (~> 13)
+  rspec
+  rubocop (~> 0.82.0)
+  rubocop-performance (~> 1.5.2)
+  rubocop-rspec (~> 1.39.0)
+  timecop
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.2.16

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Orbit
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.