notion-sdk-ruby 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b8f9260f352a244eaf86cd39b5724c874929548ebf289f795755d2e63aa09b8
-  data.tar.gz: f7c63168582a3f7d7c0b898fb0bcd85338c26c816782cd8d222fde67c1418d80
+  metadata.gz: 481e5f2cb1fb1e06b040669772b571350568fdc1575b7720de83776cfd965b2b
+  data.tar.gz: b20483bc14df3da9a1323189c798b84f230d9998b6f6891ec6ba0eea00d6ee22
 SHA512:
-  metadata.gz: f9e01092c18da58fb6d9e813cfdea77f96deb71295c525f7942cf7e125fd70106d4a33e414513fa2e6282849ea84787552397e6d009272480b11801c93509925
-  data.tar.gz: fcec5ce30ef130a1c54582cef9bd792729acb134c3b81a860a9b939f198fd115c79ef5d8ea4481723a6ee345b116cf9fb81b5aedf03d373cfab33853700e1543
+  metadata.gz: 32298bebc868742363f23d46ad0ed35a7a357342de1aace3ac04c6fa78e56e9bc81d21dc7b91eb6079759c1d465309df284918877655c92b2282ef22231abe50
+  data.tar.gz: 5ce80f427551c8841e1410183854cac0c10d49de8cdbdfcc73057b745953c360b4c602e2c014d44c4d29279a75969a04f42b784a9304ba5b3508fcf83b216c16

data/.github/workflows/ci.yml

@@ -18,7 +18,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ["2.6", "2.7", "3.0"]
+        ruby-version: ["2.7"]
 
     steps:
       - uses: actions/checkout@v2
@@ -32,3 +32,12 @@ jobs:
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
       - name: Run tests
         run: bundle exec rake
+      - name: Build docs
+        run: bundle exec rake yard
+      - name: Deploy docs
+        if: ${{ github.ref == 'refs/heads/main' }}
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./doc
+          publish_branch: gh-pages

data/Gemfile.lock

@@ -1,29 +1,59 @@
 PATH
   remote: .
   specs:
