cocoapods-entitlements-statistics 0.0.1

data/lib/cocoapods-entitlements-statistics/app_entitlements_statistics/mobile_provision.rb

@@ -0,0 +1,317 @@
+# frozen_string_literal: true
+
+require_relative 'core_ext/inflector'
+require_relative 'core_ext/try'
+
+require 'openssl'
+require 'cfpropertylist'
+
+module AppEntitlementsStatistics
+  
+  # .mobileprovision file parser
+  class MobileProvision
+    def initialize(path)
+      @path = path
+    end
+
+    def name
+      mobileprovision.try(:[], 'Name')
+    end
+
+    def app_name
+      mobileprovision.try(:[], 'AppIDName')
+    end
+
+    def type
+      return :development if development?
+      return :adhoc if adhoc?
+      return :appstore if appstore?
+      return :enterprise if enterprise?
+    end
+
+    def platforms
+      return unless platforms = mobileprovision.try(:[], 'Platform')
+
+      platforms.map do |v|
+        v = 'macOS' if v == 'OSX'
+        v.downcase.to_sym
+      end
+    end
+
+    def platform
+      platforms[0]
+    end
+
+    def devices
+      mobileprovision.try(:[], 'ProvisionedDevices')
+    end
+
+    def team_identifier
+      mobileprovision.try(:[], 'TeamIdentifier')
+    end
+
+    def team_name
+      mobileprovision.try(:[], 'TeamName')
+    end
+
+    def profile_name
+      mobileprovision.try(:[], 'Name')
+    end
+
+    def created_date
+      mobileprovision.try(:[], 'CreationDate')
+    end
+
+    def expired_date
+      mobileprovision.try(:[], 'ExpirationDate')
+    end
+
+    def entitlements
+      mobileprovision.try(:[], 'Entitlements')
+    end
+
+    def developer_certs
+      certs = mobileprovision.try(:[], 'DeveloperCertificates')
+      return if certs.empty?
+
+      certs.each_with_object([]) do |cert, obj|
+        obj << DeveloperCertificate.new(cert)
+      end
+    end
+
+    # Detect is development type of mobileprovision
+    #
+    # related link: https://stackoverflow.com/questions/1003066/what-does-get-task-allow-do-in-xcode
+    def development?
+      case platform.downcase.to_sym
+      when :ios
+        entitlements['get-task-allow'] == true
+      when :macos
+        !devices.nil?
+      else
+        raise Error, "Not implement with platform: #{platform}"
+      end
+    end
+
+    # Detect app store type
+    #
+    # related link: https://developer.apple.com/library/archive/qa/qa1830/_index.html
+    def appstore?
+      case platform.downcase.to_sym
+      when :ios
+        !development? && entitlements.key?('beta-reports-active')
+      when :macos
+        !development?
+      else
+        raise Error, "Not implement with platform: #{platform}"
+      end
+    end
+
+    def adhoc?
+      return false if platform == :macos # macOS no need adhoc
+
+      !development? && !devices.nil?
+    end
+
+    def enterprise?
+      return false if platform == :macos # macOS no need adhoc
+
+      !development? && !adhoc? && !appstore?
+    end
+    alias inhouse? enterprise?
+
+    # Enabled Capabilites
+    #
+    # Related link: https://developer.apple.com/help/account/reference/supported-capabilities-ios
+    def enabled_capabilities
+      capabilities = Hash.new
+      entitlements.each do |key, value|
+          case key
+          when 'com.apple.developer.game-center'
+              capabilities['Game Center'] = {
+                  key => value
+              }
+          when 'keychain-access-groups' 
+              capabilities['Keychain sharing'] =   {
+                  key => value
+              }
+          when 'aps-environment'
+              capabilities['Push Notifications'] = {
+                  key => value
+              }
+          when 'com.apple.developer.applesignin'
+              capabilities['Sign In with Apple'] = {
+                  key => value
+              }
+          when 'com.apple.developer.siri'
+              capabilities['SiriKit'] = {
+                  key => value
+              }
+          when 'com.apple.security.application-groups'
+              capabilities['App Groups'] = {
+                  key => value
+              }
+          when 'com.apple.developer.associated-domains'
+              capabilities['Associated Domains']  =  {
+                  key => value
+              }
+          when 'com.apple.developer.default-data-protection'
+              capabilities['Data Protection'] = {
+                  key => value
+              }
+          when 'com.apple.developer.networking.networkextension'
+              capabilities ['Network Extensions'] = {
+                  key => value
+              }
+          when 'com.apple.developer.networking.vpn.api'
+              capabilities ['Personal VPN'] =  {
+                  key => value
+              }
+          when 'com.apple.developer.healthkit',
+              'com.apple.developer.healthkit.access'
+              capabilities['HealthKit']  = {
+                  'com.apple.developer.healthkit' => entitlements['com.apple.developer.healthkit'],
+                  'com.apple.developer.healthkit.access' => entitlements['com.apple.developer.healthkit.access'],
+              } unless capabilities.include?('HealthKit')
+          when 'com.apple.developer.icloud-services',
+              'com.apple.developer.icloud-container-identifiers'
+              capabilities['iCloud']  = {
+                  'com.apple.developer.icloud-services' => entitlements['com.apple.developer.icloud-services'],
+                  'com.apple.developer.icloud-container-identifiers' => entitlements['com.apple.developer.icloud-container-identifiers'],
+              } unless capabilities.include?('iCloud')
+          when 'com.apple.developer.in-app-payments'
+              capabilities['Apple Pay'] = {
+                  key => value
+              }
+          when 'com.apple.developer.homekit'
+              capabilities['HomeKit'] =  {
+                  key => value
+              }
+          when 'com.apple.developer.user-fonts'
+              capabilities['Fonts'] = {
+                  key => value
+              }
+          when 'com.apple.developer.pass-type-identifiers'
+              capabilities['Wallet'] =  {
+                  key => value
+              }
+          when 'inter-app-audio'
+              capabilities['Inter-App Audio'] =  {
+                  key => value
+              }
+          when 'com.apple.developer.networking.multipath'
+              capabilities['Multipath'] = {
+                  key => value
+              }
+          when 'com.apple.developer.authentication-services.autofill-credential-provider'
+              capabilities['AutoFill Credential Provider'] = {
+                  key => value
+              }
+          when 'com.apple.developer.networking.wifi-info'
+              capabilities['Access WiFi Information'] = {
+                  key => value
+              }
+          when 'com.apple.external-accessory.wireless-configuration'
+              capabilities['Wireless Accessory Configuration'] = {
+                  key => value
+              }
+          when 'com.apple.developer.kernel.extended-virtual-addressing'
+              capabilities['Extended Virtual Address Space'] = {
+                  key => value
+              }
+          when 'com.apple.developer.nfc.readersession.formats'
+              capabilities['NFC Tag Reading'] =  {
+                  key => value
+              }
+          when 'com.apple.developer.ClassKit-environment'
+              capabilities['ClassKit'] =  {
+                  key => value
+              }
+          when 'com.apple.developer.networking.HotspotConfiguration'
+              capabilities['Hotspot'] =  {
+                  key => value
+              }
+          when 'com.apple.developer.devicecheck.appattest-environment'
+              capabilities['App Attest'] =  {
+                  key => value
+              }
+          when 'com.apple.developer.coremedia.hls.low-latency'
+              capabilities['Low Latency HLS'] =  {
+                  key => value
+              }
+          when 'com.apple.developer.associated-domains.mdm-managed'
+              capabilities['MDM Managed Associated Domains'] =  {
+                  key => value
+              }
+          end
+      end
+      capabilities
+    end
+
+
+    def [](key)
+      mobileprovision.try(:[], key.to_s)
+    end
+
+    def empty?
+      mobileprovision.nil?
+    end
+
+    def mobileprovision
+      return @mobileprovision = nil unless File.exist?(@path)
+
+      data = File.read(@path)
+      data = strip_plist_wrapper(data) unless bplist?(data)
+      list = CFPropertyList::List.new(data: data).value
+      @mobileprovision = CFPropertyList.native_types(list)
+    rescue CFFormatError
+      @mobileprovision = nil
+    end
+
+    def method_missing(method_name, *args, &block)
+      mobileprovision.try(:[], method_name.to_s.ai_camelcase) ||
+        mobileprovision.send(method_name) ||
+        super
+    end
+
+    def respond_to_missing?(method_name, *args)
+      mobileprovision.key?(method_name.to_s.ai_camelcase) ||
+        mobileprovision.respond_to?(method_name) ||
+        super
+    end
+
+    private
+
+    def bplist?(raw)
+      raw[0..5] == 'bplist'
+    end
+
+    def strip_plist_wrapper(raw)
+      end_tag = '</plist>'
+      start_point = raw.index('<?xml version=')
+      end_point = raw.index(end_tag) + end_tag.size - 1
+      raw[start_point..end_point]
+    end
+
+    # Developer Certificate
+    class DeveloperCertificate
+      attr_reader :raw
+
+      def initialize(data)
+        @raw = OpenSSL::X509::Certificate.new(data)
+      end
+
+      def name
+        @raw.subject.to_a.find { |name, _, _| name == 'CN' }[1].force_encoding('UTF-8')
+      end
+
+      def created_date
+        @raw.not_after
+      end
+
+      def expired_date
+        @raw.not_before
+      end
+    end
+  end
+end

data/lib/cocoapods-entitlements-statistics/gem_version.rb

@@ -0,0 +1,3 @@
+module CocoapodsEntitlementsStatistics
+  VERSION = "0.0.1"
+end

data/lib/cocoapods-entitlements-statistics/project_info.rb

@@ -0,0 +1,82 @@
+
+require 'cocoapods'
+
+module CocoapodsEntitlementsStatistics
+
+    class ProjectInfo
+        include Xcodeproj::Project::Object
+
+        attr_reader :project
+        attr_reader :load_success
+        attr_reader :tagret_name
+
+        def initialize 
+            load_xcodeproj
+        end
+
+        def load_xcodeproj_success?
+            return @load_success
+        end
+
+        def load_xcodeproj
+            xcodeprojects = Pathname.glob('**/*.xcodeproj').reject { |path| path.to_s.start_with?('Pods/') }        
+            if xcodeprojects.length == 1
+                @tagret_name = Pathname(xcodeprojects.first).basename('.xcodeproj')
+                @project = Xcodeproj::Project.open(xcodeprojects.first.realpath)
+                @load_success = true
+            else
+                @load_success = false
+                error_message = xcodeprojects.length > 1 ? 'found too many' : "couldn't find any"
+                projects = xcodeprojects.map(&:basename).join(' ')
+                Pod::UI.notice 'CocoaPods-Keys ' + error_message + ' Xcode projects (' + projects + '). Please give a name for this project.'        
+            end
+        end
+
+        def info_plist
+            info_plists = Pathname.glob('**/info.plist').reject { |path| !path.to_s.start_with?("#{@tagret_name}/") }
+            info_plist_path =  info_plists.length > 0 ? info_plists.first.realpath : "" 
+            info_plist_path
+        end
+
+        def entitlements_plist
+            entitlements_files = Pathname.glob("**/#{@tagret_name}.entitlements").reject { |path| !path.to_s.start_with?("#{@tagret_name}/") }
+            entitlements_path =  entitlements_files.length > 0 ? entitlements_files.first.realpath : "" 
+            entitlements_path
+        end
+
+        def project_release_config
+            return @release_configurations unless @release_configurations.nil?
+            @project.targets[0].build_configurations.each do |config|
+                if config.name == 'Release'
+                    @release_configurations = config
+                end
+            end
+            @release_configurations
+        end
+
+        def marketing_version
+            return nil unless !project_release_config.nil?
+            marketing_version = project_release_config.build_settings["MARKETING_VERSION"] 
+            marketing_version
+        end
+
+        def product_bundle_identifier
+            return nil unless !project_release_config.nil?
+            product_bundle_identifier = project_release_config.build_settings["PRODUCT_BUNDLE_IDENTIFIER"] 
+            product_bundle_identifier
+        end
+
+        def system_capabilities
+            target_attr_hash = @project.root_object.attributes["TargetAttributes"]
+            system_capabilities = Hash.new
+            target_attr_hash.each do |_,value|
+                if value.class == Hash && value.keys.include?("SystemCapabilities")
+                    system_capabilities = value["SystemCapabilities"]    
+                end
+            end
+            system_capabilities
+        end
+        
+    end
+
+end

