i18n-remote_backend 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 63e0370549d377339d8478e713df25e4fdcf78cc375639dc474e7c53a79fb57c
+  data.tar.gz: d9165bdf584bf69e76eb110e0d9fcafc18518a9605e986c85df9e49396f7b7f3
+SHA512:
+  metadata.gz: a931dd0853154d803e82d93fa4488ea00970d96c993e736dcb7b75ab68f319ed550567a4166b78307d3ea645aa22f69362f94beae5cda86bf446a17d961b8e52
+  data.tar.gz: '084f45906d8342a95ea31e1c668f0ba1de59a8e27b325c0e4ef76ea0b8daf5c71be475f82c7d94748a9d679ebe8a3d76890368a7a23cccc7e82c3d71472ed264'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 TODO: Write your name
+
+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,45 @@
+# I18n::RemoteBackend
+
+I18n backend for loading remote locales via HTTP.
+
+## Installation
+
+Put the following in your Gemfile:
+
+```ruby
+gem 'i18n-remote_backend', require: 'i18n/remote_backend', git: 'git@github.com:mudasirraza/i18n-remote_backend.git'
+```
+
+After updating your bundle, run the installer
+
+    $ rails g i18n:remote_backend:install
+
+It generates a new file in `config/initializers` named `i18n_remote_backend.rb` with the following content.
+
+```ruby
+require 'i18n/backend/remote_backend'
+
+I18n.backend = I18n::Backend::Chain.new(I18n::Backend::RemoteBackend.new, I18n::Backend::Simple.new)
+
+I18n::Backend::RemoteBackend.configure do |config|
+  # config.http_url = ''
+end
+```
+
+Set the http_url accordingly. e.g `https://example-url/locales`
+The corresponding generated requests will look like: `https://example-url/locales/en` or `https://example-url/locales/fr` etc.
+And it should respond back with the yaml file content.
+
+If a remote translation is unavailable, it will fall back to a local translation.
+
+## Usage
+
+You can then use `I18n.t('text')`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mudasirraza/i18n-remote_backend.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/generators/i18n/remote_backend/install_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module I18n
+  module RemoteBackend
+    module Generators
+      class InstallGenerator < Rails::Generators::Base
+        desc 'This generator creates an initializer file at config/initializers'
+
+        source_root File.expand_path('templates', __dir__)
+
+        def copy_initializer
+          template 'initializer.rb', 'config/initializers/i18n_remote_backend.rb'
+        end
+      end
+    end
+  end
+end

data/lib/generators/i18n/remote_backend/templates/initializer.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'i18n/backend/remote_backend'
+
+I18n.backend = I18n::Backend::Chain.new(I18n::Backend::RemoteBackend.new, I18n::Backend::Simple.new)
+
+I18n::Backend::RemoteBackend.configure do |config|
+  # config.http_url = ''
+end

data/lib/i18n/backend/remote_backend/configuration.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+module I18n
+  module Backend
+    class RemoteBackend
+      class Configuration
+        attr_reader :http_url
+
+        def http_url=(http_url)
+          raise RemoteBackend::InvalidURLException unless http_url =~ URI::DEFAULT_PARSER.regexp[:ABS_URI]
+
+          @http_url = http_url
+        end
+      end
+    end
+  end
+end

data/lib/i18n/backend/remote_backend/exceptions.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module I18n
+  module Backend
+    class RemoteBackend
+      class InvalidURLException < StandardError; end
+      class BlankURLException < StandardError; end
+    end
+  end
+end

data/lib/i18n/backend/remote_backend/implementation.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'i18n/backend/base'
+
+module I18n
+  module Backend
+    class RemoteBackend
+      module Implementation
+        include Base
+
+        attr_accessor :store
+
+        def initialize
+          @store = {}
+          I18n.enforce_available_locales = false
+        end
+
+        def initialized?
+          !@store.nil?
+        end
+
+        def store_translations(locale, data, _options = {})
+          @store[locale] = data
+        end
+
+        def available_locales
+          @store.keys.map(&:to_sym)
+        end
+
+        def translations
+          @store
+        end
+
+        def init_translations
+          @store
+        end
+
+        protected
+
+        def lookup(locale, key, scope = [], options = {})
+          return unless fetch_remote_translations(locale)
+
+          keys = I18n.normalize_keys(locale, key, scope, options[:separator])
+          keys.inject(translations) do |result, k|
+            return nil unless result.is_a?(Hash)
+
+            unless result.key?(k)
+              k = k.to_s.to_sym
+              return nil unless result.key?(k)
+            end
+            result[k]
+          end
+        end
+
+        def fetch_remote_translations(locale)
+          return @store[locale] if @store[locale]
+
+          data = Loader.new(locale).fetch_locale
+          @store[locale] = data[locale] if data
+
+          @store[locale]
+        end
+      end
+    end
+  end
+end

data/lib/i18n/backend/remote_backend/loader.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'open-uri'
+
+module I18n
+  module Backend
+    class RemoteBackend
+      class Loader
+        attr_reader :locale
+        attr_accessor :yaml
+
+        def initialize(locale = default_locale)
+          @locale = locale
+        end
+
+        def fetch_locale
+          raise RemoteBackend::BlankURLException if RemoteBackend.configuration.http_url.nil?
+
+          begin
+            yaml = YAML.safe_load(fetch_remote_file)
+            Utils.deep_symbolize_keys(yaml) if yaml.instance_of?(Hash)
+          rescue StandardError => e
+            RemoteBackend.logger.error "Error occured while reading remote locale : #{RemoteBackend.configuration.http_url}/#{locale} error: " + e.inspect
+            nil
+          end
+        end
+
+        private
+
+        def fetch_remote_file
+          URI.parse("#{RemoteBackend.configuration.http_url}/#{@locale}").open.read
+        end
+      end
+    end
+  end
+end

data/lib/i18n/backend/remote_backend.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'logger'
+Dir["#{File.dirname(__FILE__)}/remote_backend/*.rb"].sort.each { |file| require file }
+
+module I18n
+  module Backend
+    class RemoteBackend
+      include Implementation
+
+      class << self
+        def configuration
+          @configuration ||= Configuration.new
+        end
+
+        def configure
+          yield(configuration) if block_given?
+        end
+
+        def logger
+          @logger ||= defined?(Rails) ? Rails.logger : Logger.new($stdout)
+        end
+      end
+    end
+  end
+end

data/lib/i18n/remote_backend/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module I18n
+  module RemoteBackend
+    VERSION = '0.1.0'
+  end
+end

data/lib/i18n/remote_backend.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'i18n'

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: i18n-remote_backend
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mudasir Raza
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: 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: 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: 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'
+description: 
+email:
+- i18n-remote@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/i18n/remote_backend/install_generator.rb
+- lib/generators/i18n/remote_backend/templates/initializer.rb
+- lib/i18n/backend/remote_backend.rb
+- lib/i18n/backend/remote_backend/configuration.rb
+- lib/i18n/backend/remote_backend/exceptions.rb
+- lib/i18n/backend/remote_backend/implementation.rb
+- lib/i18n/backend/remote_backend/loader.rb
+- lib/i18n/remote_backend.rb
+- lib/i18n/remote_backend/version.rb
+homepage: https://github.com/mudasirraza/i18n-remote_backend
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mudasirraza/i18n-remote_backend
+  source_code_uri: https://github.com/mudasirraza/i18n-remote_backend
+  changelog_uri: https://github.com/mudasirraza/i18n-remote_backend/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key: 
+specification_version: 4
+summary: Adds support for fetching translation from a remote resource
+test_files: []