notion-ruby-client 0.0.1 → 0.0.6

data/spec/fixtures/notion/users.yml

@@ -0,0 +1,132 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.notion.com/v1/users/a8da8d30-c858-4c3d-87ad-3f2d477bd98d
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      User-Agent:
+      - Notion Ruby Client/0.0.4
+      Authorization:
+      - Bearer <NOTION_API_TOKEN>
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sun, 25 Apr 2021 21:00:08 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cfduid=d10c7505ad45dea19d885ea9e087883651619384407; expires=Tue, 25-May-21
+        21:00:07 GMT; path=/; domain=.notion.com; HttpOnly; SameSite=Lax
+      - notion_browser_id=6378e6be-b1ca-4d94-b556-8f3ae50d725f; Domain=www.notion.so;
+        Path=/; Expires=Wed, 01 Jan 2053 22:46:48 GMT; Secure
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Frame-Options:
+      - SAMEORIGIN
+      Strict-Transport-Security:
+      - max-age=5184000; includeSubDomains
+      X-Download-Options:
+      - noopen
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      Referrer-Policy:
+      - same-origin
+      Content-Security-Policy:
+      - 'script-src ''self'' ''unsafe-inline'' ''unsafe-eval'' https://gist.github.com
+        https://apis.google.com https://api.amplitude.com https://widget.intercom.io
+        https://js.intercomcdn.com https://logs-01.loggly.com https://cdn.segment.com
+        https://analytics.pgncs.notion.so https://checkout.stripe.com https://js.stripe.com/v3
+        https://embed.typeform.com https://admin.typeform.com https://platform.twitter.com
+        https://cdn.syndication.twimg.com https://www.googletagmanager.com https://x.clearbitjs.com;
+        connect-src ''self'' https://msgstore.www.notion.so wss://msgstore.www.notion.so
+        ws://localhost:* https://notion-emojis.s3-us-west-2.amazonaws.com https://s3-us-west-2.amazonaws.com
+        https://s3.us-west-2.amazonaws.com https://notion-production-snapshots-2.s3.us-west-2.amazonaws.com
+        https: http: https://api.amplitude.com https://api.embed.ly https://js.intercomcdn.com
+        https://api-iam.intercom.io wss://nexus-websocket-a.intercom.io https://logs-01.loggly.com
+        https://api.segment.io https://api.pgncs.notion.so https://checkout.stripe.com
+        https://js.stripe.com/v3 https://cdn.contentful.com https://preview.contentful.com
+        https://images.ctfassets.net https://api.unsplash.com https://boards-api.greenhouse.io;
+        font-src ''self'' data: https://cdnjs.cloudflare.com https://js.intercomcdn.com;
+        img-src ''self'' data: blob: https: https://platform.twitter.com https://syndication.twitter.com
+        https://pbs.twimg.com https://ton.twimg.com www.googletagmanager.com; style-src
+        ''self'' ''unsafe-inline'' https://cdnjs.cloudflare.com https://github.githubassets.com
+        https://platform.twitter.com https://ton.twimg.com; frame-src https: http:;
+        media-src https: http:'
+      X-Content-Security-Policy:
+      - 'script-src ''self'' ''unsafe-inline'' ''unsafe-eval'' https://gist.github.com
+        https://apis.google.com https://api.amplitude.com https://widget.intercom.io
+        https://js.intercomcdn.com https://logs-01.loggly.com https://cdn.segment.com
+        https://analytics.pgncs.notion.so https://checkout.stripe.com https://js.stripe.com/v3
+        https://embed.typeform.com https://admin.typeform.com https://platform.twitter.com
+        https://cdn.syndication.twimg.com https://www.googletagmanager.com https://x.clearbitjs.com;
+        connect-src ''self'' https://msgstore.www.notion.so wss://msgstore.www.notion.so
+        ws://localhost:* https://notion-emojis.s3-us-west-2.amazonaws.com https://s3-us-west-2.amazonaws.com
+        https://s3.us-west-2.amazonaws.com https://notion-production-snapshots-2.s3.us-west-2.amazonaws.com
+        https: http: https://api.amplitude.com https://api.embed.ly https://js.intercomcdn.com
+        https://api-iam.intercom.io wss://nexus-websocket-a.intercom.io https://logs-01.loggly.com
+        https://api.segment.io https://api.pgncs.notion.so https://checkout.stripe.com
+        https://js.stripe.com/v3 https://cdn.contentful.com https://preview.contentful.com
+        https://images.ctfassets.net https://api.unsplash.com https://boards-api.greenhouse.io;
+        font-src ''self'' data: https://cdnjs.cloudflare.com https://js.intercomcdn.com;
+        img-src ''self'' data: blob: https: https://platform.twitter.com https://syndication.twitter.com
+        https://pbs.twimg.com https://ton.twimg.com www.googletagmanager.com; style-src
+        ''self'' ''unsafe-inline'' https://cdnjs.cloudflare.com https://github.githubassets.com
+        https://platform.twitter.com https://ton.twimg.com; frame-src https: http:;
+        media-src https: http:'
+      X-Webkit-Csp:
+      - 'script-src ''self'' ''unsafe-inline'' ''unsafe-eval'' https://gist.github.com
+        https://apis.google.com https://api.amplitude.com https://widget.intercom.io
+        https://js.intercomcdn.com https://logs-01.loggly.com https://cdn.segment.com
+        https://analytics.pgncs.notion.so https://checkout.stripe.com https://js.stripe.com/v3
+        https://embed.typeform.com https://admin.typeform.com https://platform.twitter.com
+        https://cdn.syndication.twimg.com https://www.googletagmanager.com https://x.clearbitjs.com;
+        connect-src ''self'' https://msgstore.www.notion.so wss://msgstore.www.notion.so
+        ws://localhost:* https://notion-emojis.s3-us-west-2.amazonaws.com https://s3-us-west-2.amazonaws.com
+        https://s3.us-west-2.amazonaws.com https://notion-production-snapshots-2.s3.us-west-2.amazonaws.com
+        https: http: https://api.amplitude.com https://api.embed.ly https://js.intercomcdn.com
+        https://api-iam.intercom.io wss://nexus-websocket-a.intercom.io https://logs-01.loggly.com
+        https://api.segment.io https://api.pgncs.notion.so https://checkout.stripe.com
+        https://js.stripe.com/v3 https://cdn.contentful.com https://preview.contentful.com
+        https://images.ctfassets.net https://api.unsplash.com https://boards-api.greenhouse.io;
+        font-src ''self'' data: https://cdnjs.cloudflare.com https://js.intercomcdn.com;
+        img-src ''self'' data: blob: https: https://platform.twitter.com https://syndication.twitter.com
+        https://pbs.twimg.com https://ton.twimg.com www.googletagmanager.com; style-src
+        ''self'' ''unsafe-inline'' https://cdnjs.cloudflare.com https://github.githubassets.com
+        https://platform.twitter.com https://ton.twimg.com; frame-src https: http:;
+        media-src https: http:'
+      Etag:
+      - W/"112-+UfaDnQ0AQtnGmMk1mvOOgv2xyk"
+      Vary:
+      - Accept-Encoding
+      Cf-Cache-Status:
+      - DYNAMIC
+      Cf-Request-Id:
+      - '09ac6e2e810000a843f7864000000001'
+      Expect-Ct:
+      - max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 645a7fc3fe50a843-CDG
+    body:
+      encoding: UTF-8
+      string: '{"object":"user","id":"a8da8d30-c858-4c3d-87ad-3f2d477bd98d","name":"Nicolas
+        Goutay","avatar_url":"https://s3-us-west-2.amazonaws.com/public.notion-static.com/5f9b5c65-a7ed-4fc5-983a-6c999b7c2208/Copy_of_P1222454.jpg","type":"person","person":{"email":"nicolas@orbit.love"}}'
+  recorded_at: Sun, 25 Apr 2021 21:00:08 GMT
+recorded_with: VCR 6.0.0

