notion-ruby-client 0.0.4 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da15ba6b2f024300114602bd828c15ca06e04366336e3414b6c8a557011672ff
-  data.tar.gz: b729ffdea1ce51e5381a2dc1a296180bf4ae396ae1be526433fd8059f3a974a8
+  metadata.gz: 819fe0911c48a9f09bb4a8e7c92b1c36f77fc61878944df6da74bfab0bd3a9cf
+  data.tar.gz: 2c93279f5b48004a93b92e0a1268712472ac7e5534dcb57ab8003dd8507676ef
 SHA512:
-  metadata.gz: 2d6c904bc63780d5ce10688ac6033e7c62dacb72baaf5d451d7a2332ad4bf39719cb5f02b52e82f8b358543081c9008010f0cf1394e67f04aa047bbc9727cfc3
-  data.tar.gz: b29c7cbb03715c3d4390e0d0a94d36fecf175e8d38fb4713e82785ee8a240cf3a834b2fc157504040a546922ed039a0fe9d92b50896a61d034b9b0d44d9fda0d
+  metadata.gz: 8d4a7d57457cdbb614eb9600b14e5f4460d0672631ff10f2525b87783f587ed251e4b3e3fc33d04420fe06cd086536b17acbfe008595a2f404cb513887365bdc
+  data.tar.gz: ffdab9a3e8962cfd8f21fd75a274020eba721963d12b7cfbb010eff711e7b7ef7945b2763a8db6f75130f53dc2408e7eafb3f95b9d0e3281cbb2b041cfd57e19

data/.rspec_status

@@ -1,15 +1,19 @@
 example_id                                           | status | run_time        |
 ---------------------------------------------------- | ------ | --------------- |
-./spec/notion/api/endpoints/databases_spec.rb[1:1:1] | passed | 0.01164 seconds |
-./spec/notion/api/endpoints/databases_spec.rb[1:1:2] | passed | 0.007 seconds   |
-./spec/notion/api/endpoints/databases_spec.rb[1:1:3] | passed | 0.00692 seconds |
-./spec/notion/api/endpoints/databases_spec.rb[1:1:4] | passed | 0.00666 seconds |
-./spec/notion/api/endpoints/databases_spec.rb[1:1:5] | passed | 0.85972 seconds |
-./spec/notion/api/endpoints/pages_spec.rb[1:1:1]     | passed | 0.00676 seconds |
-./spec/notion/api/endpoints/pages_spec.rb[1:1:2]     | passed | 0.0063 seconds  |
-./spec/notion/api/endpoints/pages_spec.rb[1:1:3]     | passed | 0.00628 seconds |
-./spec/notion/api/endpoints/users_spec.rb[1:1:1]     | passed | 0.00722 seconds |
-./spec/notion/api/endpoints/users_spec.rb[1:1:2]     | passed | 0.00731 seconds |
-./spec/notion/api/endpoints/users_spec.rb[1:1:3]     | passed | 0.00678 seconds |
-./spec/notion/config_spec.rb[1:1:1]                  | passed | 0.00009 seconds |
-./spec/notion/version_spec.rb[1:1]                   | passed | 0.00006 seconds |
+./spec/notion/api/endpoints/blocks_spec.rb[1:1:1]    | passed | 0.03873 seconds |
+./spec/notion/api/endpoints/blocks_spec.rb[1:1:2]    | passed | 0.0494 seconds  |
+./spec/notion/api/endpoints/blocks_spec.rb[1:1:3]    | passed | 0.02657 seconds |
+./spec/notion/api/endpoints/databases_spec.rb[1:1:1] | passed | 0.02458 seconds |
+./spec/notion/api/endpoints/databases_spec.rb[1:1:2] | passed | 0.02588 seconds |
+./spec/notion/api/endpoints/databases_spec.rb[1:1:3] | passed | 0.0268 seconds  |
+./spec/notion/api/endpoints/databases_spec.rb[1:1:4] | passed | 0.01669 seconds |
+./spec/notion/api/endpoints/databases_spec.rb[1:1:5] | passed | 0.01661 seconds |
+./spec/notion/api/endpoints/databases_spec.rb[1:1:6] | passed | 0.0173 seconds  |
+./spec/notion/api/endpoints/pages_spec.rb[1:1:1]     | passed | 0.01728 seconds |
+./spec/notion/api/endpoints/pages_spec.rb[1:1:2]     | passed | 0.01656 seconds |
+./spec/notion/api/endpoints/pages_spec.rb[1:1:3]     | passed | 0.0206 seconds  |
+./spec/notion/api/endpoints/users_spec.rb[1:1:1]     | passed | 0.02992 seconds |
+./spec/notion/api/endpoints/users_spec.rb[1:1:2]     | passed | 0.02664 seconds |
+./spec/notion/api/endpoints/users_spec.rb[1:1:3]     | passed | 0.02533 seconds |
+./spec/notion/config_spec.rb[1:1:1]                  | passed | 0.00016 seconds |
+./spec/notion/version_spec.rb[1:1]                   | passed | 0.00016 seconds |

