trellodon 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf1b8715b6cbad2c1bd3ab4fce72198a442380cf4f2d7bb39c55928ef72b032f
+  data.tar.gz: 2caa2a3a24fe463cc1cb730a3aad68928323ec0fea04fea8e3a0f10ebf051ea7
+SHA512:
+  metadata.gz: b50b3279f7a9e787b2f2e718109902a9cda88729f7d7b330aa5db9db944f913af33d6f26fab7b1f6c4d2866a1241d62d99c4dbe989ea468499bcaaa4908a153f
+  data.tar.gz: 52d86ebd0b43ad0b064facbfb66332623422b2c688eff732188b7ea2ce8baba2842a331a941e1aafb410f114c31aef3ec80f7588b7f6a07808070019f9eb12ba

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-04-07
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Evil Martians
+
+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,3 @@
+# trellodon
+
+Dump Trello boards to your file system

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "trellodon"
+require "irb"
+
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/bin/trellodon

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "trellodon/cli"
+
+Trellodon::CLI.new.run

data/lib/trellodon/api_client.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require "trello"
+
+require "trellodon/entities"
+
+module Trellodon
+  class APIClient
+    def initialize(api_key:, api_token:, logger: Config.logger)
+      @logger = logger
+      @client = Trello::Client.new(
+        developer_public_key: api_key,
+        member_token: api_token
+      )
+    end
+
+    def fetch_board(board_id)
+      retrying do
+        board = @client.find(:boards, board_id)
+
+        Board.new(
+          id: board.id,
+          short_id: board.short_url.chars.last(8).join,
+          name: board.name,
+          lists: lists_from(board),
+          card_ids: @client.find_many(Trello::Card, "/boards/#{board_id}/cards", fields: "id").map(&:id),
+          last_activity_date: board.last_activity_date
+        )
+      end
+    end
+
+    def fetch_card(card_id)
+      retrying do
+        card = @client.find(:cards, card_id)
+
+        Card.new(
+          id: card.id,
+          short_id: card.short_url.chars.last(8).join,
+          name: card.name,
+          desc: card.desc,
+          labels: card.labels.map(&:name),
+          list_id: card.list_id,
+          comments: comments_from(card),
+          attachments: attachments_from(card),
+          last_activity_date: card.last_activity_date
+        )
+      end
+    end
+
+    private
+
+    attr_reader :logger
+
+    def retrying(&block)
+      attempt = 0
+      begin
+        block.call
+      rescue Trello::Error => err
+        raise unless err.status_code == 429
+
+        attempt += 1
+
+        cooldown = 2**attempt + rand(2**attempt) - 2**(attempt - 1)
+
+        logger.warn "API limit exceeded, cool down for #{cooldown}s"
+
+        sleep cooldown
+
+        retry
+      end
+    end
+
+    def comments_from(card)
+      card.comments.map do |comment|
+        Comment.new(
+          text: comment.data["text"],
+          date: comment.date,
+          creator_id: comment.creator_id
+        )
+      end
+    end
+
+    def attachments_from(card)
+      card.attachments.map do |attach|
+        Attachment.new(
+          file_name: attach.file_name,
+          mime_type: attach.mime_type,
+          bytes: attach.bytes,
+          url: attach.url
+        )
+      end
+    end
+
+    def lists_from(board)
+      board.lists.map do |list|
+        List.new(
+          id: list.id,
+          name: list.name,
+          short_id: board.short_url.chars.last(8).join
+        )
+      end
+    end
+  end
+end

