read_ipa 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0aa9fcadc0cb606734c8de9894defea9862e2efe
+  data.tar.gz: 5829b9607ef440c25f6cdade87a4c8adcc50ebd5
+SHA512:
+  metadata.gz: 11161be4ed6136ef3138966596fff2252e431cbc7a750feea76e66c9a8c770c23ecdbea39ed5673f70ec4e7c1f2cfa6732ab1d94f609a4bf39c4536d467e1890
+  data.tar.gz: ee7c5a3960a7bc7728fcd3f5fb34f6f1a016aa48d75e45cca725ed17b48c883b94bed324604c84378a6bd414cf3f578f44848a3a1f13d116cfb873c5412249a1

data/README.md

@@ -0,0 +1,70 @@
+# read_ipa [![Build Status](https://travis-ci.org/playtestcloud/read_ipa.png?branch=master)](https://travis-ci.org/playtestcloud/read_ipa) [![Gem Version](https://badge.fury.io/rb/read_ipa.png)](http://badge.fury.io/rb/read_ipa)
+
+Reads metadata form iPhone Package Archive Files (ipa).
+
+## USAGE
+
+```bash
+irb > require 'rubygems'
+ => true
+irb > require 'read_ipa'
+ => true
+irb > ipa_file = ReadIpa::IpaFile.new("/path/to/file.ipa")
+ => #<ReadIpa::IpaFile:0x1012a9458>
+irb > ipa_file.version
+ => "1.2.2.4"
+irb > ipa_file.name
+ => "MultiG"
+irb > ipa_file.target_os_version
+ => "4.1"
+irb > ipa_file.minimum_os_version
+ => "3.1"
+irb > ipa_file.url_schemes
+ => []
+irb > ipa_file.bundle_identifier
+ => "com.dcrails.multig"
+irb > ipa_file.icon_prerendered
+ => false
+```
+
+## Supported ruby versions
+
+* 1.9 **NOT SUPPORTED**
+* 2.0
+* 2.1
+* 2.2
+
+## INSTALL
+
+`gem install read_ipa`
+
+## Contributors
+
+* [@schlu](//github.com/schlu)
+* [@yayanet](//github.com/yayanet)
+* [@mwhuss](//github.com/mwhuss)
+
+## LICENSE
+
+(The MIT License)
+
+Copyright (c) 2010
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task default: :test

data/lib/read_ipa/plist_binary.rb

@@ -0,0 +1,33 @@
+begin
+  require 'cfpropertylist'
+rescue LoadError
+  require 'rubygems'
+  require 'cfpropertylist'
+end
+
+# Adds to_rb functionality to return native ruby types rather than CFTypes
+module CFPropertyList
+  class CFDictionary
+    def to_rb
+      hash_data = {}
+      value.keys.each do |key|
+        hash_data[key] = value[key].to_hash
+      end
+      hash_data
+    end
+  end
+  class CFType
+    def to_hash
+      self.value
+    end
+  end
+  class CFArray
+    def to_hash
+      hash_data = []
+      value.each do |obj|
+        hash_data << obj.to_hash
+      end
+      hash_data
+    end
+  end
+end

data/lib/read_ipa/png_file.rb

@@ -0,0 +1,113 @@
+# direct port of python code at https://gist.github.com/4141831#file_ipin.py
+require 'zlib'
+
+module ReadIpa
+  class PngFile
+    attr_accessor :raw_data, :width, :height
+
+    def initialize(oldPNG)
+      # begin
+        self.raw_data = extract_apple_png(oldPNG)
+      # rescue
+      #  self.width, self.height = oldPNG[0x10..0x18].unpack('NN')
+      #  self.raw_data = oldPNG
+      # end
+    end
+
+    def extract_apple_png(oldPNG)
+      pngheader = "\x89PNG\r\n\x1A\n".b
+
+      if oldPNG[0...8] != pngheader
+        return nil
+      end
+
+      newPNG = oldPNG[0...8]
+
+      chunkPos = newPNG.length
+
+      idatAcc = "".b
+      breakLoop = false
+
+      # For each chunk in the PNG file
+      while chunkPos < oldPNG.length
+        skip = false
+
+        # Reading chunk
+        chunkLength = oldPNG[chunkPos...chunkPos+4]
+        chunkLength = chunkLength.unpack("N")[0]
+        chunkType = oldPNG[chunkPos+4...chunkPos+8]
+        chunkData = oldPNG[chunkPos+8...chunkPos+8+chunkLength]
+        chunkCRC = oldPNG[chunkPos+chunkLength+8...chunkPos+chunkLength+12]
+        chunkCRC = chunkCRC.unpack("N")[0]
+        chunkPos += chunkLength + 12
+
+        # Parsing the header chunk
+        if chunkType == "IHDR".b
+          self.width = chunkData[0...4].unpack("N")[0]
+          self.height = chunkData[4...8].unpack("N")[0]
+        end
+
+        # Parsing the image chunk
+        if chunkType == "IDAT".b
+          # Store the chunk data for later decompression
+          idatAcc += chunkData
+          skip = true
+        end
+
+        # Removing CgBI chunk
+        if chunkType == "CgBI".b
+          skip = true
+        end
+
+        # Stopping the PNG file parsing
+        if chunkType == "IEND".b
+          # Uncompressing the image chunk
+          inf = Zlib::Inflate.new(-Zlib::MAX_WBITS)
+          chunkData = inf.inflate(idatAcc)
+          inf.finish
+          inf.close
+
+          chunkType = "IDAT".b
+
+          # Swapping red & blue bytes for each pixel
+          newdata = "".b
+
+          self.height.times do
+            i = newdata.length
+            newdata += chunkData[i..i].to_s
+            self.width.times do
+              i = newdata.length
+              newdata += chunkData[i+2..i+2].to_s
+              newdata += chunkData[i+1..i+1].to_s
+              newdata += chunkData[i+0..i+0].to_s
+              newdata += chunkData[i+3..i+3].to_s
+            end
+          end
+
+          # Compressing the image chunk
+          chunkData = newdata
+          chunkData = Zlib::Deflate.deflate( chunkData )
+          chunkLength = chunkData.length
+          chunkCRC = Zlib.crc32(chunkType)
+          chunkCRC = Zlib.crc32(chunkData, chunkCRC)
+          chunkCRC = (chunkCRC + 0x100000000) % 0x100000000
+          breakLoop = true
+        end
+
+        if !skip
+          newPNG += [chunkLength].pack("N")
+          newPNG += chunkType
+          if chunkLength > 0
+            newPNG += chunkData
+          end
+          newPNG += [chunkCRC].pack("N")
+        end
+
+        break if breakLoop
+      end
+
+      return newPNG
+    end
+
+  end
+end

data/lib/read_ipa.rb

@@ -0,0 +1,109 @@
+begin
+  require 'zip/zip'
+rescue LoadError
+  require 'rubygems'
+  require 'zip/zip'
+end
+
+require 'read_ipa/plist_binary'
+require 'read_ipa/png_file'
+
+module ReadIpa
+  class IpaFile
+    attr_accessor :plist, :file_path
+    def initialize(file_path)
+      self.file_path = file_path
+      @app_folder = Zip::ZipFile.foreach(file_path).find { |e| /.*\.app\/$/ =~ e.to_s }.to_s
+      @zipfile = Zip::ZipFile.open(file_path)
+
+      cf_plist = CFPropertyList::List.new(data: @zipfile.read(@app_folder + "Info.plist"), format: CFPropertyList::List::FORMAT_AUTO)
+      self.plist = cf_plist.value.to_rb
+    end
+
+    def version
+      plist["CFBundleVersion"]
+    end
+
+    def short_version
+      plist["CFBundleShortVersionString"]
+    end
+
+    def name
+      plist["CFBundleDisplayName"]
+    end
+
+    def target_os_version
+      plist["DTPlatformVersion"].match(/[\d\.]*/)[0]
+    end
+
+    def minimum_os_version
+      plist["MinimumOSVersion"].match(/[\d\.]*/)[0]
+    end
+
+    def url_schemes
+      if plist["CFBundleURLTypes"] && plist["CFBundleURLTypes"][0] && plist["CFBundleURLTypes"][0]["CFBundleURLSchemes"]
+        plist["CFBundleURLTypes"][0]["CFBundleURLSchemes"]
+      else
+        []
+      end
+    end
+
+    def icon_file
+      if plist["CFBundleIconFiles"]
+        highest_res_icon = plist["CFBundleIconFiles"]
+          .map{ |icon|
+            data = read_file(icon)
+            ReadIpa::PngFile.new(data)
+          }
+          .sort{ |a,b| b.width <=> a.width }
+          .first
+        highest_res_icon.raw_data
+      elsif plist["CFBundleIconFile"]
+        data = read_file(plist["CFBundleIconFile"])
+        png = ReadIpa::PngFile.new(data)
+        png.raw_data
+      else
+        nil
+      end
+    end
+
+    def executable_file_name
+      plist["CFBundleExecutable"]
+    end
+
+    def executable_file
+      read_file(executable_file_name)
+    end
+
+    def mobile_provision_file
+      read_file("embedded.mobileprovision")
+    end
+
+    def bundle_identifier
+      plist["CFBundleIdentifier"]
+    end
+
+    def icon_prerendered
+      plist["UIPrerenderedIcon"] == true
+    end
+
+    def for_ipad?
+      return true if plist["UIDeviceFamily"] && (plist["UIDeviceFamily"] == 2 || plist["UIDeviceFamily"].include?(2))
+      return true if plist["UIDeviceFamily"] && (plist["UIDeviceFamily"] == "2" || plist["UIDeviceFamily"].include?("2"))
+      return false
+    end
+
+    def for_iphone?
+      return true if !plist["UIDeviceFamily"]
+      return true if plist["UIDeviceFamily"] == 1 || plist["UIDeviceFamily"].include?(1)
+      return true if plist["UIDeviceFamily"] == "1" || plist["UIDeviceFamily"].include?("1")
+      return false
+    end
+
+    private
+
+    def read_file(entry)
+      @zipfile.read(@app_folder + entry)
+    end
+  end
+end

data/test/test_read_ipa.rb

@@ -0,0 +1,68 @@
+require 'minitest/autorun'
+require 'digest'
+require 'read_ipa'
+
+class ReadIpaTest < Minitest::Test
+  def setup
+    @ipa_file = ReadIpa::IpaFile.new(File.dirname(__FILE__) + '/MultiG.ipa')
+  end
+
+  def test_parse
+    assert(@ipa_file.plist.keys.count > 0)
+  end
+
+  def test_version
+    assert_equal(@ipa_file.version, "1.2.2.4")
+  end
+
+  def test_short_version
+    # asserting nil because the test file doesn't have this key
+    assert_nil(@ipa_file.short_version)
+  end
+
+  def test_name
+    assert_equal(@ipa_file.name, "MultiG")
+  end
+
+  def test_target_os_version
+    assert_equal(@ipa_file.target_os_version, "4.1")
+  end
+
+  def test_minimum_os_version
+    assert_equal(@ipa_file.minimum_os_version, "3.1")
+  end
+
+  def test_url_schemes
+    assert_equal(@ipa_file.url_schemes, [])
+  end
+
+  def test_bundle_identifier
+    assert_equal("com.dcrails.multig", @ipa_file.bundle_identifier)
+  end
+
+  def test_icon_prerendered
+    assert_equal(false, @ipa_file.icon_prerendered)
+  end
+
+  def test_icon
+    assert_equal("56b1eecad1cb7046b2e944dcd90fa74b77187f2cb4c766d7bb328ad86c37ca04",
+                 Digest::SHA256::hexdigest(@ipa_file.icon_file))
+  end
+
+  def test_executable_file_name
+    assert_equal("MultiG", @ipa_file.executable_file_name)
+  end
+
+  def test_executable_file
+    assert_equal("227e5272684846d7c8193dbe0995a2df62314d11a069608831f5d38d51ee9c7a",
+                 Digest::SHA256::hexdigest(@ipa_file.executable_file))
+  end
+
+  def test_for_iphone
+    assert_equal(true, @ipa_file.for_iphone?)
+  end
+
+  def test_for_ipad
+    assert_equal(true, @ipa_file.for_ipad?)
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: read_ipa
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Marvin Killing
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-22 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+- !ruby/object:Gem::Dependency
+  name: CFPropertyList
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+description: Extract metadata from iOS packages such as the app name, the app icons
+  or the binary file. This is a diverging fork of github.com/schlu/Ipa-Reader.
+email: marvinkilling@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/read_ipa.rb
+- lib/read_ipa/plist_binary.rb
+- lib/read_ipa/png_file.rb
+- test/test_read_ipa.rb
+homepage: https://github.com/playtestcloud/read_ipa
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Read metadata from iOS IPA package files
+test_files:
+- test/test_read_ipa.rb