slackup 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a4dedeb8b780ba10d0d0b0aaec15408778b6ff7
-  data.tar.gz: 29cec35036d341b5e8a517cfcc478ca2d59faa92
+  metadata.gz: b2a6ccd804fcb8f4b965e9a95e71fc893d3eb263
+  data.tar.gz: be9b759ec58de1e56ed08722e9cbfbb963a0e658
 SHA512:
-  metadata.gz: 678224011c1df666ba67826313c457fd471b2bdc4691fcc495984f8eea78990283adee62d881f1424beec509958169c4747b0bfbff429e88323d075900698b8d
-  data.tar.gz: f4ced7657011c11dd89310e719d8cd5c40773f846c0a0d969ce9689eb4228cdf4b226a380c5b8908f44fc4d1cad8a8694a4f9fb4da50e07d568d9be9a910f178
+  metadata.gz: 8286cfb800e9349830e4ebd2b219c521997707cfd7e7e0dbbb10e251e170e56348d0ffc882514e8608206840e0e0390d2875769a52f20a516a76456e10c69d11
+  data.tar.gz: 36307a23aff28e4927e5b74e507c0940685e557d41051766842246bd776411ac86a62761eb6d7fc0b2974227cfffb96f94fb4ce69ded2cc59b84d44c7d9dbf61

data/README.md

@@ -20,6 +20,11 @@ where each team config is a dictionary (hash) as below:
 | name (required) | the team name. e.g. `some-team` in `some-team.slackup.com`. Is used as backup directory name for the team.
 | nickname (optional) | a nickname. When present, overrides `name` as the backup directory name for the team.
 | token (required) | https://api.slack.com/custom-integrations/legacy-tokens
+| channels (optional) | array of whitelisted channels to include. Default is to include all
+| groups (optional) | array of whitelisted groups to include. Default is to include all
+| users (optional) | boolean whether to write out users
+| stars (optional) | boolean whether to write out stars
+| ims (optional) | boolean whether to write out ims
 
 e.g.
 
@@ -32,6 +37,14 @@ slack_teams.yml
 - name: another-team
   nickname: ateam
   token: xxxp-different-token
+  channels:
+    - general
+    # - random
+  groups:
+    - core-maintainers
+  users: true
+  stars: false
+  ims: true
 ```
 
 slack_teams.json

data/lib/slackup.rb

@@ -46,10 +46,7 @@ class Slackup
   def self.backup(team_config = team_config())
     team_config.each do |config|
       fork do
-        name = config.fetch("nickname") { config.fetch("name") }
-        token = config.fetch("token")
-        client = configure_client(token)
-        new(name, client).execute
+        new(config).execute
       end
     end
     p Process.waitall
@@ -57,9 +54,10 @@ class Slackup
 
   attr_reader :name, :client
   alias dirname name
-  def initialize(name, client)
-    @name = name
-    @client = client
+  def initialize(config, client=nil)
+    @config = config
+    @name = config.fetch("nickname") { config.fetch("name") }
+    @client = client || configure_client
     FileUtils.mkdir_p(name)
   end
 
@@ -69,14 +67,23 @@ class Slackup
 
   def write!
     Dir.chdir(dirname) do
-      Channels.new(name, client).write!
-      Groups.new(name, client).write!
-      Stars.new(name, client).write!
+      Channels.new(config, client).write!
+      Groups.new(config, client).write!
+      Stars.new(config, client).write!
       user_client.write!
-      Ims.new(name, client).write!
+      Ims.new(config, client).write!
     end
   end
 
+  def configure_client
+    token = config.fetch("token")
+    self.class.configure_client(token)
+  end
+
+  protected
+
+  attr_reader :config
+
   private
 
   def authorize!
@@ -122,7 +129,7 @@ class Slackup
   end
 
   def user_client
-    @user_client ||= Users.new(name, client)
+    @user_client ||= Users.new(config, client)
   end
 
   def users

data/lib/slackup/channels.rb

@@ -5,8 +5,28 @@ class Slackup::Channels < Slackup
   end
   alias channels list
 
+  def configured_channels
+    @configured_channels ||= config.fetch("channels", [])
+  end
+
+  def write_channel?(channel)
+    whitelisted_channel = channel["name"] if configured_channels.empty?
+    whitelisted_channel ||= configured_channels.find do |channel_name|
+      channel["name_normalized"] == channel_name or
+        channel["name"] == channel_name
+    end
+    if whitelisted_channel
+      p [name, :channels, "Writing #{whitelisted_channel}"]
+      true
+    else
+      p [name, :channels, "Skipping #{channel["name"]}"]
+      false
+    end
+  end
+
   def write!
     channels.each do |channel|
+      next unless write_channel?(channel)
       write_messages(channel)
     end
   end

data/lib/slackup/groups.rb

@@ -30,9 +30,28 @@ class Slackup::Groups < Slackup
   end
   alias groups list
 
+  def configured_groups
+    @configured_groups ||= config.fetch("groups", [])
+  end
+
+  def write_group?(group)
+    whitelisted_group = group["name"] if configured_groups.empty?
+    whitelisted_group ||= @configured_groups.find do |group_name|
+      group["name"] == group_name
+    end
+    if whitelisted_group
+      p [name, :groups, "Writing #{whitelisted_group}"]
+      true
+    else
+      p [name, :groups, "Skipping #{group["name"]}"]
+      false
+    end
+  end
+
   def write!
     Dir.chdir(groups_dir) do
       groups.each do |group|
+        next unless write_group?(group)
         write_messages(group)
       end
     end

data/lib/slackup/ims.rb

@@ -17,9 +17,21 @@ class Slackup::Ims < Slackup
   end
   alias ims list
 
+  def write_ims?
+    if config.fetch("ims", true)
+      p [name, :ims, "Writing"]
+      true
+    else
+      p [name, :ims, "Skipping"]
+      false
+    end
+  end
+
   def write!
+    return unless write_ims?
     Dir.chdir(ims_dir) do
       ims.each do |im|
+        # p [:ims, im.user, format_username(im.user)]
         write_messages(im)
       end
     end

data/lib/slackup/stars.rb

@@ -5,7 +5,18 @@ class Slackup::Stars < Slackup
   end
   alias stars list
 
+  def write_stars?
+    if config.fetch("stars", true)
+      p [name, :stars, "Writing"]
+      true
+    else
+      p [name, :stars, "Skipping"]
+      false
+    end
+  end
+
   def write!
+    return unless write_stars?
     with_messages "stars", list do |messages|
       File.open(backup_filename("stars"), "w")  do |f|
         f.write(serialize(messages))

data/lib/slackup/users.rb

@@ -53,7 +53,18 @@ class Slackup::Users < Slackup
   end
   alias users list
 
+  def write_users?
+    if config.fetch("users", true)
+      p [name, :users, "Writing"]
+      true
+    else
+      p [name, :users, "Skipping"]
+      false
+    end
+  end
+
   def write!
+    return unless write_users?
     File.open(backup_filename("users"), "w")  do |f|
       f.write(serialize(users.map(&:to_hash)))
     end

data/lib/slackup/version.rb

@@ -1,3 +1,3 @@
 class Slackup
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slackup
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Benjamin Fleischer