notion-ruby-client 0.0.8 → 0.1.0.pre.beta1

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

@@ -3,38 +3,64 @@ require 'spec_helper'
 
 RSpec.describe Notion::Api::Endpoints::Blocks do
   let(:client) { Notion::Client.new }
-  let(:page_id) { '723578f1-6e51-450c-8ee1-09158c19fd4c' }
+  let(:block_id) { '32af3324-ba02-4516-ae88-5728a4d569f4' }
   let(:children) do
     [
       {
-        "object": 'block',
-        "type": 'heading_2',
-        "heading_2": {
-          "text": [{ "type": 'text', "text": { "content": 'Another Heading' } }]
+        'object': 'block',
+        'type': 'paragraph',
+        'paragraph': {
+          'text': [
+            {
+              'type': 'text',
+              'text': {
+                'content': 'Another children'
+              }
+            }
+          ]
         }
       }
     ]
   end
 
   context 'blocks' do
+    it 'retrieves', vcr: { cassette_name: 'block' } do
+      response = client.block(block_id: block_id)
+      expect(response).not_to be_empty
+    end
+
+    it 'updates', vcr: { cassette_name: 'update_block' } do
+      to_do = {
+        'text': [
+          {
+            'text': { 'content': 'A todo' }
+          }
+        ],
+        'checked': true
+      }
+      to_do_block_id = '6e842658-eb3d-4ea9-9bbf-e86104151729'
+      response = client.update_block(block_id: to_do_block_id, 'to_do' => to_do)
+      expect(response.id).to eql to_do_block_id
+    end
+
     it 'children', vcr: { cassette_name: 'block_children' } do
-      response = client.block_children(id: page_id)
+      response = client.block_children(block_id: block_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'
+      expect(response.results[0].paragraph.text.first.plain_text).to eql 'The first child'
+      expect(response.results[1].paragraph.text.first.plain_text).to eql 'The second child'
     end
 
     it 'paginated children', vcr: { cassette_name: 'paginated_block_children' } do
       children = []
-      client.block_children(id: page_id, page_size: 1) do |page|
+      client.block_children(block_id: block_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
+      response = client.block_append_children(block_id: block_id, children: children)
+      expect(response.results.first.type).to eql 'paragraph'
     end
   end
 end

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

@@ -3,13 +3,13 @@ require 'spec_helper'
 
 RSpec.describe Notion::Api::Endpoints::Databases do
   let(:client) { Notion::Client.new }
-  let(:database_id) { '89b30a70-ce51-4646-ab4f-5fdcb1d5e76c' }
-  let(:page_id) { '7cbf38f8-5921-4422-bd3f-a647c3e2544b' }
+  let(:database_id) { 'dd428e9dd3fe4171870da7a1902c748b' }
+  let(:page_id) { 'c7fd1abe811444eabe779632ea33e581' }
   let(:title) do
     [
       {
         "text": {
-          "content": 'Another Notion database'
+          "content": 'Orbit 💜 Notion'
         }
       }
     ]
@@ -23,31 +23,39 @@ RSpec.describe Notion::Api::Endpoints::Databases do
   end
 
   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)
+      response = client.database_query(database_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(database_id: database_id, page_size: 1) do |page|
+        pages.concat page.results
+      end
+      expect(pages.size).to be >= 1
+    end
+
     it 'creates', vcr: { cassette_name: 'create_database' } do
       response = client.create_database(
         parent: { page_id: page_id },
         title: title,
         properties: properties
       )
-      expect(response.title.first.plain_text).to eql 'Another Notion database'
+      expect(response.title.first.plain_text).to eql 'Orbit 💜 Notion'
     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
+    it 'updates', vcr: { cassette_name: 'update_database' } do
+      response = client.update_database(
+        database_id: database_id,
+        title: title
+      )
+      expect(response.title.first.plain_text).to eql 'Orbit 💜 Notion'
+    end
+
+    it 'retrieves', vcr: { cassette_name: 'database' } do
+      response = client.database(database_id: database_id)
+      expect(response.title.first.plain_text).to eql 'Orbit 💜 Notion'
     end
 
     it 'lists', vcr: { cassette_name: 'databases_list' } do
@@ -57,7 +65,7 @@ RSpec.describe Notion::Api::Endpoints::Databases do
 
     it 'paginated lists', vcr: { cassette_name: 'paginated_databases_list' } do
       databases = []
-      client.databases_list(limit: 1) do |page|
+      client.databases_list(page_size: 1) do |page|
         databases.concat page.results
       end
       expect(databases.size).to be >= 1

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

@@ -3,8 +3,8 @@ require 'spec_helper'
 
 RSpec.describe Notion::Api::Endpoints::Pages do
   let(:client) { Notion::Client.new }
-  let(:database_id) { 'ab7e7b22-7793-492a-ba6b-3295f8b19341' }
-  let(:page_id) { '2de466f0-9861-466b-9bc2-c987965da010' }
+  let(:database_id) { 'dd428e9d-d3fe-4171-870d-a7a1902c748b' }
+  let(:page_id) { 'c7fd1abe-8114-44ea-be77-9632ea33e581' }
   let(:properties) do
     {
       "Name": {
@@ -15,15 +15,6 @@ RSpec.describe Notion::Api::Endpoints::Pages do
             }
           }
         ]
-      },
-      "Description": {
-        "rich_text": [
-          {
-            "text": {
-              "content": 'Page description'
-            }
-          }
-        ]
       }
     }
   end
@@ -41,9 +32,9 @@ RSpec.describe Notion::Api::Endpoints::Pages do
 
   context 'pages' do
     it 'retrieves', vcr: { cassette_name: 'page' } do
-      response = client.page(id: page_id)
+      response = client.page(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'
+      expect(response.properties.Name.title.first.plain_text).to eql 'Nicolas Goutay'
     end
 
     it 'creates', vcr: { cassette_name: 'create_page' } do
@@ -60,16 +51,16 @@ RSpec.describe Notion::Api::Endpoints::Pages do
         "Name": [
           {
             "text": {
-              "content": 'A Notion page'
+              "content": 'Nicolas Goutay'
             }
           }
         ]
       }
       response = client.update_page(
-        id: page_id,
+        page_id: page_id,
         properties: properties
       )
-      expect(response.properties.Name.title.first.plain_text).to eql 'A Notion page'
+      expect(response.properties.Name.title.first.plain_text).to eql 'Nicolas Goutay'
     end
   end
 end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe Notion::Api::Endpoints::Search do
+  let(:client) { Notion::Client.new }
+
+  context 'search' do
+    it 'searches', vcr: { cassette_name: 'search' } do
+      response = client.search
+      expect(response.results.size).to eq 2
+    end
+
+    it 'searches with a query', vcr: { cassette_name: 'search_with_query' } do
+      response = client.search(query: 'Nicolas')
+      expect(response.results.size).to eq 1
+    end
+
+    it 'paginated search', vcr: { cassette_name: 'paginated_search' } do
+      results = []
+      client.search(page_size: 2) do |page|
+        results.concat page.results
+      end
+      expect(results.size).to eq 2
+    end
+  end
+end

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

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

