notion_to_md 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df84120caddccce07f99e140867a59ca176ee9c639a019785ef74faea03de32b
-  data.tar.gz: 5d95ff8014362018d505944b3b1afaf6593fac9f3f90cab28f6abd645843b39f
+  metadata.gz: 77ebe548eec487347104eabbac6911836cef0ec6e5ea350cb9a376ef8e07ce50
+  data.tar.gz: b2fd0700b53683daa6e59a729418139bbdee41da8184dad57eff0f2c17578dc7
 SHA512:
-  metadata.gz: 24a41732b091218c1c3b9b428714419a9ce993669d5edde0baa011cfb6953cb4db433aa8dc4536670577062b7a304b4d686361b756580800afcb72ebe2ab95b1
-  data.tar.gz: c2a9e707c602366f8f9e5d811c7010a65cdcf7c0a6fff17353b3a04a5cc28db7be452e453c5ee218b24a007c1c5d753aefb44c443c77e16cec1028097fcc71bf
+  metadata.gz: e7f09feec62553d76c72e670aa4fa05d02e98f19e74352237c8c42a255960570f77ae530b3196be24a054fa8a55f744f0b0b96dfbfb1c5e7d06f71b1423bcdf6
+  data.tar.gz: '09a041dab71e1fea3796ca9193c6a5fdf385de1d7fc212373f2e7cec086568935c72171ba900c90001907fdd4e1667e819b69c28740c2e5fa18a4b17821facb3'

data/README.md

@@ -1,2 +1,46 @@
 # notion_to_md
