notion_publish 0.1.0

data/lib/notion_publish/target.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module NotionPublish
+  # Where a document is going to land. Everything the CLI accepts — a page ID, a
+  # database ID, a data source ID, a URL, a database name — collapses into one
+  # of these before anything is written.
+  Target = Data.define(:kind, :id, :title, :database_id, :inline) do
+    def page? = kind == :page
+    def data_source? = kind == :data_source
+
+    # The `parent` object for POST /v1/pages.
+    def parent_param
+      case kind
+      when :page then { "page_id" => id }
+      when :data_source then { "data_source_id" => id }
+      else raise ArgumentError, "unknown target kind: #{kind}"
+      end
+    end
+
+    # +inline+ is a tri-state: true, false, or nil when we resolved through a
+    # data source and never fetched the database that would tell us.
+    def kind_label
+      case kind
+      when :page then "page"
+      when :data_source then inline == true ? "inline database" : "database"
+      end
+    end
+
+    def describe
+      name = title.nil? || title.empty? ? "(untitled)" : title
+      "#{kind_label} #{name.inspect} (#{id})"
+    end
+  end
+end

data/lib/notion_publish/uploader.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative "errors"
+
+module NotionPublish
+  # Puts a local file into Notion's own storage and returns its file_upload id.
+  #
+  # This is the only way to get a local image onto a page: an uploaded file has
+  # no URL of its own -- GET /v1/file_uploads/:id returns no url field at all --
+  # so it can only ever be referenced by id from a block.
+  class Uploader
+    SINGLE_PART_LIMIT = 20 * 1024 * 1024
+
+    CONTENT_TYPES = {
+      ".png" => "image/png", ".jpg" => "image/jpeg", ".jpeg" => "image/jpeg",
+      ".gif" => "image/gif", ".webp" => "image/webp", ".svg" => "image/svg+xml",
+      ".heic" => "image/heic", ".tif" => "image/tiff", ".tiff" => "image/tiff",
+      ".ico" => "image/vnd.microsoft.icon", ".bmp" => "image/bmp"
+    }.freeze
+
+    def initialize(client)
+      @client = client
+    end
+
+    def upload(path)
+      raise Error, "No such image: #{path}" unless File.file?(path)
+
+      size = File.size(path)
+      check_size(path, size)
+      content_type = content_type_for(path)
+
+      created = @client.post("/v1/file_uploads", {
+                               "mode" => "single_part",
+                               "filename" => File.basename(path),
+                               "content_type" => content_type
+                             })
+
+      sent = @client.post_file(created["upload_url"], path: path, content_type: content_type)
+      raise Error, "Upload of #{path} finished as #{sent['status'].inspect}." unless sent["status"] == "uploaded"
+
+      created["id"]
+    end
+
+    # The block that references an upload. Notion reports it back as an image of
+    # type "file" with a short-lived signed URL, minted fresh on every read.
+    def self.image_block(upload_id, caption)
+      image = { "type" => "file_upload", "file_upload" => { "id" => upload_id } }
+      image["caption"] = [{ "type" => "text", "text" => { "content" => caption.to_s } }] unless caption.to_s.empty?
+      { "object" => "block", "type" => "image", "image" => image }
+    end
+
+    private
+
+    def check_size(path, size)
+      limit = [workspace_limit, SINGLE_PART_LIMIT].compact.min
+      return if size <= limit
+
+      raise Error, <<~MSG.strip
+        #{File.basename(path)} is #{human(size)}, over the #{human(limit)} limit.
+
+        Files above #{human(SINGLE_PART_LIMIT)} need Notion's multi-part upload,
+        which notion-publish does not do yet.
+      MSG
+    end
+
+    def workspace_limit
+      @client.me.dig("bot", "workspace_limits", "max_file_upload_size_in_bytes")
+    end
+
+    def content_type_for(path)
+      extension = File.extname(path).downcase
+      CONTENT_TYPES[extension] or raise Error, <<~MSG.strip
+        Cannot tell what kind of image #{File.basename(path)} is.
+
+        Known extensions: #{CONTENT_TYPES.keys.join(' ')}
+      MSG
+    end
+
+    def human(bytes)
+      return "#{(bytes / 1024.0 / 1024).round(1)} MB" if bytes >= 1024 * 1024
+
+      "#{(bytes / 1024.0).round(1)} KB"
+    end
+  end
+end

data/lib/notion_publish/users.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "did_you_mean"
+
+require_relative "errors"
+
+module NotionPublish
+  # Resolves a person's name to a user ID, for people properties. Fetched once,
+  # and only when a people property is actually being set by name.
+  class Users
+    def initialize(client)
+      @client = client
+    end
+
+    def resolve(name)
+      wanted = name.to_s.strip
+      matches = all.select { |u| u["name"].to_s.casecmp?(wanted) }
+
+      case matches.length
+      when 1 then matches.first["id"]
+      when 0 then raise Error, no_match_message(wanted)
+      else raise Error, ambiguous_message(wanted, matches)
+      end
+    end
+
+    private
+
+    def all
+      @all ||= @client.get_all("/v1/users")
+    end
+
+    def people = all.select { |u| u["type"] == "person" }
+
+    def no_match_message(wanted)
+      close = DidYouMean::SpellChecker.new(dictionary: people.map { |u| u["name"] }.compact).correct(wanted)
+      lines = ["No workspace user is named #{wanted.inspect}."]
+      lines << "" << "Close matches: #{close.join(', ')}" unless close.empty?
+      lines << "" << "A user ID works too."
+      lines.join("\n")
+    end
+
+    def ambiguous_message(wanted, matches)
+      lines = ["More than one user is named #{wanted.inspect}:", ""]
+      matches.each { |u| lines << "  #{u['id']}  (#{u['type']})" }
+      lines << "" << "Use the ID."
+      lines.join("\n")
+    end
+  end
+end

data/lib/notion_publish/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module NotionPublish
+  VERSION = "0.1.0"
+end

data/lib/notion_publish.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "notion_publish/version"
+require_relative "notion_publish/errors"
+require_relative "notion_publish/notion_digest"
+require_relative "notion_publish/reference"
+require_relative "notion_publish/target"
+require_relative "notion_publish/sharing"
+require_relative "notion_publish/client"
+require_relative "notion_publish/resolver"
+require_relative "notion_publish/adopter"
+require_relative "notion_publish/settings"
+require_relative "notion_publish/document"
+require_relative "notion_publish/property_set"
+require_relative "notion_publish/schema"
+require_relative "notion_publish/users"
+require_relative "notion_publish/decoration"
+require_relative "notion_publish/fixups"
+require_relative "notion_publish/links"
+require_relative "notion_publish/manifest"
+require_relative "notion_publish/status"
+require_relative "notion_publish/media"
+require_relative "notion_publish/uploader"
+require_relative "notion_publish/publisher"
+require_relative "notion_publish/cli"
+
+# Publishes Markdown files into Notion as pages, and keeps them updated in
+# place. See NotionPublish::CLI for the command line and
+# NotionPublish::Publisher for the library entry point.
+module NotionPublish
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: notion_publish
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Norman
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: |
+  A command-line tool that publishes Markdown files as Notion pages and
+  updates them in place on later runs. It uses Notion's Markdown endpoints,
+  so Notion does the conversion to blocks. It records which page each file
+  became, sets database properties from front matter, uploads local images,
+  and refuses to overwrite a page someone has edited in Notion. Not
+  affiliated with or endorsed by Notion Labs, Inc.
+email:
+- john@outsidecto.com
+executables:
+- notion-publish
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- docs/notion-publish-home-page.md
+- docs/usage.md
+- exe/notion-publish
+- lib/notion_publish.rb
+- lib/notion_publish/adopter.rb
+- lib/notion_publish/cli.rb
+- lib/notion_publish/client.rb
+- lib/notion_publish/commands.rb
+- lib/notion_publish/commands/adopt.rb
+- lib/notion_publish/commands/command.rb
+- lib/notion_publish/commands/properties.rb
+- lib/notion_publish/commands/publish.rb
+- lib/notion_publish/commands/relink.rb
+- lib/notion_publish/commands/reporting.rb
+- lib/notion_publish/commands/republish.rb
+- lib/notion_publish/commands/status.rb
+- lib/notion_publish/commands/whoami.rb
+- lib/notion_publish/decoration.rb
+- lib/notion_publish/document.rb
+- lib/notion_publish/errors.rb
+- lib/notion_publish/fixups.rb
+- lib/notion_publish/links.rb
+- lib/notion_publish/log.rb
+- lib/notion_publish/manifest.rb
+- lib/notion_publish/media.rb
+- lib/notion_publish/notion_digest.rb
+- lib/notion_publish/pool.rb
+- lib/notion_publish/progress.rb
+- lib/notion_publish/property_set.rb
+- lib/notion_publish/publisher.rb
+- lib/notion_publish/reference.rb
+- lib/notion_publish/resolver.rb
+- lib/notion_publish/schema.rb
+- lib/notion_publish/settings.rb
+- lib/notion_publish/sharing.rb
+- lib/notion_publish/status.rb
+- lib/notion_publish/target.rb
+- lib/notion_publish/uploader.rb
+- lib/notion_publish/users.rb
+- lib/notion_publish/version.rb
+homepage: https://outsidecto.com/notion-publish/
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/outsidecto/notion-publish
+  changelog_uri: https://github.com/outsidecto/notion-publish/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/outsidecto/notion-publish/blob/main/docs/usage.md
+  bug_tracker_uri: https://github.com/outsidecto/notion-publish/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.18
+specification_version: 4
+summary: Publish Markdown files from a Git repository into Notion, and keep them in
+  sync
+test_files: []