notion 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58ac8026dc81c27d34f42b51e388bd036b03d2338ef9113b43bcaee0bd57f6a2
-  data.tar.gz: 914d54deb74e73057b6d52f0c7a8227903b501250243f4d61d81c2196e42bc0f
+  metadata.gz: c99389e680f113f6288c7809f95c3c4b86b894c7c0b741dd774d5738b398b241
+  data.tar.gz: 1f995b8c4d27874a248bf99023efe02a96198231e0a7cfb51d139bbae45f6cac
 SHA512:
-  metadata.gz: bdb71d3859daaf1ded2f418cc348a9d3c3fb65cf446efd94df49dc28330355571b078415f8a48f53a31328c7f672f6e0b26f02176e8ec9702810e144c5341535
-  data.tar.gz: 035343a8e4fe1326b7e735d4a019db969d1c3d356faaf80f56fc861d60e9cdb3ee419fc9c776abaf7ffeaab0572a69dfec19fe42ab6362e600dd014f105c593e
+  metadata.gz: 65d7e7713162c1ca4e694972715d904b927dada01eb3c679f9470119bb7c35afa801ffc2894cba5485348a6ae1beb4b6df931af3fada0f74317d0ae1bd27d94d
+  data.tar.gz: 375a2c1357cd5a56064a86fe650e523ddaee2834d7d0e3039b6a73d17b5157e418a4f2fa298562748e1bee350fcf5221efe1880db8b60970f2462556c4bc8468

data/README.md

