notion 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3ebde6eb43b792a313801584c8043c579e9fd356427df080a14c265e28cf2db
-  data.tar.gz: 9bf0242abe3ad4c15cebbb9a1cdd65ae64b6ec76a1d8e872836a90b5c2ec9404
+  metadata.gz: a5a96adb5d26c56e00d6f8a370b5c272bb69ecd33c57b4db37a483c8ddb70dca
+  data.tar.gz: ba367e26e35f4632a3fd25a2c9636b65eb14f602a06311715b4c80ec1a5154bf
 SHA512:
-  metadata.gz: 2f0b872d9f1eb4f88f05e4d8e41959291dc4b86bdb0be46582d196de095f174907b78c165c35140c7bc68b41b4cd6b7b7098ae23a3502d8adecc488e9185c03a
-  data.tar.gz: 8c69f7a02a7374a69590b4b1cdb92767557efaf7f56e5fa7fe3f8450f78c19e4fa9e37b5db8c46e9aef6661dda8dfc56692baeff57912769f052e831af9ae594
+  metadata.gz: 3d3f9703c7192ab1654b70b308973da70a9501a8b1d9500bbe310719b863aeade15afcf02acb041f701db657c59c41545ea1df0bff27798c6fca5860aff9fb8f
+  data.tar.gz: 13df40b25461a064419604046677f15e14aad820c7064be1d41ca0590f527198f4708156bbf3e9c16149ec61f1e20c65f1c8f2ddc9d9fc175e0ef959a7537ea3

data/README.md

@@ -2,7 +2,16 @@
 [![Build Status](https://travis-ci.com/danmurphy1217/notion-ruby.svg?branch=master)](https://travis-ci.com/danmurphy1217/notion-ruby) [![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop-hq/rubocop)
 
 ## Getting Started
-To get started using package, you'll first need to retrieve your token_v2 credentials by signing into Notion online, navigating to the developer tools, inspecting the cookies, and finding the value associated with the **token_v2** key.
+### Installation
+to install the gem:
+```ruby
+gem install notion
+```
+Then, place this at the top of your file:
+```ruby
+require 'notion_api' 
+```
+To get started using the gem, you'll first need to retrieve your token_v2 credentials by signing into Notion online, navigating to the developer tools, inspecting the cookies, and finding the value associated with the **token_v2** key.
 
 From here, you can instantiate the Notion Client with the following code:
 ```ruby

data/lib/notion_api/blocks.rb

@@ -322,11 +322,9 @@ module NotionAPI
 
       # build and set operations to send to Notion
       title_hash = Utils::BlockComponents.title(@id, new_title)
-      last_edited_time_parent_hash = Utils::BlockComponents.last_edited_time(@parent_id)
       last_edited_time_child_hash = Utils::BlockComponents.last_edited_time(@id)
       operations = [
         title_hash,
-        last_edited_time_parent_hash,
         last_edited_time_child_hash
       ]
 
@@ -516,13 +514,14 @@ module NotionAPI
       CollectionView.new(clean_id, block_title, block_parent_id, block_collection_id, block_view_id)
     end
 
-    def create_collection(_collection_type, collection_title, data)
+    def create_collection(collection_type, collection_title, data)
       # ! create a Notion Collection View and return its instantiated class object.
       # ! _collection_type -> the type of collection to create : ``str``
       # ! collection_title -> the title of the collection view : ``str``
       # ! data -> JSON data to add to the table : ``str``
 
-      unless %w[table].include?(_collection_type) ; raise ArgumentError, "That collection type is not yet supported. Try: \"table\"."; end
+      valid_types = %w[table board list timeline calendar gallery]
+      unless valid_types.include?(collection_type) ; raise ArgumentError, "That collection type is not yet supported. Try: #{valid_types.join}."; end
       cookies = Core.options['cookies']
       headers = Core.options['headers']
 
@@ -550,8 +549,12 @@ module NotionAPI
       }
 
       create_collection_view = Utils::CollectionViewComponents.create_collection_view(new_block_id, collection_id, view_id)
-      configure_view = Utils::CollectionViewComponents.set_view_config(new_block_id, view_id, children)
-      configure_columns = Utils::CollectionViewComponents.set_collection_columns(collection_id, new_block_id, data)
+      configure_view = Utils::CollectionViewComponents.set_view_config(collection_type, new_block_id, view_id, children)
+      
+      # returns the JSON and some useful column mappings...
+      column_data = Utils::CollectionViewComponents.set_collection_columns(collection_id, new_block_id, data)
+      configure_columns_hash = column_data[0]
+      column_mappings = column_data[1]
       set_parent_alive_hash = Utils::BlockComponents.set_parent_to_alive(@id, new_block_id)
       add_block_hash = Utils::BlockComponents.block_location_add(@id, @id, new_block_id, nil, 'listAfter')
       new_block_edited_time = Utils::BlockComponents.last_edited_time(new_block_id)
@@ -560,7 +563,7 @@ module NotionAPI
       operations = [
         create_collection_view,
         configure_view,
-        configure_columns,
+        configure_columns_hash,
         set_parent_alive_hash,
         add_block_hash,
         new_block_edited_time,
@@ -571,7 +574,7 @@ module NotionAPI
       data.each_with_index do |row, i|
         child = children[i]
         row.keys.each_with_index do |col_name, j|
-          child_component = Utils::CollectionViewComponents.insert_data(child, j.zero? ? 'title' : col_name, row[col_name])
+          child_component = Utils::CollectionViewComponents.insert_data(child, j.zero? ? 'title' : col_name, row[col_name], column_mappings[j])
           all_ops.push(child_component)
         end
       end
@@ -806,7 +809,7 @@ module NotionAPI
       ]
 
       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])
+        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'])
         operations.push(child_component)
       end
 

data/lib/notion_api/client.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 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

@@ -150,7 +150,7 @@ module NotionAPI
         # 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]
+        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
@@ -160,7 +160,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']
+      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)

data/lib/notion_api/utils.rb

@@ -3,9 +3,9 @@
 module Utils
   # ! defines utility functions and static variables for this application.
   URLS = {
-    GET_BLOCK: 'https://www.notion.so/api/v3/loadPageChunk',
-    UPDATE_BLOCK: 'https://www.notion.so/api/v3/saveTransactions',
-    GET_COLLECTION: 'https://www.notion.so/api/v3/queryCollection'
+    GET_BLOCK: "https://www.notion.so/api/v3/loadPageChunk",
+    UPDATE_BLOCK: "https://www.notion.so/api/v3/saveTransactions",
+    GET_COLLECTION: "https://www.notion.so/api/v3/queryCollection",
   }.freeze
 
   class BlockComponents
@@ -15,10 +15,10 @@ module Utils
       # ! payload for creating a block.
       # ! block_id -> id of the new block : ``str``
       # ! block_type -> type of block to create : ``cls``
-      table = 'block'
+      table = "block"
       path = []
-      command = 'update'
-      timestamp = DateTime.now.strftime('%Q')
+      command = "update"
+      timestamp = DateTime.now.strftime("%Q")
       {
         id: block_id,
         table: table,
@@ -29,41 +29,41 @@ module Utils
           type: block_type,
           properties: {},
           created_time: timestamp,
-          last_edited_time: timestamp
-        }
+          last_edited_time: timestamp,
+        },
       }
     end
 
     def self.title(id, title)
       # ! payload for updating the title of a block
       # ! id -> the ID to update the title of : ``str``
-      table = 'block'
+      table = "block"
       path = %w[properties title]
-      command = 'set'
+      command = "set"
 
       {
         id: id,
         table: table,
         path: path,
         command: command,
-        args: [[title]]
+        args: [[title]],
       }
     end
 
     def self.last_edited_time(id)
       # ! payload for updating the last edited time
       # ! id -> either the block ID or parent ID : ``str``
-      timestamp = DateTime.now.strftime('%Q')
-      table = 'block'
-      path = ['last_edited_time']
-      command = 'set'
+      timestamp = DateTime.now.strftime("%Q")
+      table = "block"
+      path = ["last_edited_time"]
+      command = "set"
 
       {
         table: table,
         id: id,
         path: path,
         command: command,
-        args: timestamp
+        args: timestamp,
       }
     end
 
@@ -71,9 +71,9 @@ module Utils
       # ! payload for converting a block to a different type.
       # ! id -> id of the block to convert : ``str``
       # ! block_class_to_convert_to -> type to convert to block to: ``NotionAPI::<Block_Type>``
-      table = 'block'
+      table = "block"
       path = []
-      command = 'update'
+      command = "update"
 
       {
         id: id,
@@ -81,8 +81,8 @@ module Utils
         path: path,
         command: command,
         args: {
-          type: block_class_to_convert_to.notion_type
-        }
+          type: block_class_to_convert_to.notion_type,
+        },
       }
     end
 
@@ -90,10 +90,10 @@ module Utils
       # ! payload for setting a blocks parent ID to 'alive'
       # ! block_parent_id -> the blocks parent ID : ``str``
       # ! new_block_id -> the new block ID, who is a child of the parent : ``str``
-      table = 'block'
+      table = "block"
       path = []
-      command = 'update'
-      parent_table = 'block'
+      command = "update"
+      parent_table = "block"
       alive = true
       {
         id: new_block_id,
@@ -103,17 +103,17 @@ module Utils
         args: {
           parent_id: block_parent_id,
           parent_table: parent_table,
-          alive: alive
-        }
+          alive: alive,
+        },
       }
     end
 
     def self.set_block_to_dead(block_id)
       # ! payload for setting a block to dead (alive == true)
       # ! block_id -> the block ID to 'kill' : ``str``
-      table = 'block'
+      table = "block"
       path = []
-      command = 'update'
+      command = "update"
       alive = false
 
       {
@@ -122,8 +122,8 @@ module Utils
         path: path,
         command: command,
         args: {
-          alive: alive
-        }
+          alive: alive,
+        },
       }
     end
 
@@ -136,10 +136,10 @@ module Utils
       # ! new_block_id -> id of new block : ``str``
       # ! user_notion_id -> ID of notion user : ``str``
       # ! contents -> The children of the block
-      timestamp = DateTime.now.strftime('%Q')
-      table = 'block'
+      timestamp = DateTime.now.strftime("%Q")
+      table = "block"
       path = []
-      command = 'update'
+      command = "update"
 
       {
         id: new_block_id,
@@ -151,17 +151,17 @@ module Utils
           version: 10,
           type: block_type,
           properties: {
-            title: [[block_title]]
+            title: [[block_title]],
           },
           content: contents, # root-level blocks
           created_time: timestamp,
           last_edited_time: timestamp,
-          created_by_table: 'notion_user',
+          created_by_table: "notion_user",
           created_by_id: user_notion_id,
-          last_edited_by_table: 'notion_user',
+          last_edited_by_table: "notion_user",
           last_edited_by_id: user_notion_id,
-          copied_from: block_id
-        }
+          copied_from: block_id,
+        },
       }
     end
 
@@ -169,10 +169,10 @@ module Utils
       # ! payload for adding a parent
       # ! block_parent_id -> the parent id of the block : ``str``
       # ! block_id -> the id of the block : ``str``
-      table = 'block'
+      table = "block"
       path = []
-      command = 'update'
-      parent_table = 'block'
+      command = "update"
+      parent_table = "block"
       alive = true
 
       {
@@ -183,8 +183,8 @@ module Utils
         args: {
           parent_id: block_parent_id,
           parent_table: parent_table,
-          alive: alive
-        }
+          alive: alive,
+        },
       }
     end
 
@@ -196,27 +196,27 @@ module Utils
       # ! new_block_id -> id of the new block: ``str``
       # ! target -> the ID of the target block : ``str``
       # ! command -> the position of the block, before or after, in relation to the target : ``str``
-      table = 'block'
-      path = ['content']
+      table = "block"
+      path = ["content"]
 
-      args = if command == 'listAfter'
-               {
+      args = if command == "listAfter"
+          {
                  after: target || block_id,
-                 id: new_block_id || block_id
+                 id: new_block_id || block_id,
                }
-             else
-               {
+        else
+          {
                  before: target || block_id,
-                 id: new_block_id || block_id
+                 id: new_block_id || block_id,
                }
-             end
+        end
 
       {
         table: table,
         id: block_parent_id, # ID of the parent for the new block. It should be the block that the method is invoked on.
         path: path,
         command: command,
-        args: args
+        args: args,
       }
     end
 
@@ -224,17 +224,17 @@ module Utils
       # ! removes a notion block
       # ! block_parent_id -> the parent ID of the block to remove : ``str``
       # ! block_id -> the ID of the block to remove : ``str``
-      table = 'block'
-      path = ['content']
-      command = 'listRemove'
+      table = "block"
+      path = ["content"]
+      command = "listRemove"
       {
         table: table,
         id: block_parent_id, # ID of the parent for the new block. It should be the block that the method is invoked on.
         path: path,
         command: command,
         args: {
-          id: block_id
-        }
+          id: block_id,
+        },
       }
     end
 
@@ -242,17 +242,17 @@ module Utils
       # ! payload for setting a "checked" value for TodoBlock.
       # ! block_id -> the ID of the block to remove : ``str``
       # ! standardized_check_val -> tyes/no value, determines the checked property of the block : ``str``
-      table = 'block'
-      path = ['properties']
-      command = 'update'
+      table = "block"
+      path = ["properties"]
+      command = "update"
       {
         id: block_id,
         table: table,
         path: path,
         command: command,
         args: {
-          checked: [[standardized_check_val]]
-        }
+          checked: [[standardized_check_val]],
+        },
       }
     end
 
@@ -260,9 +260,9 @@ module Utils
       # ! update the language for a codeblock
       # ! block_id -> id of the code block
       # ! coding_language -> language to change the block to.
-      table = 'block'
-      path = ['properties']
-      command = 'update'
+      table = "block"
+      path = ["properties"]
+      command = "update"
 
       {
         id: block_id,
@@ -270,8 +270,8 @@ module Utils
         path: path,
         command: command,
         args: {
-          language: [[coding_language]]
-        }
+          language: [[coding_language]],
+        },
       }
     end
   end
@@ -282,12 +282,12 @@ module Utils
       # ! new_block_id -> id of the new block
       # ! collection_id -> ID of the collection.
       # ! view_ids -> id of the view
-      table = 'block'
-      command = 'update'
+      table = "block"
+      command = "update"
       path = []
-      type = 'collection_view'
+      type = "collection_view"
       properties = {}
-      timestamp = DateTime.now.strftime('%Q')
+      timestamp = DateTime.now.strftime("%Q")
 
       {
         id: new_block_id,
@@ -299,12 +299,12 @@ module Utils
           type: type,
           collection_id: collection_id,
           view_ids: [
-            view_ids
+            view_ids,
           ],
           properties: properties,
           created_time: timestamp,
-          last_edited_time: timestamp
-        }
+          last_edited_time: timestamp,
+        },
       }
     end
 
@@ -312,14 +312,14 @@ module Utils
       # ! payload for setting the collection blocks to alive.
       # ! new_block_id -> id of the new block
       # ! collection_id -> ID of the collection.
-      table = 'block'
+      table = "block"
       path = []
-      command = 'update'
-      parent_table = 'collection'
+      command = "update"
+      parent_table = "collection"
       alive = true
-      type = 'page'
+      type = "page"
       properties = {}
-      timestamp = DateTime.now.strftime('%Q')
+      timestamp = DateTime.now.strftime("%Q")
 
       {
         id: new_block_id,
@@ -334,23 +334,22 @@ module Utils
           alive: alive,
           properties: properties,
           created_time: timestamp,
-          last_edited_time: timestamp
-        }
+          last_edited_time: timestamp,
+        },
       }
     end
 
-    def self.set_view_config(new_block_id, view_id, children_ids)
+    def self.set_view_config(collection_type, new_block_id, view_id, children_ids)
       # ! payload for setting the configurations of the view.
       # ! new_block_id -> id of the new block
       # ! view_id -> id of the view
       # ! children_ids -> IDs for the children of the collection.
-      table = 'collection_view'
+      table = "collection_view"
       path = []
-      command = 'update'
+      command = "update"
       version = 0
-      type = 'table'
-      name = 'Default View'
-      parent_table = 'block'
+      name = "Default View"
+      parent_table = "block"
       alive = true
 
       {
@@ -361,13 +360,13 @@ module Utils
         args: {
           id: view_id,
           version: version,
-          type: type,
+          type: collection_type,
           name: name,
           page_sort: children_ids,
           parent_id: new_block_id,
           parent_table: parent_table,
-          alive: alive
-        }
+          alive: alive,
+        },
       }
     end
 
@@ -377,75 +376,86 @@ 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"}
+      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 
+          DateTime.parse(data[0][name]) ? data_mappings[Date] : nil
+        rescue *exceptions
+          data_mappings[data[0][name].class] 
+        end
+      end
 
       schema_conf = {}
       col_names.each_with_index do |_name, i|
         if i.zero?
-          schema_conf[:title] = { name: col_names[i], type: 'title' }
+          schema_conf[:title] = { name: col_names[i], type: "title" }
         else
-          schema_conf[col_names[i]] = { name: col_names[i], type: 'text' }
+          schema_conf[col_names[i]] = { name: col_names[i], type: data_types[i] }
         end
       end
-      {
+      return {
         id: collection_id,
-        table: 'collection',
+        table: "collection",
         path: [],
-        command: 'update',
+        command: "update",
         args: {
           id: collection_id,
           schema: schema_conf,
           parent_id: new_block_id,
-          parent_table: 'block',
-          alive: true
-        }
-      }
+          parent_table: "block",
+          alive: true,
+        },
+      }, data_types
     end
 
     def self.set_collection_title(collection_title, collection_id)
       # ! payload for setting the title of the collection.
       # ! collection_title -> title of the collection.
       # ! collection_id -> ID of the collection.
-      table = 'collection'
-      path = ['name']
-      command = 'set'
+      table = "collection"
+      path = ["name"]
+      command = "set"
 
       {
         id: collection_id,
         table: table,
         path: path,
         command: command,
-        args: [[collection_title]]
+        args: [[collection_title]],
       }
     end
 
-    def self.insert_data(block_id, column, value)
+    def self.insert_data(block_id, column, value, mapping)
       # ! payload for inserting data into the table.
       # ! block_id -> the ID of the block : ``str``
       # ! column -> the name of the column to insert data into.
       # ! value -> the value to insert into the column.
-      table = 'block'
+      # ! mapping -> the column data type.
+      table = "block"
       path = [
-        'properties',
-        column
+        "properties",
+        column,
       ]
-      command = 'set'
+      command = "set"
 
       {
         id: block_id,
         table: table,
         path: path,
         command: command,
-        args: [[value]]
+        args: mapping == "date" ? [["‣",[["d",{"type": "date","start_date": value}]]]] : [[value]],
       }
     end
 
     def self.add_new_row(new_block_id)
       # ! payload for adding a new row to the table.
       # ! new_block_id -> the ID of the new row : ``str``
-      table = 'block'
+      table = "block"
       path = []
-      command = 'set'
-      type = 'page'
+      command = "set"
+      type = "page"
 
       {
         id: new_block_id,
@@ -455,29 +465,29 @@ module Utils
         args: {
           type: type,
           id: new_block_id,
-          version: 1
-        }
+          version: 1,
+        },
       }
     end
 
-    def self.query_collection(collection_id, view_id, search_query = '')
+    def self.query_collection(collection_id, view_id, search_query = "")
       # ! payload for querying the table for data.
       # ! collection_id -> the collection ID : ``str``
       # ! view_id -> the view ID : ``str``
       # ! search_query -> the query for searching the table : ``str``
       query = {}
       loader = {
-        type: 'table',
+        type: "table",
         limit: 100,
         searchQuery: search_query,
-        loadContentCover: true
+        loadContentCover: true,
       }
 
       {
         collectionId: collection_id,
         collectionViewId: view_id,
         query: query,
-        loader: loader
+        loader: loader,
       }
     end
 
@@ -485,12 +495,56 @@ module Utils
       # ! payload for adding a column to the table.
       # ! collection_id -> the collection ID : ``str``
       # ! args -> the definition of the column : ``str``
+      args["format"] = {
+        "table_properties" => [
+          {
+                  "property" => "title",
+                  "visible" => true,
+                  "width" => 280,
+                },
+          {
+                  "property" => "aliases",
+                  "visible" => true,
+                  "width" => 200,
+                },
+          {
+                  "property" => "category",
+                  "visible" => true,
+                  "width" => 200,
+                },
+          {
+                  "property" => "description",
+                  "visible" => true,
+                  "width" => 200,
+                },
+          {
+                  "property" => "ios_version",
+                  "visible" => true,
+                  "width" => 200,
+                },
+          {
+                  "property" => "tags",
+                  "visible" => true,
+                  "width" => 200,
+                },
+                {
+                  "property" => "phone",
+                  "visible" => true,
+                  "width" => 200,
+                },
+          {
+                  "property" => "unicode_version",
+                  "visible" => true,
+                  "width" => 200,
+                }
+        ],
+      }
       {
         id: collection_id,
-        table: 'collection',
+        table: "collection",
         path: [],
-        command: 'update',
-        args: args
+        command: "update",
+        args: args,
       }
     end
   end
@@ -509,9 +563,9 @@ module Utils
           id: transaction_id,
           shardId: 955_090,
           spaceId: space_id,
-          operations: operations
-        }
-      ]
+          operations: operations,
+        },
+      ],
     }
     payload
   end

data/lib/notion_api/version.rb

@@ -1,3 +1,3 @@
 module NotionAPI
-    VERSION = '1.0.0'
+    VERSION = '1.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notion
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Dan Murphy
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-26 00:00:00.000000000 Z
+date: 2020-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty