notion 1.0.7 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 260bf00a0f7ffc3dec1cbf364c69815e5dcbf829677710e5b740bd58476ca9f7
-  data.tar.gz: 7220c9399aca9756e4773dda4b5fbdd573bd3decfe32758797ea11e309e6f0e0
+  metadata.gz: f33fd46038d04e6945365a27f4c06bf271606c26738e0f829b303cf62bbb516d
+  data.tar.gz: 92e51354718ea8c3d947e77f1aa9073cb654312e8783f9e375d246b8f2145188
 SHA512:
-  metadata.gz: d5933ae50944a7f77e6c68410d4291935b769869b59f71817dabd98df2e5a50f86f6200c4b7bc9800249e274c4e3ecd1e5d339df66cb08e258c50c25308e3bba
-  data.tar.gz: e01f29a16242b81b586d7852062efe030a760f30620096a691be6ee47c45de3d5f1b1ef7ce0f166a6c3328e3972ca470aaffd51b235f8d9f2f6c8b6ead69c193
+  metadata.gz: b0c40153c1ec62514f1c6cea7c3a1c6e48bd5180c1eff123b92873527368ca64922a24ab1a9de28c33084a1e248e8a9d702456f3b7efc412bca9b9487dbb947e
+  data.tar.gz: a67029c37053b49be748fb5268ec1022be91194723fd9a4e68657cbc1baf9d0d1e13a5cf75e1f23dc2a4851ae611cf511c46aff2afc59e0fbcad347e256ef6c3

data/README.md

@@ -310,8 +310,12 @@ From here, you can instantiate the Notion Client with the following code:
 )
 ```
 ### Retrieve a full-page Collection View
-Currently, either a "normal" Page URL or the Page Block ID is accepted to the `get_page` method. Therefore, if you pass the full URL to the CV Table, it will raise an error:
-```text
-the URL or ID passed to the get_page method must be that of a Page Block.
+A full-page collection view must have a URL that follows the below pattern:
+https://www.notion.so/danmurphy/[page-id]?v=[view-id]
+Then, it can be retrieved with the following code:
+```ruby
+>>> @client = NotionAPI::Client.new(
+  "<insert_v2_token_here>"
+)
+>>> @client.get_page("https://www.notion.so/danmurphy/[page-id]?v=[view-id]")
 ```
-To avoid this, you must pass only the ID of the full-page collection-view to the `get_page` method. This is next up on the features list, so passing the full URL will be supported soon:smile:

data/lib/notion_api/blocks.rb

@@ -17,6 +17,7 @@ require_relative "notion_types/table_of_contents_block"
 require_relative "notion_types/text_block"
 require_relative "notion_types/todo_block"
 require_relative "notion_types/toggle_block"
+require_relative "notion_types/link_block"
 
 Classes = NotionAPI.constants.select { |c| NotionAPI.const_get(c).is_a? Class and c.to_s != 'BlockTemplate' and c.to_s != 'Core' and c.to_s !='Client' }
 notion_types = []

data/lib/notion_api/client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'core'
-require_relative 'blocks'
+require_relative "core"
+require_relative "blocks"
 
 module NotionAPI
   # acts as the 'main interface' to the methods of this package.

data/lib/notion_api/core.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require_relative 'utils'
-require 'httparty'
+require_relative "utils"
+require "httparty"
 
 module NotionAPI
   # the initial methods available to an instantiated Cloent object are defined
   class Core
     include Utils
-    @options = { 'cookies' => { :token_v2 => nil, 'x-active-user-header' => nil }, 'headers' => { 'Content-Type' => 'application/json' } }
-    @type_whitelist = 'divider'
+    @options = { "cookies" => { :token_v2 => nil, "x-active-user-header" => nil }, "headers" => { "Content-Type" => "application/json" } }
+    @type_whitelist = "divider"
 
     class << self
       attr_reader :options, :type_whitelist, :token_v2, :active_user_header
@@ -30,39 +30,16 @@ module NotionAPI
         pageId: clean_id,
         chunkNumber: 0,
         limit: 100,
-        verticalColumns: false
+        verticalColumns: false,
       }
-      jsonified_record_response = get_all_block_info(clean_id, request_body)
-      i = 0
-      while jsonified_record_response.empty? || jsonified_record_response['block'].empty?
-        return {} if i >= 10
+      jsonified_record_response = get_all_block_info(request_body)
 
-        jsonified_record_response = get_all_block_info(clean_id, request_body)
-        i += 1
-      end
-
-      block_id = clean_id
       block_type = extract_type(clean_id, jsonified_record_response)
       block_parent_id = extract_parent_id(clean_id, jsonified_record_response)
 
