firebase-stats 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbcdeca6db0a52d5363c394beaaa7eafa626cf9cc33efd6bb50e41c1ad364d89
-  data.tar.gz: 20249bc78d26a568cf21288b144aae3999e597519a9bcc41e41f3f61890a027a
+  metadata.gz: 6f242227d13ffe84bca59bc31022c4d8628e8df5a7685d5ae1d6dd97c1aa937c
+  data.tar.gz: 06e6280fdcab4baac6818eb42f1adb9c7a4153e81620557a0da8115b4f21c7bf
 SHA512:
-  metadata.gz: 20c75f62fdd228779f51ba1a64b5f783c07b859a280efb65be07e47b5c8aabe6b94859650bb99d85f71056d5a4b1b2336bd9af148b724c67fb208fa4e52390a6
-  data.tar.gz: 8b8baf3a8985fc72ff61a5b75d69cc6660bc53bd42e0d5271a62e98d5eef262ba86631d99ee3e10226211ecd991327626ccc15e991a0acac77ae0895432a2678
+  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)
-    tp wrapper.devices(friendly: options.friendly, limit: options.limit, platform: platform)
+      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,19 +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)
 
-    grouped = options.grouped || false
-    major_order = options.version_sorted || false
+      grouped = options.grouped || false
+      major_order = options.version_sorted || false
 
-    data = wrapper.os(platform: platform, grouped: grouped, major_order: major_order)
+      data = wrapper.os(platform: platform, grouped: grouped, major_order: major_order)
 
-    tp data
+      tp data
+    rescue FirebaseStats::SectionNotFoundError => error
+      print_data_error(error)
+    end
   end
 end
 
@@ -70,11 +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])
-
-    wrapper = FirebaseStats::Wrapper.new(stats)
-    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
 
@@ -84,10 +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])
-
-    wrapper = FirebaseStats::Wrapper.new(stats)
-    tp wrapper.gender_age
+    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
+
+private
+
+
+# @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/firebase-stats.rb

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

data/lib/reader.rb

@@ -5,13 +5,21 @@ module FirebaseStats
 
   # 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 @@ module 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 @@ module 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,
@@ -62,15 +64,39 @@ module FirebaseStats
         '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 = mappings[cleaned_header]
+      section = Reader.mappings[cleaned_header]
 
+      # 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
 
 module FirebaseStats
-  VERSION = '1.0.6'
+  VERSION = '1.0.7'
 end

data/lib/wrapper.rb

@@ -35,7 +35,7 @@ module FirebaseStats
     # @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.data[:devices], platform)
+      filtered = DeviceUtils.filter_device(@stats.get(:devices), platform)
       filtered = filtered.take(limit || 10)
       cleaned = []
       filtered.each do |row|
@@ -58,7 +58,7 @@ module FirebaseStats
     end
 
     def gender
-      raw = @stats.data[:gender]
+      raw = @stats.get(:gender)
       data = []
       raw.each do |row|
         data << {
@@ -70,7 +70,7 @@ module FirebaseStats
     end
 
     def gender_age
-      raw = @stats.data[:gender_age]
+      raw = @stats.get(:gender_age)
       data = []
       raw.each do |row|
         data << {
@@ -117,7 +117,7 @@ module FirebaseStats
 
     # Get all OS versions
     def all_os
-      data = @stats.data[:os_version]
+      data = @stats.get(:os_version)
 
       data.map do |row|
         {
@@ -162,5 +162,14 @@ module FirebaseStats
         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.6
+  version: 1.0.7
 platform: ruby
 authors:
 - chedabob
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-28 00:00:00.000000000 Z
+date: 2022-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: android-devices
@@ -106,6 +106,7 @@ files:
 - 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