data/lib/trellodon/api_executor.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "trellodon/api_client"
+require "trellodon/config"
+
+module Trellodon
+  class APIExecutor
+    BOARD_ID_REGEX = /\/b\/([^\/]+)\//
+    private_constant :BOARD_ID_REGEX
+
+    def initialize(api_key:, api_token:, scheduler:, formatter:, logger: Config.logger)
+      @api_key = api_key
+      @api_token = api_token
+      @formatter = formatter
+      @logger = logger
+      @scheduler = scheduler
+      check_credentials!
+
+      @api_client = APIClient.new(api_key: @api_key, api_token: @api_token)
+    end
+
+    def download(board_pointer)
+      extract_board_id(board_pointer)
+
+      startup_time = Time.now
+      logger.debug "Fetching board 🚀️️"
+      board = scheduler.post do
+        api_client.fetch_board(board_id).tap { formatter.board_added(_1) }
+      end.value
+
+      logger.debug "Fetching cards in board with comments and attachments 🐢"
+      board.card_ids.map do |card_id|
+        scheduler.post do
+          api_client.fetch_card(card_id).tap { formatter.card_added(_1) }
+        end
+      end.map(&:value)
+
+      formatter.finish
+      logger.debug "All Trello API requests finished in #{(Time.now - startup_time).to_i} seconds ⌛"
+    end
+
+    private
+
+    attr_reader :api_client, :board_id, :logger, :scheduler, :formatter
+
+    def check_credentials!
+      return if @api_key.to_s.size.positive? && @api_token.to_s.size.positive?
+
+      raise ArgumentError, "Missing credentials. Please fill out both api_key, api_token first."
+    end
+
+    def extract_board_id(board_pointer)
+      @board_id = if URI::DEFAULT_PARSER.make_regexp.match?(board_pointer)
+        parse_board_url(board_pointer)
+      else
+        board_pointer
+      end
+    end
+
+    def parse_board_url(board_url)
+      rel_path = URI.parse(board_url).request_uri
+      match_data = rel_path.match(BOARD_ID_REGEX)
+      raise ArgumentError, "Wrong trello board url" if match_data.nil? || match_data.size != 2
+
+      match_data[1]
+    end
+  end
+end

data/lib/trellodon/cli.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require "trellodon"
+
+require "tty-prompt"
+
+module Trellodon
+  class CLI
+    class Prompt
+      def initialize
+        @prompt = TTY::Prompt.new
+      end
+
+      def ask_api_key
+        @prompt.mask(
+          "Provide your Developer API Key (see https://trello.com/app-key):"
+        ) { |q| q.required true }
+      end
+
+      def ask_api_token
+        @prompt.mask(
+          "Provide your API token:"
+        ) { |q| q.required true }
+      end
+
+      def ask_board
+        @prompt.ask("Which board would you like to dump? (URL or ID)") do |q|
+          q.required true
+        end
+      end
+
+      def ask_folder
+        @prompt.ask("Destination folder?", default: "./")
+      end
+    end
+
+    class Config < Trellodon::Config
+      attr_config :board, :out
+
+      ignore_options :api_key, :api_token
+
+      describe_options(
+        board: "Board URL or ID",
+        out: "Destination folder path"
+      )
+
+      extend_options do |opts, _|
+        opts.banner = "Usage: trellodon dump\n"\
+                      "Options:\n"
+
+        opts.on_tail("-v", "--version", "Print current version") do
+          puts Trellodon::VERSION
+          exit
+        end
+
+        opts.on_tail("-h", "--help", "Print help") do
+          puts opts
+          exit
+        end
+      end
+
+      private def prompt
+        @prompt ||= Prompt.new
+      end
+
+      def api_key
+        super || (self.api_key = prompt.ask_api_key)
+      end
+
+      def api_token
+        super || (self.api_token = prompt.ask_api_token)
+      end
+
+      def board
+        super || (self.board = prompt.ask_board)
+      end
+
+      def out
+        super || (self.out = prompt.ask_folder)
+      end
+    end
+
+    def initialize
+      @config = Config.new
+    end
+
+    def run
+      check_command!
+
+      executor = Trellodon::APIExecutor.new(
+        api_key: config.api_key,
+        api_token: config.api_token,
+        formatter: Trellodon::Formatters::Markdown.new(output_dir: config.out),
+        scheduler: Schedulers::Threaded.new
+      )
+      executor.download(config.board)
+    end
+
+    private
+
+    attr_reader :config
+
+    def check_command!
+      command, = config.option_parser.permute!(ARGV)
+      unless command
+        puts config.option_parser.help
+        exit
+      end
+
+      return if command == "dump"
+
+      raise "Unknown command: #{command}. Available commands: dump"
+    end
+  end
+end

