phrase-ota-i18n 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2f9c7981adbdad2b7ccda60036861f500c4855dc3793cb536d3282845af6197e
+  data.tar.gz: 7a41b105cf56b98f410faefd85b938a83988f7d0d82e79e7fd8d374bea52aabc
+SHA512:
+  metadata.gz: c622e6fbf7ed2b806ed4d6466ba6e48c0917e1c184dfcd39e7af0d01aee6fa02a02947f0c4873f8da394d72a0a2e36c76164e335f79317469da834c98a263e2c
+  data.tar.gz: 4c14fe8da857858018ff49d457657d361224d3c42af94578b1caed6090357f452ce774081a87241436daf3c66de153a2f610103cf33cbca1971e50c836cd8263

data/.github/workflows/check_pr_title.yml

@@ -0,0 +1,20 @@
+name: "Check PR title"
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+permissions:
+  pull-requests: read
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@c3cd5d1ea3580753008872425915e343e351ab54 # pin@5.2.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/lint.yml

@@ -0,0 +1,15 @@
+name: Lint
+on: [push]
+jobs:
+  standard:
+    name: standard
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Install Ruby
+        uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf
+        with:
+          bundler-cache: true
+      - name: standard
+        run: bundle exec standardrb --no-fix

data/.github/workflows/release.yml

@@ -0,0 +1,36 @@
+name: Release
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: GoogleCloudPlatform/release-please-action@ca6063f4ed81b55db15b8c42d1b6f7925866342d # pin@3.7.11
+        with:
+          release-type: ruby
+          package-name: phrase-ota-i18n
+          version-file: "lib/phrase/ota/version.rb"
+      - uses: actions/checkout@v3
+        if: ${{ steps.release.outputs.release_created }}
+      - uses: ruby/setup-ruby@250fcd6a742febb1123a77a841497ccaa8b9e939 #pin@v1.152.0
+        with:
+          ruby-version: 3.2.2
+        if: ${{ steps.release.outputs.release_created }}
+      - run: bundle install
+        if: ${{ steps.release.outputs.release_created }}
+      - name: publish gem
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build phrase-ota-i18n.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_TOKEN}}"
+        if: ${{ steps.release.outputs.release_created }}
+
+

data/.github/workflows/test.yml

