Replace export with pull

Author: devxoul

lib/poeditor.rb

@@ -9,14 +9,14 @@ module POEditor
   autoload :UI,        "poeditor/ui"
 
   # core
-  autoload :Exporter,   "poeditor/core/exporter"
+  autoload :Core,   "poeditor/core"
 
   # command
   autoload :Command,        "poeditor/commands/command"
-  autoload :ExportCommand,  "poeditor/commands/export_command"
+  autoload :PullCommand,    "poeditor/commands/pull_command"
   autoload :HelpCommand,    "poeditor/commands/help_command"
   autoload :VersionCommand, "poeditor/commands/version_command"
 
   # configuration
-  autoload :ExportConfiguration, "poeditor/configurations/export_configuration"
+  autoload :Configuration, "poeditor/configuration"
 end

lib/poeditor/commands/command.rb

@@ -13,8 +13,8 @@ def self.run(argv)
 
     def self.command_class(argv)
       case argv[0]
-      when "export"
-        ExportCommand
+      when "pull"
+        PullCommand
       when "--version"
         VersionCommand
       else

lib/poeditor/commands/help_command.rb

@@ -1,7 +1,7 @@
 module POEditor
   class HelpCommand
     def run(argv)
-      puts "Usage: poeditor export"
+      puts "Usage: poeditor [pull|help]"
     end
   end
 end

lib/poeditor/commands/export_command.rb lib/poeditor/commands/pull_command.rblib/poeditor/commands/export_command.rb renamed to lib/poeditor/commands/pull_command.rb

@@ -1,11 +1,11 @@
 module POEditor
-  class ExportCommand
+  class PullCommand
     def run(argv)
       UI.puts "Reading configuration"
       configuration = get_configuration(argv)
       UI.puts configuration
-      exporter = POEditor::Exporter.new(configuration)
-      exporter.export_all()
+      client = POEditor::Core.new(configuration)
+      client.pull()
     end
 
     # Detects and returns the location of `poeditor.yml` file from the given
@@ -23,11 +23,11 @@ def get_configuration_file_path(argv)
       end
     end
 
-    # Returns {#POEditor::ExportConfiguration} from the given system arguments.
+    # Returns {#POEditor::Configuration} from the given system arguments.
     #
     # @param argv [Array<String>] System arguments
     #
-    # @return [POEditor::ExportConfiguration] The export configuration
+    # @return [POEditor::Configuration] The export configuration
     def get_configuration(argv)
       config_path = get_configuration_file_path(argv)
       unless File.exist?(config_path)
@@ -37,7 +37,7 @@ def get_configuration(argv)
         }
       end
       yaml = YAML.load(File.read(config_path))
-      ExportConfiguration.new(
+      Configuration.new(
         api_key: get_or_raise(yaml, "api_key"),
         project_id: get_or_raise(yaml, "project_id"),
         type: get_or_raise(yaml, "type"),

…r/configurations/export_configuration.rb lib/poeditor/configuration.rblib/poeditor/configurations/export_configuration.rb renamed to lib/poeditor/configuration.rb lib/poeditor/configurations/export_configuration.rb renamed to lib/poeditor/configuration.rb

@@ -1,5 +1,5 @@
 module POEditor
-  class ExportConfiguration
+  class Configuration
     # @return [String] POEditor API key
     # @see https://poeditor.com/account/api POEditor API Access
     attr_accessor :api_key
@@ -29,7 +29,7 @@ def initialize(api_key:, project_id:, type:, tags:nil,
                    languages:, language_alias:nil,
                    path:, path_replace:nil)
       @api_key = from_env(api_key)
-      @project_id = from_env(project_id)
+      @project_id = from_env(project_id.to_s)
       @type = type
       @tags = tags || []
 

lib/poeditor/core/exporter.rb lib/poeditor/core.rblib/poeditor/core/exporter.rb renamed to lib/poeditor/core.rb

@@ -2,15 +2,15 @@
 require "net/http"
 
 module POEditor
-  class Exporter
-    # @return [POEditor::ExportConfiguration] The configuration for export
+  class Core
+    # @return [POEditor::Configuration] The configuration for export
     attr_accessor :configuration
 
-    # @param configuration [POEditor::ExportConfiguration]
+    # @param configuration [POEditor::Configuration]
     def initialize(configuration)
-      unless configuration.is_a? ExportConfiguration
+      unless configuration.is_a? Configuration
         raise POEditor::Exception.new \
-          "`configuration` should be an `ExportConfiguration`"
+          "`configuration` should be an `Configuration`"
       end
       @configuration = configuration
     end
@@ -31,8 +31,8 @@ def api(action, api_token, options={})
       return Net::HTTP.post_form(uri, options)
     end
 
-    # Exports all translations
-    def export_all()
+    # Pull translations
+    def pull()
       UI.puts "\nExport translations"
       for language in @configuration.languages
         UI.puts "  - Exporting '#{language}'"

test/test_export.rb test/test_core.rbtest/test_export.rb renamed to test/test_core.rb

@@ -1,6 +1,6 @@
 require_relative "test"
 
-class ExportTest < Test
+class CoreTest < Test
 
   def clean
     FileUtils.rm_rf("TestProj")
@@ -33,10 +33,10 @@ def teardown
     clean()
   end
 
-  def get_exporter(type:,
-                   languages:, language_alias:nil,
-                   path:, path_replace:nil)
-    configuration = POEditor::ExportConfiguration.new(
+  def get_client(type:,
+                 languages:, language_alias:nil,
+                 path:, path_replace:nil)
+    configuration = POEditor::Configuration.new(
       :api_key => "TEST",
       :project_id => 12345,
       :type => type,
@@ -46,26 +46,26 @@ def get_exporter(type:,
       :path_replace => path_replace,
       :path => path,
     )
-    POEditor::Exporter.new(configuration)
+    POEditor::Core.new(configuration)
   end
 
-  def test_export_failure
+  def test_pull_failure
     stub_api_export_failure()
-    exporter = get_exporter(
+    client = get_client(
       :type => "apple_strings",
       :languages => ["en", "ko"],
       :path => "",
     )
-    assert_raises POEditor::Exception do exporter.export_all() end
+    assert_raises POEditor::Exception do client.pull() end
   end
 
-  def test_export
-    exporter = get_exporter(
+  def test_pull
+    client = get_client(
       :type => "apple_strings",
       :languages => ["en", "ko", "zh-Hans", "zh-Hant"],
       :path => "TestProj/{LANGUAGE}.lproj/Localizable.strings"
     )
-    exporter.export_all()
+    client.pull()
 
     assert_match "Hi, %@!",
       File.read("TestProj/en.lproj/Localizable.strings")
@@ -83,14 +83,14 @@ def test_export
     assert File.read("TestProj/zh.lproj/Localizable.strings").length == 0
   end
 
-  def test_export_language_alias
-    exporter = get_exporter(
+  def test_pull_language_alias
+    client = get_client(
       :type => "apple_strings",
       :languages => ["en", "ko", "zh-Hans", "zh-Hant"],
       :language_alias => {"zh" => "zh-Hans"},
       :path => "TestProj/{LANGUAGE}.lproj/Localizable.strings",
     )
-    exporter.export_all()
+    client.pull()
 
     assert_match "Simplified 你好, %@!",
       File.read("TestProj/zh-Hans.lproj/Localizable.strings")
@@ -99,14 +99,14 @@ def test_export_language_alias
       File.read("TestProj/zh.lproj/Localizable.strings")
   end
 
-  def test_export_path_replace
-    exporter = get_exporter(
+  def test_pull_path_replace
+    client = get_client(
       :type => "android_strings",
       :languages => ["en", "ko", "zh-rCN", "zh-rTW"],
       :path => "TestProj/values-{LANGUAGE}/strings.xml",
       :path_replace => {"en" => "TestProj/values/strings.xml"},
     )
-    exporter.export_all()
+    client.pull()
 
     refute File.exist?("TestProj/values-en/strings.xml")
     assert_match "Hi, %s!",