data/lib/trellodon/config.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "anyway_config"
+require "logger"
+
+module Trellodon
+  class Config < Anyway::Config
+    config_name :trellodon
+
+    attr_config :api_token, :api_key
+
+    def self.logger
+      Logger.new($stdout)
+    end
+  end
+end

data/lib/trellodon/entities/attachment.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Trellodon
+  Attachment = Struct.new("Attachment", :file_name, :mime_type, :bytes, :url, keyword_init: true)
+end

data/lib/trellodon/entities/board.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Trellodon
+  Board = Struct.new("Board", :id, :short_id, :name, :card_ids, :lists, :last_activity_date, keyword_init: true) do
+    def get_list(list_id)
+      return nil if lists.nil?
+      lists.find { |list| list.id == list_id }
+    end
+  end
+end

data/lib/trellodon/entities/card.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Trellodon
+  Card = Struct.new("Card", :id, :short_id, :name, :desc, :list_id, :labels, :comments, :attachments, :last_activity_date, keyword_init: true)
+end

data/lib/trellodon/entities/comment.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Trellodon
+  Comment = Struct.new("Comment", :text, :date, :creator_id, keyword_init: true)
+end

data/lib/trellodon/entities/list.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Trellodon
+  List = Struct.new("List", :id, :short_id, :name, keyword_init: true)
+end

data/lib/trellodon/entities.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "trellodon/entities/board"
+require "trellodon/entities/card"
+require "trellodon/entities/list"
+require "trellodon/entities/comment"
+require "trellodon/entities/attachment"

data/lib/trellodon/formatters/base.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Trellodon
+  module Formatters
+    class Base
+      attr_reader :board, :logger
+
+      def initialize(logger: Config.logger)
+        @logger = logger
+      end
+
+      def board_added(board)
+        @board = board
+      end
+
+      def card_added(card)
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+
+      def finish
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+    end
+  end
+end

data/lib/trellodon/formatters/markdown.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require "open-uri"
+require "fileutils"
+require "trellodon/formatters/base"
+
+module Trellodon
+  module Formatters
+    class Markdown < Base
+      attr_reader :output_dir
+
+      def initialize(output_dir:, **opts)
+        super(**opts)
+        @output_dir = output_dir
+      end
+
+      def card_added(card)
+        card_mdfile = File.join(card_path(card), "index.md")
+        raise "File #{card_mdfile} already exists" if File.exist?(card_mdfile)
+
+        File.write(card_mdfile, format_card(card))
+        download_attachments(card)
+      end
+
+      def finish
+        logger.info "Markdown dump is here: #{@output_dir}"
+      end
+
+      private
+
+      def card_path(card)
+        raise "Board is undefined" if @board.nil?
+        raise "List id is undefined" if card.list_id.nil? || card.list_id.empty?
+        list = @board.get_list(card.list_id)
+        raise "List #{card.list_id} is not found" if list.nil?
+
+        card_dir = File.join(@output_dir,
+          "#{board.name} [#{board.short_id}]",
+          "#{list.name} [#{list.short_id}]",
+          "#{card.name} [#{card.short_id}]")
+        FileUtils.mkdir_p(card_dir) unless File.directory?(card_dir)
+        card_dir
+      end
+
+      def card_attachments_path(card)
+        attachments_dir = File.join(card_path(card), "attachments")
+        FileUtils.mkdir_p(attachments_dir) unless File.directory?(attachments_dir)
+        attachments_dir
+      end
+
+      def download_attachments(card)
+        return # FIXME: 401 Unauthorized ???
+        return if card.attachments.nil? || card.attachments.empty? # rubocop:disable Lint/UnreachableCode
+        attachments_path = card_attachments_path(card)
+        card.attachments.each do |att|
+          IO.copy_stream(URI.parse(att.url).open, File.join(attachments_path, att.file_name))
+        end
+      end
+
+      def format_card(card)
+        create_card_header(card) +
+          create_card_title(card) +
+          create_card_description(card) +
+          create_card_comments(card)
+      end
+
+      def create_card_header(card)
+        <<~EOS
+          ---
+          title: #{card.name}
+          last_updated_at: #{card.last_activity_date}
+          labels: #{create_card_labels(card)}
+          ---
+        EOS
+      end
+
+      def create_card_title(card)
+        <<~EOS
+
+          # #{card.name}
+        EOS
+      end
+
+      def create_card_description(card)
+        <<~EOS
+
+          ## Description
+          #{card.desc}
+        EOS
+      end
+
+      def create_card_labels(card)
+        return "" if card.labels.nil? || card.labels.empty?
+        card.labels.map { |label| "\n - " + label }.reduce(:+)
+      end
+
+      def create_card_comments(card)
+        return "" if card.comments.nil? || card.comments.empty?
+        <<~EOS
+
+          ## Comments
+          #{card.comments.map { |comment| create_card_comment(comment) }.reduce(:+)}
+        EOS
+      end
+
+      def create_card_comment(comment)
+        <<~EOS
+
+          **#{comment.creator_id} @ #{comment.date}**  
+          #{comment.text}
+        EOS
+      end
+    end
+  end
+end

