slack_profile 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cb76f24d5ce044a37f9d998cec1379a893a56284485e49880f46f20a49f08894
+  data.tar.gz: fbb1ae6983d9e4c0711a4b4f83353d9bab6715e327926efa8fdd289813e266eb
+SHA512:
+  metadata.gz: 65371e0b40dfdb651771d3b90b8f38b7769f12af007a54536f57345fbd945c1ff3684e0e261dbcc1ba508ed6cdf51c436051cfdb6cc7db7e3ae826d25770bcad
+  data.tar.gz: 65c0849528d6a15378fac996f6aca89fcaa333c60936406c1fff2bae75cfcbd2bb8d7ebe141db56341f54a97e3d7b2350f29a578866f1944894f91b45573e244

data/README.md

@@ -0,0 +1,100 @@
+# Slack Profile CLI (Ruby)
+
+Ruby gem implementation of the Slack Profile CLI tool.
+
+## Installation
+
+### Via RubyGems
+
+```bash
+gem install slack_profile
+```
+
+### From Source
+
+```bash
+cd ruby
+bundle install
+rake install
+```
+
+## Setup
+
+Configure your Slack token (choose one method):
+
+**Option 1: Environment variable (recommended)**
+```bash
+export SLACK_TOKEN=xoxp-your-token-here
+```
+
+**Option 2: .env file**
+```bash
+cp .env.example .env
+# Edit .env and add your token
+```
+
+**Option 3: Command line flag**
+```bash
+slack-profile --token xoxp-your-token-here <command>
+```
+
+## Usage
+
+### Interactive Mode
+
+```bash
+slack-profile
+# or
+slack-profile interactive
+```
+
+### CLI Commands
+
+```bash
+# Show version
+slack-profile version
+
+# List available fields
+slack-profile list-fields
+
+# Set a single field
+slack-profile set-field -u U1234567890 -n title -v "Engineer"
+
+# Set multiple fields
+slack-profile set-profile -u U1234567890 -p '{"title":"CTO","phone":"555-1234"}'
+
+# Batch update
+slack-profile batch-field -u U123,U456,U789 -n title -v "Engineer"
+```
+
+## Development
+
+```bash
+# Install dependencies
+bundle install
+
+# Run tests (when available)
+rake spec
+
+# Build the gem
+gem build slack_profile.gemspec
+
+# Install locally
+gem install ./slack_profile-1.0.0.gem
+```
+
+## Publishing to RubyGems
+
+```bash
+# Build the gem
+gem build slack_profile.gemspec
+
+# Push to RubyGems
+gem push slack_profile-1.0.0.gem
+
+# Create GitHub release for Homebrew
+git tag v1.0.0
+git push origin v1.0.0
+```
+
+See the main [README](../README.md) for full documentation.

data/bin/slack-profile

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/slack_profile"
+
+SlackProfile::CLI.start(ARGV)

data/lib/slack_profile/cli.rb

@@ -0,0 +1,318 @@
+require "thor"
+require "tty-prompt"
+
+module SlackProfile
+  class CLI < Thor
+    class_option :token, type: :string, aliases: "-t", desc: "Slack API token (overrides SLACK_TOKEN env var)"
+
+    def self.exit_on_failure?
+      true
+    end
+
+    desc "interactive", "Interactive mode - prompts for all inputs"
+    def interactive
+      client = get_client
+      prompt = TTY::Prompt.new
+
+      # Fetch custom fields on startup
+      custom_fields = {}
+      begin
+        puts "🔄 Fetching available fields...\n\n"
+        custom_fields = client.get_team_profile
+      rescue => e
+        puts "⚠️  Could not fetch custom fields: #{e.message}\n\n"
+      end
+
+      loop do
+        puts "🚀 Slack Profile CLI - Interactive Mode\n\n"
+
+        action = prompt.select("What would you like to do?", filter: true, per_page: 10) do |menu|
+          menu.choice "Get user profile", :get
+          menu.choice "Set a single field for one user", :single
+          menu.choice "Set a single field for multiple users", :batch_single
+          menu.choice "Set multiple fields for one user", :multiple
+          menu.choice "Set multiple fields for multiple users", :batch_multiple
+          menu.choice "List available fields", :list
+          menu.choice "Exit", :exit
+        end
+
+        break if action == :exit
+
+        case action
+        when :get
+          user_id = prompt.ask("Enter the Slack user ID:") do |q|
+            q.validate(/^U\w+/, "User ID should start with 'U'")
+            q.required true
+          end
+
+          profile = client.get_profile(user_id)
+          puts "\n📋 Profile for user #{user_id}:"
+          puts JSON.pretty_generate(profile)
+          puts ""
+
+        when :list
+          puts "\n📋 Available profile fields:"
+          puts "\nStandard fields:"
+          standard_fields.each { |field| puts "  • #{field}" }
+
+          if custom_fields.any?
+            puts "\nCustom fields:"
+            custom_fields.each do |id, field|
+              puts "  • #{id} - #{field['label']} (#{field['type']})"
+            end
+          else
+            puts "\n📝 No custom fields configured."
+          end
+          puts ""
+
+        when :single, :batch_single
+          user_ids = if action == :batch_single
+            prompt.ask("Enter Slack user IDs (comma-separated):") do |q|
+              q.required true
+            end.split(",").map(&:strip)
+          else
+            [prompt.ask("Enter the Slack user ID:") do |q|
+              q.validate(/^U\w+/, "User ID should start with 'U'")
+              q.required true
+            end]
+          end
+
+          # Build field choices
+          field_choices = standard_fields.map { |f| { name: f, value: f } }
+          custom_fields.each do |id, field|
+            field_choices << { name: "#{field['label']} (#{id})", value: id }
+          end
+          field_choices << { name: "Enter field ID manually", value: :custom }
+
+          field_name = prompt.select("Which field would you like to update?", field_choices, filter: true, per_page: 15)
+
+          if field_name == :custom
+            field_name = prompt.ask("Enter the field name or ID:")
+          end
+
+          value = prompt.ask("Enter the value for #{field_name} (leave empty to clear):", default: "")
+
+          if action == :single
+            client.set_single_field(user_ids[0], field_name, value)
+            puts "✅ Successfully updated #{field_name} for user #{user_ids[0]}\n\n"
+          else
+            puts "🚀 Updating #{field_name} for #{user_ids.length} users..."
+            success_count = 0
+            user_ids.each do |user_id|
+              begin
+                client.set_single_field(user_id, field_name, value)
+                puts "✅ Updated #{field_name} for user #{user_id}"
+                success_count += 1
+              rescue => e
+                puts "❌ Failed to update #{field_name} for user #{user_id}: #{e.message}"
+              end
+            end
+            puts "\n📊 Summary: #{success_count}/#{user_ids.length} users updated successfully\n\n"
+          end
+
+        when :multiple, :batch_multiple
+          user_ids = if action == :batch_multiple
+            prompt.ask("Enter Slack user IDs (comma-separated):") do |q|
+              q.required true
+            end.split(",").map(&:strip)
+          else
+            [prompt.ask("Enter the Slack user ID:") do |q|
+              q.validate(/^U\w+/, "User ID should start with 'U'")
+              q.required true
+            end]
+          end
+
+          puts "\n📝 You can set multiple fields using JSON format."
+          puts 'Example: {"first_name":"John","last_name":"Doe","title":"Developer"}'
+
+          profile_json = prompt.ask("Enter profile data as JSON:") do |q|
+            q.required true
+            q.validate ->(input) { JSON.parse(input); true rescue false }, "Invalid JSON format"
+          end
+
+          profile = JSON.parse(profile_json)
+
+          if action == :multiple
+            client.set_profile(user_ids[0], profile)
+            puts "✅ Successfully updated profile for user #{user_ids[0]}\n\n"
+          else
+            puts "🚀 Updating profiles for #{user_ids.length} users..."
+            success_count = 0
+            user_ids.each do |user_id|
+              begin
+                client.set_profile(user_id, profile)
+                puts "✅ Updated profile for user #{user_id}"
+                success_count += 1
+              rescue => e
+                puts "❌ Failed to update profile for user #{user_id}: #{e.message}"
+              end
+            end
+            puts "\n📊 Summary: #{success_count}/#{user_ids.length} users updated successfully\n\n"
+          end
+        end
+      end
+
+      puts "👋 Goodbye!"
+    rescue TTY::Reader::InputInterrupt
+      puts "\n\n👋 Goodbye!"
+      exit 0
+    end
+
+    desc "set-field", "Set a single profile field for a user"
+    option :user, required: true, aliases: "-u", desc: "Slack user ID"
+    option :name, required: true, aliases: "-n", desc: "Field name"
+    option :value, required: true, aliases: "-v", desc: "Field value"
+    def set_field
+      client = get_client
+      client.set_single_field(options[:user], options[:name], options[:value])
+      puts "✅ Successfully updated #{options[:name]} for user #{options[:user]}"
+    rescue Error => e
+      puts "❌ Error: #{e.message}"
+      exit 1
+    end
+
+    desc "set-profile", "Set multiple profile fields for a user using JSON"
+    option :user, required: true, aliases: "-u", desc: "Slack user ID"
+    option :profile, required: true, aliases: "-p", desc: "Profile data as JSON string"
+    def set_profile
+      client = get_client
+      profile = JSON.parse(options[:profile])
+      client.set_profile(options[:user], profile)
+      puts "✅ Successfully updated profile for user #{options[:user]}"
+    rescue JSON::ParserError
+      puts "❌ Error: Invalid JSON in profile data"
+      exit 1
+    rescue Error => e
+      puts "❌ Error: #{e.message}"
+      exit 1
+    end
+
+    desc "batch-field", "Set a single field for multiple users"
+    option :users, required: true, aliases: "-u", desc: "Comma-separated list of Slack user IDs"
+    option :name, required: true, aliases: "-n", desc: "Field name"
+    option :value, required: true, aliases: "-v", desc: "Field value"
+    def batch_field
+      client = get_client
+      user_ids = options[:users].split(",").map(&:strip).reject(&:empty?)
+
+      if user_ids.empty?
+        puts "❌ Error: No valid user IDs provided"
+        exit 1
+      end
+
+      puts "🚀 Updating #{options[:name]} for #{user_ids.length} users..."
+      success_count = 0
+      errors = 0
+
+      user_ids.each do |user_id|
+        begin
+          client.set_single_field(user_id, options[:name], options[:value])
+          puts "✅ Updated #{options[:name]} for user #{user_id}"
+          success_count += 1
+        rescue => e
+          puts "❌ Failed to update #{options[:name]} for user #{user_id}: #{e.message}"
+          errors += 1
+        end
+      end
+
+      puts "\n📊 Summary: #{success_count}/#{user_ids.length} users updated successfully"
+      exit 1 if errors > 0
+    end
+
+    desc "batch-profile", "Set multiple fields for multiple users using JSON"
+    option :users, required: true, aliases: "-u", desc: "Comma-separated list of Slack user IDs"
+    option :profile, required: true, aliases: "-p", desc: "Profile data as JSON string"
+    def batch_profile
+      client = get_client
+      user_ids = options[:users].split(",").map(&:strip).reject(&:empty?)
+
+      if user_ids.empty?
+        puts "❌ Error: No valid user IDs provided"
+        exit 1
+      end
+
+      profile = JSON.parse(options[:profile])
+
+      puts "🚀 Updating profiles for #{user_ids.length} users..."
+      success_count = 0
+      errors = 0
+
+      user_ids.each do |user_id|
+        begin
+          client.set_profile(user_id, profile)
+          puts "✅ Updated profile for user #{user_id}"
+          success_count += 1
+        rescue => e
+          puts "❌ Failed to update profile for user #{user_id}: #{e.message}"
+          errors += 1
+        end
+      end
+
+      puts "\n📊 Summary: #{success_count}/#{user_ids.length} users updated successfully"
+      exit 1 if errors > 0
+    rescue JSON::ParserError
+      puts "❌ Error: Invalid JSON in profile data"
+      exit 1
+    end
+
+    desc "list-fields", "List available custom profile fields for the team"
+    def list_fields
+      client = get_client
+      fields = client.get_team_profile
+
+      puts "Available profile fields:"
+      puts "\nStandard fields:"
+      standard_fields.each { |field| puts "  #{field}" }
+
+      if fields.any?
+        puts "\nCustom fields:"
+        fields.each do |id, field|
+          puts "  #{id} - #{field['label']} (#{field['type']})"
+        end
+      else
+        puts "\nNo custom fields configured."
+      end
+    rescue Error => e
+      puts "❌ Error: #{e.message}"
+      exit 1
+    end
+
+    desc "version", "Show version"
+    def version
+      puts "slack-profile version #{SlackProfile::VERSION}"
+    end
+
+    default_task :interactive
+
+    private
+
+    def get_client
+      token = options[:token] || ENV["SLACK_TOKEN"]
+
+      unless token
+        puts "❌ Error: Slack token is required"
+        puts "Provide it via:"
+        puts "  1. Command line: --token xoxp-your-token-here"
+        puts "  2. Environment variable: export SLACK_TOKEN=xoxp-your-token-here"
+        puts "  3. .env file: SLACK_TOKEN=xoxp-your-token-here"
+        exit 1
+      end
+
+      Client.new(token)
+    end
+
+    def standard_fields
+      %w[
+        first_name
+        last_name
+        display_name
+        title
+        email
+        phone
+        pronouns
+        real_name
+        start_date
+      ]
+    end
+  end
+end

