app-info 3.0.0.beta1 → 3.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35509386f8425f29ea466dbcb1ce12cf54be230f9b4668d4ad2f5ac9b4a4b1b5
-  data.tar.gz: 6f3f87d116877fd058a9f479de6b0aa789d74c255f832f5db132446e6250b82e
+  metadata.gz: f8ca25ba9f5e54dc762996f1b7393593393b29adcbe0622131a905aa2f494141
+  data.tar.gz: c2839b1ac586397d1f76833fd9b4947722892ae584d8942ccb8e0d706f207210
 SHA512:
-  metadata.gz: b62671980b8d9e7a854523e24311af90e78b807023b65aa1d417159717c3119c34beef4e589638d3fa3708820c8732a1c82859f8b2194477a90548dfd0611b0a
-  data.tar.gz: dc22e6f681b64658bacd6206c3cb7bdceb4afac7fac9332af230563930d8df24da1b95336647c25f7f84537c7716804d5d27e7409baa08b30e5f436e3a505c16
+  metadata.gz: cb08a20e764b4c8c35c7c03f43c3472b89cf0ebf34889080ef28c52e97c51b8700c91d09acd073cf21ece653c19beab34ecfc4b0477a5c534d23314bb503ff83
+  data.tar.gz: c7aa998b3224be94bbb20589fe57906356e93788739383d89703fafd1856f0eca948c33d046561460400590bf727fcd633f98edcfb321f11d740bbe00aa48aa2

data/.rubocop.yml

@@ -31,6 +31,8 @@ Layout/LineLength:
   Max: 100
   Exclude:
     - 'lib/app_info/helper/signatures.rb'
+    - 'lib/app_info/android/signatures/info.rb'
+    - 'lib/app_info/apk.rb'
 
 Lint/AssignmentInCondition:
   Enabled: false

data/CHANGELOG.md

@@ -9,21 +9,44 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 > List all changes before release a new version.
 
-## [3.0.0.beta1] (2023-04-?)
+## [3.0.0.beta3] (2023-04-05)
+
+### Added
+
+- Android parser `.icons` method add exclude param to filter icons.
+
+### Changed
+
+- Rename `.platform` to `.manufacturer`, rename `.opera_sytem` to `.platform` for all parsers.
+
+### Fixed
+
+- Minor fixes.
+
+## [3.0.0.beta2] (2023-04-04)
+
+### Changed
+
+- Re-organize categories `.platform`, `.opera_sytem` and `.device` for all parsers. [#58](https://github.com/icyleaf/app_info/pull/58)
+- Change ExportType values type to symbol both IPA and macOS parsers. [#58](https://github.com/icyleaf/app_info/pull/58)
+
+## [3.0.0.beta1] (2023-04-04)
 
 ### Added
 
 - New Windows PE format parser. [#47](https://github.com/icyleaf/app_info/pull/47)
 - Android parser add v2, v3 scheme signature support. [#55](https://github.com/icyleaf/app_info/pull/55]
 - dSYM parer accept multi dSYM target in a zip file. [#56](https://github.com/icyleaf/app_info/pull/56)
+- Better document for yardoc.
 
 ### Changed
 
 - Add `AppInfo::File` base class for all parsers.
 - Add `AppInfo::Certifiate` X509 certificate wrapped and apply in Android/MobileProvision.
-- Remove `AppInfo::MobileProvision::DeveloperCertificate` class, use `AppInfo::Certifiate` instead.
 - Remove `.sign_version` method in Android parser.
+- Rename `.file_type` to `.format` method in all parers and return a `AppInfo::Format` type.
 - Remove duplice `AppInfo::AndroidDevice` class.
+- Remove `AppInfo::MobileProvision::DeveloperCertificate` class, use `AppInfo::Certifiate` instead.
 - Deprecate `.signs` and `.certifiates` methods in Android parser, use `.signatures` instead.
 - Deprecate `.developer_certs` method in MobileProvision parser, use `.certificates` instead.
 
@@ -269,7 +292,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - Updated dependency of CFPropertly list be a range between 2.3.4. (thanks @[cschroed](https://github.com/cschroed))
 
-[Unreleased]: https://github.com/icyleaf/app-info/compare/v2.8.5..HEAD
+[Unreleased]: https://github.com/icyleaf/app-info/compare/v3.0.0.beta3..HEAD
+[3.0.0.beta3]: https://github.com/icyleaf/app-info/compare/v3.0.0.beta2...v3.0.0.beta3
+[3.0.0.beta2]: https://github.com/icyleaf/app-info/compare/v3.0.0.beta1...v3.0.0.beta2
+[3.0.0.beta1]: https://github.com/icyleaf/app-info/compare/v2.8.5...v3.0.0.beta1
 [2.8.5]: https://github.com/icyleaf/app-info/compare/v2.8.4...v2.8.5
 [2.8.4]: https://github.com/icyleaf/app-info/compare/v2.8.3...v2.8.4
 [2.8.3]: https://github.com/icyleaf/app-info/compare/v2.8.2...v2.8.3

data/README.md

@@ -1,9 +1,9 @@
-# app_info
+# app-info
 
-[![Language](https://img.shields.io/badge/ruby-2.5+-701516.svg)](.github/workflows/ci.yml)
+[![Language](https://img.shields.io/badge/ruby-2.5+-701516)](.github/workflows/ci.yml)
+[![Gem version](https://img.shields.io/gem/v/app-info?include_prereleases)](https://rubygems.org/gems/app-info)
 [![Build Status](https://img.shields.io/github/actions/workflow/status/icyleaf/app_info/ci.yml)](https://github.com/icyleaf/app_info/actions/workflows/ci.yml)
-[![Gem version](https://img.shields.io/gem/v/app-info.svg?style=flat)](https://rubygems.org/gems/app_info)
-[![License](https://img.shields.io/badge/license-MIT-red.svg?style=flat)](LICENSE)
+[![License](https://img.shields.io/github/license/icyleaf/app-info)](LICENSE)
 
 Teardown tool for mobile app (ipa, apk and aab file), macOS app, dSYM.zip file and Windows PE file.
 Analysis metedata like version, name, icon etc.

data/lib/app_info/aab.rb

@@ -1,53 +1,23 @@
 # frozen_string_literal: true
 
 require 'app_info/protobuf/manifest'
-require 'image_size'
-require 'forwardable'
 
 module AppInfo
   # Parse APK file parser
-  class AAB < File
-    include Helper::HumanFileSize
-    extend Forwardable
-
-    attr_reader :file
-
-    # APK Devices
-    module Device
-      PHONE       = 'Phone'
-      TABLET      = 'Tablet'
-      WATCH       = 'Watch'
-      TV          = 'Television'
-      AUTOMOTIVE  = 'Automotive'
-    end
-
+  class AAB < Android
     BASE_PATH = 'base'
     BASE_MANIFEST = "#{BASE_PATH}/manifest/AndroidManifest.xml"
     BASE_RESOURCES = "#{BASE_PATH}/resources.pb"
 
-    # 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] {Format::AAB}
-    def file_type
-      Format::AAB
-    end
-
-    # @return [String] {Platform::ANDROID}
-    def platform
-      Platform::ANDROID
-    end
-
+    # @!method version_name
+    #   @see Protobuf::Manifest#version_name
+    #   @return [String]
+    # @!method deep_links
+    #   @see Protobuf::Manifest#deep_links
+    #   @return [String]
+    # @!method schemes
+    #   @see Protobuf::Manifest#schemes
+    #   @return [String]
     def_delegators :manifest, :version_name, :deep_links, :schemes
 
     alias release_version version_name
@@ -70,43 +40,6 @@ module AppInfo
       manifest.label
     end
 
-    # @return [String] {Device}
-    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
-    # Found answer but not works: https://stackoverflow.com/questions/9279111/determine-if-the-device-is-a-smartphone-or-tablet
-    # def tablet?
-    #   resource.first_package
-    #           .entries('bool')
-    #           .select{|e| e.name == 'isTablet' }
-    #           .size >= 1
-    # end
-
-    # @return [Boolean]
-    def wear?
-      !!use_features&.include?('android.hardware.type.watch')
-    end
-
-    # @return [Boolean]
-    def tv?
-      !!use_features&.include?('android.software.leanback')
-    end
-
-    # @return [Boolean]
-    def automotive?
-      !!use_features&.include?('android.hardware.type.automotive')
-    end
-
     # @return [String]
     def min_sdk_version
       manifest.uses_sdk.min_sdk_version
@@ -132,39 +65,21 @@ module AppInfo
       @use_permissions ||= manifest&.uses_permission&.map(&:name)
     end
 
+    # @return [Protobuf::Node]
     def activities
       @activities ||= manifest.activities
     end
 
+    # @return [Protobuf::Node]
     def services
       @services ||= manifest.services
     end
 
+    # @return [Protobuf::Node]
     def components
       @components ||= manifest.components.transform_values
     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
-
     def each_file
       zip.each do |entry|
         next unless entry.file?
@@ -187,6 +102,7 @@ module AppInfo
       entry
     end
 
+    # @return [Protobuf::Manifest]
     def manifest
       io = zip.read(zip.find_entry(BASE_MANIFEST))
       @manifest ||= Protobuf::Manifest.parse(io, resource)
@@ -198,19 +114,49 @@ module AppInfo
       @resource ||= Protobuf::Resources.parse(io)
     end
 
-    # @return [Zip::File]
-    def zip
-      @zip ||= Zip::File.open(@file)
-    end
-
-    # @return [Array<Hash>]
-    def icons
+    # Full icons metadata
+    # @example full icons
+    #   aab.icons
+    #   # => [
+    #   #   {
+    #   #     name: 'ic_launcher.png',
+    #   #     file: '/path/to/ic_launcher.webp',
+    #   #     dimensions: [29, 29]
+    #   #   },
+    #   #   {
+    #   #     name: 'ic_launcher.png',
+    #   #     file: '/path/to/ic_launcher.png',
+    #   #     dimensions: [120, 120]
+    #   #   },
+    #   #   {
+    #   #     name: 'ic_launcher.xml',
+    #   #     file: '/path/to/ic_launcher.xml',
+    #   #     dimensions: [nil, nil]
+    #   #   },
+    #   # ]
+    # @example exclude xml icons
+    #   aab.icons(filter: :xml)
+    #   # => [
+    #   #   {
+    #   #     name: 'ic_launcher.png',
+    #   #     file: '/path/to/ic_launcher.webp',
+    #   #     dimensions: [29, 29]
+    #   #   },
+    #   #   {
+    #   #     name: 'ic_launcher.png',
+    #   #     file: '/path/to/ic_launcher.png',
+    #   #     dimensions: [120, 120]
+    #   #   }
+    #   # ]
+    # @param [String, Symbol, Array<Symbol, Array>] filter filter file extension name
+    # @return [Array<Hash{Symbol => String, Array<Integer>}>] icons paths of icons
+    def icons(exclude: nil)
       @icons ||= manifest.icons.each_with_object([]) do |res, obj|
         path = res.value
         filename = ::File.basename(path)
         filepath = ::File.join(contents, ::File.dirname(path))
         file = ::File.join(filepath, filename)
-        FileUtils.mkdir_p filepath
+        FileUtils.mkdir_p(filepath)
 
         binary_data = read_file(path)
         ::File.write(file, binary_data, encoding: Encoding::BINARY)
@@ -221,6 +167,8 @@ module AppInfo
           dimensions: ImageSize.path(file).size
         }
       end
+
+      extract_icon(@icons, exclude: exclude)
     end
 
     def clear!
@@ -235,18 +183,13 @@ module AppInfo
       @info = nil
     end
 
-    def contents
-      @contents ||= ::File.join(Dir.mktmpdir, "AppInfo-android-#{SecureRandom.hex}")
+    # @return [Zip::File]
+    def zip
+      @zip ||= Zip::File.open(@file)
     end
 
     private
 
-    def v1sign
-      @v1sign ||= Android::Signature::V1.verify(self)
-    rescue Android::Signature::NotFoundError
-      nil
-    end
-
     def xml_file?(file)
       ::File.extname(file) == '.xml'
     end

data/lib/app_info/android/signature.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module AppInfo
-  module Android
+  class Android < File
     # Android Signature
     #
     # Support digest and length:
@@ -15,10 +15,10 @@ module AppInfo
       class NotFoundError < NotFoundError; end
 
       module Version
-        V1    = 1
-        V2    = 2
-        V3    = 3
-        V4    = 4
+        V1 = 1
+        V2 = 2
+        V3 = 3
+        V4 = 4
       end
 
       # All registerd verions to verify

data/lib/app_info/android/signatures/base.rb

@@ -2,43 +2,47 @@
 
 require 'app_info/android/signatures/info'
 
-module AppInfo::Android::Signature
-  class Base
-    def self.verify(parser)
-      instance = new(parser)
-      instance.verify
-      instance
-    end
-
-    DESCRIPTION = 'APK Signature Scheme'
-
-    attr_reader :verified
-
-    def initialize(parser)
-      @parser = parser
-      @verified = false
-    end
-
-    # @abstract Subclass and override {#verify} to implement
-    def verify
-      raise NotImplementedError, ".#{__method__} method implantation required in #{self.class}"
-    end
-
-    # @abstract Subclass and override {#certificates} to implement
-    def certificates
-      raise NotImplementedError, ".#{__method__} method implantation required in #{self.class}"
-    end
-
-    def scheme
-      "v#{version}"
-    end
-
-    def description
-      "#{DESCRIPTION} #{scheme}"
-    end
-
-    def logger
-      @parser.logger
+module AppInfo
+  class Android < File
+    module Signature
+      class Base
+        def self.verify(parser)
+          instance = new(parser)
+          instance.verify
+          instance
+        end
+
+        DESCRIPTION = 'APK Signature Scheme'
+
+        attr_reader :verified
+
+        def initialize(parser)
+          @parser = parser
+          @verified = false
+        end
+
+        # @abstract Subclass and override {#verify} to implement
+        def verify
+          raise NotImplementedError, ".#{__method__} method implantation required in #{self.class}"
+        end
+
+        # @abstract Subclass and override {#certificates} to implement
+        def certificates
+          raise NotImplementedError, ".#{__method__} method implantation required in #{self.class}"
+        end
+
+        def scheme
+          "v#{version}"
+        end
+
+        def description
+          "#{DESCRIPTION} #{scheme}"
+        end
+
+        def logger
+          @parser.logger
+        end
+      end
     end
   end
 end