notion-sdk-ruby 0.4.1 → 0.6.1

data/lib/notion-sdk-ruby/client.rb

@@ -1,26 +1,30 @@
-module Notion
-  class Client
-    include Operations::Search
-
-    def initialize(token:, notion_version: "2021-08-16")
-      Notion.api_token = token
-      Notion.notion_version = notion_version
-    end
-
-    def blocks
-      Blocks.new
-    end
-
-    def databases
-      Databases.new
-    end
-
-    def pages
-      Pages.new
-    end
-
-    def users
-      Users.new
-    end
-  end
-end
+module Notion
+  class Client
+    include Api::SearchMethods
+
+    def initialize(token:, notion_version: "2022-02-22")
+      Notion.api_token = token
+      Notion.notion_version = notion_version
+    end
+
+    # @return [Notion::Api::DatabasesMethods]
+    def databases
+      Api::DatabasesMethods.new
+    end
+
+    # @return [Notion::Api::UsersMethods]
+    def users
+      Api::UsersMethods.new
+    end
+
+    # @return [Notion::Api::BlocksMethods]
+    def blocks
+      Api::BlocksMethods.new
+    end
+
+    # @return [Notion::Api::PagesMethods]
+    def pages
+      Api::PagesMethods.new
+    end
+  end
+end

data/lib/notion-sdk-ruby/config.rb

@@ -1,5 +1,5 @@
-module Notion
-  class Config
-    attr_accessor :api_token, :notion_version
-  end
-end
+module Notion
+  class Config
+    attr_accessor :api_token, :notion_version
+  end
+end

data/lib/notion-sdk-ruby/error.rb

@@ -1,52 +1,52 @@
-# Sourced from notion-sdk-js:
-# https://github.com/makenotion/notion-sdk-js/blob/main/src/errors.ts
-module Notion
-  API_ERROR_CODE = {
-    unauthorized: "unauthorized",
-    restricted_resource: "restricted_resource",
-    object_not_found: "object_not_found",
-    rate_limited: "rate_limited",
-    invalid_json: "invalid_json",
-    invalid_request_url: "invalid_request_url",
-    invalid_request: "invalid_request",
-    validation_error: "validation_error",
-    conflict_error: "conflict_error",
-    internal_server_error: "internal_server_error",
-    service_unavailable: "service_unavailable"
-  }
-
-  class ErrorFactory
-    def self.create(error = {})
-      return NotionError.new("Unknown error.") if error["message"].nil?
-
-      if API_ERROR_CODE.value?(error["code"])
-        APIResponseError.new(error["message"], body: error)
-      elsif error["request"] && error["response"] && error["timings"]
-        HTTPResponseError.new(error["message"], body: error)
-      elsif error["request"] && error["timings"]
-        RequestTimeoutError.new(error["message"], body: error)
-      else
-        NotionError.new(error["message"])
-      end
-    end
-  end
-
-  class NotionError < StandardError
-    attr_reader :message, :body
-
-    def initialize(message = nil, body: nil)
-      @message = message
-      @body = body
-    end
-  end
-
-  class RequestTimeoutError < NotionError; end
-
-  class HTTPResponseError < NotionError; end
-
-  class APIResponseError < NotionError
-    def code
-      body["code"]
-    end
-  end
-end
+# Sourced from notion-sdk-js:
+# https://github.com/makenotion/notion-sdk-js/blob/main/src/errors.ts
+module Notion
+  API_ERROR_CODE = {
+    unauthorized: "unauthorized",
+    restricted_resource: "restricted_resource",
+    object_not_found: "object_not_found",
+    rate_limited: "rate_limited",
+    invalid_json: "invalid_json",
+    invalid_request_url: "invalid_request_url",
+    invalid_request: "invalid_request",
+    validation_error: "validation_error",
+    conflict_error: "conflict_error",
+    internal_server_error: "internal_server_error",
+    service_unavailable: "service_unavailable"
+  }
+
+  class ErrorFactory
+    def self.create(error = {})
+      return NotionError.new("Unknown error.") if error["message"].nil?
+
+      if API_ERROR_CODE.value?(error["code"])
+        APIResponseError.new(error["message"], body: error)
+      elsif error["request"] && error["response"] && error["timings"]
+        HTTPResponseError.new(error["message"], body: error)
+      elsif error["request"] && error["timings"]
+        RequestTimeoutError.new(error["message"], body: error)
+      else
+        NotionError.new(error["message"])
+      end
+    end
+  end
+
+  class NotionError < StandardError
+    attr_reader :message, :body
+
+    def initialize(message = nil, body: nil)
+      @message = message
+      @body = body
+    end
+  end
+
+  class RequestTimeoutError < NotionError; end
+
+  class HTTPResponseError < NotionError; end
+
+  class APIResponseError < NotionError
+    def code
+      body["code"]
+    end
+  end
+end

