notion-ruby-client 0.0.2 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f21b181770c49f8d02f34bdcf949fbc19ccbbd7e7cb62bee02163abf64fd80f5
-  data.tar.gz: 599580c1772892e31227fe369fdb478408442c12320f8fb6109da32f58f516ca
+  metadata.gz: 54a7b7076dce99aa2eec8b0ba041d2f1bfbdd1558a2ee94f76fe27112a726405
+  data.tar.gz: 11b710cf49ae369d53b023278ddfe6fe54f9c5eb4cc0d74922966f0d97f45b7f
 SHA512:
-  metadata.gz: 59d8fe6a3a90b9286cb5a09561263d4bb48330727d0c3daa0752aa11d5caeadeb02a66287e64dd9efa25dc72c31e0dc28aa91d233974ce93b3dda68734fabd75
-  data.tar.gz: 8d9c80c3d970fcb0e3715d325c091d3f95b85172850cc671c4a4f651e507e4b3adb8886aabd2a1288035be82f415013a26a5a3c583fc3db1e68d6926a2ebb3b9
+  metadata.gz: 415e4801fd99af01efe431edd03cef55b27a1436a089a69a3bf3cbb986109a810223736e8cb415dd8e60a4066e476af3e7d5736a5ffeb96002fd599e3bd24e0f
+  data.tar.gz: a26e034921948f495a28362f4ce392601f02e795ee1eac93fa41100df0781522b6a7488e2957b7b80e1fcaaa629433ba9f95aee7121d8a15abb20596a17e16ff

data/.github/workflows/ci.yml

@@ -0,0 +1,14 @@
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      matrix:
+        ruby: [2.5, 2.6, 2.7]
+    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

data/.rspec

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

data/.rspec_status

@@ -0,0 +1,18 @@
+example_id                                           | status | run_time        |
+---------------------------------------------------- | ------ | --------------- |
+./spec/notion/api/endpoints/blocks_spec.rb[1:1:1]    | passed | 0.01423 seconds |
+./spec/notion/api/endpoints/blocks_spec.rb[1:1:2]    | passed | 0.02323 seconds |
+./spec/notion/api/endpoints/blocks_spec.rb[1:1:3]    | passed | 0.00704 seconds |
+./spec/notion/api/endpoints/databases_spec.rb[1:1:1] | passed | 0.00598 seconds |
+./spec/notion/api/endpoints/databases_spec.rb[1:1:2] | passed | 0.00628 seconds |
+./spec/notion/api/endpoints/databases_spec.rb[1:1:3] | passed | 0.00548 seconds |
+./spec/notion/api/endpoints/databases_spec.rb[1:1:4] | passed | 0.00596 seconds |
+./spec/notion/api/endpoints/databases_spec.rb[1:1:5] | passed | 0.00606 seconds |
+./spec/notion/api/endpoints/pages_spec.rb[1:1:1]     | passed | 0.00581 seconds |
+./spec/notion/api/endpoints/pages_spec.rb[1:1:2]     | passed | 0.00598 seconds |
+./spec/notion/api/endpoints/pages_spec.rb[1:1:3]     | passed | 0.00717 seconds |
+./spec/notion/api/endpoints/users_spec.rb[1:1:1]     | passed | 0.00637 seconds |
+./spec/notion/api/endpoints/users_spec.rb[1:1:2]     | passed | 0.00671 seconds |
+./spec/notion/api/endpoints/users_spec.rb[1:1:3]     | passed | 0.00567 seconds |
+./spec/notion/config_spec.rb[1:1:1]                  | passed | 0.00005 seconds |
+./spec/notion/version_spec.rb[1:1]                   | passed | 0.00005 seconds |

data/.rubocop.yml

@@ -0,0 +1,46 @@
+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
+
+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,30 @@
+### 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/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    notion-ruby-client (0.0.6)
+      faraday (>= 1.0)
+      faraday_middleware
+      hashie
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    faraday (1.4.2)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.1.0)
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    hashdiff (1.0.1)
+    hashie (4.1.0)
+    jaro_winkler (1.5.4)
+    multipart-post (2.1.1)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    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.4)
+    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
+  x86_64-linux
+
+DEPENDENCIES
+  notion-ruby-client!
+  rake (~> 10)
+  rspec
+  rubocop (~> 0.82.0)
+  rubocop-performance (~> 1.5.2)
+  rubocop-rspec (~> 1.39.0)
+  timecop
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.2.16

data/README.md

@@ -24,7 +24,7 @@ Run `bundle install`.
 
 ### Create a New Bot Integration
 
