trello-fs 0.0.1

data/lib/trello-fs/attachment_builder.rb

@@ -0,0 +1,60 @@
+require 'open-uri'
+
+module TrelloFs
+  class AttachmentBuilder
+    attr_reader :card_builder, :attachment
+
+    def initialize(card_builder, attachment)
+      @card_builder = card_builder
+      @attachment = attachment
+    end
+
+    def build
+      return if already_downloaded?
+
+      download_and_save
+    end
+
+    def download_and_save
+      data = download
+      return unless data
+
+      FileUtils.mkpath(full_folder_path) unless File.exist? full_folder_path
+      File.open(path, 'wb') do |file|
+        file.write data
+      end
+    end
+
+    def path
+      File.join(full_folder_path, file_name)
+    end
+
+    def relative_path
+      File.join(folder_path, file_name)
+    end
+
+    def folder_path
+      File.join('Attachments', StringToFileName.convert(@card_builder.card_name))
+    end
+
+    def full_folder_path
+      File.join(repository.path, folder_path)
+    end
+
+    def file_name
+      @attachment.name.gsub(/ /, '_')
+    end
+
+    def already_downloaded?
+      File.exist? path
+    end
+
+    def download
+      open(@attachment.url).read
+    end
+
+    def repository
+      @card_builder.repository
+    end
+  end
+end

data/lib/trello-fs/attachment_cleaner.rb

@@ -0,0 +1,39 @@
+require 'fileutils'
+require 'set'
+
+module TrelloFs
+  class AttachmentCleaner
+    def initialize(repository, board)
+      @repository = repository
+      @board = board
+    end
+
+    def set_of_attachment_paths
+      @board.attachments.map do |attachment|
+        AttachmentBuilder.new(
+          CardBuilder.new(
+            ListBuilder.new(
+              BoardBuilder.new(@repository, @board),
+              attachment.card.list
+            ), attachment.card
+          ), attachment).path
+      end.to_set
+    end
+
+    def remove_old_attachments
+      new_attachments = set_of_attachment_paths
+
+      Dir.
+        glob(File.join(@repository.path, "Attachments/**/*")).
+        reject {|fn| File.directory?(fn) }.
+        each do |file|
+          next if new_attachments.include? file
+          FileUtils.rm(file)
+
+          # remove parent dir if empty
+          dirname = File.dirname(file)
+          FileUtils.rm_rf(dirname) if Dir[File.join(dirname, '*')].empty?
+        end
+    end
+  end
+end

data/lib/trello-fs/board_builder.rb

@@ -0,0 +1,61 @@
+module TrelloFs
+  class BoardBuilder
+    attr_reader :repository, :board
+
+    def initialize(repository, board)
+      @repository = repository
+      @board = board
+    end
+
+    def build
+      board.lists.each do |list|
+        ListBuilder.new(self, list).build
+      end
+      LabelsBuilder.new(@repository, @board).build
+
+      build_readme
+    end
+
+    def build_readme
+      readme_path = File.join(path, 'README.md')
+      File.open(readme_path, 'w') do |file|
+        file.write(readme_content)
+      end
+    end
+
+    def readme_content
+      [
+        "# [#{board_name}](#{@board.url})",
+        labels_content,
+        board.lists.map do |list|
+          list_builder = ListBuilder.new(self, list)
+          list_link = "[#{list_builder.list_name}](#{list_builder.file_name}/README.md)"
+
+          [
+            "## #{list_link}",
+            list_builder.content(true)
+          ].join("\n\n")
+        end.join("\n\n")
+      ].join("\n\n")
+    end
+
+    def labels_content
+      return '' unless @board.labels && @board.labels.any?
+
+      @board.labels.sort {|a, b| a.name <=> b.name }.
+        select {|lbl| lbl.cards.any? }.
+        map do |label|
+        label_builder = LabelBuilder.new(LabelsBuilder.new(@repository, @board), label)
+        "[`#{label_builder.label_name}`](#{label_builder.relative_path})"
+      end.join(' ')
+    end
+
+    def path
+      @repository.path
+    end
+
+    def board_name
+      @board.name
+    end
+  end
+end

data/lib/trello-fs/builder.rb

