notion-ruby-client 0.0.1 → 0.0.6

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require 'rubygems'
+require 'bundler'
+require 'bundler/gem_tasks'
+
+Bundler.setup :default, :development
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/notion-ruby-client.rb

@@ -1,18 +1,16 @@
 # frozen_string_literal: true
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
+require 'logger'
+require 'hashie'
+
 require_relative 'notion/version'
 require_relative 'notion/logger'
 require_relative 'notion/config'
 
 # Messages
-require 'hashie'
 require_relative 'notion/messages/message'
-require_relative 'notion/messages/formatting'
-
-# Web API
-require 'faraday'
-require 'faraday_middleware'
-require 'json'
-require 'logger'
 
 require_relative 'notion/config'
 require_relative 'notion/api/errors/notion_error'

data/lib/notion/api/endpoints.rb

@@ -1,10 +1,16 @@
 # frozen_string_literal: true
 
+require_relative 'endpoints/blocks'
+require_relative 'endpoints/databases'
+require_relative 'endpoints/pages'
 require_relative 'endpoints/users'
 
 module Notion
   module Api
     module Endpoints
+      include Blocks
+      include Databases
+      include Pages
       include Users
     end
   end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Notion
+  module Api
+    module Endpoints
+      module Blocks
+        #
+        # Returns a paginated array of Block objects contained in the
+        # block of the requested path using the ID specified.
+        #
+        # Returns a 404 HTTP response if any of the following are true:
+        # - the ID does not exist
+        # - the bot doesn't have access to the block with the given ID
+        #
+        # 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.
+        def block_children(options = {})
+          throw ArgumentError.new('Required arguments :id missing') if options[: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)
+          end
+        end
+
+        #
+        # Creates and appends new children blocks to the parent block
+        # in the requested path using the ID specified. Returns the Block
+        # object being appended to.
+        #
+        # Returns a 404 HTTP response if any of the following are true:
+        # - the ID does not exist
+        # - the bot doesn't have access to the block with the given ID
+        #
+        # 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 [[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)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+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.
+        #
+        # Filters are similar to the filters provided in the Notion UI. Filters operate
+        # on database properties and can be combined. If no filter is provided, all the
+        # pages in the database will be returned with pagination.
+        #
+        # Sorts are similar to the sorts provided in the Notion UI. Sorts operate on
+        # 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
+        #   Database to query.
+        #
+        # @option options [Object] :filter
+        #   When supplied, limits which pages are returned based on the provided criteria.
+        #
+        # @option options [[Object]] :sorts
+        #   When supplied, sorts the results based on the provided criteria.
+        #
+        # @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.
+        def database_query(options = {})
+          throw ArgumentError.new('Required arguments :id missing') if options[: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)
+          end
+        end
+
+        #
+        # Returns a paginated list of Databases objects for the workspace.
+        #
+        # @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.
+        def databases_list(options = {})
+          if block_given?
+            Pagination::Cursor.new(self, :databases_list, options).each do |page|
+              yield page
+            end
+          else
+            get('databases', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Notion
+  module Api
+    module Endpoints
+      module Pages
+        #
+        # 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
+        #   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]}")
+        end
+
+        #
+        # Creates a new page in the specified database.
+        # Later iterations of the API will support creating pages outside databases.
+        # Note that this iteration of the API will only expose page properties, not
+        # page content, as described in the data model.
+        #
+        # @option options [Object] :parent
+        #   Parent of the page, which is always going to be a database in this version of the API.
+        #
+        # @option options [Object] :properties
+        #   Properties of this page.
+        #   The schema for the page's keys and values is described by the properties of
+        #   the database this page belongs to. key string Name of a property as it
+        #   appears in Notion, or property ID. value object Object containing a value
+        #   specific to the property type, e.g. {"checkbox": true}.
+        #
+        # @option options [Object] :children
+        #   An optional array of Block objects representing the Page’s conent
+        def create_page(options = {})
+          throw ArgumentError.new('Required arguments :parent.database_id missing') if options.dig(:parent, :database_id).nil?
+          post("pages", options)
+        end
+
+        #
+        # Updates a page by setting the values of any properties specified in the
+        # JSON body of the request. Properties that are not set via parameters will
+        # remain unchanged.
+        #
+        # 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
+        #   Page to get info on.
+        #
+        # @option options [Object] :properties
+        #   Properties of this page.
+        #   The schema for the page's keys and values is described by the properties of
+        #   the database this page belongs to. key string Name of a property as it
+        #   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)
+        end
+      end
+    end
+  end
+end

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

@@ -16,15 +16,19 @@ module Notion
 
         #
         # Returns a paginated list of User objects for the workspace.
-        # @option options [Object] :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 [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.
         def users_list(options = {})
           if block_given?
             Pagination::Cursor.new(self, :users_list, options).each do |page|
               yield page
             end
           else
-            get("users?start_cursor=#{options[:start_cursor]}")
+            get("users", options)
           end
         end
       end

data/lib/notion/api/errors.rb

@@ -3,16 +3,22 @@
 module Notion
   module Api
     module Errors
+      class BadRequest < NotionError; end
+      class Forbidden < NotionError; end
       class InternalError < NotionError; end
       class InvalidRequest < NotionError; end
       class ObjectNotFound < NotionError; end
       class TooManyRequests < NotionError; end
+      class Unauthorized < NotionError; end
 
       ERROR_CLASSES = {
+        'bad_request' => BadRequest,
+        'forbidden' => Forbidden,
         'internal_error' => InternalError,
         'invalid_request' => InvalidRequest,
         'object_not_found' => ObjectNotFound,
-        'rate_limited' => TooManyRequests
+        'rate_limited' => TooManyRequests,
+        'unauthorized' => Unauthorized
       }.freeze
     end
   end

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

@@ -5,8 +5,8 @@ module Notion
       class NotionError < ::Faraday::Error
         attr_reader :response
 
-        def initialize(message, response = nil)
-          super message
+        def initialize(message, details, response = nil)
+          super("#{message} #{details}")
           @response = response
         end
       end

data/lib/notion/config.rb

@@ -47,4 +47,6 @@ module Notion
       Config
     end
   end
-end
+end
+
+Notion::Config.reset

data/lib/notion/faraday/request.rb

@@ -6,6 +6,10 @@ module Notion
         request(:get, path, options)
       end
 
+      def patch(path, options = {})
+        request(:patch, path, options)
+      end
+
       def post(path, options = {})
         request(:post, path, options)
       end
@@ -23,12 +27,14 @@ 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)
-          when :post, :put
+          when :post, :put, :patch
+            request.headers['Content-Type'] = 'application/json'
             request.path = path
-            request.body = options unless options.empty?
+            request.body = options.to_json unless options.empty?
           end
           request.options.merge!(options.delete(:request)) if options.key?(:request)
         end

data/lib/notion/faraday/response/raise_error.rb

@@ -6,19 +6,18 @@ module Notion
         def on_complete(env)
           raise Notion::Api::Errors::TooManyRequests, env.response if env.status == 429
 
-          return unless env.success?
+          return if env.success?
 
           body = env.body
           return unless body
-          return if env.status == 200
 
           error_code = body['code']
           error_message = body['message']
-          error_message = body['details']
+          error_details = body['details']
 
           error_class = Notion::Api::Errors::ERROR_CLASSES[error_code]
           error_class ||= Notion::Api::Errors::NotionError
-          raise error_class.new(error_message, env.response)
+          raise error_class.new(error_message, error_details, env.response)
         end
 
         def call(env)

data/lib/notion/pagination/cursor.rb

@@ -23,10 +23,10 @@ module Notion
           next_cursor = nil
           retry_count = 0
           loop do
-            query = { limit: client.default_page_size }.merge(params).merge(start_cursor: next_cursor)
+            query = next_cursor.nil? ? params : params.merge(start_cursor: next_cursor)
             begin
               response = client.send(verb, query)
-            rescue Notion::Api::Errors::TooManyRequestsError => e
+            rescue Notion::Api::Errors::TooManyRequests => e
               raise e if retry_count >= max_retries
 
               client.logger.debug("#{self.class}##{__method__}") { e.to_s }

data/lib/notion/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 module Notion
-  VERSION = '0.0.1'
-end
+  VERSION = '0.0.6'
+  NOTION_REQUEST_VERSION = '2021-05-11'
+end

data/spec/fixtures/notion/block_append_children.yml

@@ -0,0 +1,135 @@
+---
+http_interactions:
+- request:
+    method: patch
+    uri: https://api.notion.com/v1/blocks/723578f1-6e51-450c-8ee1-09158c19fd4c/children
+    body:
+      encoding: UTF-8
+      string: '{"id":"723578f1-6e51-450c-8ee1-09158c19fd4c","children":[{"object":"block","type":"heading_2","heading_2":{"text":[{"type":"text","text":{"content":"Another
+        Heading"}}]}}]}'
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      User-Agent:
+      - Notion Ruby Client/0.0.4
+      Authorization:
+      - Bearer <NOTION_API_TOKEN>
+      Content-Type:
+      - application/json
+      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:05:49 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cfduid=d34e3fa5c4766df6ac5561da522624b761619384749; expires=Tue, 25-May-21
+        21:05:49 GMT; path=/; domain=.notion.com; HttpOnly; SameSite=Lax
+      - notion_browser_id=e006545d-4f97-4497-8d9c-491386cb6d2a; Domain=www.notion.so;
+        Path=/; Expires=Wed, 01 Jan 2053 22:52:29 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/"e5-DFeqv/gYemlg3XfmjAU4nnWmtn8"
+      Vary:
+      - Accept-Encoding
+      Cf-Cache-Status:
+      - DYNAMIC
+      Cf-Request-Id:
+      - '09ac73642e00000818408a7000000001'
+      Expect-Ct:
+      - max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 645a8819e9030818-CDG
+    body:
+      encoding: UTF-8
+      string: '{"object":"block","id":"723578f1-6e51-450c-8ee1-09158c19fd4c","created_time":"2021-01-29T20:50:51.917Z","last_edited_time":"2021-04-25T21:05:49.706Z","has_children":true,"type":"child_page","child_page":{"title":"A
+        Notion page"}}'
+  recorded_at: Sun, 25 Apr 2021 21:05:49 GMT
+recorded_with: VCR 6.0.0