localeui 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 34ebbd165eaa32936d46e399b8300910a67df1372dfcd7afe305ffb30b862682
+  data.tar.gz: 2b848e39e1b5a84614c110998103966792291aff6a9c7e9b17688c5207681faf
+SHA512:
+  metadata.gz: 86d70ebe060920ce041f2731cbed9aa65bbcd4b86fa4e6130e48880ef8d4113c447b148218cd4722190428d6c0c0fefd61df9d6261a14a95297cd48eb8bab52c
+  data.tar.gz: 94bbf3d795a02511b45209b276f3810e99a687c1fa9661a620faef1ac0155cdc9b39eaf672e9e358bc1d38538a2338b50adeb168692a93c2cb30377efde48ba6

data/README.md

@@ -0,0 +1,70 @@
+# LocaleUIRails
+
+![Gem Version](https://img.shields.io/gem/v/localeui-rails)
+![CI Status](https://github.com/localeUI/localeui-rails/actions/workflows/main.yml/badge.svg)
+
+The LocaleUI-Rails Gem is a Ruby on Rails application gem that provides developers with a seamless way to manage and synchronise translation files with LocaleUI.com. By integrating the Gem into the Rails application, translations can be automatically synchronised, updated and deployed directly to LocaleUI without manually uploading or copying language files.
+
+The LocaleUI-Rails Gem makes the management of multilingual Ruby on Rails applications uncomplicated and automated - ideal for companies that want to offer their Ruby on Rails application in different languages.
+
+## Requirements
+
+This gem requires Ruby 3.2+ and Rails 7.1+.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+Next, you need to create a config file for localeui-rails. Run the following command to copy a basic config file.
+
+    $ rails g localeui:install
+
+Go to the config file `config/initializers/localeui.rb` and add your `api_token` and `project_id`.
+
+```ruby
+Localeui.config do |config|
+  # ...
+  
+  # Authentication Token
+  config.api_token = ENV['LOCALEUID_API_TOKEN']
+
+  # Project API ID
+  config.project_id = ENV['LOCALEUID_PROJECT_ID']
+
+  # ...other options
+end
+```
+
+## Upload Translation Files
+
+    $ rails localeui:upload  
+
+## Download Translation Files
+
+    $ rails localeui:download
+
+## Development
+
+Run tests with in the terminal 
+
+    $ bin/test
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/localeUI/localeui_rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/localeUI/localeui-rails/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the LocaleuiRails project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/localeUI/localeui-rails/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/generators/localeui/install_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Localeui
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __dir__)
+
+      desc 'Creates a LocaleUI config file.'
+      def copy_config
+        template 'localeui_config.rb', "#{Rails.root}/config/initializers/localeui.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/localeui_config.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'localeui'
+
+Localeui.config do |config|
+  # These are mandatory parameters that must be set before rake tasks are executed
+  # Base API Endpoint
+  config.base_api = 'http://localhost:3000/api/v1/'
+
+  # Authentication Token
+  config.api_token = ''
+
+  # Project API ID
+  config.project_id = ''
+
+  # Path of the translation files
+  config.locales_path = "#{Rails.root}/config/locales"
+end

data/lib/localeui/errors.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Localeui
+  class LocaleuiError < StandardError; end
+  class BadRequestError < LocaleuiError; end
+  class ForbiddenError < LocaleuiError; end
+  class NoBaseApiError < LocaleuiError; end
+  class NoApiTokenError < LocaleuiError; end
+  class NoProjectError < LocaleuiError; end
+  class NotFoundError < LocaleuiError; end
+  class UnauthorizedError < LocaleuiError; end
+end

data/lib/localeui/http.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Localeui
+  class Http
+    def self.request(method:, endpoint:, params: {})
+      request = Localeui::Request.new
+      request.send(method, endpoint, params)
+    end
+  end
+end

data/lib/localeui/railtie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Localeui
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'tasks/localeui_tasks.rake'
+    end
+  end
+end

data/lib/localeui/request.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'http'
+
+module Localeui
+  class Request
+    def send(method, endpoint, params)
+      http_request = HTTP.headers(header)
+      response = http_request.public_send(method, url(endpoint), form: params)
+      Localeui::Response.new(http_request, response)
+    end
+
+    private
+
+    def url(endpoint)
+      raise NoBaseApiError, 'No api url set' if Localeui.base_api.nil? || Localeui.base_api.empty?
+
+      "#{Localeui.base_api}#{endpoint}"
+    end
+
+    def header
+      raise NoApiTokenError, 'No api token set' if Localeui.api_token.nil? || Localeui.api_token.empty?
+
+      { Authorization: "Bearer #{Localeui.api_token}" }
+    end
+  end
+end

data/lib/localeui/resources/event.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Localeui
+  class Event
+    def self.create
+      raise NoProjectError, 'No project initialised' if Localeui.project_id.nil? || Localeui.project_id.empty?
+
+      response = Localeui::Http.request(
+        method: :post,
+        endpoint: "projects/#{Localeui.project_id}/events"
+      )
+      Localeui::Utils.logger.info "Event '#{response.body['api_id']}' was successfully created"
+      response
+    end
+  end
+end

data/lib/localeui/resources/project.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Localeui
+  class Project
+    def self.info
+      # show project informations
+      raise NoProjectError, 'No project initialised' if Localeui.project_id.nil? || Localeui.project_id.empty?
+
+      response = Localeui::Http.request(
+        method: :get,
+        endpoint: "projects/#{Localeui.project_id}"
+      )
+      Localeui::Utils.logger.info "Project '#{response.body['api_id']}' informations were successfully requested"
+      response
+    end
+  end
+end

data/lib/localeui/resources/source_file.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Localeui
+  class SourceFile
+    def self.upload
+      raise NoProjectError, 'No project initialised' if Localeui.project_id.nil?
+
+      # Get all source files
+      files = all
+
+      # Create event
+      event = Localeui::Event.create
+
+      # Submit each file
+      files.each do |file|
+        file_upload(file, event)
+      end
+
+      { event: event.body['api_id'], files: files.count }
+    end
+
+    def self.download
+      raise NoProjectError, 'No project initialised' if Localeui.project_id.nil?
+
+      # TODO: think about, if we want to create an event
+
+      # Request all source files
+      files_response = files_to_download
+
+      # Request all locales
+      locales_response = locales_to_download
+
+      # Request each source file with file content
+      locales_response.body.each do |locale|
+        files_response.body.each do |file|
+          downloaded_file_response = download_file(file, locale)
+          store_file(downloaded_file_response)
+        end
+      end
+    end
+
+    def self.files_to_download
+      response = Localeui::Http.request(
+        method: :get, endpoint: "projects/#{Localeui.project_id}/source_files"
+      )
+      Localeui::Utils.logger.info "#{response.body.count} files will be downloaded"
+      response
+    end
+
+    def self.locales_to_download
+      response = Localeui::Http.request(
+        method: :get, endpoint: "projects/#{Localeui.project_id}/locales"
+      )
+      Localeui::Utils.logger.info "#{response.body.count} locale(s) available"
+      response
+    end
+
+    def self.store_file(file) # rubocop:disable Metrics/AbcSize
+      if Rails.env.test?
+        Localeui::Utils.logger.info "Skipping file storage for '#{file.body['name']}' in test environment"
+        return
+      end
+
+      file_path = [Localeui.locales_path, file.body['name']].join('/')
+      File.open file_path, 'w' do |f|
+        f.write YAML.dump(file.body['content'])
+        f.close
+      end
+      Localeui::Utils.logger.info "File '#{file.body['name']}' has been successfully stored under '#{file_path}'"
+    end
+
+    def self.download_file(file, locale)
+      response = Localeui::Http.request(
+        method: :get,
+        endpoint: "projects/#{Localeui.project_id}/source_files/#{file['api_id']}?locale_id=#{locale['api_id']}"
+      )
+      Localeui::Utils.logger.info "File '#{response.body['name']}' has been successfully downloaded"
+      response
+    end
+
+    def self.file_upload(file, event)
+      file_path = [Localeui.locales_path, file].join('/')
+
+      response = Localeui::Http.request(
+        method: :post, endpoint: "projects/#{Localeui.project_id}/source_files", params: {
+          filename: file, event_id: event.body['api_id'],
+          content: YAML.load_file(file_path).to_json
+        }
+      )
+      Localeui::Utils.logger.info "File '#{file}' has been successfully uploaded"
+      response
+    end
+
+    def self.all
+      files = Dir.glob("#{Localeui.locales_path}/**/*").select { |file| File.file?(file) }
+      files.map { |file| file[Rails.root.join('config/locales/').to_s.length..] }
+    end
+  end
+end

data/lib/localeui/response/status_codes.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Localeui
+  class Response
+    module StatusCodes
+      HTTP_OK_CODE = 200
+      HTTP_CREATED_CODE = 201
+      HTTP_BAD_REQUEST_CODE = 400
+      HTTP_UNAUTHORIZED_CODE = 401
+      HTTP_FORBIDDEN_CODE = 403
+      HTTP_NOT_FOUND_CODE = 404
+      HTTP_UNPROCESSABLE_ENTITY_CODE = 429
+    end
+  end
+end

data/lib/localeui/response.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'localeui/response/status_codes'
+
+module Localeui
+  class Response
+    include StatusCodes
+
+    attr_reader :request, :response, :headers, :status, :body
+
+    def initialize(request, response)
+      @request = request
+      @response = response
+      init_header
+      init_body
+      identifiy_errors
+    end
+
+    def successful?
+      [HTTP_OK_CODE, HTTP_CREATED_CODE].include?(@status)
+    end
+
+    private
+
+    def init_header
+      @headers = @response.headers
+      @status = @response.status
+    end
+
+    def init_body
+      @body = JSON.parse(@response.body)
+    end
+
+    def identifiy_errors
+      return nil if successful?
+
+      raise_error
+    end
+
+    def raise_error
+      error = error_class.new(@body)
+      raise error
+    end
+
+    def error_class # rubocop:disable Metrics/MethodLength
+      case @status
+      when HTTP_BAD_REQUEST_CODE
+        BadRequestError
+      when HTTP_UNAUTHORIZED_CODE
+        UnauthorizedError
+      when HTTP_FORBIDDEN_CODE
+        ForbiddenError
+      when HTTP_NOT_FOUND_CODE
+        NotFoundError
+      else
+        LocaleuiError
+      end
+    end
+  end
+end

data/lib/localeui/task/base.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# rubocop:disable Lint/EmptyClass
+
+module Localeui
+  module Task
+    class Base
+    end
+  end
+end
+
+# rubocop:enable Lint/EmptyClass

data/lib/localeui/task/download.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Localeui
+  module Task
+    class Download < Base
+      class << self
+        def download!
+          Localeui::SourceFile.download
+          Localeui::Utils.logger.info 'Task complete!'
+          true
+        end
+      end
+    end
+  end
+end

data/lib/localeui/task/project_info.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Localeui
+  module Task
+    class ProjectInfo < Base
+      class << self
+        def project_info!
+          response = Localeui::Project.info
+          pp response.body
+          true
+        end
+      end
+    end
+  end
+end

data/lib/localeui/task/upload.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Localeui
+  module Task
+    class Upload < Base
+      class << self
+        def upload!
+          Localeui::SourceFile.upload
+          Localeui::Utils.logger.info 'Task complete!'
+          true
+        end
+      end
+    end
+  end
+end

data/lib/localeui/utils.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module Localeui
+  module Utils
+    class << self
+      def logger
+        Logger.new($stdout)
+      end
+
+      def root
+        Pathname.new(rails_root || Dir.getwd)
+      end
+
+      def rails_root
+        return ::Rails.root.to_s if defined?(::Rails.root) && ::Rails.root
+        return RAILS_ROOT.to_s if defined?(RAILS_ROOT)
+
+        nil
+      end
+    end
+  end
+end

data/lib/localeui/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Localeui
+  VERSION = '0.1.0'
+end

data/lib/localeui.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Version
+require 'localeui/version'
+
+# Resources
+require 'localeui/resources/event'
+require 'localeui/resources/project'
+require 'localeui/resources/source_file'
+
+# Supporting classes
+require 'localeui/errors'
+require 'localeui/http'
+require 'localeui/request'
+require 'localeui/response'
+require 'localeui/utils'
+
+# Tasks classes
+require 'localeui/task/base'
+require 'localeui/task/download'
+require 'localeui/task/project_info'
+require 'localeui/task/upload'
+require 'localeui/railtie' if defined?(Rails)
+
+module Localeui
+  class << self
+    attr_accessor :base_api, :api_token, :project_id, :locales_path, :allow_overwriting
+
+    def config
+      yield self
+    end
+  end
+end

data/lib/tasks/localeui_tasks.rake

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'localeui'
+
+namespace :localeui do
+  desc 'Upload all translation source files to localeUI'
+  task upload: :environment do
+    Localeui::Task::Upload.upload!
+  end
+
+  desc 'Display project information from localeUI'
+  task project_info: :environment do
+    Localeui::Task::ProjectInfo.project_info!
+  end
+
+  desc 'Download all translation source files to localeUI'
+  task download: :environment do
+    Localeui::Task::Download.download!
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: localeui
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lars Klindwordt
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: optparse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: This gem allows to integrate LocaleUI to your locale Ruby on Rails application
+email:
+- lars.klindwordt@klind.de
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- Rakefile
+- lib/generators/localeui/install_generator.rb
+- lib/generators/templates/localeui_config.rb
+- lib/localeui.rb
+- lib/localeui/errors.rb
+- lib/localeui/http.rb
+- lib/localeui/railtie.rb
+- lib/localeui/request.rb
+- lib/localeui/resources/event.rb
+- lib/localeui/resources/project.rb
+- lib/localeui/resources/source_file.rb
+- lib/localeui/response.rb
+- lib/localeui/response/status_codes.rb
+- lib/localeui/task/base.rb
+- lib/localeui/task/download.rb
+- lib/localeui/task/project_info.rb
+- lib/localeui/task/upload.rb
+- lib/localeui/utils.rb
+- lib/localeui/version.rb
+- lib/tasks/localeui_tasks.rake
+homepage: https://localeui.com/en/docs/rails_gem/get-started
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://localeui.com/en/docs/rails_gem/get-started
+  source_code_uri: https://github.com/localeUI/localeui-rails
+  changelog_uri: https://github.com/localeUI/localeui-rails/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+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.7.2
+specification_version: 4
+summary: LocaleUI Gem for Ruby on Rails applications
+test_files: []