zci 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 335619ce8666e6f76384cf8a6cbdf58d528a29c25811e022a7136b6ae727809a
-  data.tar.gz: 1b7db4ed8c41ec1b74d2269cfefce1c1b1cee53505918aafde01d4c4bbf284e3
+  metadata.gz: 288b8d33f051846608ed93e937598a6fdcae07058c92c27001c79d12dbe03fa5
+  data.tar.gz: 1aede6fa10bee8a04c5e3430430774260c21caed7b9533e4c826280df5df7fc9
 SHA512:
-  metadata.gz: 93f042417010dd09c9da37dfea0a7ae1afc4f3524e27613ecc59197851017453976fbe28cd72264d77c7e9a23b3b93d94466505a4cfe93578855915720ecd742
-  data.tar.gz: df37dc930fce92e2d7cd77b8963fcdb4377df55441780e6d65e7047e83bc10c684ae779686e8dc9a30c10c457dcfc4762426066d3370f0f32dd9552737c2ba3c
+  metadata.gz: 589dfda55c4d68b9c115279535bc0e292104521e8ccbcf337e1fef2b2a7968300c2788dcef12ce928eeda5e9af85ca3e8a550a87bae2a7f188fe2d753ee8760c
+  data.tar.gz: 53ae293ac3bf6683f701d80a6c8465f9536489c494c270213acc100ae8d8e6950f2b19a0a96207d1845010e47c9acb89d7cb28ee7aafedb2980758738d1ce8fa

data/Gemfile

@@ -1,5 +1,4 @@
 source 'https://rubygems.org'
 gemspec
 
-# gem 'byebug'
 # gem 'zendesk_help_center_api', path: '../zendesk_help_center_api_client_rb'

data/README.md

@@ -49,7 +49,7 @@ SYNOPSIS
     zci [global options] command [command options] [arguments...]
 
 VERSION
-    0.6.0
+    0.6.1
 
 GLOBAL OPTIONS
     -c, --config=<s> - Project-specific configuration file (default: /home/crowdin/zci.yml)
@@ -88,21 +88,38 @@ categories:
 - zendesk_category: '<%zendesk-category-id%>'
   translations:
     -
-      crowdin_language_code: '<%crowdin-two-letters-code%>'
-      zendesk_locale: '<%zendesk-locale%>'
+      crowdin_language_code: '<%crowdin-language-code%>' #the full list of language codes: https://support.crowdin.com/api/language-codes/
+      zendesk_locale: '<%zendesk-locale%>' #the full list of language codes: https://support.zendesk.com/hc/en-us/articles/203761906-Language-codes-for-Zendesk-supported-languages
     -
-      crowdin_language_code: '<%crowdin-two-letters-code%>'
+      crowdin_language_code: '<%crowdin-language-code%>'
       zendesk_locale: '<%zendesk-locale%>'
 - zendesk_category: '<%zendesk-category-id%>'
   translations:
     -
-      crowdin_language_code: '<%crowdin-two-letters-code%>'
+      crowdin_language_code: '<%crowdin-language-code%>'
       zendesk_locale: '<%zendesk-locale%>'
     -
