firebase-stats 1.0.3 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaeab070afaf270810993c11137363d74ff5700131a95e52e798cb8e62337525
-  data.tar.gz: d6fd22e36775bf9ffa6fcab773c027839fa3f67dc6eb0f5aec18ac526bf8a6d0
+  metadata.gz: 6f242227d13ffe84bca59bc31022c4d8628e8df5a7685d5ae1d6dd97c1aa937c
+  data.tar.gz: 06e6280fdcab4baac6818eb42f1adb9c7a4153e81620557a0da8115b4f21c7bf
 SHA512:
-  metadata.gz: ffd869cca7971501c8d066c0ca2a5b9e1ec266c2e33d078345b313678e6df4a64af29b1a337ba64017af63d5379c6991d6fc1e955fc82a5462b80b184816946e
-  data.tar.gz: be9b8f09955a53e35335e0c7c80c8e0f340ebe0649e8da6249e128ddd9edabf3f284c2ab5b8027b5b8559b799c29d04be10ebef519dcfc70bc1cd663572e3ddd
+  metadata.gz: c3e663d068be4f12c0c3ea98fd7aeda11184550a0ca3732effe19a1999733fab5fa960c14a6dfbd5f55ba6549908d8665f34d93917d1768b101dff50f69b383b
+  data.tar.gz: ef547e9e6b067dba32befac728beb80eeccd1f9217b4641cc358f1f72765eff5bfba90ad79dde97fdc7a09b5d97ff42ae6de3be00164ea8de759ec85d2e6f673

data/bin/firebase-stats

@@ -29,13 +29,17 @@ command :devices do |c|
   c.option '--platform STRING', String, 'Show only stats for this OS. Either ios, android or all (default)'
 
   c.action do |args, options|
-    stats = FirebaseStats::Reader.new
-    stats.parse_file(args[0])
+    begin
+      stats = FirebaseStats::Reader.new
+      stats.parse_file(args[0])
 
-    platform = map_platform(options)
+      platform = map_platform(options)
 
-    wrapper = FirebaseStats::Wrapper.new(stats, platform)
-    tp wrapper.devices(friendly: options.friendly, limit: options.limit)
+      wrapper = FirebaseStats::Wrapper.new(stats)
+      tp wrapper.devices(friendly: options.friendly, limit: options.limit, platform: platform)
+    rescue FirebaseStats::SectionNotFoundError => error
+      print_data_error(error)
+    end
   end
 end
 
@@ -48,21 +52,23 @@ command :os do |c|
   c.option '--platform STRING', String, 'Show only stats for this OS. Either ios, android or all (default)'
 
   c.action do |args, options|
-    stats = FirebaseStats::Reader.new
-    stats.parse_file(args[0])
+    begin
+      stats = FirebaseStats::Reader.new
+      stats.parse_file(args[0])
+
+      platform = map_platform(options)
 
-    platform = map_platform(options)
+      wrapper = FirebaseStats::Wrapper.new(stats)
 
-    wrapper = FirebaseStats::Wrapper.new(stats, platform)
+      grouped = options.grouped || false
+      major_order = options.version_sorted || false
 
-    data = options.grouped.nil? ? wrapper.os_version : wrapper.os_grouped
+      data = wrapper.os(platform: platform, grouped: grouped, major_order: major_order)
 
-    unless options.version_sorted.nil?
-      data = data.sort_by do |row|
-        row['version']
-      end.reverse
+      tp data
+    rescue FirebaseStats::SectionNotFoundError => error
+      print_data_error(error)
     end
-    tp data
   end
 end
 
@@ -72,13 +78,15 @@ command :gender do |c|
   c.description = 'Prints out a table with number of users of each gender'
 
   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.gender
+    begin
+      stats = FirebaseStats::Reader.new
+      stats.parse_file(args[0])
+
+      wrapper = FirebaseStats::Wrapper.new(stats)
+      tp wrapper.gender
+    rescue FirebaseStats::SectionNotFoundError => error
+      print_data_error(error)
+    end
   end
 end
 
@@ -88,12 +96,26 @@ command :gender_age do |c|
   c.description = 'Prints out a table with percentage of users of each gender grouped by age'
 
   c.action do |args, options|
-    stats = FirebaseStats::Reader.new
-    stats.parse_file(args[0])
+    begin
+      stats = FirebaseStats::Reader.new
+      stats.parse_file(args[0])
+
+      wrapper = FirebaseStats::Wrapper.new(stats)
+      tp wrapper.gender_age
+    rescue FirebaseStats::SectionNotFoundError => error
+      print_data_error(error)
+    end
+  end
+end
 
-    platform = map_platform(options)
+private
 
-    wrapper = FirebaseStats::Wrapper.new(stats, platform)
-    tp wrapper.gender_age
-  end
+
+# @param [SectionNotFoundError] error
+def print_data_error(error)
+  tip = FirebaseStats::Wrapper.tip(error.section)
+  expected_header = FirebaseStats::Reader.search_string(error.section)
+  puts "Unable to find that specific data in the input file"
+  puts "For the data you requested, the following CSV header should be contained within the file: '#{expected_header}'"
+  puts tip unless tip.nil?
 end

data/lib/device_utils.rb

@@ -0,0 +1,24 @@
+module FirebaseStats
+  # Parses the Firebase CSV file into sections
+  class DeviceUtils
+    # Is this device name an iOS device?
+    # @param [CSV::Row] device_name
+    def self.ios_device?(device_name)
+      device_name.downcase.include?('iphone') or device_name.downcase.include?('ipad') or device_name.downcase.include?('ipod')
+    end
+
+    # Filters a device list to only the requested platform
+    # @param [CSV::Table] device_data
+    # @param [Symbol] platform One of :all, :ios, :android
+    def self.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
+  end
+end

data/lib/firebase-stats.rb

@@ -3,3 +3,5 @@
 require 'reader'
 require 'wrapper'
 require 'version'
+require 'device_utils'
+require 'section_not_found_error'

data/lib/reader.rb

@@ -1,17 +1,25 @@
 # frozen_string_literal: true
 
-class FirebaseStats
+module FirebaseStats
   require 'csv'
 
   # Parses the Firebase CSV file into sections
   class Reader
-    attr_reader :data
-
     def initialize
       super
       @data = {}
     end
 
+    def num_sections
+      @data.length
+    end
+
+    def get(section)
+      found = @data[section]
+      raise SectionNotFoundError.new(section) if found.nil?
+      found
+    end
+
     # @param [String] filename
     def parse_file(filename)
       lines = File.readlines(filename)
@@ -20,6 +28,7 @@ class FirebaseStats
 
     # @param [Array<String>] input
     def parse(input)
+      @data = {}
       curr_lines = []
       input.each_with_index do |line, idx|
         curr_lines.push(line) unless comment?(line) || line.strip.empty?
@@ -31,22 +40,15 @@ class FirebaseStats
       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?
+    # Get the string that is used to find a given section in the CSV
+    def self.search_string(section)
+      header = Reader.mappings.key(section)
+      header = "Category,Male,Other,Female" if header.nil? and section == :gender_age
+      return header
     end
 
-    # @param [String] header
-    # @return [Symbol, nil]
-    # rubocop:disable Metrics/MethodLength
-    def match_header(header)
-      mappings = {
+    def self.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,
@@ -59,16 +61,42 @@ class FirebaseStats
         '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
       }
+    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
+
+    # Maps a given CSV header to a section
+    # @param [String] header The CSV header line to parse
+    # @return [Symbol, nil] The section, or nil if not found
+    # rubocop:disable Metrics/MethodLength
+    def match_header(header)
+      # All of the section headers that can be found in the CSV file, mapping to our internal section symbols
+
+      cleaned_header = header.strip
+      section = Reader.mappings[cleaned_header]
 
-      mappings[header.strip]
+      # Kludge for gender_age parsing as the headers aren't always in the right order, so rule out
+      # all the other sections first
+      section = :gender_age if section.nil? and cleaned_header.include? 'Category,'
+      section
     end
     # rubocop:enable Metrics/MethodLength
 
+    # Is this line a comment
     # @param [String] line
+    # @return [Boolean]
     def comment?(line)
       line.include?('#')
     end

data/lib/section_not_found_error.rb

@@ -0,0 +1,9 @@
+module FirebaseStats
+  class SectionNotFoundError < StandardError
+    attr_reader :section
+
+    def initialize(section)
+      @section = section
+    end
+  end
+end

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-class FirebaseStats
-  VERSION = '1.0.3'
+module FirebaseStats
+  VERSION = '1.0.7'
 end

data/lib/wrapper.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class FirebaseStats
+module FirebaseStats
   require 'csv'
   require 'android/devices'
   require 'open-uri'
@@ -8,65 +8,41 @@ class FirebaseStats
   # 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)
+    def initialize(stats)
       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
+    # Get all OS versions, grouped by Major version
+    # @param [Symbol] platform One of :all, :ios, :android
+    # @param [Boolean] grouped Group by Major OS version
+    # @param [Boolean] major_order Order by Major OS version (instead of percentage)
+    def os(platform: :all, grouped: true, major_order: true)
+      os_data = all_os
+      filtered = filter_os(os_data, platform)
+
+      data = if grouped
+               make_group_stats(filtered, platform)
+             else
+               filtered
+             end
+
+      major_order ? major_version_sort(data) : data
     end
 
