slack_export 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: de3d078aca9ed5e72062c99b8ac19a96b558b5b3
+  data.tar.gz: 7dda1f57a02bf122ace9cf49c1fdd685113fdeed
+SHA512:
+  metadata.gz: 4f0d10460a96ad98bfa50caabe50b967c80700cb7f24dfa45acc57d048f766063ffe41c84d7496b1f24ecef5df31f283b768f8cfc0517679a409761c0de5a281
+  data.tar.gz: 02e8510665d65140155c7c311544a6f6537a058c70aff4b2d18f97cc0f316c2966a552faeb5222361e34b76e988d9db17d1f05e06ade00119e45abf027a57455

data/bin/slack_export

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "slack_export"
+
+options = {}
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: slack_export --key=your-slack-api-key --channel=private-channel-name --path=folder-to-create-export"
+
+  opts.on("-h", "--help", "Display this screen") do
+    puts opts
+    exit
+  end
+
+  opts.on("-k", "--key KEY", "Slack API Key (required)") do |key|
+    options[:key] = key
+  end
+
+  opts.on("-c", "--channel CHANNEL", "Private Channel name (required)") do |channel|
+    options[:channel] = channel
+  end
+
+  opts.on("-p", "--path PATH", "Local folder path to write export file (required)") do |path|
+    options[:path] = path
+  end
+end
+optparse.parse!
+
+[:key, :channel, :path].each do |arg|
+  unless options[arg]
+    puts optparse.help
+    exit -1
+  end
+end
+
+exporter = SlackExport::Exporter.new(options[:key], options[:channel], options[:path])
+exporter.logger = -> (message) { puts message }
+
+begin
+  exporter.export
+rescue => e
+  puts e.message
+  exit -1
+end

data/lib/slack_export/exporter.rb

@@ -0,0 +1,95 @@
+require "slack_export/slack_client"
+require "json"
+require "zip"
+
+module SlackExport
+  class Exporter
+
+    attr_reader :client, :channel, :base_path
+    attr_accessor :logger
+
+    def initialize(api_key, channel, base_path, logger=nil)
+      @client = SlackClient.new(api_key, channel)
+      @channel = channel
+      @base_path = base_path
+      self.logger = logger
+    end
+
+    def export(new_channel_name=nil)
+      raise StandardError("Directory #{base_path} does not exist") unless Dir.exist?(base_path)
+      log "Exporting #{channel} to folder #{base_path}"
+
+      # CHANNELS
+      channels = client.get_channels.select {|c| c["name"] == channel}
+      log "Exporting #{channels.count} channels"
+      File.open(channels_path, "w") {|f| f.write(channels.to_json)}
+
+      # MESSAGES
+      messages = client.get_messages
+      log "Exporting #{messages.count} messages"
+      Dir.mkdir(messages_base_path) unless Dir.exist?(messages_base_path)
+      File.open(messages_path, "w") do |file|
+        file.write(messages.to_json)
+      end
+
+      # USERS
+      users = client.get_users
+      log "Exporting #{users.count} users"
+      users = users.select do |u|
+        messages.any? {|m| m["user"] == u["id"]}
+      end
+      File.open(users_path, "w") {|f| f.write(users.to_json)}
+
+      # BUNDLE TO ZIP
+      log "Bundling export file to #{export_path}"
+      Zip::File.open(export_path, Zip::File::CREATE) do |zip|
+        zip.add(users_filename, users_path)
+        zip.add(channels_filename, channels_path)
+        zip.add(messages_sub_path, messages_path)
+      end
+    end
+
+    def export_path
+      File.join(base_path, "#{channel}.zip")
+    end
+
+    private
+
+    def users_filename
+      "users.json"
+    end
+
+    def users_path
+      File.join(base_path, users_filename)
+    end
+
+    def channels_filename
+      "channels.json"
+    end
+
+    def channels_path
+      File.join(base_path, channels_filename)
+    end
+
+    def messages_filename
+      "messages.json"
+    end
+
+    def messages_base_path
+      File.join(base_path, channel)
+    end
+
+    def messages_sub_path
+      File.join(channel, messages_filename)
+    end
+
+    def messages_path
+      File.join(base_path, messages_sub_path)
+    end
+
+    def log(message)
+      logger.call message if logger
+    end
+
+  end
+end

data/lib/slack_export/slack_client.rb

@@ -0,0 +1,59 @@
+require "rest-client"
+
+module SlackExport
+  class SlackClient
+
+    BASE_URL = "https://slack.com/api/"
+    LIST_USERS = "users.list"
+    LIST_CHANNELS = "groups.list"
+    LIST_MESSAGES = "groups.history"
+    CHANNEL_INFO = "groups.info"
+
+    attr_accessor :token, :channel
+
+    def initialize(api_key, channel_name)
+      self.token = api_key
+      self.channel = get_channel_id(channel_name)
+    end
+
+    def get_users
+      response = post_form(LIST_USERS)
+      response["members"]
+    end
+
+    def get_channels
+      response = post_form(LIST_CHANNELS)
+      response["groups"]
+    end
+
+    def get_messages()
+      responses = []
+      latest = latest.to_i #pages backward, so keep track of most recent message pulled
+      oldest = oldest.to_i
+      loop do
+        responses << post_form(LIST_MESSAGES, { channel: channel, latest: latest, oldest: oldest, count: 1000})
+        latest = responses.last["messages"].last["ts"]
+        break unless responses.last["has_more"]
+      end
+
+      responses.map {|r| r["messages"]}.flatten
+    end
+
+    private
+
+    def get_channel_id(channel_name)
+      get_channels.select {|g| g["name"] == channel_name}.first["id"]
+    end
+
+    def post_form(action, form_values={})
+      response = RestClient::Request.execute(
+        url: "#{BASE_URL}#{action}",
+        method: :post,
+        payload: form_values.merge(token: self.token)
+      )
+
+      JSON.parse(response)
+    end
+
+  end
+end

data/lib/slack_export/version.rb

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

data/lib/slack_export.rb

@@ -0,0 +1,6 @@
+module SlackExport
+end
+
+require "slack_export/version"
+require "slack_export/slack_client"
+require "slack_export/exporter"

data/spec/slack_export/slack_client_spec.rb

@@ -0,0 +1,9 @@
+require "slack_export/slack_client"
+
+module SlackExport
+  describe SlackClient do
+
+    subject { SlackClient.new() }
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,96 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: slack_export
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Tucker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+description: Export private Slack channels in the standard Slack export format
+email:
+- mtucker@godaddy.com
+executables:
+- slack_export
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/slack_export
+- lib/slack_export.rb
+- lib/slack_export/exporter.rb
+- lib/slack_export/slack_client.rb
+- lib/slack_export/version.rb
+- spec/slack_export/slack_client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mtuckergd/slack_export
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Export private Slack channels
+test_files:
+- spec/slack_export/slack_client_spec.rb
+- spec/spec_helper.rb