ricotta 0.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    ricotta (0.0.1)
+      commander (~> 4.1.2)
+      faraday (~> 0.8.0)
+      faraday_middleware (~> 0.9.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    commander (4.1.3)
+      highline (~> 1.6.11)
+    faraday (0.8.7)
+      multipart-post (~> 1.1)
+    faraday_middleware (0.9.0)
+      faraday (>= 0.7.4, < 0.9)
+    highline (1.6.19)
+    multipart-post (1.2.0)
+    rake (0.9.6)
+    rspec (0.6.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 0.9.2)
+  ricotta!
+  rspec (~> 0.6.1)

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Erik Sundin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+Ricotta is a web based translation management tool, with complimentary build 
+tools, to efficiently manage localized resources in your software project.
+
+- http://ricotta-open.appspot.com
+- https://github.com/sosandstrom/ricotta
+
+## About
+
+The ricotta gem integrates with the Ricotta translation tool to make it easier
+to keep translations up to date in your software projects, all from the command line.
+
+## Installation
+
+    gem install ricotta
+
+## Usage
+
+    $ ricotta
+    
+    Download translations from Ricotta
+    
+    Commands:
+    dump                 Dump translations from Ricotta into local files.
+    help                 Display global or [command] help documentation.
+    install:xcode        Fetch translations from Ricotta and install them into an Xcode project
+
+    Global Options:
+    -h, --help           Display help documentation 
+    -v, --version        Display version information 
+    -t, --trace          Display backtrace when an error occurs 
+
+### Install into an Xcode project
+
+    $ cd projects/MyXcodeProject
+    $ ricotta install:xcode -u http://ricotta-open.appspot.com \
+                            -p MyRicottaProject \
+                            -l en
+
+Or by recommendation, create a `.ricottarc` file (see below) and execute.
+
+    $ ricotta install:xcode
+
+## Configuration
+
+You can configure ricotta by using a ricotta configuration file. 
+The recommended name is `.ricottarc` but a custom file can be passed by using the `-c` option.
+
+    # My Ricotta configuration
+    url: http://ricotta-open.appspot.com
+    project: MyProject
+    language: en,es,pt
+    branch: staging
+    template: my_translation_template
+
+Ricotta automatically searches for `.ricottarc` in the current working directory and in the users home directory.
+Multiple configurations are automatically merged.
+
+Multiple configurations example:
+
+    # Global config in ~/.ricottarc
+    url: http://ricotta.mycompany.com
+    subset: ios
+
+App configurations
+
+    # /Users/es/dev/projects/MyiOSApp
+    project: MyApp
+    language: en,es
+    name_token: appName
+    
+And
+
+    # /Users/es/dev/projects/MyOtheriOSApp
+    project: MyOtherApp
+    language: en,pt,ru
+    name_token: applicationName
+    subset: iphone  #override global config
+    
+## Contact
+
+Erik Sundin
+
+- erik@eriksundin.se
+ 
+## License
+
+Ricotta gem is available under the MIT license. See the LICENSE file for more info.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler"
+Bundler.setup
+
+gemspec = eval(File.read("ricotta.gemspec"))
+
+task :build => "#{gemspec.full_name}.gem"
+
+file "#{gemspec.full_name}.gem" => gemspec.files + ["ricotta.gemspec"] do
+  system "gem build ricotta.gemspec"
+end

data/bin/ricotta

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require 'commander/import'
+
+$:.push File.expand_path("../../lib", __FILE__)
+require 'ricotta'
+
+HighLine.track_eof = false # Fix for built-in Ruby
+
+program :version, Ricotta::VERSION
+program :description, 'Download translations from Ricotta'
+
+program :help, 'Author', 'Erik Sundin <erik@eriksundin.se>'
+program :help, 'Website', 'http://github.com/eriksundin'
+program :help_formatter, :compact
+
+default_command :help
+
+require 'ricotta/commands'

data/lib/ricotta.rb

@@ -0,0 +1,6 @@
+module Ricotta
+  VERSION = '0.0.1'
+end
+
+require 'ricotta/fetcher'
+require 'ricotta/configuration'

data/lib/ricotta/commands.rb

@@ -0,0 +1,4 @@
+$:.push File.expand_path('../', __FILE__)
+
+require 'commands/dump'
+require 'commands/xcode'

data/lib/ricotta/commands/dump.rb

@@ -0,0 +1,69 @@
+require 'yaml'
+
+command :'dump' do |c|
+  c.syntax = "ricotta dump [options]"
+  c.summary = "Dump translations from Ricotta into local files."
+  c.description = "Fetched translations will written to one file per language"
+  c.option '-u', '--url URL', "Ricotta application URL"
+  c.option '-p', '--project PROJECT', "The Ricotta project"
+  c.option '-l', '--language LANGUAGE', "Comma separated list of language codes"
+  c.option '-T', '--template TEMPLATE', "Template name"
+  c.option '--subset SUBSET', "The subset name"
+  c.option '--branch BRANCH', "The branch name ('trunk' if not set)"
+  c.option '--config FILE', "Load default options from a configuration file"
+  
+  c.action do |args, options|
+    options.default :branch => 'trunk'
+    
+    global_config = Ricotta::Configuration::Config.new(options.config)
+    options.url = global_config[:url] unless options.url
+    options.project = global_config[:project] unless options.project
+    options.language = global_config[:language] unless options.language
+    options.subset = global_config[:subset] unless options.subset
+    options.template = global_config[:template] unless options.template
+    options.branch = global_config[:branch] if global_config[:branch] and options.branch.eql?('trunk')
+    
+    
+    determine_url! unless @url = options.url
+    determine_project! unless @project = options.project
+    determine_language! unless @language = options.language
+    determine_template! unless @template = options.template
+    
+    languages = @language.split(',')
+    
+    client = Ricotta::Fetcher::Client.new(@url)
+    
+    languages.each do |language|
+      
+      response = client.fetch(@project, options.branch, language, @template, options.subset)
+      case response.status
+      when 200
+        output = "#{@project}.#{language}"
+        File.open(output, 'w') { |file| file.write("#{response.body}") }
+        say_ok "#{language} translations downloaded to #{output}"
+      else
+        say_error "Failed to download translations for #{language}: #{response.status} #{response.body}\n"
+        abort
+      end
+    end
+  end
+
+  private
+
+  def determine_url!
+    @url ||= ask "Ricotta URL:"
+  end
+
+  def determine_project!
+    @project ||= ask "Project:"
+  end
+
+  def determine_template!
+    @template ||= ask "Template:"
+  end
+
+  def determine_language!
+    @language ||= ask "Language(s):"
+  end
+
+end

data/lib/ricotta/commands/xcode.rb

@@ -0,0 +1,96 @@
+
+command :'install:xcode' do |c|
+  c.syntax = "ricotta install:xcode [options]"
+  c.summary = "Fetch translations from Ricotta and install them into an Xcode project"
+  c.description = "Execute this command in the root of the Xcode project."
+  c.option '-u', '--url URL', "Ricotta application URL"
+  c.option '-p', '--project PROJECT', "The Ricotta project"
+  c.option '-l', '--language LANGUAGE', "Comma separated list of language codes"
+  c.option '--subset SUBSET', "Subset name"
+  c.option '--name_token NAMETOKEN', "A token within the translations to install as the localized CFBundleDisplayName"
+  c.option '--lproj_dir LPROJDIR', "Home dir of the localized Xcode project folders (default: scans the working directory)"
+  c.option '--template TEMPLATE', "The template (default: 'localizable_strings_padding')"
+  c.option '--branch BRANCH', "The branch name (default: 'trunk')"
+  c.option '--config FILE', "Load default options from a configuration file"
+  
+  c.action do |args, options|
+    options.default :branch => 'trunk', :template => 'localizable_strings_padding'
+    
+    global_config = Ricotta::Configuration::Config.new(options.config)
+    options.url = global_config[:url] unless options.url
+    options.project = global_config[:project] unless options.project
+    options.language = global_config[:language] unless options.language
+    options.subset = global_config[:subset] unless options.subset
+    options.template = global_config[:template] if global_config[:template] and options.template.eql?('localizable_strings_padding')
+    options.branch = global_config[:branch] if global_config[:branch] and options.branch.eql?('trunk')
+    
+    options.name_token = global_config[:name_token] unless options.name_token
+    options.lproj_dir = global_config[:lproj_dir] unless options.lproj_dir
+    
+    determine_url! unless @url = options.url
+    determine_project! unless @project = options.project
+    determine_language! unless @language = options.language
+    
+    unless @resource_path = options.lproj_dir 
+      resource_dir_lookup = Dir.glob('**/*.lproj').first    
+      @resource_path = File.dirname(resource_dir_lookup) if resource_dir_lookup
+    end
+    
+    determine_resource_path! unless @resource_path
+    @resource_path = File.expand_path(@resource_path)
+    say_error "The directory #{@resource_path} does not exist" and abort unless File.directory?(@resource_path)
+    
+    languages = @language.split(',')
+    client = Ricotta::Fetcher::Client.new(@url)
+    
+    languages.each do |language|
+      say_ok "processing #{language}"
+      response = client.fetch(@project, options.branch, language, options.template, options.subset)
+      case response.status
+      when 200
+        lproj_base_dir = "#{@resource_path}/#{language}.lproj"
+        Dir.mkdir(lproj_base_dir) unless File.directory?(lproj_base_dir)
+        strings_file = "#{lproj_base_dir}/Localizable.strings"
+        File.open(strings_file, 'w') { |file| file.write("#{response.body}") }
+        say_ok "created #{strings_file}"
+      
+        if options.name_token
+          File.open(strings_file).each do |line|
+            if line.start_with?(options.name_token)
+              app_name = line.split('=').last.strip.split('"')[1]
+              say_error "The token #{options.name_token} is missing or empty for language #{language}" and abort unless app_name.length > 0
+              
+              info_plist_strings = "#{lproj_base_dir}/InfoPlist.strings"
+              File.open(info_plist_strings, 'w') { |file| file.write("CFBundleDisplayName=\"#{app_name}\";\n") }
+              say_ok "created #{info_plist_strings} with CFBundleDisplayName '#{app_name}'"
+              
+              break
+            end
+          end
+        end
+      else
+        say_error "Failed to download translations for #{language}: #{response.status} #{response.body}\n" and abort
+      end
+    end
+    say_ok "translations for #{@project} installed"
+  end
+  
+  private
+  
+  def determine_resource_path!
+    @resource_path ||= ask "Destination for .lproj folders:"
+  end
+  
+  def determine_url!
+    @url ||= ask "Ricotta URL:"
+  end
+
+  def determine_project!
+    @project ||= ask "Project:"
+  end
+
+  def determine_language!
+    @language ||= ask "Language(s):"
+  end
+
+end

data/lib/ricotta/configuration.rb

@@ -0,0 +1,26 @@
+require 'yaml'
+
+module Ricotta::Configuration
+    class Config
+    
+    def initialize(rcfile)
+      @config = Hash.new
+      parse(File.expand_path('~/.ricottarc'))
+      parse('.ricottarc')
+      parse(rcfile)
+    end
+    
+    def [](key)
+      return @config["#{key}"]
+    end
+    
+    private
+    
+    def parse(file)
+      if file and File.exist?(file)
+        YAML.load_file(file).each {|key, value| @config[key] = value }
+      end
+    end
+
+  end  
+end

data/lib/ricotta/fetcher.rb

@@ -0,0 +1,23 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module Ricotta::Fetcher
+    class Client
+      
+    def initialize(url)
+      @connection = Faraday.new(:url => url) do |builder|
+        builder.use FaradayMiddleware::FollowRedirects
+        builder.adapter :net_http
+      end
+    end
+    def fetch(project, branch, language, template, subset)
+      path = "/proj/#{project}/branch/#{branch}/lang/#{language}/templ/#{template}/"
+      path.concat("subset/#{subset}/") if subset
+      
+      @connection.get(path).on_complete do |env|
+        yield env[:status], env[:body] if block_given?
+      end
+    end
+  end
+end
+

data/ricotta.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ricotta"
+
+Gem::Specification.new do |s|
+  s.name        = "ricotta"
+  s.authors     = ["Erik Sundin"]
+  s.email       = "erik@eriksundin.se"
+  s.homepage    = "http://github.com/eriksundin/ricotta-gem"
+  s.version     = Ricotta::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = "Ricotta"
+  s.description = "Tool for downloading translations from Ricotta"
+
+  s.add_development_dependency "rspec", "~> 0.6.1"
+  s.add_development_dependency "rake",  "~> 0.9.2"
+
+  s.add_dependency "commander", "~> 4.1.2"
+  s.add_dependency "faraday", "~> 0.8.0"
+  s.add_dependency "faraday_middleware", "~> 0.9.0"
+
+  s.files         = Dir["./**/*"].reject { |file| file =~ /\.\/(bin|log|pkg|script|spec|test|vendor)/ }
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: ricotta
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Erik Sundin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.2
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: Tool for downloading translations from Ricotta
+email: erik@eriksundin.se
+executables:
+- ricotta
+extensions: []
+extra_rdoc_files: []
+files:
+- ./Gemfile
+- ./Gemfile.lock
+- ./lib/ricotta/commands/dump.rb
+- ./lib/ricotta/commands/xcode.rb
+- ./lib/ricotta/commands.rb
+- ./lib/ricotta/configuration.rb
+- ./lib/ricotta/fetcher.rb
+- ./lib/ricotta.rb
+- ./LICENSE
+- ./Rakefile
+- ./README.md
+- ./ricotta.gemspec
+- bin/ricotta
+homepage: http://github.com/eriksundin/ricotta-gem
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Ricotta
+test_files: []