data/spec/fixtures/notion/users_list.yml

@@ -0,0 +1,133 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.notion.com/v1/users
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      User-Agent:
+      - Notion Ruby Client/0.0.4
+      Authorization:
+      - Bearer <NOTION_API_TOKEN>
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sun, 25 Apr 2021 21:00:06 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cfduid=d8bd1f2559197f7cbe522dc8d2a13cf771619384405; expires=Tue, 25-May-21
+        21:00:05 GMT; path=/; domain=.notion.com; HttpOnly; SameSite=Lax
+      - notion_browser_id=a30325ff-c789-4096-a739-ba51b79eea5b; Domain=www.notion.so;
+        Path=/; Expires=Wed, 01 Jan 2053 22:46:46 GMT; Secure
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Frame-Options:
+      - SAMEORIGIN
+      Strict-Transport-Security:
+      - max-age=5184000; includeSubDomains
+      X-Download-Options:
+      - noopen
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      Referrer-Policy:
+      - same-origin
+      Content-Security-Policy:
+      - 'script-src ''self'' ''unsafe-inline'' ''unsafe-eval'' https://gist.github.com
+        https://apis.google.com https://api.amplitude.com https://widget.intercom.io
+        https://js.intercomcdn.com https://logs-01.loggly.com https://cdn.segment.com
+        https://analytics.pgncs.notion.so https://checkout.stripe.com https://js.stripe.com/v3
+        https://embed.typeform.com https://admin.typeform.com https://platform.twitter.com
+        https://cdn.syndication.twimg.com https://www.googletagmanager.com https://x.clearbitjs.com;
+        connect-src ''self'' https://msgstore.www.notion.so wss://msgstore.www.notion.so
+        ws://localhost:* https://notion-emojis.s3-us-west-2.amazonaws.com https://s3-us-west-2.amazonaws.com
+        https://s3.us-west-2.amazonaws.com https://notion-production-snapshots-2.s3.us-west-2.amazonaws.com
+        https: http: https://api.amplitude.com https://api.embed.ly https://js.intercomcdn.com
+        https://api-iam.intercom.io wss://nexus-websocket-a.intercom.io https://logs-01.loggly.com
+        https://api.segment.io https://api.pgncs.notion.so https://checkout.stripe.com
+        https://js.stripe.com/v3 https://cdn.contentful.com https://preview.contentful.com
+        https://images.ctfassets.net https://api.unsplash.com https://boards-api.greenhouse.io;
+        font-src ''self'' data: https://cdnjs.cloudflare.com https://js.intercomcdn.com;
+        img-src ''self'' data: blob: https: https://platform.twitter.com https://syndication.twitter.com
+        https://pbs.twimg.com https://ton.twimg.com www.googletagmanager.com; style-src
+        ''self'' ''unsafe-inline'' https://cdnjs.cloudflare.com https://github.githubassets.com
+        https://platform.twitter.com https://ton.twimg.com; frame-src https: http:;
+        media-src https: http:'
+      X-Content-Security-Policy:
+      - 'script-src ''self'' ''unsafe-inline'' ''unsafe-eval'' https://gist.github.com
+        https://apis.google.com https://api.amplitude.com https://widget.intercom.io
+        https://js.intercomcdn.com https://logs-01.loggly.com https://cdn.segment.com
+        https://analytics.pgncs.notion.so https://checkout.stripe.com https://js.stripe.com/v3
+        https://embed.typeform.com https://admin.typeform.com https://platform.twitter.com
+        https://cdn.syndication.twimg.com https://www.googletagmanager.com https://x.clearbitjs.com;
+        connect-src ''self'' https://msgstore.www.notion.so wss://msgstore.www.notion.so
+        ws://localhost:* https://notion-emojis.s3-us-west-2.amazonaws.com https://s3-us-west-2.amazonaws.com
+        https://s3.us-west-2.amazonaws.com https://notion-production-snapshots-2.s3.us-west-2.amazonaws.com
+        https: http: https://api.amplitude.com https://api.embed.ly https://js.intercomcdn.com
+        https://api-iam.intercom.io wss://nexus-websocket-a.intercom.io https://logs-01.loggly.com
+        https://api.segment.io https://api.pgncs.notion.so https://checkout.stripe.com
+        https://js.stripe.com/v3 https://cdn.contentful.com https://preview.contentful.com
+        https://images.ctfassets.net https://api.unsplash.com https://boards-api.greenhouse.io;
+        font-src ''self'' data: https://cdnjs.cloudflare.com https://js.intercomcdn.com;
+        img-src ''self'' data: blob: https: https://platform.twitter.com https://syndication.twitter.com
+        https://pbs.twimg.com https://ton.twimg.com www.googletagmanager.com; style-src
+        ''self'' ''unsafe-inline'' https://cdnjs.cloudflare.com https://github.githubassets.com
+        https://platform.twitter.com https://ton.twimg.com; frame-src https: http:;
+        media-src https: http:'
+      X-Webkit-Csp:
+      - 'script-src ''self'' ''unsafe-inline'' ''unsafe-eval'' https://gist.github.com
+        https://apis.google.com https://api.amplitude.com https://widget.intercom.io
+        https://js.intercomcdn.com https://logs-01.loggly.com https://cdn.segment.com
+        https://analytics.pgncs.notion.so https://checkout.stripe.com https://js.stripe.com/v3
+        https://embed.typeform.com https://admin.typeform.com https://platform.twitter.com
+        https://cdn.syndication.twimg.com https://www.googletagmanager.com https://x.clearbitjs.com;
+        connect-src ''self'' https://msgstore.www.notion.so wss://msgstore.www.notion.so
+        ws://localhost:* https://notion-emojis.s3-us-west-2.amazonaws.com https://s3-us-west-2.amazonaws.com
+        https://s3.us-west-2.amazonaws.com https://notion-production-snapshots-2.s3.us-west-2.amazonaws.com
+        https: http: https://api.amplitude.com https://api.embed.ly https://js.intercomcdn.com
+        https://api-iam.intercom.io wss://nexus-websocket-a.intercom.io https://logs-01.loggly.com
+        https://api.segment.io https://api.pgncs.notion.so https://checkout.stripe.com
+        https://js.stripe.com/v3 https://cdn.contentful.com https://preview.contentful.com
+        https://images.ctfassets.net https://api.unsplash.com https://boards-api.greenhouse.io;
+        font-src ''self'' data: https://cdnjs.cloudflare.com https://js.intercomcdn.com;
+        img-src ''self'' data: blob: https: https://platform.twitter.com https://syndication.twitter.com
+        https://pbs.twimg.com https://ton.twimg.com www.googletagmanager.com; style-src
+        ''self'' ''unsafe-inline'' https://cdnjs.cloudflare.com https://github.githubassets.com
+        https://platform.twitter.com https://ton.twimg.com; frame-src https: http:;
+        media-src https: http:'
+      Etag:
+      - W/"2c7-9fGZ6Loa3izncqaW0AxZr7NvCPY"
+      Vary:
+      - Accept-Encoding
+      Cf-Cache-Status:
+      - DYNAMIC
+      Cf-Request-Id:
+      - '09ac6e27c800000853aea0c000000001'
+      Expect-Ct:
+      - max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 645a7fb93dac0853-CDG
+    body:
+      encoding: UTF-8
+      string: '{"object":"list","results":[{"object":"user","id":"7ee614aa-0542-421d-b8aa-b14adf120642","name":"Arthur
+        Levoyer","avatar_url":"https://lh6.googleusercontent.com/-Y62UK1QjtV8/AAAAAAAAAAI/AAAAAAAAACk/3PgWyczXM8o/photo.jpg?sz=50","type":"person","person":{"email":"arthurl@bam.tech"}},{"object":"user","id":"a8da8d30-c858-4c3d-87ad-3f2d477bd98d","name":"Nicolas
+        Goutay","avatar_url":"https://s3-us-west-2.amazonaws.com/public.notion-static.com/5f9b5c65-a7ed-4fc5-983a-6c999b7c2208/Copy_of_P1222454.jpg","type":"person","person":{"email":"nicolas@orbit.love"}},{"object":"user","id":"f2e67536-c037-4dd5-97f5-8ed9d23a4dbd","name":"LeBot","avatar_url":null,"type":"bot","bot":{}}],"next_cursor":null,"has_more":false}'
+  recorded_at: Sun, 25 Apr 2021 21:00:06 GMT
+recorded_with: VCR 6.0.0

data/spec/notion/api/endpoints/blocks_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe Notion::Api::Endpoints::Blocks do
+  let(:client) { Notion::Client.new }
+  let(:page_id) { '723578f1-6e51-450c-8ee1-09158c19fd4c' }
+  let(:children) do
+    [
+      {
+        "object": 'block',
+        "type": 'heading_2',
+        "heading_2": {
+          "text": [{ "type": 'text', "text": { "content": 'Another Heading' } }]
+        }
+      }
+    ]
+  end
+
+  context 'blocks' do
+    it 'children', vcr: { cassette_name: 'block_children' } do
+      response = client.block_children(id: page_id)
+      expect(response.results.length).to be >= 1
+      expect(response.results[0].heading_1.text.first.plain_text).to eql 'A Header'
+      expect(response.results[1].paragraph.text.first.plain_text).to eql 'A paragraph'
+    end
+
+    it 'paginated children', vcr: { cassette_name: 'paginated_block_children' } do
+      children = []
+      client.block_children(id: page_id, page_size: 1) do |page|
+        children.concat page.results
+      end
+      expect(children.size).to be >= 1
+    end
+
+    it 'appends', vcr: { cassette_name: 'block_append_children' } do
+      response = client.block_append_children(id: page_id, children: children)
+      expect(response.id).to eql page_id
+    end
+  end
+end

data/spec/notion/api/endpoints/databases_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe Notion::Api::Endpoints::Databases do
+  let(:client) { Notion::Client.new }
+  let(:database_id) { '89b30a70-ce51-4646-ab4f-5fdcb1d5e76c' }
+
+  context 'databases' do
+    it 'retrieves', vcr: { cassette_name: 'database' } do
+      response = client.database(id: database_id)
+      expect(response.title.first.plain_text).to eql 'A Notion database'
+    end
+
+    it 'queries', vcr: { cassette_name: 'database_query' } do
+      response = client.database_query(id: database_id)
+      expect(response.results.length).to be >= 1
+    end
+
+    it 'paginated queries', vcr: { cassette_name: 'paginated_database_query' } do
+      pages = []
+      client.database_query(id: database_id, limit: 1) do |page|
+        pages.concat page.results
+      end
+      expect(pages.size).to be >= 1
+    end
+
+    it 'lists', vcr: { cassette_name: 'databases_list' } do
+      response = client.databases_list
+      expect(response.results.length).to be >= 1
+    end
+
+    it 'paginated lists', vcr: { cassette_name: 'paginated_databases_list' } do
+      databases = []
+      client.databases_list(limit: 1) do |page|
+        databases.concat page.results
+      end
+      expect(databases.size).to be >= 1
+    end
+  end
+end

