notion 1.0.6 → 1.1.3

data/lib/notion_api/notion_types/text_block.rb

@@ -1,16 +1,16 @@
 module NotionAPI
 
-    # good for just about anything (-:
-    class TextBlock < BlockTemplate
-      @notion_type = 'text'
-      @type = 'text'
-  
-      def type
-        NotionAPI::TextBlock.notion_type
-      end
-  
-      class << self
-        attr_reader :notion_type, :type
-      end
+  # good for just about anything (-:
+  class TextBlock < BlockTemplate
+    @notion_type = "text"
+    @type = "text"
+
+    def type
+      NotionAPI::TextBlock.notion_type
+    end
+
+    class << self
+      attr_reader :notion_type, :type
     end
-end
+  end
+end

data/lib/notion_api/notion_types/todo_block.rb

@@ -1,60 +1,60 @@
 module NotionAPI
 
-    # To-Do block: best for checklists and tracking to-dos.
-    class TodoBlock < BlockTemplate
-      @notion_type = 'to_do'
-      @type = 'to_do'
-  
-      def type
-        NotionAPI::TodoBlock.notion_type
-      end
-  
-      class << self
-        attr_reader :notion_type, :type
-      end
-  
-      def checked=(checked_value)
-        # ! change the checked property of the Todo Block.
-        # ! checked_value -> boolean value used to determine whether the block should be checked [yes] or not [no] : ``str``
-        # set static variables for request
-        cookies = Core.options['cookies']
-        headers = Core.options['headers']
-        request_url = URLS[:UPDATE_BLOCK]
-  
-        # set unique values for request
-        request_id = extract_id(SecureRandom.hex(16))
-        transaction_id = extract_id(SecureRandom.hex(16))
-        space_id = extract_id(SecureRandom.hex(16))
-        request_ids = {
-          request_id: request_id,
-          transaction_id: transaction_id,
-          space_id: space_id
-        }
-  
-        if %w[yes no].include?(checked_value.downcase)
-          checked_hash = Utils::BlockComponents.checked_todo(@id, checked_value.downcase)
-          last_edited_time_parent_hash = Utils::BlockComponents.last_edited_time(@parent_id)
-          last_edited_time_child_hash = Utils::BlockComponents.last_edited_time(@id)
-  
-          operations = [
-            checked_hash,
-            last_edited_time_parent_hash,
-            last_edited_time_child_hash
-          ]
-          request_body = build_payload(operations, request_ids)
-          response = HTTParty.post(
-            request_url,
-            body: request_body.to_json,
-            cookies: cookies,
-            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
-  
-          true
-        else
-          false
-        end
+  # To-Do block: best for checklists and tracking to-dos.
+  class TodoBlock < BlockTemplate
+    @notion_type = "to_do"
+    @type = "to_do"
+
+    def type
+      NotionAPI::TodoBlock.notion_type
+    end
+
+    class << self
+      attr_reader :notion_type, :type
+    end
+
+    def checked=(checked_value)
+      # ! change the checked property of the Todo Block.
+      # ! checked_value -> boolean value used to determine whether the block should be checked [yes] or not [no] : ``str``
+      # set static variables for request
+      cookies = Core.options["cookies"]
+      headers = Core.options["headers"]
+      request_url = URLS[:UPDATE_BLOCK]
+
+      # set unique values for request
+      request_id = extract_id(SecureRandom.hex(16))
+      transaction_id = extract_id(SecureRandom.hex(16))
+      space_id = extract_id(SecureRandom.hex(16))
+      request_ids = {
+        request_id: request_id,
+        transaction_id: transaction_id,
+        space_id: space_id,
+      }
+
+      if %w[yes no].include?(checked_value.downcase)
+        checked_hash = Utils::BlockComponents.checked_todo(@id, checked_value.downcase)
+        last_edited_time_parent_hash = Utils::BlockComponents.last_edited_time(@parent_id)
+        last_edited_time_child_hash = Utils::BlockComponents.last_edited_time(@id)
+
+        operations = [
+          checked_hash,
+          last_edited_time_parent_hash,
+          last_edited_time_child_hash,
+        ]
+        request_body = build_payload(operations, request_ids)
+        response = HTTParty.post(
+          request_url,
+          body: request_body.to_json,
+          cookies: cookies,
+          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
+
+        true
+      else
+        false
       end
     end
-end
+  end
+end

data/lib/notion_api/notion_types/toggle_block.rb

@@ -1,16 +1,16 @@
 module NotionAPI
 
-    # Toggle block: best for storing children blocks
-    class ToggleBlock < BlockTemplate
-      @notion_type = 'toggle'
-      @type = 'toggle'
-  
-      def type
-        NotionAPI::ToggleBlock.notion_type
-      end
-  
-      class << self
-        attr_reader :notion_type, :type
-      end
+  # Toggle block: best for storing children blocks
+  class ToggleBlock < BlockTemplate
+    @notion_type = "toggle"
+    @type = "toggle"
+
+    def type
+      NotionAPI::ToggleBlock.notion_type
+    end
+
+    class << self
+      attr_reader :notion_type, :type
     end
-end
+  end
+end

data/lib/notion_api/utils.rb

@@ -11,6 +11,27 @@ module Utils
   class BlockComponents
     # ! Each function defined here builds one component that is included in each request sent to Notions backend.
     # ! Each request sent will contain multiple components.
+    # TODO figure this out
+    def self.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]``
+      # ! request_ids -> the unique IDs for the request : ``str``
+      request_id = request_ids[:request_id]
+      transaction_id = request_ids[:transaction_id]
+      space_id = request_ids[:space_id]
+      payload = {
+        requestId: request_id,
+        transactions: [
+          {
+            id: transaction_id,
+            shardId: 955_090,
+            spaceId: space_id,
+            operations: operations,
+          },
+        ],
+      }
+      payload
+    end
     def self.create(block_id, block_type)
       # ! payload for creating a block.
       # ! block_id -> id of the new block : ``str``
@@ -200,14 +221,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 +240,25 @@ module Utils
       }
     end
 
