mindmeister_api 0.0.15

data/bin/khotfix

@@ -0,0 +1,244 @@
+#!/usr/bin/env bash
+
+#NOTE: you may need change file permissions
+#      chmod +x bin/khotfix
+
+# Create a Versioned HotFix in Git and update the VERSION #
+# USAGE
+#
+#   ./bin/khotfix.sh 'my brand new hot fix'
+
+# HELPERS
+clear
+
+l_heading ()
+{
+  heading=$1
+
+  echo "======================================================================"
+  echo "${heading}"
+  echo "======================================================================"
+}
+
+l_line ()
+{
+  echo "----------------------------------------------------------------------"
+}
+
+l_title ()
+{
+  title=$1
+
+  l_line
+  echo "${title}"
+  l_line
+}
+
+l ()
+{
+  title=$1
+
+  echo "${title}"
+}
+
+lkv ()
+{
+  title=$1
+  value=$2
+
+  printf "%-25s : %s\n" "$title" "$value"
+}
+
+
+# expect 1 argument
+MESSAGE=$1
+
+l_heading "Make Hotfix - '${MESSAGE}'"
+
+
+# This environment var will prevent git from asking for merge messages
+export GIT_MERGE_AUTOEDIT=no
+
+# Set up colour support, if we have it
+# Are stdout and  stderr both connected to a terminal, If not then don't set colours
+if [ -t 1 -a -t 2 ]
+then
+  if tput -V >/dev/null 2>&1
+  then
+    C_RED=`tput setaf 1`
+    C_GREEN=`tput setaf 2`
+    C_BROWN=`tput setaf 3`
+    C_BLUE=`tput setaf 4`
+    C_RESET=`tput sgr0`
+  fi
+fi
+
+
+exit_error ()
+{
+  # dont display if string is zero length
+  [  -z "$1" ] || echo "${C_RED}Error: ${C_BROWN} $1 ${C_RESET}"
+  exit 1
+}
+
+
+# check arguments
+[ ! -z "${MESSAGE}" ] || exit_error "You must pass a message when making a hotfix"
+
+# make sure we are in a git tree
+[ "`git rev-parse --is-inside-work-tree`" = "true" ] || exit_error "NOT a git repository"
+l "Repository check OK"
+
+CURRENT_BRANCH=`git branch | awk '/^\*/{print $2}'`
+
+lkv "CURRENT_BRANCH" "${CURRENT_BRANCH}"
+
+# check that we are on develop or master
+[ "${CURRENT_BRANCH}" = "master" -o "${CURRENT_BRANCH}" = "develop" ] || exit_error "You MUST be on either the master or development branch"
+l "OK: Branch"
+
+# check that the current branch is NOT clean (we need changes to make a hotfix)
+[  ! -z "`git status --porcelain`" ] || exit_error "Working copy is clean - no hotfix"
+l "OK: Working copy has hotfix ready"
+
+# fetch from origin
+git fetch origin || exit_error "Failed to fetch from origin"
+l "OK: Fsetch from origin"
+
+# get the current directory that this script is in.
+# we assume that the other scripts are in the same directory
+SYNC_SCRIPT=kgitsync
+SCRIPT_DIR=`dirname $0`
+
+# ----------------------------------------------------------------------
+# GET VERSION NUMBER
+# ----------------------------------------------------------------------
+
+l_title 'GET VERSION NUMBER'
+
+# Get the last tag version
+VERSION=`git tag | sort -V | tail -1`
+lkv "CURENT VERSION" "${VERSION}"
+
+# NOTE, if you don't have a TAG then you might need to manually do
+# git flow hotfix start v0.01.001
+# git flow hotfix finish v0.01.001
+
+# Verify its format
+[[ "`git tag | sort -V | tail -1`"  =~ ^v[0-9]{1,2}.[0-9]{1,2}.[0-9]{1,3}$ ]] || exit_error "Bad version format, version=${VERSION}"
+# extract the version components
+IFS=. read MAJOR_VERSION MINOR_VERSION PATCH_VERSION <<< "${VERSION}"
+
+# inc the patch version.  note: force base 10 as leading 0 makes bash think this is octal
+PATCH_VERSION=$((10#${PATCH_VERSION} + 1))
+lkv 'Patch #' "${PATCH_VERSION}"
+
+# assemble the new version
+NEW_VERSION="${MAJOR_VERSION}.${MINOR_VERSION}.${PATCH_VERSION}"
+lkv "NEW VERSION" "${NEW_VERSION}"
+
+./hooks/update-version "${NEW_VERSION}" || exit_error "could not update version.rb you may need to run [chmod +x hooks/update-version]"
+
+l_line
+l 'git add .'
+git add .
+
+l 'git status'
+l_line
+git status
+
+# ----------------------------------------------------------------------
+# Before doing anything, add the files and then run the commit hook
+# Then stash any changes - working directory will be clean after this
+# The commit hook is where we can check for any debugging code that has
+# gone into the code and abort the commit
+# ----------------------------------------------------------------------
+
+l 'check for debugging code'
+./hooks/pre-commit || exit_error "remove debugging code from the commit - then run again"
+
+l "Stash changes to [git_make_hotfix: ${MESSAGE}]"
+
+git stash save "git_make_hotfix: ${MESSAGE}"
+
+l "OK: Stashed"
+
+l_title 'Master/Develop Branches'
+# ----------------------------------------------------------------------
+# update develop
+# ----------------------------------------------------------------------
+
+lkv "Develop" "Synchronized"
+git checkout develop || exit_error "Failed to checkout develop branch"
+lkv "Develop" "Switched"
+git merge origin/develop || exit_error "Failed to merge develop from origin"
+lkv "Develop" "Merged and upto date"
+
+# ----------------------------------------------------------------------
+# update master
+# ----------------------------------------------------------------------
+
+lkv "Master" "Synchronized"
+git checkout master || exit_error "Failed to checkout master branch"
+lkv "Master" "Switched"
+git merge  origin/master || exit_error "Failed to merge master from origin"
+lkv "Master" "Merged and upto date"
+
+# ----------------------------------------------------------------------
+# start the hotfix
+# ----------------------------------------------------------------------
+
+l_title 'Hotfix'
+
+lkv "Version" "${NEW_VERSION}"
+
+
+
+lkv "git flow hotfix start" "${NEW_VERSION}"
+
+git flow hotfix start "${NEW_VERSION}" || exit_error "Failed to start hotfix ${NEW_VERSION}"
+
+HOTFIX_BRANCH="hotfix/${NEW_VERSION}"
+
+lkv "started" "${HOTFIX_BRANCH}"
+
+# ----------------------------------------------------------------------
+# commit the stashed changes
+# ----------------------------------------------------------------------
+
+lkv "git stash" "pop"
+
+git stash pop || exit_error "Failed to pop the stash into the hotfix"
+
+lkv "git commit" "${MESSAGE}"
+
+git commit -a -m"${MESSAGE}" || exit_error "Failed to commit the stash to ${HOTFIX_BRANCH}"
+
+lkv "git commit succesful" "${HOTFIX_BRANCH}"
+
+# ----------------------------------------------------------------------
+# close the hotfix
+# ----------------------------------------------------------------------
+
+lkv "git flow hotfix finish" "${NEW_VERSION}"
+
+git flow hotfix finish "${NEW_VERSION}" -m"${MESSAGE}" || exit_error "Failed to close ${HOTFIX_BRANCH}"
+
+lkv "finished" "${HOTFIX_BRANCH}"
+
+# closing the hotfix leaves you on the development branch
+# return to the master ???? or should we stay on development
+
+lkv "git checkout" "master"
+
+git checkout master || exit_error "Failed to return to master branch"
+
+# ----------------------------------------------------------------------
+# now push the changes
+# ----------------------------------------------------------------------
+
+l_title 'Push Changes and Synchronize Master/Develop'
+
+${SCRIPT_DIR}/${SYNC_SCRIPT}
+
+l_heading 'Success'

data/bin/setup

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+# frozen_string_literal: true
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hooks/pre-commit

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'English'
+
+# NOTE: you may need change file permissions
+#       chmod +x hooks/pre-commit
+
+exit 0 if ARGV.include?('--no-verify')
+
+warning_keywords = %w[console.log]
+keywords = %w[binding.pry console.dir byebug debugger]
+files_changed = `git diff-index --name-only HEAD --`.split
+
+# puts '----------------------------------------------------------------------'
+# puts remove files changed from the pre-commit checking if they are one of the following files
+# puts '----------------------------------------------------------------------'
+# files_changed = files_changed - ['hooks/pre-commit']
+# files_changed = files_changed - ['hooks/update-version']
+
+# byebug may need to be in these files
+files_changed -= ['Gemfile']
+files_changed -= ['Gemfile.lock']
+files_changed -= ['.gitignore']
+files_changed -= ['README.md']
+
+files_changed = files_changed.reject { |f| f.downcase.end_with?('.json') }
+files_changed = files_changed.reject { |f| f.downcase.end_with?('.yml') }
+
+# ignore files from specific folders
+
+file_groups = files_changed.select do |item|
+  item.start_with?('hooks') # ||
+  # item.start_with?('lib/generators')
+end
+
+files_changed -= file_groups
+
+# remove files that are changed because they are deleted
+files_changed = files_changed.select { |filename| File.file?(filename) }
+
+# puts '----------------------------------------------------------------------'
+# puts 'Files Changed'
+# puts '----------------------------------------------------------------------'
+# puts files_changed
+# puts '----------------------------------------------------------------------'
+
+unless files_changed.length.zero?
+  # puts "#{keywords.join('|')}"
+  # puts "#{files_changed.join(' ')}"
+
+  `git grep -q -E "#{warning_keywords.join('|')}" #{files_changed.join(' ')}`
+
+  if $CHILD_STATUS.exitstatus.zero?
+    puts '' # Check following lines:''
+    puts $CHILD_STATUS.exitstatus
+    files_changed.each do |file|
+      warning_keywords.each do |keyword|
+        # puts "#{keyword} ::: #{file}"
+        `git grep -q -E #{keyword} #{file}`
+        if $CHILD_STATUS.exitstatus.zero?
+          line = `git grep -n #{keyword} #{file} | awk -F ":" '{print $2}'`.split.join(', ')
+          puts "WARNING:\t\033[31m#{file}\033[0m contains #{keyword} at line \033[33m#{line}\033[0m."
+        end
+      end
+    end
+  end
+
+  `git grep -q -E "#{keywords.join('|')}" #{files_changed.join(' ')}`
+
+  if $CHILD_STATUS.exitstatus.zero?
+    puts '' # Check following lines:''
+    puts $CHILD_STATUS.exitstatus
+    files_changed.each do |file|
+      keywords.each do |keyword|
+        # puts "#{keyword} ::: #{file}"
+        `git grep -q -E #{keyword} #{file}`
+        if $CHILD_STATUS.exitstatus.zero?
+          line = `git grep -n #{keyword} #{file} | awk -F ":" '{print $2}'`.split.join(', ')
+          puts "ERROR  :\t\033[31m#{file}\033[0m contains #{keyword} at line \033[33m#{line}\033[0m."
+        end
+      end
+    end
+    puts '# Force commit with --no-verify'
+    exit 1
+  end
+end

data/hooks/update-version

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# NOTE: you may need change file permissions
+#       chmod +x hooks/update-version
+
+exit 1 if ARGV.empty?
+
+version = ARGV[0]
+version = version[1..-1] # revoke 'v' character, e.g. v0.1.1 becomes 0.1.1
+
+namespaces = %w[MindmeisterApi]
+
+indent = 0
+output = ['# frozen_string_literal: true', '']
+
+namespaces.each do |namespace|
+  output.push "#{'  ' * indent}module #{namespace}"
+  indent += 1
+end
+
+output.push "#{'  ' * indent}VERSION = \'#{version}'"
+indent -= 1
+
+namespaces.each do
+  output.push "#{'  ' * indent}end"
+  indent -= 1
+end
+
+output.push('')
+
+printf "%-25<label>s : %<version>s\n", label: 'GEM VERSION', version: version
+File.open('lib/mindmeister_api/version.rb', 'w+') { |f| f.write(output.join("\n")) }

data/lib/mindmeister_api/mindmeister_map_parser.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module MindmeisterApi
+  # Parse a Mindmeister .mind formatted content
+  class MindmeisterMapParser
+    include KLog::Logging
+
+    attr_reader :input_mindmap
+    attr_reader :mindmap
+
+    # Create a parser for a mindmeister mindmap
+    #
+    # @param [Hash] input_mindmap Mindmeister formatted object
+    def initialize(input_mindmap)
+      @input_mindmap = input_mindmap
+    end
+
+    class << self
+      # Factory for creating a parser for an existing mindmap .json file
+      def json_file_parser(json_file)
+        raise MindmeisterApi::Error, "File not found: #{json_file}" unless File.exist?(json_file)
+
+        content = File.read(json_file)
+        json = JSON.parse(content)
+        new(json)
+      end
+    end
+
+    def valid?
+      return false if input_mindmap.nil? || input_mindmap == {}
+      return false unless input_mindmap['root'] && input_mindmap['root']['id']
+
+      true
+    end
+
+    def parse
+      @mindmap = parse_node(input_mindmap['root'], 1) if valid?
+
+      self
+    end
+
+    private
+
+    # rubocop:disable Metrics/AbcSize
+    def parse_node(input_node, level)
+      node = Node.new
+
+      node.level        = level
+
+      node.id           = input_node['id']                  # DONE:
+      node.title        = input_node['title']               # DONE:
+      node.rank         = input_node['rank']                # TODO: waiting for a value to reveal itself
+      node.pos          = input_node['pos']                 # TODO: waiting for a value to reveal itself
+      node.floating     = input_node['floating']            # TODO: waiting for a value to reveal itself
+      node.icon         = input_node['icon']                # TODO: waiting for a value to reveal itself
+      node.style        = input_node['style']               # TODO: waiting for a value to reveal itself
+      node.created_at   = input_node['created_at']          # TODO: Map to date time
+      node.updated_at   = input_node['updated_at']          # TODO: Map to date time
+      node.note         = input_node['note']                # TODO: waiting for a value to reveal itself
+      node.link         = input_node['link']                # TODO: waiting for a value to reveal itself
+      node.task         = input_node['task']                # TODO: Link to task
+      node.attachments  = input_node['attachments']         # TODO: Array
+      node.image        = input_node['image']               # TODO: ?
+      node.boundary     = input_node['boundary']            # TODO: ?
+      node.video        = input_node['video']               # TODO: ?
+
+      node.children     = input_node['children'].map { |child| parse_node(child, level + 1) } if input_node['children']
+
+      node
+    end
+    # rubocop:enable Metrics/AbcSize
+  end
+end

data/lib/mindmeister_api/models/node.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Mind map node
+module MindmeisterApi
+  class Node
+    attr_accessor :level
+
+    attr_accessor :id
+    attr_accessor :title
+    attr_accessor :rank
+    attr_accessor :pos
+    attr_accessor :floating
+    attr_accessor :icon
+    attr_accessor :style
+    attr_accessor :created_at
+    attr_accessor :updated_at
+    attr_accessor :note
+    attr_accessor :link
+    attr_accessor :task
+    attr_accessor :attachments
+    attr_accessor :image
+
+    attr_accessor :children
+    attr_accessor :boundary
+    attr_accessor :video
+  end
+end

data/lib/mindmeister_api/models/node_enumerator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module MindmeisterApi
+  # Enumerate through the mind map hierarchy to build a list of nodes
+  class NodeEnumerator
+    include KLog::Logging
+
+    attr_reader :list
+
+    def initialize(mindmap)
+      @list = []
+
+      add_node(mindmap)
+    end
+
+    private
+
+    def add_node(current_node)
+      node = current_node.clone
+      node.children = nil
+
+      @list << node
+
+      current_node.children.each do |child_node|
+        add_node(child_node)
+      end
+    end
+  end
+end

data/lib/mindmeister_api/printer/node_printer.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Print helpers for mind map node
+module MindmeisterApi
+  # Include the Printer namespace to have access to console printers
+  module Printer
+    include KLog::Logging
+
+    def print_mindmap(mindmap, take: nil)
+      list = NodeEnumerator.new(mindmap).list
+      list = list.take(take) if take
+
+      print_nodes_as_table(list)
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def print_nodes_as_table(nodes)
+      log.section_heading 'Mindmap'
+
+      tp nodes,
+         :id,
+         :level,
+         { title: { width: 50, display_method: ->(row) { "#{' ' * ((row.level - 1) * 2)}#{row.title.gsub("\r", ' ')}" } } },
+         :rank,
+         { pos: { display_method: ->(row) { row.pos.nil? ? '' : row.pos.reject(&:nil?).join(',').to_s } } },
+         :floating,
+         { icon: { display_method: ->(row) { row.icon.nil? ? '' : row.icon.reject(&:nil?).join(',').to_s } } }
+      #  :style,
+      #  :note,
+      #  { link: { width: 30 } },
+      #  :task,
+      #  :attachments,
+      #  :image,
+      #  :boundary,
+      #  :video
+    end
+    # rubocop:enable Metrics/AbcSize
+  end
+end

data/lib/mindmeister_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MindmeisterApi
+  VERSION = '0.0.15'
+end

data/lib/mindmeister_api/zip_helpers/zip_content_list.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module MindmeisterApi
+  # ZIP helper
+  class ZipContentList
+    attr_reader :list
+
+    def initialize
+      @list = []
+    end
+
+    def add(name, content)
+      @list << OpenStruct.new(name: name, content: content)
+    end
+
+    def find(name)
+      @list.find { |item| item.name == name }
+    end
+
+    def find_content(name)
+      item = find(name)
+
+      item.nil? ? nil : item.content
+    end
+  end
+end

data/lib/mindmeister_api/zip_helpers/zip_helper.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module MindmeisterApi
+  # ZIP helper
+  class ZipHelper
+    MAX_SIZE = 50 * (1024**2)
+
+    # Uncompress a ZIP archive that has come via string (used by HTTP request)
+    #
+    # @param [String] content ZIP File in string format
+    def uncompress_content(content)
+      content_list = MindmeisterApi::ZipContentList.new
+
+      Zip::InputStream.open(StringIO.new(content)) do |io|
+        while (entry = io.get_next_entry)
+          raise 'File too large when extracted' if entry.size > MAX_SIZE
+
+          content_list.add(entry.name, io.read)
+        end
+      end
+
+      content_list
+    end
+
+    # Uncompress a ZIP archive file
+    #
+    # @param [String] zip_file ZIP file name
+    def uncompress_file(zip_file)
+      content_list = MindmeisterApi::ZipContentList.new
+
+      Zip::File.open(zip_file) do |zip|
+        zip.each do |entry|
+          raise 'File too large when extracted' if entry.size > MAX_SIZE
+
+          content_list.add(entry.name, entry.get_input_stream.read)
+        end
+      end
+
+      content_list
+    end
+  end
+end

data/lib/mindmeister_api.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/http'
+require 'zip'
+require 'k_log'
+
+require_relative 'mindmeister_api/version'
+require_relative 'mindmeister_api/printer/node_printer'
+require_relative 'mindmeister_api/mindmeister_map_parser'
+require_relative 'mindmeister_api/models/node'
+require_relative 'mindmeister_api/models/node_enumerator'
+require_relative 'mindmeister_api/zip_helpers/zip_content_list'
+require_relative 'mindmeister_api/zip_helpers/zip_helper'
+
+# Mindmeister API
+module MindmeisterApi
+  # Mindmeister Errors
+  class Error < StandardError; end
+
+  # Static helpers
+  class << self
+    def zip
+      @zip ||= MindmeisterApi::ZipHelper.new
+    end
+  end
+end