notion-ruby-client 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f21b181770c49f8d02f34bdcf949fbc19ccbbd7e7cb62bee02163abf64fd80f5
-  data.tar.gz: 599580c1772892e31227fe369fdb478408442c12320f8fb6109da32f58f516ca
+  metadata.gz: 20e1bb5a2a25417881a39465bc72a003d9f8a3fc59ab0fcfd3378a6c87759753
+  data.tar.gz: dfd32ada283cb93a62e8e9358abe25aadf56d1693ddd0b94e75d5a133669ed3c
 SHA512:
-  metadata.gz: 59d8fe6a3a90b9286cb5a09561263d4bb48330727d0c3daa0752aa11d5caeadeb02a66287e64dd9efa25dc72c31e0dc28aa91d233974ce93b3dda68734fabd75
-  data.tar.gz: 8d9c80c3d970fcb0e3715d325c091d3f95b85172850cc671c4a4f651e507e4b3adb8886aabd2a1288035be82f415013a26a5a3c583fc3db1e68d6926a2ebb3b9
+  metadata.gz: 937c7196eced3be3cd9cd811242bccae35e8101dd6a5194bf35a39184b02aa810854dc5dd925e2f10af62df3206a6388c8757723cb762d1179cab07952e85f9c
+  data.tar.gz: b651fdf6d3901fed41ebae4570267ca4641f6e84dd0b899622b02a5089dc98cedec5cbee005e523205f0c3d3824091ea2cb4f21947bf6edbb8a8450441ade347

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+### 0.0.3 (2020-01-30)
+
+- The gem now covers all available endpoints to date
+- Better error handling and logging
+
+### 0.0.2 (2020-01-29)
+
+- Fixed blocking bug present in 0.0.1
+
+### 0.0.1 (2020-01-29)
+
+- Initial alpha public release. Suffers from a bug that prevents installation.

data/lib/notion/api/endpoints.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 
+require_relative 'endpoints/databases'
+require_relative 'endpoints/pages'
 require_relative 'endpoints/users'
 
 module Notion
   module Api
     module Endpoints
+      include Databases
+      include Pages
       include Users
     end
   end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Notion
