phrase 0.2.0 → 0.2.1

data/.gitignore

@@ -1,2 +1,4 @@
 *.gem
 .phrase
+.DS_Store
+/phrase/

data/README.md

@@ -1,4 +1,4 @@
-# Phrase - the Gem
+# phrase
 
 ### Installation and usage
 
@@ -12,4 +12,4 @@
 
 ### More Information
 
-http://phraseapp.com
+https://phraseapp.com

data/lib/phrase/api/client.rb

@@ -1,6 +1,7 @@
 # -*- encoding : utf-8 -*-
 
 require 'addressable/uri'
+require 'cgi'
 require 'net/http'
 require 'net/https'
 require 'phrase'
@@ -44,24 +45,6 @@ class Phrase::Api::Client
     keys = extract_structured_object(result["translate"]) if result["translate"]
     keys
   end
-
-  def extract_structured_object(translation)
-    if translation.is_a?(Hash)
-      symbolize_keys(translation)
-    else
-      translation
-    end
-  end
-
-  def symbolize_keys(hash)
-    hash.symbolize_keys!
-    hash.each do |key, value|
-      if value.is_a?(Hash)
-        hash[key] = symbolize_keys(value)
-      end
-    end
-    hash
-  end
   
   def find_keys_by_name(key_names=[])
     result = JSON.parse(perform_api_request("/translation_keys", :get, {:key_names => key_names}))
@@ -103,12 +86,14 @@ class Phrase::Api::Client
     end
   end
   
-  def upload(filename, file_content)  
+  def upload(filename, file_content, tags=[])
     begin
-      perform_api_request("/translation_keys/upload", :post, {
+      params = {
         "filename" => filename,
         "file_content" => file_content,
-      })
+        "tags[]" => tags
+      }
+      perform_api_request("/translation_keys/upload", :post, params)
     rescue Phrase::Api::Exceptions::ServerError => e
       raise "File #{filename} could not be uploaded"
     end
@@ -116,6 +101,24 @@ class Phrase::Api::Client
   end
   
 private
+  def extract_structured_object(translation)
+    if translation.is_a?(Hash)
+      symbolize_keys(translation)
+    else
+      translation
+    end
+  end
+
+  def symbolize_keys(hash)
+    hash.symbolize_keys!
+    hash.each do |key, value|
+      if value.is_a?(Hash)
+        hash[key] = symbolize_keys(value)
+      end
+    end
+    hash
+  end
+
   def display_api_error(response)
     error_message = api_error_message(response)
     $stderr.puts error_message
@@ -171,7 +174,7 @@ private
     params.merge!({
       'auth_token' => @auth_token
     })
-    request.set_form_data(params)
+    set_form_data(request, params)
     request
   end
   
@@ -180,7 +183,7 @@ private
     params.merge!({
       'auth_token' => @auth_token
     })
-    request.set_form_data(params)
+    set_form_data(request, params)
     request
   end
   
@@ -195,4 +198,17 @@ private
     client.ca_file = File.join(File.dirname(__FILE__), "..", "..", "cacert.pem")
     client
   end
-end
+  
+  # Support for arrays in POST data
+  # http://blog.assimov.net/blog/2010/06/01/postput-arrays-with-ruby-nethttp-set_form_data/
+  def set_form_data(request, params, separator='&')
+    request.body = params.map do |key, value| 
+      if value.instance_of?(Array)
+        value.map {|value_item| "#{CGI::escape(key.to_s)}=#{CGI::escape(value_item.to_s)}"}.join(separator)
+      else
+        "#{CGI::escape(key.to_s)}=#{CGI::escape(value.to_s)}"
+      end
+    end.join(separator)
+    request.content_type = 'application/x-www-form-urlencoded'
+  end
+end

data/lib/phrase/tool.rb

@@ -1,24 +1,27 @@
 # -*- encoding : utf-8 -*-
 
-require 'optparse'
-require 'net/http'
-require 'net/https'
 require 'fileutils'
-require 'phrase/tool_config'
+require 'rubygems'
+require 'phrase'
 
 class Phrase::Tool
+  autoload :Config, 'phrase/tool/config'
+  autoload :Options, 'phrase/tool/options'
+  autoload :TagValidator, 'phrase/tool/tag_validator'
   
-  attr_accessor :config
+  attr_accessor :config, :options
   
   def initialize(argv)
     @args = argv
   end
 
   def run
-    @config = Phrase::ToolConfig.new
-    command = args.first
+    subcommand = @args.first
+    
+    @config = Phrase::Tool::Config.new
+    @options = Phrase::Tool::Options.new(@args, subcommand)
 
-    case command
+    case subcommand
       when /init/
         init
       when /push/
@@ -26,42 +29,47 @@ class Phrase::Tool
       when /pull/
         pull
       else
-        print_usage
+        if @options.get(:version)
+          print_version
+        else
+          print_usage
+        end
     end
   end
 
-protected  
+protected
+
   def init
-    secret_param = args.find{ |arg| arg =~ /secret=/ }
-    unless secret_param.to_s.match(/secret=.+/)
+    secret = @options.get(:secret)
+    unless secret.present?
       $stderr.puts "Need a secret to init, but found none."
       $stderr.puts "Please provide the --secret=YOUR_SECRET parameter."
       exit(41)
     end
-
-    secret = secret_param.split("=", 2).last
+    
     @config.secret = secret
     puts "Wrote secret to config file .phrase"
     
-    default_locale_param = args.find{ |arg| arg =~ /default-locale=/ }
-    if default_locale_param.to_s.match(/default-locale=.+/)
-      locale_name = default_locale_param.split("=", 2).last
-    else 
-      locale_name = "en"
-    end
-    create_locale(locale_name)
-    make_locale_default(locale_name)
+    default_locale_name = @options.get(:default_locale)    
+    create_locale(default_locale_name)
+    make_locale_default(default_locale_name)
   end
 
   def push
     check_config_available
+    tags = @options.get(:tags)
+    unless tags.empty? or valid_tags_are_given?(tags)
+      $stderr.puts "Invalid tags: Only letters, numbers, underscores and dashes are allowed"
+      exit(43)
+    end
     
     files = choose_files_to_upload
     if files.empty?
       puts "Could not find any files to upload :("
       exit(43)
     end
-    upload_files(files)
+    
+    upload_files(files, tags)
   end
 
   def pull
@@ -85,17 +93,23 @@ protected
   
   def print_usage
     $stderr.puts <<USAGE
-Welcome to phrase!
-
-  phrase           Prints usage
+usage: phrase <command> [<args>]
 
-  phrase init --secret=<YOUR SECRET> --default-locale=<YOUR DEFAULT LOCALE>
+  phrase init --secret=<YOUR SECRET> --default-locale=<DEFAULT LOCALE>
 
-  phrase push FILE
-  phrase push DIRECTORY
+  phrase push FILE [--tags=<tags>]
+  phrase push DIRECTORY [--tags=<tags>]
+  
+  phrase pull [LOCALE]
+  
+  phrase --version
 USAGE
   end
   
+  def print_version
+    puts "phrase version #{Phrase::VERSION}"
+  end
+  
 private
   def choose_files_to_upload
     file_name = args[1]
@@ -124,7 +138,7 @@ private
     end
   end
 
-  def upload_files(files)
+  def upload_files(files, tags=[])
     files.each do |file|
       proceed_with_upload = true
     
@@ -134,13 +148,14 @@ private
     
       if is_yaml_file(file)
         proceed_with_upload = false
-        $stderr.puts "Notice: Could not upload #{file} (extension not supported - see http://phraseapp.com/help for more information)"
+        $stderr.puts "Notice: Could not upload #{file} (extension not supported)"
       end
     
       if proceed_with_upload
         begin
-          puts "Uploading #{file}..."
-          api_client.upload(file, File.read(file))
+          tagged = " (tagged: #{tags.join(", ")})" if tags.size > 0
+          puts "Uploading #{file}#{tagged}..."
+          api_client.upload(file, File.read(file), tags)
           puts "OK"
         rescue Exception => e
           puts "Failed"
@@ -209,11 +224,6 @@ private
   def args
     @args
   end
-
-  def puts_debug_info
-    puts "ARGS: #{args.join(",")}"
-    puts "Dir.pwd: #{Dir.pwd}"
-  end
   
   def is_yaml_file(filepath)
     !File.directory?(filepath) && filepath.split('.').last != 'yml'
@@ -230,6 +240,13 @@ private
     end
   end
   
+  def valid_tags_are_given?(tags)
+    tags.each do |tag|
+      return false unless TagValidator.valid?(tag)
+    end
+    true
+  end
+  
   def self.rails_default_locale_folder
     "./config/locales/"
   end

data/lib/phrase/{tool_config.rb → tool/config.rb}

@@ -1,9 +1,8 @@
 # -*- encoding : utf-8 -*-
 
-require 'phrase'
 require 'json'
 
-class Phrase::ToolConfig
+class Phrase::Tool::Config
   def initialize
     if File.exist?(".phrase")
       begin