data/spec/notion/api/endpoints/pages_spec.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe Notion::Api::Endpoints::Pages do
+  let(:client) { Notion::Client.new }
+  let(:database_id) { '89b30a70-ce51-4646-ab4f-5fdcb1d5e76c' }
+  let(:page_id) { '723578f1-6e51-450c-8ee1-09158c19fd4c' }
+  let(:properties) do
+    {
+      "Name": [
+        {
+          "text": {
+            "content": 'Another Notion page'
+          }
+        }
+      ]
+    }
+  end
+  let(:children) do
+    [
+      {
+        "object": 'block',
+        "type": 'heading_2',
+        "heading_2": {
+          "text": [{ "type": 'text', "text": { "content": 'A heading' } }]
+        }
+      }
+    ]
+  end
+
+  context 'pages' do
+    it 'retrieves', vcr: { cassette_name: 'page' } do
+      response = client.page(id: page_id)
+      expect(response.properties.Name.type).to eql 'title'
+      expect(response.properties.Name.title.first.plain_text).to eql 'A Notion page'
+    end
+
+    it 'creates', vcr: { cassette_name: 'create_page' } do
+      response = client.create_page(
+        parent: { database_id: database_id },
+        properties: properties,
+        children: children
+      )
+      expect(response.properties.Name.title.first.plain_text).to eql 'Another Notion page'
+    end
+
+    it 'updates', vcr: { cassette_name: 'update_page' } do
+      properties = {
+        "Name": [
+          {
+            "text": {
+              "content": 'A Notion page'
+            }
+          }
+        ]
+      }
+      response = client.update_page(
+        id: page_id,
+        properties: properties
+      )
+      expect(response.properties.Name.title.first.plain_text).to eql 'A Notion page'
+    end
+  end
+end

data/spec/notion/api/endpoints/users_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe Notion::Api::Endpoints::Users do
+  let(:client) { Notion::Client.new }
+
+  context 'users' do
+    it 'lists', vcr: { cassette_name: 'users_list' } do
+      response = client.users_list
+      expect(response.results.size).to be 3
+    end
+
+    it 'paginated list', vcr: { cassette_name: 'paginated_users_list' } do
+      members = []
+      client.users_list(limit: 2) do |page|
+        members.concat page.results
+      end
+      expect(members.size).to eq 3
+    end
+
+    it 'retrieves', vcr: { cassette_name: 'users' } do
+      response = client.user(id: 'a8da8d30-c858-4c3d-87ad-3f2d477bd98d')
+      expect(response.name).to eql 'Nicolas Goutay'
+    end
+  end
+end

data/spec/notion/config_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+describe Notion::Config do
+  describe '#configure' do
+    before do
+      Notion.configure do |config|
+        config.token = 'a token'
+      end
+    end
+
+    it 'sets token' do
+      expect(Notion.config.token).to eq 'a token'
+    end
+  end
+end