smartling_rails 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82d5e6986da0ca41df9f8f6f00d4671ce40ec92c
-  data.tar.gz: 03ef9ed1735b02db0e04f9e95f402994d648c182
+  metadata.gz: a04f810e2a6ec749972f35b89f18f9f2d933c5a1
+  data.tar.gz: ee2de26466dc506be0adea8ac8e419d3985c1b08
 SHA512:
-  metadata.gz: 0ba98e6de6a08e885b3e66891fad9cb6a19d21e9709fd10baf4b91919ee1fc378b8ed1d72053e4c671a7ba9cd5424dcfa9bb100a9c7fdc6eaa6779eb80fbdd74
-  data.tar.gz: 1841825530d247fce72af930d0cbc43349335555728ca8a6bcaa681e98d98fe5315bdf44cb72c20c1a867321db8cf3aa175daccaee7bd47e44819592a703f730
+  metadata.gz: d59cacf6199a64d1ec43ac3ce6a33bf0459126c4e828ec0d0d4d3a7f7f503c5b9bb3d1e05f0d9da5580a5064402bc36940e3e11c78ccb388c1de2680666f7a3b
+  data.tar.gz: 1473e021757bd5181696d4b5f685a2236ab9bcb921373295616f42edf31ffe5dd7bdf15789ff8c00ffd3c1f56f4e22e7a749abdfa45cddff5dbf37acad0f1af1

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+Version History
+====
+    * All Version bumps are required to update this file as well!!
+----
+
+* 0.0.9  adding code climate reporting, cleaning up some of the ruby code
+* 0.0.8  cleaning up project for official open source release
+* 0.0.7  fixing a reference problem pulling EN-US only down for all locales, now it pulls the locale you expect
+* 0.0.6  locales configured from yaml
+* 0.0.5  call cleanup and documentation

data/CONTRIBUTING.md

@@ -0,0 +1,18 @@
+# Contributing to smartling rails project
+We'd love for you to contribute to our source code and to make it even better than it is currently!
+
+# Reporting an issue
+If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to our GitHub Repository. Even better you can submit a Pull Request with a fix.
+
+# Requesting a feature
+You can request a new feature by submitting an issue to our GitHub Repository.  If you would like to implement a new feature then consider what kind of change it is:
+
+* **Major Changes** that you wish to contribute to the project should be discussed first so that we can better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the
+project.  The best way to start this discussion is by opening an issue on our github repository.
+* **Small Changes** can be crafted and submitted to the gitHub repository as a Pull Request.
+
+# How code gets into the project
+
+1. Always open a pull request
+2. All pull request must come with coresponding tests
+3. All pull requests will be peer reviewed (dont just accept them please :) )

data/README.md

@@ -1,8 +1,12 @@
 # Welcome to Smartling Rails
