notion-sdk-ruby 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7e21c20b56990d0f42d1df0130e4e3f3d7835727d4802cd230b7bb5daaa4109
-  data.tar.gz: 1ad409bdc5168dac0f604e62efda59ca5b1d343a353b6492f42f9daaf650fe57
+  metadata.gz: 646301fd9a326d4b9d74cb514b948f85ff38dc0c7f001edd5c94285510029088
+  data.tar.gz: a544ddbd17c26ba618082eb04dc2e3e268da12b1b9d729fbf9109c8d642fc803
 SHA512:
-  metadata.gz: cd38bbbb96dd0c1fbf80bf419032a9e00be069de0c5e74ed921f1d6fb06846064d773fe0ad046cd2b8f7d38b9496247a307f48ac485c720e4877d20b52b9b1b0
-  data.tar.gz: 3beaf308945c7e566a74a63068f078bc211e07a74e0d677beb0788c2073c3d360f583204648bb522f54f012fad877e4dd92e2c0ebf585afda878bc2fd2071d9f
+  metadata.gz: 256824b18cfead3ab2630a96906022a5d8e936c3323824c5dd72e6605592c67fc2fa94d59f71796365e3639ced885b7f3344f6f39300fa7b74211be1ee618506
+  data.tar.gz: e7ec55aea773b32cead4f0ce0a788435abdd7e45f7a7050f9541a0c3514d612786f4be6661fa1fb35ddc904ca8961d363120d02a57035e14683f3c6d7c20eb80

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    notion-sdk-ruby (0.2.3)
+    notion-sdk-ruby (0.3.0)
       httparty (~> 0.18.1)
 
 GEM

data/README.md

