notion-sdk-ruby 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d3e4424acc768faab4126af9bdbb3d90df17c9ed67253f9eb5cba03cb31fe55
-  data.tar.gz: 9ca3dda6a415c27e979c3cad27b792fa6891f1700a63f6f94190a6975d209b80
+  metadata.gz: 4491885de234786385349badac10c8224bd15c576f63ddc6073bf6593566727b
+  data.tar.gz: 8b4bd58bf052bf6a5612990a0521442b82ff9e8e400afbb92a10b9dd1c3afcca
 SHA512:
-  metadata.gz: a285b1f694a878c799de3a44373e22ae7ff25fab89d66879cf1bf3732778ad3819aa65ee54d606d694350311e7ea4d89a0bfb92ac4303050e4ce8bd866c9a1a8
-  data.tar.gz: 88c571a79fc993e34ee4a0fccc71786723d7862acaf1a9f391844d97390c052cb50186f767f86f03734841cf0de66a99be0c689a4e333c168f4a64ef111bb2a4
+  metadata.gz: b139926f4ee0a376d5507d7025a72c89c528461012dfe8ab03c245080c487fece19ce45754bb907bfd0d53f9503a0b48ff8a02052eaa8917862de01347be8549
+  data.tar.gz: e06fed554747d0bbaf0f7d81224474e642ff540151d136ca59fb2916fa33ba492279ddb166cd25c441aedf2cf0c542802f1737a34538a3d2f5cbc2f732c2e442

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+.env

data/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "editor.formatOnSave": true,
+  "editor.tabSize": 2
+}

data/Gemfile

@@ -1,7 +1,15 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in notion-sdk-ruby.gemspec
-gemspec
-
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in notion-sdk-ruby.gemspec
+gemspec
+
+gem "httparty", "~> 0.18.1"
+
+group :development, :test do
+  gem "rake", "~> 12.0"
+  gem "rspec", "~> 3.0"
+  gem "standardrb", "~> 1.0"
+  gem "webmock", "~> 3.12"
+  gem "pry", "~> 0.14.1"
+  gem "dotenv", "~> 2.7"
+end

data/Gemfile.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: .
+  specs:
+    notion-sdk-ruby (0.2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    dotenv (2.7.6)
+    hashdiff (1.0.1)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0225)
+    multi_xml (0.6.0)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.14.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.5.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.1.1)
+      rubocop (= 1.14.0)
+      rubocop-performance (= 1.11.2)
+    standardrb (1.0.0)
+      standard
+    unicode-display_width (2.0.0)
+    webmock (3.12.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+  x64-mingw32
+
+DEPENDENCIES
+  dotenv (~> 2.7)
+  httparty (~> 0.18.1)
+  notion-sdk-ruby!
+  pry (~> 0.14.1)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  standardrb (~> 1.0)
+  webmock (~> 3.12)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -1,8 +1,4 @@
-# Notion::Sdk::Ruby
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/notion/sdk/ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+# Notion Ruby SDK
 
 ## Installation
 
@@ -22,7 +18,175 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```rb
+cilent = Notion::Client.new(token: ENV["NOTION_API_SECRET"])
+```
+
+### 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
 
@@ -32,8 +196,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/notion-sdk-ruby.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/mgmarlow/notion-sdk-ruby.
 
 ## License
 

data/Rakefile

@@ -1,6 +1,7 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "standard/rake"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:spec, :standard]

data/bin/console

@@ -1,14 +1,11 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "notion/sdk/ruby"
+require "pry"
+require 'dotenv/load'
 
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
+require "notion"
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
+$client = Notion::Client.new(token: ENV["API_SECRET"])
 
-require "irb"
-IRB.start(__FILE__)
+Pry.start

data/lib/notion.rb

@@ -0,0 +1,13 @@
+require "httparty"
+require "notion/version"
+require "notion/endpoints/blocks"
+require "notion/endpoints/databases"
+require "notion/endpoints/pages"
+require "notion/endpoints/search"
+require "notion/endpoints/users"
+require "notion/endpoints"
+require "notion/client"
+
+module Notion
+  class Error < StandardError; end
+end

data/lib/notion/client.rb

@@ -0,0 +1,11 @@
+module Notion
+  class Client
+    include Endpoints
+    include HTTParty
+    base_uri "https://api.notion.com"
+
+    def initialize(token:)
+      self.class.headers({Authorization: "Bearer #{token}"})
+    end
+  end
+end

data/lib/notion/endpoints.rb

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

data/lib/notion/endpoints/blocks.rb

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

data/lib/notion/endpoints/databases.rb

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

data/lib/notion/endpoints/pages.rb

@@ -0,0 +1,17 @@
+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)
+      end
+
+      def update_page(id, body)
+        self.class.patch("/v1/pages/#{id}", body: body)
+      end
+    end
+  end
+end

data/lib/notion/endpoints/search.rb

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

data/lib/notion/endpoints/users.rb

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

data/lib/notion/version.rb

@@ -0,0 +1,3 @@
+module Notion
+  VERSION = "0.2.1"
+end

data/notion-sdk-ruby.gemspec

@@ -1,26 +1,26 @@
-require_relative 'lib/notion/sdk/ruby/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "notion-sdk-ruby"
-  spec.version       = Notion::Sdk::Ruby::VERSION
-  spec.authors       = ["Graham Marlow"]
-  spec.email         = ["mgmarlow@hey.com"]
-
-  spec.summary       = %q{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"]
-end
+require_relative "lib/notion/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"]
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: notion-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Graham Marlow
@@ -17,17 +17,27 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".vscode/settings.json"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- lib/notion/sdk/ruby.rb
-- lib/notion/sdk/ruby/version.rb
+- lib/notion.rb
+- lib/notion/client.rb
+- lib/notion/endpoints.rb
+- lib/notion/endpoints/blocks.rb
+- lib/notion/endpoints/databases.rb
+- lib/notion/endpoints/pages.rb
+- lib/notion/endpoints/search.rb
+- lib/notion/endpoints/users.rb
+- lib/notion/version.rb
 - notion-sdk-ruby.gemspec
 homepage: https://github.com/mgmarlow/notion-sdk-ruby
 licenses:

data/lib/notion/sdk/ruby.rb

@@ -1,10 +0,0 @@
-require "notion/sdk/ruby/version"
-
-module Notion
-  module Sdk
-    module Ruby
-      class Error < StandardError; end
-      # Your code goes here...
-    end
-  end
-end

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

@@ -1,7 +0,0 @@
-module Notion
-  module Sdk
-    module Ruby
-      VERSION = "0.1.0"
-    end
-  end
-end