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

data/bin/console

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "dotenv/load"
+require "notion-ruby-client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+
+def reload!(print = true)
+  puts 'Reloading ...' if print
+  # Main project directory.
+  root_dir = File.expand_path('..', __dir__)
+  # Directories within the project that should be reloaded.
+  reload_dirs = %w{lib}
+  # Loop through and reload every file in all relevant project directories.
+  reload_dirs.each do |dir|
+    Dir.glob("#{root_dir}/#{dir}/**/*.rb").each { |f| load(f) }
+  end
+  # Return true when complete.
+  true
+end
+
+IRB.start(__FILE__)

data/lib/notion/api/endpoints/blocks.rb

@@ -4,6 +4,34 @@ module Notion
   module Api
     module Endpoints
       module Blocks
+        #
+        # Retrieves a Block object using the ID specified.
+        #
+        # @option options [id] :block_id
+        #   Block to get children info on.
+        def block(options = {})
+          throw ArgumentError.new('Required arguments :block_id missing') if options[:block_id].nil?
+          get("blocks/#{options[:block_id]}")
+        end
+
+        #
+        # Updates the content for the specified block_id based on
+        # the block type. Supported fields based on the block object
+        # type (see Block object for available fields and the
+        # expected input for each field).
+        #
+        # @option options [id] :block_id
+        #   Block to get children info on.
+        #
+        # @option options [string] {type}
+        #   The block object type value with the properties to be
+        #   updated. Currently only text (for supported block types)
+        #   and checked (for to_do blocks) fields can be updated.
+        def update_block(options = {})
+          throw ArgumentError.new('Required arguments :block_id missing') if options[:block_id].nil?
+          patch("blocks/#{options[:block_id]}", options.except(:block_id))
+        end
+
         #
         # Returns a paginated array of Block objects contained in the
         # block of the requested path using the ID specified.
@@ -14,16 +42,16 @@ module Notion
         #
         # Returns a 400 or 429 HTTP response if the request exceeds Notion's Request limits.
         #
-        # @option options [id] :id
+        # @option options [id] :block_id
         #   Block to get children info on.
         def block_children(options = {})
-          throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
+          throw ArgumentError.new('Required arguments :block_id missing') if options[:block_id].nil?
           if block_given?
             Pagination::Cursor.new(self, :block_children, options).each do |page|
               yield page
             end
           else
-            get("blocks/#{options[:id]}/children", options)
+            get("blocks/#{options[:block_id]}/children", options.except(:block_id))
           end
         end
 
@@ -38,14 +66,14 @@ module Notion
         #
         # Returns a 400 or 429 HTTP response if the request exceeds Notion's Request limits.
         #
-        # @option options [id] :id
-        #   Block to get children info on.
+        # @option options [id] :block_id
+        #   Block to append children to.
         #
         # @option options [[Object]] :children
         #   Children blocks to append
         def block_append_children(options = {})
-          throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
-          patch("blocks/#{options[:id]}/children", options)
+          throw ArgumentError.new('Required arguments :block_id missing') if options[:block_id].nil?
+          patch("blocks/#{options[:block_id]}/children", options.except(:block_id))
         end
       end
     end

data/lib/notion/api/endpoints/databases.rb

@@ -4,20 +4,6 @@ module Notion
   module Api
     module Endpoints
       module Databases
-        #
-        # Retrieves a Database object using the ID specified in the request.
-        #
-        # Returns a 404 HTTP response if the database doesn't exist, or if the bot
-        # doesn't have access to the database. Returns a 429 HTTP response if the
-        # request exceeds Notion's Request limits.
-        #
-        # @option options [id] :id
-        #   Database to get info on.
-        def database(options = {})
-          throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
-          get("databases/#{options[:id]}")
-        end
-
         #
         # Gets a paginated array of Page object s contained in the requested database,
         # filtered and ordered according to the filter and sort objects provided in the request.
@@ -30,7 +16,7 @@ module Notion
         # database properties and can be combined. The order of the sorts in the request
         # matter, with earlier sorts taking precedence over later ones.
         #
-        # @option options [id] :id
+        # @option options [id] :database_id
         #   Database to query.
         #
         # @option options [Object] :filter
@@ -44,17 +30,78 @@ module Notion
         #   to a start_cursor attribute returned by a previous request's next_cursor.
         #   Default value fetches the first "page" of the collection.
         #   See pagination for more detail.
+        #
+        # @option options [integer] :page_size
+        #   The number of items from the full list desired in the response. Maximum: 100
         def database_query(options = {})
-          throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
+          throw ArgumentError.new('Required arguments :database_id missing') if options[:database_id].nil?
           if block_given?
             Pagination::Cursor.new(self, :database_query, options).each do |page|
               yield page
             end
           else
-            post("databases/#{options[:id]}/query", options)
+            post("databases/#{options[:database_id]}/query", options.except(:database_id))
           end
         end
 
