growi-image_converter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 39307d84e87c1e73cda70ceb019ee7136593b454ce854d20c90dd5f1b4104a4d
+  data.tar.gz: fc30ebba1f8b1241b552bd2f8f086f1945828fe6199a4b72179dc88c7f2a6ceb
+SHA512:
+  metadata.gz: 7c00185b8dfcf40cda41259494c76d5cd802e5fad4d662d00ba74b657420a35ffb537df299454f968f1010f4ef2edfbfd6021fbebc361862392248540d5b5507
+  data.tar.gz: 9786454b470c8f861771f18d7768ed823f910a924272737ae11c466119d62c37487785b6988add54d894e1f36f7bfd93777d181c38b275d9b8ea9cc9731f50a1

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,21 @@
+Style/AsciiComments:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/MethodLength:
+  Max: 27
+
+Metrics/AbcSize:
+  Max: 30
+
+Naming/FileName:
+  Exclude:
+    - 'lib/growi-image-converter-esa.rb'

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.4
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in growi-image_converter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Takayuki TAMURA
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# Growi::ImageConverter
+
+growi-image_converter is a converter that converts esa.io images to GROWI.
+
+GROWI has the ability to import data from esa.io. However, images are not converted. Therefore, convert using this growi-image_converter.
+
+You need to create an AWS S3 bucket in advance and set it to GROWI.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'growi-image_converter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install growi-image_converter
+
+## Usage
+
+Export these environments.
+
+```
+$ export GROWI_URL=https://*****.growi.cloud
+$ export GROWI_ACCESS_TOKEN=0123456789abcdef0123456789abcdef0123456789ab
+```
+
+Perform a trial run with no changes made:
+
+    $ growi-image_converter
+
+Perform the conversion:
+
+    $ growi-image_converter -d
+
+## 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/aqutam/growi-image_converter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/growi-image_converter

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require 'optparse'
+require 'growi-client'
+require 'growi/image_converter'
+
+def run
+  options = {}
+  options[:dry_run] = true
+
+  OptionParser.new do |opt|
+    opt.banner = 'Usage: growi-image_converter [options]'
+    opt.version = Growi::ImageConverter::VERSION
+    opt.on('-d', '--no-dry-run', 'Perform the conversion') do
+      options[:dry_run] = false
+    end
+  end.parse!
+
+  if ENV['GROWI_URL'].nil?
+    puts 'Error: growi_url is required.'
+    puts
+    puts 'Export this environment:'
+    puts '$ export GROWI_URL=https://*****.growi.cloud'
+    exit 1
+  end
+
+  if ENV['GROWI_ACCESS_TOKEN'].nil?
+    puts 'Error: access_token is required.'
+    puts
+    puts 'Export this environment:'
+    puts '$ export GROWI_ACCESS_TOKEN=0123456789abcdef0123456789abcdef0123456789ab'
+    exit 1
+  end
+
+  puts '[DRY RUN MODE]' if options[:dry_run]
+
+  client = GrowiClient.new growi_url: ENV['GROWI_URL'], access_token: ENV['GROWI_ACCESS_TOKEN']
+  image_converter = Growi::ImageConverter::Esa.new client
+  image_converter.convert dry_run: options[:dry_run]
+end
+
+run

data/growi-image_converter.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'growi/image_converter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'growi-image_converter'
+  spec.version       = Growi::ImageConverter::VERSION
+  spec.authors       = ['Takayuki TAMURA']
+  spec.email         = ['tamtam.okinawa@gmail.com']
+
+  spec.summary       = 'GROWI image converter'
+  spec.description   = 'growi-image_converter is a converter that converts esa.io images to GROWI.'
+  spec.homepage      = 'https://github.com/aqutam/growi-image-converter-esa'
+  spec.license       = 'MIT'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = ['growi-image_converter']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_dependency 'growi-client'
+end

data/lib/growi/image_converter/attached_image_file.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Growi
+  module ImageConverter
+    # Image Markdownとアタッチされた画像を対応させるクラス
+    class AttachedImageFile
+      def initialize(markdown_images, attached_file)
+        @data = attached_file
+        @markdown_images = markdown_images
+      end
+      attr_accessor :data, :markdown_images
+    end
+  end
+end

