notionrb 1.3.0

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+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 Unauthorized < NotionError; end
+
+      ERROR_CLASSES = {
+        'bad_request' => BadRequest,
+        'forbidden' => Forbidden,
+        'internal_error' => InternalError,
+        'invalid_request' => InvalidRequest,
+        'object_not_found' => ObjectNotFound,
+        'unauthorized' => Unauthorized
+      }.freeze
+    end
+  end
+end

data/lib/notion/client.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+module Notion
+  class Client
+    include Faraday::Connection
+    include Faraday::Request
+    include Api::Endpoints
+
+    attr_accessor(*Config::ATTRIBUTES)
+
+    def initialize(options = {})
+      Notion::Config::ATTRIBUTES.each do |key|
+        send("#{key}=", options.fetch(key, Notion.config.send(key)))
+      end
+      @logger ||= Notion::Config.logger || Notion::Logger.default
+      @token ||= Notion.config.token
+    end
+
+    class << self
+      def configure
+        block_given? ? yield(Config) : Config
+      end
+
+      def config
+        Config
+      end
+    end
+  end
+end

data/lib/notion/config.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+module Notion
+  module Config
+    extend self
+
+    ATTRIBUTES = %i[
+      proxy
+      user_agent
+      ca_path
+      ca_file
+      logger
+      endpoint
+      token
+      timeout
+      open_timeout
+      default_page_size
+      default_max_retries
+      default_retry_after
+      adapter
+    ].freeze
+
+    attr_accessor(*Config::ATTRIBUTES)
+
+    def reset
+      self.endpoint = 'https://api.notion.com/v1'
+      self.user_agent = "Notion Ruby Client/#{Notion::VERSION}"
+      self.ca_path = nil
+      self.ca_file = nil
+      self.token = nil
+      self.proxy = nil
+      self.logger = nil
+      self.timeout = nil
+      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
+
+    reset
+  end
+
+  class << self
+    def configure
+      block_given? ? yield(Config) : Config
+    end
+
+    def config
+      Config
+    end
+  end
+end
+
+Notion::Config.reset

data/lib/notion/faraday/connection.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+module Notion
+  module Faraday
+    module Connection
+      private
+
+      def connection
+        @connection ||=
+          begin
+            options = {
+              headers: { 'Accept' => 'application/json; charset=utf-8' }
+            }
+
+            options[:headers]['User-Agent'] = user_agent if user_agent
+            options[:proxy] = proxy if proxy
+            options[:ssl] = { ca_path: ca_path, ca_file: ca_file } if ca_path || ca_file
+
+            request_options = {}
+            request_options[:timeout] = timeout if timeout
+            request_options[:open_timeout] = open_timeout if open_timeout
+            options[:request] = request_options if request_options.any?
+
+            ::Faraday::Connection.new(endpoint, options) do |connection|
+              connection.use ::Faraday::Multipart::Middleware
+              connection.use ::Faraday::Request::UrlEncoded
+              connection.use ::Notion::Faraday::Response::RaiseError
+              connection.use ::Faraday::Mashify::Middleware, mash_class: Notion::Messages::Message
+              connection.use ::Faraday::Response::Json
+              connection.use ::Notion::Faraday::Response::WrapError
+              connection.response :logger, logger if logger
+              connection.adapter adapter
+            end
+          end
+      end
+    end
+  end
+end

data/lib/notion/faraday/request.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+module Notion
+  module Faraday
+    module Request
+      def get(path, options = {})
+        request(:get, path, options)
+      end
+
+      def patch(path, options = {})
+        request(:patch, path, options)
+      end
+
+      def post(path, options = {})
+        request(:post, path, options)
+      end
+
+      def put(path, options = {})
+        request(:put, path, options)
+      end
+
+      def delete(path, options = {})
+        request(:delete, path, options)
+      end
+
+      private
+
+      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, :patch
+            request.headers['Content-Type'] = 'application/json'
+            request.path = path
+            request.body = options.to_json unless options.empty?
+          end
+          request.options.merge!(options.delete(:request)) if options.key?(:request)
+        end
+        response.body
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+module Notion
+  module Faraday
+    module Response
+      class RaiseError < ::Faraday::Response::Json
+        def on_complete(env)
+          raise Notion::Api::Errors::TooManyRequests, env.response if env.status == 429
+
+          return if env.success?
+
+          body = env.body
+          return unless body
+
+          error_code = body['code']
+          error_message = body['message']
+          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, error_details, env.response)
+        end
+
+        def call(env)
+          super
+        rescue ::Faraday::ParsingError
+          raise Notion::Api::Errors::ParsingError.new('parsing_error', env.response)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module Notion
+  module Faraday
+    module Response
+      class WrapError < ::Faraday::Response::Json
+        UNAVAILABLE_ERROR_STATUSES = (500..599).freeze
+
+        def on_complete(env)
+          return unless UNAVAILABLE_ERROR_STATUSES.cover?(env.status)
+
+          raise Notion::Api::Errors::UnavailableError.new('unavailable_error', env.response)
+        end
+
+        def call(env)
+          super
+        rescue ::Faraday::TimeoutError, ::Faraday::ConnectionFailed
+          raise Notion::Api::Errors::TimeoutError.new('timeout_error', env.response)
+        end
+      end
+    end
+  end
+end

data/lib/notion/logger.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'logger'
+
+module Notion
+  class Logger < ::Logger
+    def self.default
+      return @default if @default
+
+      logger = new STDOUT
+      logger.level = Logger::WARN
+      @default = logger
+    end
+  end
+end

data/lib/notion/messages/message.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module Notion
+  module Messages
+    class Message < Hashie::Mash
+      def to_s
+        keys.sort_by(&:to_s).map do |key|
+          "#{key}=#{self[key]}"
+        end.join(', ')
+      end
+
+      private
+
+      # see https://github.com/intridea/hashie/issues/394
+      def log_built_in_message(*); end
+    end
+  end
+end

data/lib/notion/pagination/cursor.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+module Notion
+  module Api
+    module Pagination
+      class Cursor
+        include Enumerable
+
+        attr_reader :client
+        attr_reader :verb
+        attr_reader :sleep_interval
+        attr_reader :max_retries
+        attr_reader :retry_after
+        attr_reader :params
+
+        def initialize(client, verb, params = {})
+          @client = client
+          @verb = verb
+          @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 = { 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
+              raise e if retry_count >= max_retries
+
+              client.logger.debug("#{self.class}##{__method__}") { e.to_s }
+              retry_count += 1
+              sleep(retry_after)
+              next
+            end
+            yield response
+            break unless response.has_more
+
+            next_cursor = response.next_cursor
+            break if next_cursor.nil? || next_cursor == ''
+
+            retry_count = 0
+            sleep(sleep_interval) if sleep_interval
+          end
+        end
+      end
+    end
+  end
+end

data/lib/notion/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module Notion
+  VERSION = '1.3.0'
+  NOTION_REQUEST_VERSION = '2025-09-03'
+end

data/lib/notion-ruby-client.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+require 'faraday'
+require 'faraday/mashify'
+require 'faraday/multipart'
+require 'json'
+require 'logger'
+require 'hashie'
+
+require_relative 'notion/version'
+require_relative 'notion/logger'
+require_relative 'notion/config'
+
+# Messages
+require_relative 'notion/messages/message'
+
+require_relative 'notion/config'
+require_relative 'notion/api/errors/notion_error'
+require_relative 'notion/api/error'
+require_relative 'notion/api/errors'
+require_relative 'notion/api/errors/internal_error'
+require_relative 'notion/api/errors/too_many_requests'
+require_relative 'notion/faraday/response/raise_error'
+require_relative 'notion/faraday/response/wrap_error'
+require_relative 'notion/faraday/connection'
+require_relative 'notion/faraday/request'
+require_relative 'notion/api/endpoints'
+require_relative 'notion/pagination/cursor'
+require_relative 'notion/client'

data/lib/notion.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require 'notion-ruby-client'

data/lib/notion_ruby_client.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require 'notion-ruby-client'

data/notionrb.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'notion/version'
+
+Gem::Specification.new do |s|
+  s.name = 'notionrb'
+  s.version = Notion::VERSION
+  s.authors = ['Nicolas Goutay', 'Ivan Lyubchenko']
+  s.email = 'lubchenko2044@gmail.com'
+  s.platform = Gem::Platform::RUBY
+  s.required_rubygems_version = '>= 1.3.6'
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ['lib']
+  s.homepage = 'https://github.com/lyubchenko-ivan/notion-ruby-client'
+  s.licenses = ['MIT']
+  s.summary = 'Notion API client for Ruby.'
+  s.add_dependency 'faraday', '>= 2.0'
+  s.add_dependency 'faraday-mashify', '>= 0.1.1'
+  s.add_dependency 'faraday-multipart', '>= 1.0.4'
+  s.add_dependency 'hashie', '~> 5'
+  s.add_development_dependency 'dotenv'
+  s.add_development_dependency 'rake', '~> 13'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rubocop', '~> 0.82.0'
+  s.add_development_dependency 'rubocop-performance', '~> 1.5.2'
+  s.add_development_dependency 'rubocop-rspec', '~> 1.39.0'
+  s.add_development_dependency 'timecop'
+  s.add_development_dependency 'vcr'
+  s.add_development_dependency 'webmock'
+end

data/spec/fixtures/notion/block.yml

@@ -0,0 +1,146 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.notion.com/v1/blocks/32af3324-ba02-4516-ae88-5728a4d569f4
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      User-Agent:
+      - Notion Ruby Client/0.0.8
+      Authorization:
+      - Bearer <NOTION_API_TOKEN>
+      Notion-Version:
+      - '2022-02-22'
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sun, 29 Aug 2021 17:45:01 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      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://o324374.ingest.sentry.io https://checkout.stripe.com
+        https://js.stripe.com https://embed.typeform.com https://admin.typeform.com
+        https://public.profitwell.com js.sentry-cdn.com https://js.chilipiper.com
+        https://platform.twitter.com https://cdn.syndication.twimg.com https://www.googletagmanager.com
+        https://x.clearbitjs.com https://client-registry.mutinycdn.com https://client.mutinycdn.com/
+        https://user-data.mutinycdn.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://cdn.segment.com https://api.segment.io https://analytics.pgncs.notion.so
+        https://api.pgncs.notion.so https://o324374.ingest.sentry.io https://checkout.stripe.com
+        https://js.stripe.com https://cdn.contentful.com https://preview.contentful.com
+        https://images.ctfassets.net https://www2.profitwell.com https://tracking.chilipiper.com
+        https://api.chilipiper.com https://api.unsplash.com https://boards-api.greenhouse.io
+        https://user-data.mutinycdn.com https://api-v2.mutinyhq.io https://api.statuspage.io
+        https://pgncd.notion.so; 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://js.chilipiper.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://o324374.ingest.sentry.io https://checkout.stripe.com
+        https://js.stripe.com https://embed.typeform.com https://admin.typeform.com
+        https://public.profitwell.com js.sentry-cdn.com https://js.chilipiper.com
+        https://platform.twitter.com https://cdn.syndication.twimg.com https://www.googletagmanager.com
+        https://x.clearbitjs.com https://client-registry.mutinycdn.com https://client.mutinycdn.com/
+        https://user-data.mutinycdn.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://cdn.segment.com https://api.segment.io https://analytics.pgncs.notion.so
+        https://api.pgncs.notion.so https://o324374.ingest.sentry.io https://checkout.stripe.com
+        https://js.stripe.com https://cdn.contentful.com https://preview.contentful.com
+        https://images.ctfassets.net https://www2.profitwell.com https://tracking.chilipiper.com
+        https://api.chilipiper.com https://api.unsplash.com https://boards-api.greenhouse.io
+        https://user-data.mutinycdn.com https://api-v2.mutinyhq.io https://api.statuspage.io
+        https://pgncd.notion.so; 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://js.chilipiper.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://o324374.ingest.sentry.io https://checkout.stripe.com
+        https://js.stripe.com https://embed.typeform.com https://admin.typeform.com
+        https://public.profitwell.com js.sentry-cdn.com https://js.chilipiper.com
+        https://platform.twitter.com https://cdn.syndication.twimg.com https://www.googletagmanager.com
+        https://x.clearbitjs.com https://client-registry.mutinycdn.com https://client.mutinycdn.com/
+        https://user-data.mutinycdn.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://cdn.segment.com https://api.segment.io https://analytics.pgncs.notion.so
+        https://api.pgncs.notion.so https://o324374.ingest.sentry.io https://checkout.stripe.com
+        https://js.stripe.com https://cdn.contentful.com https://preview.contentful.com
+        https://images.ctfassets.net https://www2.profitwell.com https://tracking.chilipiper.com
+        https://api.chilipiper.com https://api.unsplash.com https://boards-api.greenhouse.io
+        https://user-data.mutinycdn.com https://api-v2.mutinyhq.io https://api.statuspage.io
+        https://pgncd.notion.so; 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://js.chilipiper.com https://platform.twitter.com
+        https://ton.twimg.com; frame-src https: http:; media-src https: http:'
+      Set-Cookie:
+      - notion_browser_id=5e3ae42a-9c10-4632-bbd6-f8635f637d51; Domain=www.notion.so;
+        Path=/; Expires=Wed, 07 May 2053 19:31:41 GMT; Secure
+      Etag:
+      - W/"1c9-RV2WR8+djapd2GV8p8VntQ5R7zI"
+      Vary:
+      - Accept-Encoding
+      Cf-Cache-Status:
+      - DYNAMIC
+      Expect-Ct:
+      - max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 68679732dfea3acb-CDG
+    body:
+      encoding: UTF-8
+      string: '{"object":"block","id":"32af3324-ba02-4516-ae88-5728a4d569f4","created_time":"2021-05-01T17:13:00.000Z","last_edited_time":"2021-08-29T17:18:00.000Z","has_children":true,"type":"paragraph","paragraph":{"rich_text":[{"type":"text","text":{"content":"A
+        paragraph with childrens","link":null},"annotations":{"bold":false,"italic":false,"strikethrough":false,"underline":false,"code":false,"color":"default"},"plain_text":"A
+        paragraph with childrens","href":null}]}}'
+  recorded_at: Sun, 29 Aug 2021 17:45:01 GMT
+recorded_with: VCR 6.0.0