-      raise 'the URL or ID passed to the get_page method must be that of a Page Block.' if !['collection_view_page', 'page'].include?(block_type)
-
-      if block_type == "page"
-        block_title = extract_title(clean_id, jsonified_record_response)
-        PageBlock.new(block_id, block_title, block_parent_id)
-      elsif block_type == "collection_view_page"
-        collection_id = extract_collection_id(block_id, jsonified_record_response)
-        block_title = extract_collection_title(clean_id, collection_id, jsonified_record_response)
-        view_id = extract_view_ids(block_id, jsonified_record_response)[0]
-        schema = extract_collection_schema(collection_id, view_id, jsonified_record_response)
-        column_mappings = schema.keys
-        column_names = column_mappings.map { |mapping| schema[mapping]['name']}
-
-        collection_view_page = CollectionViewPage.new(block_id, block_title, block_parent_id, collection_id, view_id)
-        collection_view_page.instance_variable_set(:@column_names, column_names)
-        CollectionView.class_eval{attr_reader :column_names}
-        collection_view_page
-      end
+      raise ArgumentError, "the URL or ID passed to the get_page method must be that of a Page Block." if !["collection_view_page", "page"].include?(block_type)
+
+      get_instantiated_instance_for(block_type, clean_id, block_parent_id, jsonified_record_response)
     end
 
     def children(url_or_id = @id)
@@ -87,18 +64,41 @@ module NotionAPI
         pageId: clean_id,
         chunkNumber: 0,
         limit: 100,
-        verticalColumns: false
+        verticalColumns: false,
       }
-      jsonified_record_response = get_all_block_info(clean_id, request_body)
-      i = 0
-      while jsonified_record_response.empty?
-        return {} if i >= 10
+      jsonified_record_response = get_all_block_info(request_body)
 
-        jsonified_record_response = get_all_block_info(clean_id, request_body)
-        i += 1
-      end
+      # if no content, returns empty list
+      jsonified_record_response["block"][clean_id]["value"]["content"] || []
+    end
+
+    def extract_id(url_or_id)
+      # ! parse and clean the URL or ID object provided.
+      # ! url_or_id -> the block ID or URL : ``str``
+      http_or_https = url_or_id.match(/^(http|https)/) # true if http or https in url_or_id...
+      collection_view_match = url_or_id.match(/(\?v=)/)
 
-      jsonified_record_response['block'][clean_id]['value']['content'] || []
+      if (url_or_id.length == 36) && ((url_or_id.split("-").length == 5) && !http_or_https)
+        # passes if url_or_id is perfectly formatted already...
+        url_or_id
+      elsif (http_or_https && (url_or_id.split("-").last.length == 32)) || (!http_or_https && (url_or_id.length == 32)) || (collection_view_match)
+        # passes if either:
+        # 1. a URL is passed as url_or_id and the ID at the end is 32 characters long or
+        # 2. a URL is not passed and the ID length is 32 [aka unformatted]
+        pattern = [8, 13, 18, 23]
+        if collection_view_match
+          id_without_view = url_or_id.split("?")[0]
+          clean_id = id_without_view.split("/").last
+          pattern.each { |index| clean_id.insert(index, "-") }
+          clean_id
+        else
+          id = url_or_id.split("-").last
+          pattern.each { |index| id.insert(index, "-") }
+          id
+        end
+      else
+        raise ArgumentError, "Expected a Notion page URL or a page ID. Please consult the documentation for further information."
+      end
     end
 
     private
@@ -106,19 +106,19 @@ module NotionAPI
     def get_notion_id(body)
       # ! retrieves a users ID from the headers of a Notion response object.
       # ! body -> the body to send in the request : ``Hash``
-      Core.options['cookies'][:token_v2] = @@token_v2
-      Core.options['headers']['x-notion-active-user-header'] = @@active_user_header
-      cookies = Core.options['cookies']
-      headers = Core.options['headers']
+      Core.options["cookies"][:token_v2] = @@token_v2
+      Core.options["headers"]["x-notion-active-user-header"] = @@active_user_header
+      cookies = Core.options["cookies"]
+      headers = Core.options["headers"]
       request_url = URLS[:GET_BLOCK]
 
       response = HTTParty.post(
         request_url,
         body: body.to_json,
         cookies: cookies,
-        headers: headers
+        headers: headers,
       )
-      response.headers['x-notion-user-id']
+      response.headers["x-notion-user-id"]
     end
 
     def get_last_page_block_id(url_or_id)
@@ -132,48 +132,53 @@ module NotionAPI
         pageId: clean_id,
         chunkNumber: 0,
         limit: 100,
-        verticalColumns: false
+        verticalColumns: false,
       }
-      jsonified_record_response = get_all_block_info(clean_id, request_body)
-      i = 0
-      while jsonified_record_response.empty?
-        return {:properties => {title: [[block_title]]}, :format => {}} if i >= 10
+      jsonified_record_response = get_all_block_info(request_body)
 
-        jsonified_record_response = get_all_block_info(clean_id, request_body)
-        i += 1
-      end
-      properties = jsonified_record_response['block'][clean_id]['value']['properties']
-      formats = jsonified_record_response['block'][clean_id]['value']['format']
+      properties = jsonified_record_response["block"][clean_id]["value"]["properties"]
+      formats = jsonified_record_response["block"][clean_id]["value"]["format"]
       return {
-        :properties => properties,
-        :format => formats
-      }
+               :properties => properties,
+               :format => formats,
+             }
     end
 
-    def get_all_block_info(_clean_id, body)
+    def get_all_block_info(body, i = 0)
       # ! retrieves all info pertaining to a block Id.
       # ! clean_id -> the block ID or URL cleaned : ``str``
-      Core.options['cookies'][:token_v2] = @@token_v2
-      Core.options['headers']['x-notion-active-user-header'] = @@active_user_header
-      cookies = Core.options['cookies']
-      headers = Core.options['headers']
-
+      Core.options["cookies"][:token_v2] = @@token_v2
+      Core.options["headers"]["x-notion-active-user-header"] = @@active_user_header
+      cookies = Core.options["cookies"]
+      headers = Core.options["headers"]
       request_url = URLS[:GET_BLOCK]
 
       response = HTTParty.post(
         request_url,
         body: body.to_json,
         cookies: cookies,
-        headers: headers
+        headers: headers,
       )
 
-      JSON.parse(response.body)['recordMap']
+      jsonified_record_response = JSON.parse(response.body)["recordMap"]
+      response_invalid = (!jsonified_record_response || jsonified_record_response.empty? || jsonified_record_response["block"].empty?)
+
+      if i < 10 && response_invalid
+        i = i + 1
+        return get_all_block_info(body, i)
+      else
+        if i == 10 && response_invalid
+          raise InvalidClientInstantiationError, "Attempted to retrieve block 10 times and received an empty response each time. Please make sure you have a valid token_v2 value set. If you do, then try setting the 'active_user_header' variable as well."
+        else
+          return jsonified_record_response
+        end
+      end
     end
 
     def filter_nil_blocks(jsonified_record_response)
       # ! removes any blocks that are empty [i.e. have no title / content]
       # ! jsonified_record_responses -> parsed JSON representation of a notion response object : ``Json``
-      jsonified_record_response.empty? || jsonified_record_response['block'].empty? ? nil : jsonified_record_response['block']
+      jsonified_record_response.empty? || jsonified_record_response["block"].empty? ? nil : jsonified_record_response["block"]
     end
 
     def extract_title(clean_id, jsonified_record_response)
@@ -181,14 +186,13 @@ module NotionAPI
       # ! clean_id -> the cleaned block ID: ``str``
       # ! jsonified_record_response -> parsed JSON representation of a notion response object : ``Json``
       filter_nil_blocks = filter_nil_blocks(jsonified_record_response)
-      if filter_nil_blocks.nil? || filter_nil_blocks[clean_id].nil? || filter_nil_blocks[clean_id]['value']['properties'].nil?
+      if filter_nil_blocks.nil? || filter_nil_blocks[clean_id].nil? || filter_nil_blocks[clean_id]["value"]["properties"].nil?
         nil
       else
         # titles for images are called source, while titles for text-based blocks are called title, so lets dynamically grab it
         # https://stackoverflow.com/questions/23765996/get-all-keys-from-ruby-hash/23766007
-        title_value = filter_nil_blocks[clean_id]['value']['properties'].keys[0]
-        Core.type_whitelist.include?(filter_nil_blocks[clean_id]['value']['type']) ? nil : jsonified_record_response['block'][clean_id]['value']['properties'][title_value].flatten[0] 
-
+        title_value = filter_nil_blocks[clean_id]["value"]["properties"].keys[0]
+        Core.type_whitelist.include?(filter_nil_blocks[clean_id]["value"]["type"]) ? nil : jsonified_record_response["block"][clean_id]["value"]["properties"][title_value].flatten[0]
       end
     end
 