-      crowdin_language_code: '<%crowdin-two-letters-code%>'
+      crowdin_language_code: '<%crowdin-language-code%>'
       zendesk_locale: '<%zendesk-locale%>'
 ```
 
+## Advance Usage
+
+This section covers some of `zci` more advanced features.
+
+### Brands
+
+To make changes and updates via the `Help Center API` in your branded `Help Centers` you will use the URL of the specific brand.
+
+For more information, see [Managing multiple brands](https://support.zendesk.com/hc/en-us/articles/204577973-Managing-multiple-brands-Professional-Add-on-and-Enterprise-).
+
+```yaml
+---
+categories:
+- zendesk_category: '<%zendesk-category-id%>'
+  brand_url: '<%zendesk-brand-url%>/api/v2/'
+```
+
 ## Supported Rubies
 
 Tested with the following Ruby versions:

data/bin/zci

@@ -47,18 +47,13 @@ pre do |global, command, options, args|
     EOS
   end
 
-  @zendesk = ZendeskAPI::Client.new do |config|
-    config.url       = @cli_config['zendesk_base_url']
-    config.username  = @cli_config['zendesk_username']
-    config.password  = @cli_config['zendesk_password']
-
-    if global[:verbose]
-      require 'logger'
-      config.logger = Logger.new(STDOUT)
-    end
-
-    config.client_options = {ssl: {verify: false}}
-  end
+  # Global Zendesk Client
+  @zendesk = ZCI.initialize_zendesk_client(
+    @cli_config['zendesk_base_url'],
+    @cli_config['zendesk_username'],
+    @cli_config['zendesk_password'],
+    global[:verbose]
+  )
 
   if global[:verbose]
     Crowdin::API.log = Logger.new(STDOUT) if global[:verbose]

data/lib/zci/commands/02_import.rb

@@ -16,11 +16,20 @@ command :'import:sources' do |c|
     end
 
     @cli_config['categories'].each do |category|
+      zendesk_url = category.fetch('brand_url', @cli_config['zendesk_base_url'])
+
+      zendesk_client = ZCI.initialize_zendesk_client(
+        zendesk_url,
+        @cli_config['zendesk_username'],
+        @cli_config['zendesk_password'],
+        global_options[:verbose]
+      )
+
       # Source Category
       source_category_id = category['zendesk_category'].to_i
 
       # Check if Category exists in Zendesk
-      source_category = @zendesk.hc_categories.find(id: source_category_id)
+      source_category = zendesk_client.hc_categories.find(id: source_category_id)
 
       if source_category.nil? || source_category.id != source_category_id
         puts "[Zendesk] No category with id #{source_category_id}"

data/lib/zci/commands/04_export.rb

@@ -19,13 +19,22 @@ command :'export:translations' do |c|
 
     crowdin_supported_languages = @crowdin.supported_languages
 
-    if language == 'all'
-      zendesk_locales = @zendesk.locales
-    else
-      zendesk_locales  = @zendesk.locales.select { |locale| locale.locale == language }
-    end
-
     @cli_config['categories'].each do |category_section|
+      zendesk_url = category.fetch('brand_url', @cli_config['zendesk_base_url'])
+
+      zendesk_client = ZCI.initialize_zendesk_client(
+        zendesk_url,
+        @cli_config['zendesk_username'],
+        @cli_config['zendesk_password'],
+        global_options[:verbose]
+      )
+
+      if language == 'all'
+        zendesk_locales = zendesk_client.locales
+      else
+        zendesk_locales = zendesk_client.locales.select { |locale| locale.locale == language }
+      end
+
       zendesk_locales.select { |locale| !locale.default? }.each do |locale|
         if lang = category_section['translations'].detect { |tr| tr['zendesk_locale'].casecmp(locale.locale) == 0 }
           crowdin_locale = crowdin_supported_languages.detect { |l| l['crowdin_code'] == lang['crowdin_language_code'] }['locale']
@@ -61,7 +70,7 @@ command :'export:translations' do |c|
 
           ### Categories
           #
-          categories = @zendesk.hc_categories
+          categories = zendesk_client.hc_categories
           all_categories.each do |category_hash|
             if category = categories.find(id: category_hash[:id])
               if category_tr = category.translations.detect { |tr| tr.locale.casecmp(locale.locale) == 0 }
@@ -80,7 +89,7 @@ command :'export:translations' do |c|
 
           ### Sections
           #
-          sections = @zendesk.sections
+          sections = zendesk_client.sections
           all_sections.each do |section_hash|
             if section = sections.find(id: section_hash[:id])
               if section_tr = section.translations.detect { |tr| tr.locale.casecmp(locale.locale) == 0 }

data/lib/zci/commands/06_info.rb

@@ -21,19 +21,35 @@ command :'project:info' do |c|
     # Zendesk
     if @zendesk.current_user.id
       puts "Zendesk: authentication successful."
-      categories = @zendesk.hc_categories
+      brands = @zendesk.brands
 
-      puts "Zendesk: available categories:"
-      categories.each do |category|
-        puts "  - #{category.id}: #{category.name}"
-      end
+      brands.each do |brand|
+        puts "Zendesk URL: #{brand.brand_url}"
+
+        zendesk_url = brand.brand_url + "/api/v2"
+
+        zendesk_client = ZCI.initialize_zendesk_client(
+          zendesk_url,
+          @cli_config['zendesk_username'],
+          @cli_config['zendesk_password'],
+          global_options[:verbose]
+        )
 
-      locales = @zendesk.locales
+        locales = zendesk_client.locales
+        categories = zendesk_client.hc_categories
 
-      puts "Zendesk: available locales:"
-      locales.each do |locale|
-        puts "  - #{locale.locale}"
+        puts "  available categories:"
+        categories.each do |category|
+          puts "    - #{category.id}: #{category.name}"
+        end
+
+        puts "  available locales:"
+        locales.each do |locale|
+          puts "    - #{locale.locale}"
+        end
+        puts
       end
+
     else
       puts "Zendesk: login and/or password is incorect"
     end

data/lib/zci/helpers.rb

@@ -5,6 +5,23 @@ class String
   end
 end
 
+module ZCI
+  def initialize_zendesk_client(base_url, username, password, verbose)
+    ZendeskAPI::Client.new do |config|
+      config.url       = base_url
+      config.username  = username
+      config.password  = password
+
+      if verbose
+        require 'logger'
+        config.logger = Logger.new(STDOUT)
+      end
+
+      config.client_options = {ssl: {verify: false}}
+    end
+  end
+end
+
 # Return +hierarchy+ of directories and files in Crowdin project
 #
 # +files+ - basically, it's project files details from API method `project_info`

data/lib/zci/init.rb

@@ -47,18 +47,18 @@ module ZCI
     - zendesk_category: '<%zendesk-category-id%>'
       translations:
         -
-          crowdin_language_code: '<%crowdin-two-letters-code%>'
-          zendesk_locale: '<%zendesk-locale%>'
+          crowdin_language_code: '<%crowdin-language-code%>' # the full list: https://support.crowdin.com/api/language-codes/
+          zendesk_locale: '<%zendesk-locale%>' # the full list: https://support.zendesk.com/hc/en-us/articles/203761906-Language-codes-for-Zendesk-supported-languages
         -
-          crowdin_language_code: '<%crowdin-two-letters-code%>'
+          crowdin_language_code: '<%crowdin-language-code%%>'
           zendesk_locale: '<%zendesk-locale%>'
     - zendesk_category: '<%zendesk-category-id%>'
       translations:
         -
-          crowdin_language_code: '<%crowdin-two-letters-code%>'
+          crowdin_language_code: '<%crowdin-language-code%%>'
           zendesk_locale: '<%zendesk-locale%>'
         -
-          crowdin_language_code: '<%crowdin-two-letters-code%>'
+          crowdin_language_code: '<%crowdin-language-code%%>'
           zendesk_locale: '<%zendesk-locale%>'
     EOS
 

data/lib/zci/version.rb

@@ -1,3 +1,3 @@
 module ZCI
-  VERSION = '0.6.1'
+  VERSION = '0.7.0'
 end

data/lib/zci.rb

@@ -6,7 +6,7 @@ require 'zendesk_api/help_center'
 require 'crowdin-api'
 require 'nokogiri'
 require 'zip'
-# require 'byebug'
+require 'pry'
 
 # Add requires for other files you add to your project here, so
 # you just need to require this one file in your bin file

data/zci.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake', '~> 12.3'
   s.add_development_dependency 'rdoc', '~> 6.1'
   s.add_development_dependency 'aruba', '~> 0.14'
+  s.add_development_dependency 'pry', '~> 0.12.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zci
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Anton Maminov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-18 00:00:00.000000000 Z
+date: 2019-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
 description: 
 email: anton.maminov@gmail.com
 executables: