fastlane-plugin-google_data_safety 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 40b801d950ef2c54b5dff6015bf2ff90f77b502c509408c8bd51538c0eca0948
+  data.tar.gz: f469686cb3772ab11d328d4891b8e8e4aa30a7a744de9e94b99919d68822495a
+SHA512:
+  metadata.gz: d65d43564f78fcc032356047b3ae7a6053d3fadae44d78ab8d92c26b786e8799d27c71d021b7acb5528544477cb8a878a5e3c6e9e32413be0c287e3e57ed7576
+  data.tar.gz: 600b3413608be49ff72fcd0abd115a452c0a8e862f11d9c9ed0fd95e6e37ebf4dba98eb952c91a8a33712d01a08e7891f30ead1f22527cd0d540dd78ff859886

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Owen Bean <owenbean400@gmail.com>
+
+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/README.md

@@ -0,0 +1,52 @@
+# google_data_safety plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-data_safety)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-google_data_safety`, add it to your project by running:
+
+```bash
+fastlane add_plugin google_data_safety
+```
+
+## About google_data_safety
+
+Google safety data sheet for automation of safety form
+
+**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+
+**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/google_data_safety/actions/upload_google_data_safety_action.rb

@@ -0,0 +1,184 @@
+require 'fastlane/action'
+require 'googleauth'
+require_relative '../helper/upload_google_data_safety_helper'
+require 'net/http'
+require 'json'
+
+module Fastlane
+  module Actions
+    class UploadGoogleDataSafetyAction < Action
+      def self.run(params)
+
+        csv_content = self.csv_file_content(params: params)
+
+        service_account_data = self.service_account_authentication(params: params)
+
+        body = self.get_google_auth(service_account_json: service_account_data)
+
+        access_token = body["access_token"]
+
+        self.send_data_safety_sheet(package_name: params[:package_name], auth_token: access_token, csv_content: csv_content)
+
+      end
+
+      def self.csv_file_content(params: nil)
+        unless params[:csv_file] || params[:csv_content]
+          if UI.interactive?
+            UI.important("To not be asked about this value, you can specify it using 'csv_file'")
+            csv_file_path = UI.input("The csv file used for Google data safety sheet: ")
+            csv_file_path = File.expand_path(csv_file_path)
+
+            UI.user_error!("Could not find csv file at path '#{csv_file_path}'") unless File.exist?(csv_file_path)
+            params[:csv_file]
+          else
+            UI.user_error!("Could not obtain data safety information as comma separated values. Please have 'csv_file' or 'csv_content' variable set.")
+          end
+        end
+
+        csv_file_content = ""
+
+        if params[:csv_file]
+          csv_file_content = File.read(File.expand_path(params[:csv_file]))
+        elsif params[:csv_content]
+          csv_file_content = params[:csv_content]
+        end
+
+        csv_file_content
+      end
+
+      def self.service_account_authentication(params: nil)
+        unless params[:json_key] || params[:json_key_data]
+          if UI.interactive?
+            UI.important("To not be asked about this value, you can specify it using 'json_key'")
+            json_key_path = UI.input("The service account json file used to authenticate with Google: ")
+            json_key_path = File.expand_path(json_key_path)
+
+            UI.user_error!("Could not find service account json file at path '#{json_key_path}'") unless File.exist?(json_key_path)
+            params[:json_key] = json_key_path
+          else
+            UI.user_error!("Could not load Google authentication. Make sure it has been added as an environment variable in 'json_key' or 'json_key_data'")
+          end
+        end
+
+        if params[:json_key]
+          service_account_json = File.open(File.expand_path(params[:json_key]))
+        elsif params[:json_key_data]
+          service_account_json = StringIO.new(params[:json_key_data])
+        end
+
+        service_account_json
+      end
+
+      def self.get_google_auth(service_account_json: nil)
+        scope = 'https://www.googleapis.com/auth/androidpublisher'
+
+        auth = Google::Auth::ServiceAccountCredentials.make_creds(json_key_io: service_account_json, scope: scope)
+
+        token = auth.fetch_access_token!
+
+        token
+      end
+
+      def self.send_data_safety_sheet(package_name: nil, auth_token: nil, csv_content: nil)
+        if package_name.nil?
+          if UI.interactive?
+            UI.important("To not be asked package name, you can specify it using 'package_name'.")
+            package_name_input = UI.input("The package name to upload Google safety data sheet: ")
+            package_name = package_name_input
+          else
+            UI.Error("Package name is required to upload Google safety data sheet. Please specify package name with 'package_name' variable.")
+          end
+        end
+
+        uri = URI("https://androidpublisher.googleapis.com/androidpublisher/v3/applications/#{package_name}/dataSafety")
+
+        request = Net::HTTP::Post.new(uri)
+        request["Authorization"] = "Bearer #{auth_token}"
+        request["Content-Type"] = "application/json"
+        request.body = { safetyLabels: csv_content }.to_json
+
+        response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme = 'https') do | http |
+          http.request(request)
+        end
+
+        if response.is_a?(Net::HTTPSuccess)
+          UI.success("Google Safety Data sheet has been uploaded!")
+        else
+          if response.is_a?(Net::HTTPUnauthorized)
+            UI.error("Unauthorized request to upload Google Data Safety sheet.")
+          elsif response.is_a?(Net::HTTPBadRequest)
+            UI.error("Bad request to upload Google Data Safety sheet.")
+          else
+            UI.error("Google Data Safety sheet upload error with API")
+          end
+        end
+
+      end
+
+      def self.description
+        "Google safety data sheet for automation of safety form"
+      end
+
+      def self.authors
+        ["Owen Bean"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "Uploads and update any data safety sheet on Google Play Console API."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :csv_file,
+            env_name: "CSV_FILE",
+            description: "Csv file path to upload to Google Play Console Data Safety",
+            optional: true,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :csv_content,
+            env_name: "CSV_CONTENT",
+            description: "Comma delimited list of Google Data Safety form",
+            optional: true,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :package_name,
+            env_name: "PACKAGE_NAME",
+            description: "Package name of project",
+            optional: false,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :json_key,
+            env_name: "JSON_KEY_FILE",
+            description: "Json key file for service account authentication",
+            optional: true,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :json_key_data,
+            env_name: "JSON_KEY_DATA",
+            description: "Json key data for service account authentication",
+            optional: true,
+            type: Hash
+          ),
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/google_data_safety/helper/upload_google_data_safety_helper.rb

@@ -0,0 +1,16 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
+
+  module Helper
+    class GoogleDataSafetyHelper
+      # class methods that you define here become available in your action
+      # as `Helper::DataSafetyHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the data_safety plugin helper!")
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/google_data_safety/version.rb

@@ -0,0 +1,5 @@
+module Fastlane
+  module GoogleDataSafety
+    VERSION = "0.1.2"
+  end
+end

data/lib/fastlane/plugin/google_data_safety.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/google_data_safety/version'
+
+module Fastlane
+  module GoogleDataSafety
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::GoogleDataSafety.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-google_data_safety
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Owen Bean
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: googleauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+description: 
+email: owenbean400@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/google_data_safety.rb
+- lib/fastlane/plugin/google_data_safety/actions/upload_google_data_safety_action.rb
+- lib/fastlane/plugin/google_data_safety/helper/upload_google_data_safety_helper.rb
+- lib/fastlane/plugin/google_data_safety/version.rb
+homepage: 
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Google safety data sheet for automation of safety form
+test_files: []