+    def self.row_location_add(last_row_id, block_id, view_id)
+      # ! add a new row to a Collection View table
+      # ! last_row_id -> ID of the last row in the CV : ``str``
+      # ! block_id -> ID of the blow : ``str``
+      # ! view_id -> ID of the View : ``str``
+      {
+        "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``
@@ -274,11 +314,52 @@ module Utils
       }
     end
     def self.add_emoji_icon(block_id, icon)
+      # ! add an emoji icon for either a page or callout block
+      # ! block_id -> the ID of the block : ``str``
+      # ! icon -> the icon for the block. This is currently randomly chosen. : ``str``
       {
         id: block_id,
-        table:"block",
-        path:["format","page_icon"],
-        command:"set","args": icon
+        table: "block",
+        path: ["format", "page_icon"],
+        command: "set", "args": icon,
+      }
+    end
+
+    def self.source(new_block_id, url)
+      # ! set the source for the ImageBlock
+      # ! new_block_id -> the ID of the new ImageBlock: ``str``
+      # ! url -> the URL for the image
+      table = "block"
+      path = ["properties"]
+      command = "update"
+
+      {
+        id: new_block_id,
+        table: table,
+        path: path,
+        command: command,
+        args: {
+          source: [[
+            url,
+          ]],
+        },
+      }
+    end
+
+    def self.display_source(new_block_id, block_url)
+      # ! set the display source for the ImageBlock
+      # ! new_block_id -> the ID of the new ImageBlock: ``str``
+      # ! block_url -> the URL of the ImageBlock: ``str``
+      {
+        "id": new_block_id,
+        "table": "block",
+        "path": [
+          "format",
+        ],
+        "command": "update",
+        "args": {
+          "display_source": block_url,
+        },
       }
     end
   end
@@ -383,14 +464,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 +484,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 +521,12 @@ 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"]
+      page_mappings = ["relation"]
+
       table = "block"
       path = [
         "properties",
@@ -447,12 +534,52 @@ 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]]]]
+      elsif page_mappings.include?(mapping)
+        args = [["‣",
+                 [["p", 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
 
@@ -502,50 +629,7 @@ 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",
@@ -555,31 +639,46 @@ module Utils
       }
     end
 
-    def self.update_property_value(page_id, column_name, new_value)
+    def self.update_property_value(page_id, column_name, new_value, column_type)
       # ! update the specified column_name to new_value
       # ! page_id -> the ID of the page: ``str``
       # ! column_name -> the name of the column ["property"] to update: ``str``
       # ! new_value -> the new value to assign to that column ["property"]: ``str``
+      # ! column_type -> the type of the property: ``str``
       table = "block"
       path = [
         "properties",
-        column_name
+        column_name,
       ]
       command = "set"
-      args = [[
-        new_value
-      ]]
+
+      if column_type == "relation"
+        args = [["‣", [[
+          "p", new_value,
+        ]]]]
+      else
+        args = [[
+          new_value,
+        ]]
+      end
 
       {
         id: page_id,
         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]``