notion-ruby-client 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20e1bb5a2a25417881a39465bc72a003d9f8a3fc59ab0fcfd3378a6c87759753
-  data.tar.gz: dfd32ada283cb93a62e8e9358abe25aadf56d1693ddd0b94e75d5a133669ed3c
+  metadata.gz: da15ba6b2f024300114602bd828c15ca06e04366336e3414b6c8a557011672ff
+  data.tar.gz: b729ffdea1ce51e5381a2dc1a296180bf4ae396ae1be526433fd8059f3a974a8
 SHA512:
-  metadata.gz: 937c7196eced3be3cd9cd811242bccae35e8101dd6a5194bf35a39184b02aa810854dc5dd925e2f10af62df3206a6388c8757723cb762d1179cab07952e85f9c
-  data.tar.gz: b651fdf6d3901fed41ebae4570267ca4641f6e84dd0b899622b02a5089dc98cedec5cbee005e523205f0c3d3824091ea2cb4f21947bf6edbb8a8450441ade347
+  metadata.gz: 2d6c904bc63780d5ce10688ac6033e7c62dacb72baaf5d451d7a2332ad4bf39719cb5f02b52e82f8b358543081c9008010f0cf1394e67f04aa047bbc9727cfc3
+  data.tar.gz: b29c7cbb03715c3d4390e0d0a94d36fecf175e8d38fb4713e82785ee8a240cf3a834b2fc157504040a546922ed039a0fe9d92b50896a61d034b9b0d44d9fda0d

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,15 @@
+example_id                                           | status | run_time        |
+---------------------------------------------------- | ------ | --------------- |
+./spec/notion/api/endpoints/databases_spec.rb[1:1:1] | passed | 0.01164 seconds |
+./spec/notion/api/endpoints/databases_spec.rb[1:1:2] | passed | 0.007 seconds   |
+./spec/notion/api/endpoints/databases_spec.rb[1:1:3] | passed | 0.00692 seconds |
+./spec/notion/api/endpoints/databases_spec.rb[1:1:4] | passed | 0.00666 seconds |
+./spec/notion/api/endpoints/databases_spec.rb[1:1:5] | passed | 0.85972 seconds |
+./spec/notion/api/endpoints/pages_spec.rb[1:1:1]     | passed | 0.00676 seconds |
+./spec/notion/api/endpoints/pages_spec.rb[1:1:2]     | passed | 0.0063 seconds  |
+./spec/notion/api/endpoints/pages_spec.rb[1:1:3]     | passed | 0.00628 seconds |
+./spec/notion/api/endpoints/users_spec.rb[1:1:1]     | passed | 0.00722 seconds |
+./spec/notion/api/endpoints/users_spec.rb[1:1:2]     | passed | 0.00731 seconds |
+./spec/notion/api/endpoints/users_spec.rb[1:1:3]     | passed | 0.00678 seconds |
+./spec/notion/config_spec.rb[1:1:1]                  | passed | 0.00009 seconds |
+./spec/notion/version_spec.rb[1:1]                   | passed | 0.00006 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

@@ -1,3 +1,9 @@
+### 0.0.4 (2020-04-25)
+
+- Added specs and a CI process with GitHub Actions
+- Add support for GET /databases, POST /databases/<:id>/query endpoints
+- Add support for `content` when creating a page
+
 ### 0.0.3 (2020-01-30)
 
 - The gem now covers all available endpoints to date

data/Gemfile.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: .
+  specs:
+    notion-ruby-client (0.0.3)
+      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.1)
+      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-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.0)
+      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.12.2)
+      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.5

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,172 @@ 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)
+```