Class: POEditor::Core

Inherits:
Object
  • Object
show all
Defined in:
lib/poeditor/core.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(configuration) ⇒ Core

Returns a new instance of Core.

Parameters:



10
11
12
13
14
15
16
 
# File 'lib/poeditor/core.rb', line 10

def initialize(configuration)
  unless configuration.is_a? Configuration
    raise POEditor::Exception.new \
      "`configuration` should be an `Configuration`"
  end
  @configuration = configuration
end

Instance Attribute Details

#configuration ⇒ POEditor::Configuration

Returns The configuration for export.

Returns:



7
8
9
 
# File 'lib/poeditor/core.rb', line 7

def configuration
  @configuration
end

Instance Method Details

#api(action, api_token, options = {}) ⇒ Net::HTTPResponse

Request POEditor API

Parameters:

  • action (String)
  • api_token (String)
  • options (Hash{Sting => Object}) (defaults to: {})

Returns:

  • (Net::HTTPResponse) —

    The response object of API request

See Also:



27
28
29
30
31
 
# File 'lib/poeditor/core.rb', line 27

def api(action, api_token, options={})
  uri = URI("https://api.poeditor.com/v2/#{action}")
  options["api_token"] = api_token
  return Net::HTTP.post_form(uri, options)
end

#convert_to_poeditor_language(language) ⇒ Object 



96
97
98
99
100
101
102
103
104
 
# File 'lib/poeditor/core.rb', line 96

def convert_to_poeditor_language(language)
  if language.downcase.match(/zh.+(hans|cn)/)
    'zh-CN'
  elsif language.downcase.match(/zh.+(hant|tw)/)
    'zh-TW'
  else
    language
  end
end

#export(api_key:, project_id:, language:, type:, tags: nil, filters: nil) ⇒ Object

Export translation for specific language

Parameters:

  • api_key (String)
  • project_jd (String)
  • language (String)
  • type (String)
  • tags (Array<String>) (defaults to: nil)
  • filters (Array<String>) (defaults to: nil)

Returns:

  • Downloaded translation content



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/poeditor/core.rb', line 64

def export(api_key:, project_id:, language:, type:, tags:nil, filters:nil)
  options = {
    "id" => project_id,
    "language" => convert_to_poeditor_language(language),
    "type" => type,
    "tags" => (tags || []).join(","),
    "filters" => (filters || []).join(","),
  }
  response = self.api("projects/export", api_key, options)
  data = JSON(response.body)
  unless data["response"]["status"] == "success"
    code = data["response"]["code"]
    message = data["response"]["message"]
    raise POEditor::Exception.new "#{message} (#{code})"
  end

  download_uri = URI(data["result"]["url"])
  content = Net::HTTP.get(download_uri)

  case type
  when "apple_strings"
    content.gsub!(/(%(\d+\$)?)s/, '\1@')  # %s -> %@
  when "android_strings"
    content.gsub!(/(%(\d+\$)?)@/, '\1s')  # %@ -> %s
  end

  unless content.end_with? "\n"
    content += "\n"
  end
  return content
end

#path_for_language(language) ⇒ Object 



116
117
118
119
120
121
122
 
# File 'lib/poeditor/core.rb', line 116

def path_for_language(language)
  if @configuration.path_replace[language]
    @configuration.path_replace[language]
  else
    @configuration.path.gsub("{LANGUAGE}", language)
  end
end

#pull ⇒ Object

Pull translations



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/poeditor/core.rb', line 34

def pull()
  UI.puts "\nExport translations"
  for language in @configuration.languages
    UI.puts "  - Exporting '#{language}'"
    content = self.export(:api_key => @configuration.api_key,
                          :project_id => @configuration.project_id,
                          :language => language,
                          :type => @configuration.type,
                          :tags => @configuration.tags,
                          :filters => @configuration.filters)
    write(language, content)

    for alias_to, alias_from in @configuration.language_alias
      if language == alias_from
        write(alias_to, content)
      end
    end
  end
end

#write(language, content) ⇒ Object

Write translation file



107
108
109
110
111
112
113
114
 
# File 'lib/poeditor/core.rb', line 107

def write(language, content)
  path = path_for_language(language)
  unless File.exist?(path)
    raise POEditor::Exception.new "#{path} doesn't exist"
  end
  File.write(path, content)
  UI.puts "      #{"\xe2\x9c\x93".green} Saved at '#{path}'"
end