notion-sdk-ruby 0.5.0 → 0.6.0

data/lib/notion-sdk-ruby.rb

@@ -1,33 +1,36 @@
-require "faraday"
-require "faraday_middleware"
-require "forwardable"
-require "ostruct"
-
-require "notion-sdk-ruby/version"
-require "notion-sdk-ruby/config"
-require "notion-sdk-ruby/request_client"
-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/client"
-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"
-
-module Notion
-  @config = Config.new
-
-  class << self
-    extend Forwardable
-
-    attr_reader :config
-
-    def_delegators :@config, :api_token, :api_token=
-    def_delegators :@config, :notion_version, :notion_version=
-  end
-end
+require "faraday"
+require "faraday_middleware"
+require "forwardable"
+require "ostruct"
+
+require "notion-sdk-ruby/version"
+require "notion-sdk-ruby/config"
+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
+  @config = Config.new
+
+  class << self
+    extend Forwardable
+
+    attr_reader :config
+
+    def_delegators :@config, :api_token, :api_token=
+    def_delegators :@config, :notion_version, :notion_version=
+  end
+end

data/notion-sdk-ruby.gemspec

@@ -1,39 +1,41 @@
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require_relative "lib/notion-sdk-ruby/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "notion-sdk-ruby"
-  spec.version = Notion::VERSION
-  spec.authors = ["Graham Marlow"]
-  spec.email = ["mgmarlow@hey.com"]
-
-  spec.summary = "Notion SDK"
-  spec.homepage = "https://github.com/mgmarlow/notion-sdk-ruby"
-  spec.license = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/mgmarlow/notion-sdk-ruby"
-  spec.metadata["changelog_uri"] = "https://github.com/mgmarlow/notion-sdk-ruby/blob/master/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  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"
-  spec.add_development_dependency "standardrb", "~> 1.0"
-  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"
-end
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative "lib/notion-sdk-ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "notion-sdk-ruby"
+  spec.version = Notion::VERSION
+  spec.authors = ["Graham Marlow"]
+  spec.email = ["mgmarlow@hey.com"]
+
+  spec.summary = "Notion SDK"
+  spec.homepage = "https://github.com/mgmarlow/notion-sdk-ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/mgmarlow/notion-sdk-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/mgmarlow/notion-sdk-ruby/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  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"
+  spec.add_development_dependency "standardrb", "~> 1.0"
+  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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notion-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Graham Marlow
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-30 00:00:00.000000000 Z
+date: 2022-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -136,7 +136,35 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.1'
-description: 
+- !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
 executables: []
@@ -156,6 +184,11 @@ 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
@@ -164,14 +197,10 @@ files:
 - 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/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
+- todos.md
 homepage: https://github.com/mgmarlow/notion-sdk-ruby
 licenses:
 - MIT
@@ -179,7 +208,7 @@ metadata:
   homepage_uri: https://github.com/mgmarlow/notion-sdk-ruby
   source_code_uri: https://github.com/mgmarlow/notion-sdk-ruby
   changelog_uri: https://github.com/mgmarlow/notion-sdk-ruby/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -194,8 +223,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Notion SDK
 test_files: []

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

@@ -1,12 +0,0 @@
-module Notion
-  module Operations
-    module Search
-      include RequestClient
-
-      def search(body)
-        response = post("/v1/search", body.to_json)
-        List.new(response.body)
-      end
-    end
-  end
-end

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

@@ -1,33 +0,0 @@
-module Notion
-  class Blocks
-    include RequestClient
-
-    def children
-      Children.new
-    end
-
-    def retrieve(block_id)
-      response = get("/v1/blocks/#{block_id}")
-      Block.new(response.body)
-    end
-
-    def update(block_id, body)
-      response = patch("/v1/blocks/#{block_id}", body.to_json)
-      Block.new(response.body)
-    end
-  end
-
-  class Children
-    include RequestClient
-
-    def list(block_id, query: {})
-      response = get("/v1/blocks/#{block_id}/children", query: query)
-      List.new(response.body)
-    end
-
-    def append(block_id, body)
-      response = patch("/v1/blocks/#{block_id}/children", body.to_json)
-      Block.new(response.body)
-    end
-  end
-end

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

@@ -1,32 +0,0 @@
-module Notion
-  class Databases
-    include RequestClient
-
-    def retrieve(id)
-      response = get("/v1/databases/#{id}")
-      Database.new(response.body)
-    end
-
-    # DEPRECATED
-    def list
-      warn "DEPRECATED: client.databases.list is deprecated."
-      response = get("/v1/databases")
-      List.new(response.body)
-    end
-
-    def query(id, body)
-      response = post("/v1/databases/#{id}/query", body.to_json)
-      List.new(response.body)
-    end
-
-    def create(body)
-      response = post("/v1/databases", body.to_json)
-      Database.new(response.body)
-    end
-
-    def update(id, body)
-      response = patch("/v1/databases/#{id}", body.to_json)
-      Database.new(response.body)
-    end
-  end
-end

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

@@ -1,20 +0,0 @@
-module Notion
-  class Pages
-    include RequestClient
-
-    def retrieve(id)
-      response = get("/v1/pages/#{id}")
-      Page.new(response.body)
-    end
-
-    def create(body)
-      response = post("/v1/pages", body.to_json)
-      Page.new(response.body)
-    end
-
-    def update(id, body)
-      response = patch("/v1/pages/#{id}", body.to_json)
-      Page.new(response.body)
-    end
-  end
-end

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

@@ -1,15 +0,0 @@
-module Notion
-  class Users
-    include RequestClient
-
-    def list
-      response = get("/v1/users")
-      List.new(response.body)
-    end
-
-    def retrieve(id)
-      response = get("/v1/users/#{id}")
-      User.new(response.body)
-    end
-  end
-end