@@ -8,18 +8,23 @@
 - Check out the [Gem](https://rubygems.org/gems/notion)!
 
 ## Table of Contents
-- [Getting Started](#getting-started)
-  * [Installation](#installation)
-- [Retrieving a Page](#retrieving-a-page)
-- [Retrieving a Block within the Page](#retrieving-a-block-within-the-page)
-  * [Get a Block](#get-a-block)
-  * [Get a Collection View - Table](#get-a-collection-view---table)
-- [Creating New Blocks](#creating-new-blocks)
-  * [Create a block whose parent is the page](#create-a-block-whose-parent-is-the-page)
-  * [Create a block whose parent is another block](#create-a-block-whose-parent-is-another-block)
-- [Creating New Collections](#creating-new-collections)
-- [Troubleshooting](#troubleshooting)
-  * [No results returned when attempting to get a page](#no-results-returned-when-attempting-to-get-a-page)
+- [Unofficial Notion Client for Ruby.](#unofficial-notion-client-for-ruby)
+  - [Table of Contents](#table-of-contents)
+  - [Getting Started](#getting-started)
+    - [Installation](#installation)
+  - [Retrieving a Page](#retrieving-a-page)
+  - [Retrieving a CollectionView Page](#retrieving-a-collectionview-page)
+  - [Retrieving a Block within the Page](#retrieving-a-block-within-the-page)
+    - [Get a Block](#get-a-block)
+    - [Get a Collection View](#get-a-collection-view)
+  - [Creating New Blocks](#creating-new-blocks)
+    - [Create a block whose parent is the page](#create-a-block-whose-parent-is-the-page)
+    - [Create a block whose parent is another block](#create-a-block-whose-parent-is-another-block)
+  - [Creating New Collections](#creating-new-collections)
+  - [Updating Collection View Cells](#updating-collection-view-cells)
+  - [Troubleshooting](#troubleshooting)
+    - [No results returned when attempting to get a page](#no-results-returned-when-attempting-to-get-a-page)
+    - [Retrieve a full-page Collection View](#retrieve-a-full-page-collection-view)
 
 ## Getting Started
 ### Installation
@@ -60,6 +65,8 @@ The following attributes can be read from any block class instance:
 To update the title of the page:
 ![Update the title of a page](https://github.com/danmurphy1217/notion-ruby/blob/master/gifs/change_title.gif)
 
+## Retrieving a CollectionView Page
+This is achieved by passing the ID of the Collection View to the `get_page` method. Currently, the full URL of a Collection View Page is not supported (next up on the features list!). Once you retrieve the Collection View Page, all of the methods exposed to a normal Collection View instance are available (such as `.rows`, `.row(<row_id>)`, and all else outlined in [Updating a Collection](#updating-collection-view-cells)).
 ## Retrieving a Block within the Page
 Now that you have retrieved a Notion Page, you have full access to the blocks on that page. You can retrieve a specific block or collection view, retrieve all children IDs (array of children IDs), or retrieve all children (array of children class instances).
 
@@ -114,7 +121,7 @@ For example:
 ```
 For example:
 ![move a block](https://github.com/danmurphy1217/notion-ruby/blob/master/gifs/move_before_and_after.gif)
-### Get a Collection View - Table
+### Get a Collection View
 To retrieve a collection, you use the `get_collection` method. This method is designed to work with Table collections, but the codebase is actively being updated to support others:
 ```ruby
 >>> @page = @client.get_page("https://www.notion.so/danmurphy/TEST-PAGE-d2ce338f19e847f586bd17679f490e66")
@@ -268,6 +275,28 @@ The first argument passed to `create_collection` determines which type of collec
 4. timeline
 5. gallery
 
+## Updating Collection View Cells
+When you retrieve a `CollectionViewRow` instance with `.row(<row_id>)` or a list of `CollectionViewRow` instances with `.rows`, a handful of methods are created. Each row instance has access attributes that represent the properties in the Notion Collection View. So, let's say we are working with the following Notion Collection View:
+| emoji | description  | category            | aliases | tags    | unicode_version | ios_version |
+|-------|--------------|---------------------|---------|---------|-----------------|-------------|
+| 😉     | "winking face" | "Smileys & Emotion" | "wink"  | "flirt" | "6.0"           | "6.0"       |
+
+If you wanted to update the unicode and ios versions, you could use the following code:
+```ruby
+>>> collection_view = @page.get_collection("1234567") # the ID of the collection block is 1234567
+>>> rows = collection_view.rows
+>>> row[0].unicode_version = "updated version here!"
+>>> row[0].ios_version = "I was updated too!"
+```
+Now, your Collection View will look like this:
+| emoji | description  | category            | aliases | tags    | unicode_version | ios_version |
+|-------|--------------|---------------------|---------|---------|-----------------|-------------|
+| 😉     |   "winking face"   | "Smileys & Emotion" | "wink"  | "flirt" | "updated version here!"          | "I was updated too!" |
+
+You can also add new rows with the `.add_row({<data!>})` method and add new properties with the `.add_property("name_of_property", "type_of_property")` method.
+
+**One important thing to be aware of:**
+When adding a row with `.add_row`, the hash of data passed must be in the same order as it appears in your Notion Collection View.
 ## Troubleshooting
 ### No results returned when attempting to get a page
 If an empty hash is returned when you attempt to retrieve a Notion page, you'll need to include the `x-notion-active-user-header` when instantiating the Notion Client.
@@ -280,4 +309,9 @@ From here, you can instantiate the Notion Client with the following code:
   "<insert_x_notion_active_user_header_here>"
 )
 ```
-
+### 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.
+```
+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

@@ -42,13 +42,27 @@ module NotionAPI
       end
 
       block_id = clean_id
-      block_title = extract_title(clean_id, jsonified_record_response)
       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 block_type != 'page'
-
-      PageBlock.new(block_id, block_title, block_parent_id)
+      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
     end
 
     def children(url_or_id = @id)
@@ -236,5 +250,47 @@ module NotionAPI
         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']
+
+      if response.empty?
+        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
+        )
+        response['recordMap']['collection'][collection_id]['value']['schema']
+      else
+        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']
+
+      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
+      )
+      response['recordMap']
+    end
   end
 end

data/lib/notion_api/notion_types/collection_view_blocks.rb

@@ -1,228 +1,325 @@
 module NotionAPI
-    # collection views such as tables and timelines.
-    class CollectionView < Core
-      attr_reader :id, :title, :parent_id, :collection_id, :view_id
-  
-      @notion_type = 'collection_view'
-      @type = 'collection_view'
-  
-      def type
-        NotionAPI::CollectionView.notion_type
-      end
-  
-      class << self
-        attr_reader :notion_type, :type
-      end
-  
-      def initialize(id, title, parent_id, collection_id, view_id)
-        @id = id
-        @title = title
-        @parent_id = parent_id
-        @collection_id = collection_id
-        @view_id = view_id
-      end
-  
-      def add_row(data)
-        # ! add new row to Collection View table.
-        # ! data -> data to add to table : ``hash``
-  
-        cookies = Core.options['cookies']
-        headers = Core.options['headers']
-  
-        request_id = extract_id(SecureRandom.hex(16))
-        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)
-        keys = schema.keys
-        col_map = {}
-        keys.map { |key| col_map[schema[key]['name']]  = key }
-  
-        request_ids = {
-          request_id: request_id,
-          transaction_id: transaction_id,
-          space_id: space_id
-        }
-  
-        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)
-  
-        operations = [
-          instantiate_row,
-          set_block_alive,
-          new_block_edited_time,
-          parent_edited_time
-        ]
-  
-        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'])
-          operations.push(child_component)
+  # collection views such as tables and timelines.
+  class CollectionView < Core
+    attr_reader :id, :title, :parent_id, :collection_id, :view_id
+
+    @notion_type = "collection_view"
+    @type = "collection_view"
+
+    def type
+      NotionAPI::CollectionView.notion_type
+    end
+
+    class << self
+      attr_reader :notion_type, :type
+    end
+
+    def initialize(id, title, parent_id, collection_id, view_id)
+      @id = id
+      @title = title
+      @parent_id = parent_id
+      @collection_id = collection_id
+      @view_id = view_id
+    end
+
+    def add_row(data)
+      # ! add new row to Collection View table.
+      # ! data -> data to add to table : ``hash``
+
+      cookies = Core.options["cookies"]
+      headers = Core.options["headers"]
+
+      request_id = extract_id(SecureRandom.hex(16))
+      transaction_id = extract_id(SecureRandom.hex(16))
+      space_id = extract_id(SecureRandom.hex(16))
+      new_block_id = extract_id(SecureRandom.hex(16))
+      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 }
+
+      request_ids = {
+        request_id: request_id,
+        transaction_id: transaction_id,
+        space_id: space_id,
+      }
+
+      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)
+      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,
+        page_sort
+      ]
+
+      data.keys.each_with_index do |col_name, j|
+        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"]}
+          if !options.include?(data[col_name])
+            create_new_option = Utils::CollectionViewComponents.add_new_option(col_map[col_name.to_s], data[col_name], @collection_id)
+            operations.push(create_new_option)
+          end
         end
-  
-        request_url = URLS[:UPDATE_BLOCK]
-        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
-  
-           NotionAPI::CollectionViewRow.new(new_block_id, @parent_id, @collection_id, @view_id)
+        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
-  
-      def add_property(name, type)
-        # ! add a property (column) to the table.
-        # ! name -> name of the property : ``str``
-        # ! type -> type of the property : ``str``
-        cookies = Core.options['cookies']
-        headers = Core.options['headers']
-  
-        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
-        }
-  
-        # create updated schema
-        schema = extract_collection_schema(@collection_id, @view_id)
-        schema[name] = {
-          name: name,
-          type: type
-        }
-        new_schema = {
-          schema: schema
-        }
-  
-        add_collection_property = Utils::CollectionViewComponents.add_collection_property(@collection_id, new_schema)
-  
-        operations = [
-          add_collection_property
-        ]
-  
-        request_url = URLS[:UPDATE_BLOCK]
-        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
-      end
-  
-      def row(row_id)
-        # ! retrieve a row from a CollectionView Table.
-        # ! row_id -> the ID for the row to retrieve: ``str``
-        clean_id = extract_id(row_id)
-  
-        request_body = {
-          pageId: clean_id,
-          chunkNumber: 0,
-          limit: 100,
-          verticalColumns: false
-        }
+
+      request_url = URLS[:UPDATE_BLOCK]
+      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
+
+      NotionAPI::CollectionViewRow.new(new_block_id, @parent_id, @collection_id, @view_id)
+    end
+
+    def add_property(name, type)
+      # ! add a property (column) to the table.
+      # ! name -> name of the property : ``str``
+      # ! type -> type of the property : ``str``
+      cookies = Core.options["cookies"]
+      headers = Core.options["headers"]
+
+      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,
+      }
+
+      # create updated schema
+      schema = extract_collection_schema(@collection_id, @view_id)
+      schema[name] = {
+        name: name,
+        type: type,
+      }
+      new_schema = {
+        schema: schema,
+      }
+
+      add_collection_property = Utils::CollectionViewComponents.add_collection_property(@collection_id, new_schema)
+
+      operations = [
+        add_collection_property,
+      ]
+
+      request_url = URLS[:UPDATE_BLOCK]
+      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
+    end
+
+    def row(row_id)
+      # ! retrieve a row from a CollectionView Table.
+      # ! row_id -> the ID for the row to retrieve: ``str``
+      clean_id = extract_id(row_id)
+
+      request_body = {
+        pageId: clean_id,
+        chunkNumber: 0,
+        limit: 100,
+        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(clean_id, request_body)
-        schema = extract_collection_schema(@collection_id, @view_id)
-        keys = schema.keys
-        column_names = keys.map { |key| schema[key]['name'] }
-        i = 0
-        while jsonified_record_response.empty? || jsonified_record_response['block'].empty?
-          return {} if i >= 10
-  
-          jsonified_record_response = get_all_block_info(clean_id, request_body)
-          i += 1
-        end
-        row_jsonified_response = jsonified_record_response['block'][clean_id]['value']['properties']
-        row_data = {}
-        keys.each_with_index { |key, idx| row_data[column_names[idx]] = row_jsonified_response[key] ? row_jsonified_response[key].flatten : [] }
-        row_data
+        i += 1
       end
-  
-      def row_ids
-        # ! retrieve all Collection View table rows.
-        clean_id = extract_id(@id)
-  
-        request_body = {
-          pageId: clean_id,
-          chunkNumber: 0,
-          limit: 100,
-          verticalColumns: false
-        }
-  
+
+      collection_data = extract_collection_data(@collection_id, @view_id)
+      schema = collection_data["collection"][collection_id]["value"]["schema"]
+      column_mappings = schema.keys
+      column_names = column_mappings.map { |mapping| schema[mapping]["name"] }
+
+      collection_row = CollectionViewRow.new(row_id, @parent_id, @collection_id, @view_id)
+      collection_row.instance_variable_set(:@column_names, column_names)
+      CollectionViewRow.class_eval { attr_reader :column_names }
+
+      row_data = collection_data["block"][collection_row.id]
+      create_singleton_methods_and_instance_variables(collection_row, row_data)
+
+      collection_row
+    end
+
+    def row_ids
+      # ! retrieve all Collection View table rows.
+      clean_id = extract_id(@id)
+
+      request_body = {
+        pageId: clean_id,
+        chunkNumber: 0,
+        limit: 100,
+        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(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(clean_id, request_body)
-          i += 1
-        end
-  
-        jsonified_record_response['collection_view'][@view_id]['value']['page_sort']
-      end
-  
-      def rows
-        # ! returns all rows as instantiated class instances.
-        row_id_array = row_ids
-        parent_id = @parent_id
-        collection_id = @collection_id
-        view_id = @view_id
-  
-        row_id_array.map { |row_id| NotionAPI::CollectionViewRow.new(row_id, parent_id, collection_id, view_id) }
-      end
-  
-      private
-  
-      def extract_collection_schema(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']
-  
-        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
-        )
-        response['recordMap']['collection'][collection_id]['value']['schema']
+        i += 1
       end
+
+      jsonified_record_response["collection_view"][@view_id]["value"]["page_sort"]
     end
-    class CollectionViewRow < Core
-      @notion_type = 'table_row'
-      @type = 'table_row'
-  
-      def type
-        NotionAPI::CollectionViewRow.notion_type
-      end
-  
-      class << self
-        attr_reader :notion_type, :type, :parent_id
+
+    def rows
+      # ! returns all rows as instantiated class instances.
+      row_id_array = row_ids
+      parent_id = @parent_id
+      collection_id = @collection_id
+      view_id = @view_id
+      collection_data = extract_collection_data(@collection_id, @view_id)
+      schema = collection_data["collection"][collection_id]["value"]["schema"]
+      column_mappings = schema.keys
+      column_names = column_mappings.map { |mapping| schema[mapping]["name"] }
+
+      row_instances = row_id_array.map { |row_id| NotionAPI::CollectionViewRow.new(row_id, parent_id, collection_id, view_id) }
+      clean_row_instances = row_instances.filter { |row| collection_data["block"][row.id] }
+      clean_row_instances.each { |row| row.instance_variable_set(:@column_names, column_names) }
+      CollectionViewRow.class_eval { attr_reader :column_names }
+
+      clean_row_instances.each do |collection_row|
+        row_data = collection_data["block"][collection_row.id]
+        create_singleton_methods_and_instance_variables(collection_row, row_data)
       end
-  
-      attr_reader :parent_id, :id
-      def initialize(id, parent_id, collection_id, view_id)
-        @id = id
-        @parent_id = parent_id
-        @collection_id = collection_id
-        @view_id = view_id
+      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``
+      # ! row_data -> the data corresponding to that row, should be key-value pairs where the keys are the columns: ``hash``
+      collection_data = extract_collection_data(@collection_id, @view_id)
+      schema = collection_data["collection"][collection_id]["value"]["schema"]
+      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
+
+        # 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]  
+        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 
+        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(" ")
+          cookies = Core.options["cookies"]
+          headers = Core.options["headers"]
+
+          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,
+          }
+
+          update_property_value = Utils::CollectionViewComponents.update_property_value(@id, column_hash.key(parsed_method), new_value)
+
+          operations = [
+            update_property_value,
+          ]
+
+          request_url = URLS[:UPDATE_BLOCK]
+          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
+          
+          # set the instance variable to the updated value!
+          _ = row.instance_variable_set("@#{__method__.to_s[0...-1]}", new_value)
+          row
+        end
       end
     end
-end
+  end
+
+  # class that represents each row in a CollectionView
+  class CollectionViewRow < Core
+    @notion_type = "table_row"
+    @type = "table_row"
+
+    def type
+      NotionAPI::CollectionViewRow.notion_type
+    end
+
+    def inspect
+      "CollectionViewRow - id: #{self.id} - parent id: #{self.parent_id}"
+    end
+
+    class << self
+      attr_reader :notion_type, :type, :parent_id
+    end
+
+    attr_reader :parent_id, :id
+
+    def initialize(id, parent_id, collection_id, view_id)
+      @id = id
+      @parent_id = parent_id
+      @collection_id = collection_id
+      @view_id = view_id
+    end
+  end
+
+  # class that represents a CollectionViewPage, inheriting all properties from CollectionView
+  class CollectionViewPage < CollectionView
+    @notion_type = "collection_view_page"
+    @type = "collection_view_page"
+
+    def type
+      NotionAPI::CollectionViewRow.notion_type
+    end
+
+    class << self
+      attr_reader :notion_type, :type, :parent_id
+    end
+
+    attr_reader :parent_id, :id
+  end
+end

data/lib/notion_api/notion_types/template.rb

@@ -304,7 +304,15 @@ module NotionAPI
             block_collection_id = extract_collection_id(clean_id, jsonified_record_response)
             block_view_id = extract_view_ids(clean_id, jsonified_record_response)
             collection_title = extract_collection_title(clean_id, block_collection_id, jsonified_record_response)
-            block_class.new(clean_id, collection_title, block_parent_id, block_collection_id, block_view_id.join)
+            
+            block = block_class.new(clean_id, collection_title, block_parent_id, block_collection_id, block_view_id.join)
+            schema = extract_collection_schema(block_collection_id, block_view_id[0])
+            column_mappings = schema.keys
+            column_names = column_mappings.map { |mapping| schema[mapping]['name']}
+            block.instance_variable_set(:@column_names, column_names)
+            CollectionView.class_eval{attr_reader :column_names}
+
+            block
           else
             block_title = extract_title(clean_id, jsonified_record_response)
             block_class.new(clean_id, block_title, block_parent_id)

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,49 @@ 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)
+      colors = ["default", "gray", "brown", "orange", "yellow", "green", "blue", "purple", "pink", "red"]
+      random_color = colors[rand(0...colors.length)]
+      table = "collection"
+      path = ["schema", column, "options"]
+      command = "keyedObjectListAfter"
+      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 +562,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,
+          },
         ],
       }
       {
@@ -554,6 +611,37 @@ module Utils
         args: args,
       }
     end
+
+    def self.update_property_value(page_id, column_name, new_value)
+      # ! 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``
+      table = "block"
+      path = [
+        "properties",
+        column_name,
+      ]
+      command = "set"
+      args = [[
+        new_value,
+      ]]
+
+      {
+        id: page_id,
+        table: table,
+        path: path,
+        command: command,
+        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)
@@ -576,4 +664,4 @@ module Utils
     }
     payload
   end
-end
+end

data/lib/notion_api/version.rb

@@ -1,3 +1,3 @@
 module NotionAPI
-    VERSION = '1.0.3'
+    VERSION = '1.1.0'
 end

metadata

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