fastlane-plugin-ovo_poeditor 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eaa989467e195285f9da509bfff7d80c8d88071d2f5725a7ab009dde29cf56d0
+  data.tar.gz: 74d78ea4d189e71546e89d621058cf6152d2e585b9cb536921606cde84b7d44d
+SHA512:
+  metadata.gz: e68fac94606eefb45e9e47eb8b8f097c2bd23dc6281b7e5b754f286f9a36078debee4820cd8b3b629e9eb91b6a10b975e44ce9b7c73698c3fe5bbd7ea5e25605
+  data.tar.gz: 04d1404d97ed221e85e2c674c45673593a9fcf1217a9e70cf77e7eff3496d305907b5c3a1339ac86ebb830442095f1e140cded4fc099b9e340b351d9ce5102cc

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Alessio Arsuffi <alessio.arsuffi@ovolab.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,96 @@
+# Ovo POEditor Plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-ovo_poeditor)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-ovo_poeditor`, add it to your project by running:
+
+```bash
+fastlane add_plugin ovo_poeditor
+```
+
+## About Ovo POEditor
+
+Fetch latest POEditor terms and download them as `.xcstrings/.strings/.xml` file
+
+## Available Actions
+
+### ovo_poeditor_strings
+
+This action will download the latest terms from POEditor to the specified `output_dir` in the specified `file_format`.
+
+#### iOS
+
+##### `xcstrings`:
+```ruby
+ovo_poeditor_strings(
+  api_token: "api_token",
+  project_id: "project_id",
+  languages: ["fr"], 
+  output_dir: "./XCStrings",
+  file_format: "xcstrings",
+  file_name: "Localizable.xcstrings"
+)
+```
+NB: when `file_format: "xcstrings"`, you can pass a single language to the script, it will export all the available languages in the project to the `.xcstrings` file.
+
+##### `strings`:
+```ruby
+ovo_poeditor_strings(
+  api_token: "api_token",
+  project_id: "project_id",
+  languages: ["fr", "en", "it", "ru"], 
+  output_dir: "./Strings",
+  file_format: "apple_strings",
+  file_name: "Localizable.strings"
+)
+```
+
+#### Android
+```ruby
+ovo_poeditor_strings(
+  api_token: "api_token",
+  project_id: "project_id",
+  languages: ["fr", "en", "it", "ru"], 
+  output_dir: "./values",
+  file_format: "android_strings",
+  file_name: "strings.xml"
+)
+```
+
+
+## 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/ovo_poeditor/actions/ovo_poeditor_strings_action.rb

@@ -0,0 +1,95 @@
+require 'fastlane/action'
+require_relative '../helper/ovo_poeditor_helper'
+
+module Fastlane
+  module Actions
+    class OvoPoeditorStringsAction < Action
+      def self.run(params)
+        api_token = params[:api_token]
+        project_id = params[:project_id]
+        languages = params[:languages]
+        output_dir = params[:output_dir]
+        file_format = params[:file_format]
+        file_name = params[:file_name]
+
+        Helper::OvoPoeditorHelper.sync_strings(
+          api_token: api_token,
+          project_id: project_id,
+          languages: languages,
+          output_dir: output_dir,
+          file_format: file_format,
+          file_name: file_name
+        )
+      end
+
+      def self.description
+        "Fetch latest POEditor terms and download them as .strings/.xml/.xcstrings file"
+      end
+
+      def self.authors
+        ["Alessio Arsuffi"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+        "Return a file with all POEditor terms"
+      end
+
+      def self.details
+        # Optional:
+        "Fetch latest POEditor terms and download them as .strings/.xml/.xcstrings file"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :api_token,
+            env_name: "POEDITOR_API_TOKEN",
+            description: "POEditor read-only API Token",
+            optional: false,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :project_id,
+            env_name: "POEDITOR_PROJECT_ID",
+            description: "POEditor Project ID",
+            optional: false,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :languages,
+            env_name: "POEDITOR_LANGUAGES",
+            description: "The languages to export strings for",
+            optional: false,
+            type: Array
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :output_dir,
+            env_name: "POEDITOR_OUTPUT_DIR",
+            description: "Directory containing strings file",
+            optional: false,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :file_name,
+            env_name: "POEDITOR_FILE_NAME",
+            description: "The name of the file to be downloaded",
+            optional: false,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :file_format,
+            env_name: "POEDITOR_EXPORT_FILE_FORMAT",
+            description: "Export file format (xcstrings, apple_strings, android_strings)",
+            optional: false,
+            type: String
+          )
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/ovo_poeditor/helper/ovo_poeditor_helper.rb

@@ -0,0 +1,98 @@
+require 'fastlane_core/ui/ui'
+require 'fastlane'
+
+require 'json'
+require 'open-uri'
+require 'fileutils'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
+
+  module Helper
+    class OvoPoeditorHelper
+      @supported_export_types = ["apple_strings", "xcstrings", "android_strings"].freeze
+
+      def self.sync_strings(api_token:, project_id:, languages:, output_dir:, file_format:, file_name:)
+        unless @supported_export_types.include?(file_format)
+          UI.error("Invalid export type '#{file_format}'. Allowed values: #{@supported_export_types.join(', ')}")
+        end
+
+        languages.each do |language|
+          UI.message("Fetching terms for language: #{language}")
+
+          export_url = fetch_export_url(
+            api_token: api_token,
+            project_id: project_id,
+            language: language,
+            file_format: file_format
+          )
+
+          if export_url.nil?
+            UI.error("No export URL for language '#{language}'. Please check if it's enabled in POEditor.")
+            next
+          end
+
+          strings_data = download_file(export_url, language)
+          next unless strings_data
+
+          output_path = build_output_path(output_dir, language, file_name, file_format)
+
+          begin
+            FileUtils.mkdir_p(File.dirname(output_path))
+            File.write(output_path, strings_data)
+            UI.success("Downloaded localization file for #{language} to #{output_path}")
+          rescue Errno::EACCES => e
+            UI.error("Permission denied while writing to #{output_path}: #{e.message}")
+          rescue IOError, SystemCallError => e
+            UI.error("Failed to write file for #{language}: #{e.message}")
+          end
+        end
+      end
+
+      def self.fetch_export_url(api_token:, project_id:, language:, file_format:)
+        uri = URI("https://api.poeditor.com/v2/projects/export")
+        request = Net::HTTP::Post.new(uri)
+
+        form_data = {
+          "api_token" => api_token,
+          "id" => project_id,
+          "language" => language,
+          "order" => "terms",
+          "type" => file_format
+        }
+        form_data["options"] = '[{"export_all":1}]' if file_format == "xcstrings"
+
+        request.set_form_data(form_data)
+
+        response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+          http.request(request)
+        end
+
+        return nil unless response.is_a?(Net::HTTPSuccess)
+
+        result = JSON.parse(response.body)
+        result.dig("result", "url")
+      rescue JSON::ParserError => e
+        UI.error("Failed to parse POEditor response: #{e.message}")
+        nil
+      end
+
+      def self.download_file(url, language)
+        URI.open(url).read
+      rescue => e
+        UI.error("Error downloading file for language '#{language}': #{e.message}")
+        nil
+      end
+
+      def self.build_output_path(base_dir, language, file_name, format)
+        if format == "xcstrings"
+          "#{base_dir}/#{file_name}"
+        elsif format == "apple_strings"
+          "#{base_dir}/#{language}.lproj/#{file_name}"
+        else
+          "#{base_dir}/#{language}/#{file_name}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module OvoPoeditor
+    VERSION = "1.0.0"
+  end
+end

data/lib/fastlane/plugin/ovo_poeditor.rb

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

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-ovo_poeditor
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alessio Arsuffi
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+email: alessio.arsuffi@ovolab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/ovo_poeditor.rb
+- lib/fastlane/plugin/ovo_poeditor/actions/ovo_poeditor_strings_action.rb
+- lib/fastlane/plugin/ovo_poeditor/helper/ovo_poeditor_helper.rb
+- lib/fastlane/plugin/ovo_poeditor/version.rb
+homepage: https://github.com/ovolab/fastlane-plugin-ovo_poeditor
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+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.6.9
+specification_version: 4
+summary: Fetch latest POEditor terms and download them as .xcstrings and .strings
+  file
+test_files: []