notion 1.0.5 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 529d9a75b50731156f263184b27628a2ee6b0b0cd798e3f3b44e5ea3f7106c60
-  data.tar.gz: eb5b69ebe9b9d34215d6da17e8c2999761e9242b2618afaaa6583ee09691c65d
+  metadata.gz: 3114ccf59f80a17322c559fce61050e7e7f1908a279e8786c4a8fe87e6fa79d8
+  data.tar.gz: a7c6fea5eb18a4d962117a4a5120bc357e0bf038640ba39db821d5bc3de230e6
 SHA512:
-  metadata.gz: '09ec6f516f22fac9f2b9c7c2efc3df164f83a745414cb18f092a6df939625435a77883712b86e100d7062536b189ddd8115145a52528cd5cc81767029f3bd250'
-  data.tar.gz: b643a46d9682d2ebb612c0d0c37454344f0f9abb580c1cf258887bc7a242afdc22af155c78b87434a00c38a048b206351ad453477d5c914393b1ff4ac68aeb97
+  metadata.gz: '06202342711853b35c0d694b4de7c89aec269f226d5ceda2c6b4e086f61f6e8f3e7381ca1d0389d85c2b3814d849dd980d9d6b3492a9d2a3d9c8bf9fbad71939'
+  data.tar.gz: 7561a58fff0a26b4190a79c713a4f89c3f85c1c5cca4bca21e2c9013ea3fa981f32e8779e9b771b243fe41a65c5b717f9a09e675e9c9590c3a09cf1f344ca02b

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/core.rb

@@ -235,17 +235,26 @@ module NotionAPI
       # ! 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))
+      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]
-        id = url_or_id.split('-').last
-        pattern.each { |index| id.insert(index, '-') }
-        id
+        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

data/lib/notion_api/notion_types/collection_view_blocks.rb

@@ -33,7 +33,9 @@ module NotionAPI
       transaction_id = extract_id(SecureRandom.hex(16))
       space_id = extract_id(SecureRandom.hex(16))
       new_block_id = extract_id(SecureRandom.hex(16))
-      schema = extract_collection_schema(@collection_id, @view_id)
+      collection_data = extract_collection_data(collection_id, view_id)
+      last_row_id = collection_data["collection_view"][@view_id]["value"]["page_sort"][-1]
+      schema = collection_data["collection"][collection_id]["value"]["schema"]
       keys = schema.keys
       col_map = {}
       keys.map { |key| col_map[schema[key]["name"]] = key }
@@ -47,17 +49,28 @@ module NotionAPI
       instantiate_row = Utils::CollectionViewComponents.add_new_row(new_block_id)
       set_block_alive = Utils::CollectionViewComponents.set_collection_blocks_alive(new_block_id, @collection_id)
       new_block_edited_time = Utils::BlockComponents.last_edited_time(new_block_id)
-      parent_edited_time = Utils::BlockComponents.last_edited_time(@parent_id)
+      page_sort = Utils::BlockComponents.row_location_add(last_row_id, new_block_id, @view_id)
 
       operations = [
         instantiate_row,
         set_block_alive,
         new_block_edited_time,
-        parent_edited_time,
+        page_sort,
       ]
 
       data.keys.each_with_index do |col_name, j|
-        child_component = Utils::CollectionViewComponents.insert_data(new_block_id, j.zero? ? "title" : col_map[col_name], data[col_name], j.zero? ? schema["title"]["type"] : schema[col_map[col_name]]["type"])
+        unless col_map.keys.include?(col_name.to_s); raise ArgumentError, "Column '#{col_name.to_s}' does not exist." end
+        if %q[select multi_select].include?(schema[col_map[col_name.to_s]]["type"])
+          options = schema[col_map[col_name.to_s]]["options"].nil? ? [] : schema[col_map[col_name.to_s]]["options"].map { |option| option["value"] }
+          multi_select_multi_options = data[col_name].split(",")
+          multi_select_multi_options.each do |option|
+            if !options.include?(option.strip)
+              create_new_option = Utils::CollectionViewComponents.add_new_option(col_map[col_name.to_s], option.strip, @collection_id)
+              operations.push(create_new_option)
+            end
+          end
+        end
+        child_component = Utils::CollectionViewComponents.insert_data(new_block_id, col_map[col_name.to_s], data[col_name], schema[col_map[col_name.to_s]]["type"])
         operations.push(child_component)
       end
 
@@ -73,7 +86,18 @@ module NotionAPI
       unless response.code == 200; raise "There was an issue completing your request. Here is the response from Notion: #{response.body}, and here is the payload that was sent: #{operations}.
            Please try again, and if issues persist open an issue in GitHub.";       end
 
-      NotionAPI::CollectionViewRow.new(new_block_id, @parent_id, @collection_id, @view_id)
+      collection_row = NotionAPI::CollectionViewRow.new(new_block_id, @parent_id, @collection_id, @view_id)
+
+      properties = {}
+      data.keys.each do |col|
+        properties[col_map[col.to_s]] = [[data[col]]]
+      end
+
+      collection_data["block"][collection_row.id] = { "role" => "editor", "value" => { "id" => collection_row.id, "version" => 12, "type" => "page", "properties" => properties, "created_time" => 1607253360000, "last_edited_time" => 1607253360000, "parent_id" => "dde513c6-2428-4a5d-a830-7a67fdbf6b48", "parent_table" => "collection", "alive" => true, "created_by_table" => "notion_user", "created_by_id" => "0c5f02f3-495d-4b73-b1c5-9f6fe03a8c26", "last_edited_by_table" => "notion_user", "last_edited_by_id" => "0c5f02f3-495d-4b73-b1c5-9f6fe03a8c26", "shard_id" => 955090, "space_id" => "f687f7de-7f4c-4a86-b109-941a8dae92d2" } }
+      row_data = collection_data["block"][collection_row.id]
+      create_singleton_methods_and_instance_variables(collection_row, row_data)
+
+      collection_row
     end
 
     def add_property(name, type)
@@ -204,6 +228,7 @@ module NotionAPI
       end
       clean_row_instances
     end
+
     def create_singleton_methods_and_instance_variables(row, row_data)
       # ! creates singleton methods for each property in a CollectionView.
       # ! row -> the block ID of the 'row' to retrieve: ``str``
@@ -213,22 +238,25 @@ module NotionAPI
       column_mappings = schema.keys
       column_hash = {}
       column_names = column_mappings.map { |mapping| column_hash[mapping] = schema[mapping]["name"].downcase }
-      
+
       column_hash.keys.each_with_index do |column, i|
         # loop over the column names...
         # set instance variables for each column, allowing the dev to 'read' the column value
-        cleaned_column = column_hash[column].split(" ").join("_").downcase.to_sym
+        cleaned_column = clean_property_names(column_hash, column)
 
         # p row_data["value"]["properties"][column_mappings[i]], !(row_data["value"]["properties"][column] or row_data["value"]["properties"][column_mappings[i]])
         if row_data["value"]["properties"].nil? or row_data["value"]["properties"][column].nil?
           value = ""
         else
-          value = row_data["value"]["properties"][column][0][0]  
+          value = row_data["value"]["properties"][column][0][0]
+          if ["‣"].include?(value.to_s)
+            value = row_data["value"]["properties"][column][0][1].flatten[-1]
+          end
         end
 
         row.instance_variable_set("@#{cleaned_column}", value)
         CollectionViewRow.class_eval { attr_reader cleaned_column }
-        # then, define singleton methods for each column that are used to update the table cell 
+        # then, define singleton methods for each column that are used to update the table cell
         row.define_singleton_method("#{cleaned_column}=") do |new_value|
           # neat way to get the name of the currently invoked method...
           parsed_method = __method__.to_s[0...-1].split("_").join(" ")
@@ -245,12 +273,23 @@ module NotionAPI
             space_id: space_id,
           }
 
-          update_property_value = Utils::CollectionViewComponents.update_property_value(@id, column_hash.key(parsed_method), new_value)
+          update_property_value_hash = Utils::CollectionViewComponents.update_property_value(@id, column_hash.key(parsed_method), new_value)
 
           operations = [
-            update_property_value,
+            update_property_value_hash,
           ]
 
+          if %q[select multi_select].include?(schema[column_hash.key(parsed_method)]["type"])
+            options = schema[column_hash.key(parsed_method)]["options"].nil? ? [] : schema[column_hash.key(parsed_method)]["options"].map { |option| option["value"] }
+            multi_select_multi_options = new_value.split(",")
+            multi_select_multi_options.each do |option|
+              if !options.include?(option.strip)
+                create_new_option = Utils::CollectionViewComponents.add_new_option(column_hash.key(parsed_method), option.strip, @collection_id)
+                operations.push(create_new_option)
+              end
+            end
+          end
+
           request_url = URLS[:UPDATE_BLOCK]
           request_body = build_payload(operations, request_ids)
           response = HTTParty.post(
@@ -260,14 +299,23 @@ module NotionAPI
             headers: headers,
           )
           unless response.code == 200; raise "There was an issue completing your request. Here is the response from Notion: #{response.body}, and here is the payload that was sent: #{operations}.
-               Please try again, and if issues persist open an issue in GitHub.";end
-          
+               Please try again, and if issues persist open an issue in GitHub.";           end
+
           # set the instance variable to the updated value!
           _ = row.instance_variable_set("@#{__method__.to_s[0...-1]}", new_value)
           row
         end
       end
     end
+
+    def clean_property_names(prop_hash, prop_notion_name)
+      # ! standardize property names by splitting the words in the property name into an array, removing non-alphanumeric
+      # ! characters, downcasing, and then re-joining the array with underscores.
+      # ! prop_hash -> hash of property notion names  and property textual names: ``str``
+      # ! prop_notion_name -> the four-character long name of the notion property: ``str``
+
+      prop_hash[prop_notion_name].split(" ").map { |word| word.gsub(/[^a-z0-9]/i, "").downcase }.join("_").to_sym
+    end
   end
 
   # class that represents each row in a CollectionView

data/lib/notion_api/utils.rb

@@ -200,14 +200,14 @@ module Utils
 
       args = if command == "listAfter"
           {
-                 after: target || block_id,
-                 id: new_block_id || block_id,
-               }
+            after: target || block_id,
+            id: new_block_id || block_id,
+          }
         else
           {
-                 before: target || block_id,
-                 id: new_block_id || block_id,
-               }
+            before: target || block_id,
+            id: new_block_id || block_id,
+          }
         end
 
       {
@@ -219,6 +219,21 @@ module Utils
       }
     end
 
+    def self.row_location_add(last_row_id, block_id, view_id)
+      {
+        "table": "collection_view",
+        "id": view_id,
+        "path": [
+            "page_sort"
+        ],
+        "command": "listAfter",
+        "args": {
+            "after": last_row_id,
+            "id": block_id
+        }
+    }
+    end
+
     def self.block_location_remove(block_parent_id, block_id)
       # ! removes a notion block
       # ! block_parent_id -> the parent ID of the block to remove : ``str``
@@ -276,9 +291,9 @@ module Utils
     def self.add_emoji_icon(block_id, icon)
       {
         id: block_id,
-        table:"block",
-        path:["format","page_icon"],
-        command:"set","args": icon
+        table: "block",
+        path: ["format", "page_icon"],
+        command: "set", "args": icon,
       }
     end
   end
@@ -383,14 +398,14 @@ module Utils
       # ! new_block_id -> id of the new block
       # ! data -> json data to insert into table.
       col_names = data[0].keys
-      data_mappings = {Integer => "number", String => "text", Array => "text", Float => "number", Date => "date"}
+      data_mappings = { Integer => "number", String => "text", Array => "text", Float => "number", Date => "date" }
       exceptions = [ArgumentError, TypeError]
       data_types = col_names.map do |name|
         # TODO: this is a little hacky... should probably think about a better way or add a requirement for user input to match a certain criteria.
-        begin 
+        begin
           DateTime.parse(data[0][name]) ? data_mappings[Date] : nil
         rescue *exceptions
-          data_mappings[data[0][name].class] 
+          data_mappings[data[0][name].class]
         end
       end
 
@@ -403,18 +418,18 @@ module Utils
         end
       end
       return {
-        id: collection_id,
-        table: "collection",
-        path: [],
-        command: "update",
-        args: {
-          id: collection_id,
-          schema: schema_conf,
-          parent_id: new_block_id,
-          parent_table: "block",
-          alive: true,
-        },
-      }, data_types
+               id: collection_id,
+               table: "collection",
+               path: [],
+               command: "update",
+               args: {
+                 id: collection_id,
+                 schema: schema_conf,
+                 parent_id: new_block_id,
+                 parent_table: "block",
+                 alive: true,
+               },
+             }, data_types
     end
 
     def self.set_collection_title(collection_title, collection_id)
@@ -440,6 +455,11 @@ module Utils
       # ! column -> the name of the column to insert data into.
       # ! value -> the value to insert into the column.
       # ! mapping -> the column data type.
