fastlane-plugin-deploy_file_provider 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99c1e4b27dbd9a788554a42d914e996e6212b44c
+  data.tar.gz: f3a37c6a4c1e34a5a092808b19a330590829e5fb
+SHA512:
+  metadata.gz: e44d0be528e915fa72d38821f41121913a85b481efed8fa131a624397e10f44dc3ff7dd3133a6156e52cbe6a7d9217a3b3e6a677d21e186d3c0a7a6b3e9ee635
+  data.tar.gz: 7667c0939c34510fef679ed9bb56e9edc99bbda24433527a93741d622636b11d56627720af2ca32b89f3e0deedff9f8b36780dcae0beb6bede76e2975c5bec52

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kamil Krzyk <krzyk.kamil@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 @@
+# deploy_file_provider plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-deploy_file_provider)
+
+## Getting Started
+
+This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-deploy_file_provider`, add it to your project by running:
+
+```bash
+fastlane add_plugin deploy_file_provider
+```
+
+## About deploy_file_provider
+
+Prepares metadata files with structure ready for AppStore, PlayStore deploy
+
+**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://github.com/fastlane/fastlane/blob/master/fastlane/docs/PluginsTroubleshooting.md) doc in the main `fastlane` repo.
+
+## Using `fastlane` Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Plugins.md).
+
+## About `fastlane`
+
+`fastlane` is the easiest way to automate building and releasing your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/deploy_file_provider/actions/deploy_file_provider_action.rb

@@ -0,0 +1,296 @@
+require 'json'
+
+module Fastlane
+  module Actions
+
+    class MetaData
+      attr_accessor :description, :language, :releaseNotesiOS, :releaseNotesAndroid
+    end
+
+    class DeployFileProviderAction < Action
+      RUN_VARIANT_ANDROID = "android"
+      RUN_VARIANT_IOS = "ios"
+
+      JSON_DIR = "fastlane/"
+      JSON_NAME = "update.json"
+
+
+      ANDROID_ROOT = "fastlane/metadata/android/"
+
+      ANDROID_CHANGELOG_DIR = "changelogs/"
+      #ANDROID_CHANGELOG_FILENAME -> changes depending on build, fetched from api
+
+      ANDROID_FULL_DESCRIPTION_DIR = ""
+      ANDROID_FULL_DESCRIPTION_FILENAME = "full_description.txt"
+
+      ANDROID_METADATA_LOC = {
+        "german"               => "de-DE/",
+        "english"              => "en-GB/",
+        "spanish"              => "es-ES/",
+        "french"               => "fr-FR/",
+        "italian"              => "it-IT/",
+        "polish"               => "pl-PL/",
+        "portugese"            => "pt-PT/",
+        "romanian"             => "ro/",
+        "russian"              => "ru-RU/",
+        "turkish"              => "tr-TR/"
+      } 
+
+
+      IOS_ROOT = "fastlane/metadata/"
+
+      IOS_RELEASE_NOTES_DIR = ""
+      IOS_RELEASE_NOTES_FILENAME = "release_notes.txt"
+
+      IOS_DESCRIPTION_DIR = ""
+      IOS_DESCRIPTION_FILENAME = "description.txt"
+
+      IOS_METADATA_LOC = {
+        "german"               => "de-DE/",
+        "english"              => "en-GB/",
+        "spanish"              => "es-ES/",
+        "french"               => "fr-FR/",
+        "italian"              => "it/",
+        "portugese"            => "pt-PT/",
+        "russian"              => "ru/",
+        "turkish"              => "tr/"
+      } 
+
+      def self.run(params)
+        logStep("Attempting to fetch JSON with metadata updates.")
+        countryMetaData = fetchMetadataUpdates(params)
+
+        if countryMetaData.empty?
+          throwError("Couldn't fetch metadata updates. Plugin won't run!")
+        else
+          logStep("Fetch successfull!")
+
+          platform = "#{params[:platform]}".downcase
+          if platform.eql? RUN_VARIANT_ANDROID
+            logStep("The deploy_file_provider plugin runs for platform: " + platform + ".")
+            prepareFilesFor_Android(params, countryMetaData)
+          elsif platform.eql? RUN_VARIANT_IOS
+            logStep("The deploy_file_provider plugin runs for platform: " + platform + ".")
+            prepareFilesFor_iOS(countryMetaData)
+          else
+            throwError("Unknown platform. Plugin won't run!") 
+          end
+        end
+      end
+
+      def self.fetchMetadataUpdates(params) 
+        descriptionsArray = Helper::DeployFileProviderHelper.get_descriptions_array(params)
+        return metaDataObjectsArray(descriptionsArray)
+      end
+
+      def self.metaDataObjectsArray(array)
+          tempArray = []  
+          array.each do |row|
+            tempMetaData = MetaData.new
+            tempMetaData.language = row[0]
+            tempMetaData.description = row[1]
+            tempMetaData.releaseNotesiOS = row[2]
+            tempMetaData.releaseNotesAndroid = row[3]
+            tempArray << tempMetaData
+          end   
+          return tempArray
+      end
+
+      def self.prepareFilesFor_Android(params, countryMetaData)
+        logStep("Attempting to fetch JSON with Android .apk versionCode.")
+        android_apk_version_code = Helper::DeployFileProviderHelper.get_android_version(params)
+        if android_apk_version_code == nil || android_apk_version_code.empty?
+          throwError("Provided version code: " + android_apk_version_code + ", can't be used to create changelog filename.")
+        else 
+          logStep("Fetch successfull!")
+        end
+        android_changelog_filename = android_apk_version_code + ".txt"
+        
+        if (locationExists(ANDROID_ROOT))
+          numOfLanguagesToHandle = ANDROID_METADATA_LOC.size
+          numOfLanguagesProcessed = 0
+
+          for i in 0 ... countryMetaData.size
+           languageKey = countryMetaData[i].language.downcase 
+            unless ANDROID_METADATA_LOC.key?(languageKey)
+              next
+            end
+
+            fulldescription_metaDataDir = [
+              ANDROID_ROOT,
+              ANDROID_METADATA_LOC[languageKey], 
+              ANDROID_FULL_DESCRIPTION_DIR].join
+            logStep("Attempting to prepare " + ANDROID_FULL_DESCRIPTION_FILENAME + " for language: " + languageKey + " - in location: " + fulldescription_metaDataDir)
+            
+            if (locationExists(fulldescription_metaDataDir))
+              file = fulldescription_metaDataDir + ANDROID_FULL_DESCRIPTION_FILENAME
+              
+              if File.exists?(file) 
+                  File.delete(file)
+              end
+
+              newFullDescriptionFile = File.new(file, "w")
+              begin
+                newFullDescriptionFile.puts(countryMetaData[i].description)
+              ensure
+                newFullDescriptionFile.close
+              end
+            end
+            
+            changelog_metaDataDir = [
+              ANDROID_ROOT,
+              ANDROID_METADATA_LOC[languageKey],
+              ANDROID_CHANGELOG_DIR].join
+            logStep("Attempting to prepare changelog file with name: " + android_changelog_filename + " for language: " + languageKey + " - in location: " + changelog_metaDataDir)
+
+            if (locationExists(changelog_metaDataDir))
+              file = changelog_metaDataDir + android_changelog_filename
+              
+              if File.exists?(file) 
+                File.delete(file)
+              end
+
+              newChangeLogFile = File.new(file, "w")
+              begin
+                newChangeLogFile.puts(countryMetaData[i].releaseNotesAndroid)
+              ensure
+                newChangeLogFile.close
+              end
+            end
+
+            numOfLanguagesProcessed += 1
+            logStep("---- Files updated")
+          end
+
+          if numOfLanguagesProcessed != numOfLanguagesToHandle
+            throwError("Android expected to receive metadata for: #{numOfLanguagesToHandle} languages, but received for: #{numOfLanguagesProcessed}!")
+          end
+        end
+      end
+
+      def self.prepareFilesFor_iOS(countryMetaData)
+        if (locationExists(IOS_ROOT))
+
+          numOfLanguagesToHandle = IOS_METADATA_LOC.size
+          numOfLanguagesProcessed = 0
+
+          for i in 0 ... countryMetaData.size
+            languageKey = countryMetaData[i].language.downcase 
+            unless IOS_METADATA_LOC.key?(languageKey)
+              next
+            end
+
+            description_metaDataDir = [
+              IOS_ROOT,
+              IOS_METADATA_LOC[languageKey], 
+              IOS_DESCRIPTION_DIR].join
+            logStep("Attempting to prepare " + IOS_DESCRIPTION_FILENAME + " for language: " + languageKey + " - in location: " + description_metaDataDir)
+
+            if (locationExists(description_metaDataDir))
+              file = description_metaDataDir + IOS_DESCRIPTION_FILENAME
+
+              if File.exists?(file)
+                File.delete(file)
+              end
+
+              newFullDescriptionFile = File.new(file, "w")
+              begin
+                newFullDescriptionFile.puts(countryMetaData[i].description)
+              ensure
+                newFullDescriptionFile.close
+              end
+            end
+
+            releasenotes_metaDataDir = [
+              IOS_ROOT,
+              IOS_METADATA_LOC[languageKey],
+              IOS_RELEASE_NOTES_DIR].join
+            logStep("Attempting to prepare " + IOS_RELEASE_NOTES_FILENAME + " file for language: " + languageKey + " - in location: " + releasenotes_metaDataDir)
+
+            if (locationExists(releasenotes_metaDataDir))
+              file = description_metaDataDir + IOS_RELEASE_NOTES_FILENAME
+
+              if File.exists?(file)
+                File.delete(file)
+              end
+
+              newReleaseNotesFile = File.new(file, "w")
+              begin
+                newReleaseNotesFile.puts(countryMetaData[i].releaseNotesiOS)
+              ensure
+                newReleaseNotesFile.close
+              end
+            end
+
+            numOfLanguagesProcessed += 1
+            logStep("---- Files updated")
+          end
+
+          if numOfLanguagesProcessed != numOfLanguagesToHandle
+            throwError("iOS expected to receive metadata for: #{numOfLanguagesToHandle} languages, but received for: #{numOfLanguagesProcessed}!")
+          end
+        end
+      end
+
+      def self.logStep(message) 
+        UI.message("Step: ".blue + message.blue)
+      end 
+
+      def self.throwError(message) 
+        UI.message("Error: ".red + message.red)
+        raise Exception, "Lane was stopped by script"
+      end
+
+      def self.locationExists(path) 
+        if File.directory?(path)
+          return true
+        else
+          throwError("Could not find location '" + path + "'. Did you fetch metdata from store before launching plugin?")
+          return false
+        end
+      end
+
+      def self.description
+        "Prepares metadata files with structure ready for AppStore, PlayStore deploy"
+      end
+
+      def self.authors
+        ["Kamil Krzyk, Przemysław Wośko"]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :platform,
+                                     env_name: "DEPLOY_FOR_PLATFORM",
+                                     description: "For which platform files should be prepared",
+                                     is_string: true,
+                                     optional: false),
+          FastlaneCore::ConfigItem.new(key: :apiCredentialsPath,
+                                     env_name: "API_CREDENTIALS_PATH",
+                                     description: "File that contains your OAuth2.0 data",
+                                     is_string: true,
+                                     optional: false),
+          FastlaneCore::ConfigItem.new(key: :spreadsheetId,
+                                     env_name: "SPREADSHEET_ID",
+                                     description: "Your spreadsheet id",
+                                     is_string: true,
+                                     optional: false),
+          FastlaneCore::ConfigItem.new(key: :spreadsheetApplicationName,
+                                     env_name: "SPREADSHEET_APPLICATION_NAME",
+                                     description: "Your google plafrom application name",
+                                     is_string: true,
+                                     optional: false),
+          FastlaneCore::ConfigItem.new(key: :credentialsPath,
+                                     env_name: "SPREADSHEET_APPLICATION_NAME",
+                                     description: "Sphreadsheet OAuth2 credentials url",
+                                     is_string: true,
+                                     optional: false)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        platform == :android || platform == :ios
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/deploy_file_provider/helper/deploy_file_provider_helper.rb

@@ -0,0 +1,64 @@
+require 'google/apis/sheets_v4'
+require 'googleauth'
+require 'googleauth/stores/file_token_store'
+
+require 'fileutils'
+
+
+module Fastlane
+  module Helper
+    class DeployFileProviderHelper
+
+      OOB_URI = 'urn:ietf:wg:oauth:2.0:oob'
+      SCOPE = Google::Apis::SheetsV4::AUTH_SPREADSHEETS_READONLY
+      credentials = ''
+
+      def self.authorizedService(params) 
+        client_secret_path_param = params[:apiCredentialsPath]
+        application_name = params[:spreadsheetApplicationName]
+        credentials_path = params[:credentialsPath]
+  
+        service = Google::Apis::SheetsV4::SheetsService.new
+        service.client_options.application_name = application_name
+        client_id = Google::Auth::ClientId.from_file(client_secret_path_param)
+        token_store = Google::Auth::Stores::FileTokenStore.new(file: credentials_path)
+        authorizer = Google::Auth::UserAuthorizer.new(
+          client_id, SCOPE, token_store)
+        user_id = 'default'
+        credentials = authorizer.get_credentials(user_id)
+        service.authorization = credentials
+        return service
+      end 
+
+      def self.get_descriptions_array(params) 
+      spreadsheet_id = params[:spreadsheetId]
+      service = self.authorizedService(params)
+      
+      range = 'Master!B1:K7'
+      response = service.get_spreadsheet_values(spreadsheet_id, range)
+      puts 'No data found.' if response.values.empty?
+      return self.parse_json(response)
+      end
+
+      def self.get_android_version(params)
+        spreadsheet_id = params[:spreadsheetId]
+        service = self.authorizedService(params)
+
+        range = 'Android!B1'
+        response = service.get_spreadsheet_values(spreadsheet_id, range)
+        puts 'No android version provided!'.red if response.values.empty? 
+        return response.values[0][0]
+      end
+
+      def self.parse_json(response) 
+        transposed = response.values.transpose
+        size = transposed.size
+        array = Array.new()
+        transposed.each do |row|
+          dictionary = {:language => row[0], :description => row[1], :releaseNotesiOS => row[2], :releaseNotesAndroid => row[3]}
+          array << dictionary
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module DeployFileProvider
+    VERSION = "0.1.0"
+  end
+end

data/lib/fastlane/plugin/deploy_file_provider.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/deploy_file_provider/version'
+
+module Fastlane
+  module DeployFileProvider
+    # 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::DeployFileProvider.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-deploy_file_provider
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kamil Krzyk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: bundler
+  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: rspec
+  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: 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: rubocop
+  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: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.103.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.103.0
+description: 
+email: krzyk.kamil@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/deploy_file_provider.rb
+- lib/fastlane/plugin/deploy_file_provider/actions/deploy_file_provider_action.rb
+- lib/fastlane/plugin/deploy_file_provider/helper/deploy_file_provider_helper.rb
+- lib/fastlane/plugin/deploy_file_provider/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Prepares metadata files with structure ready for AppStore, PlayStore deploy
+test_files: []