data/CHANGELOG.md

@@ -1,8 +1,25 @@
+### 0.0.8 (2021-07-27)
+
+- Bump `Notion-Version` header to `2021-05-13` (@H0R15H0)
+- Add support for the new Create database endpoint (@H0R15H0)
+
+### 0.0.7 (2021-06-17)
+
+- Fixes the query parameter for fetching a page resource
+
+### 0.0.6 (2021-06-09)
+
+- Added `Notion-Version` required header to all requests
+
+### 0.0.5 (2020-04-25)
+
+- Added support for Blocks endpoints
+
 ### 0.0.4 (2020-04-25)
 
 - Added specs and a CI process with GitHub Actions
-- Add support for GET /databases, POST /databases/<:id>/query endpoints
-- Add support for `content` when creating a page
+- Added support for GET /databases, POST /databases/<:id>/query endpoints
+- Added support for `content` when creating a page
 
 ### 0.0.3 (2020-01-30)
 

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+nicolas@orbit.love.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    notion-ruby-client (0.0.3)
+    notion-ruby-client (0.0.8)
       faraday (>= 1.0)
       faraday_middleware
       hashie
@@ -9,18 +9,22 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
     crack (0.4.5)
       rexml
     diff-lcs (1.4.4)
-    faraday (1.4.1)
+    faraday (1.4.2)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
       faraday-net_http (~> 1.0)
       faraday-net_http_persistent (~> 1.1)
       multipart-post (>= 1.2, < 3)
       ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
     faraday-excon (1.1.0)
     faraday-net_http (1.0.1)
     faraday-net_http_persistent (1.1.0)
@@ -31,7 +35,7 @@ GEM
     jaro_winkler (1.5.4)
     multipart-post (2.1.1)
     parallel (1.20.1)
-    parser (3.0.1.0)
+    parser (3.0.1.1)
       ast (~> 2.4.1)
     public_suffix (4.0.6)
     rainbow (3.0.0)
@@ -67,7 +71,7 @@ GEM
     timecop (0.9.4)
     unicode-display_width (1.7.0)
     vcr (6.0.0)