@@ -197,7 +201,7 @@ module NotionAPI
       # ! clean_id -> the cleaned block ID: ``str``
       # ! collection_id -> the collection ID: ``str``
       # ! jsonified_record_response -> parsed JSON representation of a notion response object : ``Json``
-      jsonified_record_response['collection'][collection_id]['value']['name'].flatten.join if jsonified_record_response['collection'] and jsonified_record_response['collection'][collection_id]['value']['name']
+      jsonified_record_response["collection"][collection_id]["value"]["name"].flatten.join if jsonified_record_response["collection"] and jsonified_record_response["collection"][collection_id]["value"]["name"]
     end
 
     def extract_type(clean_id, jsonified_record_response)
@@ -208,8 +212,7 @@ module NotionAPI
       if filter_nil_blocks.nil?
         nil
       else
-        filter_nil_blocks[clean_id]['value']['type']
-
+        filter_nil_blocks[clean_id]["value"]["type"]
       end
     end
 
@@ -217,80 +220,135 @@ module NotionAPI
       # ! extract parent ID from core JSON response object.
       # ! clean_id -> the block ID or URL cleaned : ``str``
       # ! jsonified_record_response -> parsed JSON representation of a notion response object : ``Json``
-      jsonified_record_response.empty? || jsonified_record_response['block'].empty? ? {} : jsonified_record_response['block'][clean_id]['value']['parent_id']
+      jsonified_record_response.empty? || jsonified_record_response["block"].empty? ? {} : jsonified_record_response["block"][clean_id]["value"]["parent_id"]
     end
 
     def extract_collection_id(clean_id, jsonified_record_response)
       # ! extract the collection ID
       # ! clean_id -> the block ID or URL cleaned : ``str``
       # ! jsonified_record_response -> parsed JSON representation of a notion response object : ``Json``
-      jsonified_record_response['block'][clean_id]['value']['collection_id']
+      jsonified_record_response["block"][clean_id]["value"]["collection_id"]
     end
 
     def extract_view_ids(clean_id, jsonified_record_response)
-      jsonified_record_response['block'][clean_id]['value']['view_ids'] || []
-    end
-    
-    def extract_id(url_or_id)
-      # ! parse and clean the URL or ID object provided.
-      # ! url_or_id -> the block ID or URL : ``str``
-      http_or_https = url_or_id.match(/^(http|https)/) # true if http or https in url_or_id...
-      if (url_or_id.length == 36) && ((url_or_id.split('-').length == 5) && !http_or_https)
-        # passes if url_or_id is perfectly formatted already...
-        url_or_id
-      elsif (http_or_https && (url_or_id.split('-').last.length == 32)) || (!http_or_https && (url_or_id.length == 32))
-        # passes if either:
-        # 1. a URL is passed as url_or_id and the ID at the end is 32 characters long or
-        # 2. a URL is not passed and the ID length is 32 [aka unformatted]
-        pattern = [8, 13, 18, 23]
-        id = url_or_id.split('-').last
-        pattern.each { |index| id.insert(index, '-') }
-        id
-      else
-        raise ArgumentError, 'Expected a Notion page URL or a page ID. Please consult the documentation for further information.'
-      end
+      jsonified_record_response["block"][clean_id]["value"]["view_ids"] || []
     end
 
+    # def extract_id(url_or_id)
+    #   # ! parse and clean the URL or ID object provided.
+    #   # ! url_or_id -> the block ID or URL : ``str``
+    #   http_or_https = url_or_id.match(/^(http|https)/) # true if http or https in url_or_id...
+    #   collection_view_match = url_or_id.match(/(\?v=)/)
+
+    #   if (url_or_id.length == 36) && ((url_or_id.split("-").length == 5) && !http_or_https)
+    #     # passes if url_or_id is perfectly formatted already...
+    #     url_or_id
+    #   elsif (http_or_https && (url_or_id.split("-").last.length == 32)) || (!http_or_https && (url_or_id.length == 32)) || (collection_view_match)
+    #     # passes if either:
+    #     # 1. a URL is passed as url_or_id and the ID at the end is 32 characters long or
+    #     # 2. a URL is not passed and the ID length is 32 [aka unformatted]
+    #     pattern = [8, 13, 18, 23]
+    #     if collection_view_match
+    #       id_without_view = url_or_id.split("?")[0]
+    #       clean_id = id_without_view.split("/").last
+    #       pattern.each { |index| clean_id.insert(index, "-") }
+    #       clean_id
+    #     else
+    #       id = url_or_id.split("-").last
+    #       pattern.each { |index| id.insert(index, "-") }
+    #       id
+    #     end
+    #   else
+    #     raise ArgumentError, "Expected a Notion page URL or a page ID. Please consult the documentation for further information."
+    #   end
+    # end
+
     def extract_collection_schema(collection_id, view_id, response = {})
       # ! retrieve the collection scehma. Useful for 'building' the backbone for a table.
       # ! collection_id -> the collection ID : ``str``
       # ! view_id -> the view ID : ``str``