data/lib/growi/image_converter/body.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Growi
+  module ImageConverter
+    # markdown bodyを扱うクラス
+    class Body
+      REGEX_SPACE = '[ \t]'
+      REGEX_URL_PREFIX_ESA = 'https?://img.esa.io/'
+      REGEX_SPACE_OR_RETURN = "(?:#{REGEX_SPACE}*?\\n)?#{REGEX_SPACE}*?"
+      REGEX_SPACE_GE_1_OR_RETURN = "(?:#{REGEX_SPACE}+?|#{REGEX_SPACE_OR_RETURN})"
+      REGEX_TITLE = "(?:#{REGEX_SPACE_GE_1_OR_RETURN}\".*?\")?"
+
+      FILE_PATH_PREFIX = '/attachment/'
+
+      def initialize(body)
+        @body = body
+        @markdown_images = []
+      end
+      attr_accessor :body, :markdown_images
+
+      def scan_markdown_image_esa
+        matches = []
+
+        # Image syntax inline
+        matches.concat(body.scan(
+                         /
+                         !\[#{REGEX_SPACE_OR_RETURN}.*?#{REGEX_SPACE_OR_RETURN}\]
+                         \(#{REGEX_SPACE_OR_RETURN}
+                         #{REGEX_URL_PREFIX_ESA}.*?#{REGEX_TITLE}
+                         #{REGEX_SPACE_OR_RETURN}\)
+                         /x
+                       ))
+
+        # Image syntax reference-style
+        matches.concat(body.scan(
+                         /
+                         \[#{REGEX_SPACE_OR_RETURN}.*?#{REGEX_SPACE_OR_RETURN}\]:
+                         #{REGEX_SPACE_OR_RETURN}#{REGEX_URL_PREFIX_ESA}.*
+                         /x
+                       ))
+
+        # Image syntax img tag
+        matches.concat(body.scan(/<img#{REGEX_SPACE_GE_1_OR_RETURN}.*?#{REGEX_URL_PREFIX_ESA}.*?>/m))
+
+        @markdown_images = matches.map { |match| Growi::ImageConverter::MarkdownImage.new match }
+      end
+
+      def group_by_url
+        group_by_url = {}
+        markdown_images.each do |markdown_image|
+          (group_by_url[markdown_image.url] ||= []).push(markdown_image)
+        end
+        group_by_url
+      end
+
+      def replace_markdown_image(attached_file)
+        attached_file_path = FILE_PATH_PREFIX + attached_file.data[:attachment]._id
+        attached_file.markdown_images.each do |markdown_image|
+          body.sub! markdown_image.syntax, markdown_image.replace_url(attached_file_path)
+        end
+      end
+    end
+  end
+end

data/lib/growi/image_converter/esa.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Growi
+  module ImageConverter
+    # img.esa.io の画像を GROWI にアタッチし直すクラス
+    class Esa
+      class << self
+        def get_image_from_esa(url, tempdir)
+          tmp_file = URI.parse(url).open
+          image_file = File.open(tempdir + '/' + File.basename(URI.parse(url).path), 'w+b')
+          image_file.write(tmp_file.read)
+          image_file.rewind
+          image_file
+        end
+      end
+
+      def initialize(client)
+        @client = client
+      end
+
+      def convert(dry_run: true)
+        Signal.trap(:INT) { throw :exit_convert }
+        catch :exit_convert do
+          begin
+            page_list = get_page_list
+          rescue StandardError => e
+            puts 'Error: ' + e.message
+            exit 1
+          end
+
+          page_list.each do |page_summary|
+            Dir.mktmpdir do |tempdir|
+              begin
+                page = Growi::ImageConverter::Page.new(page_summary._id, @client, dry_run: dry_run)
+                page.body.scan_markdown_image_esa
+                page.attach_files(page.body.group_by_url, tempdir)
+                page.replace_markdown_image
+                page.update
+              rescue StandardError => e
+                puts 'PageID: ' + page_summary._id + ', Result: Failed to convert' + ', Message: ' + e.message
+                next
+              end
+            end
+          end
+        end
+      end
+
+      private
+
+      def get_page_list(path_exp = '/')
+        req = GApiRequestPagesList.new path_exp: path_exp
+        api_return = @client.request(req)
+
+        raise StandardError, 'Failed to get page list.' unless api_return.ok
+
+        api_return.data
+      end
+    end
+  end
+end

data/lib/growi/image_converter/markdown_image.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Growi
+  module ImageConverter
+    # Markdown syntax image
+    class MarkdownImage
+      def initialize(syntax)
+        match = syntax.match(%r{(?<url>https?://.*?)(?:\s+?|"|\)|$)})
+
+        @syntax = syntax
+        @url = match&.[](:url)
+      end
+      attr_accessor :syntax, :url
+
+      def replace_url(new_url)
+        syntax.sub url, new_url
+      end
+    end
+  end
+end

data/lib/growi/image_converter/page.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Growi
+  module ImageConverter
+    # page を扱うクラス
+    class Page
+      def initialize(page_id, client, dry_run: true)
+        @dry_run = dry_run
+        @client = client
+        @data = get(page_id)
+        @body = Body.new(data.revision.body)
+        @attached_files = []
+      end
+      attr_accessor :data, :body, :attached_files
+
+      def get(page_id)
+        req = GApiRequestPagesGet.new page_id: page_id
+        api_return = @client.request(req)
+
+        raise StandardError, 'Failed to get page data.' unless api_return.ok
+
+        api_return.data
+      end
+
+      def attach_files(markdown_images_group_by_url, tempdir)
+        markdown_images_group_by_url.each do |url, markdown_images|
+          begin
+            image_file = Growi::ImageConverter::Esa.get_image_from_esa url, tempdir
+            attached_file = attach_file image_file
+            attached_files.push(Growi::ImageConverter::AttachedImageFile.new(markdown_images, attached_file))
+          rescue StandardError => e
+            puts 'PageID: ' + data._id + ', Image URL: ' + url + ', Message: ' + e.message
+            next
+          end
+        end
+      end
+
+      def attach_file(file)
+        if @dry_run
+          attachment_params = { _id: 'dry-run-' + data._id + '-' + SecureRandom.hex(10), creator: 'dry-run-user' }
+          return { attachment: GrowiAttachment.new(attachment_params) }
+        end
+
+        req = GApiRequestAttachmentsAdd.new page_id: data._id, file: file
+        api_return = @client.request(req)
+
+        raise StandardError, 'Failed to atach file.' unless api_return.ok
+
+        api_return.data
+      end
+
+      def replace_markdown_image
+        attached_files.each { |attached_file| body.replace_markdown_image(attached_file) }
+      end
+
+      def update
+        if attached_files.empty?
+          puts 'PageID: ' + data._id + ', Result: Through'
+          return
+        end
+
+        if @dry_run
+          puts 'PageID: ' + data._id + ', Result: Converted'
+          return
+        end
+
+        req = GApiRequestPagesUpdate.new(
+          page_id: data._id,
+          revision_id: data.revision._id,
+          body: body,
+          grant: data.grant
+        )
+        api_return = @client.request(req)
+
+        raise StandardError, 'Failed to update page.' unless api_return.ok
+
+        puts 'PageID: ' + data._id + ', Result: Converted'
+      end
+    end
+  end
+end

data/lib/growi/image_converter/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Growi
+  module ImageConverter
+    VERSION = '0.1.0'
+  end
+end

data/lib/growi/image_converter.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'growi-client'
+require 'open-uri'
+
+require 'growi/image_converter/attached_image_file'
+require 'growi/image_converter/body'
+require 'growi/image_converter/esa'
+require 'growi/image_converter/markdown_image'
+require 'growi/image_converter/page'
+require 'growi/image_converter/version'

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: growi-image_converter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takayuki TAMURA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: growi-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: growi-image_converter is a converter that converts esa.io images to GROWI.
+email:
+- tamtam.okinawa@gmail.com
+executables:
+- growi-image_converter
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/growi-image_converter
+- growi-image_converter.gemspec
+- lib/growi/image_converter.rb
+- lib/growi/image_converter/attached_image_file.rb
+- lib/growi/image_converter/body.rb
+- lib/growi/image_converter/esa.rb
+- lib/growi/image_converter/markdown_image.rb
+- lib/growi/image_converter/page.rb
+- lib/growi/image_converter/version.rb
+homepage: https://github.com/aqutam/growi-image-converter-esa
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: GROWI image converter
+test_files: []