trip_advisor 0.0.15

data/lib/trip_advisor/rake_tasks.rb

@@ -0,0 +1,182 @@
+require 'rake'
+require 'rake/tasklib'
+
+module TripAdvisor
+  class TestDevice
+    attr_accessor :platform, :name, :valid_schemes
+
+    def initialize
+      @platform = 'iOS Simulator'
+      @name = 'iPhone 5s'
+      @valid_schemes = []
+    end
+
+    def destination_arg(os_version)
+      "platform='#{platform}',OS=#{os_version},name='#{name}'"
+    end
+
+    def valid_for?(scheme_name)
+      valid_schemes.empty? || valid_schemes.include?(scheme_name)
+    end
+
+    def sdk
+      platform.eql?('iOS Simulator') ? 'iphonesimulator' : 'iphoneos'
+    end
+
+    def short_name
+      "#{name.downcase.gsub(/\s+/, '')}"
+    end
+
+    def to_s
+      "#{name} (#{platform})"
+    end
+
+    def hash
+      [platform, name].hash
+    end
+
+    def eql?(object)
+      platform.eql?(object.platform) && name.eql?(object.name)
+    end
+  end
+
+  class TestReport
+    include Singleton
+    
+    def initialize
+      @namespaces = {}
+      @success = true
+    end
+    
+    def add_result(namespace, ios_version, test_device, success)
+      @namespaces[namespace] ||= {}
+      @namespaces[namespace][ios_version] ||= {}
+      @namespaces[namespace][ios_version][test_device] = success
+      @success = false unless success
+    end
+    
+    def [](ios_version)
+      @namespaces[ios_version]
+    end
+    
+    def success?
+      @success
+    end
+    
+    def failure?
+      @success == false
+    end
+    
+    def report
+      @namespaces.each do |namespace, version_status|
+        version_status.each do |ios_version, device_status|
+          device_status.each do |test_device, success|
+            puts "\033[0;31m!! #{namespace} tests failed on #{test_device} under iOS #{ios_version}" unless success
+          end
+        end
+      end
+      puts "\033[0;32m** All tests executed successfully" if success?
+    end
+  end
+  
+  class TestTasks < Rake::TaskLib
+    include ::Rake::DSL if defined?(::Rake::DSL)
+    
+    attr_reader :namespace_name, :prepare_dependency
+    attr_accessor :workspace, :schemes_dir, :schemes, :ios_versions
+    attr_accessor :runner, :xctool_path, :xcodebuild_path, :environment_variables
+    attr_accessor :ios_versions, :test_devices, :settings
+    
+    def initialize(namespace_name = :test)
+      @namespace_name = namespace_name.is_a?(Hash) ? namespace_name.keys.first : namespace_name
+      @prepare_dependency = namespace_name.is_a?(Hash) ? namespace_name.values.first : nil
+      @schemes_dir = 'Tests/Schemes'
+      @ios_versions = %w{7.0 8.0}
+      @xctool_path = '/usr/local/bin/xctool'
+      @xcodebuild_path = 'xcodebuild'
+      @runner = :xctool
+      @settings = {}
+      @environment_variables = ''
+      
+      yield self if block_given?
+      raise "A workspace must be configured" unless workspace
+      raise "At least one scheme must be configured" unless schemes
+      raise "At least one test device must be configured" unless test_devices
+      define_tasks
+    end
+    
+    def runner=(runner)
+      raise ArgumentError, "Must be :xctool or :xcodebuild" unless %w{xctool xcodebuild}.include?(runner.to_s)
+      @runner = runner.to_sym
+    end
+    
+    def define_tasks
+      namespace self.namespace_name do
+        task (prepare_dependency ? { prepare: prepare_dependency} : :prepare ) do
+          run(%Q{mkdir -p "#{workspace}/xcshareddata/xcschemes" && cp Tests/Schemes/*.xcscheme "#{workspace}/xcshareddata/xcschemes/"})
+        end
+        
+        # Iterate across the schemes and define a task for each version of iOS and an aggregate task
+        schemes.each do |scheme_namespace, scheme_names|
+          scheme_names_array = scheme_names.is_a?(Array) ? scheme_names : [scheme_names]
+          namespace scheme_namespace do
+            scheme_names_array.each do |scheme_name|
+              ios_versions.each do |ios_version|
+                namespace ios_version do
+                  test_devices.each do |test_device|
+                    next unless test_device.valid_for?(scheme_name)
+                    desc "Run #{scheme_namespace} tests against #{ios_version} SDK on #{test_device}"
+                    task test_device.short_name => :prepare do
+                      test_scheme(scheme_name, namespace: scheme_namespace, ios_version: ios_version, test_device: test_device)
+                    end
+                  end
+                end
+                desc "Run #{scheme_namespace} tests against #{ios_version} SDK on valid devices"
+                task "#{ios_version}" => test_devices.select { |test_device| test_device.valid_for?(scheme_name) }.map { |test_device| "#{scheme_namespace}:#{ios_version}:#{test_device.short_name}" }
+              end
+            end
+          end
+
+          desc "Run #{scheme_namespace} tests against all SDKs and valid devices"
+          task scheme_namespace => ios_versions.map { |ios_version| "#{scheme_namespace}:#{ios_version}" }
+        end
+      end
+      
+      desc "Run the #{schemes.keys.join(', ')} tests on all devices and SDKs"
+      task namespace_name => schemes.keys.map { |scheme| "#{namespace_name}:#{scheme}" } do
+        TripAdvisor::TestReport.instance.report
+      end
+    end
+    
+  private
+    def run(command)
+      puts "Executing `#{command}`"
+      system(command)
+    end
+    
+    def test_scheme(scheme, options)
+      system(%q{killall "iPhone Simulator"})
+      namespace = options[:namespace]
+      ios_version = options[:ios_version]
+      test_device = options[:test_device]
+      test_sdk = "#{ios_version}"      
+
+      settings_arg = settings.map { |k,v| "#{k}=#{v}"}.join(' ')
+      destination_arg = test_device.destination_arg(ios_version)
+      success = if xctool?
+        run("#{xctool_path} -workspace #{workspace} -scheme #{scheme} -sdk #{test_device.sdk} test -freshSimulator -destination #{destination_arg} #{settings_arg} #{environment_variables} DEVICE_NAME=#{test_device.short_name}_#{ios_version} -reporter junit:#{scheme}-#{test_sdk}-#{test_device.short_name}.xml")
+      elsif xcodebuild?
+        run("#{xcodebuild_path} -workspace #{workspace} -scheme #{scheme} -sdk #{test_device.sdk} test -destination #{destination_arg} #{settings_arg} #{environment_variables} DEVICE_NAME=#{test_device.short_name}_#{ios_version} | xcpretty -cr html --output build/reports/#{scheme}-#{test_sdk}-#{test_device.short_name}.html ; exit ${PIPESTATUS[0]}")
+      end
+      TripAdvisor::TestReport.instance.add_result(namespace, ios_version, test_device, success)
+    end
+    
+    def xctool?
+      runner == :xctool
+    end
+
+    def xcodebuild?
+      runner == :xcodebuild
+    end
+  end
+end

data/lib/trip_advisor/resource_manager.rb

@@ -0,0 +1,101 @@
+module TripAdvisor
+  class ResourceManager
+    attr_accessor :api_client, :output_dir
+  
+    def initialize(options={})
+      options.each { |k,v| self.send("#{k}=", v) }
+    end
+  
+    def locales
+      @locales ||= api_client.get_flights_locales
+    end
+  
+    def dump_airports
+      provision_locale_projects
+      puts "Dumping Airport fixtures for #{locales.size} locales..."
+      locales.each do |locale|
+        locale_identifier = locale['locale']
+        begin
+          json = api_client.get(:airports, locale: locale_identifier)
+        rescue RestClient::Exception => ex
+           puts "ERROR: Failed Fetching Airports fixture for '#{locale_identifier}' locale_identifier: #{ex}"
+           next
+        end
+        language_code = TripAdvisor::Translation.locale_identifier_to_language_codes_mapping[locale_identifier] || locale_identifier
+        path = File.join(output_dir, "#{language_code}.lproj", "airports.json")
+        File.open(path, 'w') { |f| f << json }
+        puts "  Wrote Airports fixture for '#{locale_identifier}' locale to #{path}"
+      end            
+    end
+  
+    def dump_airlines
+      provision_locale_projects
+      puts "Dumping Airline fixtures for #{locales.size} locales..."
+      locales.each do |locale|
+        locale_identifier = locale['locale']
+        begin
+          json = api_client.get(:airlines, locale: locale_identifier)
+        rescue RestClient::Exception => ex
+           puts "ERROR: Failed Fetching Airlines fixture for '#{locale_identifier}' locale_identifier: #{ex}"
+           next
+        end
+        language_code = TripAdvisor::Translation.locale_identifier_to_language_codes_mapping[locale_identifier] || locale_identifier
+        path = File.join(output_dir, "#{language_code}.lproj", "airlines.json")
+        File.open(path, 'w') { |f| f << json }
+        puts "  Wrote Airlines fixture for '#{locale_identifier}' locale to #{path}"
+      end
+    end
+  
+    def dump_purchase_link_providers
+      provision_locale_projects
+      puts "Dumping Purchase Link Provider fixtures for #{locales.size} locales..."
+      locales.each do |locale|
+        locale_identifier = locale['locale']
+        begin
+          json = api_client.get(:flight_purchase_link_providers, locale: locale_identifier)
+        rescue RestClient::Exception => ex
+           puts "ERROR: Failed Fetching Purchase Link Provider fixture for '#{locale_identifier}' locale_identifier: #{ex}"
+           next
+        end
+        language_code = TripAdvisor::Translation.locale_identifier_to_language_codes_mapping[locale_identifier] || locale_identifier
+        path = File.join(output_dir, "#{language_code}.lproj", "flight_purchase_link_providers.json")
+        File.open(path, 'w') { |f| f << json }
+        puts "  Wrote Purchase Link Provider fixture for '#{locale_identifier}' locale to #{path}"
+      end
+    end
+
+    def language_tags_from_locales_api
+      locales.map { |l| l['locale'] }
+    end
+
+    def provision_locale_projects(language_tags = self.language_tags_from_locales_api)
+      FileUtils.mkdir(output_dir) unless File.exists?(output_dir)
+      language_tags.inject([]) do |paths, language_tag|
+        language_tag = TripAdvisor::Translation.locale_identifier_to_language_codes_mapping[language_tag] || language_tag
+        path = File.join(output_dir, "#{language_tag}.lproj")
+        unless File.exist?(path)
+          FileUtils.mkdir(path)
+          paths << path
+          yield path if block_given?
+        end      
+        paths
+      end
+    end
+    
+    def provision_localized_android_resources(language_tags = self.language_tags_from_locales_api)
+      FileUtils.mkdir(output_dir) unless File.exists?(output_dir)
+      language_tags.inject([]) do |paths, language_tag|
+        language_tag = TripAdvisor::Translation.locale_identifier_to_language_codes_mapping[language_tag] || language_tag
+        language_tag.gsub!(/-/,'_')
+        language_tag.gsub!(/_/,'-r')
+        path = File.join(output_dir, "values-#{language_tag}")
+        unless File.exist?(path)
+          FileUtils.mkdir(path)
+          paths << path
+          yield path if block_given?
+        end      
+        paths
+      end
+    end
+  end
+end

data/lib/trip_advisor/strings_file.rb

@@ -0,0 +1,112 @@
+require 'twine'
+require 'twine/stringsfile'
+
+module TripAdvisor
+  class StringsFile
+    attr_reader :path, :translations
+    
+    def self.read(path)
+      self.new.tap { |sf| sf.read(path) }
+    end
+    
+    def merge_translations(translations)
+      translations.each do |translation|
+        if twine_row = twine_row_for_key(translation['en'].to_s)
+          update_twine_row_with_translation(twine_row, translation)
+        else
+          add_twine_row_for_translation(translation)
+        end
+      end
+    end
+    
+    def merge_translations_android(translations)
+      translations.each do |translation|
+        if twine_row = twine_row_for_key(translation.key)
+          update_twine_row_with_translation(twine_row, translation)
+        else
+          add_twine_row_for_translation_android(translation)
+        end
+      end
+    end
+    
+    def loaded?
+      @twine_strings_file != nil
+    end
+    
+    def [](key)
+      raise "Cannot access translations without reading a Strings file" unless loaded?
+      translations.detect { |translation| translation.key == key.to_s }
+    end
+        
+    def read(path)
+      @path = path
+      @twine_strings_file = Twine::StringsFile.new
+      @twine_strings_file.read(path)
+      load_translations_from_twine
+    end
+    
+    def write(path = self.path)
+      @twine_strings_file.write(path)
+    end
+    
+    def language_tags
+      @twine_strings_file.language_codes
+    end
+
+    private
+    def load_translations_from_twine
+      @translations = @twine_strings_file.sections.collect do |section|
+        section.rows.map do |row|
+          Translation.new(key: row.key, note: row.comment).tap do |translation|
+            translation.localizations = row.translations.map do |locale_identifier, string|
+              Translation::Localization.new(locale_identifier: locale_identifier, string: string)
+            end
+          end
+        end
+      end.flatten
+    end
+    
+    # NOTE: For Android, the Twine files are keyed by Translation Tool key, _not_ English translation.
+    # NOTE: The Twine files are keyed by English translation, _not_ Translation Tool key
+    def twine_row_for_key(key)
+      @twine_strings_file.sections.each do |section|        
+        if row = section.rows.detect { |row| row.key == key }
+          return row
+        end
+      end
+      nil
+    end
+    
+    def update_twine_row_with_translation(twine_row, translation)
+      twine_row.comment = translation.note
+      translation.localizations.each do |localization|        
+        @twine_strings_file.add_language_code(localization.locale_identifier)
+        twine_row.translations[localization.locale_identifier] = localization.string
+      end
+    end
+    
+    def add_twine_row_for_translation(translation)
+      # We merge new rows into the first section
+      section = @twine_strings_file.sections.first
+      english_string = translation['en']
+      raise "Cannot add Translation: No English ('en') localization available" unless english_string
+      row = Twine::StringsRow.new(english_string).tap do |row|
+        row.tags = ["key:#{translation.key}"]
+        update_twine_row_with_translation(row, translation)
+      end
+      section.rows << row
+    end
+        
+    def add_twine_row_for_translation_android(translation)
+      # We merge new rows into the first section
+      section = @twine_strings_file.sections.first
+      translation_tool_key = translation.key
+      raise "Cannot add Translation: No translation tool key." unless translation_tool_key
+      row = Twine::StringsRow.new(translation_tool_key).tap do |row|
+        row.tags = ["key:#{translation.key}"]
+        update_twine_row_with_translation(row, translation)
+      end
+      section.rows << row
+    end
+  end
+end

data/lib/trip_advisor/translation.rb

@@ -0,0 +1,63 @@
+module TripAdvisor
+  class Translation
+    # Returns a dictionary that specifies how locale identifiers map to BCP 47 Language Identifiers
+    def self.locale_identifier_to_language_codes_mapping
+      {  "zh_TW" => "zh-Hant", "zh_CN"=> "zh-Hans", "zh_CN"=> "zh",
+         "no"=> "nb", "in"=> "id", "en_UK"=> "en-GB" }
+    end
+    
+    # Supports keyed lookup by locale identifier
+    class LocalizationsArray < Array
+      def [](locale_identifier)
+        if locale_identifier.is_a?(String)
+          self.detect { |localization| localization.locale_identifier == locale_identifier.to_s }
+        else
+          super
+        end
+      end
+    end
+  
+    class Localization
+      attr_accessor :locale_identifier, :language_name, :string, :status
+  
+      def initialize(attributes = {})
+        attributes.each { |k, v| self.send("#{k}=", v) }
+      end
+      
+      def locale_identifier=(locale_identifier)
+        @locale_identifier = (Translation.locale_identifier_to_language_codes_mapping[locale_identifier] || locale_identifier)
+      end
+      
+      def string=(string)
+        @string = string.strip
+      end
+  
+      def to_s
+        string
+      end
+    
+      def active?
+        status == 'Active'
+      end
+    end
+  
+    attr_accessor :id, :key, :note, :localizations
+  
+    def initialize(attributes = {})
+      @localizations = LocalizationsArray.new
+      attributes.each { |k, v| self.send("#{k}=", v) }
+    end
+    
+    def key=(key)
+      @key = key.strip
+    end
+  
+    def localizations=(localizations)      
+      @localizations.concat(localizations)
+    end
+    
+    def [](locale_identifier)
+      localizations[locale_identifier]
+    end
+  end
+end

data/lib/trip_advisor/translation_tool.rb

@@ -0,0 +1,110 @@
+require 'trip_advisor/translation'
+require 'rest-client'
+require 'nokogiri'
+require "active_support/core_ext"
+
+module TripAdvisor
+  class TranslationTool
+    module Scraper
+      class << self
+        def translations_from_doc(doc)
+          Array.new.tap do |translations|
+            doc.each { |translation| translations << Translation.new(id: translation["id"], key: translation["key"], note: translation["note"]) }
+          end
+        end
+    
+        def localizations_from_doc(doc)
+          Array.new.tap do |localizations|
+            doc.each { |localization| 
+              locale_string = localization["lang"]["locale"]
+              localized_string = localization["displayedValue"]
+              status = localization["isTranslatedValue"]
+              language_name = localization["lang"]["localizedDisplayName"]
+              locale_identifier = localization["lang"]["locale"]
+              localizations << Translation::Localization.new(locale_identifier: locale_identifier, language_name: language_name, string: localized_string, status: status, )
+            }
+          end
+        end
+      end
+    end
+    
+    class ResultsPaginator
+      attr_reader :base_url, :offset, :total, :per_page, :params, :translations
+      
+      def initialize(base_url, attributes = {})
+        @base_url = base_url
+        @total = 0
+        @per_page = 50
+        @offset = attributes[:offset] || 0        
+        @params = attributes[:params]
+      end      
+      
+      def load(options = {})
+        @offset = options[:offset] if options[:offset]
+        @offset = ((options[:page] - 1) * per_page) if options[:page]
+        raise ArgumentError, "Cannot load a negative offset" if @offset < 0
+        raise ArgumentError, "Cannot load an offset greater than the total number of objects" if total && @offset > total
+        response = RestClient.post(base_url, params.to_json, :content_type => :json, :accept => :json)
+        doc = JSON.parse(response)
+        @total = doc.count
+        @per_page = doc.count
+        @translations = Scraper.translations_from_doc(doc)
+      end
+      
+      def page_count
+        (total / per_page.to_f).ceil
+      end
+      
+      def loaded?
+        @translations
+      end
+      
+      def paginate
+        load unless loaded?        
+        1.upto(page_count).collect do |page_number|
+          load(page: page_number).tap do |translations|
+            yield page_number, translations if block_given?
+          end
+        end.flatten
+      end
+      
+      alias_method :all, :paginate
+      
+      def current_page_index
+        offset / per_page
+      end
+      
+      def next_page
+        load(page: current_page_index + 1)
+      end
+      
+      def previous_page
+        load(page: current_page_index - 1)
+      end
+    end
+    
+    attr_accessor :username, :password, :locale
+    
+    def initialize(attributes = {})
+      attributes.each { |k, v| self.send("#{k}=", v) }
+      @locale ||= 'en'
+    end
+    
+    def search(query, &block)      
+      ResultsPaginator.new("https://#{username}:#{password}@localization.tripadvisor.com/translations/search/keys", params: { lang: locale, keyName: query }).tap do |paginator|
+        if block_given?
+          paginator.paginate(&block)
+        else
+          paginator.load
+        end
+      end
+    end
+    
+    def get_translation(translation)
+      translation = Translation.new(id: translation) if translation.is_a?(Integer)
+      response = RestClient.get("https://#{username}:#{password}@localization.tripadvisor.com/translations/keys/id/#{translation.id}/translations")
+      translation.localizations = Scraper.localizations_from_doc(JSON.parse(response))
+      translation
+    end
+  end
+end

data/lib/trip_advisor/version.rb

@@ -0,0 +1,3 @@
+module TripAdvisor
+  VERSION = "0.0.15"
+end

data/lib/trip_advisor.rb

@@ -0,0 +1,5 @@
+require "trip_advisor/version"
+require "trip_advisor/api"
+require "trip_advisor/resource_manager"
+require 'trip_advisor/translation_tool'
+require 'trip_advisor/strings_file'

data/run_tests.sh

@@ -0,0 +1,6 @@
+export LC_CTYPE="en_US.UTF-8"
+echo "Building and Running Tests..."
+echo "Installing Gem dependencies via Bundler..."
+unset RUBYOPT
+DISABLE_BINSTUBS=1 bundle install --deployment --binstubs
+bundle exec rake spec

data/spec/api_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'trip_advisor/api'
+
+describe TripAdvisor::API do
+  describe '.get_locales' do
+    before(:each) do
+      @api = TripAdvisor::API.new(api_key: 'adf6d1b8-0aca-4b0c-a492-50530aadd7aa')
+      WebMock.allow_net_connect!
+    end
+
+    after(:each) do
+      WebMock.disable_net_connect!
+    end
+
+    it "load all locales from the API" do
+      @api.get_locales.count.should == 46
+    end
+  end
+
+  describe '.get_flights_locales' do
+    before(:each) do
+      @api = TripAdvisor::API.new(api_key: 'adf6d1b8-0aca-4b0c-a492-50530aadd7aa')
+      WebMock.allow_net_connect!
+    end
+
+    after(:each) do
+      WebMock.disable_net_connect!
+    end
+
+    it "load all flights_enabled locales from the API" do
+      @api.get_flights_locales.count.should == 39
+    end
+  end
+end