polyglot_cli 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae72077047be9a770cf1ce424f9591f153a342d7
-  data.tar.gz: 82447037cdd587057e644b3e797e3248d90365c0
+  metadata.gz: 642fd850f33d45c62506232f920482c9ba8975df
+  data.tar.gz: e4d3d1f9bd6dbef49d96919ed1af1f6856b9725e
 SHA512:
-  metadata.gz: 3ad2c8a20c1d4c9a6dafc9c55e5485328fcc4a28034f53777df0b66412cb7d5bd59b903a4201c8718a5b43ea209426cd0a368ecb68825b5ce76af7b11a852a4f
-  data.tar.gz: 85a71e6b4028c54d0b1edb62ed28b66b800c8a0b450b26494db33f2448c94c28a8dcc3388921addb29fa497d1a99595386c1f6a7e2a32d3987e77cb5347947f5
+  metadata.gz: d7099829ae98fce77983b920a04a21114235b8582a32961c18e6e9a139caef73f1ca8348e6ca29dd30ad67ea467734bb0e8be7265ee97b07054cc8bc85ec40de
+  data.tar.gz: 8b5e040c81b143ce63869727d45f447ea7fb41f00b7ec7f0d3ad7bc22eb7ea042e6eb69b577d132fe322be0fee1e4ca11e57cea5233fc1cd56ef9b6196b3441f

data/README.md

@@ -1,8 +1,9 @@
 # PolyglotCli
 