-      cookies = Core.options['cookies']
-      headers = Core.options['headers']
+      cookies = Core.options["cookies"]
+      headers = Core.options["headers"]
 
       if response.empty?
-        query_collection_hash = Utils::CollectionViewComponents.query_collection(collection_id, view_id, '')
+        query_collection_hash = Utils::CollectionViewComponents.query_collection(collection_id, view_id, "")
 
         request_url = URLS[:GET_COLLECTION]
         response = HTTParty.post(
           request_url,
           body: query_collection_hash.to_json,
           cookies: cookies,
-          headers: headers
+          headers: headers,
         )
-        response['recordMap']['collection'][collection_id]['value']['schema']
+        response["recordMap"]["collection"][collection_id]["value"]["schema"]
       else
-        response['collection'][collection_id]['value']['schema']
+        response["collection"][collection_id]["value"]["schema"]
       end
     end
-    
+
     def extract_collection_data(collection_id, view_id)
       # ! retrieve the collection scehma. Useful for 'building' the backbone for a table.
       # ! collection_id -> the collection ID : ``str``
       # ! view_id -> the view ID : ``str``
-      cookies = Core.options['cookies']
-      headers = Core.options['headers']
+      cookies = Core.options["cookies"]
+      headers = Core.options["headers"]
 
-      query_collection_hash = Utils::CollectionViewComponents.query_collection(collection_id, view_id, '')
+      query_collection_hash = Utils::CollectionViewComponents.query_collection(collection_id, view_id, "")
 
       request_url = URLS[:GET_COLLECTION]
       response = HTTParty.post(
         request_url,
         body: query_collection_hash.to_json,
         cookies: cookies,
-        headers: headers
+        headers: headers,
       )
-      response['recordMap']
+      response["recordMap"]
+    end
+
+    def extract_page_information(page_meta = {})
+      # ! helper method for extracting information about a page block
+      # ! page_meta -> hash containing data points useful for the extraction of a page blocks information.
+      # !           This should include clean_id, jsonified_record_response, and parent_id
+      clean_id = page_meta.fetch(:clean_id)
+      jsonified_record_response = page_meta.fetch(:jsonified_record_response)
+      block_parent_id = page_meta.fetch(:parent_id)
+
+      block_title = extract_title(clean_id, jsonified_record_response)
+      PageBlock.new(clean_id, block_title, block_parent_id)
+    end
+
+    def extract_collection_view_page_information(page_meta = {})
+      # ! helper method for extracting information about a Collection View page block
+      # ! page_meta -> hash containing data points useful for the extraction of a page blocks information.
+      # !           This should include clean_id, jsonified_record_response, and parent_id
+      clean_id = page_meta.fetch(:clean_id)
+      jsonified_record_response = page_meta.fetch(:jsonified_record_response)
+      block_parent_id = page_meta.fetch(:parent_id)
+
+      collection_id = extract_collection_id(clean_id, jsonified_record_response)
+      block_title = extract_collection_title(clean_id, collection_id, jsonified_record_response)
+      view_id = extract_view_ids(clean_id, jsonified_record_response)[0]
+      schema = extract_collection_schema(collection_id, view_id, jsonified_record_response)
+      column_names = NotionAPI::CollectionView.extract_collection_view_column_names(schema)
+
+      collection_view_page = CollectionViewPage.new(clean_id, block_title, block_parent_id, collection_id, view_id)
+      collection_view_page.instance_variable_set(:@column_names, column_names)
+      CollectionView.class_eval { attr_reader :column_names }
+      collection_view_page
+    end
+
+    def get_instantiated_instance_for(block_type, clean_id, parent_id, jsonified_record_response)
+      case block_type
+      when "page" then extract_page_information(clean_id: clean_id, parent_id: parent_id, jsonified_record_response: jsonified_record_response)
+      when "collection_view_page" then extract_collection_view_page_information(clean_id: clean_id, parent_id: parent_id, jsonified_record_response: jsonified_record_response)
+      end
+    end
+
+    class InvalidClientInstantiationError < StandardError
+      def initialize(msg = "Custom exception that is raised when an invalid property type is passed as a mapping.", exception_type = "instantiation_type")
+        @exception_type = exception_type
+        super(msg)
+      end
     end
   end
 end