@@ -0,0 +1,31 @@
+module TrelloFs
+  class Builder
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    def build
+      repository = Repository.new config, self
+      board = TrelloApi.new(repository).board
+
+      # remove old files from the repo
+      RepositoryCleaner.new(repository).clean
+
+      BoardBuilder.new(repository, board).build
+      copy_readme_to_home(repository)
+
+      # remove old attachments
+      AttachmentCleaner.new(repository, board).remove_old_attachments
+    end
+
+    def copy_readme_to_home(repository)
+      FileUtils.cp(File.join(repository.path, 'README.md'), File.join(repository.path, 'Home'))
+    end
+
+    def trello_api_board(repository)
+      Trello::Board.find(repository.board_id)
+    end
+  end
+end

data/lib/trello-fs/card_builder.rb

@@ -0,0 +1,87 @@
+module TrelloFs
+  class CardBuilder
+    def initialize(list_builder, card)
+      @card = card
+      @list_builder = list_builder
+    end
+
+    def build
+      @list_builder.build_path
+
+      attachment_paths = @card.attachments.map do |attachment|
+        attachment_builder = AttachmentBuilder.new(self, attachment)
+        attachment_builder.build
+        attachment_builder.relative_path
+      end
+
+      File.open(path, 'w') do |file|
+        file.write(content(attachment_paths))
+      end
+    end
+
+    def path
+      File.join(@list_builder.path, file_name)
+    end
+
+    def relative_path
+      File.join(@list_builder.file_name, file_name)
+    end
+
+    def file_name
+      "#{StringToFileName.convert(@card.name)}.md"
+    end
+
+    def content(attachment_paths = [])
+      labels = card_labels.map do |lbl|
+        label_builder = LabelBuilder.new(LabelsBuilder.new(repository, board), lbl)
+        "[`#{label_builder.label_name}`](../#{label_builder.relative_path})"
+      end.sort.join(' ')
+      list_name = @list_builder.list_name
+      board_name = @list_builder.board_name
+
+      [
+        "# [#{card_name}](#{@card.url})",
+        [
+          "[#{board_name}](../README.md)",
+          "[#{list_name}](README.md)"
+        ].join(' > '),
+        labels,
+        @card.desc,
+        attachments_content(attachment_paths)
+      ].join("\n\n")
+    end
+
+    def attachments_content(attachment_paths = [])
+      return '' unless attachment_paths.any?
+
+      links = attachment_paths.map do |path|
+        name = path.split('/').last
+        path = "../#{path}"
+        link = "[#{name}](#{path})"
+        if path.end_with?('.png') || path.end_with?('.jpg') || path.end_with?('gif')
+          "!#{link}"
+        else
+          link
+        end
+      end.join("  \n")
+
+      "\n\n## Attachments\n\n#{links}"
+    end
+
+    def card_name
+      @card.name
+    end
+
+    def repository
+      @list_builder.repository
+    end
+
+    def card_labels
+      @card_labels ||= @card.labels
+    end
+
+    def board
+      @list_builder.board_builder.board
+    end
+  end
+end

data/lib/trello-fs/label_builder.rb

@@ -0,0 +1,60 @@
+module TrelloFs
+  class LabelBuilder
+    def initialize(labels_builder, label)
+      @labels_builder = labels_builder
+      @repository = @labels_builder.repository
+      @board = @labels_builder.board
+      @label = label
+    end
+
+    def build
+      FileUtils.mkpath(folder_path)
+
+      File.open(path, 'w') do |f|
+        f.write content
+      end
+    end
+
+    def path
+      File.join(folder_path, file_name)
+    end
+
+    def relative_path
+      File.join('Labels', file_name)
+    end
+
+    def folder_path
+      File.join(@repository.path, 'Labels')
+    end
+
+    def file_name
+      "#{StringToFileName.convert(label_name)}.md"
+    end
+
+    def content
+      [
+        "# `#{label_name}`",
+        "[#{@board.name}](../README.md)",
+        card_links
+      ].join("\n\n")
+    end
+
+    def card_links
+      @label.cards.sort {|a,b| a.name <=> b.name }.map do |card|
+        card_builder = CardBuilder.new(
+          ListBuilder.new(
+            BoardBuilder.new(@repository, @board),
+            card.list
+          ), card
+        )
+        path = '../' + card_builder.relative_path
+        link = "[#{card_builder.card_name}](#{path})"
+          "- #{link}"
+      end.join("\n")
+    end
+
+    def label_name
+      @label.name.empty? ? 'no name' : @label.name
+    end
+  end
+end

