bisu 1.4.7 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 897fab8a33b0d7172fd27278af5d6e2536fcbeaf
-  data.tar.gz: d0dcc27429ec315c3eab84401beff368e20e4549
+  metadata.gz: e11ef1004e3778da14f8a9980b7c179af2675386
+  data.tar.gz: 1f135d1bd101a886067a802cd3e01476f5023bf4
 SHA512:
-  metadata.gz: 9b968c726b181da600f37c3083418f57dbc67240f96a8978ca27797fd630f853056c63c9897cf06fdf763db6a3c133c4944ccce0a45f0dbf00329cab3073d70d
-  data.tar.gz: f1b5bc7755dedbdde632e63f83e7072115118bfd12ad6ae398e29ed43d11786e2e130d92d0d9097b15bf97094df014e87bb8c594417cc43ee31fc60f58cb8e55
+  metadata.gz: 46b10ad409ba99c19189e1ebb41fd6867475287471215c02cd2d8787f3f756bc6120391618c3af51a20fbcc7be0f17f7e1c1fd5040f5772b6cfc5c33ab5da2ed
+  data.tar.gz: 51e31ad74b7e9e816966c52da0e42dee25e8305548aeea95a91de413573c11c97144a3e38da852893e3b000d89047d5255c27e6023473b28c0d12c677ef58a9b

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 All notable changes to this project will be documented in this file.
 `Bisu` adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.5.0](https://github.com/hole19/bisu/releases/tag/v1.5.0)
+Released on 2019/01/19
+
+#### Added
+- Adds an option to skip downloading i18n dictionary from an external source and loads it directly from a local file in that format
+
 ## [1.4.7](https://github.com/hole19/bisu/releases/tag/v1.4.7)
 Released on 2018/07/24
 

data/lib/bisu.rb

@@ -5,8 +5,8 @@ require 'fileutils'
 require 'bisu/logger'
 require 'bisu/object_extension'
 require 'bisu/config'
-require 'bisu/google_sheet'
-require 'bisu/one_sky'
+require 'bisu/source/google_sheet'
+require 'bisu/source/one_sky'
 require 'bisu/dictionary'
 require 'bisu/localizer'
 require 'bisu/version'
@@ -19,7 +19,7 @@ module Bisu
 
     if config_file = open_file("translatable.yml", "r", true)
       config       = Bisu::Config.new(hash: YAML::load(config_file))
-      dictionary   = dictionary_for(config: config.dictionary, save_to_path: options[:dictionary_save_path])
+      dictionary   = dictionary_for(config: config.dictionary, options: options)
       localizer    = Bisu::Localizer.new(dictionary, config.type)
 
       config.localize_files do |in_path, out_path, language, locale|
@@ -37,24 +37,43 @@ module Bisu
 
   private
 
-  def dictionary_for(config:, save_to_path:)
+  def dictionary_for(config:, options:)
+    source =
+      if from_file_path = options[:from_file_path]
+        i18n_from(path: from_file_path)
+      else
+        i18n_for(config: config, options: options)
+      end
+
+    Bisu::Dictionary.new(source)
+  end
+
+  def i18n_for(config:, options:)
     source =
       case config[:type]
       when "google_sheet"
-        Bisu::GoogleSheet.new(config[:sheet_id], config[:keys_column])
+        Bisu::Source::GoogleSheet.new(config[:sheet_id], config[:keys_column])
       when "one_sky"
-        Bisu::OneSky.new(config[:api_key], config[:api_secret], config[:project_id], config[:file_name])
+        Bisu::Source::OneSky.new(config[:api_key], config[:api_secret], config[:project_id], config[:file_name])
       end
 
     source = source.to_i18
 
+    save_to_path = options[:dictionary_save_path]
     if save_to_path && file = open_file(save_to_path, "w", false)
       file.write(source.to_json)
       file.flush
       file.close
     end
 
-    Bisu::Dictionary.new(source)
+    source
+  end
+
+  def i18n_from(path:)
+    file = open_file(path, "r", true)
+    data = file.read
+    file.close
+    JSON.parse(data)
   end
 
   def command_line_options(options)
@@ -65,6 +84,10 @@ module Bisu
         opts_hash[:default_language] = language
       end
 
+      opts.on("--file PATH", "Loads i18n source directly from a local file") do |file|
+        opts_hash[:from_file_path] = file
+      end
+
       opts.on("--save-dictionary PATH", "Save downloaded dictionary locally at given path") do |path|
         opts_hash[:dictionary_save_path] = path
       end

data/lib/bisu/source/google_sheet.rb

@@ -0,0 +1,65 @@
+require "net/https"
+require "xmlsimple"
+
+module Bisu
+  module Source
+    class GoogleSheet
+      def initialize(sheet_id, keys_column)
+        @sheet_id = sheet_id
+        @key_column = keys_column
+      end
+
+      def to_i18
+        raw = raw_data(@sheet_id)
+
+        Logger.info("Downloading dictionary from Google Sheet...")
+
+        non_language_columns = ["id", "updated", "category", "title", "content", "link", @key_column]
+
+        kb = {}
+        raw["entry"].each do |entry|
+          unless (key = entry[@key_column]) && key = key.first
+            raise "Cannot find key column '#{@key_column}'"
+          end
+
+          entry.select { |c| !non_language_columns.include?(c) }.each do |lang, texts|
+            kb[lang] ||= {}
+            kb[lang][key] = texts.first unless texts.first == {}
+          end
+        end
+
+        Logger.info("Google Sheet parsed successfully!")
+        Logger.info("Found #{kb.count} languages.")
+
+        kb
+      end
+
+      private
+
+      def xml_data(uri, headers=nil)
+        uri = URI.parse(uri)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        data = http.get(uri.path, headers)
+
+        unless data.code.to_i == 200
+          raise "Cannot access sheet at #{uri} - HTTP #{data.code}"
+        end
+
+        begin
+          XmlSimple.xml_in(data.body, 'KeyAttr' => 'name')
+        rescue
+          raise "Cannot parse. Expected XML at #{uri}"
+        end
+      end
+
+      def raw_data(sheet_id)
+        Logger.info("Downloading Google Sheet...")
+        sheet = xml_data("https://spreadsheets.google.com/feeds/worksheets/#{sheet_id}/public/full")
+        url   = sheet["entry"][0]["link"][0]["href"]
+        xml_data(url)
+      end
+    end
+  end
+end

data/lib/bisu/source/one_sky.rb

@@ -0,0 +1,65 @@
+require 'net/https'
+require 'json'
+
+module Bisu
+  module Source
+    class OneSky
+      def initialize(api_key, api_secret, project_id, file_name)
+        @api_key    = api_key
+        @api_secret = api_secret
+        @project_id = project_id
+        @file_name  = file_name
+      end
+
+      def to_i18
+        Logger.info("Downloading dictionary from OneSky...")
+
+        path = "https://platform.api.onesky.io/1/projects/#{@project_id}/translations/multilingual"
+        file = get(path, source_file_name: @file_name, file_format: "I18NEXT_MULTILINGUAL_JSON")
+
+        hash = JSON.parse(file)
+
+        hash.each do |lang, v|
+          hash[lang] = v["translation"]
+          hash[lang].each do |key, text|
+            hash[lang][key] = hash[lang][key].join("\\n") if hash[lang][key].is_a? Array
+            hash[lang][key] = hash[lang][key].gsub("\n", "\\n") # fixes the 'stupid newline bug'
+            hash[lang][key] = hash[lang][key].gsub("\\'", "'") # fixes the 'stupid single quote bug'
+          end
+        end
+
+        Logger.info("OneSky response parsed successfully!")
+        Logger.info("Found #{hash.count} languages.")
+
+        hash
+      end
+
+      private
+
+      def get(url, params)
+        uri = URI(url)
+        uri.query = URI.encode_www_form(authenticated_params(params))
+
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+        request = Net::HTTP::Get.new(uri.request_uri)
+        response = http.request(request)
+
+        raise "OneSky: Http Error #{JSON.parse(response.body)}" if response.code.to_i >= 400
+
+        response.body
+      end
+
+      def authenticated_params(params)
+        now = Time.now.to_i
+
+        { api_key: @api_key,
+          timestamp: now,
+          dev_hash: Digest::MD5.hexdigest(now.to_s + @api_secret)
+        }.merge(params)
+      end
+    end
+  end
+end

data/lib/bisu/version.rb

@@ -1,4 +1,4 @@
 module Bisu
-  VERSION = '1.4.7'
-  VERSION_UPDATED_AT = '2018-07-24'
+  VERSION = '1.5.0'
+  VERSION_UPDATED_AT = '2019-01-19'
 end

data/spec/lib/bisu/google_sheet_spec.rb

@@ -1,5 +1,5 @@
-describe Bisu::GoogleSheet do
-  subject(:to_i18) { Bisu::GoogleSheet.new(sheet_id, key_column).to_i18 }
+describe Bisu::Source::GoogleSheet do
+  subject(:to_i18) { Bisu::Source::GoogleSheet.new(sheet_id, key_column).to_i18 }
 
   let(:sheet_id) { "abc1234567890" }
   let(:url_info)  { "https://spreadsheets.google.com/feeds/worksheets/#{sheet_id}/public/full" }

data/spec/lib/bisu/one_sky_spec.rb

@@ -1,5 +1,5 @@
-describe Bisu::OneSky do
-  subject(:to_i18) { Bisu::OneSky.new(api_key, api_secret, project_id, file_name).to_i18 }
+describe Bisu::Source::OneSky do
+  subject(:to_i18) { Bisu::Source::OneSky.new(api_key, api_secret, project_id, file_name).to_i18 }
 
   let(:api_key)    { "a123" }
   let(:api_secret) { "b123" }

data/spec/lib/bisu_spec.rb

@@ -6,7 +6,7 @@ describe Bisu do
 
     before do
       allow(Bisu).to receive(:open_file).and_return(file)
-      allow_any_instance_of(Bisu::GoogleSheet).to receive(:to_i18).and_return({
+      allow_any_instance_of(Bisu::Source::GoogleSheet).to receive(:to_i18).and_return({
         "english" => { "kKey" => "Value" }
       })
       allow(Bisu).to receive(:localize_file)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bisu
 version: !ruby/object:Gem::Version
-  version: 1.4.7
+  version: 1.5.0
 platform: ruby
 authors:
 - joaoffcosta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-24 00:00:00.000000000 Z
+date: 2019-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: safe_yaml
@@ -87,11 +87,11 @@ files:
 - lib/bisu.rb
 - lib/bisu/config.rb
 - lib/bisu/dictionary.rb
-- lib/bisu/google_sheet.rb
 - lib/bisu/localizer.rb
 - lib/bisu/logger.rb
 - lib/bisu/object_extension.rb
-- lib/bisu/one_sky.rb
+- lib/bisu/source/google_sheet.rb
+- lib/bisu/source/one_sky.rb
 - lib/bisu/version.rb
 - spec/fixtures/sample.translatable.yml
 - spec/fixtures/sample_kb_public_info.html

data/lib/bisu/google_sheet.rb

@@ -1,63 +0,0 @@
-require "net/https"
-require "xmlsimple"
-
-module Bisu
-  class GoogleSheet
-    def initialize(sheet_id, keys_column)
-      @sheet_id = sheet_id
-      @key_column = keys_column
-    end
-
-    def to_i18
-      raw = raw_data(@sheet_id)
-
-      Logger.info("Downloading dictionary from Google Sheet...")
-
-      non_language_columns = ["id", "updated", "category", "title", "content", "link", @key_column]
-
-      kb = {}
-      raw["entry"].each do |entry|
-        unless (key = entry[@key_column]) && key = key.first
-          raise "Cannot find key column '#{@key_column}'"
-        end
-
-        entry.select { |c| !non_language_columns.include?(c) }.each do |lang, texts|
-          kb[lang] ||= {}
-          kb[lang][key] = texts.first unless texts.first == {}
-        end
-      end
-
-      Logger.info("Google Sheet parsed successfully!")
-      Logger.info("Found #{kb.count} languages.")
-
-      kb
-    end
-
-    private
-
-    def xml_data(uri, headers=nil)
-      uri = URI.parse(uri)
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      data = http.get(uri.path, headers)
-
-      unless data.code.to_i == 200
-        raise "Cannot access sheet at #{uri} - HTTP #{data.code}"
-      end
-
-      begin
-        XmlSimple.xml_in(data.body, 'KeyAttr' => 'name')
-      rescue
-        raise "Cannot parse. Expected XML at #{uri}"
-      end
-    end
-
-    def raw_data(sheet_id)
-      Logger.info("Downloading Google Sheet...")
-      sheet = xml_data("https://spreadsheets.google.com/feeds/worksheets/#{sheet_id}/public/full")
-      url   = sheet["entry"][0]["link"][0]["href"]
-      xml_data(url)
-    end
-  end
-end

data/lib/bisu/one_sky.rb

@@ -1,63 +0,0 @@
-require 'net/https'
-require 'json'
-
-module Bisu
-  class OneSky
-    def initialize(api_key, api_secret, project_id, file_name)
-      @api_key    = api_key
-      @api_secret = api_secret
-      @project_id = project_id
-      @file_name  = file_name
-    end
-
-    def to_i18
-      Logger.info("Downloading dictionary from OneSky...")
-
-      path = "https://platform.api.onesky.io/1/projects/#{@project_id}/translations/multilingual"
-      file = get(path, source_file_name: @file_name, file_format: "I18NEXT_MULTILINGUAL_JSON")
-
-      hash = JSON.parse(file)
-
-      hash.each do |lang, v|
-        hash[lang] = v["translation"]
-        hash[lang].each do |key, text|
-          hash[lang][key] = hash[lang][key].join("\\n") if hash[lang][key].is_a? Array
-          hash[lang][key] = hash[lang][key].gsub("\n", "\\n") # fixes the 'stupid newline bug'
-          hash[lang][key] = hash[lang][key].gsub("\\'", "'") # fixes the 'stupid single quote bug'
-        end
-      end
-
-      Logger.info("OneSky response parsed successfully!")
-      Logger.info("Found #{hash.count} languages.")
-
-      hash
-    end
-
-    private
-
-    def get(url, params)
-      uri = URI(url)
-      uri.query = URI.encode_www_form(authenticated_params(params))
-
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-
-      request = Net::HTTP::Get.new(uri.request_uri)
-      response = http.request(request)
-
-      raise "OneSky: Http Error #{JSON.parse(response.body)}" if response.code.to_i >= 400
-
-      response.body
-    end
-
-    def authenticated_params(params)
-      now = Time.now.to_i
-
-      { api_key: @api_key,
-        timestamp: now,
-        dev_hash: Digest::MD5.hexdigest(now.to_s + @api_secret)
-      }.merge(params)
-    end
-  end
-end