hipmost 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dad37853ecd2f590343ce5366c2f9c6560aa287ea6bd878c2eac1f51ce46d143
+  data.tar.gz: 47bd0029d1bf0a4ab79c1e57d098f0a394e1a2de5ddcf48727647764b03bf8d4
+SHA512:
+  metadata.gz: 0e00a51e7a1a45b5bf446c193bf86e36bef54f29562a796cec9e4981199c58839f2910fc26c2497ef142271522f0937c8a5270d227d6f13c54bc85037c637523
+  data.tar.gz: 8d57d5844c80d8bddabf359d2b617a6fc828f3bd370e98973299b3f13945dd5ed21f6eadcf3c1ff8beda8fcfd5a0f08348ef0aa0ff86081addecf2e7a7e9c7b6

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+data
+data.jsonl

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,8 @@
+# The Ruby Community Conduct Guideline
+
+This document provides community guidelines for a safe, respectful, productive, and collaborative place for any person who is willing to contribute to the Ruby community. It applies to all "collaborative space," which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.).
+
+- Participants will be tolerant of opposing views.
+- Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+- When interpreting the words and actions of others, participants should always assume good intentions.
+- Behaviour which can be reasonably considered harassment will not be tolerated.

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    hipmost (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.8.2)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-doc (0.12.0)
+      pry (~> 0.9)
+      yard (~> 0.9)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    slop (3.6.0)
+    yard (0.9.15)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  hipmost!
+  method_source (>= 0.8.2)
+  pry (~> 0.10.3)
+  pry-doc (>= 0.8.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.2

data/HOWTO.md

@@ -0,0 +1,55 @@
+# How to migrate from Hipchat to Mattermost with Hipmost
+
+Migrating from Hipchat to Mattermost is a bit of a process, but if you know what to do then it's fairly straightforward. We'll describe some steps of what to do in this document, taking from [Mattermost's own guidelines.](https://mattermost.com/atlassian/#hipchat-migration) *Credit goes to Mattermost for the content which they wrote.*
+
+## Step 1: Set up your Mattermost Instance
+
+1. Download the [latest version of Mattermost](https://about.mattermost.com/download/).
+2. [Deploy Mattermost](https://docs.mattermost.com/guides/administrator.html#installing-mattermost) in your environment using the configuration that meets your organization’s needs for performance and scalability.
+3. [Request a Trial](https://mattermost.com/trial) of Mattermost Enterprise for [advanced features](https://mattermost.com/pricing).
+
+Feel free to [submit an issue](https://github.com/orbitalimpact/hipmost/issues/new) or visit Mattermost's [troubleshooting forum](https://forum.mattermost.org/t/how-to-use-the-troubleshooting-forum/150) for help.
+
+## Step 2: Export your data from HipChat
+
+### Situation 1:
+
+If your Hipchat instance is hosted on hipchat.com (i.e., **not** self-hosted) then you need to request your data from Atlassian. Go to [this page,](https://support.atlassian.com/hipchat/) log in with your Hipchat account information, submit a ticket via the `Contact Support` button, and explain that you wish to obtain a copy of your team's data. After some days, they should give you an AES-encrypted tarball containing your data (the file will have the extension `.tar.gz.aes`). [Here is another document](https://confluence.atlassian.com/hipchatkb/unable-to-decrypt-file-while-importing-into-hipchat-server-756777042.html) explaining how to manually decrypt your tarball at the command line.
+
+### Situation 2:
+
+These are the steps to follow if you're using Hipchat Server or Hipchat Data Center, as given by Mattermost.
+
+(i.e., what to do if you **are** self-hosted)
+
+If you’re able to upgrade HipChat Server or HipChat Data Center to the latest version, we recommend using Group Export Dashboard to export your data. If you’re unable to upgrade, see Command Line Interface procedure below.
+
+*Using the Group Export Dashboard*:
+
+1. Log in to your Hipchat Server or HipChat Server instance (e.g., hipchat.yourcompany.com)
+2. Click on **Server Admin > Export**.
+3. Select the data to export.
+4. In the Password and Confirm Password fields, create a password to protect your archive files. (Store this password as it is not saved anywhere else.)
+5. Click Export. Once the export is done, you will receive an email with a link to download the file.
+
+*If you’re unable to use the Group Export Dashboard, use the Command Line Interface to export:*
+
+1. Go to CLI.
+2. Enter `hipchat export --export -p your_password`
+3. Once the export is done, you will receive an email with a link to download the file.
+
+*More detailed instructions can be found at https://confluence.atlassian.com/hipchatdc3/export-data-from-hipchat-data-center-913476832.html.*
+
+## Step 3: Use Hipmost to convert your data
+
+After you've received your data, decrypted it, and extracted it to a folder, you may then use `hipmost` to convert your data for importation into Mattermost. If you name your folder `data`, then you can simply use `hipmost rooms import "Example Room" "Mattermost Team":"Mattermost Channel"`. Of course, substitute whatever the actual name of your room, channel, and team is in their respective fields. Furthermore, you may use the `-p` option to set a different path to your data. More usage options [in the `Usage` section of README.md.](./README.md#usage)
+
+After you execute the `hipmost` command, you should have a file entitled `Room Name.jsonl` in the current directory which is ready to be imported into Mattermost.
+
+## Step 4: Import your data into Mattermost
+
+1. Follow the [Mattermost Bulk Load Tool](https://docs.mattermost.com/deployment/bulk-loading.html) guide to import your data into Mattermost.
+  a. Note: Efforts are underway to source scripts from the Mattermost community to further automate this step. If you’re interested in contributing, please contact Mattermost at [info@mattermost.com](info@mattermost.com), Twitter or Mattermost forums at https://forum.mattermost.org
+2. Alternatively, [contact Mattermost](https://mattermost.com/contact-us) for partner recommendations for your region to assist in your import.
+
+If you encounter any troubles along the way, please feel free to [submit an issue](https://github.com/orbitalimpact/hipmost/issues/new) and let us know what problem you're having.

data/KNOWN-BUGS.md

@@ -0,0 +1,36 @@
+# Known Bugs
+Unfortunately, there are a number of problems which exist that we are presently aware of. We have worked on this project in our spare time, in between work on actual projects. Since we worked on it for free and with our specific data in mind, we have accrued the following bugs and have been unable to devote the time and effort necessary to properly fix all of them (although, some of these bugs have workarounds). We would like to remedy this, yet we could certainly use help in the way of patches or donations. If this project has been helpful to your team or you'd like to improve it to help your team migrate, then please consider submitting patches or donating money so that we can devote more time to this project.
+
+Of course, please do not assume that this list encompasses *all* of the bugs which you may encounter.
+
+Items which are fairly easy to tackle and for which we would like help are marked with "**(help wanted)**"
+
+Without further ado:
+
+## General improvements
+
+- Verbose mode could be better (i.e., more verbose but not too verbose). **(help wanted)**
+- The CLI could perhaps become easier and more intuitive. **(help wanted)**
+- More thorough documentation is always a good thing. **(help wanted)**
+
+## What gets converted
+
+- Messages which are of the type `TopicRoomMessage`, `ArchiveRoomMessage`, `GuestAccessMessage` or `NotificationMessage` are skipped; only `UserMessage`'s and `PrivateUserMessage`'s are processed.
+- Certain Hipchat [slash commands](https://confluence.atlassian.com/hipchat/keyboard-shortcuts-and-slash-commands-749385232.html#Keyboardshortcutsandslashcommands-Slashcommands) are not translated into Mattermost messages because they do not have Mattermost equivalents. This includes: `/clear`, `/me`, `s/`, `#color-hex`. However, we do attempt to translate some slash commands since they have Mattermost equivalents; namely, the formatting slash commands: `/code` and `/quote`.
+- We do not currently handle any kind of conversion or importation of files uploaded to Hipchat. E.g., images, documents, media, etc. The reason being that our team relies on external file-hosting services to upload such files to. We found Hipchat's file-hosting to be flaky and not robust. **(help wanted)**
+- Some posts may contain old usernames, i.e., a username which someone used in Hipchat that is different than the new username they've chosen for Mattermost. Unfortunately, this cannot be caught by the validator. **(help wanted)**
+    - A workaround is to use `sed` or a text editor to find & replace the occurrences of the old username with the new one.
+
+## Potential errors
+
+- Sometimes [user objects](https://docs.mattermost.com/deployment/bulk-loading.html#user-object) don't get generated. We're not exactly sure why this happens; unfortunately, it causes the validator to get upset and say something like: `Error importing post. User with username "john_doe" could not be found., SqlUserStore.GetByUsername: We couldn't find an existing account matching your username for this team.` **(help wanted)**
+    - The current workaround is to manually [create the missing user(s)](https://docs.mattermost.com/administration/command-line-tools.html#mattermost-user-create) in the system by hand.
+- If a user object *is* generated, but a user's username is now different than what it used to be in Hipchat, Mattermost may complain about them having an insufficient password. E.g.: `User.IsValid: model.user.is_valid.pwd_lowercase_uppercase_number_symbol.app_error` **(help wanted)**
+    - A workaround is to remove that user object or to modify the user object to have the right username.
+
+## Questionable behavior
+
+- If a file is generated whose name conflicts with an already existing file, then the already existing file will be overwritten.
+    - This may be considered a feature, depending on your opinion and use case.
+
+If you feel like tackling any of these problems, please feel free to submit a pull request or file an issue for discussion. We welcome contributions and are happy to help.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Gabriel Rios
+
+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,63 @@
+# Hipmost
+
+[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=AYNCCNVFYPKXW)
+
+Hipmost is a tool to migrate your Hipchat history to Mattermost. It parses your Hipchat export and generates a file to be imported on a Mattermost server. After generating this file, please see [the Mattermost documentation](https://docs.mattermost.com/deployment/bulk-loading.html) for how to import it on your server.
+
+## Installation
+
+    $ gem install hipmost
+
+## Getting started
+
+See [HOWTO.md](./HOWTO.md) for a step-by-step guide for the entire process. It covers everything from how to get your data from Hipchat, and finally, how to get that data into Mattermost.
+
+## Usage
+
+    Usage: hipmost [options] [command]
+
+    Commands:
+
+    public (AKA: `room' or `rooms')
+    Form: public [import|list] [room names] - Import or list public Hipchat rooms
+
+    [room names] must be at least one pair composed by "Hipchat room name" and "Mattermost team":"Mattermost channel".
+    The Mattermost team or channel can be the part visible in the URL path, such as "town-square", or it can be the plain-English name, such as "General"
+
+    --------
+
+    private (AKA: `direct')
+    Form: private [import|list]  - Import or list private chats
+
+    --------
+
+    Examples:
+    $ hipmost room import "Orbital Impact" "Orbital Impact":"General"
+    $ hipmost public import "Orbital Impact" "Orbital Impact":"General" -p data_folder
+    $ hipmost private list
+    $ hipmost -v rooms import "Orbital Impact" "Orbital Impact":"General"
+
+    -p, --path [PATH]     Path to Hipchat data folder (Default: "./data")
+    -v, --[no-]verbose    Run verbosely
+
+## Known Bugs
+See the [KNOWN-BUGS.md](./KNOWN-BUGS.md) file for discussion of known problems, workarounds, and potential improvements. This is also a good place to start if you're interested in contributing.
+
+## Contributing
+
+Bug reports and pull requests are welcome. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Ruby code of conduct.](https://www.ruby-lang.org/en/conduct/)
+
+Also, [here is a great reference for Hipchat's data format](https://confluence.atlassian.com/hipchatkb/exporting-from-hipchat-server-or-data-center-for-data-portability-950821555.html) and [here is a great reference for how Mattermost's data format.](https://docs.mattermost.com/deployment/bulk-loading.html#data-format) These are highly useful for aspiring contributors.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License.](https://opensource.org/licenses/MIT)
+
+## Code of Conduct
+
+Everyone interacting in the Hipmost project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct.](./CODE_OF_CONDUCT.md)
+
+## Donation
+If this project has helped you or your team, a donation would be appreciated and will help keep the project alive :)
+
+[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=AYNCCNVFYPKXW)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hipmost"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

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

data/exe/hipmost

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+$LOAD_PATH << File.expand_path("../../lib", __FILE__)
+require "rubygems" if RUBY_VERSION < "1.9"
+
+
+require 'optparse'
+require "hipmost"
+
+options = { path: "./data" }
+OptionParser.new do |opts|
+  opts.banner = <<-BANNER
+    Usage: hipmost [options] [command]
+
+    Commands:
+
+    public (AKA, room or rooms)
+    Form: public [import|list] [rooms] - Import or list public Hipchat rooms
+
+    [rooms] must be at least one pair composed by "Hipchat channel name" and "Mattermost team":"Mattermost channel"
+    The Mattermost team or channel can be the URL endpoint, such as "town-square", or the channel name, such as "General"
+
+    --------
+
+    private (AKA, direct)
+    Form: private [import|list]  - Import or list private chats
+
+    --------
+
+    Examples:
+    $ hipmost room import "Orbital Impact" "Orbital Impact":"General"
+    $ hipmost public import "Orbital Impact" "Orbital Impact":"General" -p data_folder
+    $ hipmost private list
+    $ hipmost -v rooms import "Orbital Impact" "Orbital Impact":"General"
+
+  BANNER
+
+  opts.on("-p", "--path [PATH]", 'Path to Hipchat data folder (Default: "./data")') do |p|
+    options[:path] = p
+  end
+
+  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+    options[:verbose] = true
+  end
+end.parse!
+
+command = ARGV.shift
+
+exit Hipmost::CLI.run(command, ARGV, options)

data/hipmost.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hipmost/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hipmost"
+  spec.version       = Hipmost::VERSION
+  spec.authors       = ["Gabriel Rios"]
+  spec.email         = ["gabrielfalcaorios@gmail.com"]
+
+  spec.summary       = %q{Migrate your hipchat history to Mattermost}
+  spec.description   = %q{Migrate your hipchat history to Mattermost}
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10.3"
+  spec.add_development_dependency "pry-doc", ">= 0.8.0"
+  spec.add_development_dependency "method_source", ">= 0.8.2"
+end

data/lib/hipmost.rb

@@ -0,0 +1,21 @@
+require 'pathname'
+require "hipmost/version"
+require "hipmost/hipchat"
+require "hipmost/mattermost"
+require "hipmost/cmds"
+
+module Hipmost
+  class CLI
+    def self.run(command, args, options)
+      case command.to_sym
+      when :public, :room, :rooms
+        Hipmost::Cmds::Room.new(**options).run(args)
+      when :private, :direct
+        Hipmost::Cmds::Private.new(**options).run(args)
+      else
+        puts "Invalid command"
+        exit 1
+      end
+    end
+  end
+end

data/lib/hipmost/cmds.rb

@@ -0,0 +1,6 @@
+module Hipmost
+  module Cmds
+    require_relative 'cmds/room'
+    require_relative 'cmds/private'
+  end
+end

data/lib/hipmost/cmds/private.rb

@@ -0,0 +1,55 @@
+module Hipmost
+  module Cmds
+    class Private
+      def initialize(path:, verbose: false)
+        $path    = Pathname.new(path).expand_path
+        @outpath = $path.join("..", "Private Chats.jsonl").expand_path
+        @verbose = verbose
+      end
+
+      def run(args)
+        subcommand = args.shift
+
+        if ["list", "import"].include?(subcommand)
+        else
+          puts "Command invalid for `private`, must be `import` or `list`"
+          exit 1
+        end
+
+        send(subcommand, args)
+      end
+
+      def list(_args)
+        puts "Listing Private chats" if @verbose
+        Hipchat.direct_channels.each do |members|
+          puts members.inspect
+        end
+
+        true
+      end
+
+      def import(args)
+        File.open(@outpath, "w") do |jsonl|
+          puts "Writing version header..." if @verbose
+          jsonl.puts %[{ "type": "version", "version": 1 }]
+
+          puts "Writing room members..." if @verbose
+          Hipchat.users.each do |_,user|
+            jsonl.puts(user.to_jsonl)
+          end
+
+          puts "Writing 1-on-1 room members..." if @verbose
+          Hipchat.direct_channels.each do |members|
+            puts members.inspect if @verbose
+            jsonl.puts(%[{ "type": "direct_channel", "direct_channel": { "members": #{members.inspect} }}])
+          end
+
+          puts "Writing 1-on-1 room posts (oldest to newest)..." if @verbose
+          Hipchat.direct_posts(jsonl, @verbose)
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/hipmost/cmds/room.rb

@@ -0,0 +1,126 @@
+module Hipmost
+  module Cmds
+    class Room
+      def initialize(path:, verbose: false)
+        $path    = Pathname.new(path).expand_path
+        @verbose = verbose
+      end
+
+      def run(args)
+        subcommand = args.shift
+        @outpath = $path.join("..", "#{args[0]}.jsonl").expand_path
+
+        if ["list", "import"].include?(subcommand)
+        else
+          puts "Command invalid for `public`; must be `import` or `list`"
+          exit 1
+        end
+
+        send(subcommand, args)
+      end
+
+      def list(_args)
+        puts "Listing rooms..." if @verbose
+        Hipchat.rooms.each do |_,room|
+          puts room.display_name
+        end
+
+        true
+      end
+
+      def import(args)
+        rooms      = args
+        rooms_size = rooms.size
+
+        if rooms_size.zero? || (rooms_size % 2).nonzero?
+          puts "Need a pair of rooms to migrate"
+          exit 1
+        end
+
+        @data = rooms
+
+        parse_rooms_arg
+        save
+        true
+      end
+
+      def save
+        puts "Opening #{@outpath} for writing..." if @verbose
+
+        File.open(@outpath, "w") do |jsonl|
+          puts "Writing version header..." if @verbose
+          jsonl.puts %[{ "type": "version", "version": 1 }]
+
+          puts "Writing team info..." if @verbose
+          @teams.each {|t| jsonl.puts(t.to_jsonl) }
+          puts "Writing channel info..." if @verbose
+          @channels.each {|r| jsonl.puts(r.to_jsonl) }
+
+          puts "Writing room members..." if @verbose
+          @rooms.each do |room|
+            room.users.each do |user|
+              jsonl.puts(user.to_jsonl)
+            end
+          end
+
+          puts "Writing room posts (newest to oldest)..." if @verbose
+          i = 1 if @verbose
+          j = 1 if @verbose
+
+          @rooms.each do |room|
+            if @verbose
+              puts "On room #{i}"
+              i += 1
+            end
+
+            Hipchat::PostRepository.new(room).tap(&:load).each do |post|
+              if @verbose
+                print "On post #{j}\r"
+                j += 1
+              end
+
+              jsonl.puts(post.to_jsonl)
+            end
+
+            if @verbose
+              print "\n"
+              puts "Successfully wrote public room data\n\n"
+            end
+          end
+        end
+      end
+
+      def parse_rooms_arg
+        @rooms    = []
+        @channels = []
+        @teams    = []
+
+        @data.each_slice(2).each do |hipchat_room, mattermost_room|
+          if @verbose
+            puts "Parsing rooms for Hipchat and Mattermost..."
+            puts "Hipchat room is:               #{hipchat_room}"
+            puts "Mattermost team & channel are: #{mattermost_room}"
+          end
+
+          team, channel_name = mattermost_room.split(":")
+          team               = Mattermost::Team.new(team)
+          room               = Hipchat.rooms.find_by_name(hipchat_room)
+          channel            = Mattermost::Channel.from_hipchat(room, name: channel_name, team: team)
+
+          room.team    = team
+          room.channel = channel
+
+          @rooms    << room
+          @teams    << team
+          @channels << channel
+
+          puts "Successfully parsed rooms\n\n" if @verbose
+        end
+
+        @teams.uniq!
+        @rooms.uniq!
+        @channels.uniq!
+      end
+    end
+  end
+end

data/lib/hipmost/hipchat.rb

@@ -0,0 +1,68 @@
+require 'json'
+require 'date'
+
+require_relative "hipchat/user_repository"
+require_relative "hipchat/room_repository"
+require_relative "hipchat/post_repository"
+require_relative "hipchat/conversion"
+
+module Hipmost
+  module Hipchat
+    class << self
+      def users
+        @users ||= UserRepository.load_from($path)
+      end
+
+      def rooms
+        @rooms ||= RoomRepository.new($path).tap(&:load)
+      end
+
+      def direct_channels
+        Dir[$path.join("users", "**", "*.json")].flat_map do |file_path|
+          json = JSON.parse(File.read(file_path))
+          json.map do |message|
+            msg      = message["PrivateUserMessage"]
+            sender   = users[msg["sender"]["id"]]
+            receiver = users[msg["receiver"]["id"]]
+            [sender.username, receiver.username].sort
+          end
+        end.uniq
+      end
+
+      def direct_posts(file, verbose)
+        i = 1 if verbose
+
+        Dir[$path.join("users", "**", "*.json")].each do |file_path|
+          puts "Opening 1-on-1 room at #{file_path}..." if verbose
+          json = JSON.parse(File.read(file_path))
+          puts "Successfully parsed file at #{file_path}" if verbose
+
+          puts "Examining messages in this file..." if verbose
+
+          json.each do |message|
+            if verbose
+              print "On post #{i}\r"
+              i += 1
+            end
+
+            msg       = message["PrivateUserMessage"]
+            sender    = users[msg["sender"]["id"]]
+            receiver  = users[msg["receiver"]["id"]]
+            message   = msg["message"]
+            create_at = DateTime.strptime(msg["timestamp"]).to_time.to_i*1000
+
+            members = [ sender.username, receiver.username ] .sort
+
+            Conversion.convert_formatting_to_markdown(message)
+            file.puts(%[{ "type": "direct_post", "direct_post": { "channel_members": #{members.inspect}, "user": "#{sender.username}", "message": "#{message}", "create_at": #{create_at} } }])
+          end
+
+          if verbose
+            print "\n"
+            puts "Successfully wrote data for that 1-on-1 room\n\n"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hipmost/hipchat/conversion.rb

@@ -0,0 +1,26 @@
+# Misc utilties to do data conversion from Hipchat to Mattermost
+
+module Hipmost
+  module Conversion
+    def self.convert_formatting_to_markdown(message)
+      # According to Hipchat's docs, the only formatting commands which are
+      # translatable to Mattermost are /code and /quote.
+      # Relevant docs: https://confluence.atlassian.com/hipchat/keyboard-shortcuts-and-slash-commands-749385232.html#Keyboardshortcutsandslashcommands-Slashcommands
+
+      if message
+        if message.start_with?("/code") && message.lines.count > 1
+          message.sub!("/code", "```\n")
+          message << "\n```"
+        elsif message.start_with?("/code") && message.lines.count == 1
+          message.sub!("/code", "`")
+          message << "`"
+        end
+
+        if message.start_with?("/quote")
+          message.sub!("/quote", ">")
+          message.gsub!(/\n\n(.)/, "\n\n> \\1")
+        end
+      end
+    end
+  end
+end

data/lib/hipmost/hipchat/post.rb

@@ -0,0 +1,36 @@
+require 'date'
+
+require_relative "conversion"
+
+module Hipmost
+  module Hipchat
+    class Post
+      def initialize(attrs, room, is_private_room)
+        @private    = is_private_room
+        @attrs      = attrs
+        @sender     = Hipchat.users[attrs["sender"]["id"]]
+        @message    = attrs["message"]
+        @created_at = DateTime.strptime(attrs["timestamp"])
+        @team       = room.team
+        @channel    = room.channel
+        if is_private_room
+          @receiver = Hipchat.users[attrs["sender"]["id"]]
+        end
+      end
+      attr_reader :team, :channel, :sender
+
+      def to_jsonl
+        # First, convert Hipchat formatting to markdown...
+        Conversion.convert_formatting_to_markdown(@message)
+
+        # Then, generate the actual object based on whether the room is private or not.
+        if @private
+          members = [@sender.username, @receiver.username].sort
+          %[{ "type": "direct_post", "direct_post": { "channel_members": #{members.inspect}, "user": "#{@sender.username}", "message": "#{JSON.dump(@message)}", "create_at": #{@created_at.to_time.to_i*1000} } }]
+        else
+          %[{ "type": "post", "post": { "team": "#{team.name}", "channel": "#{channel.name}", "user": "#{sender.username}", "message": #{JSON.dump(@message)}, "create_at": #{@created_at.to_time.to_i*1000} } }]
+        end
+      end
+    end
+  end
+end

data/lib/hipmost/hipchat/post_repository.rb

@@ -0,0 +1,43 @@
+require 'json'
+require 'forwardable'
+require_relative 'post'
+
+module Hipmost
+  module Hipchat
+    class PostRepository
+      attr_accessor :posts, :name_index
+      extend Forwardable
+
+      def_delegators :@posts, :size, :[], :select, :each
+
+      def self.for_room(room)
+        new(room).tap(&:load)
+      end
+
+      def initialize(room)
+        @room  = room
+        @path  = $path.join("rooms", room.id.to_s, "history.json")
+        @posts = []
+      end
+
+      def load(data = file_data)
+        return if !File.exists?(@path)
+        json = JSON.load(data)
+
+        json.each do |post_obj|
+          next if post_obj.key?("NotificationMessage")
+          next if post_obj.key?("GuestAccessMessage")
+          next if post_obj.key?("ArchiveRoomMessage")
+          next if post_obj.key?("TopicRoomMessage")          
+          post = post_obj["UserMessage"]
+          @posts << Post.new(post, @room)
+        end
+      end
+
+      def file_data
+        return if !File.exists?(@path)
+        File.read(@path)
+      end
+    end
+  end
+end

data/lib/hipmost/hipchat/room.rb

@@ -0,0 +1,57 @@
+
+=begin
+  {
+    "Room": {
+      "created": "2013-05-27T13:29:02+00:00",
+      "guest_access_url": null,
+      "id": 206455,
+      "is_archived": false,
+      "members": [
+        752160,
+        1002528,
+        844771,
+        340070,
+        1017103,
+        340825
+      ],
+      "name": "Orbital Impact",
+      "owner": 340070,
+      "participants": [],
+      "privacy": "private",
+      "topic": "Welcome! Send this link to coworkers who need accounts: https://www.hipchat.com/invite/50371/3c380f069e21ba92e3441c57952e4ed0"
+    }
+  },
+=end
+
+module Hipmost
+  module Hipchat
+    class Room
+      def initialize(attrs)
+        @id           = attrs["id"]
+        @name         = attrs["name"].gsub(/\s/, "-").downcase
+        @display_name = attrs["name"]
+        @topic        = attrs["topic"]
+        @attrs        = attrs
+      end
+      attr_reader :id, :attrs, :name, :display_name, :topic
+      attr_accessor :team, :channel
+
+      def private?
+        privacy == "private"
+      end
+
+      def users
+        @users ||= attrs["members"].map{|uid| Hipchat.users[uid] }
+      end
+
+      def posts
+        @posts ||= PostRepository.for_room(self)
+      end
+
+      def method_missing(method)
+        attrs[method.to_s]
+      end
+
+    end
+  end
+end

data/lib/hipmost/hipchat/room_repository.rb

@@ -0,0 +1,46 @@
+require 'json'
+require 'forwardable'
+require_relative "room"
+
+module Hipmost
+  module Hipchat
+    class RoomRepository
+      attr_accessor :rooms, :name_index
+      extend Forwardable
+
+      def_delegators :@rooms, :size, :[], :select, :each
+
+      def self.load_from(path)
+        new(path).tap(&:load)
+      end
+
+      def initialize(path)
+        @path  = Pathname.new(path).join("rooms.json")
+        @rooms = {}
+        @name_index = {}
+      end
+
+      def load(data = file_data)
+        json = JSON.load(data)
+
+        json.each do |room_obj|
+          room = room_obj["Room"]
+          @rooms[room["id"]] = Room.new(room)
+          @name_index[room["name"]] = room["id"]
+        end
+      end
+
+      def find_by_name(name)
+        self[name_index[name]]
+      end
+
+      def file_data
+        if File.exists? @path
+          File.read(@path)
+        else
+          abort "./data does not exist; did you forget to specify a path to the data?"
+        end
+      end
+    end
+  end
+end

data/lib/hipmost/hipchat/user_repository.rb

@@ -0,0 +1,74 @@
+require 'json'
+require 'forwardable'
+
+module Hipmost
+  module Hipchat
+    class UserRepository
+      attr_accessor :users
+      extend Forwardable
+
+      def_delegators :@users, :size, :[], :select, :each
+
+      def self.load_from(path)
+        new(path).tap(&:load)
+      end
+
+      def initialize(path)
+        @path  = Pathname.new(path).join("users.json")
+        @users = {}
+        @name_index = {}
+      end
+
+      def load(data = file_data)
+        json = JSON.load(data)
+
+        json.each do |user_obj|
+          user                           = user_obj["User"]
+          user_obj                       = User.new(user)
+          @users[user["id"]]             = user_obj
+          @name_index[user_obj.username] = user["id"]
+        end
+      end
+
+      def file_data
+        File.read(@path)
+      end
+
+      class User
+        def initialize(attrs)
+          @id    = attrs["id"]
+          @attrs = attrs
+        end
+        attr_reader :id, :attrs
+
+        def guest?
+          attrs["account_type"] == "guest"
+        end
+
+        def inactive?
+          attrs["is_deleted"]
+        end
+
+        def method_missing(method)
+          attrs[method.to_s]
+        end
+
+        def username
+          attrs["mention_name"]
+        end
+
+        def email
+          attrs["email"] || "#{username}@orbitalimpact.com"
+        end
+
+        def teams
+          []
+        end
+
+        def to_jsonl
+          %[{ "type": "user", "user": { "username": "#{username}", "email": "#{email}", "teams": #{teams.inspect} } }]
+        end
+      end
+    end
+  end
+end

data/lib/hipmost/mattermost.rb

@@ -0,0 +1,7 @@
+require_relative "mattermost/team"
+require_relative "mattermost/channel"
+
+module Hipmost
+  module Mattermost
+  end
+end

data/lib/hipmost/mattermost/channel.rb

@@ -0,0 +1,26 @@
+module Hipmost
+  module Mattermost
+    class Channel
+      def self.from_hipchat(room, name:, team: )
+        new(name:          name,
+            type:          room.private? ? "P" : "O",
+            display_name:  room.display_name,
+            header:        room.topic,
+            team:          team)
+      end
+
+      def initialize(name:, team:, display_name:, type:, header:)
+        @name         = name.downcase.gsub(/\s/, "-")
+        @team         = team
+        @display_name = display_name
+        @type         = type
+        @header       = header
+      end
+      attr_reader :name
+
+      def to_jsonl
+        %[{ "type": "channel", "channel": { "team": "#{@team.name}", "name": "#@name", "display_name": "#@display_name", "type": "#@type", "header": "#@header" } }]
+      end
+    end
+  end
+end

data/lib/hipmost/mattermost/team.rb

@@ -0,0 +1,22 @@
+module Hipmost
+  module Mattermost
+    class Team
+      def initialize(display_name)
+        @display_name = display_name
+      end
+      attr_reader :display_name
+
+      def to_jsonl
+        %[{ "type": "team", "team": { "display_name": "#@display_name", "name": "#{name}", "type": "I", "description": "#@display_name", "allow_open_invite": false } }]
+      end
+
+      def name
+        if display_name == "Orbital Impact"
+          "oi"
+        else
+          @display_name.gsub(/\s/, "-").downcase
+        end
+      end
+    end
+  end
+end

data/lib/hipmost/room.rb

@@ -0,0 +1,4 @@
+module Hipmost
+  class RoomImporter
+  end
+end

data/lib/hipmost/version.rb

@@ -0,0 +1,3 @@
+module Hipmost
+  VERSION = "1.0"
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: hipmost
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Gabriel Rios
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+description: Migrate your hipchat history to Mattermost
+email:
+- gabrielfalcaorios@gmail.com
+executables:
+- hipmost
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- HOWTO.md
+- KNOWN-BUGS.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/hipmost
+- hipmost.gemspec
+- lib/hipmost.rb
+- lib/hipmost/cmds.rb
+- lib/hipmost/cmds/private.rb
+- lib/hipmost/cmds/room.rb
+- lib/hipmost/hipchat.rb
+- lib/hipmost/hipchat/conversion.rb
+- lib/hipmost/hipchat/post.rb
+- lib/hipmost/hipchat/post_repository.rb
+- lib/hipmost/hipchat/room.rb
+- lib/hipmost/hipchat/room_repository.rb
+- lib/hipmost/hipchat/user_repository.rb
+- lib/hipmost/mattermost.rb
+- lib/hipmost/mattermost/channel.rb
+- lib/hipmost/mattermost/team.rb
+- lib/hipmost/room.rb
+- lib/hipmost/version.rb
+homepage: 
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Migrate your hipchat history to Mattermost
+test_files: []