phraseapp_updater 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b4b5ca69acb3ee2e8aa1b40c1325872ac307c50
-  data.tar.gz: 0f1e8961e0e35908ab8c8094ee845a9d71c8badf
+  metadata.gz: a0c061126d02d4f01d387770c2c9340336be6e5f
+  data.tar.gz: 31e72d551e6852fa680e477c2e0a9ba185bd5160
 SHA512:
-  metadata.gz: 70c04afe5d8a011e3f7d68872f82bfa7a67150c6868d29f2b7b2a0990647a9496a92165c1d44f7753ec72b59b4fd5649f0e93b41ca68c8041829f830033d3715
-  data.tar.gz: b6880095d635a3b72dade7bbe19ea363b6c1fb38db91cae84f230e307f34f9f7757e6b9a3bfdcdeeb208a36f3d8689705f5bc58211916bf1f68df44db5c60720
+  metadata.gz: 6b64d248d78459245df8f5f17121b85268f11cf35273addb88d8d8f876e3d24325644d6ba7696f112bca6003aefc5c8e3ac752c3a4a64e6959246bfe89d93203
+  data.tar.gz: 4ada8a07261f8e5966a6a72ed5f8223bf18999704fccfaa1f1f7c6dc4d98506b8195ed8a179b1287aef6fe88e4031ba431bffbe71e76dd5d7cc5a651a2fae848

