firebase-stats 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f9de921405769947da53d014425be7283f4417086404cf286aec2878ef76626
+  data.tar.gz: 1a3e5974d548846245ac4cf82514d6cd5032b539031b23bca24d48ea9cc4276d
+SHA512:
+  metadata.gz: ddc6212d166cc9adde36d87cd1e683dd9595461d30832b7baddde6bbd5fa5cfbd3379f2cf4129c59196db6d7cf6df15a95907d5bd18364b56de9777c29b36653
+  data.tar.gz: 4a9557ea13c60f54c1c4015c8fd1b817b4b17fd1dbbcb652a74f02be52c7046a8187f818b1bf0cb7740b5aab29b0878a4c281bbe397edcaa8791228c07cdb6eb

data/bin/firebase-stats

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'commander/import'
+require 'firebase-stats'
+require 'table_print'
+
+program :name, 'firebase_stats_cli'
+program :version, '0.1.0'
+program :description, 'CLI to view stuff from the Firebase Analytics CSV'
+
+global_option('--platform STRING', String, 'Show only stats for this OS. Either ios, android or all (default)')
+
+def map_platform(options)
+  raw_platform = options.platform ||= 'all'
+  platform = :all
+  platform = :ios if raw_platform.downcase.include?('ios')
+  platform = :android if raw_platform.downcase.include?('android')
+  platform
+end
+
+command :devices do |c|
+  c.syntax = 'firebase_stats_cli devices [options]'
+  c.summary = 'Prints out device stats'
+  c.description = ''
+  c.option '--friendly', 'Maps Android model numbers to friendly names'
+
+  c.action do |args, options|
+    stats = FirebaseStats::Reader.new
+    stats.parse_file(args[0])
+
+    platform = map_platform(options)
+
+    wrapper = FirebaseStats::Wrapper.new(stats, platform)
+    tp wrapper.devices(friendly: options.friendly)
+  end
+end
+
+command :os do |c|
+  c.syntax = 'firebase_stats_cli os [options]'
+  c.summary = 'Prints out all of the data'
+  c.description = ''
+  c.option '--grouped', 'Groups OS versions together'
+
+  c.action do |args, options|
+    stats = FirebaseStats::Reader.new
+    stats.parse_file(args[0])
+
+    platform = map_platform(options)
+
+    wrapper = FirebaseStats::Wrapper.new(stats, platform)
+
+    options.grouped.nil? ? tp(wrapper.os_version) : tp(wrapper.os_grouped)
+  end
+end

data/lib/firebase-stats.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'reader'
+require 'wrapper'

data/lib/reader.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+class FirebaseStats
+  require 'csv'
+
+  # Parses the Firebase CSV file into sections
+  class Reader
+    attr_reader :data
+
+    def initialize
+      super
+      @data = {}
+    end
+
+    # @param [String] filename
+    def parse_file(filename)
+      lines = File.readlines(filename)
+      parse(lines)
+    end
+
+    # @param [Array<String>] input
+    def parse(input)
+      curr_lines = []
+      input.each_with_index do |line, idx|
+        curr_lines.append(line) unless comment?(line) || line.strip.empty?
+
+        if (idx == input.length - 1) || line.strip.empty?
+          process_lines curr_lines unless curr_lines.empty?
+          curr_lines = []
+        end
+      end
+    end
+
+    private
+
+    # @param [Array<String>] lines
+    def process_lines(lines)
+      section = match_header lines[0]
+      return if section.nil?
+
+      parsed = CSV.parse(lines.join, headers: true)
+      @data[section] = parsed if @data[section].nil?
+    end
+
+    # @param [String] header
+    # @return [Symbol, nil]
+    # rubocop:disable Metrics/MethodLength
+    def match_header(header)
+      mappings = {
+        'Day,28-Day,7-Day,1-Day' => :active_users,
+        'Day,Average engagement time' => :daily_engagement,
+        'Page path and screen class,User engagement,Screen views' => :screens,
+        'Day,Total revenue' => :revenue,
+        'App,Crash-free users' => :crash_free_users,
+        'App,Version,Status' => :version_adoption,
+        'Source,first_open conversions,LTV' => :acquisition,
+        'Date,Week 0,Week 1,Week 2,Week 3,Week 4,Week 5' => :retention_cohorts,
+        'Country ID,Sessions,% Total' => :audience_country,
+        'Device model,Users' => :devices,
+        'OS with version,Users' => :os_version,
+        'Gender,Users' => :gender,
+        'Category,Female,Male' => :gender_age,
+        'Platform,Users' => :platform,
+        'Platform,Users,% Total,User engagement,Total revenue' => :platform_engagement
+      }
+
+      mappings[header.strip]
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    # @param [String] line
+    def comment?(line)
+      line.include?('#')
+    end
+  end
+end

data/lib/wrapper.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+class FirebaseStats
+  require 'csv'
+  # require 'android/devices'
+
+  # Transforms the parsed Firebase file into something more user friendly
+  class Wrapper
+    # @param [FirebaseStats::Reader] stats
+    # @param [Symbol] platform One of :all, :ios, :android
+    def initialize(stats, platform = :all)
+      super()
+      @stats = stats
+      @platform = platform
+    end
+
+    def os_version
+      filtered = filter_os(@stats.data[:os_version], @platform)
+
+      cleaned = []
+      filtered.each do |row|
+        cleaned << {
+          'version' => row['OS with version'],
+          'count' => row['Users'].to_i,
+          'percentage' => as_percentage(os_total, row['Users'].to_f)
+        }
+      end
+      cleaned
+    end
+
+    def os_grouped
+      raw_os = @stats.data[:os_version]
+
+      grouped = case @platform
+                when :ios
+                  ios_os_group(raw_os)
+                when :android
+                  android_os_group(raw_os)
+                else
+                  android_os_group(raw_os).merge ios_os_group(raw_os)
+                end
+      computed = []
+      grouped.each do |k, v|
+        version_name = k
+        total = v.map { |version| version['Users'].to_i }.reduce(0, :+)
+        computed << { 'version' => version_name, 'total' => total, 'percentage' => as_percentage(os_total, total.to_f) }
+      end
+      computed
+    end
+
+    def os_total
+      filtered = filter_os(@stats.data[:os_version], @platform)
+      total = 0
+      filtered.each do |row|
+        total += row['Users'].to_i
+      end
+      total
+    end
+
+    def devices(friendly: false)
+      filtered = filter_device(@stats.data[:devices], @platform)
+      cleaned = []
+      filtered.each do |row|
+        device = {
+          'model' => row['Device model'],
+          'count' => row['Users'].to_i
+        }
+        # if friendly && ((@platform == :all) || (@platform == :android))
+        #   device['friendly'] = Android::Devices.search_by_model(row['Device Model']).name
+        # end
+        cleaned << device
+      end
+      cleaned
+    end
+
+    private
+
+    # @param [CSV::Table] os_data
+    # @param [Symbol] platform One of :all, :ios, :android
+    def filter_os(os_data, platform)
+      case platform
+      when :android
+        os_data.select { |row| row['OS with version'].downcase.include?('android') }
+      when :ios
+        os_data.select { |row| row['OS with version'].downcase.include?('ios') }
+      else
+        os_data
+      end
+    end
+
+    # @param [CSV::Table] device_data
+    # @param [Symbol] platform One of :all, :ios, :android
+    def filter_device(device_data, platform)
+      case platform
+      when :android
+        device_data.reject { |row| ios_device? row['Device model'] }
+      when :ios
+        device_data.select { |row| ios_device? row['Device model'] }
+      else
+        device_data
+      end
+    end
+
+    # @param [CSV::Row] device_name
+    def ios_device?(device_name)
+      device_name.downcase.include?('iphone') or device_name.downcase.include?('ipad')
+    end
+
+    def as_percentage(total, value)
+      percentage = (value / total) * 100
+      if percentage < 0.01
+        percentage.round(4)
+      else
+        percentage.round(2)
+      end
+    end
+
+    def ios_os_group(os_details)
+      filter_os(os_details, :ios).group_by { |row| row['OS with version'].match('(iOS [0-9]{1,2})').captures[0] }
+    end
+
+    def android_os_group(os_details)
+      filter_os(os_details, :android).group_by { |row| row['OS with version'].match('(Android [0-9]{1,2})').captures[0] }
+    end
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: firebase-stats
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- chedabob
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: table_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: A simple h
+email: matt.malone1@gmail.com
+executables:
+- firebase-stats
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/firebase-stats
+- lib/.DS_Store
+- lib/firebase-stats.rb
+- lib/reader.rb
+- lib/wrapper.rb
+homepage: https://rubygems.org/gems/firebase-stats
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Firebase CSV Stats extractor
+test_files: []