data/spec/notion/pagination/cursor_spec.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe Notion::Api::Pagination::Cursor do
+  let(:client) { Notion::Client.new }
+
+  context 'default cursor' do
+    let(:cursor) { described_class.new(client, 'users_list', {}) }
+
+    it 'provides a default page_size' do
+      expect(client).to receive(:users_list).with(page_size: 100)
+      cursor.first
+    end
+
+    it 'handles blank response metadata' do
+      expect(client).to receive(:users_list).once.and_return(Notion::Messages::Message.new)
+      cursor.to_a
+    end
+
+    it 'handles nil response metadata' do
+      expect(client).to(
+        receive(:users_list).once.and_return(Notion::Messages::Message.new(response: nil))
+      )
+      cursor.to_a
+    end
+
+    it 'paginates with a cursor inside response metadata' do
+      expect(client).to receive(:users_list).twice.and_return(
+        Notion::Messages::Message.new(has_more: true, next_cursor: 'next'),
+        Notion::Messages::Message.new
+      )
+      expect(cursor).not_to receive(:sleep)
+      cursor.to_a
+    end
+
+    context 'with rate limiting' do
+      let(:error) { Notion::Api::Errors::TooManyRequests.new({}) }
+
+      context 'with default max retries' do
+        it 'sleeps after a TooManyRequestsError' do
+          expect(client).to(
+            receive(:users_list)
+              .with(page_size: 100)
+              .ordered
+              .and_return(Notion::Messages::Message.new({ has_more: true, next_cursor: 'next' }))
+          )
+          expect(client).to(
+            receive(:users_list).with(page_size: 100, start_cursor: 'next').and_raise(error)
+          )
+          expect(cursor).to receive(:sleep).once.ordered.with(10)
+          expect(client).to(
+            receive(:users_list)
+              .with(page_size: 100, start_cursor: 'next')
+              .ordered
+              .and_return(Notion::Messages::Message.new)
+          )
+          cursor.to_a
+        end
+      end
+
+      context 'with a custom max_retries' do
+        let(:cursor) { described_class.new(client, 'users_list', max_retries: 4) }
+
+        it 'raises the error after hitting the max retries' do
+          expect(client).to(
+            receive(:users_list)
+              .with(page_size: 100)
+              .and_return(Notion::Messages::Message.new({ has_more: true, next_cursor: 'next' }))
+          )
+          expect(client).to(
+            receive(:users_list).with(page_size: 100, start_cursor: 'next').exactly(5).times.and_raise(error)
+          )
+          expect(cursor).to receive(:sleep).exactly(4).times.with(10)
+          expect { cursor.to_a }.to raise_error(error)
+        end
+      end
+
+      context 'with a custom retry_after' do
+        let(:cursor) { described_class.new(client, 'users_list', retry_after: 5) }
+
+        it 'sleeps for retry_after seconds after a TooManyRequestsError' do
+          expect(client).to(
+            receive(:users_list)
+              .with(page_size: 100)
+              .ordered
+              .and_return(Notion::Messages::Message.new({ has_more: true, next_cursor: 'next' }))
+          )
+          expect(client).to(
+            receive(:users_list).with(page_size: 100, start_cursor: 'next').ordered.and_raise(error)
+          )
+          expect(cursor).to receive(:sleep).once.ordered.with(5)
+          expect(client).to(
+            receive(:users_list)
+              .with(page_size: 100, start_cursor: 'next')
+              .ordered
+              .and_return(Notion::Messages::Message.new)
+          )
+          cursor.to_a
+        end
+      end
+    end
+  end
+
+  context 'with a custom page_size' do
+    let(:cursor) { described_class.new(client, 'users_list', page_size: 42) }
+
+    it 'overrides default page_size' do
+      expect(client).to receive(:users_list).with(page_size: 42)
+      cursor.first
+    end
+  end
+
+  context 'with a custom sleep_interval' do
+    let(:cursor) { described_class.new(client, 'users_list', sleep_interval: 3) }
+
+    it 'sleeps between requests' do
+      expect(client).to receive(:users_list).exactly(3).times.and_return(
+        Notion::Messages::Message.new(has_more: true, next_cursor: 'next_a'),
+        Notion::Messages::Message.new(has_more: true, next_cursor: 'next_b'),
+        Notion::Messages::Message.new
+      )
+      expect(cursor).to receive(:sleep).with(3).twice
+      cursor.to_a
+    end
+  end
+end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: notion-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0.pre.beta1
 platform: ruby
 authors:
 - Nicolas Goutay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-27 00:00:00.000000000 Z
+date: 2021-08-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -171,8 +199,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
+- ".gitignore"
 - ".rspec"
