notion-ruby-client 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: feb78b4f0ea816f89e61d9da9d1280e8d4d3565e0a71b1d611c2c58a1b5b7f67
-  data.tar.gz: e21ab58acc5a8414bfaccf21071a68e3ab37b11933448faed332347f597bc89b
+  metadata.gz: 8e4e676c9ca818a9cdcab31f6b085d00860bd74a102f668fdbe60cd209eaa442
+  data.tar.gz: 57c19debac66cc452d441ce718bdd4f1d410c2884ac1b422d75cfe0fa228b043
 SHA512:
-  metadata.gz: 39b6ffaf9f003c928c8eb358237419f68a0578d84f8e7ce0e3eaa548afffd5754fe721696335c6476f7a02dbf0975b1d0095496eeaa6ef01bf658234efbf9882
-  data.tar.gz: 9174977cdd22e7af3516a118d2c282f60bebaea8ef756d9cc0eef5cbcbfb5ef285cb6cadfe35e738c31b62778893257c0498d8150beae8d02ab495867c9c3610
+  metadata.gz: fb1a69701d1b81d3209f9b4d36fb73e204d60fd6239be0b922fa7ea6ebf5ac24ec62bf7949cbfee34867ec5da706d1446ccde8a733d46eefad3fe6dda9cd2929
+  data.tar.gz: 38dde2575a611e67d4b6222f6c79299aef06869e72963765ba850ad567c1b36b77e5cb521c60c1ba9044537b6a4a7f781e276604e0770c61b69b96726596f97c

data/.github/workflows/ci.yml

@@ -4,7 +4,7 @@ jobs:
   test:
     strategy:
       matrix:
-        ruby: [2.5, 2.6, 2.7]
+        ruby: [2.6, 2.7, '3.0', 3.1, 3.2]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
@@ -12,4 +12,4 @@ jobs:
         with:
           bundler-cache: true
           ruby-version: ${{ matrix.ruby }}
-      - run: bundle exec rake
+      - run: bundle exec rake spec

data/.github/workflows/rubocop.yml

@@ -0,0 +1,17 @@
+name: RuboCop
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+        bundler-cache: true # 'bundle install' and cache
+    - name: Run RuboCop
+      run: bundle exec rake rubocop

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+### 1.2.0 (2023-02-26)
+
+#### New
+
+- Add support for the following new endpoints (thanks @themoffatt!):
+  - [Create comment](https://developers.notion.com/reference/create-a-comment)
+  - [Retrieve comments](https://developers.notion.com/reference/retrieve-a-comment)
+
+### 1.1.0 (2023-02-23)
+
+#### Breaking changes
+
+- Remove support for ruby 2.5
+- Remove the `activesupport` dependency. Add `gem 'activesupport'` to your Gemfile if you required ActiveSupport via this library.
+
+#### Other
+
+- Upgrade Faraday to v2 (thanks @Tao-Galasse!)
+
 ### 1.0.0 (2022-03-30)
 
 #### New

data/Gemfile.lock

@@ -1,62 +1,36 @@
 PATH
   remote: .
   specs:
-    notion-ruby-client (1.0.0)
-      activesupport (>= 6)
+    notion-ruby-client (1.2.0)
       dotenv
-      faraday (>= 1.0)
-      faraday_middleware
+      faraday (>= 2.0)
+      faraday-mashify (>= 0.1.1)
+      faraday-multipart (>= 1.0.4)
       hashie (~> 5)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (6.1.5)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
-    concurrent-ruby (1.1.10)
     crack (0.4.5)
       rexml
     diff-lcs (1.4.4)
-    dotenv (2.7.6)
-    faraday (1.10.0)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0)
-      faraday-multipart (~> 1.0)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.0)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      faraday-retry (~> 1.0)
+    dotenv (2.8.1)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.3)
-      multipart-post (>= 1.2, < 3)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    faraday-retry (1.0.3)
-    faraday_middleware (1.2.0)
-      faraday (~> 1.0)
+    faraday-mashify (0.1.1)
+      faraday (~> 2.0)
+      hashie
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (3.0.2)
     hashdiff (1.0.1)
     hashie (5.0.0)
-    i18n (1.10.0)
-      concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
-    minitest (5.15.0)
-    multipart-post (2.1.1)
+    multipart-post (2.3.0)
     parallel (1.20.1)
     parser (3.0.1.1)
       ast (~> 2.4.1)
@@ -92,15 +66,12 @@ GEM
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     timecop (0.9.4)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)
     vcr (6.0.0)
     webmock (3.13.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.5.4)
 
 PLATFORMS
   arm64-darwin-20

data/README.md