@@ -1,211 +1,228 @@
-# Notion Ruby SDK
-
-Unofficial Ruby client for the [Notion APIs](https://developers.notion.com/).
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'notion-sdk-ruby'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install notion-sdk-ruby
-
-## Usage
-
-Initialize `Notion::Client` with your app's [integration secret](https://developers.notion.com/docs/getting-started#create-a-new-integration).
-
-```rb
-require "notion-sdk-ruby"
-client = Notion::Client.new(token: ENV["NOTION_API_SECRET"])
-
-# get users
-client.get_users
-```
-
-### Databases
-
-#### #get_database
-
-```rb
-client.get_database("668d797c-76fa-4934-9b05-ad288df2d136")
-```
-
-#### #get_databases
-
-```rb
-client.get_databases
-```
-
-#### #query_database
-
-```rb
-client.query_database("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
-
-#### #get_page
-
-```rb
-client.get_page("b55c9c91-384d-452b-81db-d1ef79372b75")
-```
-
-#### #create_page
-
-```rb
-client.create_page({
-  "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": []
-})
-```
-
-#### #update_page
-
-```rb
-client.update_page("b55c9c91-384d-452b-81db-d1ef79372b75", {
-  "properties": {
-    "In stock": { "checkbox": true }
-  }
-})
-```
-
-### Blocks
-
-#### #get_block_children
-
-```rb
-client.get_block_children("b55c9c91-384d-452b-81db-d1ef79372b75", {
-  page_size: 100
-})
-```
-
-#### #append_block_children
-
-```rb
-client.append_block_children("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
-
-#### #get_user
-
-```rb
-client.get_user("d40e767c-d7af-4b18-a86d-55c61f1e39a4")
-```
-
-#### #get_users
-
-```rb
-client.get_users
-```
-
-### 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.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/mgmarlow/notion-sdk-ruby.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+# Notion Ruby SDK
+
+Unofficial Ruby client for the [Notion APIs](https://developers.notion.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'notion-sdk-ruby'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+Initialize `Notion::Client` with your app's [integration secret](https://developers.notion.com/docs/getting-started#create-a-new-integration).
+
+```rb
+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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mgmarlow/notion-sdk-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/console

@@ -1,11 +1,12 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "pry"
-require 'dotenv/load'
-
-require "notion"
-
-$client = Notion::Client.new(token: ENV["API_SECRET"])
-
-Pry.start
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pry"
+require 'dotenv/load'
+
+require "notion-sdk-ruby"
+
+$client = Notion::Client.new(token: ENV["API_SECRET"])
+$client2 = Notion::Client.new(token: ENV["API_SECRET"])
+
+Pry.start

data/lib/notion-sdk-ruby.rb

@@ -1,13 +1,26 @@
 require "httparty"
+require "forwardable"
+
 require "notion-sdk-ruby/version"
-require "notion-sdk-ruby/endpoints/blocks"
-require "notion-sdk-ruby/endpoints/databases"
-require "notion-sdk-ruby/endpoints/pages"
-require "notion-sdk-ruby/endpoints/search"
-require "notion-sdk-ruby/endpoints/users"
-require "notion-sdk-ruby/endpoints"
+
+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/client"
 
 module Notion
-  class Error < StandardError; end
+  @config = Config.new
+
+  class << self
+    extend Forwardable
+
+    attr_reader :config
+
+    def_delegators :@config, :api_token, :api_token=
+  end
 end

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

@@ -1,12 +1,25 @@
 module Notion
   class Client
-    include Endpoints
-    include HTTParty
-    headers 'Content-Type': "application/json"
-    base_uri "https://api.notion.com"
+    include Operations::Search
 
     def initialize(token:)
-      self.class.headers({Authorization: "Bearer #{token}"})
+      Notion.api_token = token
+    end
+
+    def blocks
+      Blocks.new
+    end
+
+    def databases
+      Databases.new
+    end
+
+    def pages
+      Pages.new
+    end
+
+    def users
+      Users.new
     end
   end
 end

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

@@ -0,0 +1,5 @@
+module Notion
+  class Config
+    attr_accessor :api_token
+  end
+end

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

@@ -0,0 +1,52 @@
+# Sourced from notion-sdk-js:
+# https://github.com/makenotion/notion-sdk-js/blob/main/src/errors.ts
+module Notion
+  API_ERROR_CODE = {
+    unauthorized: "unauthorized",
+    restricted_resource: "restricted_resource",
+    object_not_found: "object_not_found",
+    rate_limited: "rate_limited",
+    invalid_json: "invalid_json",
+    invalid_request_url: "invalid_request_url",
+    invalid_request: "invalid_request",
+    validation_error: "validation_error",
+    conflict_error: "conflict_error",
+    internal_server_error: "internal_server_error",
+    service_unavailable: "service_unavailable"
+  }
+
+  class ErrorFactory
+    def self.create(error = {})
+      return NotionError.new("Unknown error.") if error["message"].nil?
+
+      if API_ERROR_CODE.value?(error["code"])
+        APIResponseError.new(error["message"], body: error)
+      elsif error["request"] && error["response"] && error["timings"]
+        HTTPResponseError.new(error["message"], body: error)
+      elsif error["request"] && error["timings"]
+        RequestTimeoutError.new(error["message"], body: error)
+      else
+        NotionError.new(error["message"])
+      end
+    end
+  end
+
+  class NotionError < StandardError
+    attr_reader :message, :body
+
+    def initialize(message = nil, body: nil)
+      @message = message
+      @body = body
+    end
+  end
+
+  class RequestTimeoutError < NotionError; end
+
+  class HTTPResponseError < NotionError; end
+
+  class APIResponseError < NotionError
+    def code
+      body["code"]
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+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/request_client.rb

@@ -0,0 +1,49 @@
+module Notion
+  class RequestClient
+    include HTTParty
+
+    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}"
+    end
+
+    def get(*args, &block)
+      response = self.class.get(*args, &block)
+      raise_on_failure(response)
+    end
+
+    def post(*args, &block)
+      response = self.class.post(*args, &block)
+      raise_on_failure(response)
+    end
+
+    def patch(*args, &block)
+      response = self.class.patch(*args, &block)
+      raise_on_failure(response)
+    end
+
+    def put(*args, &block)
+      response = self.class.put(*args, &block)
+      raise_on_failure(response)
+    end
+
+    def delete(*args, &block)
+      response = self.class.delete(*args, &block)
+      raise_on_failure(response)
+    end
+
+    def raise_on_failure(response)
+      if response.success?
+        response
+      else
+        raise ErrorFactory.create(response)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,15 @@
+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
+  end
+end

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

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,11 @@
+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

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

@@ -1,3 +1,3 @@
 module Notion
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notion-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Graham Marlow
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-17 00:00:00.000000000 Z
+date: 2021-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -129,12 +129,14 @@ files:
 - bin/setup
 - lib/notion-sdk-ruby.rb
 - lib/notion-sdk-ruby/client.rb
-- lib/notion-sdk-ruby/endpoints.rb
-- lib/notion-sdk-ruby/endpoints/blocks.rb
-- lib/notion-sdk-ruby/endpoints/databases.rb
-- lib/notion-sdk-ruby/endpoints/pages.rb
-- lib/notion-sdk-ruby/endpoints/search.rb
-- lib/notion-sdk-ruby/endpoints/users.rb
+- lib/notion-sdk-ruby/config.rb
+- lib/notion-sdk-ruby/error.rb
+- lib/notion-sdk-ruby/operations/search.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
 homepage: https://github.com/mgmarlow/notion-sdk-ruby

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

@@ -1,9 +0,0 @@
-module Notion
-  module Endpoints
-    include Databases
-    include Pages
-    include Blocks
-    include Users
-    include Search
-  end
-end

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

@@ -1,13 +0,0 @@
-module Notion
-  module Endpoints
-    module Blocks
-      def get_block_children(id, params: {})
-        self.class.get("/v1/blocks/#{id}/children", query: params)
-      end
-
-      def append_block_children(id, body)
-        self.class.patch("/v1/blocks/#{id}/children", body: body.to_json)
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-module Notion
-  module Endpoints
-    module Databases
-      def get_database(id)
-        self.class.get("/v1/databases/#{id}")
-      end
-
-      def get_databases
-        self.class.get("/v1/databases")
-      end
-
-      def query_database(id, body)
-        self.class.post("/v1/databases/#{id}/query", body: body.to_json)
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-module Notion
-  module Endpoints
-    module Pages
-      def get_page(id)
-        self.class.get("/v1/pages/#{id}")
-      end
-
-      def create_page(body)
-        self.class.post("/v1/pages", body: body.to_json)
-      end
-
-      def update_page(id, body)
-        self.class.patch("/v1/pages/#{id}", body: body.to_json)
-      end
-    end
-  end
-end

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

@@ -1,9 +0,0 @@
-module Notion
-  module Endpoints
-    module Search
-      def search(body)
-        self.class.post("/v1/search", body: body.to_json)
-      end
-    end
-  end
-end

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

@@ -1,13 +0,0 @@
-module Notion
-  module Endpoints
-    module Users
-      def get_users
-        self.class.get("/v1/users")
-      end
-
-      def get_user(id)
-        self.class.get("/v1/users/#{id}")
-      end
-    end
-  end
-end