+[![Code Climate](https://codeclimate.com/repos/55f99e9b6956802d07000250/badges/b041b1a94ba97adc7619/gpa.svg)](https://codeclimate.com/repos/55f99e9b6956802d07000250/feed)
+[![Test Coverage](https://codeclimate.com/repos/55f99e9b6956802d07000250/badges/b041b1a94ba97adc7619/coverage.svg)](https://codeclimate.com/repos/55f99e9b6956802d07000250/coverage)
 SmartlingRails is a gem making localization with the [smartling](www.smartling.com) localization service easier in a ruby on rails environment. The Gem simplifies the uploading, status checking, and retrieval of information from smartling into a rails app that uses I18N localization.
 
 Communication with smartling is done via their APIs and leverages the [smartling gem](https://rubygems.org/gems/smartling).
 
+If you are interested in helping out / contributing to this project please read [CONTRIBUTING guide](https://github.com/careerbuilder/smartling-rails/blob/master/CONTRIBUTING.md)
+
 ## overview
 The uploading of [rials I18N](http://guides.rubyonrails.org/i18n.html) files to smartling, monitoring their translation status, and pulling them all back down into your `config/localization` folder is a very manual process.
 

data/lib/smartling_rails.rb

@@ -1,10 +1,19 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 require 'smartling'
 require 'yaml'
 
 Dir[File.dirname(__FILE__) + '/smartling_rails/**/*.rb'].each { |file| require file }
 
 module SmartlingRails
-
   def self.configure
     yield configuration
   end
@@ -28,5 +37,4 @@ module SmartlingRails
   def self.processor
     @processor ||= SmartlingRails::SmartlingProcessor.new
   end
-
 end

data/lib/smartling_rails/config.rb

@@ -1,28 +1,37 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 module SmartlingRails
   class Config
     attr_accessor :api_key, :project_id, :rails_app_name, :locales
 
     def initialize
       load_locales_from_yaml
-      import_env_variables()
+      import_env_variables
     end
 
     def load_locales_from_yaml
       config_file_path = 'config/smartling_rails.yml'
       throw "Localization File Missing '/config/smartling_rails.yml'" unless File.exist?(config_file_path)
-      @locales = YAML::load_file(config_file_path)['locales']
+      @locales = YAML.load_file(config_file_path)['locales']
     end
 
     def import_env_variables
-      File.open(".env", "rb") do |f|
+      File.open('.env', 'rb') do |f|
         f.each_line do |line|
-          key_val = line.split("=")
+          key_val = line.split('=')
           @api_key = key_val[1].strip if key_val[0] == 'SMARTLING_API_KEY'
           @project_id = key_val[1].strip if key_val[0] == 'SMARTLING_PROJECT_ID'
           @rails_app_name = key_val[1].strip if key_val[0] == 'SMARTLING_APP_NAME'
         end
-      end unless !File.exist?('.env')
+      end if File.exist?('.env')
     end
-
   end
 end

data/lib/smartling_rails/helpers/localizer_helpers.rb

@@ -1,20 +1,29 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 module SmartlingRails
-  #def self.command_aliases
+  # def self.command_aliases
   #  {
   #    "s" => "status",
   #    "g" => "get",
   #    "p" => "put",
   #    "h" => "--help"
   #  }
-  #end
+  # end
 
   def self.print_msg(msg, padding = false)
     puts if padding
     puts msg
   end
 
-  #def self.command_is(value)
+  # def self.command_is(value)
   #  return @command == command_aliases[value]
-  #end
-
+  # end
 end

data/lib/smartling_rails/models/smartling_file.rb

@@ -1,3 +1,13 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 module SmartlingRails
   class SmartlingFile
     attr_accessor :file_contents, :locale_codes
@@ -9,12 +19,12 @@ module SmartlingRails
 
     def fix_file_issues
       puts 'Fixing Issues:'
-      fix_tab_size()
-      fix_space_after_tree_node()
-      fix_first_line_dashes()
-      fix_locale_root_node()
+      fix_tab_size
+      fix_space_after_tree_node
+      fix_first_line_dashes
+      fix_locale_root_node
     end
-    
+
     def fix_tab_size
       puts '  fixing tabs from 4 spaces to 2 space'
       @file_contents.gsub!('    ', '  ')
@@ -22,23 +32,21 @@ module SmartlingRails
 
     def fix_space_after_tree_node
       puts '  removing space after branch root : \\n to :\\n'
-      @file_contents.gsub!(/: \n/,":\n")
+      @file_contents.gsub!(/: \n/, ":\n")
     end
 
     def fix_first_line_dashes
+      return unless @file_contents.lines.first.match(/---\n/)
       puts '  remove "---" from first line'
-      if @file_contents.lines.first.match(/---\n/)
-        @file_contents.sub!(/---\n/,"")
-        puts '  yes, replaced dashes'
-      end
-
+      @file_contents.sub!(/---\n/, '')
+      puts '  yes, replaced dashes'
     end
-    
+
     def fix_locale_root_node
       puts "  converting smartling locale code to CB locale code from #{locale_codes['smartling']} to #{locale_codes['custom']}"
-      @file_contents.sub!(locale_codes['smartling'],locale_codes['custom'])
+      @file_contents.sub!(locale_codes['smartling'], locale_codes['custom'])
     end
-    
+
     def print_contents
       puts @file_contents
     end

data/lib/smartling_rails/smartling_processor.rb

@@ -1,18 +1,25 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 module SmartlingRails
   class SmartlingProcessor
     attr_accessor :my_smartling
 
-    def initialize()
-      @my_smartling = Smartling::File.new(:apiKey => SmartlingRails.api_key, :projectId => SmartlingRails.project_id)
-      #@my_smartling = Smartling::File.sandbox(:apiKey => @@api_key, :projectId => @@project_id)
-      #puts @my_smartling.list
-      SmartlingRails.print_msg "You are working with this remote file on smartling: #{upload_file_path}", true
-      SmartlingRails.print_msg "Smartling Ruby client #{Smartling::VERSION}"
+    def initialize
+      @my_smartling = Smartling::File.new(apiKey: SmartlingRails.api_key, projectId: SmartlingRails.project_id)
+      SmartlingRails.print_msg "You are working with this remote file on smartling: #{ upload_file_path }", true
+      SmartlingRails.print_msg "Smartling Ruby client #{ Smartling::VERSION }"
     end
 
-    def get_file_statuses
-      SmartlingRails.print_msg("Checking status for #{supported_locales}", true)
-      SmartlingRails.locales.each do |language, codes|
+    def file_statuses
+      SmartlingRails.print_msg("Checking status for #{ supported_locales }", true)
+      SmartlingRails.locales.each do | _language, codes |
         check_file_status(codes['smartling'])
       end
     end
@@ -22,54 +29,52 @@ module SmartlingRails
     end
 
     def check_file_status(language_code)
-      begin
-        res = @my_smartling.status(upload_file_path, :locale => language_code)
-        total_strings =  res['stringCount'].to_i
-        completed_strings =  res['completedStringCount'].to_i
-        file_complete = completed_strings >= total_strings 
-        SmartlingRails.print_msg "#{language_code} completed: #{file_complete} (#{completed_strings} / #{total_strings})"
-      rescue Exception => e
-        puts e.message
-      end
+      res = @my_smartling.status(upload_file_path, locale: language_code)
+      total_strings =  res['stringCount'].to_i
+      completed_strings =  res['completedStringCount'].to_i
+      file_complete = completed_strings >= total_strings
+      SmartlingRails.print_msg "#{language_code} completed: #{ file_complete } (#{ completed_strings } / #{ total_strings })"
+    rescue Exception => e
+      puts e.message
     end
 
     def put_files
-      SmartlingRails.print_msg "Uploading the english file to smartling to process:", true
-      upload_english_file()
+      SmartlingRails.print_msg('Uploading the english file to smartling to process:', true)
+      upload_english_file
     end
 
-    def upload_english_file()
-      SmartlingRails.print_msg "uploading #{local_file_path_for_locale('en-us')} to #{upload_file_path}"
+    def upload_english_file
+      SmartlingRails.print_msg("uploading #{ local_file_path_for_locale('en-us') } to #{ upload_file_path }")
       @my_smartling.upload(local_file_path_for_locale('en-us'), upload_file_path, 'YAML')
     end
 
     def local_file_path_for_locale(cb_locale)
-      "config/locales/#{cb_locale}.yml"
+      "config/locales/#{ cb_locale }.yml"
     end
 
-    def upload_file_path()
-      "/files/[#{SmartlingRails.configuration.rails_app_name || 'app'}]-[#{get_current_branch}]-en-us.yml"
+    def upload_file_path
+      "/files/[#{ SmartlingRails.configuration.rails_app_name || 'app' }]-[#{ current_branch }]-en-us.yml"
     end
 
-    def get_files
-      SmartlingRails.print_msg("Checking status for #{supported_locales}", true)
-      SmartlingRails.locales.each do |language, locale_codes|
+    def files
+      SmartlingRails.print_msg("Checking status for #{ supported_locales }", true)
+      SmartlingRails.locales.each do | _language, locale_codes |
         fetch_fix_and_save_file_for_locale(locale_codes)
       end
     end
 
     def fetch_fix_and_save_file_for_locale(locale_codes)
       smartling_file = get_file_for_locale(locale_codes)
-      smartling_file.fix_file_issues()
+      smartling_file.fix_file_issues
       save_to_local_file(smartling_file.file_contents, locale_codes['custom'])
     end
 
     def get_file_for_locale(locale_codes)
       smartling_file = SmartlingFile.new('', locale_codes)
-      SmartlingRails.print_msg "Downloading #{locale_codes['smartling']}:", true
+      SmartlingRails.print_msg "Downloading #{ locale_codes['smartling'] }:", true
       begin
-        smartling_file.file_contents = @my_smartling.download(upload_file_path, :locale => locale_codes['smartling'])
-        SmartlingRails.print_msg "file loaded..."
+        smartling_file.file_contents = @my_smartling.download(upload_file_path, locale: locale_codes['smartling'])
+        SmartlingRails.print_msg 'file loaded...'
       rescue Exception => e
         SmartlingRails.print_msg e
       end
@@ -80,9 +85,9 @@ module SmartlingRails
       File.open(local_file_path_for_locale(cb_locale), 'w') { |file| file.write(file_contents) }
     end
 
-    def get_current_branch
-      b = `git branch`.split("\n").delete_if { |i| i[0] != "*" }
-      b.first.gsub("* ","")
+    def current_branch
+      b = `git branch`.split("\n").delete_if { |i| i[0] != '*' }
+      b.first.gsub('* ', '')
     end
   end
 end

data/lib/smartling_rails/version.rb

@@ -1,3 +1,13 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 module SmartlingRails
-  VERSION = '0.0.7'
+  VERSION = '0.0.9'
 end

data/lib/tasks/smartling_rails.rake

@@ -1,20 +1,30 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 require 'smartling_rails'
-namespace :smartling do 
-  desc "check statuses"
+namespace :smartling do
+  desc 'check statuses'
   task :status do
-    puts "Attempting to get translation statuses:"
-    SmartlingRails.processor.get_file_statuses
+    puts 'Attempting to get translation statuses:'
+    SmartlingRails.processor.file_statuses
   end
 
-  desc "upload the en-us.yml file to smartling"
+  desc 'upload the en-us.yml file to smartling'
   task :put do
-    puts "Attempting to upload file to smartling:"
+    puts 'Attempting to upload file to smartling:'
     SmartlingRails.processor.put_files
   end
 
-  desc "download the translations from smartling, fix and save"
+  desc 'download the translations from smartling, fix and save'
   task :get do
-    puts "Attempting to download files from smartling:"
-    SmartlingRails.processor.get_files
+    puts 'Attempting to download files from smartling:'
+    SmartlingRails.processor.files
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartling_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - The CareerBuilder.com Consumer Development teams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-25 00:00:00.000000000 Z
+date: 2015-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: smartling
@@ -106,23 +106,53 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.21'
 description: Smartling support library for automation of rails platforms using I18N
-email: ConsumerDevelopment@careerbuilder.com
+email: opensource@careerbuilder.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/localizer.rb
+- CHANGELOG.md
+- CONTRIBUTING.md
+- README.md
+- lib/smartling_rails.rb
 - lib/smartling_rails/config.rb
 - lib/smartling_rails/helpers/localizer_helpers.rb
 - lib/smartling_rails/models/smartling_file.rb
 - lib/smartling_rails/smartling_processor.rb
 - lib/smartling_rails/version.rb
-- lib/smartling_rails.rb
-- README.md
 - lib/tasks/smartling_rails.rake
-homepage: http://m.careerbuilder.com
-licenses: []
+homepage: https://github.com/careerbuilder/smartling-rails
+licenses:
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -140,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Smartling support library for automation of rails platforms using I18N

data/lib/localizer.rb

@@ -1,42 +0,0 @@
-=begin
-require 'rubygems'
-require 'smartling'
-load 'localizer_files/cb_smartling.rb'
-load 'localizer_files/localizer_helpers.rb'
-
-ARGV << "--help" if ARGV.empty?
-
-@command = ARGV.shift
-@command = @command_aliases[@command] || @command
-@my_smartling = nil
-
-def make_my_smartling
-  @my_smartling ||= CBSmartling.new()
-end
-
-def print_help
-  print_msg("Localizer Help:", true)
-  @command_aliases.each do |command_alias, command|
-    print_msg("    #{command} or #{command_alias} does.....")
-  end
-end
-
-def execute_command
-  if command_is('h')
-    print_help()
-  elsif command_is('s')
-    @my_smartling.get_status()
-  elsif command_is('g')
-    @my_smartling.get_files()
-  elsif command_is('p')
-    @my_smartling.put_files()
-  end
-end
-
-def startup()
-  make_my_smartling()
-  execute_command()
-end
-
-startup()
-=end