+      simple_mappings = ["title", "text", "phone_number", "email", "url", "number", "checkbox", "select", "multi_select"]
+      datetime_mappings = ["date"]
+      media_mappings = ["file"]
+      person_mappings = ["person"]
+
       table = "block"
       path = [
         "properties",
@@ -447,12 +467,50 @@ module Utils
       ]
       command = "set"
 
+      if simple_mappings.include?(mapping)
+        args = [[value]]
+      elsif media_mappings.include?(mapping)
+        args = [[value, [["a", value]]]]
+      elsif datetime_mappings.include?(mapping)
+        args = [["‣", [["d", { "type": "date", "start_date": value }]]]]
+      elsif person_mappings.include?(mapping)
+        args = [["‣",
+          [["u", value]]
+        ]]
+        else 
+          raise SchemaTypeError, "Invalid property type: #{mapping}"
+      end
+
       {
-        id: block_id,
         table: table,
+        id: block_id,
+        command: command,
         path: path,
+        args: args,
+      }
+    end
+
+    def self.add_new_option(column, value, collection_id)
+      table = "collection"
+      path = ["schema", column, "options"]
+      command = "keyedObjectListAfter"
+      colors = ["default", "gray", "brown", "orange", "yellow", "green", "blue", "purple", "pink", "red"]
+      random_color = colors[rand(0...colors.length)]
+
+      args = {
+        "value": {
+            "id": SecureRandom.hex(16),
+            "value": value,
+            "color": random_color
+        }
+      }
+
+      {
+        table: table,
+        id: collection_id,
         command: command,
-        args: mapping == "date" ? [["‣",[["d",{"type": "date","start_date": value}]]]] : [[value]],
+        path: path,
+        args: args,
       }
     end
 
@@ -505,45 +563,45 @@ module Utils
       args["format"] = {
         "table_properties" => [
           {
-                  "property" => "title",
-                  "visible" => true,
-                  "width" => 280,
-                },
+            "property" => "title",
+            "visible" => true,
+            "width" => 280,
+          },
           {
-                  "property" => "aliases",
-                  "visible" => true,
-                  "width" => 200,
-                },
+            "property" => "aliases",
+            "visible" => true,
+            "width" => 200,
+          },
           {
-                  "property" => "category",
-                  "visible" => true,
-                  "width" => 200,
-                },
+            "property" => "category",
+            "visible" => true,
+            "width" => 200,
+          },
           {
-                  "property" => "description",
-                  "visible" => true,
-                  "width" => 200,
-                },
+            "property" => "description",
+            "visible" => true,
+            "width" => 200,
+          },
           {
-                  "property" => "ios_version",
-                  "visible" => true,
-                  "width" => 200,
-                },
+            "property" => "ios_version",
+            "visible" => true,
+            "width" => 200,
+          },
+          {
+            "property" => "tags",
+            "visible" => true,
+            "width" => 200,
+          },
           {
-                  "property" => "tags",
-                  "visible" => true,
-                  "width" => 200,
-                },
-                {
                   "property" => "phone",
                   "visible" => true,
                   "width" => 200,
                 },
           {
-                  "property" => "unicode_version",
-                  "visible" => true,
-                  "width" => 200,
-                }
+            "property" => "unicode_version",
+            "visible" => true,
+            "width" => 200,
+          },
         ],
       }
       {
@@ -563,11 +621,11 @@ module Utils
       table = "block"
       path = [
         "properties",
-        column_name
+        column_name,
       ]
       command = "set"
       args = [[
-        new_value
+        new_value,
       ]]
 
       {
@@ -575,11 +633,18 @@ module Utils
         table: table,
         path: path,
         command: command,
-        args: args
+        args: args,
       }
     end
   end
 
+  class SchemaTypeError < StandardError
+    def initialize(msg="Custom exception that is raised when an invalid property type is passed as a mapping.", exception_type="schema_type")
+      @exception_type = exception_type
+      super(msg)
+    end
+  end
+
   def build_payload(operations, request_ids)
     # ! properly formats the payload for Notions backend.
     # ! operations -> an array of hashes that define the operations to perform : ``Array[Hash]``
@@ -600,4 +665,4 @@ module Utils
     }
     payload
   end
-end
+end

data/lib/notion_api/version.rb

@@ -1,3 +1,3 @@
 module NotionAPI
-    VERSION = '1.0.5'
+    VERSION = '1.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notion
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.2
 platform: ruby
 authors:
 - Dan Murphy
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-04 00:00:00.000000000 Z
+date: 2020-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty