headdesk 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 684f9db7853042da5d0dc68f50c3e877659095a0
-  data.tar.gz: f50419d5e71a6780ddcddcbb8e53d058aac43fce
+  metadata.gz: baa239641bcf15d4fada12d0909b5f9e6e3bf006
+  data.tar.gz: '082b47e0e4093a7deffda1ad64034f41e091f718'
 SHA512:
-  metadata.gz: afe0253dbdfc88f878e745127e2e72d04194b4ce0256d8548f559b7cb50cd360ae3853214b0914d75347fbd10156f5f0e3c93035a38ec0d0e49f8f4079f696f5
-  data.tar.gz: 333dec843afb4976d39d766450dacbaa665f4d78a4a963d6e97deeef9ea0a44a6d41cd9789a32daf45c8a6bdeafca3eddd8a818e260d0cbc64dc1e64dad49088
+  metadata.gz: b9a255eda983eac233626efd5edd88cc72b027200937abf7466e7cccaf8f2b54f2f7663543f57a22f078396197eb2b2d39f53f8ac8a44c0e532b364d296c4c26
+  data.tar.gz: 4af639f3ac6e3cc687b8d810eba3f1854b124ecc718215d377fd2ae8ac7e4f9a81a79cf5188695f58119dd3b6bed8cec6a002b9dd6e0a02669052d5cf5404540

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    headdesk (0.3.0)
+    headdesk (0.5.0)
       awesome_print (~> 1.8)
       nokogiri (~> 1.10)
       thor (~> 0.20)
@@ -27,7 +27,7 @@ GEM
     jaro_winkler (1.5.1)
     kwalify (0.7.2)
     mini_portile2 (2.4.0)
-    nokogiri (1.10.0)
+    nokogiri (1.10.1)
       mini_portile2 (~> 2.4.0)
     parallel (1.12.1)
     parser (2.5.3.0)

data/README.md

@@ -15,6 +15,14 @@ This is output from the check that ensures that the version of the Facebook SDK
 
 `headdesk` can also output to JSON.
 
+## Checks
+* [api26](docs/api26.md)
+* [facebook](docs/facebook.md)
+* [receiver](docs/receiver.md)
+* [teak/api21_icon](docs/teak/api21_icon.md)
+* [teak/caching](docs/teak/caching.md)
+* [teak/configuration](docs/teak/configuration.md)
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/docs/api26.md

@@ -0,0 +1,14 @@
+# api26
+Ensures that the APK is built with `targetSdkVersion` at least 26.
+
+## Will Fail If
+* `targetSdkVersion` is less than 26.
+
+## Exports
+None.
+
+## Reason
+As of November 1, 2018 Google Play requires that all apps, and app updates, target Android 8 (API 26).
+
+> Google Play will require that new apps target at least Android 8.0 (API level 26) from August 1, 2018, and that app updates target Android 8.0 from November 1, 2018.
+Source: https://developer.android.com/distribute/best-practices/develop/target-sdk

data/docs/facebook.md

@@ -0,0 +1,30 @@
+# facebook
+Ensure that the version of the Facebook SDK in use has been released in the last two years.
+
+## Will Skip If
+* The APK does not include the Facebook SDK (`com.facebook.FacebookSdk` class is not present).
+
+## Will Fail If
+* The Facebook SDK version was not released in the last two years.
+
+## Exports
+The version information of the included Facebook SDK.
+
+### Example
+```json
+{
+  "facebook_sdk": {
+    "major": 4,
+    "minor": 33,
+    "patch": 0,
+    "version": "4.33.0",
+    "date": "2018-05-01"
+  }
+}
+```
+
+## Reason
+Facebook deprecates their SDKs two years after release.
+
+> Core APIs and SDKs are central to the Facebook Platform offered to developers. These elements are subject to a version system, and guarantee that anything considered a core API node, field, edge, dialog, SDK or SDK method will remain available and unchanged for at least two years from the launch of that version.
+Source: https://developers.facebook.com/docs/apps/versions/

data/docs/receiver.md

@@ -0,0 +1,28 @@
+# receiver
+Ensures that each `<receiver>` declared in the `AndroidManifest.xml` points to a Java class which is present in the APK.
+
+## Will Fail If
+* Any `<receiver>` points to a Java class that does not exist in the APK.
+
+## Exports
+The recievers present in `AndroidManifest.xml`
+
+### Example
+```json
+{
+  "receivers": [
+    {
+      "name": "com.amazon.device.iap.ResponseReceiver"
+    },
+    {
+      "name": "io.teak.sdk.Teak"
+    },
+    {
+      "name": "com.facebook.CurrentAccessTokenExpirationBroadcastReceiver"
+    }
+  ]
+}
+```
+
+## Reason
+Frequently, during app updates, build settings will change, or an SDK will be removed but the `<receiver>` inside of the `AndroidManifest.xml` will not get updated or removed. This causes the app to crash.

data/docs/teak/api21_icon.md

@@ -0,0 +1,24 @@
+# teak/api21_icon
+Ensures that the APK contains a notification icon for both Android 5+ (API 21+) as well as pre-Android 5, and that these are different icons.
+
+## Will Skip If
+* The Teak SDK is not present.
+
+## Will Fail If
+* There is no drawable resource for `io_teak_small_notification_icon`.
+* There is no v21 drawable resource for `io_teak_small_notification_icon`
+* The drawable resources point to the same image.
+
+## Exports
+The values for `io_teak_small_notification_icon` for less than v21, and v21+.
+
+### Example
+```json
+{
+  "icon": null,
+  "icon_v21": "@drawable/icon_white"
+}
+```
+
+## Reason
+Android 5+ uses [Material Design](https://material.io/design/iconography/#notification) and needs a white and transparant icon for proper display of notification icons in the tray.

data/docs/teak/caching.md

@@ -0,0 +1,18 @@
+# teak/caching
+Ensures that the APK contains a notification icon for both Android 5+ (API 21+) as well as pre-Android 5, and that these are different icons.
+
+## Will Skip If
+* The Teak SDK is not present.
+* The version of the Teak SDK is greater or equal to 2.0.0.
+
+## Will Fail If
+* `io_teak_enable_caching` is not specified.
+* `io_teak_enable_caching` is not set to `true`.
+
+## Exports
+None.
+
+## Reason
+The Teak SDK uses [Android HTTP Caching](https://developer.android.com/training/efficient-downloads/redundant_redundant#ResponseCache) to prevent downloading redundant Notification assets.
+
+The `io_teak_enable_caching` setting allows you to disable this behavior, however it should be enabled unless your app, or an SDK that you use, makes uncommon assumptions.

data/docs/teak/configuration.md

@@ -0,0 +1,29 @@
+# teak/configuration
+Ensures that the APK properly configures the Teak SDK.
+
+## Will Skip If
+* The Teak SDK is not present.
+
+## Will Fail If
+* `io_teak_app_id` is not specified.
+* `io_teak_api_key` is not specified.
+* `gcm_defaultSenderId` or `io_teak_gcm_sender_id` are not specified.
+* `gcm_defaultSenderId` and `io_teak_gcm_sender_id` are specified, and set to different values.
+* The version of the Teak SDK is greater or equal to 2.0.0 and...
+    * `google_app_id` or `io_teak_firebase_app_id` are not specified.
+    * `google_app_id` and `io_teak_firebase_app_id` are specified, and set to different values.
+
+## Exports
+The configuration values for the Teak SDK.
+
+### Example
+```json
+{
+  "teak_app_id": "1234567890123456",
+  "teak_api_key": "abcdef1234567890abcdef1234567890",
+  "gcm_sender_id": "123456789012"
+}
+```
+
+## Reason
+Build configuration errors can cause

data/lib/headdesk/check.rb

@@ -35,6 +35,10 @@ module Headdesk
         @check_name = cname if cname
         @check_name
       end
+
+      def doc
+        "#{check_name}.md"
+      end
     end
 
     def initialize(bundle)
@@ -46,6 +50,7 @@ module Headdesk
         export: {}
       }
       @report[:name] = self.class.check_name if self.class.respond_to?(:check_name)
+      @report[:doc] = "https://github.com/GoCarrot/headdesk/blob/#{Headdesk::VERSION}/docs/#{self.class.doc}" if self.class.respond_to?(:check_name)
       @status = :skip
     end
 

data/lib/headdesk/checks/teak.rb

@@ -25,7 +25,7 @@ module Headdesk
           end
 
           def check_name(cname = nil)
-            cname = "teak.#{cname}" if cname
+            cname = "teak/#{cname}" if cname
             super(cname)
           end
         end

data/lib/headdesk/report.rb

@@ -34,12 +34,16 @@ module Headdesk
       }
     end
 
+    def link
+      "\e[37;4m%s\e[0m"
+    end
+
     def to_s
       ERB.new(<<~DESCRIPTION, nil, '>').result(binding)
         Bundle Id: <%= bundle_id %>\n
         <%= describe %>\n
         <% for @check in checks %>
-          <%= color_for_status[@check[:status]] % icon_for_status[@check[:status]] %> <%= color_for_status[@check[:status]] % (@check[:description] + " (" + @check[:name] + ")") %>\n
+          <%= color_for_status[@check[:status]] % icon_for_status[@check[:status]] %> <%= color_for_status[@check[:status]] % @check[:description] %> (<%= link % @check[:doc] %>)\n
           <% for @step in @check[:steps] %>
             ↳ <%= color_for_status[@step[:status]] % icon_for_status[@step[:status]] %> <%= color_for_status[@step[:status]] % @step[:description] %>\n
           <% end %>

data/lib/headdesk/version.rb

@@ -2,5 +2,5 @@
 
 module Headdesk
   APKTOOL_VERSION = '2.3.4'
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: headdesk
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Pat Wilson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-15 00:00:00.000000000 Z
+date: 2019-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,6 +128,12 @@ files:
 - bin/console
 - bin/facebook_sdk_versions
 - bin/setup
+- docs/api26.md
+- docs/facebook.md
+- docs/receiver.md
+- docs/teak/api21_icon.md
+- docs/teak/caching.md
+- docs/teak/configuration.md
 - exe/headdesk
 - ext/apktool_2.3.4.jar
 - headdesk.gemspec