data/lib/trello-fs/labels_builder.rb

@@ -0,0 +1,16 @@
+module TrelloFs
+  class LabelsBuilder
+    attr_reader :repository, :board
+
+    def initialize(repository, board)
+      @repository = repository
+      @board = board
+    end
+
+    def build
+      @board.labels.each do |label|
+        LabelBuilder.new(self, label).build
+      end
+    end
+  end
+end

data/lib/trello-fs/list_builder.rb

@@ -0,0 +1,68 @@
+module TrelloFs
+  class ListBuilder
+    attr_reader :board_builder, :list
+
+    def initialize(board_builder, list)
+      @board_builder = board_builder
+      @list = list
+    end
+
+    def build
+      list.cards.each do |card|
+        CardBuilder.new(self, card).build
+      end
+
+      build_readme
+    end
+
+    def build_readme
+      build_path
+      readme_path = File.join(path, 'README.md')
+      File.open(readme_path, 'w') do |file|
+        file.write(readme_content)
+      end
+    end
+
+    def readme_content
+      [
+        "# #{list_name}",
+        "[#{board_name}](../README.md)",
+        content
+      ].join("\n\n")
+    end
+
+    def content(full_path = false)
+      @list.cards.map do |card|
+        cb = CardBuilder.new(self, card)
+        card_path = cb.file_name
+        card_path = File.join(file_name, card_path) if full_path
+
+        "- [#{cb.card_name}](#{card_path})"
+      end.join("\n")
+    end
+
+    def path
+      File.join(@board_builder.path, file_name)
+    end
+
+    def file_name
+      StringToFileName.convert(@list.name)
+    end
+
+    def build_path
+      FileUtils.mkpath(path) unless File.exist? path
+    end
+
+    def list_name
+      @list.name
+    end
+
+    def board_name
+      @board_builder.board_name
+    end
+
+    def repository
+      @board_builder.repository
+    end
+  end
+end

data/lib/trello-fs/repository.rb

@@ -0,0 +1,36 @@
+module TrelloFs
+  class Repository
+    attr_reader :config
+
+    def initialize(config, builder = nil)
+      raise 'Wrong arguments' unless has_required_configuration?(config)
+
+      @config = config
+      @builder = builder
+    end
+
+    def path
+      @config[:path]
+    end
+
+    def board_id
+      @config[:board_id]
+    end
+
+    def developer_public_key
+      config[:developer_public_key]
+    end
+
+    def member_token
+      config[:member_token]
+    end
+
+    private
+
+    def has_required_configuration?(config)
+      config.has_key?(:path) &&
+        config.has_key?(:developer_public_key) &&
+        config.has_key?(:member_token)
+    end
+  end
+end

data/lib/trello-fs/repository_cleaner.rb

@@ -0,0 +1,18 @@
+require 'fileutils'
+
+module TrelloFs
+  class RepositoryCleaner
+    def initialize(repository)
+      @repository = repository
+    end
+
+    def clean
+      Dir.entries(@repository.path).each do |path|
+        next if path.start_with? '.'
+        next if path == 'Attachments'
+
+        FileUtils.rm_rf File.join(@repository.path, path)
+      end
+    end
+  end
+end

data/lib/trello-fs/string_to_file_name.rb

@@ -0,0 +1,9 @@
+module TrelloFs
+  class StringToFileName
+    def self.convert(str)
+      str.gsub(/[^\w\s_-]+/, '').
+        gsub(/(^|\b\s)\s+($|\s?\b)/, '\\1\\2').
+        gsub(/\s+/, '_')
+    end
+  end
+end

data/lib/trello-fs/trello_api.rb

