notion-sdk-ruby 0.4.1 → 0.6.1

data/README.md

@@ -1,339 +1,55 @@
-# Notion Ruby SDK
-
-[![ci](https://github.com/mgmarlow/notion-sdk-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/mgmarlow/notion-sdk-ruby/actions/workflows/ci.yml)
-[![Gem Version](https://badge.fury.io/rb/notion-sdk-ruby.svg)](https://badge.fury.io/rb/notion-sdk-ruby)
-
-Unofficial Ruby client for the [Notion APIs](https://developers.notion.com/).
-
-- [Notion Ruby SDK](#notion-ruby-sdk)
-  - [Installation](#installation)
-  - [Usage](#usage)
-  - [API reference](#api-reference)
-    - [Databases](#databases)
-      - [databases#retrieve](#databasesretrieve)
-      - [databases#list](#databaseslist)
-      - [databases#query](#databasesquery)
-      - [databases#create](#databasescreate)
-      - [databases#update](#databasesupdate)
-    - [Pages](#pages)
-      - [pages#retrieve](#pagesretrieve)
-      - [pages#create](#pagescreate)
-      - [pages#update](#pagesupdate)
-    - [Blocks](#blocks)
-      - [blocks#retrieve](#blocksretrieve)
-      - [blocks#update](#blocksupdate)
-      - [blocks#children#list](#blockschildrenlist)
-      - [blocks#children#append](#blockschildrenappend)
-    - [Users](#users)
-      - [users#retrieve](#usersretrieve)
-      - [users#list](#userslist)
-    - [Search](#search)
-      - [#search](#search-1)
-  - [Development](#development)
-  - [Contributing](#contributing)
-  - [License](#license)
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'notion-sdk-ruby'
-```
-
-And then execute:
-
-    $ bundle install
-
-## Usage
-
-Initialize `Notion::Client` with your app's [integration secret](https://developers.notion.com/docs/getting-started#create-a-new-integration).
-
-```rb
-require "notion-sdk-ruby"
-client = Notion::Client.new(token: ENV["NOTION_API_SECRET"])
-```
-
-## API reference
-
-### Databases
-
-#### databases#retrieve
-
-[API reference](https://developers.notion.com/reference/get-database)
-
-```rb
-client.databases.retrieve("668d797c-76fa-4934-9b05-ad288df2d136")
-```
-
-#### databases#list
-
-[API reference](https://developers.notion.com/reference/get-databases)
-
-```rb
-client.databases.list
-```
-
-#### databases#query
-
-[API reference](https://developers.notion.com/reference/post-database-query)
-
-```rb
-client.databases.query("668d797c-76fa-4934-9b05-ad288df2d136", {
-  filter: {
-    or: [
-      {
-        property: "In stock",
-        checkbox: {
-          equals: true
-        }
-      },
-      {
-        property: "Cost of next trip",
-        number: {
-          greater_than_or_equal_to: 2
-        }
-      }
-    ]
-  },
-  sorts: [
-    {
-      property: "Last ordered",
-      direction: "ascending"
-    }
-  ]
-})
-```
-
-#### databases#create
-
-[API reference](https://developers.notion.com/reference/create-a-database)
-
-```rb
-client.databases.create({
-  parent: {
-    type: "page_id",
-    page_id: "98ad959b-2b6a-4774-80ee-00246fb0ea9b"
-  },
-  title: [
-    {
-        type: "text",
-        text: {
-            content: "Grocery List",
-            link: null
-        }
-    }
-  ],
-  properties: {
-    Name: {
-      title: {}
-    }
-  }
-})
-```
-
-#### databases#update
-
-[API reference](https://developers.notion.com/reference/update-a-database)
-
-```rb
-client.databases.update("668d797c-76fa-4934-9b05-ad288df2d136", {
-  title: [
-    {
-        type: "text",
-        text: {
-            content: "Grocery List",
-            link: null
-        }
-    }
-  ],
-  properties: {
-    Name: {
-      title: {}
-    }
-  }
-})
-```
-
-### Pages
-
-#### pages#retrieve
-
-[API reference](https://developers.notion.com/reference/get-page)
-
-```rb
-client.pages.retrieve("b55c9c91-384d-452b-81db-d1ef79372b75")
-```
-
-#### pages#create
-
-[API reference](https://developers.notion.com/reference/post-page)
-
-```rb
-client.pages.create({
-  parent: { database_id: "48f8fee9cd794180bc2fec0398253067" },
-  properties: {
-    Name: {
-      title: [
-        {
-          text: {
-            content: "Tuscan Kale"
-          }
-        }
-      ]
-    },
-    Description: {
-      rich_text: [
-        {
-          text: {
-            content: "A dark green leafy vegetable"
-          }
-        }
-      ]
-    },
-    Food group: {
-      select: {
-        name: "Vegetable"
-      }
-    },
-    Price: { number: 2.5 }
-  },
-  children: []
-})
-```
-
-#### pages#update
-
-[API reference](https://developers.notion.com/reference/patch-page)
-
-```rb
-client.pages.update("b55c9c91-384d-452b-81db-d1ef79372b75", {
-  properties: {
-    "In stock": { checkbox: true }
-  }
-})
-```
-
-### Blocks
-
-#### blocks#retrieve
-
-[API reference](https://developers.notion.com/reference/retrieve-a-block)
-
-```rb
-client.blocks.retrieve("b55c9c91-384d-452b-81db-d1ef79372b75")
-```
-
-#### blocks#update
-
-[API reference](https://developers.notion.com/reference/update-a-block)
-
-```rb
-client.blocks.update("b55c9c91-384d-452b-81db-d1ef79372b75", {
-  to_do: {
-    text: [{ 
-      text: { content: "Lacinato kale" } 
-    }],
-    checked: false
-  }
-})
-```
-
-#### blocks#children#list
-
-[API reference](https://developers.notion.com/reference/get-block-children)
-
-```rb
-client.blocks.children.list("b55c9c91-384d-452b-81db-d1ef79372b75", {
-  page_size: 100
-})
-```
-
-#### blocks#children#append
-
-[API reference](https://developers.notion.com/reference/patch-block-children)
-
-```rb
-client.blocks.children.append("b54c9c91-384d-452b-81db-d1ef79372b75", {
-  children: [
-    {
-      object: "block",
-      type: "heading_1",
-      heading_1: {
-        text: [{ type: "text", text: { content: "Lacinato kale" } }]
-      }
-    },
-    {
-      object: "block",
-      type: "paragraph",
-      paragraph: {
-        text: [
-          {
-            type: "text",
-            text: {
-              content: "Lacinato kale is a variety of kale with a long tradition in Italian cuisine, especially that of Tuscany. It is also known as Tuscan kale, Italian kale, dinosaur kale, kale, flat back kale, palm tree kale, or black Tuscan palm.",
-              link: { url: "https://en.wikipedia.org/wiki/Lacinato_kale" }
-            }
-          }
-        ]
-      }
-    }
-  ]
-})
-```
-
-### Users
-
-#### users#retrieve
-
-[API reference](https://developers.notion.com/reference/get-user)
-
-```rb
-client.users.retrieve("d40e767c-d7af-4b18-a86d-55c61f1e39a4")
-```
-
-#### users#list
-
-[API reference](https://developers.notion.com/reference/get-users)
-
-```rb
-client.users.list
-```
-
-### Search
-
-[API reference](https://developers.notion.com/reference/post-search)
-
-#### #search
-
-```rb
-client.search({
-  query: "External tasks",
-  sort: {
-    direction: "ascending",
-    timestamp: "last_edited_time"
-  }
-})
-```
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-Before using `bin/console` you need to create a new file, `.env`, at the root project directory. This will enable you to run commands directly against your [Notion integration](https://developers.notion.com/docs/getting-started).
-
-```
-cat > .env <<EOF
-API_SECRET=<YOUR NOTION API SECRET HERE>
-EOF
-```
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/mgmarlow/notion-sdk-ruby.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+# Notion Ruby SDK
+
+[![ci](https://github.com/mgmarlow/notion-sdk-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/mgmarlow/notion-sdk-ruby/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/notion-sdk-ruby.svg)](https://badge.fury.io/rb/notion-sdk-ruby)
+
+Unofficial Ruby client for the [Notion APIs](https://developers.notion.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'notion-sdk-ruby'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+    
+## Documentation
+
+- [API documentation](https://mgmarlow.github.io/notion-sdk-ruby/Notion/Client.html)
+
+## Usage
+
+Initialize `Notion::Client` with your app's [integration secret](https://developers.notion.com/docs/getting-started#create-a-new-integration).
+
+```rb
+require "notion-sdk-ruby"
+client = Notion::Client.new(token: ENV["NOTION_API_SECRET"])
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+Before using `bin/console` you need to create a new file, `.env`, at the root project directory. This will enable you to run commands directly against your [Notion integration](https://developers.notion.com/docs/getting-started).
+
+```
+cat > .env <<EOF
+NOTION_API_KEY=<YOUR NOTION API SECRET HERE>
+EOF
+```
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mgmarlow/notion-sdk-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,7 +1,12 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "standard/rake"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: [:spec, :standard]
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "standard/rake"
+require "yard"
+
+RSpec::Core::RakeTask.new(:spec)
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ["lib/**/*.rb"]
+end
+
+task default: [:spec, :standard]

data/bin/console

@@ -1,11 +1,11 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "pry"
-require 'dotenv/load'
-
-require "notion-sdk-ruby"
-
-$client = Notion::Client.new(token: ENV["API_SECRET"])
-
-Pry.start
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pry"
+require 'dotenv/load'
+
+require "notion-sdk-ruby"
+
+$client = Notion::Client.new(token: ENV["API_SECRET"])
+
+Pry.start

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/setup

@@ -1,8 +1,8 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/notion-sdk-ruby/api/blocks.rb

@@ -0,0 +1,56 @@
+module Notion
+  module Api
+    class BlocksMethods
+      include RequestClient
+
+      # @return [Notion::Api::BlocksChildrenMethods]
+      def children
+        BlocksChildrenMethods.new
+      end
+
+      # Retrieves a Block object using the ID specified.
+      # https://developers.notion.com/reference/retrieve-a-block
+      # @param [String] id block_id
+      # @return [Notion::Block]
+      def retrieve(id)
+        response = get("/v1/blocks/#{id}")
+        Block.new(response.body)
+      end
+
+      # Updates the content for the specified block_id based on the block type.
+      # https://developers.notion.com/reference/update-a-block
+      # @param [String] id block_id
+      # @param [Hash] body
+      # @return [Notion::Block]
+      def update(id, body)
+        response = patch("/v1/blocks/#{id}", body.to_json)
+        Block.new(response.body)
+      end
+    end
+
+    class BlocksChildrenMethods
+      include RequestClient
+
+      # Returns a paginated array of child block objects contained in the block
+      # using the ID specified.
+      # https://developers.notion.com/reference/get-block-children
+      # @param [String] id block_id
+      # @param [Hash] query
+      # @return [Array<Notion::Block>]
+      def list(id, query = {})
+        response = get("/v1/blocks/#{id}/children", query)
+        List.new(response.body)
+      end
+
+      # Creates and appends new children blocks to the parent block_id specified.
+      # https://developers.notion.com/reference/patch-block-children
+      # @param [String] id block_id
+      # @param [Hash] body
+      # @return [Array<Notion::Block>]
+      def append(id, body)
+        response = patch("/v1/blocks/#{id}/children", body.to_json)
+        List.new(response.body)
+      end
+    end
+  end
+end

data/lib/notion-sdk-ruby/api/databases.rb

@@ -0,0 +1,47 @@
+module Notion
+  module Api
+    class DatabasesMethods
+      include RequestClient
+
+      # Retrieves a Database object using the ID specified.
+      # https://developers.notion.com/reference/retrieve-a-database
+      # @param [String] id database_id
+      # @return [Notion::Database]
+      def retrieve(id)
+        response = get("/v1/databases/#{id}")
+        Database.new(response.body)
+      end
+
+      # Gets a list of Pages contained in the database, filtered and ordered according
+      # to the filter conditions and sort criteria provided in the request.
+      # https://developers.notion.com/reference/post-database-query
+      # @param [String] id database_id
+      # @param [Hash] body
+      # @return [Array<Notion::Database>]
+      def query(id, body)
+        response = post("/v1/databases/#{id}/query", body.to_json)
+        List.new(response.body)
+      end
+
+      # Creates a database as a subpage in the specified parent page, with the
+      # specified properties schema.
+      # https://developers.notion.com/reference/create-a-database
+      # @param [Hash] body
+      # @return [Notion::Database]
+      def create(body)
+        response = post("/v1/databases", body.to_json)
+        Database.new(response.body)
+      end
+
+      # Updates an existing database as specified by the parameters.
+      # https://developers.notion.com/reference/update-a-database
+      # @param [String] id database_id
+      # @param [Hash] body
+      # @return [Notion::Database]
+      def update(id, body)
+        response = patch("/v1/databases/#{id}", body.to_json)
+        Database.new(response.body)
+      end
+    end
+  end
+end

data/lib/notion-sdk-ruby/api/pages.rb

@@ -0,0 +1,36 @@
+module Notion
+  module Api
+    class PagesMethods
+      include RequestClient
+
+      # Retrieves a Page object using the ID specified.
+      # https://developers.notion.com/reference/retrieve-a-page
+      # @param [String] id page_id
+      # @return [Notion::Page]
+      def retrieve(id)
+        response = get("/v1/pages/#{id}")
+        Page.new(response.body)
+      end
+
+      # Creates a new page in the specified database or as a child of
+      # an existing page.
+      # https://developers.notion.com/reference/post-page
+      # @param [Hash] body
+      # @return [Notion::Page]
+      def create(body)
+        response = post("/v1/pages", body.to_json)
+        Page.new(response.body)
+      end
+
+      # Updates page property values for the specified page.
+      # https://developers.notion.com/reference/patch-page
+      # @param [String] id page_id
+      # @param [Hash] body
+      # @return [Notion::Page]
+      def update(id, body)
+        response = patch("/v1/pages/#{id}", body.to_json)
+        Page.new(response.body)
+      end
+    end
+  end
+end

data/lib/notion-sdk-ruby/api/search.rb

@@ -0,0 +1,17 @@
+module Notion
+  module Api
+    module SearchMethods
+      include RequestClient
+
+      # Searches all original pages, databases, and child pages/databases
+      # that are shared with the integration.
+      # https://developers.notion.com/reference/post-search
+      # @param [Hash] body
+      # @return [Array]
+      def search(body)
+        response = post("/v1/search", body.to_json)
+        List.new(response.body)
+      end
+    end
+  end
+end

data/lib/notion-sdk-ruby/api/users.rb

@@ -0,0 +1,24 @@
+module Notion
+  module Api
+    class UsersMethods
+      include RequestClient
+
+      # Returns a paginated list of Users for the workspace.
+      # https://developers.notion.com/reference/get-users
+      # @return [Array<Notion::User>]
+      def list
+        response = get("/v1/users")
+        List.new(response.body)
+      end
+
+      # Retrieves a User using the ID specified.
+      # https://developers.notion.com/reference/get-user
+      # @param [String] id user_id
+      # @return [Notion::User]
+      def retrieve(id)
+        response = get("/v1/users/#{id}")
+        User.new(response.body)
+      end
+    end
+  end
+end