+        #
+        # Creates a new database in the specified page.
+        #
+        # @option options [Object] :parent
+        #   Parent of the database, which is always going to be a page.
+        #
+        # @option options [Object] :title
+        #   Title of this database.
+        #
+        # @option options [Object] :properties
+        #   Property schema of database.
+        #   The keys are the names of properties as they appear in Notion and the values are
+        #   property schema objects. Property Schema Object is a metadata that controls
+        #   how a database property behaves, e.g. {"checkbox": {}}.
+        #   Each database must have exactly one database property schema object of type "title".
+        def create_database(options = {})
+          throw ArgumentError.new('Required arguments :parent.page_id missing') if options.dig(:parent, :page_id).nil?
+          throw ArgumentError.new('Required arguments :title missing') if options.dig(:title).nil?
+          throw ArgumentError.new('Required arguments :properties missing') if options.dig(:properties).nil?
+          post('databases', options)
+        end
+
+        #
+        # Updates an existing database as specified by the parameters.
+        #
+        # @option options [id] :database_id
+        #   Database to update.
+        #
+        # @option options [Object] :title
+        #   Title of database as it appears in Notion. An array of rich text objects.
+        #   If omitted, the database title will remain unchanged.
+        #
+        # @option options [Object] :properties
+        #   Updates to the property schema of a database.
+        #   If updating an existing property, the keys are the names or IDs
+        #   of the properties as they appear in Notion and the values
+        #   are property schema objects. If adding a new property, the key is
+        #   the name of the database property and the value is a property schema object.
+        #
+        def update_database(options = {})
+          throw ArgumentError.new('Required arguments :database_id missing') if options.dig(:database_id).nil?
+          patch("databases/#{options[:database_id]}", options.except(:database_id))
+        end
+
+        #
+        # Retrieves a Database object using the ID specified in the request.
+        #
+        # Returns a 404 HTTP response if the database doesn't exist, or if the bot
+        # doesn't have access to the database. Returns a 429 HTTP response if the
+        # request exceeds Notion's Request limits.
+        #
+        # @option options [id] :database_id
+        #   Database to get info on.
+        def database(options = {})
+          throw ArgumentError.new('Required arguments :database_id missing') if options[:database_id].nil?
+          get("databases/#{options[:database_id]}")
+        end
+
         #
         # Returns a paginated list of Databases objects for the workspace.
         #
@@ -63,6 +110,9 @@ module Notion
         # to a start_cursor attribute returned by a previous request's next_cursor.
         # Default value fetches the first "page" of the collection.
         # See pagination for more detail.
+        #
+        # @option options [integer] :page_size
+        #   The number of items from the full list desired in the response. Maximum: 100
         def databases_list(options = {})
           if block_given?
             Pagination::Cursor.new(self, :databases_list, options).each do |page|

data/lib/notion/api/endpoints/pages.rb

@@ -8,15 +8,15 @@ module Notion
         # Retrieves a 📄Page object  using the ID specified in the request path.
         # Note that this version of the API only exposes page properties, not page content
         #
-        # @option options [id] :id
+        # @option options [id] :page_id
         #   Page to get info on.
         #
         # @option options [bool] :archived
         #   Set to true to retrieve an archived page; must be false or omitted to
         #   retrieve a page that has not been archived. Defaults to false.
         def page(options = {})
-          throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
-          get("pages/#{options[:id]}?archived=#{options[:archived]}")
+          throw ArgumentError.new('Required arguments :page_id missing') if options[:page_id].nil?
+          get("pages/#{options[:page_id]}")
         end
 
         #
@@ -36,7 +36,7 @@ module Notion
         #   specific to the property type, e.g. {"checkbox": true}.
         #
         # @option options [Object] :children
-        #   An optional array of Block objects representing the Page’s conent
+        #   An optional array of Block objects representing the Page’s content
         def create_page(options = {})
           throw ArgumentError.new('Required arguments :parent.database_id missing') if options.dig(:parent, :database_id).nil?
           post("pages", options)
@@ -50,7 +50,7 @@ module Notion
         # Note that this iteration of the API will only expose page properties, not page
         # content, as described in the data model.
         #
-        # @option options [id] :id
+        # @option options [id] :page_id
         #   Page to get info on.
         #
         # @option options [Object] :properties
@@ -60,8 +60,8 @@ module Notion
         #   appears in Notion, or property ID. value object Object containing a value
         #   specific to the property type, e.g. {"checkbox": true}.
         def update_page(options = {})
-          throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
-          patch("pages/#{options[:id]}", options)
+          throw ArgumentError.new('Required arguments :page_id missing') if options[:page_id].nil?
+          patch("pages/#{options[:page_id]}", options.except(:page_id))
         end
       end
     end

