notion-ruby-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c7b5900bd2cb236225f473631b1ee926827a33616a88640925ca18e6e185a3d1
+  data.tar.gz: 4305a9c2c648830f3e28a3e9cb5bc3e1ad71dec502ef3adc853d661dfcd0983b
+SHA512:
+  metadata.gz: 62c41933e6d555c26e366ac86ed551e0c4d903c57f9d69bd2904b8139bcebbcd614ce0fdcc79ae60e4107a8b3a7536e1ea568a39db159cd2badc15964fe2f841
+  data.tar.gz: aba7f94cce923825e99d6780ae99b5a5043ad48e599e4775fd6b1e1cdd35036777b0f2db8efd1f541b59a1fb659328351b5d71d98f566629d8efbefac0959a19

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Orbit
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# Notion Ruby Client
+
+A Ruby client for the Notion API.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Create a New Bot Integration](#create-a-new-bot-integration)
+  - [Declare the API Token](#declare-the-api-token)
+  - [API Client](#api-client)
+
+## Installation
+
+Add to Gemfile.
+
+```
+gem 'notion-ruby-client'
+```
+
+Run `bundle install`.
+
+## Usage
+
+### Create a New Bot Integration
+
+To integrate your bot with Notion, you must first create a new Notion Bot. (**TODO**: link to the docs)
+
+1. Log into the workspace that you want your integration to be associated with.
+2. Confirm that you are an Admin in the workspace (see Settings & Members > Members).
+3. Go to Settings & Members, and click API
+
+![A screenshot of the Notion page to create a bot](screenshots/create_notion_bot.png)
+
+### Declare the API token
+
+```
+Notion.configure do |config|
+  config.token = ENV['NOTION_API_TOKEN']
+end
+```
+
+### API Client
+
+TODO: document endpoints

data/lib/notion-ruby-client.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+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'
+require_relative 'notion/api/error'
+require_relative 'notion/api/errors'
+require_relative 'notion/api/errors/internal_error'
+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/api/endpoints.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'endpoints/users'
+
+module Notion
+  module Api
+    module Endpoints
+      include Users
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Notion
+  module Api
+    module Endpoints
+      module Users
+        #
+        # Retrieves a User object using the ID specified in the request.
+        #
+        # @option options [id] :id
+        #   User to get info on.
+        def user(options = {})
+          throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
+          get("users/#{options[:id]}")
+        end
+
+        #
+        # 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.
+        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]}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/notion/api/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Notion
+  module Api
+    Error = Errors::NotionError
+  end
+end

data/lib/notion/api/errors.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Notion
+  module Api
+    module Errors
+      class InternalError < NotionError; end
+      class InvalidRequest < NotionError; end
+      class ObjectNotFound < NotionError; end
+      class TooManyRequests < NotionError; end
+
+      ERROR_CLASSES = {
+        'internal_error' => InternalError,
+        'invalid_request' => InvalidRequest,
+        'object_not_found' => ObjectNotFound,
+        'rate_limited' => TooManyRequests
+      }.freeze
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module Notion
+  module Api
+    module Errors
+      class ServerError < InternalError; end
+      class ParsingError < ServerError; end
+      class HttpRequestError < ServerError; end
+      class TimeoutError < HttpRequestError; end
+      class UnavailableError < HttpRequestError; end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Notion
+  module Api
+    module Errors
+      class NotionError < ::Faraday::Error
+        attr_reader :response
+
+        def initialize(message, response = nil)
+          super message
+          @response = response
+        end
+      end
+    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,50 @@
+# 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
+      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 = defined?(OpenSSL) ? OpenSSL::X509::DEFAULT_CERT_DIR : nil
+      self.ca_file = defined?(OpenSSL) ? OpenSSL::X509::DEFAULT_CERT_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.adapter = ::Faraday.default_adapter
+    end
+
+    reset
+  end
+
+  class << self
+    def configure
+      block_given? ? yield(Config) : Config
+    end
+
+    def config
+      Config
+    end
+  end
+end

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::Request::Multipart
+              connection.use ::Faraday::Request::UrlEncoded
+              connection.use ::Notion::Faraday::Response::RaiseError
+              connection.use ::FaradayMiddleware::Mashify, mash_class: Notion::Messages::Message
+              connection.use ::FaradayMiddleware::ParseJson
+              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,39 @@
+# frozen_string_literal: true
+module Notion
+  module Faraday
+    module Request
+      def get(path, options = {})
+        request(:get, 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}"
+          case method
+          when :get, :delete
+            request.url(path, options)
+          when :post, :put
+            request.path = path
+            request.body = options 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,32 @@
+# frozen_string_literal: true
+module Notion
+  module Faraday
+    module Response
+      class RaiseError < ::Faraday::Response::Middleware
+        def on_complete(env)
+          raise Notion::Api::Errors::TooManyRequests, env.response if env.status == 429
+
+          return unless 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_class = Notion::Api::Errors::ERROR_CLASSES[error_code]
+          error_class ||= Notion::Api::Errors::NotionError
+          raise error_class.new(error_message, 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::Middleware
+        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,50 @@
+# 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 :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
+        end
+
+        def each
+          next_cursor = nil
+          retry_count = 0
+          loop do
+            query = { limit: client.default_page_size }.merge(params).merge(start_cursor: next_cursor)
+            begin
+              response = client.send(verb, query)
+            rescue Notion::Api::Errors::TooManyRequestsError => e
+              raise e if retry_count >= max_retries
+
+              client.logger.debug("#{self.class}##{__method__}") { e.to_s }
+              retry_count += 1
+              sleep(e.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,4 @@
+# frozen_string_literal: true
+module Notion
+  VERSION = '0.0.1'
+end

data/lib/notion_ruby_client.rb

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

data/notion-ruby-client.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'notion/version'
+
+Gem::Specification.new do |s|
+  s.name = 'notion-ruby-client'
+  s.version = Notion::VERSION
+  s.authors = ['Nicolas Goutay']
+  s.email = 'nicolas@orbit.love'
+  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 = 'http://github.com/orbit-love/notion-ruby-client'
+  s.licenses = ['MIT']
+  s.summary = 'Notion API client for Ruby.'
+  s.add_dependency 'faraday', '>= 1.0'
+  s.add_dependency 'faraday_middleware'
+  s.add_dependency 'hashie'
+  s.add_development_dependency 'rake', '~> 10'
+  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/scratchpad.rb

@@ -0,0 +1,22 @@
+Notion.configure do |config|
+  config.token = ENV['NOTION_API_TOKEN']
+end
+
+client = Notion::Client.new(token: 'token')
+
+
+client = Notion::Client.new
+client.auth_test
+
+client.database(id)
+client.database_query(id, options)
+
+client.page(id)
+client.create_page(options)
+client.update_page(id, options)
+
+client.user(id)
+client.list_users(options)
+
+
+# https://c15c8970-daea-4c88-9bcd-93726522a93e.mock.pstmn.io

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: notion-ruby-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nicolas Goutay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  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: hashie
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.82.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.82.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.39.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.39.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: nicolas@orbit.love
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.md
+- README.md
+- lib/notion-ruby-client.rb
+- lib/notion.rb
+- lib/notion/api/endpoints.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/client.rb
+- lib/notion/config.rb
+- lib/notion/faraday/connection.rb
+- lib/notion/faraday/request.rb
+- lib/notion/faraday/response/raise_error.rb
+- lib/notion/faraday/response/wrap_error.rb
+- lib/notion/logger.rb
+- lib/notion/messages/message.rb
+- lib/notion/pagination/cursor.rb
+- lib/notion/version.rb
+- lib/notion_ruby_client.rb
+- notion-ruby-client.gemspec
+- scratchpad.rb
+- screenshots/create_notion_bot.png
+homepage: http://github.com/orbit-love/notion-ruby-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Notion API client for Ruby.
+test_files: []