-To integrate your bot with Notion, you must first create a new Notion Bot. (**TODO**: link to the docs)
+To integrate your bot with Notion, you must first [create a new Notion Bot](https://www.notion.so/Getting-started-da32a6fc1bcc4403a6126ee735710d89).
 
 1. Log into the workspace that you want your integration to be associated with.
 2. Confirm that you are an Admin in the workspace (see Settings & Members > Members).
@@ -34,12 +34,201 @@ To integrate your bot with Notion, you must first create a new Notion Bot. (**TO
 
 ### Declare the API token
 
-```
+```ruby
 Notion.configure do |config|
   config.token = ENV['NOTION_API_TOKEN']
 end
 ```
 
+For Rails projects, the snippet above would go to `config/application.rb`.
+
 ### API Client
 
-TODO: document endpoints
+#### Instanciating a new Notion API client
+
+```ruby
+client = Notion::Client.new
+```
+
+You can specify the token or logger on a per-client basis:
+
+```ruby
+client = Notion::Client.new(token: '<secret Notion API token>')
+```
+
+#### Users
+
+Get a paginated list of [User objects](https://www.notion.so/User-object-4f8d1a2fc1e54680b5f810ed0c6903a6) for the workspace:
+
+```ruby
+client.users_list # retrieves the first page
+
+client.users_list(start_cursor: 'fe2cc560-036c-44cd-90e8-294d5a74cebc')
+
+client.users_list do |page|
+  # paginate through all users
+end
+```
+
+Get a single User:
+
+```ruby
+client.user(id: 'd40e767c-d7af-4b18-a86d-55c61f1e39a4')
+```
+
+#### Databases
+
+Gets a paginated array of Page objects contained in the requested database, filtered and ordered according to the filter and sort references provided in the request.
+
+```ruby
+client.database_query(id: 'e383bcee-e0d8-4564-9c63-900d307abdb0')  # retrieves the first page
+
+client.database_query(id: 'e383bcee-e0d8-4564-9c63-900d307abdb0', start_cursor: 'fe2cc560-036c-44cd-90e8-294d5a74cebc')
+
+client.database_query((id: 'e383bcee-e0d8-4564-9c63-900d307abdb0') do |page|
+  # paginate through all pages
+end
+
+# Filter and sort the database
+sort = [
+  {
+    "property": "Last ordered",
+    "direction": "ascending"
+  }
+]
+filter = {
+  "or": [
+    {
+      "property": "In stock",
+      "checkbox": {
+        "equals": true
+      }
+    },
+    {
+      "property": "Cost of next trip",
+      "number": {
+        "greater_than_or_equal_to": 2
+      }
+    }
+  ]
+}
+client.database_query(id: 'e383bcee-e0d8-4564-9c63-900d307abdb0', sort: sort, filter: filter)
+```
+
+Get a single Database:
+
+```ruby
+client.database(id: 'e383bcee-e0d8-4564-9c63-900d307abdb0')
+```
+
+Lists databases:
+
+```ruby
+client.databases_list # retrieves the first page
+
+client.databases_list(start_cursor: 'fe2cc560-036c-44cd-90e8-294d5a74cebc')
+
+client.databases_list do |page|
+  # paginate through all databases
+end
+```
+
+#### Pages
+
+Create a page:
+
+```ruby
+properties = {
+  "Name": [
+    {
+      "text": {
+        "content": "Tuscan Kale"
+      }
+    }
+  ],
+  "Description": [
+    {
+      "text": {
+        "content": "A dark green leafy vegetable"
+      }
+    }
+  ],
+  "Food group": {
+    "name": "🥦 Vegetable"
+  },
+  "Price": 2.5
+}
+children = [
+  {
+    "object": "block",
+    "type": "heading_2",
+    "heading_2": {
+      "text": [{ "type": "text", "text": { "content": "Lacinato kale" } }]
+    }
+  },
+  {
+    "object": "block",
+    "type": "paragraph",
+    "paragraph": {
+      "text": [
+        {
+          "type": "text",
+          "text": {
+            "content": "Lacinato kale is a variety of kale with a long tradition in Italian cuisine, especially that of Tuscany. It is also known as Tuscan kale, Italian kale, dinosaur kale, kale, flat back kale, palm tree kale, or black Tuscan palm.",
+            "link": { "url": "https://en.wikipedia.org/wiki/Lacinato_kale" }
+          }
+        }
+      ]
+    }
+  }
+]
+client.create_page(
+   parent: { database_id: 'e383bcee-e0d8-4564-9c63-900d307abdb0'},
+   properties: properties,
+   children: children
+)
+```
+
+Retrieve a page:
+
+```ruby
+client.page(id: 'b55c9c91-384d-452b-81db-d1ef79372b75')
+```
+
+Update page properties:
+
+```ruby
+properties = {
+  "In stock": true
+}
+client.update_page(id: 'b55c9c91-384d-452b-81db-d1ef79372b75', properties: properties)
+```
+
+#### Blocks
+
+Retrieve children Block objects at the requested path:
+
+```ruby
+client.block_children(id: 'b55c9c91-384d-452b-81db-d1ef79372b75')
+
+client.block_children(start_cursor: 'fe2cc560-036c-44cd-90e8-294d5a74cebc')
+
+client.block_children_list do |page|
+  # paginate through all children
+end
+```
+
+Creates and appends new children blocks to the parent block in the requested path:
+
+```ruby
+children = [
+  {
+    "object": 'block',
+    "type": 'heading_2',
+    "heading_2": {
+      "text": [{ "type": 'text', "text": { "content": 'A Second-level Heading' } }]
+    }
+  }
+]
+client.block_append_children(id: 'b55c9c91-384d-452b-81db-d1ef79372b75', children: children)
+```