-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/polyglot_cli`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/polyglot_cli.svg)](https://badge.fury.io/rb/polyglot_cli) [![Code Climate](https://codeclimate.com/repos/5875055a2c6a0b7145003aec/badges/37ca549d69fb7b786979/gpa.svg)](https://codeclimate.com/repos/5875055a2c6a0b7145003aec/feed) [![Test Coverage](https://codeclimate.com/repos/5875055a2c6a0b7145003aec/badges/37ca549d69fb7b786979/coverage.svg)](https://codeclimate.com/repos/5875055a2c6a0b7145003aec/coverage) [![Issue Count](https://codeclimate.com/repos/5875055a2c6a0b7145003aec/badges/37ca549d69fb7b786979/issue_count.svg)](https://codeclimate.com/repos/5875055a2c6a0b7145003aec/feed) [![Build Status](https://semaphoreci.com/api/v1/projects/13ad022a-36ce-4b0d-9d3d-48634e2c2591/1126271/shields_badge.svg)](https://semaphoreci.com/infinum/rails-polyglot-cli)
 
-TODO: Delete this and the text above, and describe your gem
+
+Pulls and pushes translations to and from locale files.
 
 ## Installation
 
@@ -20,9 +21,38 @@ Or install it yourself as:
 
     $ gem install polyglot_cli
 
+## Setup
+All commands have --help with detailed descriptions of options.
+
+First we need to login to Polyglot:
+
+    polyglot login
+
+This will prompt you for your email and password. If the the login attempt is successful. The API token will be written to a file in your home directory: `~/.polyglot.auth`
+
+Next you have to initialize the project and go through a quick setup:
+
+    polyglot init
+
+This will prompt you to choose from a list of projects, and set your locale directory. The default locale directory is `config/locales` for rails apps.
+
 ## Usage
+Once you have setup the project you can use any of the following commands:
+
+### polyglot pull
+This command will query the Polyglot API and retrieve all translations. If you use the `--locale` option it will only retrieve that locale. If you use `--path` option you will override the default locale path. Both options are optional. Please be careful when pulling, it will overwrite any changes that are not stored on the server.
+
+    polyglot pull [--locale --path]
+
+### polyglot push
+This command will read the locale files and push them to the server. It will update and create both translations and translation keys. If your locales aren't up to date with the server, the command will fail. If you use the `--locale` option it will only retrieve that locale. If you use `--path` option you will override the default locale path. Both options are optional.
 
-TODO: Write usage instructions here
+    polyglot push [--locale --path]
+
+### polyglot status
+This command simply checks if your version of the locales are up to date with the sever.
+
+    polyglot status
 
 ## Development
 
@@ -32,10 +62,9 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/polyglot_cli.
+Bug reports and pull requests are welcome on Bitbucket at https://bitbucket.org/infinum_hr/rails-polyglot-cli/.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/polyglot_cli/commands/login.rb

@@ -7,11 +7,6 @@ module PolyglotCli
         new.call
       end
 
-      def initialize
-        @email = prompt.ask('Email:') { |q| q.validate :email }
-        @password = prompt.mask('Password:')
-      end
-
       def call
         PolyglotCli::IO::Token.write(token)
         success
@@ -21,7 +16,15 @@ module PolyglotCli
 
       def token
         prompt.say('Logging into API...')
-        PolyglotCli::Resource::Session.create(email: @email, password: @password).token
+        PolyglotCli::Resource::Session.create(email: email, password: password).token
+      end
+
+      def email
+        prompt.ask('Email:') { |q| q.validate :email }
+      end
+
+      def password
+        prompt.mask('Password:')
       end
     end
   end

data/lib/polyglot_cli/commands/pull.rb

@@ -10,12 +10,11 @@ module PolyglotCli
       end
 
       def initialize(options)
-        @locale = options.locale
-        @path = options.path
+        @options = options
       end
 
       def call
-        languages(@locale).each do |language|
+        languages(option_locale).each do |language|
           PolyglotCli::IO::Locale.write(locale_path, translation_hash(language))
         end
         update_config
@@ -25,7 +24,15 @@ module PolyglotCli
       private
 
       def locale_path
-        @path || config[:locale_path]
+        option_path || config[:locale_path]
+      end
+
+      def option_locale
+        @options.locale
+      end
+
+      def option_path
+        @options.path
       end
 
       def translation_hash(language)

data/lib/polyglot_cli/commands/push.rb

@@ -10,15 +10,14 @@ module PolyglotCli
       end
 
       def initialize(options)
-        @locale = options.locale
-        @path = options.path
+        @options = options
       end
 
       def call
         if server_changed?
           prompt.error('Changes have been made on the server. Please pull before pushing.')
         else
-          languages(@locale).each do |language|
+          languages(option_locale).each do |language|
             prompt.say("Processing push for #{language.name}...")
             process(language)
           end
@@ -95,8 +94,16 @@ module PolyglotCli
         denest(PolyglotCli::IO::Locale.read(locale_path, locale)[locale])
       end
 
+      def option_locale
+        @options.locale
+      end
+
+      def option_path
+        @options.path
+      end
+
       def locale_path
-        @path || config[:locale_path]
+        option_path || config[:locale_path]
       end
     end
   end

data/lib/polyglot_cli/resources/base.rb

@@ -3,7 +3,7 @@ module PolyglotCli
     class Base < JsonApiClient::Resource
       extend PolyglotCli::Helper::Depaginate
 
-      self.site = if ENV['POLYGLOT_CLI_ENV'] == 'development'
+      self.site = if ENV['POLYGLOT_CLI_ENV'] == 'development' || ENV['POLYGLOT_CLI_ENV'] == 'test'
                     'http://polyglot.infinum.co.dev/api/v2/'
                   else
                     'https://polyglot.infinum.co/api/v2/'

data/lib/polyglot_cli/version.rb

@@ -1,3 +1,3 @@
 module PolyglotCli
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

data/lib/polyglot_cli.rb

@@ -1,4 +1,4 @@
-require 'YAML'
+require 'yaml'
 require 'polyglot_cli/version'
 
 # Helpers

data/polyglot_cli.gemspec

@@ -10,17 +10,11 @@ Gem::Specification.new do |spec|
   spec.email         = ['ivan.grgurevic@infinum.hr']
 
   spec.summary       = 'A ruby cli for pulling and pushing polyglot translations'
-  # spec.description   = 'Write a longer description or delete this line.'
-  # spec.homepage      = "Put your gem's website or public repo URL here."
+  spec.description   = 'A ruby cli that takes translations from Polyglot and writes them to yml locale files. Also allows pushing of new translations to Polyglot.'
+  spec.homepage      = 'https://bitbucket.org/infinum_hr/rails-polyglot-cli/'
   spec.license       = 'MIT'
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
-  end
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -29,10 +23,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'bundler', '~> 1.12.5'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'pry-byebug', '~> 3.4'
+  spec.add_development_dependency 'vcr', '~> 3.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0'
+  spec.add_development_dependency 'webmock', '~> 2.3.2'
   spec.add_dependency 'json_api_client'
   spec.add_dependency 'commander'
   spec.add_dependency 'tty-prompt'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polyglot_cli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ivan Grgurevic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-09 00:00:00.000000000 Z
+date: 2017-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 1.12.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 1.12.5
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -54,6 +54,34 @@ dependencies:
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
 - !ruby/object:Gem::Dependency
   name: json_api_client
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +164,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description: A ruby cli that takes translations from Polyglot and writes them to yml
+  locale files. Also allows pushing of new translations to Polyglot.
 email:
 - ivan.grgurevic@infinum.hr
 executables:
@@ -150,7 +207,7 @@ files:
 - lib/polyglot_cli/resources/translation_key.rb
 - lib/polyglot_cli/version.rb
 - polyglot_cli.gemspec
-homepage: 
+homepage: https://bitbucket.org/infinum_hr/rails-polyglot-cli/
 licenses:
 - MIT
 metadata: