applocale-ruby 0.0.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 992e5cd3f0948c9f7cb7a20d8937d6ec62e1bd2b9f009260ca18f01e8770868d
+  data.tar.gz: 27138c786bd8aa1cba40b574ec316f0b9ba0ac1ed8101f5a0f12d576ecd59417
+SHA512:
+  metadata.gz: fbb57f422b89498e5e095d2ddbe24e578cc04c278e33fca46f6ddad75c05b2a2cb880b3f9cfa3a1d386f33a1e4cfabdc330c4884f73f2273c9ac2528e97742d7
+  data.tar.gz: 81d5b21b2dc7bcbd5b1d1abea9d4c6dea6058ba77b4d0b59af1b4ae43b647ad5b990b1bb7bedc476cd72a64e1ea3fb31cbc699753aa39f78458f969565007865

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/test/sample-locales
+
+/config/applocale.yml
+*.applocale.yml

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.0.10
+
+- Initial public release, welcome to a better way to manage your app translations 👋

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at andrew@zerlex.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in applocale-ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    applocale-ruby (0.0.10)
+      httparty (~> 0.18.0)
+      thor (>= 0.18.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.18.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    minitest (5.14.0)
+    multi_xml (0.6.0)
+    rake (10.5.0)
+    thor (1.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  applocale-ruby!
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -0,0 +1,77 @@
+# AppLocale
+
+Welcome to AppLocale's Ruby gem. This gem helps customers of AppLocale.dev to easily pull down their
+latest translations with a simple `bundle exec applocale pull`.
+
+Getting started with AppLocale will give you a free 14-day trial.
+
+## Installation
+
+### With our RailsBytes application template:
+
+This application template will install the gem for you, and walk you through setting up a configration file for your project. You'll need to login to your https://applocale.dev account, click on your avatar and click API Tokens to have the information ready for this step.
+
+You should **always** review contents of scripts you run before hand, you may do so by visiting this url and reading the script: https://railsbytes.com/public/templates/X8Bsjj
+
+```
+rails app:template LOCATION="https://railsbytes.com/script/X8Bsjj"
+```
+
+### Manually:
+
+Add this line to your application's Gemfile:
+
+```ruby
+
+group :development do
+  gem 'applocale-ruby'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install applocale-ruby
+
+Then follow the instructions in Usage to setup your configuration file.
+
+## Usage
+
+Using AppLocale's gem requires a configuration file to be present. By default we assume this file to
+live at `config/applocale.yml` but you can alternatively run each command with `--config-file=path-to-applocale.yml`
+
+You'll need to login to your https://applocale.dev account, click on your avatar and click API Tokens to have the information ready for this step after creating an API Token and Project.
+
+**Sample configuration file:**
+
+```yaml
+applocale:
+  project_id: 234qfewaf
+  api_key: API_KEY_HERE
+  locale_directory: "config/locales" # Default, you can override this if you wish.
+```
+
+Once you have your configuration file setup for your project you can proceed to use the following commands.
+
+After that, to pull ALL your setup languages in AppLocale:
+
+```
+bundle exec applocale pull
+```
+
+Or just your specified languages:
+
+```
+bundle exec applocale en es
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/applocale/applocale-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the Applocale::Ruby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/applocale/applocale-ruby/blob/master/CODE_OF_CONDUCT.md).

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/applocale-ruby.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "applocale/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "applocale-ruby"
+  spec.version       = AppLocale::VERSION
+  spec.authors       = ["Andrew Fomera"]
+  spec.email         = ["andrew@zerlex.net"]
+
+  spec.summary       = %q{Easily pull in your locales from AppLocale.dev}
+  spec.description   = %q{Easily pull in your locales from AppLocale.dev}
+  spec.homepage      = "https://applocale.dev"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/applocale/applocale-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/applocale/applocale-ruby/blob/master/CHANGELOG.md"
+
+  # 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.required_ruby_version = ">= 2.3.0"
+
+  spec.add_dependency 'httparty', '~> 0.18.0'
+  spec.add_dependency 'thor', '>= 0.18.0'
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/bin/applocale

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require "applocale/ruby"
+
+AppLocale::Cli.start(ARGV)

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "applocale/ruby"
+
+# 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/exe/applocale

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require "applocale/ruby"
+
+AppLocale::Cli.start(ARGV)

data/lib/applocale/base_command.rb

@@ -0,0 +1,10 @@
+module AppLocale
+  class BaseCommand
+    attr_accessor(:config, :options)
+
+    def initialize(config, options)
+      @config = config
+      @options = options
+    end
+  end
+end

data/lib/applocale/cli.rb

@@ -0,0 +1,36 @@
+require "thor"
+
+module AppLocale
+  class Cli < ::Thor
+    class_option 'config-file',
+      default: "config/applocale.yml",
+      desc: "Customize the location of the config file"
+    class_option 'verbose',
+      type: :boolean,
+      desc: "Turn on additional logging, helpful for debugging."
+
+    desc "pull [en es]", "Downloads all translations, optionally pass specifc locales"
+    long_desc <<-LONGDESC
+    `applocale pull` will fetch all locales from AppLocale.
+
+    You can optionally specify language codes, which will only
+    fetch locales for those specifc languages.
+
+    > $ applocale pull en es de
+    LONGDESC
+    def pull(*languages)
+      AppLocale::Pull.new(config, options).call(languages)
+    end
+
+    desc "version", "Print the current version"
+    def version
+      puts "AppLocale Version: #{AppLocale::VERSION}"
+    end
+
+    private
+
+    def config
+      @config ||= AppLocale::Config.load(options['config-file'])
+    end
+  end
+end

data/lib/applocale/client.rb

@@ -0,0 +1,83 @@
+require 'httparty'
+
+module AppLocale
+  class Client
+    include HTTParty
+    attr_reader(:params)
+
+    def initialize(params = {})
+      @params = params
+    end
+
+    # Required params:
+    # - api_key
+    # - project_id
+    #
+    # Optionally:
+    # - locale
+    # pass single code of language for export
+    def export(language = nil)
+      request(:export, body: export_params(language))
+    end
+
+    def project_information
+      request(:project_show)
+    end
+
+    private
+
+    def project_id
+      params[:project_id]
+    end
+
+    def export_params(language)
+      export_params = { project_id: project_id }
+      if language
+        export_params.merge!(locale: language)
+      end
+      export_params
+    end
+
+    def request(action, body: {}, options: {})
+      HTTParty.send(
+        routes[action][:method],
+        routes[action][:endpoint],
+        base_payload(body, options)
+      ).parsed_response
+    end
+
+    # rubocop: disable Metrics/MethodLength
+    def routes
+      {
+        project_show: {
+          method: :get,
+          endpoint: "#{base_uri}/projects/#{project_id}"
+        },
+        export: {
+          method: :post,
+          endpoint: "#{base_uri}/exports"
+        }
+      }
+    end
+    # rubocop: enable Metrics/MethodLength
+
+    def base_payload(body = {}, options = {})
+      {
+        headers: {
+          'Accept' => 'application/json',
+          'Authorization' => "Bearer #{params[:api_key]}",
+          'User-Agent' => "AppLocale-Ruby:#{AppLocale::VERSION}"
+        },
+        body: body
+      }.merge(options)
+    end
+
+    # Private: base_uri
+    #
+    def base_uri
+      return "http://localhost:5000/api/v1" if ENV['APPLOCALE_DEVELOPMENT']
+
+      "https://applocale.dev/api/v1"
+    end
+  end
+end

data/lib/applocale/config.rb

@@ -0,0 +1,58 @@
+require "erb"
+require "yaml"
+
+module AppLocale
+  class Config
+    attr_accessor(:config_file, :configuration_data, :api_key, :project_id, :locale_directory)
+
+    def self.load(config_file)
+      new(config_file)
+    end
+
+    def initialize(config_file)
+      @config_file = config_file
+      parse_config_file!
+      @api_key = env_or_config_value('api_key')
+      @project_id = env_or_config_value('project_id')
+      @locale_directory = env_or_config_value('locale_directory', default: 'config/locales')
+    end
+
+    def parse_config_file!
+      validate_config_file!
+
+      file_content = File.read(config_file_path)
+      parsed_config_file = ERB.new(file_content).result
+      @configuration_data = YAML.load(parsed_config_file).dig("applocale") || {}
+    end
+
+    def validate_config_file!
+      unless File.exists?(config_file_path)
+        puts "[AppLocale] Error: #{config_file_path} does not exist."
+        exit 1
+      end
+
+      unless File.readable?(config_file_path)
+        puts "[AppLocale] Error: #{config_file_path} is not readable by AppLocale."
+        exit 1
+      end
+    end
+
+    private
+
+    def config_file_path
+      File.expand_path(config_file)
+    end
+
+    def env_or_config_value(key, required: true, default: nil)
+      value = ENV["APPLOCALE_#{key.upcase}"] || configuration_data.dig(key.to_s)
+      if required && (!value || value == "") && !default
+        raise ArgumentError, "Missing APPLOCALE_#{key.upcase} or key in config/applocale.yml"
+      end
+      value || default
+    end
+
+    def config_value_or_default(key, default: nil)
+      configuration_data.dig(key.to_s) || default
+    end
+  end
+end

data/lib/applocale/file_writer.rb

@@ -0,0 +1,21 @@
+require 'fileutils'
+
+module AppLocale
+  class FileWriter < AppLocale::BaseCommand
+    def call(response)
+      create_locale_directory unless File.directory?(config.locale_directory)
+
+      relative_file_path = "#{config.locale_directory}/#{response.dig('language_code')}.yml"
+      file_path = File.expand_path(relative_file_path)
+      File.write(file_path, response.dig('yaml'))
+      puts "[AppLocale] ↳ Wrote translations for #{response.dig('language_code')} to #{relative_file_path}"
+    end
+
+    private
+
+    def create_locale_directory
+      FileUtils.mkdir_p(config.locale_directory)
+      puts "[AppLocale] Created #{config.locale_directory} directory"
+    end
+  end
+end

data/lib/applocale/pull.rb

@@ -0,0 +1,46 @@
+module AppLocale
+  class Pull < AppLocale::BaseCommand
+    def call(languages)
+      # The user did not pass in specifc languages to ask AppLocale about.
+      # Let's fetch the languages for the project and then loop over them.
+      if languages.empty?
+        puts "[AppLocale] Fetching list of languages..."
+        response = client.project_information
+        if response.dig("success")
+          languages = response.dig("languages")
+          puts "[AppLocale] ↳ Received #{languages} from AppLocale..." if options[:verbose]
+        else
+          puts "[AppLocale] #{response.dig('message')}"
+          exit 1
+        end
+      end
+
+      if languages.any?
+        languages.each do |language_code|
+          puts "[AppLocale] Fetching translations for #{language_code}..."
+          response = client.export(language_code)
+          if response.dig("success")
+            puts "[AppLocale] ↳ Received #{response} from AppLocale" if options[:verbose]
+            AppLocale::FileWriter.new(config, options).call(response)
+          else
+            puts "[AppLocale] #{response.dig('message')}"
+            exit 1
+          end
+        end
+      else
+        puts "[AppLocale] Sorry, no languages were found for the project."
+        exit 1
+      end
+    end
+
+    private
+
+    def params
+      { api_key: config.api_key, project_id: config.project_id }
+    end
+
+    def client
+      @client ||= AppLocale::Client.new(params)
+    end
+  end
+end

data/lib/applocale/ruby.rb

@@ -0,0 +1,19 @@
+# This ruby.rb file is required to keep the gem working properly since the
+# applocale gem was already taken :(
+# But we want to name our gem files AppLocale anyway and the commands the same.
+
+require "applocale/version"
+require "applocale/client"
+require "applocale/cli"
+require "applocale/config"
+
+# BaseCommand holds configuration option used in various other classes
+require "applocale/base_command"
+require "applocale/pull"
+require "applocale/file_writer"
+
+module Applocale
+  module Ruby
+    class Error < StandardError; end
+  end
+end

data/lib/applocale/version.rb

@@ -0,0 +1,3 @@
+module AppLocale
+  VERSION = "0.0.10".freeze
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: applocale-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.10
+platform: ruby
+authors:
+- Andrew Fomera
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Easily pull in your locales from AppLocale.dev
+email:
+- andrew@zerlex.net
+executables:
+- applocale
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- applocale-ruby.gemspec
+- bin/applocale
+- bin/console
+- bin/setup
+- exe/applocale
+- lib/applocale/base_command.rb
+- lib/applocale/cli.rb
+- lib/applocale/client.rb
+- lib/applocale/config.rb
+- lib/applocale/file_writer.rb
+- lib/applocale/pull.rb
+- lib/applocale/ruby.rb
+- lib/applocale/version.rb
+homepage: https://applocale.dev
+licenses: []
+metadata:
+  homepage_uri: https://applocale.dev
+  source_code_uri: https://github.com/applocale/applocale-ruby
+  changelog_uri: https://github.com/applocale/applocale-ruby/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Easily pull in your locales from AppLocale.dev
+test_files: []