data/lib/cocoapods-entitlements-statistics.rb

@@ -0,0 +1 @@
+require 'cocoapods-entitlements-statistics/gem_version'

data/lib/cocoapods_plugin.rb

@@ -0,0 +1,34 @@
+require "cocoapods-entitlements-statistics/app_entitlements_statistics/extracter"
+require "cocoapods-entitlements-statistics/app_entitlements_statistics/analyze"
+require "cocoapods-entitlements-statistics/project_info"
+require 'cocoapods'
+
+module CocoapodsEntitlementsStatistics
+
+    Pod::HooksManager.register('cocoapods-entitlements-statistics', :post_install) do |context,options|
+
+        project_info = ProjectInfo.new()
+
+        if project_info.load_xcodeproj_success?
+            args = {
+                "cur_version" => project_info.marketing_version,
+                "product_bundle_identifier" => project_info.product_bundle_identifier,
+                "info_plist_path" => project_info.info_plist,
+                "entitlements_path" => project_info.entitlements_plist,
+                "system_capabilities" => project_info.system_capabilities
+            }
+    
+            # extract_update 、analyze
+            extracter = AppEntitlementsStatistics::Extracter.new(args)
+            extracter.extract_update
+    
+            report_path = (!options.nil? && options.has_key?("report_path")) ? options[:report_path] : nil 
+            analyzer = AppEntitlementsStatistics::Analyzer.new(project_info.product_bundle_identifier, report_path: report_path )
+            
+            report_real_path = analyzer.analyze
+            Pod::UI.notice "Entitlements Statistics Report : #{File.expand_path(report_real_path)}" unless report_real_path.empty?
+        end
+
+    end
+
+end

data/spec/command/statistics_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+module Pod
+  describe Command::Statistics do
+    describe 'CLAide' do
+      it 'registers it self' do
+        Command.parse(%w{ statistics }).should.be.instance_of Command::Statistics
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+require 'pathname'
+ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+$:.unshift((ROOT + 'lib').to_s)
+$:.unshift((ROOT + 'spec').to_s)
+
+require 'bundler/setup'
+require 'bacon'
+require 'mocha-on-bacon'
+require 'pretty_bacon'
+require 'pathname'
+require 'cocoapods'
+
+Mocha::Configuration.prevent(:stubbing_non_existent_method)
+
+require 'cocoapods_plugin'
+
+#-----------------------------------------------------------------------------#
+
+module Pod
+
+  # Disable the wrapping so the output is deterministic in the tests.
+  #
+  UI.disable_wrap = true
+
+  # Redirects the messages to an internal store.
+  #
+  module UI
+    @output = ''
+    @warnings = ''
+
+    class << self
+      attr_accessor :output
+      attr_accessor :warnings
+
+      def puts(message = '')
+        @output << "#{message}\n"
+      end
+
+      def warn(message = '', actions = [])
+        @warnings << "#{message}\n"
+      end
+
+      def print(message)
+        @output << message
+      end
+    end
+  end
+end
+
+#-----------------------------------------------------------------------------#

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: cocoapods-entitlements-statistics
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- bin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: crimp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: CFPropertyList
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A short description of cocoapods-entitlements-statistics.
+email:
+- tang.bin@olaola.chat
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cocoapods-entitlements-statistics.gemspec
+- lib/cocoapods-entitlements-statistics.rb
+- lib/cocoapods-entitlements-statistics/app_entitlements_statistics/analyze.rb
+- lib/cocoapods-entitlements-statistics/app_entitlements_statistics/core_ext/inflector.rb
+- lib/cocoapods-entitlements-statistics/app_entitlements_statistics/core_ext/try.rb
+- lib/cocoapods-entitlements-statistics/app_entitlements_statistics/entitlements.rb
+- lib/cocoapods-entitlements-statistics/app_entitlements_statistics/extracter.rb
+- lib/cocoapods-entitlements-statistics/app_entitlements_statistics/helper.rb
+- lib/cocoapods-entitlements-statistics/app_entitlements_statistics/info_plist.rb
+- lib/cocoapods-entitlements-statistics/app_entitlements_statistics/mobile_provision.rb
+- lib/cocoapods-entitlements-statistics/gem_version.rb
+- lib/cocoapods-entitlements-statistics/project_info.rb
+- lib/cocoapods_plugin.rb
+- spec/command/statistics_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/EXAMPLE/cocoapods-entitlements-statistics
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+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: A longer description of cocoapods-entitlements-statistics.
+test_files:
+- spec/command/statistics_spec.rb
+- spec/spec_helper.rb