-Notion Markdown Exporter in Ruby
+Notion Markdown Exporter in Ruby.
+
+## Installation
+Use gem to install.
+```bash
+$ gem install 'notion_to_md'
+```
+
+Or add it to the `Gemfile`.
+```ruby
+# Gemfile
+gem 'notion_to_md'
+```
+
+## Usage
+Before using the gem create an integration and generate a secret token. Check [notion getting started guide](https://developers.notion.com/docs/getting-started) to learn more.
+
+Pass the page id and secret token to the constructor and execute the `convert` method.
+
+```ruby
+require 'notion_to_md'
+
+notion_converter = NotionToMd::Converter.new(page_id: 'b91d5...', token: 'secret_...')
+md = notion_converter.convert
+```
+
+If the secret token is provided as an environment variable —`NOTION_TOKEN`—, there's no need to pass it as an argument to the constructor.
+
+```bash
+$ export NOTION_TOKEN=<secret_...>
+```
+
+```ruby
+require 'notion_to_md'
+
+notion_converter = NotionToMd::Converter.new(page_id: 'b91d5...')
+md = notion_converter.convert
+```
+
+And that's all. The `md` is a string variable containing the notion page formatted in markdown.
+
+## Test
+```bash
+$ ruby -Ilib:test test/notion_to_md/converter_spec.rb
+```

data/lib/notion_to_md/block.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module NotionToMd
+  class Block
+    class << self
+      def paragraph(block)
+        convert_text(block)
+      end
+
+      def heading_1(block)
+        "# #{convert_text(block)}"
+      end
+
+      def heading_2(block)
+        "## #{convert_text(block)}"
+      end
+
+      def heading_3(block)
+        "### #{convert_text(block)}"
+      end
+
+      def callout(block)
+        icon = get_icon(block[:icon])
+        text = convert_text(block)
+        "#{icon} #{text}"
+      end
+
+      def quote(block)
+        "> #{convert_text(block)}"
+      end
+
+      def bulleted_list_item(block)
+        "- #{convert_text(block)}"
+      end
+
+      # TODO: numbered_list_item
+      def numbered_list_item(block)
+        Logger.info('numbered_list_item type not supported. Shown as bulleted_list_item.')
+        bulleted_list_item(block)
+      end
+
+      def to_do(block)
+        checked = block[:checked]
+        text = convert_text(block)
+
+        "- #{checked ? '[x]' : '[ ]'} #{text}"
+      end
+
+      def code(block)
+        language = block[:language]
+        text = convert_text(block)
+
+        "```#{language}\n\t#{text}\n```"
+      end
+
+      def embed(block)
+        url = block[:url]
+
+        "[#{url}](#{url})"
+      end
+
+      def image(block)
+        type = block[:type].to_sym
+        url = block.dig(type, :url)
+        caption = convert_caption(block)
+
+        "![](#{url})\n\n#{caption}"
+      end
+
+      def bookmark(block)
+        url = block[:url]
+        "[#{url}](#{url})"
+      end
+
+      def divider(_block)
+        '---'
+      end
+
+      def blank
+        '<br />'
+      end
+
+      def convert_text(block)
+        block[:text].map do |text|
+          content = Text.send(text[:type], text)
+          enrich_text_content(text, content)
+        end.join
+      end
+
+      def convert_caption(block)
+        convert_text(text: block[:caption])
+      end
+
+      def get_icon(block)
+        type = block[:type].to_sym
+        block[type]
+      end
+
+      def enrich_text_content(text, content)
+        enriched_content = add_link(text, content)
+        add_annotations(text, enriched_content)
+      end
+
+      def add_link(text, content)
+        href = text[:href]
+        return content if href.nil?
+
+        "[#{content}](#{href})"
+      end
+
+      def add_annotations(text, content)
+        annotations = text[:annotations].select { |_key, value| !!value }
+        annotations.keys.inject(content) do |enriched_content, annotation|
+          TextAnnotation.send(annotation.to_sym, enriched_content)
+        end
+      end
+    end
+  end
+end

data/lib/notion_to_md/converter.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require 'notion'
-require_relative './logger'
-require_relative './text_annotation'
-
 module NotionToMd
   class Converter
     attr_reader :page_id
@@ -15,13 +11,19 @@ module NotionToMd
 
     def convert
       md = page_blocks[:results].map do |block|
-        next blank if block[:type] == 'paragraph' && block.dig(:paragraph, :text).empty?
+        next Block.blank if block[:type] == 'paragraph' && block.dig(:paragraph, :text).empty?
 
         block_type = block[:type].to_sym
-        send(block_type, block[block_type])
+
+        begin
+          Block.send(block_type, block[block_type])
+        rescue StandardError
+          Logger.info("Unsupported block type: #{block_type}")
+          next nil
+        end
       end
       Logger.info("Notion page #{page_id} converted to markdown")
-      md.join("\n\n")
+      md.compact.join("\n\n")
     end
 
     private
@@ -29,123 +31,5 @@ module NotionToMd
     def page_blocks
       @page_blocks ||= @notion.block_children(id: page_id)
     end
-
-
-    def paragraph(block)
-      convert_text(block)
-    end
-
-    def heading_1(block)
-      "# #{convert_text(block)}"
-    end
-
-    def heading_2(block)
-      "## #{convert_text(block)}"
-    end
-
-    def heading_3(block)
-      "### #{convert_text(block)}"
-    end
-
-    def callout(block)
-      icon = get_icon(block[:icon])
-      text = convert_text(block)
-      "#{icon} #{text}"
-    end
-
-    def quote(block)
-      "> #{convert_text(block)}"
-    end
-
-    def bulleted_list_item(block)
-      "- #{convert_text(block)}"
-    end
-
-    # TODO: numbered_list_item
-    def numbered_list_item(block)
-      Logger.info('numbered_list_item type not supported. Shown as bulleted_list_item.')
-      bulleted_list_item(block)
-    end
-
-    def to_do(block)
-      checked = block[:checked]
-      text = convert_text(block)
-
-      "- #{checked ? '[x]' : '[ ]'} #{text}"
-    end
-
-    def code(block)
-      language = block[:language]
-      text = convert_text(block)
-
-      "```#{language}\n\t#{text}\n```"
-    end
-
-    def embed(block)
-      url = block[:url]
-
-      "[#{url}](#{url})"
-    end
-
-    def image(block)
-      type = block[:type].to_sym
-      url = block.dig(type, :url)
-      caption = convert_caption(block)
-
-      "![](#{url})\n\n#{caption}"
-    end
-
-    def bookmark(block)
-      url = block[:url]
-      "[#{url}](#{url})"
-    end
-
-    def divider(_block)
-      '---'
-    end
-
-    def equation(block)
-      equ = convert_text(block)
-      "$$ #{equ} $$"
-    end
-
-    def blank
-      '<br />'
-    end
-
-    def convert_text(block)
-      block[:text].map do |text|
-        content = text[:plain_text]
-        enrich_text_content(text, content)
-      end.join
-    end
-
-    def convert_caption(block)
-      convert_text(text: block[:caption])
-    end
-
-    def get_icon(block)
-      type = block[:type].to_sym
-      block[type]
-    end
-
-    def enrich_text_content(text, content)
-      enriched_content = add_link(text, content)
-      add_annotations(text, enriched_content)
-    end
-
-    def add_link(text, content)
-      href = text[:href]
-      return content if href.nil?
-
-      "[#{content}](#{href})"
-    end
-
-    def add_annotations(text, content)
-      annotations = text[:annotations].select { |key, value| !!value }
-      annotations.keys.inject(content) do |enriched_content, annotation|
-        TextAnnotation.send(annotation.to_sym, enriched_content)
-      end
-    end
   end
 end

data/lib/notion_to_md/logger.rb

@@ -1,16 +1,12 @@
 # frozen_string_literal: true
 
-require 'logger'
-
 module NotionToMd
   class Logger
-    @logger = ::Logger.new(STDOUT)
+    @logger = ::Logger.new($stdout)
 
     class << self
       extend Forwardable
-      def_delegators :@logger, :debug, :info, :warn, :error, :fatal
+      def_delegators :@logger, :debug, :info, :warn, :error, :fatal, :level, :level=
     end
   end
 end
-
-

data/lib/notion_to_md/text.rb

@@ -0,0 +1,13 @@
+module NotionToMd
+  class Text
+    class << self
+      def text(text)
+        text[:plain_text]
+      end
+
+      def equation(text)
+        "$$ #{text[:plain_text]} $$"
+      end
+    end
+  end
+end

data/lib/notion_to_md/text_annotation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module NotionToMd
   # Append the text type:
   # * italic: boolean,
@@ -9,19 +11,19 @@ module NotionToMd
   class TextAnnotation
     class << self
       def italic(text)
-        "_#{text}_"
+        "*#{text}*"
       end
 
       def bold(text)
         "**#{text}**"
       end
 
-      def striketrough(text)
+      def strikethrough(text)
         "~~#{text}~~"
       end
 
       def underline(text)
-        text
+        "<u>#{text}</u>"
       end
 
       def code(text)

data/lib/notion_to_md/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NotionToMd
-  VERSION = '0.0.0'
+  VERSION = '0.1.0'
 end

data/lib/notion_to_md.rb

@@ -1,4 +1,10 @@
 # frozen_string_literal: true
 
+require 'notion'
+require 'logger'
 require_relative './notion_to_md/version'
 require_relative './notion_to_md/converter'
+require_relative './notion_to_md/logger'
+require_relative './notion_to_md/block'
+require_relative './notion_to_md/text'
+require_relative './notion_to_md/text_annotation'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notion_to_md
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Enrique Arias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-28 00:00:00.000000000 Z
+date: 2022-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: notion-ruby-client
@@ -24,6 +24,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.8
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Notion Markdown Exporter in Ruby
 email: emoriarty81@gmail.com
 executables: []
@@ -32,8 +74,10 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/notion_to_md.rb
+- lib/notion_to_md/block.rb
 - lib/notion_to_md/converter.rb
 - lib/notion_to_md/logger.rb
+- lib/notion_to_md/text.rb
 - lib/notion_to_md/text_annotation.rb
 - lib/notion_to_md/version.rb
 homepage: https://github.com/emoriarty/notion_to_md
@@ -48,7 +92,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.3
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="