data/lib/slack_profile/client.rb

@@ -0,0 +1,84 @@
+require "httparty"
+require "json"
+
+module SlackProfile
+  class Client
+    include HTTParty
+    base_uri "https://slack.com/api"
+
+    def initialize(token)
+      @token = token
+      @headers = {
+        "Authorization" => "Bearer #{@token}",
+        "Content-Type" => "application/json"
+      }
+    end
+
+    def set_profile(user_id, profile)
+      response = self.class.post("/users.profile.set",
+        headers: @headers,
+        body: {
+          user: user_id,
+          profile: profile.to_json
+        }.to_json
+      )
+
+      handle_response(response)
+    end
+
+    def set_single_field(user_id, field_name, value)
+      profile = if field_name.start_with?("X")
+        # Custom field
+        {
+          fields: {
+            field_name => {
+              value: value,
+              alt: ""
+            }
+          }
+        }
+      else
+        # Standard field
+        { field_name => value }
+      end
+
+      set_profile(user_id, profile)
+    end
+
+    def get_profile(user_id)
+      response = self.class.get("/users.profile.get",
+        headers: @headers,
+        query: {
+          user: user_id,
+          include_labels: true
+        }
+      )
+
+      result = handle_response(response)
+      result["profile"]
+    end
+
+    def get_team_profile
+      response = self.class.get("/team.profile.get",
+        headers: @headers
+      )
+
+      result = handle_response(response)
+      result.dig("profile", "fields") || {}
+    end
+
+    private
+
+    def handle_response(response)
+      data = JSON.parse(response.body)
+
+      unless data["ok"]
+        raise Error, "Slack API error: #{data['error']}"
+      end
+
+      data
+    rescue JSON::ParserError
+      raise Error, "Invalid response from Slack API"
+    end
+  end
+end

data/lib/slack_profile/version.rb

@@ -0,0 +1,3 @@
+module SlackProfile
+  VERSION = "1.0.0"
+end

data/lib/slack_profile.rb

@@ -0,0 +1,8 @@
+require "dotenv/load"
+require_relative "slack_profile/version"
+require_relative "slack_profile/client"
+require_relative "slack_profile/cli"
+
+module SlackProfile
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: slack_profile
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jasper Mayone
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+description: A command-line tool for updating Slack user profiles using the Slack
+  API. Perfect for workspace admins who need to manage user profiles programmatically.
+email:
+- ''
+executables:
+- slack-profile
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/slack-profile
+- lib/slack_profile.rb
+- lib/slack_profile/cli.rb
+- lib/slack_profile/client.rb
+- lib/slack_profile/version.rb
+homepage: https://github.com/jaspermayone/slack-profile-cli
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jaspermayone/slack-profile-cli
+  source_code_uri: https://github.com/jaspermayone/slack-profile-cli
+  changelog_uri: https://github.com/jaspermayone/slack-profile-cli/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: CLI tool for updating Slack user profiles
+test_files: []