data/lib/phrase/tool/options.rb

@@ -0,0 +1,69 @@
+# -*- encoding : utf-8 -*-
+
+require 'optparse'
+
+class Phrase::Tool::Options
+  
+  def initialize(args, command="")
+    @command = command
+    @data = {
+      default: {
+        version: false,
+        help: false
+      },
+      init: {
+        secret: "",
+        default_locale: "en"
+      },
+      push: {
+        tags: []
+      },
+      pull: {
+      }
+    }
+    options.parse!(args)
+  end
+  
+  def get(name)
+    return @data.fetch(command_name).fetch(name.to_sym)
+  rescue => e
+    $stderr.puts "Invalid or missing option \"#{name}\" for command \"#{command_name}\""
+  end
+  
+private
+  
+  def options
+    case command_name
+      when :init
+        OptionParser.new do |opts|
+          opts.on("--secret=YOUR_AUTH_TOKEN", String, "Your auth token") do |secret|
+            @data[command_name][:secret] = secret
+          end
+          
+          opts.on("--default-locale=en", String, "The default locale for your application") do |default_locale|
+            @data[command_name][:default_locale] = default_locale
+          end
+        end
+      when :push
+        OptionParser.new do |opts|
+          opts.on("--tags=foo,bar", Array, "List of tags for phrase push (separated by comma)") do |tags|
+            @data[command_name][:tags] = tags
+          end
+        end
+      else
+        OptionParser.new do |opts|
+          opts.on_tail("-v", "--version", "Show version number") do |version|
+            @data[:default][:version] = true
+          end
+          
+          opts.on_tail("-h", "--help", "Show help") do |help|
+            @data[:default][:help] = true
+          end
+        end
+    end
+  end
+  
+  def command_name
+    @command_name ||= (@command.present? and @data.has_key?(@command.to_sym)) ? @command.to_sym : :default
+  end
+end

data/lib/phrase/tool/tag_validator.rb

@@ -0,0 +1,9 @@
+# -*- encoding : utf-8 -*-
+
+class Phrase::Tool::TagValidator
+  FORMAT = /\A[a-zA-Z0-9_-]+\z/
+  
+  def self.valid?(tag_name)
+    (tag_name.to_s =~ FORMAT)
+  end
+end

data/lib/phrase/version.rb

@@ -0,0 +1,3 @@
+module Phrase
+  VERSION = "0.2.1"
+end

data/phrase.gemspec

@@ -2,15 +2,17 @@
 lib = File.expand_path('../lib/', __FILE__)
 $:.unshift lib unless $:.include?(lib)
 
+require 'phrase/version'
+
 Gem::Specification.new do |s|
   s.name = "phrase"
-  s.version = "0.2.0"
+  s.version = Phrase::VERSION
   s.platform = Gem::Platform::RUBY
   s.authors = ["Dynport GmbH"]
   s.email = ["info@phraseapp.com"]
-  s.homepage = "http://phraseapp.com"
+  s.homepage = "https://phraseapp.com"
   s.summary = %q{The best way to manage i18n.}
-  s.description = %q{phrase allows you to edit translations inline, on the page itself. More information at phraseapp.com}
+  s.description = %q{phrase allows you to edit translations in-place on the page itself. More information at phraseapp.com}
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project = "phrase"
   git_files = `git ls-files | grep -v spec/`.split("\n") rescue ''

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phrase
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-26 00:00:00.000000000 Z
+date: 2012-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70308573413560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,15 +21,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.0'
+  version_requirements: *70308573413560
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70308573428880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -37,13 +32,8 @@ dependencies:
         version: 2.2.8
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.2.8
-description: phrase allows you to edit translations inline, on the page itself. More
+  version_requirements: *70308573428880
+description: phrase allows you to edit translations in-place on the page itself. More
   information at phraseapp.com
 email:
 - info@phraseapp.com
@@ -70,10 +60,13 @@ files:
 - lib/phrase/delegate.rb
 - lib/phrase/engine.rb
 - lib/phrase/tool.rb
-- lib/phrase/tool_config.rb
+- lib/phrase/tool/config.rb
+- lib/phrase/tool/options.rb
+- lib/phrase/tool/tag_validator.rb
+- lib/phrase/version.rb
 - lib/phrase/view_helpers.rb
 - phrase.gemspec
-homepage: http://phraseapp.com
+homepage: https://phraseapp.com
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -93,9 +86,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: phrase
-rubygems_version: 1.8.24
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: The best way to manage i18n.
 test_files: []
-has_rdoc: