pprof 0.3.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b298d026ed403f21ea18ce7023b6a31369b749c1
-  data.tar.gz: 9dbfec58d992aa3d80decc8bbb3f8167f2839a0a
+  metadata.gz: 1e19ab5781df3a2fe5ddd41e85b937da9134941a
+  data.tar.gz: ec74aa8ec2cd3341756d38ab617839cb259d87ac
 SHA512:
-  metadata.gz: 4be4244290d618ceb0a91b23ef21d9d327dadee0840e4291ac8d854b8f2a137269099898fb8c1001f08863df9eeabd37609b58431cb1340a1e71110aad275c4a
-  data.tar.gz: f00597c5cf7be23cf250861d47c8ac3cb5e75a43b15440155733a405baf7b5e8a4603caf6489a5e601bea7c6338ee23aba632268c0b4652b1da13e1edde899c7
+  metadata.gz: fd233c67e41648c601af8a57ae712a2ad32dfbd8912ba71d062633afbb6dbddeadc32161d9f5d929213c4479dfe8a0479c38c10d42d9bd6485477a28754df261
+  data.tar.gz: df20d443af778ba98a8b44d44927a994dd94d97536369bfba77580e8740787c1a9ab593938a4000cf6ad6a667f18e42ab43a9f7ed5310a400dfecf95983e1e6c

data/README.md

@@ -2,6 +2,7 @@
 
 [![Twitter: @aligatr](https://img.shields.io/badge/contact-@aligatr-blue.svg?style=flat)](https://twitter.com/aligatr)
 [![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/AliSoftware/pprof/blob/master/LICENSE)
+[![Gem Version](https://badge.fury.io/rb/pprof.svg)](https://badge.fury.io/rb/pprof)
 
 `pprof` is a ruby library and binary to manipulate Provisioning Profiles.
 
@@ -11,8 +12,11 @@ It can help you create ruby scripts to list, get information, find and filter Pr
 
 ### Rubygems
 
-As of now this library is very early stage and [hasn't been pushed on RubyGems yet](https://github.com/AliSoftware/pprof/issues/4).
-I intend to push it as soon as [#2](https://github.com/AliSoftware/pprof/issues/4) (unit tests) and [#3](https://github.com/AliSoftware/pprof/issues/4) (CHANGELOG) are addressed.
+```sh
+$ gem install pprof
+```
+
+_(You might need to run this command with `sudo` if your gem home is a system directory)_
 
 ### Build from source
 

data/lib/pprof/entitlements.rb

@@ -1,60 +1,90 @@
+# Module for the pprof tool to manipulate Provisioning Profiles
 module PProf
+  # Represents the list of entitlements in a Provisioning Profile
   class Entitlements
+    # Create a new Entitlements object from the hash representation
+    # extracted from the Provisioning Profile
+    #
+    # @param [Hash] dict
+    #        The hash representation of the entitlements, typically
+    #        extracted from the Provisioning Profile.
     def initialize(dict)
       @dict = dict
     end
 
+    # The list of Keychain Access Groups
+    #
     # @return [Array<String>]
     def keychain_access_groups
       @dict['keychain-access-groups']
     end
 
+    # The status of the `get-task-allow` flag.
+    # True if we can attach a debugger to the executable, false if not.
+    #
     # @return [Bool]
     def get_task_allow
       @dict['get-task-allow']
     end
 
+    # The full application identifier (including the team prefix), as specified in the entitlements
+    #
     # @return [String]
     def app_id
       @dict['application-identifier']
     end
 
+    # The Team Identifier
+    #
     # @return [String]
     def team_id
       @dict['com.apple.developer.team-identifier']
     end
 
+    # The Apple Push Service environment used for push notifications.
+    # Typically either 'development' or 'production', or `nil` if push isn't enabled.
+    #
     # @return [String]
     def aps_environment
       @dict['aps-environment']
     end
 
+    # The Application Groups registered in the entitlements
+    #
     # @return [Array<String>]
     def app_groups
       @dict['com.apple.security.application-groups']
     end
 
+    # Are Beta (TestFlight) reports active?
+    #
     # @return [Bool]
     def beta_reports_active
       @dict['beta-reports-active']
     end
 
+    # True if the HealthKit entitlement is set
+    #
     # @return [Bool]
     def healthkit
       @dict['com.apple.developer.healthkit']
     end
 
+    # The Ubiquity Container identifiers, if at least one is enabled
+    #
     # @return [Array<String>]
     def ubiquity_container_identifiers
       @dict['com.apple.developer.ubiquity-container-identifiers']
     end
 
+    # The Ubiquity Key-Value Store Identifier, if enabled.
+    #
     # @return [String]
     def ubiquity_kvstore_identifier
       @dict['com.apple.developer.ubiquity-kvstore-identifier']
     end
 
-    # Access entitlements by key
+    # Generic access to any entitlement by key
     #
     # @param [#to_s] key
     #        The entitlement key to read
@@ -72,7 +102,7 @@ module PProf
       @dict.has_key?(key.to_s)
     end
 
-    # The list of entitlement keys as String
+    # The list of all entitlement keys, as String
     #
     # @return [Array<String>]
     #
@@ -80,10 +110,17 @@ module PProf
       @dict.keys.map(&:to_s)
     end
 
+    # The hash representation of the entitlements (as represented in their PLIST form)
+    #
+    # @return [Hash]
     def to_hash
       @dict
     end
 
+    # The pretty-printed list of all entitlement keys and values
+    # (as a multi-line dashed list for human reading)
+    #
+    # @return [String]
     def to_s
       @dict.map do |key, value|
         "- #{key}: #{value}"

data/lib/pprof/output_formatter.rb

@@ -1,4 +1,6 @@
+# Module for the pprof tool to manipulate Provisioning Profiles
 module PProf
+  # A helper tool to pretty-print Provisioning Profile informations
   class OutputFormatter
     # Initialize a new OutputFormatter
     #
@@ -12,16 +14,25 @@ module PProf
 
     # A small helper to print ASCII tables
     class ASCIITable
+      # Create a new ASCII table
+      #
+      # @param [Int...] widths
+      #        The list of width for each colum of the table
       def initialize(*widths)
         @widths = widths
       end
 
+      # Add a new row to the ASCII table
+      #
+      # @param [String...] cols
+      #        The content of each column of the row to add
       def row(*cols)
         '| ' + cols.zip(@widths).map do |c,w|
           (c || '<nil>').to_s.ljust(w)[0...w]
         end.join(' | ') + ' |'
       end
 
+      # Add a separator line to the ASCII table
       def separator
         '+' + @widths.map { |w| '-' * (w+2) }.join('+') + '+' 
       end

data/lib/pprof/provisioning_profile.rb

@@ -2,10 +2,22 @@ require 'openssl'
 require 'plist'
 require 'time'
 
+# Module for the pprof tool to manipulate Provisioning Profiles
 module PProf
+  # Represents the content of a Provisioning Profile file
   class ProvisioningProfile
+    # The default location where all the Provisioning Profiles are stored on a Mac
     DEFAULT_DIR="#{ENV['HOME']}/Library/MobileDevice/Provisioning Profiles"
 
+    # Create a new ProvisioningProfile object from a file path or UUID
+    #
+    # - If the parameter given has the form of an UUID, a file named with this UUID
+    #   and a `.mobileprovision` is searched in the default directory `DEFAULT_DIR`
+    # - Otherwise, the parameter is interpreted as a file path
+    #
+    # @param [String] file
+    #        File path or UUID of the ProvisioningProfile
+    #
     def initialize(file)
       if file =~ %r/^[0-9A-F-]*$/i
         path = "#{PProf::ProvisioningProfile::DEFAULT_DIR}/#{file}.mobileprovision"
@@ -17,77 +29,115 @@ module PProf
       @plist = Plist::parse_xml(pkcs7.data)
     end
 
+    # The name of the Provisioning Profile
+    #
     # @return [String]
     def name
       @plist['Name']
     end
 
+    # The UUID of the Provisioning Profile
+    #
     # @return [String]
     def uuid
       @plist['UUID']
     end
 
+    # The name of the Application Identifier associated with this Provisioning Profile
+    #
+    # @note This is not the AppID itself, but rather the name you associated to that
+    #       AppID in your Developer Portal
+    #
     # @return [String]
     def app_id_name
       @plist['AppIDName']
     end
 
+    # The AppID prefix (which is typically the ID of the team)
+    #
     # @return [String]
     def app_id_prefix
       @plist['ApplicationIdentifierPrefix']
     end
 
+    # The Creation date of this Provisioning Profile
+    #
     # @return [DateTime]
     def creation_date
       @plist['CreationDate']
     end
 
+    # The expiration date of this Provisioning Profile
+    #
     # @return [DateTime]
     def expiration_date
       @plist['ExpirationDate']
     end
 
+    # The Time-To-Live of this Provisioning Profile
     # @return [Int]
     def ttl
       @plist['TimeToLive'].to_i
     end
 
+    # The Team IDs associated with this Provisioning Profile
+    #
+    # @note typically Provisioning Profiles contain only one team
+    #
     # @return [Array<String>]
     def team_ids
       @plist['TeamIdentifier']
     end
     
+    # The name of the Team associated with this Provisioning Profile
+    #
     # @return [String]
     def team_name
       @plist['TeamName']
     end
 
-    # @return [Array<OpenSSL::X509::Certificate>] List of certificates associated with this profile
+    # The list of X509 Developer Certifiates associated with this profile
+    #
+    # @return [Array<OpenSSL::X509::Certificate>]
     def developer_certificates
       @plist['DeveloperCertificates'].map do |data|
         OpenSSL::X509::Certificate.new(data.string)
       end
     end
 
-    # @return [Entitlements] All the entitlements associated with this profile
+    # All the entitlements associated with this Provisioning Profile
+    #
+    # @return [Entitlements]
     def entitlements
       PProf::Entitlements.new(@plist['Entitlements'])
     end
 
-    # @return [Array<String>] List of provisioned devices if any
+    # The list of devices provisioned with this Provisioning Profile (if any)
+    #
+    # @return [Array<String>]
     def provisioned_devices
       @plist['ProvisionedDevices']
     end
 
+    # Indicates if this Provisioning Profile is provisioned for all devices
+    # or only for a list of some specific devices
+    #
     # @return [Bool]
     def provisions_all_devices
       @plist['ProvisionsAllDevices'] || false
     end
 
+    # The hash representation of this Provisioning Profile
+    #
+    # @return [Hash]
     def to_hash
       @dict
     end
 
+    # The human-readable string representation of this Provisioning Profile
+    # Typically suitable for printing this Provisioning Profile information to the user.
+    #
+    # @return [String]
     def to_s
       lines = [:name, :uuid, :app_id_name, :app_id_prefix, :creation_date, :expiration_date, :ttl, :team_ids, :team_name].map do |key|
         "- #{key.to_s}: #{self.send(key.to_sym)}"

data/lib/pprof/version.rb

@@ -1,3 +1,4 @@
 module PProf
-  VERSION = '0.3.2'
+  # Module version
+  VERSION = '0.3.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pprof
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.4
 platform: ruby
 authors:
 - Olivier Halligon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-09 00:00:00.000000000 Z
+date: 2016-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist
@@ -39,7 +39,7 @@ files:
 - lib/pprof/output_formatter.rb
 - lib/pprof/provisioning_profile.rb
 - lib/pprof/version.rb
-homepage: http://rubygems.org/gems/pp
+homepage: https://github.com/AliSoftware/pprof
 licenses:
 - MIT
 metadata: {}