data/lib/notion-sdk-ruby/models/block.rb

@@ -0,0 +1,7 @@
+module Notion
+  # A block object represents content within Notion.
+  #
+  # https://developers.notion.com/reference/block
+  class Block < OpenStruct
+  end
+end

data/lib/notion-sdk-ruby/models/database.rb

@@ -0,0 +1,7 @@
+module Notion
+  # Database objects describe the property schema of a database in Notion.
+  #
+  # https://developers.notion.com/reference/database
+  class Database < OpenStruct
+  end
+end

data/lib/notion-sdk-ruby/models/list.rb

@@ -0,0 +1,49 @@
+module Notion
+  # The List object is an intermediate object that helps with pagination.
+  #
+  # https://developers.notion.com/reference/pagination
+  class List
+    # An array of endpoint-dependent objects
+    # @return [Array<Notion::User>]
+    # @return [Array<Notion::Database>]
+    # @return [Array<Notion::Page>]
+    # @return [Array<Notion::Block>]
+    attr_reader :data
+
+    # Used to retrieve the next page of results by passing the value as the
+    # start_cursor parameter to the same endpoint.
+    # @return [nil] if has_more is true.
+    # @return [string] if has_more is false.
+    attr_reader :next_cursor
+
+    # When the response includes the end of the list, false. Otherwise, true.
+    # @return [boolean]
+    attr_reader :has_more
+
+    def initialize(response_body)
+      @data = response_body["results"].map do |d|
+        get_model(d["object"]).new(d)
+      end
+
+      @next_cursor = response_body["next_cursor"]
+      @has_more = response_body["has_more"]
+    end
+
+    private
+
+    def get_model(object_name)
+      case object_name
+      when "block"
+        Block
+      when "database"
+        Database
+      when "page"
+        Page
+      when "user"
+        User
+      else
+        raise NotionError.new("unimplemented object type")
+      end
+    end
+  end
+end

data/lib/notion-sdk-ruby/models/page.rb

@@ -0,0 +1,7 @@
+module Notion
+  # The Page object contains the property values of a single Notion page.
+  #
+  # https://developers.notion.com/reference/page
+  class Page < OpenStruct
+  end
+end

data/lib/notion-sdk-ruby/models/user.rb

@@ -0,0 +1,7 @@
+module Notion
+  # The User object represents a user in a Notion workspace.
+  #
+  # https://developers.notion.com/reference/user
+  class User < OpenStruct
+  end
+end

data/lib/notion-sdk-ruby/request_client.rb

@@ -1,50 +1,45 @@
-module Notion
-  class RequestClient
-    include HTTParty
-
-    base_uri "https://api.notion.com"
-    headers "Content-Type": "application/json"
-
-    def self.active_client
-      RequestClient.new(Notion.config)
-    end
-
-    def initialize(config)
-      self.class.headers Authorization: "Bearer #{config.api_token}"
-      self.class.headers "Notion-Version": config.notion_version
-    end
-
-    def get(*args, &block)
-      response = self.class.get(*args, &block)
-      raise_on_failure(response)
-    end
-
-    def post(*args, &block)
-      response = self.class.post(*args, &block)
-      raise_on_failure(response)
-    end
-
-    def patch(*args, &block)
-      response = self.class.patch(*args, &block)
-      raise_on_failure(response)
-    end
-
-    def put(*args, &block)
-      response = self.class.put(*args, &block)
-      raise_on_failure(response)
-    end
-
-    def delete(*args, &block)
-      response = self.class.delete(*args, &block)
-      raise_on_failure(response)
-    end
-
-    def raise_on_failure(response)
-      if response.success?
-        response
-      else
-        raise ErrorFactory.create(response)
-      end
-    end
-  end
-end
+module Notion
+  module RequestClient
+    private
+
+    def get(*args)
+      handle_request(:get, *args)
+    end
+
+    def post(*args)
+      handle_request(:post, *args)
+    end
+
+    def patch(*args)
+      handle_request(:patch, *args)
+    end
+
+    def delete(*args)
+      handle_request(:delete, *args)
+    end
+
+    def handle_request(method, *args)
+      faraday_client.public_send(method, *args)
+    rescue Faraday::ClientError => error
+      error_details = JSON.parse(error.response[:body])
+      raise ErrorFactory.create(error_details)
+    rescue JSON::ParserError => error
+      raise NotionError.new(error.message)
+    end
+
+    def faraday_client
+      @faraday_client ||= Faraday.new(
+        url: "https://api.notion.com",
+        headers: {
+          "Content-Type" => "application/json",
+          "Notion-Version" => Notion.config.notion_version,
+          "Authorization" => "Bearer #{Notion.config.api_token}"
+        }
+      ) do |f|
+        f.request :json
+        f.response :json
+        f.use Faraday::Response::RaiseError
+      end
+    end
+  end
+end