@@ -0,0 +1,83 @@
+require 'open-uri'
+require 'json'
+
+module TrelloFs
+  class TrelloApi
+    def initialize(repository)
+      @repository = repository
+    end
+
+    def board
+      @board ||= new_board
+    end
+
+    def new_board
+      json = download_board_json
+      board = OpenStruct.new(name: json['name'],
+                             desc: json['desc'],
+                             id: json['id'],
+                             url: json['url'])
+      labels, lists = {}, {}
+      board.attachments = []
+
+      board.organization_name = json['organization']['displayName'] if json['organization']
+
+      json['labels'].each do |label|
+        labels[label['id']] = OpenStruct.new name: label['name'], id: label['id'], cards: []
+      end
+
+      json['lists'].each do |list|
+        lists[list['id']] = OpenStruct.new(name: list['name'],
+                                           id: list['id'],
+                                           board: board,
+                                           cards: [])
+      end
+
+      cards = json['cards'].map do |card|
+        list = lists[card['idList']]
+        c = OpenStruct.new(id: card['id'],
+                           name: card['name'],
+                           desc: card['desc'],
+                           url: card['url'],
+                           list: list)
+        list.cards << c
+
+        c.labels = card['idLabels'].map do |label_id|
+          label = labels[label_id]
+          label.cards << c
+          label
+        end
+
+        c.checklists = card['checklists'].map do |checklist|
+          OpenStruct.new(
+            name: checklist['name'],
+            items: checklist['checkItems'].map do |item|
+              OpenStruct.new(name: item['name'], state: item['state'])
+            end
+          )
+        end
+
+        c.attachments = card['attachments'].map do |attachment|
+          a = OpenStruct.new(name: attachment['name'],
+                             url: attachment['url'],
+                             id: attachment['id'],
+                             card: c)
+          board.attachments << a
+          a
+        end
+
+        c
+      end
+
+      board.labels = labels.values
+      board.lists = lists.values
+
+      board
+    end
+
+    def download_board_json
+      url = "https://api.trello.com/1/boards/#{@repository.board_id}?key=#{@repository.developer_public_key}&token=#{@repository.member_token}&cards=all&lists=all&labels=all&card_checklists=all&card_attachments=true&organization=true"
+      JSON.parse(open(url).read)
+    end
+  end
+end

data/lib/trello-fs/version.rb

@@ -0,0 +1,3 @@
+module TrelloFs
+    VERSION = "0.0.1"
+end

data/lib/trello-fs.rb

@@ -0,0 +1,8 @@
+Dir[File.dirname(__FILE__) + "/**/*.rb"].each { |file| require file }
+require 'fileutils'
+
+module TrelloFs
+  def self.build(config)
+    Builder.new(config).build
+  end
+end

data/spec/helpers/test_repository.rb

@@ -0,0 +1,21 @@
+require 'fileutils'
+
+class TestRepository < TrelloFs::Repository
+  def initialize
+    super({
+      path: TestRepository.path,
+      developer_public_key: '',
+      member_token: ''
+    })
+  end
+
+  def self.path
+    p = 'tmp/test_repo'
+    FileUtils.mkpath p
+    p
+  end
+
+  def self.remove
+    FileUtils.rm_rf path
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require File.expand_path("../../lib/trello-fs", __FILE__)
+Dir[File.dirname(__FILE__) + "/helpers/*.rb"].each { |file| require file }
+require 'ostruct'
+
+RSpec.configure do |config|
+  config.after :each do
+    TestRepository.remove
+  end
+end

data/spec/trello-fs/attachment_builder_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe TrelloFs::AttachmentBuilder do
+  let(:attachment) { OpenStruct.new(id: '1', name: 'Attachment Name') }
+  let(:card) { OpenStruct.new(name: 'Card Name', attachments: [attachment]) }
+  let(:list) { OpenStruct.new(name: 'List Name', cards: [card]) }
+  let(:board) { OpenStruct.new(name: 'Board') }
+
+  let(:board_builder) { TrelloFs::BoardBuilder.new(TestRepository.new, board) }
+  let(:list_builder) { TrelloFs::ListBuilder.new(board_builder, list) }
+  let(:card_builder) { TrelloFs::CardBuilder.new(list_builder, card) }
+  let(:attachment_builder) { TrelloFs::AttachmentBuilder.new(card_builder, attachment) }
+
+  subject { attachment_builder }
+
+  before(:each) do
+    allow(attachment_builder).to receive(:download) { 'data' }
+  end
+
+  describe '#path' do
+    subject { attachment_builder.path }
+
+    it { should include 'Card_Name' }
+    it { should include 'Attachment Name' }
+  end
+
+  describe '#already_downloaded?' do
+    subject { attachment_builder.already_downloaded? }
+
+    it { should eq false }
+
+    it 'returns true after download' do
+      attachment_builder.build
+      should eq true
+    end
+  end
+end