-    def devices(friendly: false, limit: 10)
-      filtered = filter_device(@stats.data[:devices], @platform)
+    # Gets all devices
+    # @param [Boolean] friendly Transform the Android model numbers into their human numaes
+    # @param [Integer] limit Number of devices to turn
+    # @param [Symbol] platform One of :all, :ios, :android
+    def devices(friendly: false, limit: 10, platform: :all)
+      filtered = DeviceUtils.filter_device(@stats.get(:devices), platform)
       filtered = filtered.take(limit || 10)
       cleaned = []
       filtered.each do |row|
         device = {
           'model' => row['Device model']
         }
-        if friendly && ((@platform == :all) || (@platform == :android))
+        if friendly && ((platform == :all) || (platform == :android))
           mapped = Android::Devices.search_by_model(row['Device model'])
           device['friendly'] = if mapped.nil?
                                  row['Device model']
@@ -82,25 +58,26 @@ class FirebaseStats
     end
 
     def gender
-      raw = @stats.data[:gender]
+      raw = @stats.get(:gender)
       data = []
       raw.each do |row|
         data << {
           'gender' => row['Gender'],
-          'count' => row['Users']
+          'count' => row['Users'].to_i
         }
       end
       data
     end
 
     def gender_age
-      raw = @stats.data[:gender_age]
+      raw = @stats.get(:gender_age)
       data = []
       raw.each do |row|
         data << {
           'age' => row['Category'],
           'male' => (row['Male'].to_f * 100).round(2),
-          'female' => (row['Female'].to_f * 100).round(2)
+          'female' => (row['Female'].to_f * 100).round(2),
+          'other' => (row['Other'].to_f * 100).round(2)
         }
       end
       data
@@ -113,32 +90,14 @@ class FirebaseStats
     def filter_os(os_data, platform)
       case platform
       when :android
-        os_data.select { |row| row['OS with version'].downcase.include?('android') }
+        os_data.select { |row| row['version'].downcase.include?('android') }
       when :ios
-        os_data.select { |row| row['OS with version'].downcase.include?('ios') }
+        os_data.select { |row| row['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') or device_name.downcase.include?('ipod')
-    end
-
     def as_percentage(total, value)
       percentage = (value / total) * 100
       if percentage < 0.01
@@ -149,11 +108,68 @@ class FirebaseStats
     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] }
+      filter_os(os_details, :ios).group_by { |row| row['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] }
+      filter_os(os_details, :android).group_by { |row| row['version'].match('(Android [0-9]{1,2})').captures[0] }
+    end
+
+    # Get all OS versions
+    def all_os
+      data = @stats.get(:os_version)
+
+      data.map do |row|
+        {
+          'version' => row['OS with version'],
+          'count' => row['Users'].to_i
+        }
+      end
+    end
+
+    def make_group_stats(os_data, platform)
+      data = make_os_groups(os_data, platform)
+
+      total_devices = os_total(os_data)
+      data.map do |k, v|
+        version_name = k
+        group_total = v.map { |version| version['count'].to_i }.reduce(0, :+)
+        { 'version' => version_name,
+          'total' => group_total,
+          'percentage' => as_percentage(total_devices.to_f, group_total) }
+      end
+    end
+
+    def make_os_groups(os_data, platform)
+      case platform
+      when :ios
+        ios_os_group(os_data)
+      when :android
+        android_os_group(os_data)
+      else
+        android_os_group(os_data).merge ios_os_group(os_data)
+      end
+    end
+
+    def os_total(os_data)
+      os_data.map { |row| row['count'] }.reduce(0, :+)
+    end
+
+    def major_version_sort(data)
+      data.sort_by do |row|
+        version = row['version']
+        number = version.match('([0-9.]+)').captures[0]
+        Gem::Version.new(number)
+      end.reverse
+    end
+
+    def self.tip(section)
+      tips = {
+        :os_version => "This data can now be found in the Audiences section of Firebase Analytics. Before you export the CSV file, change one of the charts to `Users` by `OS with version`",
+        :gender_age => "Note: The columns for Gender+Age are not always in the same order, but this is taken into account when searching",
+        :devices => "Note: If you export from the Tech Details: Device Model page, this is currently unsupported as it has two different headers. Use the export from the main Dashboard page"
+      }
+      tips[section]
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firebase-stats
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.7
 platform: ruby
 authors:
 - chedabob
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-19 00:00:00.000000000 Z
+date: 2022-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: android-devices
@@ -103,9 +103,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/firebase-stats
-- lib/.DS_Store
+- lib/device_utils.rb
 - lib/firebase-stats.rb
 - lib/reader.rb
+- lib/section_not_found_error.rb
 - lib/version.rb
 - lib/wrapper.rb
 homepage: https://github.com/chedabob/firebase-stats
@@ -127,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.14
+rubygems_version: 3.0.9
 signing_key:
 specification_version: 4
 summary: Firebase CSV Stats CLI