-    notion-sdk-ruby (0.4.0)
-      httparty (~> 0.18.1)
+    notion-sdk-ruby (0.6.0)
+      faraday (~> 1.8)
+      faraday_middleware (~> 1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
     coderay (1.1.3)
+    concurrent-ruby (1.1.9)
     crack (0.4.5)
       rexml
     diff-lcs (1.4.4)
     dotenv (2.7.6)
+    faraday (1.10.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
     hashdiff (1.0.1)
-    httparty (0.18.1)
-      mime-types (~> 3.0)
-      multi_xml (>= 0.5.2)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
     method_source (1.0.0)
-    mime-types (3.3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0704)
-    multi_xml (0.6.0)
+    minitest (5.14.4)
+    multipart-post (2.2.3)
     parallel (1.20.1)
     parser (3.0.1.1)
       ast (~> 2.4.1)
@@ -63,29 +93,38 @@ GEM
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
     standard (1.1.1)
       rubocop (= 1.14.0)
       rubocop-performance (= 1.11.2)
     standardrb (1.0.0)
       standard
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.0.0)
+    vcr (6.1.0)
     webmock (3.12.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.26)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
   x64-mingw32
 
 DEPENDENCIES
+  activesupport (~> 6.1)
   dotenv (~> 2.7)
   notion-sdk-ruby!
   pry (~> 0.14.1)
   rake (~> 12.0)
   rspec (~> 3.0)
   standardrb (~> 1.0)
+  vcr (~> 6.0)
   webmock (~> 3.12)
+  yard (~> 0.9.26)
 
 BUNDLED WITH
    2.2.3

data/README.md

@@ -5,30 +5,6 @@
 
 Unofficial Ruby client for the [Notion APIs](https://developers.notion.com/).
 
-- [Notion Ruby SDK](#notion-ruby-sdk)
-  - [Installation](#installation)
-  - [Usage](#usage)
-  - [API reference](#api-reference)
-    - [Databases](#databases)
-      - [databases#retrieve](#databasesretrieve)
-      - [databases#list](#databaseslist)
-      - [databases#query](#databasesquery)
-    - [Pages](#pages)
-      - [pages#retrieve](#pagesretrieve)
-      - [pages#create](#pagescreate)
-      - [pages#update](#pagesupdate)
-    - [Blocks](#blocks)
-      - [blocks#children#list](#blockschildrenlist)
-      - [blocks#children#append](#blockschildrenappend)
-    - [Users](#users)
-      - [users#retrieve](#usersretrieve)
-      - [users#list](#userslist)
-    - [Search](#search)
-      - [#search](#search-1)
-  - [Development](#development)
-  - [Contributing](#contributing)
-  - [License](#license)
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -39,7 +15,13 @@ gem 'notion-sdk-ruby'
 
 And then execute:
 
-    $ bundle install
+```
+$ bundle install
+```
+    
+## Documentation
+
+- [API documentation](https://mgmarlow.github.io/notion-sdk-ruby/Notion/Client.html)
 
 ## Usage
 
@@ -50,196 +32,6 @@ require "notion-sdk-ruby"
 client = Notion::Client.new(token: ENV["NOTION_API_SECRET"])
 ```
 
-## API reference
-
-### Databases
-
-#### databases#retrieve
-
-[API reference](https://developers.notion.com/reference/get-database)
-
-```rb
-client.databases.retrieve("668d797c-76fa-4934-9b05-ad288df2d136")
-```
-
-#### databases#list
-
-[API reference](https://developers.notion.com/reference/get-databases)
-
-```rb
-client.databases.list
-```
-
-#### databases#query
-
-[API reference](https://developers.notion.com/reference/post-database-query)
-
-```rb
-client.databases.query("668d797c-76fa-4934-9b05-ad288df2d136", {
-  "filter": {
-    "or": [
-      {
-        "property": "In stock",
-        "checkbox": {
-          "equals": true
-        }
-      },
-      {
-        "property": "Cost of next trip",
-        "number": {
-          "greater_than_or_equal_to": 2
-        }
-      }
-    ]
-  },
-  "sorts": [
-    {
-      "property": "Last ordered",
-      "direction": "ascending"
-    }
-  ]
-})
-```
-
-### Pages
-
-#### pages#retrieve
-
-[API reference](https://developers.notion.com/reference/get-page)
-
-```rb
-client.pages.retrieve("b55c9c91-384d-452b-81db-d1ef79372b75")
-```
-
-#### pages#create
-
-[API reference](https://developers.notion.com/reference/post-page)
-
-```rb
-client.pages.create({
-  "parent": { "database_id": "48f8fee9cd794180bc2fec0398253067" },
-  "properties": {
-    "Name": {
-      "title": [
-        {
-          "text": {
-            "content": "Tuscan Kale"
-          }
-        }
-      ]
-    },
-    "Description": {
-      "rich_text": [
-        {
-          "text": {
-            "content": "A dark green leafy vegetable"
-          }
-        }
-      ]
-    },
-    "Food group": {
-      "select": {
-        "name": "Vegetable"
-      }
-    },
-    "Price": { "number": 2.5 }
-  },
-  "children": []
-})
-```
-
-#### pages#update
-
-[API reference](https://developers.notion.com/reference/patch-page)
-
-```rb
-client.pages.update("b55c9c91-384d-452b-81db-d1ef79372b75", {
-  "properties": {
-    "In stock": { "checkbox": true }
-  }
-})
-```
-
-### Blocks
-
-#### blocks#children#list
-
-[API reference](https://developers.notion.com/reference/get-block-children)
-
-```rb
-client.blocks.children.list("b55c9c91-384d-452b-81db-d1ef79372b75", {
-  page_size: 100
-})
-```
-
-#### blocks#children#append
-
-[API reference](https://developers.notion.com/reference/patch-block-children)
-
-```rb
-client.blocks.children.append("b54c9c91-384d-452b-81db-d1ef79372b75", {
-  "children": [
-    {
-      "object": "block",
-      "type": "heading_1",
-      "heading_1": {
-        "text": [{ "type": "text", "text": { "content": "Lacinato kale" } }]
-      }
-    },
-    {
-      "object": "block",
-      "type": "paragraph",
-      "paragraph": {
-        "text": [
-          {
-            "type": "text",
-            "text": {
-              "content": "Lacinato kale is a variety of kale with a long tradition in Italian cuisine, especially that of Tuscany. It is also known as Tuscan kale, Italian kale, dinosaur kale, kale, flat back kale, palm tree kale, or black Tuscan palm.",
-              "link": { "url": "https://en.wikipedia.org/wiki/Lacinato_kale" }
-            }
-          }
-        ]
-      }
-    }
-  ]
-})
-```
-
-### Users
-
-#### users#retrieve
-
-[API reference](https://developers.notion.com/reference/get-user)
-
-```rb
-client.users.retrieve("d40e767c-d7af-4b18-a86d-55c61f1e39a4")
-```
-
-#### users#list
-
-[API reference](https://developers.notion.com/reference/get-users)
-
-```rb
-client.users.list
-```
-
-### Search
-
-[API reference](https://developers.notion.com/reference/post-search)
-
-#### #search
-
-```rb
-client.search({
-  "query":"External tasks",
-  "sort":{
-    "direction":"ascending",
-    "timestamp":"last_edited_time"
-    }
-  }
-)
-```
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -248,7 +40,7 @@ Before using `bin/console` you need to create a new file, `.env`, at the root pr
 
 ```
 cat > .env <<EOF
-API_SECRET=<YOUR NOTION API SECRET HERE>
+NOTION_API_KEY=<YOUR NOTION API SECRET HERE>
 EOF
 ```
 

data/Rakefile

@@ -1,7 +1,12 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "standard/rake"
+require "yard"
 
 RSpec::Core::RakeTask.new(:spec)
 
+YARD::Rake::YardocTask.new do |t|
+  t.files = ["lib/**/*.rb"]
+end
+
 task default: [:spec, :standard]

data/lib/notion-sdk-ruby/api/blocks.rb

@@ -0,0 +1,56 @@
+module Notion
+  module Api
+    class BlocksMethods
+      include RequestClient
+
+      # @return [Notion::Api::BlocksChildrenMethods]
+      def children
+        BlocksChildrenMethods.new
+      end
+
+      # Retrieves a Block object using the ID specified.
+      # https://developers.notion.com/reference/retrieve-a-block
+      # @param [String] id block_id
+      # @return [Notion::Block]
+      def retrieve(id)
+        response = get("/v1/blocks/#{id}")
+        Block.new(response.body)
+      end
+
+      # Updates the content for the specified block_id based on the block type.
+      # https://developers.notion.com/reference/update-a-block
+      # @param [String] id block_id
+      # @param [Hash] body
+      # @return [Notion::Block]
+      def update(id, body)
+        response = patch("/v1/blocks/#{id}", body.to_json)
+        Block.new(response.body)
+      end
+    end
+
+    class BlocksChildrenMethods
+      include RequestClient
+
+      # Returns a paginated array of child block objects contained in the block
+      # using the ID specified.
+      # https://developers.notion.com/reference/get-block-children
+      # @param [String] id block_id
+      # @param [Hash] query
+      # @return [Array<Notion::Block>]
+      def list(id, query = {})
+        response = get("/v1/blocks/#{id}/children", query)
+        List.new(response.body)
+      end
+
+      # Creates and appends new children blocks to the parent block_id specified.
+      # https://developers.notion.com/reference/patch-block-children
+      # @param [String] id block_id
+      # @param [Hash] body
+      # @return [Array<Notion::Block>]
+      def append(id, body)
+        response = patch("/v1/blocks/#{id}/children", body.to_json)
+        List.new(response.body)
+      end
+    end
+  end
+end

data/lib/notion-sdk-ruby/api/databases.rb

@@ -0,0 +1,47 @@
+module Notion
+  module Api
+    class DatabasesMethods
+      include RequestClient
+
+      # Retrieves a Database object using the ID specified.
+      # https://developers.notion.com/reference/retrieve-a-database
+      # @param [String] id database_id
+      # @return [Notion::Database]
+      def retrieve(id)
+        response = get("/v1/databases/#{id}")
+        Database.new(response.body)
+      end
+
+      # Gets a list of Pages contained in the database, filtered and ordered according
+      # to the filter conditions and sort criteria provided in the request.
+      # https://developers.notion.com/reference/post-database-query
+      # @param [String] id database_id
+      # @param [Hash] body
+      # @return [Array<Notion::Database>]
+      def query(id, body)
+        response = post("/v1/databases/#{id}/query", body.to_json)
+        List.new(response.body)
+      end
+
+      # Creates a database as a subpage in the specified parent page, with the
+      # specified properties schema.
+      # https://developers.notion.com/reference/create-a-database
+      # @param [Hash] body
+      # @return [Notion::Database]
+      def create(body)
+        response = post("/v1/databases", body.to_json)
+        Database.new(response.body)
+      end
+
+      # Updates an existing database as specified by the parameters.
+      # https://developers.notion.com/reference/update-a-database
+      # @param [String] id database_id
+      # @param [Hash] body
+      # @return [Notion::Database]
+      def update(id, body)
+        response = patch("/v1/databases/#{id}", body.to_json)
+        Database.new(response.body)
+      end
+    end
+  end
+end

data/lib/notion-sdk-ruby/api/pages.rb

@@ -0,0 +1,36 @@
+module Notion
+  module Api
+    class PagesMethods
+      include RequestClient
+
+      # Retrieves a Page object using the ID specified.
+      # https://developers.notion.com/reference/retrieve-a-page
+      # @param [String] id page_id
+      # @return [Notion::Page]
+      def retrieve(id)
+        response = get("/v1/pages/#{id}")
+        Page.new(response.body)
+      end
+
+      # Creates a new page in the specified database or as a child of
+      # an existing page.
+      # https://developers.notion.com/reference/post-page
+      # @param [Hash] body
+      # @return [Notion::Page]
+      def create(body)
+        response = post("/v1/pages", body.to_json)
+        Page.new(response.body)
+      end
+
+      # Updates page property values for the specified page.
+      # https://developers.notion.com/reference/patch-page
+      # @param [String] id page_id
+      # @param [Hash] body
+      # @return [Notion::Page]
+      def update(id, body)
+        response = patch("/v1/pages/#{id}", body.to_json)
+        Page.new(response.body)
+      end
+    end
+  end
+end

data/lib/notion-sdk-ruby/api/search.rb

@@ -0,0 +1,17 @@
+module Notion
+  module Api
+    module SearchMethods
+      include RequestClient
+
+      # Searches all original pages, databases, and child pages/databases
+      # that are shared with the integration.
+      # https://developers.notion.com/reference/post-search
+      # @param [Hash] body
+      # @return [Array]
+      def search(body)
+        response = post("/v1/search", body.to_json)
+        List.new(response.body)
+      end
+    end
+  end
+end

data/lib/notion-sdk-ruby/api/users.rb

@@ -0,0 +1,24 @@
+module Notion
+  module Api
+    class UsersMethods
+      include RequestClient
+
+      # Returns a paginated list of Users for the workspace.
+      # https://developers.notion.com/reference/get-users
+      # @return [Array<Notion::User>]
+      def list
+        response = get("/v1/users")
+        List.new(response.body)
+      end
+
+      # Retrieves a User using the ID specified.
+      # https://developers.notion.com/reference/get-user
+      # @param [String] id user_id
+      # @return [Notion::User]
+      def retrieve(id)
+        response = get("/v1/users/#{id}")
+        User.new(response.body)
+      end
+    end
+  end
+end

data/lib/notion-sdk-ruby/client.rb

@@ -1,26 +1,30 @@
 module Notion
   class Client
-    include Operations::Search
+    include Api::SearchMethods
 
-    def initialize(token:, notion_version: "2021-05-13")
+    def initialize(token:, notion_version: "2022-02-22")
       Notion.api_token = token
       Notion.notion_version = notion_version
     end
 
-    def blocks
-      Blocks.new
+    # @return [Notion::Api::DatabasesMethods]
+    def databases
+      Api::DatabasesMethods.new
     end
 
-    def databases
-      Databases.new
+    # @return [Notion::Api::UsersMethods]
+    def users
+      Api::UsersMethods.new
     end
 
-    def pages
-      Pages.new
+    # @return [Notion::Api::BlocksMethods]
+    def blocks
+      Api::BlocksMethods.new
     end
 
-    def users
-      Users.new
+    # @return [Notion::Api::PagesMethods]
+    def pages
+      Api::PagesMethods.new
     end
   end
 end

data/lib/notion-sdk-ruby/models/block.rb

@@ -0,0 +1,7 @@
+module Notion
+  # A block object represents content within Notion.
+  #
+  # https://developers.notion.com/reference/block
+  class Block < OpenStruct
+  end
+end

data/lib/notion-sdk-ruby/models/database.rb

@@ -0,0 +1,7 @@
+module Notion
+  # Database objects describe the property schema of a database in Notion.
+  #
+  # https://developers.notion.com/reference/database
+  class Database < OpenStruct
+  end
+end

data/lib/notion-sdk-ruby/models/list.rb

@@ -0,0 +1,49 @@
+module Notion
+  # The List object is an intermediate object that helps with pagination.
+  #
+  # https://developers.notion.com/reference/pagination
+  class List
+    # An array of endpoint-dependent objects
+    # @return [Array<Notion::User>]
+    # @return [Array<Notion::Database>]
+    # @return [Array<Notion::Page>]
+    # @return [Array<Notion::Block>]
+    attr_reader :data
+
+    # Used to retrieve the next page of results by passing the value as the
+    # start_cursor parameter to the same endpoint.
+    # @return [nil] if has_more is true.
+    # @return [string] if has_more is false.
+    attr_reader :next_cursor
+
+    # When the response includes the end of the list, false. Otherwise, true.
+    # @return [boolean]
+    attr_reader :has_more
+
+    def initialize(response_body)
+      @data = response_body["results"].map do |d|
+        get_model(d["object"]).new(d)
+      end
+
+      @next_cursor = response_body["next_cursor"]
+      @has_more = response_body["has_more"]
+    end
+
+    private
+
+    def get_model(object_name)
+      case object_name
+      when "block"
+        Block
+      when "database"
+        Database
+      when "page"
+        Page
+      when "user"
+        User
+      else
+        raise NotionError.new("unimplemented object type")
+      end
+    end
+  end
+end

data/lib/notion-sdk-ruby/models/page.rb

@@ -0,0 +1,7 @@
+module Notion
+  # The Page object contains the property values of a single Notion page.
+  #
+  # https://developers.notion.com/reference/page
+  class Page < OpenStruct
+  end
+end

data/lib/notion-sdk-ruby/models/user.rb

@@ -0,0 +1,7 @@
+module Notion
+  # The User object represents a user in a Notion workspace.
+  #
+  # https://developers.notion.com/reference/user
+  class User < OpenStruct
+  end
+end

data/lib/notion-sdk-ruby/request_client.rb

@@ -1,49 +1,44 @@
 module Notion
-  class RequestClient
-    include HTTParty
+  module RequestClient
+    private
 
-    base_uri "https://api.notion.com"
-    headers "Content-Type": "application/json"
-
-    def self.active_client
-      RequestClient.new(Notion.config)
-    end
-
-    def initialize(config)
-      self.class.headers Authorization: "Bearer #{config.api_token}"
-      self.class.headers "Notion-Version": config.notion_version
-    end
-
-    def get(*args, &block)
-      response = self.class.get(*args, &block)
-      raise_on_failure(response)
+    def get(*args)
+      handle_request(:get, *args)
     end
 
-    def post(*args, &block)
-      response = self.class.post(*args, &block)
-      raise_on_failure(response)
+    def post(*args)
+      handle_request(:post, *args)
     end
 
-    def patch(*args, &block)
-      response = self.class.patch(*args, &block)
-      raise_on_failure(response)
+    def patch(*args)
+      handle_request(:patch, *args)
     end
 
-    def put(*args, &block)
-      response = self.class.put(*args, &block)
-      raise_on_failure(response)
+    def delete(*args)
+      handle_request(:delete, *args)
     end
 
-    def delete(*args, &block)
-      response = self.class.delete(*args, &block)
-      raise_on_failure(response)
+    def handle_request(method, *args)
+      faraday_client.public_send(method, *args)
+    rescue Faraday::ClientError => error
+      error_details = JSON.parse(error.response[:body])
+      raise ErrorFactory.create(error_details)
+    rescue JSON::ParserError => error
+      raise NotionError.new(error.message)
     end
 
-    def raise_on_failure(response)
-      if response.success?
-        response
-      else
-        raise ErrorFactory.create(response)
+    def faraday_client
+      @faraday_client ||= Faraday.new(
+        url: "https://api.notion.com",
+        headers: {
+          "Content-Type" => "application/json",
+          "Notion-Version" => Notion.config.notion_version,
+          "Authorization" => "Bearer #{Notion.config.api_token}"
+        }
+      ) do |f|
+        f.request :json
+        f.response :json
+        f.use Faraday::Response::RaiseError
       end
     end
   end

data/lib/notion-sdk-ruby/version.rb

@@ -1,3 +1,3 @@
 module Notion
-  VERSION = "0.4.0"
+  VERSION = "0.6.0"
 end

data/lib/notion-sdk-ruby.rb

@@ -1,16 +1,25 @@
-require "httparty"
+require "faraday"
+require "faraday_middleware"
 require "forwardable"
+require "ostruct"
 
 require "notion-sdk-ruby/version"
-
 require "notion-sdk-ruby/config"
-require "notion-sdk-ruby/resources/blocks"
-require "notion-sdk-ruby/resources/databases"
-require "notion-sdk-ruby/resources/pages"
-require "notion-sdk-ruby/resources/users"
-require "notion-sdk-ruby/operations/search"
-require "notion-sdk-ruby/error"
 require "notion-sdk-ruby/request_client"
+require "notion-sdk-ruby/error"
+
+require "notion-sdk-ruby/models/user"
+require "notion-sdk-ruby/models/list"
+require "notion-sdk-ruby/models/block"
+require "notion-sdk-ruby/models/database"
+require "notion-sdk-ruby/models/page"
+
+require "notion-sdk-ruby/api/blocks"
+require "notion-sdk-ruby/api/databases"
+require "notion-sdk-ruby/api/pages"
+require "notion-sdk-ruby/api/users"
+require "notion-sdk-ruby/api/search"
+
 require "notion-sdk-ruby/client"
 
 module Notion

data/notion-sdk-ruby.gemspec

@@ -26,7 +26,8 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "httparty", "~> 0.18.1"
+  spec.add_dependency "faraday", "~> 1.8"
+  spec.add_dependency "faraday_middleware", "~> 1.1"
 
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"
@@ -34,4 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock", "~> 3.12"
   spec.add_development_dependency "pry", "~> 0.14.1"
   spec.add_development_dependency "dotenv", "~> 2.7"
+  spec.add_development_dependency "activesupport", "~> 6.1"
+  spec.add_development_dependency "yard", "~> 0.9.26"
+  spec.add_development_dependency "vcr", "~> 6.0"
 end

data/todos.md

@@ -0,0 +1,11 @@
+# todos
+
+- [x] Add VCR
+- [x] Swap over specs to use VCR
+- [x] Update to latest notion SDK version
+- [x] Improve generated docs by removing extra module namespaces
+- [x] Remove manual docs from readme, move to auto-generated docs
+- [ ] New endpoint: Delete block
+- [ ] New endpoint: Retrieve a page property item
+- [ ] Pagination APIs
+- [ ] Examples

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: notion-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Graham Marlow
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-22 00:00:00.000000000 Z
+date: 2022-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.26
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.26
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 description:
 email:
 - mgmarlow@hey.com
@@ -128,17 +184,23 @@ files:
 - bin/console
 - bin/setup
 - lib/notion-sdk-ruby.rb
+- lib/notion-sdk-ruby/api/blocks.rb
+- lib/notion-sdk-ruby/api/databases.rb
+- lib/notion-sdk-ruby/api/pages.rb
+- lib/notion-sdk-ruby/api/search.rb
+- lib/notion-sdk-ruby/api/users.rb
 - lib/notion-sdk-ruby/client.rb
 - lib/notion-sdk-ruby/config.rb
 - lib/notion-sdk-ruby/error.rb
-- lib/notion-sdk-ruby/operations/search.rb
+- lib/notion-sdk-ruby/models/block.rb
+- lib/notion-sdk-ruby/models/database.rb
+- lib/notion-sdk-ruby/models/list.rb
+- lib/notion-sdk-ruby/models/page.rb
+- lib/notion-sdk-ruby/models/user.rb
 - lib/notion-sdk-ruby/request_client.rb
-- lib/notion-sdk-ruby/resources/blocks.rb
-- lib/notion-sdk-ruby/resources/databases.rb
-- lib/notion-sdk-ruby/resources/pages.rb
-- lib/notion-sdk-ruby/resources/users.rb
 - lib/notion-sdk-ruby/version.rb
 - notion-sdk-ruby.gemspec
+- todos.md
 homepage: https://github.com/mgmarlow/notion-sdk-ruby
 licenses:
 - MIT
@@ -161,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Notion SDK

data/lib/notion-sdk-ruby/operations/search.rb

@@ -1,9 +0,0 @@
-module Notion
-  module Operations
-    module Search
-      def search(body)
-        RequestClient.active_client.post("/v1/search", body: body.to_json)
-      end
-    end
-  end
-end

data/lib/notion-sdk-ruby/resources/blocks.rb

@@ -1,17 +0,0 @@
-module Notion
-  class Blocks
-    def children
-      Children.new
-    end
-  end
-
-  class Children
-    def list(block_id, query: {})
-      RequestClient.active_client.get("/v1/blocks/#{block_id}/children", query: query)
-    end
-
-    def append(block_id, body)
-      RequestClient.active_client.patch("/v1/blocks/#{block_id}/children", body: body.to_json)
-    end
-  end
-end

data/lib/notion-sdk-ruby/resources/databases.rb

@@ -1,19 +0,0 @@
-module Notion
-  class Databases
-    def retrieve(id)
-      RequestClient.active_client.get("/v1/databases/#{id}")
-    end
-
-    def list
-      RequestClient.active_client.get("/v1/databases")
-    end
-
-    def query(id, body)
-      RequestClient.active_client.post("/v1/databases/#{id}/query", body: body.to_json)
-    end
-
-    def create(body)
-      RequestClient.active_client.post("/v1/databases", body: body.to_json)
-    end
-  end
-end

data/lib/notion-sdk-ruby/resources/pages.rb

@@ -1,15 +0,0 @@
-module Notion
-  class Pages
-    def retrieve(id)
-      RequestClient.active_client.get("/v1/pages/#{id}")
-    end
-
-    def create(body)
-      RequestClient.active_client.post("/v1/pages", body: body.to_json)
-    end
-
-    def update(id, body)
-      RequestClient.active_client.patch("/v1/pages/#{id}", body: body.to_json)
-    end
-  end
-end

data/lib/notion-sdk-ruby/resources/users.rb

@@ -1,11 +0,0 @@
-module Notion
-  class Users
-    def list
-      RequestClient.active_client.get("/v1/users")
-    end
-
-    def retrieve(id)
-      RequestClient.active_client.get("/v1/users/#{id}")
-    end
-  end
-end