data/lib/notion-sdk-ruby/version.rb

@@ -1,3 +1,3 @@
-module Notion
-  VERSION = "0.4.1"
-end
+module Notion
+  VERSION = "0.6.1"
+end

data/lib/notion-sdk-ruby.rb

@@ -1,27 +1,37 @@
-require "httparty"
-require "forwardable"
-
-require "notion-sdk-ruby/version"
-
-require "notion-sdk-ruby/config"
-require "notion-sdk-ruby/resources/blocks"
-require "notion-sdk-ruby/resources/databases"
-require "notion-sdk-ruby/resources/pages"
-require "notion-sdk-ruby/resources/users"
-require "notion-sdk-ruby/operations/search"
-require "notion-sdk-ruby/error"
-require "notion-sdk-ruby/request_client"
-require "notion-sdk-ruby/client"
-
-module Notion
-  @config = Config.new
-
-  class << self
-    extend Forwardable
-
-    attr_reader :config
-
-    def_delegators :@config, :api_token, :api_token=
-    def_delegators :@config, :notion_version, :notion_version=
-  end
-end
+require "json"
+require "faraday"
+require "faraday_middleware"
+require "forwardable"
+require "ostruct"
+
+require "notion-sdk-ruby/version"
+require "notion-sdk-ruby/config"
+require "notion-sdk-ruby/request_client"
+require "notion-sdk-ruby/error"
+
+require "notion-sdk-ruby/models/user"
+require "notion-sdk-ruby/models/list"
+require "notion-sdk-ruby/models/block"
+require "notion-sdk-ruby/models/database"
+require "notion-sdk-ruby/models/page"
+
+require "notion-sdk-ruby/api/blocks"
+require "notion-sdk-ruby/api/databases"
+require "notion-sdk-ruby/api/pages"
+require "notion-sdk-ruby/api/users"
+require "notion-sdk-ruby/api/search"
+
+require "notion-sdk-ruby/client"
+
+module Notion
+  @config = Config.new
+
+  class << self
+    extend Forwardable
+
+    attr_reader :config
+
+    def_delegators :@config, :api_token, :api_token=
+    def_delegators :@config, :notion_version, :notion_version=
+  end
+end

data/notion-sdk-ruby.gemspec

@@ -1,37 +1,41 @@
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require_relative "lib/notion-sdk-ruby/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "notion-sdk-ruby"
-  spec.version = Notion::VERSION
-  spec.authors = ["Graham Marlow"]
-  spec.email = ["mgmarlow@hey.com"]
-
-  spec.summary = "Notion SDK"
-  spec.homepage = "https://github.com/mgmarlow/notion-sdk-ruby"
-  spec.license = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/mgmarlow/notion-sdk-ruby"
-  spec.metadata["changelog_uri"] = "https://github.com/mgmarlow/notion-sdk-ruby/blob/master/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "httparty", "~> 0.18.1"
-
-  spec.add_development_dependency "rake", "~> 12.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "standardrb", "~> 1.0"
-  spec.add_development_dependency "webmock", "~> 3.12"
-  spec.add_development_dependency "pry", "~> 0.14.1"
-  spec.add_development_dependency "dotenv", "~> 2.7"
-end
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative "lib/notion-sdk-ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "notion-sdk-ruby"
+  spec.version = Notion::VERSION
+  spec.authors = ["Graham Marlow"]
+  spec.email = ["mgmarlow@hey.com"]
+
+  spec.summary = "Notion SDK"
+  spec.homepage = "https://github.com/mgmarlow/notion-sdk-ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/mgmarlow/notion-sdk-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/mgmarlow/notion-sdk-ruby/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 1.8"
+  spec.add_dependency "faraday_middleware", "~> 1.1"
+
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "standard", "~> 1.0"
+  spec.add_development_dependency "webmock", "~> 3.12"
+  spec.add_development_dependency "pry", "~> 0.14.1"
+  spec.add_development_dependency "dotenv", "~> 2.7"
+  spec.add_development_dependency "activesupport", "~> 6.1"
+  spec.add_development_dependency "yard", "~> 0.9.26"
+  spec.add_development_dependency "vcr", "~> 6.0"
+end

data/todos.md

@@ -0,0 +1,11 @@
+# todos
+
+- [x] Add VCR
+- [x] Swap over specs to use VCR
+- [x] Update to latest notion SDK version
+- [x] Improve generated docs by removing extra module namespaces
+- [x] Remove manual docs from readme, move to auto-generated docs
+- [ ] New endpoint: Delete block
+- [ ] New endpoint: Retrieve a page property item
+- [ ] Pagination APIs
+- [ ] Examples