-    webmock (3.12.2)
+    webmock (3.13.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -88,4 +92,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.2.5
+   2.2.16

data/README.md

@@ -44,7 +44,7 @@ For Rails projects, the snippet above would go to `config/application.rb`.
 
 ### API Client
 
-#### Instanciating a new Notion API client
+#### Instantiating a new Notion API client
 
 ```ruby
 client = Notion::Client.new
@@ -133,26 +133,78 @@ client.databases_list do |page|
 end
 ```
 
+Create a Database:
+
+```ruby
+title = [
+  {
+    "type": "text",
+    "text": {
+      "content": "Grocery List",
+      "link": nil
+    }
+  }
+],
+properties = {
+  "Name": {
+    "title": {}
+  },
+  "Description": {
+    "rich_text": {}
+  },
+  "In stock": {
+    "checkbox": {}
+  },
+  "Food group": {
+    "select": {
+      "options": [
+        {
+          "name": "🥦Vegetable",
+          "color": "green"
+        },
+        {
+          "name": "🍎Fruit",
+          "color": "red"
+        },
+        {
+          "name": "💪Protein",
+          "color": "yellow"
+        }
+      ]
+    }
+  }
+}
+client.create_database(
+  parent: { page_id: '98ad959b-2b6a-4774-80ee-00246fb0ea9b' },
+  title: title,
+  properties: properties
+)
+```
+
 #### Pages
 
 Create a page:
 
 ```ruby
 properties = {
-  "Name": [
-    {
-      "text": {
-        "content": "Tuscan Kale"
+  "Name": {
+    "title": [
+      {
+        "text": {
+          "content": "Tuscan Kale"
+        }
       }
-    }
-  ],
-  "Description": [
-    {
-      "text": {
-        "content": "A dark green leafy vegetable"
+    ]
+  },
+  "Description": {
+    "rich_text": [
+      {
+        "text": {
+          "content": "A dark green leafy vegetable"
+        }
       }
-    }
-  ],
+    ]
+  },
   "Food group": {
     "name": "🥦 Vegetable"
   },
@@ -203,3 +255,32 @@ properties = {
 }
 client.update_page(id: 'b55c9c91-384d-452b-81db-d1ef79372b75', properties: properties)
 ```
+
+#### Blocks
+
+Retrieve children Block objects at the requested path:
+
+```ruby
+client.block_children(id: 'b55c9c91-384d-452b-81db-d1ef79372b75')
+
+client.block_children(start_cursor: 'fe2cc560-036c-44cd-90e8-294d5a74cebc')
+
+client.block_children_list do |page|
+  # paginate through all children
+end
+```
+
+Creates and appends new children blocks to the parent block in the requested path:
+
+```ruby
+children = [
+  {
+    "object": 'block',
+    "type": 'heading_2',
+    "heading_2": {
+      "text": [{ "type": 'text', "text": { "content": 'A Second-level Heading' } }]
+    }
+  }
+]
+client.block_append_children(id: 'b55c9c91-384d-452b-81db-d1ef79372b75', children: children)
+```

data/lib/notion/api/endpoints.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'endpoints/blocks'
 require_relative 'endpoints/databases'
 require_relative 'endpoints/pages'
 require_relative 'endpoints/users'
@@ -7,6 +8,7 @@ require_relative 'endpoints/users'
 module Notion
   module Api
     module Endpoints
+      include Blocks
       include Databases
       include Pages
       include Users

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Notion
+  module Api
+    module Endpoints
+      module Blocks
+        #
+        # Returns a paginated array of Block objects contained in the
+        # block of the requested path using the ID specified.
+        #
+        # Returns a 404 HTTP response if any of the following are true:
+        # - the ID does not exist
+        # - the bot doesn't have access to the block with the given ID
+        #
+        # Returns a 400 or 429 HTTP response if the request exceeds Notion's Request limits.
+        #
+        # @option options [id] :id
+        #   Block to get children info on.
+        def block_children(options = {})
+          throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
+          if block_given?
+            Pagination::Cursor.new(self, :block_children, options).each do |page|
+              yield page
+            end
+          else
+            get("blocks/#{options[:id]}/children", options)
+          end
+        end
+
+        #
+        # Creates and appends new children blocks to the parent block
+        # in the requested path using the ID specified. Returns the Block
+        # object being appended to.
+        #
+        # Returns a 404 HTTP response if any of the following are true:
+        # - the ID does not exist
+        # - the bot doesn't have access to the block with the given ID
+        #
+        # Returns a 400 or 429 HTTP response if the request exceeds Notion's Request limits.
+        #
+        # @option options [id] :id
+        #   Block to get children info on.
+        #
+        # @option options [[Object]] :children
+        #   Children blocks to append
+        def block_append_children(options = {})
+          throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
+          patch("blocks/#{options[:id]}/children", options)
+        end
+      end
+    end
+  end
+end