localedata 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa35b67d4dd4e4b8ae793fa8d14fc4a208c5d1e9e28f60ede7951d137ed6b6a7
+  data.tar.gz: 51302c306029316297b1757676c8feacf514b5fb62663276cc53ec1e7a8c6e8c
+SHA512:
+  metadata.gz: ab084ae29827b18272d07599963171286eda7948ff57f96e377ebd21728c07eb5724a410af4961f506c69b12489b82df9816cc7249d98572a37bbaff401980fb
+  data.tar.gz: d2608cde89e8ca2f0e70960ee045553d2561f184ac1eb272b14a53c548d49896435b31696800875fb6bcbccd1729f2facda3e4e2e8bbdc6329e55470e0f8fe52

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## 0.1.0 (2019-05-02)
+
+- Add `localedata install` command to create a default configuration file
+- Add `localedata pull` command to download translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 LocaleData
+
+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,68 @@
+# LocaleData Client
+
+The `localedata` gem provides a command line interface for the Ruby on Rails translation management platform LocaleData on https://www.localedata.com.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "localedata", group: :development
+```
+
+Execute the following command:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install localedata
+```
+
+Finally, create the default configuration file:
+
+```bash
+$ bundle exec localedata install
+```
+
+## Configuration
+
+You need to configure your access token on your development machine. Add the folowing line into your `.bashrc` (or `.zshrc`) file:
+
+```bash
+export LOCALEDATA_ACCESS_TOKEN="YOUR-SECRET-ACCESS-TOKEN"
+```
+
+You can edit the configuration in `config/localedata.yml`:
+
+```yaml
+projects:
+  - id: "YOUR-PROJECT-ID"
+    locales:
+      en: "config/locales/en.yml"
+      sk: "config/locales/sk.yml"
+```
+
+You can find the project ID and your access token on your LocaleData project page.
+
+## Usage
+
+```bash
+localedata pull       # downloads all your locales
+localedata pull en de # downloads only the en and de locales
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/localedata/localedata-client. 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.
+
+## 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 LocaleData Client project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/localedata/localedata-client/blob/master/CODE_OF_CONDUCT.md).

data/bin/localedata

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "localedata"
+Localedata::Cli.start(ARGV)

data/lib/localedata/cli.rb

@@ -0,0 +1,22 @@
+require "thor"
+
+module Localedata
+  class Cli < Thor
+    desc "install [PROJECT_ID]", "Create a default configuration file"
+    def install(project_id=nil)
+      installer = Localedata::Installer.new
+      installer.install(project_id)
+    end
+
+    desc "pull [LOCALES]", "Download the configured locales"
+    def pull(*locales)
+      downloader = Localedata::Downloader.new
+      downloader.download(locales)
+    end
+
+    desc "version", "Print the current version"
+    def version
+      puts "Localedata #{Localedata::VERSION}"
+    end
+  end
+end

data/lib/localedata/client.rb

@@ -0,0 +1,43 @@
+require "json"
+require "faraday"
+
+module Localedata
+  class Client
+    def initialize(access_token)
+      @access_token = access_token
+    end
+
+    def pull(project_id, locale)
+      success = false
+      status_code = 0
+      yaml_data = nil
+      error_message = nil
+
+      begin
+        get_data = { access_token: @access_token, project_id: project_id, language_code: locale }
+        response = connection.get("/api/v1/exports", get_data)
+
+        success = response.success?
+        status_code = response.status
+
+        data = JSON.parse(response.body)
+        yaml_data = data["yaml"]
+        error_message = data["error"]
+
+      rescue Faraday::ConnectionFailed
+        success = false
+        error_message = "API connection failed."
+
+      rescue JSON::ParserError
+        success = false
+        error_message = "API response parsing failed."
+      end
+
+      { success: success, status_code: status_code, yaml: yaml_data, error: error_message }
+    end
+
+    def connection
+      @connection ||= Faraday.new(url: "https://app.localedata.com")
+    end
+  end
+end

data/lib/localedata/configuration.rb

@@ -0,0 +1,92 @@
+require "erb"
+require "yaml"
+
+module Localedata
+  class Configuration
+    attr_reader :access_token
+    attr_reader :projects
+
+    def initialize
+      @access_token = ENV["LOCALEDATA_ACCESS_TOKEN"]
+      @projects = []
+    end
+
+    def load_config_file
+      validate_config_file!
+
+      file_content = File.read(config_file_path)
+      yaml_data = ERB.new(file_content).result
+      config_data = YAML.load(yaml_data)
+
+      @access_token = (config_data["access_token"] || @access_token)
+      @projects = (config_data["projects"] || @projects)
+
+      validate_configuration!
+    end
+
+    def relative_config_file_path
+      File.join("config", "localedata.yml")
+    end
+
+    def config_file_path
+      File.expand_path(relative_config_file_path)
+    end
+
+  private
+
+    def validate_config_file!
+      unless File.exist?(config_file_path)
+        puts "Error: #{relative_file_path} does not exist."
+        exit 1
+      end
+
+      unless File.readable?(config_file_path)
+        puts "Error: #{relative_file_path} is not readable."
+        exit 1
+      end
+    end
+
+    def validate_configuration!
+      if @access_token.to_s.strip.empty?
+        puts "Error: \"access_token\" is missing."
+        exit 1
+      end
+
+      unless @projects.kind_of?(Array)
+        puts "Error: \"projects\" is not an array."
+        exit 1
+      end
+
+      @projects.each do |project|
+        if project["id"].to_s.strip.empty?
+          puts "Error: \"id\" in \"projects\" is missing."
+          exit 1
+        end
+
+        unless project["locales"].kind_of?(Hash)
+          puts "Error: \"locales\" in \"projects\" is not a hash."
+          exit 1
+        end
+
+        project["locales"].each do |language_code, relative_file_path|
+          file_path = File.expand_path(relative_file_path)
+
+          unless File.exist?(file_path)
+            puts "Error: #{relative_file_path} does not exist."
+            exit 1
+          end
+
+          unless File.readable?(file_path)
+            puts "Error: #{relative_file_path} is not readable."
+            exit 1
+          end
+
+          unless File.writable?(file_path)
+            puts "Error: #{relative_file_path} is not writable."
+            exit 1
+          end
+        end
+      end
+    end
+  end
+end

data/lib/localedata/downloader.rb

@@ -0,0 +1,26 @@
+module Localedata
+  class Downloader
+    def download(locales)
+      configuration = Localedata::Configuration.new
+      configuration.load_config_file
+
+      client = Localedata::Client.new(configuration.access_token)
+      configuration.projects.each do |project|
+        project["locales"].each do |language_code, relative_file_path|
+          next if locales.any? && !locales.include?(language_code)
+
+          print "Downloading #{language_code} into #{relative_file_path}..."
+          data = client.pull(project["id"], language_code)
+          if data[:success]
+            file_path = File.expand_path(relative_file_path)
+            File.write(file_path, data[:yaml])
+            puts "Done."
+          else
+            puts "FAIL!"
+            puts "Error #{data[:status_code]}: #{data[:error]}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/localedata/installer.rb

@@ -0,0 +1,41 @@
+module Localedata
+  class Installer
+    def install(project_id)
+      configuration = Localedata::Configuration.new
+
+      relative_config_file_path = configuration.relative_config_file_path
+      config_file_path = configuration.config_file_path
+
+      if File.exist?(config_file_path)
+        puts "A #{relative_config_file_path} already exists."
+        return
+      end
+
+      FileUtils.mkdir_p(File.dirname(config_file_path))
+      File.write(config_file_path, default_config(project_id))
+
+      puts congratulation(relative_config_file_path)
+    end
+
+  private
+
+    def default_config(project_id)
+      <<~YAML
+        projects:
+          - id: "#{project_id || 'YOUR-PROJECT-ID'}"
+            locales:
+              en: "config/locales/en.yml"
+      YAML
+    end
+
+    def congratulation(config_file_path)
+      <<~CONGRATS
+        Congratulations! Localedata was successfully installed.
+        We generated a config file containing some default settings:
+
+          #{config_file_path}
+
+      CONGRATS
+    end
+  end
+end

data/lib/localedata/version.rb

@@ -0,0 +1,3 @@
+module Localedata
+  VERSION = "0.1.0"
+end

data/lib/localedata.rb

@@ -0,0 +1,9 @@
+require "localedata/version"
+require "localedata/configuration"
+require "localedata/cli"
+require "localedata/client"
+require "localedata/installer"
+require "localedata/downloader"
+
+module Localedata
+end

data/localedata.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "localedata/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "localedata"
+  spec.version = Localedata::VERSION
+  spec.authors = ["Juraj Kostolansky"]
+  spec.email   = ["hello@localedata.com"]
+
+  spec.summary  = "CLI for the Ruby on Rails translation management platform LocaleData"
+  spec.homepage = "https://github.com/localedata/localedata-client"
+  spec.license  = "MIT"
+
+  spec.files = Dir["README.md", "LICENSE.txt", "CHANGELOG.md", "localedata.gemspec",
+    "lib/**/*.rb", "bin/*"]
+
+  spec.require_paths = ["lib"]
+  spec.executables   = ["localedata"]
+
+  spec.required_ruby_version = ">= 2.3.0"
+
+  spec.add_dependency 'thor', '>= 0.20.0'
+  spec.add_dependency 'faraday', '>= 0.12.0'
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: localedata
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Juraj Kostolansky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+description: 
+email:
+- hello@localedata.com
+executables:
+- localedata
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- bin/localedata
+- lib/localedata.rb
+- lib/localedata/cli.rb
+- lib/localedata/client.rb
+- lib/localedata/configuration.rb
+- lib/localedata/downloader.rb
+- lib/localedata/installer.rb
+- lib/localedata/version.rb
+- localedata.gemspec
+homepage: https://github.com/localedata/localedata-client
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: CLI for the Ruby on Rails translation management platform LocaleData
+test_files: []