data/lib/notion/api/endpoints/search.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Notion
+  module Api
+    module Endpoints
+      module Search
+        #
+        # Searches all pages and child pages that are shared with the integration.
+        # The results may include databases.
+        #
+        # @option options [string] :query
+        #   When supplied, limits which pages are returned by comparing the query to the page title.
+        #
+        # @option options [Object] :filter
+        #   When supplied, filters the results based on the provided criteria.
+        #
+        # @option options [[Object]] :sorts
+        #   When supplied, sorts the results based on the provided criteria.
+        #   Limitation: Currently only a single sort is allowed and is limited to last_edited_time.
+        #
+        # @option options [UUID] :start_cursor
+        #   Paginate through collections of data by setting the cursor parameter
+        #   to a start_cursor attribute returned by a previous request's next_cursor.
+        #   Default value fetches the first "page" of the collection.
+        #   See pagination for more detail.
+        #
+        # @option options [integer] :page_size
+        #   The number of items from the full list desired in the response. Maximum: 100
+        def search(options = {})
+          if block_given?
+            Pagination::Cursor.new(self, :search, options).each do |page|
+              yield page
+            end
+          else
+            post('search', options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/notion/api/endpoints/users.rb

@@ -7,11 +7,11 @@ module Notion
         #
         # Retrieves a User object using the ID specified in the request.
         #
-        # @option options [id] :id
+        # @option options [id] :user_id
         #   User to get info on.
         def user(options = {})
-          throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
-          get("users/#{options[:id]}")
+          throw ArgumentError.new('Required arguments :user_id missing') if options[:user_id].nil?
+          get("users/#{options[:user_id]}")
         end
 
         #
@@ -22,6 +22,9 @@ module Notion
         # to a start_cursor attribute returned by a previous request's next_cursor.
         # Default value fetches the first "page" of the collection.
         # See pagination for more detail.
+        #
+        # @option options [integer] :page_size
+        #   The number of items from the full list desired in the response. Maximum: 100
         def users_list(options = {})
           if block_given?
             Pagination::Cursor.new(self, :users_list, options).each do |page|

data/lib/notion/api/endpoints.rb

@@ -4,6 +4,7 @@ require_relative 'endpoints/blocks'
 require_relative 'endpoints/databases'
 require_relative 'endpoints/pages'
 require_relative 'endpoints/users'
+require_relative 'endpoints/search'
 
 module Notion
   module Api
@@ -12,6 +13,7 @@ module Notion
       include Databases
       include Pages
       include Users
+      include Search
     end
   end
-end
+end

data/lib/notion/api/errors/too_many_requests.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Notion
+  module Api
+    module Errors
+      class TooManyRequests < ::Faraday::Error
+        attr_reader :response
+
+        def initialize(response)
+          @response = response
+          super 'Too many requests'
+        end
+      end
+    end
+  end
+end

data/lib/notion/api/errors.rb

@@ -8,7 +8,6 @@ module Notion
       class InternalError < NotionError; end
       class InvalidRequest < NotionError; end
       class ObjectNotFound < NotionError; end
-      class TooManyRequests < NotionError; end
       class Unauthorized < NotionError; end
 
       ERROR_CLASSES = {
@@ -17,7 +16,6 @@ module Notion
         'internal_error' => InternalError,
         'invalid_request' => InvalidRequest,
         'object_not_found' => ObjectNotFound,
-        'rate_limited' => TooManyRequests,
         'unauthorized' => Unauthorized
       }.freeze
     end

data/lib/notion/config.rb

@@ -15,6 +15,7 @@ module Notion
       open_timeout
       default_page_size
       default_max_retries
+      default_retry_after
       adapter
     ].freeze
 
@@ -32,6 +33,7 @@ module Notion
       self.open_timeout = nil
       self.default_page_size = 100
       self.default_max_retries = 100
+      self.default_retry_after = 10
       self.adapter = ::Faraday.default_adapter
     end
 

data/lib/notion/faraday/request.rb

@@ -27,6 +27,7 @@ module Notion
       def request(method, path, options)
         response = connection.send(method) do |request|
           request.headers['Authorization'] = "Bearer #{token}"
+          request.headers['Notion-Version'] = Notion::NOTION_REQUEST_VERSION
           case method
           when :get, :delete
             request.url(path, options)

data/lib/notion/pagination/cursor.rb

@@ -9,6 +9,7 @@ module Notion
         attr_reader :verb
         attr_reader :sleep_interval
         attr_reader :max_retries
+        attr_reader :retry_after
         attr_reader :params
 
         def initialize(client, verb, params = {})
@@ -17,13 +18,15 @@ module Notion
           @params = params.dup
           @sleep_interval = @params.delete(:sleep_interval)
           @max_retries = @params.delete(:max_retries) || client.default_max_retries
+          @retry_after = @params.delete(:retry_after) || client.default_retry_after
         end
 
         def each
           next_cursor = nil
           retry_count = 0
           loop do
-            query = next_cursor.nil? ? params : params.merge(start_cursor: next_cursor)
+            query = { page_size: client.default_page_size }.merge(params)
+            query = query.merge(start_cursor: next_cursor) unless next_cursor.nil?
             begin
               response = client.send(verb, query)
             rescue Notion::Api::Errors::TooManyRequests => e
@@ -31,7 +34,7 @@ module Notion
 
               client.logger.debug("#{self.class}##{__method__}") { e.to_s }
               retry_count += 1
-              sleep(e.retry_after)
+              sleep(retry_after)
               next
             end
             yield response