firebase-stats 0.1.0 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f9de921405769947da53d014425be7283f4417086404cf286aec2878ef76626
-  data.tar.gz: 1a3e5974d548846245ac4cf82514d6cd5032b539031b23bca24d48ea9cc4276d
+  metadata.gz: 4c0052a1fd763bfd20e4561f5381098bc8436252f25ca478a51f152d9c9edc1f
+  data.tar.gz: 5057c8cf57c562d489d60ecf7d35fa4172ad025937da9b7fd3ddd72b09e8b86c
 SHA512:
-  metadata.gz: ddc6212d166cc9adde36d87cd1e683dd9595461d30832b7baddde6bbd5fa5cfbd3379f2cf4129c59196db6d7cf6df15a95907d5bd18364b56de9777c29b36653
-  data.tar.gz: 4a9557ea13c60f54c1c4015c8fd1b817b4b17fd1dbbcb652a74f02be52c7046a8187f818b1bf0cb7740b5aab29b0878a4c281bbe397edcaa8791228c07cdb6eb
+  metadata.gz: 2e36f05b2e942c81ebd86db0ddaff06aecca5e8167bf233591a32df06489b31b52985d6636d00dfcedd2c82ff914430c03d220297f3d93456b658c012b8240be
+  data.tar.gz: f74f39bd93fcfc0fc0c93ed6f11d9485d1635cbcbb64c0ca046cd91eb5f0828f8acaa9c3e3c2640cec4c62f00ef4cadf4f92dbe5e9b1dbe5d9c7ea07b5bba498

data/bin/firebase-stats

@@ -6,11 +6,11 @@ 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'
+program :name, 'firebase-stats'
+program :version, FirebaseStats::VERSION
+program :description, 'A CLI tool to get different stats out of the huge Firebase Analytics CSV'
+program :help_formatter, Commander::HelpFormatter::TerminalCompact
 
-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'
@@ -21,10 +21,12 @@ def map_platform(options)
 end
 
 command :devices do |c|
-  c.syntax = 'firebase_stats_cli devices [options]'
+  c.syntax = 'devices <path to csv> [options]'
   c.summary = 'Prints out device stats'
-  c.description = ''
-  c.option '--friendly', 'Maps Android model numbers to friendly names'
+  c.description = 'Prints out a table with all of the devices, optionally filtered by OS'
+  c.option '--friendly', 'Prints out Android device models with their human readable name (this is slow)'
+  c.option '--limit NUMBER', Integer, 'Limits number of devices output'
+  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
@@ -32,16 +34,18 @@ command :devices do |c|
 
     platform = map_platform(options)
 
-    wrapper = FirebaseStats::Wrapper.new(stats, platform)
-    tp wrapper.devices(friendly: options.friendly)
+    wrapper = FirebaseStats::Wrapper.new(stats)
+    tp wrapper.devices(friendly: options.friendly, limit: options.limit, platform: platform)
   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.syntax = 'os <path to csv> [options]'
+  c.summary = 'Prints out OS stats'
+  c.description = 'Prints out the number of devices per OS version, optionally filtered by OS and grouped by major version'
+  c.option '--grouped', 'Groups minor OS versions together'
+  c.option '--version-sorted', 'Sorts by OS version instead of percentage'
+  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
@@ -49,8 +53,45 @@ command :os do |c|
 
     platform = map_platform(options)
 
-    wrapper = FirebaseStats::Wrapper.new(stats, platform)
+    wrapper = FirebaseStats::Wrapper.new(stats)
 
-    options.grouped.nil? ? tp(wrapper.os_version) : tp(wrapper.os_grouped)
+    grouped = options.grouped || false
+    major_order = options.version_sorted || false
+
+    data = wrapper.os(platform: platform, grouped: grouped, major_order: major_order)
+
+    tp data
+  end
+end
+
+command :gender do |c|
+  c.syntax = 'gender'
+  c.summary = 'Prints out gender stats (if available)'
+  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)
+    tp wrapper.gender
+  end
+end
+
+command :gender_age do |c|
+  c.syntax = 'gender_age'
+  c.summary = 'Prints out age group stats (if available)'
+  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])
+
+    platform = map_platform(options)
+
+    wrapper = FirebaseStats::Wrapper.new(stats)
+    tp wrapper.gender_age
   end
 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

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

data/lib/reader.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class FirebaseStats
+module FirebaseStats
   require 'csv'
 
   # Parses the Firebase CSV file into sections
@@ -22,7 +22,7 @@ class FirebaseStats
     def parse(input)
       curr_lines = []
       input.each_with_index do |line, idx|
-        curr_lines.append(line) unless comment?(line) || line.strip.empty?
+        curr_lines.push(line) unless comment?(line) || line.strip.empty?
 
         if (idx == input.length - 1) || line.strip.empty?
           process_lines curr_lines unless curr_lines.empty?

data/lib/version.rb

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

data/lib/wrapper.rb

@@ -1,76 +1,85 @@
 # frozen_string_literal: true
 
-class FirebaseStats
+module FirebaseStats
   require 'csv'
-  # require 'android/devices'
+  require 'android/devices'
+  require 'open-uri'
 
   # 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)
+    # 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
+
+    # 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.data[:devices], platform)
+      filtered = filtered.take(limit || 10)
       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)
+        device = {
+          'model' => row['Device model']
         }
-      end
-      cleaned
-    end
+        if friendly && ((platform == :all) || (platform == :android))
+          mapped = Android::Devices.search_by_model(row['Device model'])
+          device['friendly'] = if mapped.nil?
+                                 row['Device model']
+                               else
+                                 mapped.name
+                               end
+        end
+        device['count'] = row['Users'].to_i
 
-    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) }
+        cleaned << device
       end
-      computed
+      cleaned
     end
 
-    def os_total
-      filtered = filter_os(@stats.data[:os_version], @platform)
-      total = 0
-      filtered.each do |row|
-        total += row['Users'].to_i
+    def gender
+      raw = @stats.data[:gender]
+      data = []
+      raw.each do |row|
+        data << {
+          'gender' => row['Gender'],
+          'count' => row['Users']
+        }
       end
-      total
+      data
     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
+    def gender_age
+      raw = @stats.data[: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)
         }
-        # if friendly && ((@platform == :all) || (@platform == :android))
-        #   device['friendly'] = Android::Devices.search_by_model(row['Device Model']).name
-        # end
-        cleaned << device
       end
-      cleaned
+      data
     end
 
     private
@@ -80,32 +89,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')
-    end
-
     def as_percentage(total, value)
       percentage = (value / total) * 100
       if percentage < 0.01
@@ -116,11 +107,59 @@ 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.data[: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
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: firebase-stats
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.5
 platform: ruby
 authors:
 - chedabob
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-16 00:00:00.000000000 Z
+date: 2021-03-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: android-devices
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: commander
   requirement: !ruby/object:Gem::Requirement
@@ -38,7 +52,50 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-description: A simple h
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+description: A CLI tool to get different stats out of the huge Firebase Analytics
+  CSV
 email: matt.malone1@gmail.com
 executables:
 - firebase-stats
@@ -47,10 +104,12 @@ extra_rdoc_files: []
 files:
 - bin/firebase-stats
 - lib/.DS_Store
+- lib/device_utils.rb
 - lib/firebase-stats.rb
 - lib/reader.rb
+- lib/version.rb
 - lib/wrapper.rb
-homepage: https://rubygems.org/gems/firebase-stats
+homepage: https://github.com/chedabob/firebase-stats
 licenses:
 - MIT
 metadata: {}
@@ -60,17 +119,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '3'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.14
 signing_key:
 specification_version: 4
-summary: Firebase CSV Stats extractor
+summary: Firebase CSV Stats CLI
 test_files: []