+  module Api
+    module Endpoints
+      module Databases
+        #
+        # Retrieves a Database object using the ID specified in the request.
+        #
+        # Returns a 404 HTTP response if the database doesn't exist, or if the bot
+        # doesn't have access to the database. Returns a 429 HTTP response if the
+        # request exceeds Notion's Request limits.
+        #
+        # @option options [id] :id
+        #   Database to get info on.
+        def database(options = {})
+          throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
+          get("databases/#{options[:id]}")
+        end
+
+        #
+        # Gets a paginated array of Page object s contained in the requested database,
+        # filtered and ordered according to the filter and sort objects provided in the request.
+        #
+        # Filters are similar to the filters provided in the Notion UI. Filters operate
+        # on database properties and can be combined. If no filter is provided, all the
+        # pages in the database will be returned with pagination.
+        #
+        # Sorts are similar to the sorts provided in the Notion UI. Sorts operate on
+        # database properties and can be combined. The order of the sorts in the request
+        # matter, with earlier sorts taking precedence over later ones.
+        #
+        # @option options [id] :id
+        #   Database to query.
+        #
+        # @option options [Object] :filter
+        #   When supplied, limits which pages are returned based on the provided criteria.
+        #
+        # @option options [[Object]] :sorts
+        #   When supplied, sorts the results based on the provided criteria.
+        #
+        # @option options [UUID] :start_cursor
+        #   Paginate through collections of data by setting the cursor parameter
+        #   to a start_cursor attribute returned by a previous request's next_cursor.
+        #   Default value fetches the first "page" of the collection.
+        #   See pagination for more detail.
+        def database_query(options = {})
+          throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
+          if block_given?
+            Pagination::Cursor.new(self, :database_query, options).each do |page|
+              yield page
+            end
+          else
+            post("databases/#{options[:id]}", options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Notion
+  module Api
+    module Endpoints
+      module Pages
+        #
+        # Retrieves a 📄Page object  using the ID specified in the request path.
+        # Note that this version of the API only exposes page properties, not page content
+        #
+        # @option options [id] :id
+        #   Page to get info on.
+        #
+        # @option options [bool] :archived
+        #   Set to true to retrieve an archived page; must be false or omitted to
+        #   retrieve a page that has not been archived. Defaults to false.
+        def page(options = {})
+          throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
+          get("pages/#{options[:id]}?archived=#{options[:archived]}")
+        end
+
+        #
+        # Creates a new page in the specified database.
+        # Later iterations of the API will support creating pages outside databases.
+        # Note that this iteration of the API will only expose page properties, not
+        # page content, as described in the data model.
+        #
+        # @option options [Object] :parent
+        #   Parent of the page, which is always going to be a database in this version of the API.
+        #
+        # @option options [Object] :properties
+        #   Properties of this page.
+        #   The schema for the page's keys and values is described by the properties of
+        #   the database this page belongs to. key string Name of a property as it
+        #   appears in Notion, or property ID. value object Object containing a value
+        #   specific to the property type, e.g. {"checkbox": true}.
+        def create_page(options = {})
+          throw ArgumentError.new('Required arguments :parent.database_id missing') if options.dig(:parent, :database_id).nil?
+          post("pages", options)
+        end
+
+        #
+        # Updates a page by setting the values of any properties specified in the
+        # JSON body of the request. Properties that are not set via parameters will
+        # remain unchanged.
+        #
+        # Note that this iteration of the API will only expose page properties, not page
+        # content, as described in the data model.
+        #
+        # @option options [id] :id
+        #   Page to get info on.
+        #
+        # @option options [Object] :properties
+        #   Properties of this page.
+        #   The schema for the page's keys and values is described by the properties of
+        #   the database this page belongs to. key string Name of a property as it
+        #   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 arguments :id missing') if options[:id].nil?
+          patch("pages/#{options[:id]}", options)
+        end
+      end
+    end
+  end
+end

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

@@ -16,15 +16,19 @@ module Notion
 
         #
         # Returns a paginated list of User objects for the workspace.
-        # @option options [Object] :start_cursor
-        # Paginate through collections of data by setting the cursor parameter to a start_cursor attribute returned by a previous request's next_cursor. Default value fetches the first "page" of the collection. See pagination for more detail.
+        #
+        # @option options [UUID] :start_cursor
+        # Paginate through collections of data by setting the cursor parameter
+        # to a start_cursor attribute returned by a previous request's next_cursor.
+        # Default value fetches the first "page" of the collection.
+        # See pagination for more detail.
         def users_list(options = {})
           if block_given?
             Pagination::Cursor.new(self, :users_list, options).each do |page|
               yield page
             end
           else
-            get("users?start_cursor=#{options[:start_cursor]}")
+            get("users", options)
           end
         end
       end

data/lib/notion/api/errors.rb

@@ -3,16 +3,22 @@
 module Notion
   module Api
     module Errors
+      class BadRequest < NotionError; end
+      class Forbidden < NotionError; end
       class InternalError < NotionError; end
       class InvalidRequest < NotionError; end
       class ObjectNotFound < NotionError; end
       class TooManyRequests < NotionError; end
+      class Unauthorized < NotionError; end
 
       ERROR_CLASSES = {
+        'bad_request' => BadRequest,
+        'forbidden' => Forbidden,
         'internal_error' => InternalError,
         'invalid_request' => InvalidRequest,
         'object_not_found' => ObjectNotFound,
-        'rate_limited' => TooManyRequests
+        'rate_limited' => TooManyRequests,
+        'unauthorized' => Unauthorized
       }.freeze
     end
   end

data/lib/notion/api/errors/notion_error.rb

@@ -5,8 +5,8 @@ module Notion
       class NotionError < ::Faraday::Error
         attr_reader :response
 
-        def initialize(message, response = nil)
-          super message
+        def initialize(message, details, response = nil)
+          super("#{message} #{details}")
           @response = response
         end
       end

data/lib/notion/faraday/request.rb

@@ -6,6 +6,10 @@ module Notion
         request(:get, path, options)
       end
 
+      def patch(path, options = {})
+        request(:patch, path, options)
+      end
+
       def post(path, options = {})
         request(:post, path, options)
       end
@@ -26,9 +30,10 @@ module Notion
           case method
           when :get, :delete
             request.url(path, options)
-          when :post, :put
+          when :post, :put, :patch
+            request.headers['Content-Type'] = 'application/json'
             request.path = path
-            request.body = options unless options.empty?
+            request.body = options.to_json unless options.empty?
           end
           request.options.merge!(options.delete(:request)) if options.key?(:request)
         end

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

@@ -6,19 +6,18 @@ module Notion
         def on_complete(env)
           raise Notion::Api::Errors::TooManyRequests, env.response if env.status == 429
 
-          return unless env.success?
+          return if env.success?
 
           body = env.body
           return unless body
-          return if env.status == 200
 
           error_code = body['code']
           error_message = body['message']
-          error_message = body['details']
+          error_details = body['details']
 
           error_class = Notion::Api::Errors::ERROR_CLASSES[error_code]
           error_class ||= Notion::Api::Errors::NotionError
-          raise error_class.new(error_message, env.response)
+          raise error_class.new(error_message, error_details, env.response)
         end
 
         def call(env)

data/lib/notion/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Notion
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notion-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Nicolas Goutay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-29 00:00:00.000000000 Z
+date: 2021-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -170,12 +170,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - Gemfile
 - LICENSE.md
 - README.md
 - lib/notion-ruby-client.rb
 - lib/notion.rb
 - lib/notion/api/endpoints.rb
+- lib/notion/api/endpoints/databases.rb
+- lib/notion/api/endpoints/pages.rb
 - lib/notion/api/endpoints/users.rb
 - lib/notion/api/error.rb
 - lib/notion/api/errors.rb