slackup 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e065eb49b0187dd348830f1c73a3f0548e7a2906
-  data.tar.gz: ff1f53897bb4911be878785dbdc2d954abec5596
+  metadata.gz: 1a4dedeb8b780ba10d0d0b0aaec15408778b6ff7
+  data.tar.gz: 29cec35036d341b5e8a517cfcc478ca2d59faa92
 SHA512:
-  metadata.gz: 686a4114820035ef6a59ca866811ab93ce4f3ed72d1206f08c3c3213dd7c77d03e6b5d3175d39ddef57878729472443f93b4e405e94d372859955de56c03e939
-  data.tar.gz: 3e02401f1c62c5613d8faf0f9af2685a59f49d25b7be35f28bc89e3e351fcc45f97396182b829832f1339626820f84626b7e63905c3c753f54853e3c40b85ea1
+  metadata.gz: 678224011c1df666ba67826313c457fd471b2bdc4691fcc495984f8eea78990283adee62d881f1424beec509958169c4747b0bfbff429e88323d075900698b8d
+  data.tar.gz: f4ced7657011c11dd89310e719d8cd5c40773f846c0a0d969ce9689eb4228cdf4b226a380c5b8908f44fc4d1cad8a8694a4f9fb4da50e07d568d9be9a910f178

data/README.md

@@ -12,8 +12,14 @@ backup my slacks
 2. Configure a file in the backup directory called `slack_teams.yml`,
 though `slack_teams.yaml` and `slack_teams.json` will also work.
 
-The config file must contain a dictionary (hash) of 
-team names (backup directories) and associated tokens.
+The config file must contain an array (list) of team configurations,
+where each team config is a dictionary (hash) as below:
+
+| config | description |
+|--------|-------|
+| 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
 
 e.g.
 
@@ -21,24 +27,31 @@ slack_teams.yml
 
 ```yaml
 ---
-some-team: xxxp-some-token
-another-team: xxxp-different-token
+- name: some-team
+  token: xxxp-some-token
+- name: another-team
+  nickname: ateam
+  token: xxxp-different-token
 ```
 
 slack_teams.json
 
 ```json
-{
-  "some-team": "xxxp-some-token",
-  "another-team": "xxxp-different-token"
-}
+[
+  {
+    "name": "some-time",
+    "token": "xxxp-some-token"
+  },
+  {
+    "name": "another-team",
+    "nickname": "ateam",
+    "token": "xxxp-different-token"
+  }
+]
 ```
 
 3. Run `slackup` in your terminal
 
-Each key/value team pair will be run in a local directory named by the key
-using only the token for auth. Thus, the key (team) name can be whatever you want.
-
 ## Development
 
 This gem is does the bare basics of backup and works for me.

data/lib/slackup.rb

@@ -20,15 +20,15 @@ class Slackup
 
   SEMAPHORE = Mutex.new
 
-  def self.team_token_pairs_file
+  def self.team_config_file
     Pathname.glob(run_root.join("slack_teams.{json,yml,yaml}")).first
   end
 
-  def self.team_token_pairs
-    if team_token_pairs_file.readable?
-      YAML.load(team_token_pairs_file.read)
+  def self.team_config
+    if team_config_file.readable?
+      YAML.load(team_config_file.read)
     else
-      fail Error, "No team token pairs file found. See README for instructions."
+      fail Error, "No team config file found. See README for instructions."
     end
   end
 
@@ -43,9 +43,11 @@ class Slackup
     client
   end
 
-  def self.backup(team_token_pairs = team_token_pairs())
-    team_token_pairs.each do |name, token|
+  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
       end

data/lib/slackup/version.rb

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

metadata

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