data/README.markdown

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/iknow/phraseapp_updater.svg?branch=master)](https://travis-ci.org/iknow/phraseapp_updater)
 
-**Version** 0.1.4
+**Version** 0.1.5
 
 This is a tool for merging PhraseApp locale data with locale data
 committed in your project.
@@ -89,7 +89,7 @@ committed to your application's respository.  These will be used in the
 merge with the files on PhraseApp.
 
 ```
-phraseapp_updater push --new_locales_path="/data/previous", --previous_locales_path="/data/new" --phraseapp_api_key="yourkey" --phraseapp_project_id="projectid"
+phraseapp_updater push --new_locales_path="/data/previous", --previous_locales_path="/data/new" --phraseapp_api_key="yourkey" --phraseapp_project_id="projectid --file_format=json"
 ```
 
 The arguments provided to the command can also be specified as shell
@@ -100,6 +100,7 @@ PA_NEW_LOCALES_PATH
 PA_PREVIOUS_LOCALES_PATH
 PA_API_KEY
 PA_PROJECT_ID
+PA_FILE_FORMAT
 ```
 
 Additionally, PhraseApp credentials can be loaded from a
@@ -118,7 +119,7 @@ If you want to pull without this fallback behavior, PhraseApp's [client](https:/
 is the best tool to use.
 
 ```
-phraseapp_updater pull --fallback_path="/data/app/locales" --phraseapp_api_key="yourkey" --phraseapp_project_id="projectid"
+phraseapp_updater pull --fallback_path="/data/app/locales" --phraseapp_api_key="yourkey" --phraseapp_project_id="projectid --file_format=json""
 ```
 
 The PhraseApp data passed to the command can also be specified as shell
@@ -127,6 +128,7 @@ variables:
 ```
 PA_API_KEY
 PA_PROJECT_ID
+PA_FILE_FORMAT
 ```
 
 Additionally, PhraseApp credentials can be loaded from a
@@ -138,8 +140,8 @@ Ruby
 `PhraseAppUpdater.push` and `PhraseAppUpdater.pull` are analogous to the command line versions:
 
 ```ruby
-PhraseAppUpdater.push("api_key", "project_id", "previous/path", "current/path")
-PhraseAppUpdater.pull("api_key", "project_id", "fallback/path")
+PhraseAppUpdater.new("api_key", "project_id", "file_format").push("previous/path", "current/path")
+PhraseAppUpdater.new("api_key", "project_id", "file_format").pull("fallback/path")
 ```
 
 

data/bin/phraseapp_updater

@@ -11,9 +11,10 @@ class PhraseAppUpdaterCLI < Thor
   option :config_file_path,                type: :string, desc: "Path to .phraseapp.yml config file to read API key and project ID."
   option :store_results_path,              type: :string, desc: "Path to write the resolved files. Shell variable: PA_STORE_RESULTS_PATH"
   option :store_phraseapp_originals_path,  type: :string, desc: "Path to write the files downloaded from PhraseApp before the merge. Shell variable: PA_STORE_PHRASEAPP_ORIGINALS_PATH"
+  option :file_format,                     type: :string, desc: "Filetype of localization files."
 
   def push
-    phraseapp_api_key, phraseapp_project_id = load_phraseapp_credentials(options)
+    phraseapp_api_key, phraseapp_project_id, file_format = load_phraseapp_configuration(options)
 
     new_locales_path = options.fetch(:new_locales_path, ENV["PA_NEW_LOCALES_PATH"]).to_s
     validate_readable_path!('new_locales_path', new_locales_path)
@@ -28,7 +29,7 @@ class PhraseAppUpdaterCLI < Thor
     validate_writable_path!('store_phraseapp_originals_path', store_phraseapp_originals_path)
 
     begin
-      result = PhraseAppUpdater.new(phraseapp_api_key, phraseapp_project_id).push(previous_locales_path, new_locales_path)
+      result = PhraseAppUpdater.new(phraseapp_api_key, phraseapp_project_id, file_format).push(previous_locales_path, new_locales_path)
 
       unless store_results_path.empty?
         write_locale_files(store_results_path, result.resolved_files)
@@ -41,8 +42,10 @@ class PhraseAppUpdaterCLI < Thor
       puts "Bad PhraseApp API key."
     rescue PhraseAppUpdater::PhraseAppAPI::BadProjectIDError => e
       puts "Bad PhraseApp project ID: #{phraseapp_project_id}"
+    rescue PhraseAppUpdater::LocaleFile::BadFileTypeError => e
+      puts "Bad filetype for localization files: #{e.message}"
     rescue StandardError => e
-      puts "Unknown error when pushing files"
+      puts "Unknown error when pushing files."
       raise e
     end
   end
@@ -56,7 +59,7 @@ class PhraseAppUpdaterCLI < Thor
   option :config_file_path,      type: :string,                  desc: "Path to .phraseapp.yml config file to read API key and project ID."
 
   def pull
-    phraseapp_api_key, phraseapp_project_id = load_phraseapp_credentials(options)
+    phraseapp_api_key, phraseapp_project_id, file_format = load_phraseapp_configuration(options)
 
     fallback_path = options[:fallback_path]
     validate_readable_path!('fallback_path', fallback_path)
@@ -65,12 +68,14 @@ class PhraseAppUpdaterCLI < Thor
     validate_writable_path!('destination_path', destination_path)
 
     begin
-      files = PhraseAppUpdater.new(phraseapp_api_key, phraseapp_project_id).pull(fallback_path)
+      files = PhraseAppUpdater.new(phraseapp_api_key, phraseapp_project_id, file_format).pull(fallback_path)
       write_locale_files(destination_path, files)
     rescue PhraseAppUpdater::PhraseAppAPI::BadAPIKeyError => e
       puts "Bad PhraseApp API key."
     rescue PhraseAppUpdater::PhraseAppAPI::BadProjectIDError => e
       puts "Bad PhraseApp project ID: #{phraseapp_project_id}"
+    rescue PhraseAppUpdater::LocaleFile::BadFileTypeError => e
+      puts "Bad filetype for localization files: #{e.message}"
     rescue StandardError => e
       puts "Unknown error when pulling files"
       raise e
@@ -92,10 +97,10 @@ class PhraseAppUpdaterCLI < Thor
 
   private
 
-  def load_phraseapp_credentials(options)
+  def load_phraseapp_configuration(options)
     if options[:config_file_path]
 
-      if options[:phraseapp_api_key] || options[:phraseapp_project_id]
+      if [:phraseapp_api_key, :phraseapp_project_id, :file_format].any? { |option| options.has_key?(:option) }
         raise RuntimeError.new("Provided both a path to PhraseApp config file and command line arguments. Specify only one. #{options}")
       end
 
@@ -103,9 +108,11 @@ class PhraseAppUpdaterCLI < Thor
 
       phraseapp_api_key    = config.api_key
       phraseapp_project_id = config.project_id
+      file_format          = config.file_format
     else
       phraseapp_api_key    = options.fetch(:phraseapp_api_key, ENV["PA_API_KEY"]).to_s
       phraseapp_project_id = options.fetch(:phraseapp_project_id, ENV["PA_PROJECT_ID"]).to_s
+      file_format          = options.fetch(:file_format, ENV["PA_FILE_FORMAT"]).to_s
     end
 
     if phraseapp_api_key.empty?
@@ -116,7 +123,11 @@ class PhraseAppUpdaterCLI < Thor
       raise RuntimeError.new("Must provide Phraseapp project ID. --phraseapp_project_id or PA_PROJECT_ID")
     end
 
-    return [phraseapp_api_key, phraseapp_project_id]
+    if file_format.empty?
+      raise RuntimeError.new("Must provide file format for Phraseapp project. --file_format or PA_FILE_FORMAT")
+    end
+
+    return [phraseapp_api_key, phraseapp_project_id, file_format]
   end
 
   def validate_path!(name, path)

data/lib/phraseapp_updater.rb

@@ -2,15 +2,16 @@ require 'phraseapp_updater/version'
 require 'phraseapp_updater/index_by'
 require 'phraseapp_updater/differ'
 require 'phraseapp_updater/locale_file'
-require 'phraseapp_updater/locale_file_loader'
+require 'phraseapp_updater/locale_file/loader'
 require 'phraseapp_updater/phraseapp_api'
 require 'phraseapp_updater/yml_config_loader'
 
 class PhraseAppUpdater
   using IndexBy
 
-  def initialize(phraseapp_api_key, phraseapp_project_id)
-    @phraseapp_api = PhraseAppAPI.new(phraseapp_api_key, phraseapp_project_id)
+  def initialize(phraseapp_api_key, phraseapp_project_id, file_format)
+    @locale_file_class = LocaleFile.class_for_file_format(file_format)
+    @phraseapp_api     = PhraseAppAPI.new(phraseapp_api_key, phraseapp_project_id, @locale_file_class)
   end
 
   def self.load_config(config_file_path)
@@ -38,7 +39,7 @@ class PhraseAppUpdater
                                          primary: new_locale_file.parsed_content,
                                          secondary: phraseapp_file.parsed_content)
 
-      LocaleFile.from_hash(previous_locale_file.name, resolved_content)
+      @locale_file_class.from_hash(previous_locale_file.name, resolved_content)
     end
 
     # Upload all of the secondary languages first,
@@ -88,7 +89,7 @@ class PhraseAppUpdater
       fallback           = clear_empty_strings!(fallback_files[phraseapp_without_unverified_file.name].parsed_content)
 
       restore_unverified_originals!(fallback, with_unverified, without_unverified)
-      LocaleFile.from_hash(phraseapp_without_unverified_file.name, without_unverified)
+      @locale_file_class.from_hash(phraseapp_without_unverified_file.name, without_unverified)
     end
   end
 
@@ -107,8 +108,9 @@ class PhraseAppUpdater
   end
 
   def load_locale_files(*paths)
+    loader = LocaleFile::Loader.new(@locale_file_class::EXTENSION)
     paths.map do |path|
-      LocaleFileLoader.filenames(path).map { |l| LocaleFileLoader.load(l) }
+      loader.filenames(path).map { |l| loader.load(l) }
     end
   end
 

data/lib/phraseapp_updater/locale_file.rb

@@ -1,18 +1,28 @@
-require 'multi_json'
-require 'oj'
-
-# We're working with pure JSON, not
-# serialized Ruby objects
-Oj.default_options = {mode: :strict}
+require "phraseapp_updater/locale_file/json_file"
+require "phraseapp_updater/locale_file/yaml_file"
 
 class PhraseAppUpdater
   class LocaleFile
     attr_reader :name, :content, :parsed_content
 
+    class BadFileTypeError < StandardError ; end
+
     def self.from_hash(name, hash)
-      new(name, MultiJson.dump(hash))
+      raise RuntimeError.new("Must be implemented in a subclass.")
+    end
+
+    def self.class_for_file_format(type)
+      case type.downcase
+      when "json"
+        JSONFile
+      when "yml", "yaml"
+        YAMLFile
+      else
+        raise BadFileTypeError.new("Invalid file type: #{type}")
+      end
     end
 
+    # Expects a Ruby hash
     def initialize(name, content)
       @name           = name
       @content        = content
@@ -25,20 +35,17 @@ class PhraseAppUpdater
     end
 
     def name_with_extension
-      "#{name}.json"
+      "#{name}.#{self.class::EXTENSION}"
     end
 
     private
 
     def parse(content)
-      MultiJson.load(content)
-    rescue MultiJson::ParseError => e
-      raise ArgumentError.new("Provided content was not valid JSON")
+      raise RuntimeError.new("Must be implemented in a subclass.")
     end
 
     def format_content!
-      # Add indentation for better diffs
-      @content = MultiJson.dump(MultiJson.load(@content), pretty: true)
+      raise RuntimeError.new("Must be implemented in a subclass.")
     end
   end
 end

data/lib/phraseapp_updater/locale_file/json_file.rb

@@ -0,0 +1,29 @@
+require 'multi_json'
+require 'oj'
+
+# We're working with pure JSON, not
+# serialized Ruby objects
+Oj.default_options = {mode: :strict}
+
+class PhraseAppUpdater
+  class LocaleFile
+    class JSONFile < LocaleFile
+      EXTENSION = "json"
+      def self.from_hash(name, hash)
+        new(name, MultiJson.dump(hash))
+      end
+
+      def parse(content)
+        MultiJson.load(content)
+      rescue MultiJson::ParseError => e
+        raise ArgumentError.new("Provided content was not valid JSON: #{e}")
+      end
+
+      def format_content!
+        # Add indentation for better diffs
+        @content = MultiJson.dump(MultiJson.load(@content), pretty: true)
+      end
+    end
+  end
+end
+

data/lib/phraseapp_updater/locale_file/loader.rb

@@ -0,0 +1,24 @@
+require 'phraseapp_updater/locale_file'
+
+class PhraseAppUpdater
+  class LocaleFile
+    class Loader
+      def initialize(extension)
+        @extension = extension
+      end
+
+      def load(filename)
+        unless File.readable?(filename) && File.file?(filename)
+          raise RuntimeError.new("Couldn't read localization file at #{filename}")
+        end
+
+        LocaleFile.class_for_file_format(@extension).new(File.basename(filename).chomp(".#{@extension}"), File.read(filename))
+      end
+
+      def filenames(locale_directory)
+        Dir["#{locale_directory}/*.#{@extension}"]
+      end
+    end
+  end
+end
+

data/lib/phraseapp_updater/locale_file/yaml_file.rb

@@ -0,0 +1,20 @@
+require 'psych'
+class PhraseAppUpdater
+  class LocaleFile
+    class YAMLFile < LocaleFile
+      EXTENSION = "yml"
+      def self.from_hash(name, hash)
+        new(name, Psych.dump(hash))
+      end
+
+      def parse(content)
+        Psych.load(content)
+      rescue Psych::SyntaxError => e
+        raise ArgumentError.new("Provided content was not valid YAML")
+      end
+
+      def format_content!
+      end
+    end
+  end
+end

data/lib/phraseapp_updater/phraseapp_api.rb

@@ -4,9 +4,10 @@ require 'thread'
 
 class PhraseAppUpdater
   class PhraseAppAPI
-    def initialize(api_key, project_id)
-      @client     = PhraseApp::Client.new(PhraseApp::Auth::Credentials.new(token: api_key))
-      @project_id = project_id
+    def initialize(api_key, project_id, locale_file_class)
+      @client            = PhraseApp::Client.new(PhraseApp::Auth::Credentials.new(token: api_key))
+      @project_id        = project_id
+      @locale_file_class = locale_file_class
     end
 
     def download_locales
@@ -23,7 +24,7 @@ class PhraseAppUpdater
         puts "Downloading file for #{locale}"
         download_file(locale, skip_unverified)
       end.map do |locale, file_contents|
-        LocaleFile.new(locale.name, file_contents)
+        @locale_file_class.new(locale.name, file_contents)
       end
     end
 

data/lib/phraseapp_updater/version.rb

@@ -1,3 +1,3 @@
 class PhraseAppUpdater
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/lib/phraseapp_updater/yml_config_loader.rb

@@ -2,7 +2,7 @@ require 'yaml'
 
 class PhraseAppUpdater
   class YMLConfigLoader
-    attr_reader :api_key, :project_id
+    attr_reader :api_key, :project_id, :file_format
     def initialize(file_path)
       unless File.readable?(file_path)
         raise RuntimeError.new("Can't read config file at #{file_path}")
@@ -14,8 +14,33 @@ class PhraseAppUpdater
         raise RuntimeError.new("Couldn't parse file contents: #{File.read(file_path)}")
       end
 
-      @api_key    = parsed_yaml.fetch("phraseapp").fetch("access_token")
-      @project_id = parsed_yaml.fetch("phraseapp").fetch("project_id")
+      config = parsed_yaml.fetch("phraseapp")
+
+      @api_key     = config.fetch("access_token")
+      @project_id  = config.fetch("project_id")
+
+      push_file_format = config.fetch("push").fetch("sources").first.fetch("params").fetch("file_format")
+      pull_file_format = config.fetch("pull").fetch("targets").first.fetch("params").fetch("file_format")
+
+      unless push_file_format == pull_file_format
+        raise ArgumentError.new("Push and pull must be the same format")
+      end
+
+      @file_format = convert(push_file_format)
+    end
+
+
+    private
+
+    def convert(phraseapp_file_format)
+      case phraseapp_file_format
+      when "nested_json"
+        "json"
+      when "yml"
+        "yml"
+      else
+        raise ArugmentError.new("Unsupported type: #{phraseapp_file_format}")
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phraseapp_updater
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Kevin Griffin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-21 00:00:00.000000000 Z
+date: 2017-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -174,7 +174,9 @@ files:
 - lib/phraseapp_updater/differ.rb
 - lib/phraseapp_updater/index_by.rb
 - lib/phraseapp_updater/locale_file.rb
-- lib/phraseapp_updater/locale_file_loader.rb
+- lib/phraseapp_updater/locale_file/json_file.rb
+- lib/phraseapp_updater/locale_file/loader.rb
+- lib/phraseapp_updater/locale_file/yaml_file.rb
 - lib/phraseapp_updater/phraseapp_api.rb
 - lib/phraseapp_updater/version.rb
 - lib/phraseapp_updater/yml_config_loader.rb
@@ -199,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A three-way differ for PhraseApp projects.

data/lib/phraseapp_updater/locale_file_loader.rb

@@ -1,18 +0,0 @@
-require 'phraseapp_updater/locale_file'
-
-class PhraseAppUpdater
-  class LocaleFileLoader
-    def self.load(filename)
-      unless File.readable?(filename) && File.file?(filename)
-        raise RuntimeError.new("Couldn't read localization file at #{filename}")
-      end
-
-      LocaleFile.new(File.basename(filename).chomp(".json"), File.read(filename))
-    end
-
-    def self.filenames(locale_directory)
-      Dir["#{locale_directory}/*.json"]
-    end
-  end
-end
-