@@ -0,0 +1,17 @@
+name: Test
+on: [push]
+jobs:
+  rspec:
+    name: RSpec
+    runs-on: ubuntu-latest
+    env:
+      RAILS_ENV: test
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Install Ruby
+        uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf
+        with:
+          bundler-cache: true
+      - name: RSpec
+        run: bundle exec rspec spec/

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.2

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 1.0.0 (2023-08-07)
+
+
+### Features
+
+* add debug flag ([ae741b7](https://github.com/phrase/phrase-ota-i18n/commit/ae741b79a8eadc75603e23b70d55c435ea7de26a))

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in phrase-ota-i18n.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "standard"
+gem "debug"
+gem "rspec"
+gem "webmock"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Phrase GmbH
+
+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,41 @@
+# phrase-ota-i18n
+
+Backend for the [I18n](https://github.com/ruby-i18n/i18n) gem to update translations over-the-air from [Phrase Strings](https://phrase.com)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'phrase-ota-i18n'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install phrase-ota-i18n
+
+## Usage
+
+Generate config:
+
+    bundle exec rails generate phrase_ota_rails:install --distribution-id <DISTRIBUTION_ID> --secret-token <SECRET>
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+This project relies on [conventional commits](https://www.conventionalcommits.org) used by [release-please](https://github.com/googleapis/release-please) to generate proper changelogs and increment versions of the generated client libraries affected by the PR. Please use [appropriate prefixes](https://kapeli.com/cheat_sheets/Conventional_Commits.docset/Contents/Resources/Documents/index) when giving titles to your PRs as they decide whether there will be a version bump and changelog entry.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "phrase/ota"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/phrase_ota/install_generator.rb

@@ -0,0 +1,19 @@
+require "rails/generators"
+
+module PhraseOta
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    desc "Creates a Phrase OTA initializer for your Rails application."
+    class_option :distribution_id, type: :string, desc: "Your Phrase OTA distribution ID", required: true
+    class_option :secret_token, type: :string, desc: "Your Phrase OTA secret token", required: true
+
+    def copy_initializer
+      template "phrase_ota.rb", "config/initializers/phrase_ota.rb"
+    end
+
+    def show_readme
+      readme "README.md" if behavior == :invoke
+    end
+  end
+end

data/lib/generators/phrase_ota/templates/README.md

@@ -0,0 +1,5 @@
+Welcome to Phrase OTA!
+
+Phrase OTA lets you update the translations of your app on the fly, without restarting or deploying anything.
+
+Happy internationalizing!

data/lib/generators/phrase_ota/templates/phrase_ota.rb

@@ -0,0 +1,25 @@
+require "phrase/ota"
+
+fallback_backend = I18n::Backend::Simple.new
+
+Phrase::Ota.configure do |config|
+  # Possible datacenter values are "eu" and "us". The distribution_id and secret_token need to match the datacenter
+  config.datacenter = "eu"
+
+  # Phrase OTA Distribution ID
+  config.distribution_id = "<%= options[:distribution_id] %>"
+
+  # Your Phrase OTA secret token (either development or production)
+  config.secret_token = "<%= options[:secret_token] %>"
+
+  # Logger
+  config.logger = Rails.logger
+
+  # App version, set to nil if you do not want to use app version restriction
+  config.app_version = nil
+
+  # Available locales that will be updated over-the-air
+  config.available_locales = fallback_backend.available_locales
+end
+
+I18n.backend = I18n::Backend::Chain.new(Phrase::Ota::Backend.new, fallback_backend)

data/lib/phrase/ota/backend.rb

@@ -0,0 +1,68 @@
+require "faraday"
+require "faraday_middleware"
+require "i18n"
+
+module Phrase
+  module Ota
+    class Backend < I18n::Backend::Simple
+      def initialize
+        @current_version = nil
+        start_polling
+      end
+
+      def available_locales
+        Phrase::Ota.config.available_locales
+      end
+
+      def init_translations
+        @translations = {}
+        @initialized = true
+      end
+
+      protected
+
+      def start_polling
+        Thread.new do
+          loop do
+            sleep(Phrase::Ota.config.poll_interval_seconds)
+            update_translations
+          end
+        end
+      end
+
+      def update_translations
+        log("Phrase: Updating translations...")
+
+        available_locales.each do |locale|
+          url = "#{Phrase::Ota.config.base_url}/#{Phrase::Ota.config.distribution_id}/#{Phrase::Ota.config.secret_token}/#{locale}/yml"
+          params = {
+            app_version: Phrase::Ota.config.app_version,
+            client: "ruby",
+            sdk_version: Phrase::Ota::VERSION
+          }
+          params[:current_version] = @current_version unless @current_version.nil?
+
+          connection = Faraday.new do |faraday|
+            faraday.use FaradayMiddleware::FollowRedirects
+            faraday.adapter Faraday.default_adapter
+          end
+
+          log("Phrase: Fetching URL: #{url}")
+
+          response = connection.get(url, params, {"User-Agent" => "phrase-ota-i18n #{Phrase::Ota::VERSION}"})
+          next unless response.status == 200
+
+          @current_version = CGI.parse(URI(response.env.url).query)["version"].first.to_i
+          yaml = YAML.safe_load(response.body)
+          yaml.each do |yaml_locale, tree|
+            store_translations(yaml_locale, tree || {})
+          end
+        end
+      end
+
+      def log(message)
+        Phrase::Ota.config.logger.info(message) if Phrase::Ota.config.debug
+      end
+    end
+  end
+end

data/lib/phrase/ota/configuration.rb

@@ -0,0 +1,48 @@
+require "logger"
+
+module Phrase
+  module Ota
+    class UnknownDatacenterException < StandardError; end
+
+    class Configuration
+      attr_accessor :distribution_id
+      attr_accessor :secret_token
+      attr_accessor :logger
+      attr_accessor :app_version
+      attr_accessor :poll_interval_seconds
+      attr_accessor :datacenter
+      attr_accessor :available_locales
+      attr_accessor :debug
+      attr_writer :base_url
+
+      def initialize
+        @distribution_id = nil
+        @secret_token = nil
+        @logger = Logger.new($stdout)
+        @app_version = nil
+        @poll_interval_seconds = 60
+        @datacenter = "eu"
+        @available_locales = []
+        @base_url = nil
+        @debug = false
+      end
+
+      def base_url
+        @base_url || datacenter_url
+      end
+
+      private
+
+      def datacenter_url
+        case @datacenter.downcase
+        when "eu"
+          "https://ota.eu.phrase.com"
+        when "us"
+          "https://ota.us.phrase.com"
+        else
+          raise UnknownDatacenterException
+        end
+      end
+    end
+  end
+end

data/lib/phrase/ota/version.rb

@@ -0,0 +1,5 @@
+module Phrase
+  module Ota
+    VERSION = "1.0.0"
+  end
+end

data/lib/phrase/ota.rb

@@ -0,0 +1,15 @@
+require "phrase/ota/version"
+require "phrase/ota/configuration"
+require "phrase/ota/backend"
+
+module Phrase
+  module Ota
+    def self.configure
+      yield(config) if block_given?
+    end
+
+    def self.config
+      @config ||= Phrase::Ota::Configuration.new
+    end
+  end
+end

data/phrase-ota-i18n.gemspec

@@ -0,0 +1,29 @@
+require_relative "lib/phrase/ota/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "phrase-ota-i18n"
+  spec.version = Phrase::Ota::VERSION
+  spec.authors = ["Phrase"]
+  spec.email = ["support@phrase.com"]
+
+  spec.summary = "Phrase OTA for Rails i18n"
+  spec.description = "Phrase OTA for Rails i18n"
+  spec.homepage = "https://github.com/phrase/phrase-ota-i18n"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "i18n"
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: phrase-ota-i18n
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Phrase
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  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: faraday
+  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: faraday_middleware
+  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'
+description: Phrase OTA for Rails i18n
+email:
+- support@phrase.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/check_pr_title.yml"
+- ".github/workflows/lint.yml"
+- ".github/workflows/release.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- ".tool-versions"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/phrase_ota/install_generator.rb
+- lib/generators/phrase_ota/templates/README.md
+- lib/generators/phrase_ota/templates/phrase_ota.rb
+- lib/phrase/ota.rb
+- lib/phrase/ota/backend.rb
+- lib/phrase/ota/configuration.rb
+- lib/phrase/ota/version.rb
+- phrase-ota-i18n.gemspec
+homepage: https://github.com/phrase/phrase-ota-i18n
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/phrase/phrase-ota-i18n
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Phrase OTA for Rails i18n
+test_files: []