# 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)
    - [Pages](#pages)
      - [pages#retrieve](#pagesretrieve)
      - [pages#create](#pagescreate)
      - [pages#update](#pagesupdate)
    - [Blocks](#blocks)
      - [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"
    }
  ]
})
```

### 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#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).