-- ".rspec_status"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - CHANGELOG.md
@@ -182,17 +210,20 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- bin/console
 - lib/notion-ruby-client.rb
 - lib/notion.rb
 - lib/notion/api/endpoints.rb
 - lib/notion/api/endpoints/blocks.rb
 - lib/notion/api/endpoints/databases.rb
 - lib/notion/api/endpoints/pages.rb
+- lib/notion/api/endpoints/search.rb
 - lib/notion/api/endpoints/users.rb
 - lib/notion/api/error.rb
 - lib/notion/api/errors.rb
 - lib/notion/api/errors/internal_error.rb
 - lib/notion/api/errors/notion_error.rb
+- lib/notion/api/errors/too_many_requests.rb
 - lib/notion/client.rb
 - lib/notion/config.rb
 - lib/notion/faraday/connection.rb
@@ -204,10 +235,8 @@ files:
 - lib/notion/pagination/cursor.rb
 - lib/notion/version.rb
 - lib/notion_ruby_client.rb
-- notion-ruby-client-0.0.4.gem
 - notion-ruby-client.gemspec
-- scratchpad.rb
-- screenshots/create_notion_bot.png
+- spec/fixtures/notion/block.yml
 - spec/fixtures/notion/block_append_children.yml
 - spec/fixtures/notion/block_children.yml
 - spec/fixtures/notion/create_database.yml
@@ -219,15 +248,22 @@ files:
 - spec/fixtures/notion/paginated_block_children.yml
 - spec/fixtures/notion/paginated_database_query.yml
 - spec/fixtures/notion/paginated_databases_list.yml
+- spec/fixtures/notion/paginated_search.yml
 - spec/fixtures/notion/paginated_users_list.yml
+- spec/fixtures/notion/search.yml
+- spec/fixtures/notion/search_with_query.yml
+- spec/fixtures/notion/update_block.yml
+- spec/fixtures/notion/update_database.yml
 - spec/fixtures/notion/update_page.yml
 - spec/fixtures/notion/users.yml
 - spec/fixtures/notion/users_list.yml
 - spec/notion/api/endpoints/blocks_spec.rb
 - spec/notion/api/endpoints/databases_spec.rb
 - spec/notion/api/endpoints/pages_spec.rb
+- spec/notion/api/endpoints/search_spec.rb
 - spec/notion/api/endpoints/users_spec.rb
 - spec/notion/config_spec.rb
+- spec/notion/pagination/cursor_spec.rb
 - spec/notion/version_spec.rb
 - spec/spec_helper.rb
 - spec/support/token.rb
@@ -256,6 +292,7 @@ signing_key:
 specification_version: 4
 summary: Notion API client for Ruby.
 test_files:
+- spec/fixtures/notion/block.yml
 - spec/fixtures/notion/block_append_children.yml
 - spec/fixtures/notion/block_children.yml
 - spec/fixtures/notion/create_database.yml
@@ -267,15 +304,22 @@ test_files:
 - spec/fixtures/notion/paginated_block_children.yml
 - spec/fixtures/notion/paginated_database_query.yml
 - spec/fixtures/notion/paginated_databases_list.yml
+- spec/fixtures/notion/paginated_search.yml
 - spec/fixtures/notion/paginated_users_list.yml
+- spec/fixtures/notion/search.yml
+- spec/fixtures/notion/search_with_query.yml
+- spec/fixtures/notion/update_block.yml
+- spec/fixtures/notion/update_database.yml
 - spec/fixtures/notion/update_page.yml
 - spec/fixtures/notion/users.yml
 - spec/fixtures/notion/users_list.yml
 - spec/notion/api/endpoints/blocks_spec.rb
 - spec/notion/api/endpoints/databases_spec.rb
 - spec/notion/api/endpoints/pages_spec.rb
+- spec/notion/api/endpoints/search_spec.rb
 - spec/notion/api/endpoints/users_spec.rb
 - spec/notion/config_spec.rb
+- spec/notion/pagination/cursor_spec.rb
 - spec/notion/version_spec.rb
 - spec/spec_helper.rb
 - spec/support/token.rb