applocale-ruby 0.0.2 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd22813435f5b08b939eb097c9f0e10193a4aa04843491ff439e9eac91745e42
-  data.tar.gz: a1a0c8d9f364f85be39d203502bb0307940727fb417ef9d3e4dced91efb54e45
+  metadata.gz: 992e5cd3f0948c9f7cb7a20d8937d6ec62e1bd2b9f009260ca18f01e8770868d
+  data.tar.gz: 27138c786bd8aa1cba40b574ec316f0b9ba0ac1ed8101f5a0f12d576ecd59417
 SHA512:
-  metadata.gz: 6fe6c97dd21584e6f9fe18ff53e3e1e26fd8c8dff6cea7e2f1038500976242fb0353066fd448aa18877e79af37e3e1ae5386b10850f933b14c3f1e0ac390e7cf
-  data.tar.gz: 93814906a356d82240e71de93e5996f22be1b2d4a6257833d4138760ea7a0e2fb5d95ec61d797b70f788cd188ae9b7ce3adb679f2e07a154de095477a7dfee50
+  metadata.gz: fbb57f422b89498e5e095d2ddbe24e578cc04c278e33fca46f6ddad75c05b2a2cb880b3f9cfa3a1d386f33a1e4cfabdc330c4884f73f2273c9ac2528e97742d7
+  data.tar.gz: 81d5b21b2dc7bcbd5b1d1abea9d4c6dea6058ba77b4d0b59af1b4ae43b647ad5b990b1bb7bedc476cd72a64e1ea3fb31cbc699753aa39f78458f969565007865

data/CHANGELOG.md

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

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    applocale-ruby (0.0.2)
+    applocale-ruby (0.0.10)
       httparty (~> 0.18.0)
-      thor (~> 1.0)
+      thor (>= 0.18.0)
 
 GEM
   remote: https://rubygems.org/
@@ -13,7 +13,7 @@ GEM
       multi_xml (>= 0.5.2)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2020.0425)
+    mime-types-data (3.2020.0512)
     minitest (5.14.0)
     multi_xml (0.6.0)
     rake (10.5.0)

data/README.md

@@ -1,15 +1,31 @@
-# Applocale::Ruby
+# AppLocale
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/applocale/ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
+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`.
 
-TODO: Delete this and the text above, and describe your gem
+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
-gem 'applocale-ruby'
+
+group :development do
+  gem 'applocale-ruby'
+end
 ```
 
 And then execute:
@@ -20,20 +36,42 @@ Or install it yourself as:
 
     $ gem install applocale-ruby
 
+Then follow the instructions in Usage to setup your configuration file.
+
 ## Usage
 
-TODO: Write usage instructions here
+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`
 
-## Development
+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.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+**Sample configuration file:**
 
-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).
+```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/[USERNAME]/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.
+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/[USERNAME]/applocale-ruby/blob/master/CODE_OF_CONDUCT.md).
+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/applocale-ruby.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
 
   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"
+  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.
@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.3.0"
 
   spec.add_dependency 'httparty', '~> 0.18.0'
-  spec.add_dependency 'thor', '~> 1.0'
+  spec.add_dependency 'thor', '>= 0.18.0'
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/applocale/file_writer.rb

@@ -8,7 +8,7 @@ module AppLocale
       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}"
+      puts "[AppLocale] ↳ Wrote translations for #{response.dig('language_code')} to #{relative_file_path}"
     end
 
     private

data/lib/applocale/pull.rb

@@ -8,7 +8,7 @@ module AppLocale
         response = client.project_information
         if response.dig("success")
           languages = response.dig("languages")
-          puts "[AppLocale] Received #{languages} from AppLocale..." if options[:verbose]
+          puts "[AppLocale] ↳ Received #{languages} from AppLocale..." if options[:verbose]
         else
           puts "[AppLocale] #{response.dig('message')}"
           exit 1
@@ -20,7 +20,7 @@ module AppLocale
           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]
+            puts "[AppLocale] ↳ Received #{response} from AppLocale" if options[:verbose]
             AppLocale::FileWriter.new(config, options).call(response)
           else
             puts "[AppLocale] #{response.dig('message')}"

data/lib/applocale/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: applocale-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.10
 platform: ruby
 authors:
 - Andrew Fomera
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-10 00:00:00.000000000 Z
+date: 2020-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -28,16 +28,16 @@ dependencies:
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.18.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.18.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -89,6 +89,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -112,7 +113,7 @@ licenses: []
 metadata:
   homepage_uri: https://applocale.dev
   source_code_uri: https://github.com/applocale/applocale-ruby
-  changelog_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: