gitfollow 0.1.0

data/lib/gitfollow/storage.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'fileutils'
+
+module GitFollow
+  class Storage
+    DEFAULT_DATA_DIR = File.join(Dir.home, '.gitfollow')
+    SNAPSHOTS_FILE = 'snapshots.json'
+    HISTORY_FILE = 'history.json'
+
+    attr_reader :data_dir
+
+    def initialize(data_dir: DEFAULT_DATA_DIR)
+      @data_dir = data_dir
+      ensure_data_dir_exists
+    end
+
+    def save_snapshot(username:, followers:, following:)
+      snapshots = load_snapshots
+
+      snapshot = {
+        'username' => username,
+        'timestamp' => Time.now.utc.iso8601,
+        'followers' => deep_stringify(followers),
+        'following' => deep_stringify(following),
+        'stats' => {
+          'followers_count' => followers.size,
+          'following_count' => following.size,
+          'mutual_count' => calculate_mutual(followers, following).size
+        }
+      }
+
+      snapshots[username] ||= []
+      snapshots[username] << snapshot
+
+      write_json(snapshots_file_path, snapshots)
+      snapshot
+    end
+
+    def latest_snapshot(username)
+      snapshots = load_snapshots
+      snapshots[username]&.last
+    end
+
+    def all_snapshots(username)
+      snapshots = load_snapshots
+      snapshots[username] || []
+    end
+
+    def save_history_entry(username:, event_type:, user_data:)
+      history = load_history
+
+      entry = {
+        'username' => username,
+        'event_type' => event_type.to_s,
+        'user' => deep_stringify(user_data),
+        'timestamp' => Time.now.utc.iso8601
+      }
+
+      history[username] ||= []
+      history[username] << entry
+
+      write_json(history_file_path, history)
+      entry
+    end
+
+    def get_history(username, limit: nil)
+      history = load_history
+      entries = history[username] || []
+      limit ? entries.last(limit) : entries
+    end
+
+    def clear_data(username)
+      snapshots = load_snapshots
+      history = load_history
+
+      snapshots.delete(username)
+      history.delete(username)
+
+      write_json(snapshots_file_path, snapshots)
+      write_json(history_file_path, history)
+      true
+    end
+
+    def data_exists?(username)
+      snapshots = load_snapshots
+      !snapshots[username].nil? && !snapshots[username].empty?
+    end
+
+    def export(username:, format:, output_file:)
+      case format
+      when :json
+        export_json(username, output_file)
+      when :csv
+        export_csv(username, output_file)
+      else
+        raise ArgumentError, "Unsupported export format: #{format}"
+      end
+    end
+
+    private
+
+    # Convert all symbol keys to strings recursively
+    def deep_stringify(obj)
+      case obj
+      when Hash
+        obj.each_with_object({}) do |(key, value), hash|
+          hash[key.to_s] = deep_stringify(value)
+        end
+      when Array
+        obj.map { |item| deep_stringify(item) }
+      else
+        obj
+      end
+    end
+
+    def calculate_mutual(followers, following)
+      follower_logins = followers.map { |f| f['login'] || f[:login] }
+      following.select { |f| follower_logins.include?(f['login'] || f[:login]) }
+    end
+
+    def ensure_data_dir_exists
+      FileUtils.mkdir_p(@data_dir)
+    end
+
+    def snapshots_file_path
+      File.join(@data_dir, SNAPSHOTS_FILE)
+    end
+
+    def history_file_path
+      File.join(@data_dir, HISTORY_FILE)
+    end
+
+    def load_snapshots
+      load_json(snapshots_file_path)
+    end
+
+    def load_history
+      load_json(history_file_path)
+    end
+
+    def load_json(file_path)
+      return {} unless File.exist?(file_path)
+
+      JSON.parse(File.read(file_path))
+    rescue JSON::ParserError
+      {}
+    end
+
+    def write_json(file_path, data)
+      File.write(file_path, JSON.pretty_generate(data))
+    end
+
+    def export_json(username, output_file)
+      data = {
+        'username' => username,
+        'snapshots' => all_snapshots(username),
+        'history' => get_history(username)
+      }
+      write_json(output_file, data)
+      output_file
+    end
+
+    def export_csv(username, output_file)
+      require 'csv'
+
+      history = get_history(username)
+
+      CSV.open(output_file, 'w') do |csv|
+        csv << ['Timestamp', 'Event Type', 'Username', 'User ID']
+
+        history.each do |entry|
+          csv << [
+            entry['timestamp'],
+            entry['event_type'],
+            entry['user']['login'],
+            entry['user']['id']
+          ]
+        end
+      end
+
+      output_file
+    end
+  end
+end

data/lib/gitfollow/tracker.rb

@@ -0,0 +1,237 @@
+# frozen_string_literal: true
+
+module GitFollow
+  class Tracker
+    attr_reader :client, :storage, :username
+
+    def initialize(client:, storage:)
+      @client = client
+      @storage = storage
+      @username = client.username
+    end
+
+    def initial_setup
+      followers = @client.fetch_followers
+      following = @client.fetch_following
+
+      @storage.save_snapshot(
+        username: @username,
+        followers: followers,
+        following: following
+      )
+    end
+
+    def check_changes
+      current_followers = @client.fetch_followers
+      current_following = @client.fetch_following
+
+      previous_snapshot = @storage.latest_snapshot(@username)
+
+      if previous_snapshot.nil?
+        return {
+          first_run: true,
+          message: 'No previous data found. Initializing...'
+        }
+      end
+
+      changes = detect_changes(previous_snapshot, current_followers, current_following)
+
+      # Save new snapshot
+      @storage.save_snapshot(
+        username: @username,
+        followers: current_followers,
+        following: current_following
+      )
+
+      save_history_entries(changes)
+
+      changes
+    end
+
+    def statistics
+      latest = @storage.latest_snapshot(@username)
+
+      return nil if latest.nil?
+
+      followers = latest['followers']
+      following = latest['following']
+      mutual = calculate_mutual(followers, following)
+
+      history = @storage.get_history(@username)
+      new_followers_count = history.count { |e| e['event_type'] == 'new_follower' }
+      unfollows_count = history.count { |e| e['event_type'] == 'unfollowed' }
+
+      {
+        followers_count: followers.size,
+        following_count: following.size,
+        mutual_count: mutual.size,
+        ratio: calculate_ratio(followers.size, following.size),
+        total_new_followers: new_followers_count,
+        total_unfollows: unfollows_count,
+        last_updated: latest['timestamp']
+      }
+    end
+
+    def generate_report(format: :text)
+      stats = statistics
+
+      return 'No data available. Run `gitfollow check` first.' if stats.nil?
+
+      history = @storage.get_history(@username, limit: 20)
+
+      case format
+      when :markdown
+        generate_markdown_report(stats, history)
+      when :text
+        generate_text_report(stats, history)
+      else
+        raise ArgumentError, "Unsupported format: #{format}"
+      end
+    end
+
+    def mutual_followers
+      latest = @storage.latest_snapshot(@username)
+      return [] if latest.nil?
+
+      calculate_mutual(latest['followers'], latest['following'])
+    end
+
+    def non_followers
+      latest = @storage.latest_snapshot(@username)
+      return [] if latest.nil?
+
+      following = latest['following']
+      follower_logins = latest['followers'].map { |f| f['login'] || f[:login] }
+
+      following.reject { |f| follower_logins.include?(f['login'] || f[:login]) }
+    end
+
+    private
+
+    def detect_changes(previous_snapshot, current_followers, _current_following)
+      previous_followers = previous_snapshot['followers']
+
+      # Extract IDs, handling both symbol and string keys
+      previous_follower_ids = previous_followers.map { |f| f['id'] || f[:id] }
+      current_follower_ids = current_followers.map { |f| f['id'] || f[:id] }
+
+      new_follower_ids = current_follower_ids - previous_follower_ids
+      unfollowed_ids = previous_follower_ids - current_follower_ids
+
+      # Find users by ID, handling both symbol and string keys
+      new_followers = current_followers.select { |f| new_follower_ids.include?(f['id'] || f[:id]) }
+      unfollowed = previous_followers.select { |f| unfollowed_ids.include?(f['id'] || f[:id]) }
+
+      {
+        new_followers: new_followers,
+        unfollowed: unfollowed,
+        has_changes: !new_followers.empty? || !unfollowed.empty?,
+        previous_count: previous_followers.size,
+        current_count: current_followers.size,
+        net_change: current_followers.size - previous_followers.size
+      }
+    end
+
+    def save_history_entries(changes)
+      changes[:new_followers].each do |user|
+        @storage.save_history_entry(
+          username: @username,
+          event_type: :new_follower,
+          user_data: user
+        )
+      end
+
+      changes[:unfollowed].each do |user|
+        @storage.save_history_entry(
+          username: @username,
+          event_type: :unfollowed,
+          user_data: user
+        )
+      end
+    end
+
+    def calculate_mutual(followers, following)
+      follower_logins = followers.map { |f| f['login'] || f[:login] }
+      following.select { |f| follower_logins.include?(f['login'] || f[:login]) }
+    end
+
+    def calculate_ratio(followers_count, following_count)
+      return 0.0 if following_count.zero?
+
+      (followers_count.to_f / following_count).round(2)
+    end
+
+    def generate_markdown_report(stats, history)
+      report = []
+      report << "# GitFollow Report for @#{@username}"
+      report << ''
+      report << "**Last Updated:** #{Time.parse(stats[:last_updated]).strftime('%Y-%m-%d %H:%M:%S UTC')}"
+      report << ''
+      report << '## Statistics'
+      report << ''
+      report << "- **Followers:** #{stats[:followers_count]}"
+      report << "- **Following:** #{stats[:following_count]}"
+      report << "- **Mutual:** #{stats[:mutual_count]}"
+      report << "- **Ratio:** #{stats[:ratio]}"
+      report << "- **Total New Followers:** #{stats[:total_new_followers]}"
+      report << "- **Total Unfollows:** #{stats[:total_unfollows]}"
+      report << ''
+      report << '## Recent Activity'
+      report << ''
+
+      if history.empty?
+        report << '_No recent activity_'
+      else
+        report << '| Timestamp | Event | User |'
+        report << '|-----------|-------|------|'
+
+        history.reverse.each do |entry|
+          timestamp = Time.parse(entry['timestamp']).strftime('%Y-%m-%d %H:%M')
+          event = entry['event_type'] == 'new_follower' ? '✅ New Follower' : '❌ Unfollowed'
+          user = "@#{entry['user']['login']}"
+
+          report << "| #{timestamp} | #{event} | #{user} |"
+        end
+      end
+
+      report << ''
+      report << '---'
+      report << '_Generated with [GitFollow](https://github.com/bulletdev/gitfollow)_'
+
+      report.join("\n")
+    end
+
+    def generate_text_report(stats, history)
+      report = []
+      report << "GitFollow Report for @#{@username}"
+      report << ('=' * 50)
+      report << ''
+      report << "Last Updated: #{Time.parse(stats[:last_updated]).strftime('%Y-%m-%d %H:%M:%S UTC')}"
+      report << ''
+      report << 'Statistics:'
+      report << "  Followers:         #{stats[:followers_count]}"
+      report << "  Following:         #{stats[:following_count]}"
+      report << "  Mutual:            #{stats[:mutual_count]}"
+      report << "  Ratio:             #{stats[:ratio]}"
+      report << "  Total New:         #{stats[:total_new_followers]}"
+      report << "  Total Unfollows:   #{stats[:total_unfollows]}"
+      report << ''
+      report << 'Recent Activity:'
+      report << ('-' * 50)
+
+      if history.empty?
+        report << '  No recent activity'
+      else
+        history.reverse.each do |entry|
+          timestamp = Time.parse(entry['timestamp']).strftime('%Y-%m-%d %H:%M')
+          event = entry['event_type'] == 'new_follower' ? '✅ NEW' : '❌ UNFOLLOW'
+          user = "@#{entry['user']['login']}"
+
+          report << "  [#{timestamp}] #{event} #{user}"
+        end
+      end
+
+      report.join("\n")
+    end
+  end
+end

data/lib/gitfollow/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GitFollow
+  VERSION = '0.1.0'
+end

data/lib/gitfollow.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'gitfollow/version'
+require_relative 'gitfollow/client'
+require_relative 'gitfollow/storage'
+require_relative 'gitfollow/tracker'
+require_relative 'gitfollow/notifier'
+require_relative 'gitfollow/cli'
+
+# GitFollow - Track GitHub followers and unfollows
+module GitFollow
+end

metadata

@@ -0,0 +1,255 @@
+--- !ruby/object:Gem::Specification
+name: gitfollow
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael D. Bullet
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !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-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: tty-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.60'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.60'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.26'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.26'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.19'
+description: A CLI tool to monitor your GitHub followers, detect new followers and
+  unfollows, and generate detailed reports with automated notifications.
+email:
+- contato@michaelbullet.com
+executables:
+- gitfollow
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/gitfollow
+- lib/gitfollow.rb
+- lib/gitfollow/cli.rb
+- lib/gitfollow/client.rb
+- lib/gitfollow/notifier.rb
+- lib/gitfollow/storage.rb
+- lib/gitfollow/tracker.rb
+- lib/gitfollow/version.rb
+homepage: https://github.com/bulletdev/gitfollow
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bulletdev/gitfollow
+  source_code_uri: https://github.com/bulletdev/gitfollow.git
+  changelog_uri: https://github.com/bulletdev/gitfollow/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/bulletdev/gitfollow/issues
+  documentation_uri: https://github.com/bulletdev/gitfollow/blob/main/README.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.5
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Track GitHub followers and unfollows with ease
+test_files: []