app-info 2.8.5 → 3.0.0.beta2

data/lib/app_info/android.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+require 'app_info/android/signature'
+require 'image_size'
+require 'forwardable'
+
+module AppInfo
+  # Android base parser for apk and aab file
+  class Android < File
+    extend Forwardable
+    include Helper::HumanFileSize
+
+    # return file size
+    # @example Read file size in integer
+    #   aab.size                    # => 3618865
+    #
+    # @example Read file size in human readabale
+    #   aab.size(human_size: true)  # => '3.45 MB'
+    #
+    # @param [Boolean] human_size Convert integer value to human readable.
+    # @return [Integer, String]
+    def size(human_size: false)
+      file_to_human_size(@file, human_size: human_size)
+    end
+
+    # @return [Symbol] {Platform}
+    def platform
+      Platform::GOOGLE
+    end
+
+    # @return [Symbol] {OperaSystem}
+    def opera_system
+      OperaSystem::ANDROID
+    end
+
+    # @return [Symbol] {Device}
+    def device
+      if watch?
+        Device::WATCH
+      elsif television?
+        Device::TELEVISION
+      elsif automotive?
+        Device::AUTOMOTIVE
+      elsif tablet?
+        Device::TABLET
+      else
+        Device::PHONE
+      end
+    end
+
+    # @abstract Subclass and override {#name} to implement.
+    def name
+      not_implemented_error!(__method__)
+    end
+
+    # @todo find a way to detect, no way!
+    # @see https://stackoverflow.com/questions/9279111/determine-if-the-device-is-a-smartphone-or-tablet
+    # @return [Boolean] false always false
+    def tablet?
+      # Not works!
+      # resource.first_package
+      #         .entries('bool')
+      #         .select{|e| e.name == 'isTablet' }
+      #         .size >= 1
+      false
+    end
+
+    # @return [Boolean]
+    def watch?
+      !!use_features&.include?('android.hardware.type.watch')
+    end
+
+    # @return [Boolean]
+    def television?
+      !!use_features&.include?('android.software.leanback')
+    end
+
+    # @return [Boolean]
+    def automotive?
+      !!use_features&.include?('android.hardware.type.automotive')
+    end
+
+    # @abstract Subclass and override {#use_features} to implement.
+    def use_features
+      not_implemented_error!(__method__)
+    end
+
+    # @abstract Subclass and override {#use_permissions} to implement.
+    def use_permissions
+      not_implemented_error!(__method__)
+    end
+
+    # @abstract Subclass and override {#use_permissions} to implement.
+    def activities
+      not_implemented_error!(__method__)
+    end
+
+    # @abstract Subclass and override {#use_permissions} to implement.
+    def services
+      not_implemented_error!(__method__)
+    end
+
+    # @abstract Subclass and override {#use_permissions} to implement.
+    def components
+      not_implemented_error!(__method__)
+    end
+
+    # Return multi version certifiates of signatures
+    # @return [Array<Hash>] signatures
+    # @see AppInfo::Android::Signature.verify
+    def signatures
+      @signatures ||= Android::Signature.verify(self)
+    end
+
+    # Legacy v1 scheme signatures, it will remove soon.
+    # @deprecated Use {#signatures}
+    # @return [Array<OpenSSL::PKCS7, nil>] signatures
+    def signs
+      @signs ||= v1sign&.signatures || []
+    end
+
+    # Legacy v1 scheme certificates, it will remove soon.
+    # @deprecated Use {#signatures}
+    # @return [Array<OpenSSL::PKCS7, nil>] certificates
+    def certificates
+      @certificates ||= v1sign&.certificates || []
+    end
+
+    # @abstract Subclass and override {#manifest} to implement.
+    def manifest
+      not_implemented_error!(__method__)
+    end
+
+    # @abstract Subclass and override {#resource} to implement.
+    def resource
+      not_implemented_error!(__method__)
+    end
+
+    # @abstract Subclass and override {#zip} to implement.
+    def zip
+      not_implemented_error!(__method__)
+    end
+
+    # @abstract Subclass and override {#clear!} to implement.
+    def clear!
+      not_implemented_error!(__method__)
+    end
+
+    # @return [String] contents path of contents
+    def contents
+      @contents ||= ::File.join(Dir.mktmpdir, "AppInfo-android-#{SecureRandom.hex}")
+    end
+
+    protected
+
+    def v1sign
+      @v1sign ||= Android::Signature::V1.verify(self)
+    rescue Android::Signature::NotFoundError
+      nil
+    end
+  end
+end

data/lib/app_info/apk.rb

@@ -1,41 +1,36 @@
 # frozen_string_literal: true
 
 require 'ruby_apk'
-require 'image_size'
-require 'forwardable'
 
 module AppInfo
-  # Parse APK file
-  class APK
-    include Helper::HumanFileSize
-    extend Forwardable
-
-    attr_reader :file
-
-    # APK Devices
-    module Device
-      PHONE       = 'Phone'
-      TABLET      = 'Tablet'
-      WATCH       = 'Watch'
-      TV          = 'Television'
-      AUTOMOTIVE  = 'Automotive'
-    end
-
-    def initialize(file)
-      @file = file
-    end
-
-    def size(human_size: false)
-      file_to_human_size(@file, human_size: human_size)
-    end
-
-    def os
-      Platform::ANDROID
-    end
-    alias file_type os
-
+  # Parse APK file parser, wrapper for {https://github.com/icyleaf/android_parser android_parser}.
+  class APK < Android
+    # @!method manifest
+    #   @see https://rubydoc.info/gems/android_parser/Android/Apk#manifest-instance_method ::Android::Apk#manifest
+    # @!method resource
+    #   @see https://rubydoc.info/gems/android_parser/Android/Apk#resource-instance_method ::Android::Apk#resource
+    # @!method dex
+    #   @see https://rubydoc.info/gems/android_parser/Android/Apk#dex-instance_method ::Android::Apk#dex
     def_delegators :apk, :manifest, :resource, :dex
 
+    # @!method version_name
+    #   @see https://rubydoc.info/gems/android_parser/Android/Manifest#version_name-instance_method  ::Android::Manifest#version_name
+    # @!method package_name
+    #   @see https://rubydoc.info/gems/android_parser/Android/Manifest#package_name-instance_method  ::Android::Manifest#package_name
+    # @!method target_sdk_versionx
+    #   @see https://rubydoc.info/gems/android_parser/Android/Manifest#target_sdk_versionx-instance_method  ::Android::Manifest#target_sdk_version
+    # @!method components
+    #   @see https://rubydoc.info/gems/android_parser/Android/Manifest#components-instance_method  ::Android::Manifest#components
+    # @!method services
+    #   @see https://rubydoc.info/gems/android_parser/Android/Manifest#services-instance_method  ::Android::Manifest#services
+    # @!method use_permissions
+    #   @see https://rubydoc.info/gems/android_parser/Android/Manifest#use_permissions-instance_method  ::Android::Manifest#use_permissions
+    # @!method use_features
+    #   @see https://rubydoc.info/gems/android_parser/Android/Manifest#use_features-instance_method  ::Android::Manifest#use_features
+    # @!method deep_links
+    #   @see https://rubydoc.info/gems/android_parser/Android/Manifest#deep_links-instance_method ::Android::Manifest#deep_links
+    # @!method schemes
+    #   @see https://rubydoc.info/gems/android_parser/Android/Manifest#schemes-instance_method ::Android::Manifest#schemes
     def_delegators :manifest, :version_name, :package_name, :target_sdk_version,
                    :components, :services, :use_permissions, :use_features,
                    :deep_links, :schemes
@@ -53,78 +48,50 @@ module AppInfo
       manifest.label || resource.find('@string/app_name')
     end
 
-    def device_type
-      if wear?
-        Device::WATCH
-      elsif tv?
-        Device::TV
-      elsif automotive?
-        Device::AUTOMOTIVE
-      else
-        Device::PHONE
-      end
-    end
-
-    # TODO: find a way to detect, no way!
-    # def tablet?
-    # end
-
-    def wear?
-      use_features.include?('android.hardware.type.watch')
-    end
-
-    def tv?
-      use_features.include?('android.software.leanback')
-    end
-
-    def automotive?
-      use_features.include?('android.hardware.type.automotive')
-    end
-
+    # @return [String]
     def min_sdk_version
       manifest.min_sdk_ver
     end
     alias min_os_version min_sdk_version
 
-    def sign_version
-      return 'v1' unless signs.empty?
-
-      # when ?
-      # https://source.android.com/security/apksigning/v2?hl=zh-cn
-      #   'v2'
-      # when ?
-      # https://source.android.com/security/apksigning/v3?hl=zh-cn
-      #   'v3'
-      'unknown'
-    end
-
-    def signs
-      apk.signs.each_with_object([]) do |(path, sign), obj|
-        obj << Sign.new(path, sign)
-      end
-    end
-
-    def certificates
-      apk.certificates.each_with_object([]) do |(path, certificate), obj|
-        obj << Certificate.new(path, certificate)
-      end
-    end
-
+    # @return [String]
     def activities
       components.select { |c| c.type == 'activity' }
     end
 
+    # @return [::Android::Apk]
     def apk
       @apk ||= ::Android::Apk.new(@file)
     end
 
+    # @return [Zip::File]
+    def zip
+      @zip ||= apk.instance_variable_get(:@zip)
+    end
+
+    # Full icons metadata
+    # @example
+    #   apk.icons
+    #   # => [
+    #   #   {
+    #   #     name: 'icon.png',
+    #   #     file: '/path/to/icon.png',
+    #   #     dimensions: [29, 29]
+    #   #   },
+    #   #   {
+    #   #     name: 'icon1.png',
+    #   #     file: '/path/to/icon1.png',
+    #   #     dimensions: [120, 120]
+    #   #   }
+    #   # ]
+    # @return [Array<Hash{Symbol => String, Array<Integer>}>] icons paths of icons
     def icons
       @icons ||= apk.icon.each_with_object([]) do |(path, data), obj|
-        icon_name = File.basename(path)
-        icon_path = File.join(contents, File.dirname(path))
-        icon_file = File.join(icon_path, icon_name)
+        icon_name = ::File.basename(path)
+        icon_path = ::File.join(contents, ::File.dirname(path))
+        icon_file = ::File.join(icon_path, icon_name)
         FileUtils.mkdir_p icon_path
-        File.write(icon_file, data, encoding: Encoding::BINARY)
+        ::File.write(icon_file, data, encoding: Encoding::BINARY)
 
         obj << {
           name: icon_name,
@@ -145,29 +112,5 @@ module AppInfo
       @app_path = nil
       @info = nil
     end
-
-    def contents
-      @contents ||= File.join(Dir.mktmpdir, "AppInfo-android-#{SecureRandom.hex}")
-    end
-
-    # Android Certificate
-    class Certificate
-      attr_reader :path, :certificate
-
-      def initialize(path, certificate)
-        @path = path
-        @certificate = certificate
-      end
-    end
-
-    # Android Sign
-    class Sign
-      attr_reader :path, :sign
-
-      def initialize(path, sign)
-        @path = path
-        @sign = sign
-      end
-    end
   end
 end

data/lib/app_info/apple.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+require 'macho'
+require 'fileutils'
+require 'forwardable'
+require 'cfpropertylist'
+
+module AppInfo
+  # Apple base parser for ipa and macos file
+  class Apple < File
+    extend Forwardable
+    include Helper::HumanFileSize
+    include Helper::Archive
+
+    # Export types
+    module ExportType
+      # debug configuration
+      DEBUG = :debug
+      # adhoc configuration (iOS only)
+      ADHOC = :adhoc
+      # enterprise configuration (iOS only)
+      ENTERPRISE = :enterprise
+      # release configuration
+      RELEASE = :release
+      # release configuration but download from App Store
+      APPSTORE = :appstore
+    end
+
+    # @return [Symbol] {Platform}
+    def platform
+      Platform::APPLE
+    end
+
+    # return file size
+    # @example Read file size in integer
+    #   aab.size                    # => 3618865
+    #
+    # @example Read file size in human readabale
+    #   aab.size(human_size: true)  # => '3.45 MB'
+    #
+    # @param [Boolean] human_size Convert integer value to human readable.
+    # @return [Integer, String]
+    def size(human_size: false)
+      file_to_human_size(@file, human_size: human_size)
+    end
+
+    # @!method device
+    #   @see InfoPlist#device
+    # @!method opera_system
+    #   @see InfoPlist#opera_system
+    # @!method iphone?
+    #   @see InfoPlist#iphone?
+    # @!method ipad?
+    #   @see InfoPlist#ipad?
+    # @!method universal?
+    #   @see InfoPlist#universal?
+    # @!method build_version
+    #   @see InfoPlist#build_version
+    # @!method name
+    #   @see InfoPlist#name
+    # @!method release_version
+    #   @see InfoPlist#release_version
+    # @!method identifier
+    #   @see InfoPlist#identifier
+    # @!method bundle_id
+    #   @see InfoPlist#bundle_id
+    # @!method display_name
+    #   @see InfoPlist#display_name
+    # @!method bundle_name
+    #   @see InfoPlist#bundle_name
+    # @!method min_sdk_version
+    #   @see InfoPlist#min_sdk_version
+    # @!method min_os_version
+    #   @see InfoPlist#min_os_version
+    def_delegators :info, :device, :opera_system, :iphone?, :ipad?, :universal?, :macos?,
+                   :build_version, :name, :release_version, :identifier, :bundle_id,
+                   :display_name, :bundle_name, :min_sdk_version, :min_os_version
+
+    # @!method devices
+    #   @see MobileProvision#devices
+    # @!method team_name
+    #   @see MobileProvision#team_name
+    # @!method team_identifier
+    #   @see MobileProvision#team_identifier
+    # @!method profile_name
+    #   @see MobileProvision#profile_name
+    # @!method expired_date
+    #   @see MobileProvision#expired_date
+    def_delegators :mobileprovision, :devices, :team_name, :team_identifier,
+                   :profile_name, :expired_date
+
+    # @return [String, nil]
+    def distribution_name
+      "#{profile_name} - #{team_name}" if profile_name && team_name
+    end
+
+    # @return [String]
+    def release_type
+      if stored?
+        ExportType::APPSTORE
+      else
+        build_type
+      end
+    end
+
+    # return iOS build configuration, not correct in macOS app.
+    # @return [String]
+    def build_type
+      if mobileprovision?
+        return ExportType::RELEASE if macos?
+
+        devices ? ExportType::ADHOC : ExportType::ENTERPRISE
+      else
+        ExportType::DEBUG
+      end
+    end
+
+    # @return [Array<MachO>, nil]
+    def archs
+      return unless ::File.exist?(binary_path)
+
+      file = MachO.open(binary_path)
+      case file
+      when MachO::MachOFile
+        [file.cpusubtype]
+      else
+        file.machos.each_with_object([]) do |arch, obj|
+          obj << arch.cpusubtype
+        end
+      end
+    end
+    alias architectures archs
+
+    # @abstract Subclass and override {#icons} to implement.
+    def icons(_uncrush: true)
+      not_implemented_error!(__method__)
+    end
+
+    # @abstract Subclass and override {#stored?} to implement.
+    def stored?
+      not_implemented_error!(__method__)
+    end
+
+    # force remove developer certificate data from {#mobileprovision} method
+    # @return [nil]
+    def hide_developer_certificates
+      mobileprovision.delete('DeveloperCertificates') if mobileprovision?
+    end
+
+    # @return [MobileProvision]
+    def mobileprovision
+      return unless mobileprovision?
+
+      @mobileprovision ||= MobileProvision.new(mobileprovision_path)
+    end
+
+    # @return [Boolean]
+    def mobileprovision?
+      ::File.exist?(mobileprovision_path)
+    end
+
+    # @abstract Subclass and override {#mobileprovision_path} to implement.
+    def mobileprovision_path
+      not_implemented_error!(__method__)
+    end
+
+    # @return [InfoPlist]
+    def info
+      @info ||= InfoPlist.new(info_path)
+    end
+
+    # @abstract Subclass and override {#info_path} to implement.
+    def info_path
+      not_implemented_error!(__method__)
+    end
+
+    # @abstract Subclass and override {#app_path} to implement.
+    def app_path
+      not_implemented_error!(__method__)
+    end
+
+    # @abstract Subclass and override {#clear!} to implement.
+    def clear!
+      not_implemented_error!(__method__)
+    end
+
+    # @return [String] contents path of contents
+    def contents
+      @contents ||= unarchive(@file, prefix: format.to_s)
+    end
+  end
+end