data/lib/trellodon/formatters.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "trellodon/formatters/base"
+require "trellodon/formatters/markdown"

data/lib/trellodon/schedulers/base.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Trellodon
+  module Schedulers
+    class Base
+      def post
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/trellodon/schedulers/inline.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "trellodon/schedulers/base"
+
+module Trellodon
+  module Schedulers
+    class Inline < Base
+      Result = Struct.new(:value)
+
+      def post(&block)
+        Result.new(block.call)
+      end
+    end
+  end
+end

data/lib/trellodon/schedulers/threaded.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "trellodon/schedulers/base"
+
+module Trellodon
+  module Schedulers
+    class Threaded < Base
+      def post(&block)
+        Thread.new(&block)
+      end
+    end
+  end
+end

data/lib/trellodon/schedulers.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "trellodon/schedulers/base"
+require "trellodon/schedulers/inline"
+require "trellodon/schedulers/threaded"

data/lib/trellodon/version.rb

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

data/lib/trellodon.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "trellodon/version"
+require "trellodon/config"
+require "trellodon/api_executor"
+
+require "trellodon/entities"
+require "trellodon/schedulers"
+require "trellodon/formatters"

data/sig/trellodon.rbs

@@ -0,0 +1,4 @@
+module Trellodon
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: trellodon
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- fargelus
+- rinasergeeva
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: anyway_config
+  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'
+- !ruby/object:Gem::Dependency
+  name: ruby-trello
+  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'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  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: "\n    The main purpose of Trellodon is to make it possible to backup
+  Trello boards to file system in a human-readable form (e.g., Markdown files).\n
+  \ "
+email:
+- ddraudred@gmail.com
+- catherine.sergeeva@gmail.com
+executables:
+- trellodon
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/console
+- bin/setup
+- bin/trellodon
+- lib/trellodon.rb
+- lib/trellodon/api_client.rb
+- lib/trellodon/api_executor.rb
+- lib/trellodon/cli.rb
+- lib/trellodon/config.rb
+- lib/trellodon/entities.rb
+- lib/trellodon/entities/attachment.rb
+- lib/trellodon/entities/board.rb
+- lib/trellodon/entities/card.rb
+- lib/trellodon/entities/comment.rb
+- lib/trellodon/entities/list.rb
+- lib/trellodon/formatters.rb
+- lib/trellodon/formatters/base.rb
+- lib/trellodon/formatters/markdown.rb
+- lib/trellodon/schedulers.rb
+- lib/trellodon/schedulers/base.rb
+- lib/trellodon/schedulers/inline.rb
+- lib/trellodon/schedulers/threaded.rb
+- lib/trellodon/version.rb
+- sig/trellodon.rbs
+homepage: https://github.com/evilmartians/trellodon
+licenses: []
+metadata:
+  homepage_uri: https://github.com/evilmartians/trellodon
+  source_code_uri: https://github.com/evilmartians/trellodon
+  changelog_uri: https://github.com/evilmartians/trellodon/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: 'Trellodon: dump Trello boards to your file system'
+test_files: []