@@ -32,6 +32,10 @@ A Ruby client for the Notion API.
     - [Delete a block](#delete-a-block)
     - [Retrieve block children](#retrieve-block-children)
     - [Append block children](#append-block-children)
+  - [Comments](#comments)
+    - [Retrieve comments](#retrieve-comments-from-a-page-or-block-by-id)
+    - [Create a comment on a page](#create-a-comment-on-a-page)
+    - [Create a comment on a discussion](#create-a-comment-on-a-discussion)
   - [Users](#users)
     - [Retrieve your token's bot user](#retrieve-your-tokens-bot-user)
     - [Retrieve a user](#retrieve-a-user)
@@ -129,9 +133,9 @@ client.database_query(database_id: 'e383bcee-e0d8-4564-9c63-900d307abdb0') do |p
 end
 
 # Filter and sort the database
-sort = [
+sorts = [
   {
-    'property': 'Last ordered',
+    'timestamp': 'created_time',
     'direction': 'ascending'
   }
 ]
@@ -151,7 +155,7 @@ filter = {
     }
   ]
 }
-client.database_query(database_id: 'e383bcee-e0d8-4564-9c63-900d307abdb0', sort: sort, filter: filter)
+client.database_query(database_id: 'e383bcee-e0d8-4564-9c63-900d307abdb0', sorts: sorts, filter: filter)
 ```
 
 See [Pagination](#pagination) for details about how to iterate through the list.
@@ -273,7 +277,7 @@ See the full endpoint documentation on [Notion Developers](https://developers.no
 
 Creates a new page in the specified database or as a child of an existing page.
 
-If the parent is a database, the [property values](https://developers.notion.com/reference-link/page-property-value) of the new page in the properties parameter must conform to the parent [database](https://developers.notion.com/reference-link/database)'s property schema.
+If the parent is a database, the [property values](https://developers.notion.com/reference-link/page-property-values) of the new page in the properties parameter must conform to the parent [database](https://developers.notion.com/reference-link/database)'s property schema.
 
 If the parent is a page, the only valid property is `title`.
 
@@ -314,14 +318,14 @@ children = [
     'type': 'heading_2',
     'heading_2': {
       'rich_text': [{
-        'type": 'text',
+        'type': 'text',
         'text': { 'content': 'Lacinato kale' }
       }]
     }
   },
   {
     'object': 'block',
-    'type": 'paragraph',
+    'type': 'paragraph',
     'paragraph': {
       'rich_text': [
         {
@@ -463,6 +467,43 @@ client.block_append_children(block_id: 'b55c9c91-384d-452b-81db-d1ef79372b75', c
 
 See the full endpoint documentation on [Notion Developers](https://developers.notion.com/reference/patch-block-children).
 
+### Comments
+
+#### Retrieve comments from a page or block by id
+```ruby
+client.retrieve_comments(block_id: '1a2f70ab26154dc7a838536a3f430af4')
+```
+#### Create a comment on a page
+```ruby
+options = {
+  parent: { page_id: '3e4bc91d36c74de595113b31c6fdb82c' },
+  rich_text: [
+    {
+      text: {
+        content: 'Hello world'
+      }
+    }
+  ]
+}
+client.create_comment(options)
+```
+#### Create a comment on a discussion
+```ruby
+options = {
+  discussion_id: 'ea116af4839c410bb4ac242a18dc4392',
+  rich_text: [
+    {
+      text: {
+        content: 'Hello world'
+      }
+    }
+  ]
+}
+client.create_comment(options)
+```
+
+See the full endpoint documention on [Notion Developers](https://developers.notion.com/reference/comment-object).
+
 ### Users
 
 #### Retrieve your token's bot user

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

@@ -28,8 +28,9 @@ module Notion
         #   updated. Currently only text (for supported block types)
         #   and checked (for to_do blocks) fields can be updated.
         def update_block(options = {})
-          throw ArgumentError.new('Required arguments :block_id missing') if options[:block_id].nil?
-          patch("blocks/#{options[:block_id]}", options.except(:block_id))
+          block_id = options.delete(:block_id)
+          throw ArgumentError.new('Required arguments :block_id missing') if block_id.nil?
+          patch("blocks/#{block_id}", options)
         end
 
         #
@@ -67,7 +68,8 @@ module Notion
               yield page
             end
           else
-            get("blocks/#{options[:block_id]}/children", options.except(:block_id))
+            block_id = options.delete(:block_id)
+            get("blocks/#{block_id}/children", options)
           end
         end
 
@@ -88,8 +90,9 @@ module Notion
         # @option options [[Object]] :children
         #   Children blocks to append
         def block_append_children(options = {})
-          throw ArgumentError.new('Required arguments :block_id missing') if options[:block_id].nil?
-          patch("blocks/#{options[:block_id]}/children", options.except(:block_id))
+          block_id = options.delete(:block_id)
+          throw ArgumentError.new('Required arguments :block_id missing') if block_id.nil?
+          patch("blocks/#{block_id}/children", options)
         end
       end
     end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+module Notion
+  module Api
+    module Endpoints
+      module Comments
+        #
+        # Retrieves a list of un-resolved Comment objects from a page or block.
+        #
+        # @option options [id] :block_id
+        #   Block or page id to fetch comments for.
+        #
+        # @option options [start_cursor] :start_cursor
+        #   If supplied, this endpoint will return a page
+        #   of results starting after the cursor provided.
+        #   If not supplied, this endpoint will return the
+        #   first page of results.
+        #
+        # @option options [page_size] :page_size
+        #   The number of items from the full list desired in the response.
+        #   Maximum: 100
+        #
+        def retrieve_comments(options = {})
+          throw ArgumentError.new('Required arguments :block_id missing') if options[:block_id].nil?
+          if block_given?
+            Pagination::Cursor.new(self, :retrieve_comments, options).each do |page|
+              yield page
+            end
+          else
+            get('comments', options)
+          end
+        end
+
+        #
+        # Creates a comment in a page or existing discussion thread.
+        #   There are two locations you can add a new comment to:
+        #     - A page
+        #     - An existing discussion thread
+        #   If the intention is to add a new comment to a page, a parent object
+        #   must be provided in the body params. Alternatively, if a new comment
+        #   is being added to an existing discussion thread, the discussion_id string
+        #   must be provided in the body params. Exactly one of these parameters must be provided.
+        #
+        # @option options [Object] :parent
+        #   A page parent. Either this or a discussion_id is required (not both).
+        #
+        # @option options [UUID] :discussion_id
+        #   A UUID identifier for a discussion thread. Either this or a parent object is required (not both).
+        #
+        # @option options [Object] :rich_text
+        #   A rich text object.
+        def create_comment(options = {})
+          if options.dig(:parent, :page_id).nil? && options[:discussion_id].nil?
+            throw ArgumentError.new('Required argument :page_id or :discussion_id missing')
+          end
+          throw ArgumentError.new('Required argument :rich_text missing') if options[:rich_text].nil?
+          post('comments', options)
+        end
+      end
+    end
+  end
+end

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

@@ -40,7 +40,8 @@ module Notion
               yield page
             end
           else
-            post("databases/#{options[:database_id]}/query", options.except(:database_id))
+            database_id = options.delete(:database_id)
+            post("databases/#{database_id}/query", options)
           end
         end
 
@@ -84,8 +85,9 @@ module Notion
         #   the name of the database property and the value is a property schema object.
         #
         def update_database(options = {})
-          throw ArgumentError.new('Required arguments :database_id missing') if options.dig(:database_id).nil?
-          patch("databases/#{options[:database_id]}", options.except(:database_id))
+          database_id = options.delete(:database_id)
+          throw ArgumentError.new('Required arguments :database_id missing') if database_id.nil?
+          patch("databases/#{database_id}", options)
         end
 
         #

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

@@ -60,8 +60,9 @@ module Notion
         #   appears in Notion, or property ID. value object Object containing a value
         #   specific to the property type, e.g. {"checkbox": true}.
         def update_page(options = {})
-          throw ArgumentError.new('Required argument :page_id missing') if options[:page_id].nil?
-          patch("pages/#{options[:page_id]}", options.except(:page_id))
+          page_id = options.delete(:page_id)
+          throw ArgumentError.new('Required argument :page_id missing') if page_id.nil?
+          patch("pages/#{page_id}", options)
         end
 
         #

data/lib/notion/api/endpoints.rb

@@ -5,6 +5,7 @@ require_relative 'endpoints/databases'
 require_relative 'endpoints/pages'
 require_relative 'endpoints/users'
 require_relative 'endpoints/search'
+require_relative 'endpoints/comments'
 
 module Notion
   module Api
@@ -14,6 +15,7 @@ module Notion
       include Pages
       include Users
       include Search
+      include Comments
     end
   end
 end

data/lib/notion/config.rb

@@ -24,8 +24,8 @@ module Notion
     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.ca_path = nil
+      self.ca_file = nil
       self.token = nil
       self.proxy = nil
       self.logger = nil

data/lib/notion/faraday/connection.rb

@@ -21,11 +21,11 @@ module Notion
             options[:request] = request_options if request_options.any?
 
             ::Faraday::Connection.new(endpoint, options) do |connection|
-              connection.use ::Faraday::Request::Multipart
+              connection.use ::Faraday::Multipart::Middleware
               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 ::Faraday::Mashify::Middleware, mash_class: Notion::Messages::Message
+              connection.use ::Faraday::Response::Json
               connection.use ::Notion::Faraday::Response::WrapError
               connection.response :logger, logger if logger
               connection.adapter adapter
@@ -34,4 +34,4 @@ module Notion
       end
     end
   end
-end
+end

data/lib/notion/faraday/request.rb

@@ -42,4 +42,4 @@ module Notion
       end
     end
   end
-end
+end

data/lib/notion/faraday/response/raise_error.rb

@@ -2,7 +2,7 @@
 module Notion
   module Faraday
     module Response
-      class RaiseError < ::Faraday::Response::Middleware
+      class RaiseError < ::Faraday::Response::Json
         def on_complete(env)
           raise Notion::Api::Errors::TooManyRequests, env.response if env.status == 429
 
@@ -28,4 +28,4 @@ module Notion
       end
     end
   end
-end
+end

data/lib/notion/faraday/response/wrap_error.rb

@@ -2,7 +2,7 @@
 module Notion
   module Faraday
     module Response
-      class WrapError < ::Faraday::Response::Middleware
+      class WrapError < ::Faraday::Response::Json
         UNAVAILABLE_ERROR_STATUSES = (500..599).freeze
 
         def on_complete(env)
@@ -19,4 +19,4 @@ module Notion
       end
     end
   end
-end
+end

data/lib/notion/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Notion
-  VERSION = '1.0.0'
+  VERSION = '1.2.0'
   NOTION_REQUEST_VERSION = '2022-02-22'
 end

data/lib/notion-ruby-client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
-require 'active_support/core_ext/hash/except'
 require 'faraday'
-require 'faraday_middleware'
+require 'faraday/mashify'
+require 'faraday/multipart'
 require 'json'
 require 'logger'
 require 'hashie'

data/notion-ruby-client.gemspec

@@ -15,10 +15,10 @@ Gem::Specification.new do |s|
   s.homepage = 'http://github.com/orbit-love/notion-ruby-client'
   s.licenses = ['MIT']
   s.summary = 'Notion API client for Ruby.'
-  s.add_dependency 'activesupport', '>= 6'
   s.add_dependency 'dotenv'
-  s.add_dependency 'faraday', '>= 1.0'
-  s.add_dependency 'faraday_middleware'
+  s.add_dependency 'faraday', '>= 2.0'
+  s.add_dependency 'faraday-mashify', '>= 0.1.1'
+  s.add_dependency 'faraday-multipart', '>= 1.0.4'
   s.add_dependency 'hashie', '~> 5'
   s.add_development_dependency 'rake', '~> 13'
   s.add_development_dependency 'rspec'

data/spec/fixtures/notion/create_discussion_comment.yml

@@ -0,0 +1,110 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.notion.com/v1/comments
+    body:
+      encoding: UTF-8
+      string: '{"rich_text":[{"text":{"content":"test comment"}}],"discussion_id":"ea116af4839c410bb4ac242a18dc4392"}'
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      User-Agent:
+      - Notion Ruby Client/1.0.0
+      Authorization:
+      - Bearer <NOTION_API_TOKEN>
+      Notion-Version:
+      - '2022-02-22'
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 02 Sep 2022 16:29:26 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - notion_browser_id=060fba74-6b6c-4d17-bd99-ac0aaa23aefd; Domain=www.notion.so;
+        Path=/; Expires=Sat, 02 Sep 2023 16:29:26 GMT; Secure
+      - notion_check_cookie_consent=false; Domain=www.notion.so; Path=/; Expires=Sat,
+        03 Sep 2022 16:29:26 GMT; Secure
+      Content-Security-Policy:
+      - "script-src 'self' 'unsafe-inline' 'unsafe-eval' https://gist.github.com https://apis.google.com
+        https://www.google.com https://www.gstatic.com https://cdn.amplitude.com https://api.amplitude.com
+        https://hkfxbbdzib.notion.so https://widget.intercom.io https://js.intercomcdn.com
+        https://static.zdassets.com https://api.smooch.io\t https://logs-01.loggly.com
+        https://http-inputs-notion.splunkcloud.com https://cdn.segment.com https://analytics.pgncs.notion.so
+        https://o324374.ingest.sentry.io https://checkout.stripe.com https://js.stripe.com
+        https://embed.typeform.com https://admin.typeform.com https://public.profitwell.com
+        js.sentry-cdn.com https://js.chilipiper.com https://platform.twitter.com https://cdn.syndication.twimg.com
+        https://accounts.google.com www.googletagmanager.com https://www.googleadservices.com
+        https://googleads.g.doubleclick.net https://api-v2.mutinyhq.io https://client-registry.mutinycdn.com
+        https://client.mutinycdn.com https://user-data.mutinycdn.com;connect-src 'self'
+        https://msgstore.www.notion.so wss://msgstore.www.notion.so ws://localhost:*
+        ws://127.0.0.1:* https://notion-emojis.s3-us-west-2.amazonaws.com https://s3-us-west-2.amazonaws.com
+        https://s3.us-west-2.amazonaws.com https://notion-production-snapshots-2.s3.us-west-2.amazonaws.com
+        https://cdn.amplitude.com https://api.amplitude.com https://hkfxbbdzib.notion.so
+        https://www.notion.so https://api.embed.ly https://js.intercomcdn.com https://api-iam.intercom.io
+        https://uploads.intercomcdn.com wss://nexus-websocket-a.intercom.io https://ekr.zdassets.com
+        https://ekr.zendesk.com\t https://makenotion.zendesk.com\t https://api.smooch.io\t
+        wss://api.smooch.io\t https://logs-01.loggly.com https://http-inputs-notion.splunkcloud.com
+        https://cdn.segment.com https://api.segment.io https://analytics.pgncs.notion.so
+        https://api.pgncs.notion.so https://o324374.ingest.sentry.io https://checkout.stripe.com
+        https://js.stripe.com https://cdn.contentful.com https://preview.contentful.com
+        https://images.ctfassets.net https://www2.profitwell.com https://tracking.chilipiper.com
+        https://api.chilipiper.com https://api.unsplash.com https://boards-api.greenhouse.io
+        https://accounts.google.com https://oauth2.googleapis.com https://www.googleadservices.com
+        https://googleads.g.doubleclick.net https://region1.google-analytics.com https://region1.analytics.google.com
+        https://www.google-analytics.com https://api-v2.mutinyhq.io https://client-registry.mutinycdn.com
+        https://client.mutinycdn.com https://user-data.mutinycdn.com https://api.statuspage.io
+        https://pgncd.notion.so https://api.statsig.com https://statsigapi.net https://exp.notion.so
+        https://file.notion.so;font-src 'self' data: https://cdnjs.cloudflare.com
+        https://js.intercomcdn.com;img-src 'self' data: blob: https: https://platform.twitter.com
+        https://syndication.twitter.com https://pbs.twimg.com https://ton.twimg.com
+        https://region1.google-analytics.com https://region1.analytics.google.com;style-src
+        'self' 'unsafe-inline' https://cdnjs.cloudflare.com https://github.githubassets.com
+        https://js.chilipiper.com https://platform.twitter.com https://ton.twimg.com
+        https://accounts.google.com;frame-src https: http: https://accounts.google.com;media-src
+        https: http: https://file.notion.so"
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Frame-Options:
+      - SAMEORIGIN
+      Strict-Transport-Security:
+      - max-age=5184000; includeSubDomains
+      X-Download-Options:
+      - noopen
+      X-Content-Type-Options:
+      - nosniff
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Referrer-Policy:
+      - strict-origin-when-cross-origin
+      X-Xss-Protection:
+      - '0'
+      Etag:
+      - W/"250-4FWWLrU/GwY9p/XT7GcTdthccMw"
+      Vary:
+      - Accept-Encoding
+      Cf-Cache-Status:
+      - DYNAMIC
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 74479fdd5a4e2940-ORD
+    body:
+      encoding: UTF-8
+      string: '{"object":"comment","id":"9e908609-bfcd-42d2-8f54-61c39d82351d","parent":{"type":"block_id","block_id":"1a2f70ab-2615-4dc7-a838-536a3f430af4"},"discussion_id":"ea116af4-839c-410b-b4ac-242a18dc4392","created_time":"2022-09-02T16:29:00.000Z","last_edited_time":"2022-09-02T16:29:00.000Z","created_by":{"object":"user","id":"3eb712e5-c1d7-43f2-ae18-c4d36f846aa1"},"rich_text":[{"type":"text","text":{"content":"test
+        comment","link":null},"annotations":{"bold":false,"italic":false,"strikethrough":false,"underline":false,"code":false,"color":"default"},"plain_text":"test
+        comment","href":null}]}'
+  recorded_at: Fri, 02 Sep 2022 16:29:26 GMT
+recorded_with: VCR 6.0.0

data/spec/fixtures/notion/create_page_comment.yml

@@ -0,0 +1,110 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.notion.com/v1/comments
+    body:
+      encoding: UTF-8
+      string: '{"rich_text":[{"text":{"content":"test comment"}}],"parent":{"page_id":"3e4bc91d36c74de595113b31c6fdb82c"}}'
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      User-Agent:
+      - Notion Ruby Client/1.0.0
+      Authorization:
+      - Bearer <NOTION_API_TOKEN>
+      Notion-Version:
+      - '2022-02-22'
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 02 Sep 2022 16:26:31 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - notion_browser_id=fd495a20-5f77-4a87-a210-adb2144bd55b; Domain=www.notion.so;
+        Path=/; Expires=Sat, 02 Sep 2023 16:26:31 GMT; Secure
+      - notion_check_cookie_consent=false; Domain=www.notion.so; Path=/; Expires=Sat,
+        03 Sep 2022 16:26:31 GMT; Secure
+      Content-Security-Policy:
+      - "script-src 'self' 'unsafe-inline' 'unsafe-eval' https://gist.github.com https://apis.google.com
+        https://www.google.com https://www.gstatic.com https://cdn.amplitude.com https://api.amplitude.com
+        https://hkfxbbdzib.notion.so https://widget.intercom.io https://js.intercomcdn.com
+        https://static.zdassets.com https://api.smooch.io\t https://logs-01.loggly.com
+        https://http-inputs-notion.splunkcloud.com https://cdn.segment.com https://analytics.pgncs.notion.so
+        https://o324374.ingest.sentry.io https://checkout.stripe.com https://js.stripe.com
+        https://embed.typeform.com https://admin.typeform.com https://public.profitwell.com
+        js.sentry-cdn.com https://js.chilipiper.com https://platform.twitter.com https://cdn.syndication.twimg.com
+        https://accounts.google.com www.googletagmanager.com https://www.googleadservices.com
+        https://googleads.g.doubleclick.net https://api-v2.mutinyhq.io https://client-registry.mutinycdn.com
+        https://client.mutinycdn.com https://user-data.mutinycdn.com;connect-src 'self'
+        https://msgstore.www.notion.so wss://msgstore.www.notion.so ws://localhost:*
+        ws://127.0.0.1:* https://notion-emojis.s3-us-west-2.amazonaws.com https://s3-us-west-2.amazonaws.com
+        https://s3.us-west-2.amazonaws.com https://notion-production-snapshots-2.s3.us-west-2.amazonaws.com
+        https://cdn.amplitude.com https://api.amplitude.com https://hkfxbbdzib.notion.so
+        https://www.notion.so https://api.embed.ly https://js.intercomcdn.com https://api-iam.intercom.io
+        https://uploads.intercomcdn.com wss://nexus-websocket-a.intercom.io https://ekr.zdassets.com
+        https://ekr.zendesk.com\t https://makenotion.zendesk.com\t https://api.smooch.io\t
+        wss://api.smooch.io\t https://logs-01.loggly.com https://http-inputs-notion.splunkcloud.com
+        https://cdn.segment.com https://api.segment.io https://analytics.pgncs.notion.so
+        https://api.pgncs.notion.so https://o324374.ingest.sentry.io https://checkout.stripe.com
+        https://js.stripe.com https://cdn.contentful.com https://preview.contentful.com
+        https://images.ctfassets.net https://www2.profitwell.com https://tracking.chilipiper.com
+        https://api.chilipiper.com https://api.unsplash.com https://boards-api.greenhouse.io
+        https://accounts.google.com https://oauth2.googleapis.com https://www.googleadservices.com
+        https://googleads.g.doubleclick.net https://region1.google-analytics.com https://region1.analytics.google.com
+        https://www.google-analytics.com https://api-v2.mutinyhq.io https://client-registry.mutinycdn.com
+        https://client.mutinycdn.com https://user-data.mutinycdn.com https://api.statuspage.io
+        https://pgncd.notion.so https://api.statsig.com https://statsigapi.net https://exp.notion.so
+        https://file.notion.so;font-src 'self' data: https://cdnjs.cloudflare.com
+        https://js.intercomcdn.com;img-src 'self' data: blob: https: https://platform.twitter.com
+        https://syndication.twitter.com https://pbs.twimg.com https://ton.twimg.com
+        https://region1.google-analytics.com https://region1.analytics.google.com;style-src
+        'self' 'unsafe-inline' https://cdnjs.cloudflare.com https://github.githubassets.com
+        https://js.chilipiper.com https://platform.twitter.com https://ton.twimg.com
+        https://accounts.google.com;frame-src https: http: https://accounts.google.com;media-src
+        https: http: https://file.notion.so"
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Frame-Options:
+      - SAMEORIGIN
+      Strict-Transport-Security:
+      - max-age=5184000; includeSubDomains
+      X-Download-Options:
+      - noopen
+      X-Content-Type-Options:
+      - nosniff
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Referrer-Policy:
+      - strict-origin-when-cross-origin
+      X-Xss-Protection:
+      - '0'
+      Etag:
+      - W/"24e-lwOvl3pLRgq3uaVwDU7YNYGeauA"
+      Vary:
+      - Accept-Encoding
+      Cf-Cache-Status:
+      - DYNAMIC
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 74479b9bdc202d94-ORD
+    body:
+      encoding: UTF-8
+      string: '{"object":"comment","id":"95ef4675-e3c0-428c-b937-ac8d6805ac04","parent":{"type":"page_id","page_id":"3e4bc91d-36c7-4de5-9511-3b31c6fdb82c"},"discussion_id":"4cbe01af-8163-4b03-957d-cac2691b9839","created_time":"2022-09-02T16:26:00.000Z","last_edited_time":"2022-09-02T16:26:00.000Z","created_by":{"object":"user","id":"3eb712e5-c1d7-43f2-ae18-c4d36f846aa1"},"rich_text":[{"type":"text","text":{"content":"test
+        comment","link":null},"annotations":{"bold":false,"italic":false,"strikethrough":false,"underline":false,"code":false,"color":"default"},"plain_text":"test
+        comment","href":null}]}'
+  recorded_at: Fri, 02 Sep 2022 16:26:31 GMT
+recorded_with: VCR 6.0.0

data/spec/fixtures/notion/retrieve_comments.yml

@@ -0,0 +1,106 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.notion.com/v1/comments?block_id=1a2f70ab26154dc7a838536a3f430af4
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      User-Agent:
+      - Notion Ruby Client/1.0.0
+      Authorization:
+      - Bearer <NOTION_API_TOKEN>
+      Notion-Version:
+      - '2022-02-22'
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 02 Sep 2022 16:21:51 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - notion_browser_id=86d25b85-2df9-4e71-abd7-1d3e0b02bc8a; Domain=www.notion.so;
+        Path=/; Expires=Sat, 02 Sep 2023 16:21:51 GMT; Secure
+      - notion_check_cookie_consent=false; Domain=www.notion.so; Path=/; Expires=Sat,
+        03 Sep 2022 16:21:51 GMT; Secure
+      Content-Security-Policy:
+      - "script-src 'self' 'unsafe-inline' 'unsafe-eval' https://gist.github.com https://apis.google.com
+        https://www.google.com https://www.gstatic.com https://cdn.amplitude.com https://api.amplitude.com
+        https://hkfxbbdzib.notion.so https://widget.intercom.io https://js.intercomcdn.com
+        https://static.zdassets.com https://api.smooch.io\t https://logs-01.loggly.com
+        https://http-inputs-notion.splunkcloud.com https://cdn.segment.com https://analytics.pgncs.notion.so
+        https://o324374.ingest.sentry.io https://checkout.stripe.com https://js.stripe.com
+        https://embed.typeform.com https://admin.typeform.com https://public.profitwell.com
+        js.sentry-cdn.com https://js.chilipiper.com https://platform.twitter.com https://cdn.syndication.twimg.com
+        https://accounts.google.com www.googletagmanager.com https://www.googleadservices.com
+        https://googleads.g.doubleclick.net https://api-v2.mutinyhq.io https://client-registry.mutinycdn.com
+        https://client.mutinycdn.com https://user-data.mutinycdn.com;connect-src 'self'
+        https://msgstore.www.notion.so wss://msgstore.www.notion.so ws://localhost:*
+        ws://127.0.0.1:* https://notion-emojis.s3-us-west-2.amazonaws.com https://s3-us-west-2.amazonaws.com
+        https://s3.us-west-2.amazonaws.com https://notion-production-snapshots-2.s3.us-west-2.amazonaws.com
+        https://cdn.amplitude.com https://api.amplitude.com https://hkfxbbdzib.notion.so
+        https://www.notion.so https://api.embed.ly https://js.intercomcdn.com https://api-iam.intercom.io
+        https://uploads.intercomcdn.com wss://nexus-websocket-a.intercom.io https://ekr.zdassets.com
+        https://ekr.zendesk.com\t https://makenotion.zendesk.com\t https://api.smooch.io\t
+        wss://api.smooch.io\t https://logs-01.loggly.com https://http-inputs-notion.splunkcloud.com
+        https://cdn.segment.com https://api.segment.io https://analytics.pgncs.notion.so
+        https://api.pgncs.notion.so https://o324374.ingest.sentry.io https://checkout.stripe.com
+        https://js.stripe.com https://cdn.contentful.com https://preview.contentful.com
+        https://images.ctfassets.net https://www2.profitwell.com https://tracking.chilipiper.com
+        https://api.chilipiper.com https://api.unsplash.com https://boards-api.greenhouse.io
+        https://accounts.google.com https://oauth2.googleapis.com https://www.googleadservices.com
+        https://googleads.g.doubleclick.net https://region1.google-analytics.com https://region1.analytics.google.com
+        https://www.google-analytics.com https://api-v2.mutinyhq.io https://client-registry.mutinycdn.com
+        https://client.mutinycdn.com https://user-data.mutinycdn.com https://api.statuspage.io
+        https://pgncd.notion.so https://api.statsig.com https://statsigapi.net https://exp.notion.so
+        https://file.notion.so;font-src 'self' data: https://cdnjs.cloudflare.com
+        https://js.intercomcdn.com;img-src 'self' data: blob: https: https://platform.twitter.com
+        https://syndication.twitter.com https://pbs.twimg.com https://ton.twimg.com
+        https://region1.google-analytics.com https://region1.analytics.google.com;style-src
+        'self' 'unsafe-inline' https://cdnjs.cloudflare.com https://github.githubassets.com
+        https://js.chilipiper.com https://platform.twitter.com https://ton.twimg.com
+        https://accounts.google.com;frame-src https: http: https://accounts.google.com;media-src
+        https: http: https://file.notion.so"
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Frame-Options:
+      - SAMEORIGIN
+      Strict-Transport-Security:
+      - max-age=5184000; includeSubDomains
+      X-Download-Options:
+      - noopen
+      X-Content-Type-Options:
+      - nosniff
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Referrer-Policy:
+      - strict-origin-when-cross-origin
+      X-Xss-Protection:
+      - '0'
+      Etag:
+      - W/"2a4-a2pWQq0rrllNzewHfiDfmBJ/vB8"
+      Vary:
+      - Accept-Encoding
+      Cf-Cache-Status:
+      - DYNAMIC
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 744794c32dac2c80-ORD
+    body:
+      encoding: UTF-8
+      string: '{"object":"list","results":[{"object":"comment","id":"8539f829-54f8-4389-a4a3-a6bc3d40636a","parent":{"type":"block_id","block_id":"1a2f70ab-2615-4dc7-a838-536a3f430af4"},"discussion_id":"ea116af4-839c-410b-b4ac-242a18dc4392","created_time":"2022-09-02T16:19:00.000Z","last_edited_time":"2022-09-02T16:19:00.000Z","created_by":{"object":"user","id":"240574f5-3adc-498c-a504-7733b0ea337b"},"rich_text":[{"type":"text","text":{"content":"hello!","link":null},"annotations":{"bold":false,"italic":false,"strikethrough":false,"underline":false,"code":false,"color":"default"},"plain_text":"hello!","href":null}]}],"next_cursor":null,"has_more":false,"type":"comment","comment":{}}'
+  recorded_at: Fri, 02 Sep 2022 16:21:51 GMT
+recorded_with: VCR 6.0.0

data/spec/notion/api/endpoints/comments_spec.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe Notion::Api::Endpoints::Comments do
+  let(:client) { Notion::Client.new }
+  let(:discussion_comment) do
+    {
+      discussion_id: 'ea116af4839c410bb4ac242a18dc4392',
+      rich_text: [
+        {
+          text: {
+            content: 'test comment'
+          }
+        }
+      ]
+    }
+  end
+  let(:page_comment) do
+    {
+      parent: { page_id: '3e4bc91d36c74de595113b31c6fdb82c' },
+      rich_text: [
+        {
+          text: {
+            content: 'test comment'
+          }
+        }
+      ]
+    }
+  end
+
+  describe '#retrieve_comments' do
+    it 'retrieves comments', vcr: { cassette_name: 'retrieve_comments' } do
+      response = client.retrieve_comments(block_id: '1a2f70ab26154dc7a838536a3f430af4')
+      expect(response.results.size).to eq 1
+    end
+  end
+
+  describe '#create_comment' do
+    it 'creates a comment on a page', vcr: { cassette_name: 'create_page_comment' } do
+      response = client.create_comment(page_comment)
+      expect(response.created_time).not_to be_empty
+    end
+
+    it 'creates a comment on a discussion', vcr: { cassette_name: 'create_discussion_comment' } do
+      response = client.create_comment(discussion_comment)
+      expect(response.created_time).not_to be_empty
+    end
+  end
+end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: notion-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Nicolas Goutay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-30 00:00:00.000000000 Z
+date: 2023-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: faraday-mashify
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-multipart
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.4
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -202,6 +202,7 @@ files:
 - ".devcontainer/boot.sh"
 - ".devcontainer/devcontainer.json"
 - ".github/workflows/ci.yml"
+- ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -219,6 +220,7 @@ files:
 - lib/notion.rb
 - lib/notion/api/endpoints.rb
 - lib/notion/api/endpoints/blocks.rb
+- lib/notion/api/endpoints/comments.rb
 - lib/notion/api/endpoints/databases.rb
 - lib/notion/api/endpoints/pages.rb
 - lib/notion/api/endpoints/search.rb
@@ -244,7 +246,9 @@ files:
 - spec/fixtures/notion/block_append_children.yml
 - spec/fixtures/notion/block_children.yml
 - spec/fixtures/notion/create_database.yml
+- spec/fixtures/notion/create_discussion_comment.yml
 - spec/fixtures/notion/create_page.yml
+- spec/fixtures/notion/create_page_comment.yml
 - spec/fixtures/notion/database.yml
 - spec/fixtures/notion/database_query.yml
 - spec/fixtures/notion/delete_block.yml
@@ -255,6 +259,7 @@ files:
 - spec/fixtures/notion/paginated_databases_list.yml
 - spec/fixtures/notion/paginated_search.yml
 - spec/fixtures/notion/paginated_users_list.yml
+- spec/fixtures/notion/retrieve_comments.yml
 - spec/fixtures/notion/search.yml
 - spec/fixtures/notion/search_with_query.yml
 - spec/fixtures/notion/update_block.yml
@@ -264,6 +269,7 @@ files:
 - spec/fixtures/notion/users_list.yml
 - spec/fixtures/notion/users_me.yml
 - spec/notion/api/endpoints/blocks_spec.rb
+- spec/notion/api/endpoints/comments_spec.rb
 - spec/notion/api/endpoints/databases_spec.rb
 - spec/notion/api/endpoints/pages_spec.rb
 - spec/notion/api/endpoints/search_spec.rb
@@ -302,7 +308,9 @@ test_files:
 - spec/fixtures/notion/block_append_children.yml
 - spec/fixtures/notion/block_children.yml
 - spec/fixtures/notion/create_database.yml
+- spec/fixtures/notion/create_discussion_comment.yml
 - spec/fixtures/notion/create_page.yml
+- spec/fixtures/notion/create_page_comment.yml
 - spec/fixtures/notion/database.yml
 - spec/fixtures/notion/database_query.yml
 - spec/fixtures/notion/delete_block.yml
@@ -313,6 +321,7 @@ test_files:
 - spec/fixtures/notion/paginated_databases_list.yml
 - spec/fixtures/notion/paginated_search.yml
 - spec/fixtures/notion/paginated_users_list.yml
+- spec/fixtures/notion/retrieve_comments.yml
 - spec/fixtures/notion/search.yml
 - spec/fixtures/notion/search_with_query.yml
 - spec/fixtures/notion/update_block.yml
@@ -322,6 +331,7 @@ test_files:
 - spec/fixtures/notion/users_list.yml
 - spec/fixtures/notion/users_me.yml
 - spec/notion/api/endpoints/blocks_spec.rb
+- spec/notion/api/endpoints/comments_spec.rb
 - spec/notion/api/endpoints/databases_spec.rb
 - spec/notion/api/endpoints/pages_spec.rb
 - spec/notion/api/endpoints/search_spec.rb