Merge pull request #473 from roomorama/release/0.12.11

Release/0.12.11

CHANGELOG.md

@@ -4,6 +4,12 @@ This file summarises the most important changes that went live on each release
 of Concierge. Please check the Wiki entry on the release process to understand
 how this file is formatted and how the process works.
 
+## [0.12.11] - 2016-10-21
+### Added
+- Atleisure, Ciirus, Poplidays, Kigo, Waytostay, RentalsUnited: add error.data reporting to Rollbar
+- Translations for title, description, t&c, check_in_instructions and
+description_append on Roomorama::Property
+
 ## [0.12.10] - 2016-10-19
 ### Fixed
 - Poplidays: metadata sync is safe for `nil` availabilities response

apps/api/controllers/kigo/image.rb

@@ -63,6 +63,7 @@ def announce_error(result)
         operation:   'image',
         supplier:    Kigo::Legacy::SUPPLIER_NAME,
         code:        result.error.code,
+        description: result.error.data,
         context:     Concierge.context.to_h,
         happened_at: Time.now
       })

apps/workers/comparison/property.rb

@@ -45,6 +45,7 @@ def extract_diff
       diff = Roomorama::Diff.new(original.identifier)
 
       extract_metadata_diff(original, new, diff)
+      Workers::Comparison::Translations.new(original.translations, new.translations).apply_to(diff)
       compare_images(original.images, new.images, diff)
 
       if original.multi_unit?

apps/workers/comparison/translations.rb

@@ -0,0 +1,48 @@
+module Workers::Comparison
+
+  # +Workers::Comparison::Translations+
+  #
+  # This class performs a comparison between two hash of translations.
+  #
+  # Usage:
+  #   original = old_roomorama_property.translations
+  #   new = new_roomorama_property.translations
+  #
+  #   diff = Roomorama::Diff.new(old_roomorama_property.identifier)
+  #
+  #   Workers::Comparison::Translations.(original, new).apply_to(diff)
+  #
+  class Translations
+
+    attr_reader :original, :new
+
+    def initialize(original, new)
+      @original = original || {}
+      @new      = new || {}
+    end
+
+    def apply_to(diff)
+      Roomorama::Translated::TRANSLATED_LOCALES.each do |locale|
+        new_t = new[locale] || {}
+        old_t = original[locale] || {}
+        next if new_t.empty? && old_t.empty?
+        translation = diff.public_send(locale)
+
+        added = new_t.keys - old_t.keys
+        added.each do |attr|
+          translation[attr] = new_t[attr]
+        end
+
+        removed = old_t.keys - new_t.keys
+        removed.each do |attr|
+          translation.erase(attr)
+        end
+
+        common = old_t.keys & new_t.keys
+        common.each do |attr|
+          translation[attr] = new_t[attr] if new_t[attr] != old_t[attr]
+        end
+      end
+    end
+  end
+end

apps/workers/suppliers/atleisure/availabilities.rb

@@ -45,7 +45,7 @@ def availability_error(availability)
           message = "Error during fetching availabilities for property `#{property_id}`: `#{error_message}`"
           augment_context_error(message)
 
-          Result.error(:availability_error)
+          Result.error(:availability_error, message)
         end
 
         def valid_availability?(availability)
@@ -85,6 +85,7 @@ def announce_error(message, result)
             operation:   'sync',
             supplier:    ::AtLeisure::Client::SUPPLIER_NAME,
             code:        result.error.code,
+            description: result.error.data,
             context:     Concierge.context.to_h,
             happened_at: Time.now
           })

apps/workers/suppliers/atleisure/metadata.rb

@@ -93,6 +93,7 @@ def announce_error(message, result)
         operation:   'sync',
         supplier:    AtLeisure::Client::SUPPLIER_NAME,
         code:        result.error.code,
+        description: result.error.data,
         context:     Concierge.context.to_h,
         happened_at: Time.now
       })

apps/workers/suppliers/ciirus/metadata.rb

@@ -201,6 +201,7 @@ def announce_error(message, result)
         operation:   'sync',
         supplier:    Ciirus::Client::SUPPLIER_NAME,
         code:        result.error.code,
+        description: result.error.data,
         context:     Concierge.context.to_h,
         happened_at: Time.now
       })

apps/workers/suppliers/kigo/availabilities.rb

@@ -72,6 +72,7 @@ def announce_error(message, result)
         operation:   'sync',
         supplier:    supplier.name,
         code:        result.error.code,
+        description: result.error.data,
         context:     Concierge.context.to_h,
         happened_at: Time.now
       })
@@ -88,4 +89,4 @@ def initial_args_result
 
 Concierge::Announcer.on("availabilities.Kigo") do |supplier, args|
   Workers::Suppliers::Kigo::Availabilities.new(supplier, args).perform
-end
+end

apps/workers/suppliers/kigo/legacy/availabilities.rb

@@ -74,6 +74,7 @@ def announce_error(message, result)
         operation:   'sync',
         supplier:    supplier.name,
         code:        result.error.code,
+        description: result.error.data,
         context:     Concierge.context.to_h,
         happened_at: Time.now
       })
@@ -90,4 +91,4 @@ def initial_args_result
 
 Concierge::Announcer.on("availabilities.KigoLegacy") do |supplier, args|
   Workers::Suppliers::Kigo::Legacy::Availabilities.new(supplier, args).perform
-end
+end

apps/workers/suppliers/kigo/legacy/metadata.rb

@@ -128,6 +128,7 @@ def announce_error(message, result)
         operation:   'sync',
         supplier:    supplier_name,
         code:        result.error.code,
+        description: result.error.data,
         context:     Concierge.context.to_h,
         happened_at: Time.now
       })

apps/workers/suppliers/kigo/metadata.rb

@@ -113,6 +113,7 @@ def announce_error(message, result)
         operation:   'sync',
         supplier:    supplier_name,
         code:        result.error.code,
+        description: result.error.data,
         context:     Concierge.context.to_h,
         happened_at: Time.now
       })

apps/workers/suppliers/poplidays/availabilities.rb

@@ -93,6 +93,7 @@ def announce_error(message, result)
         operation:   'sync',
         supplier:    Poplidays::Client::SUPPLIER_NAME,
         code:        result.error.code,
+        description: result.error.data,
         context:     Concierge.context.to_h,
         happened_at: Time.now
       })
@@ -104,4 +105,4 @@ def announce_error(message, result)
 Concierge::Announcer.on('availabilities.Poplidays') do |host, args|
   Workers::Suppliers::Poplidays::Availabilities.new(host).perform
   Result.new({})
-end
+end

apps/workers/suppliers/poplidays/metadata.rb

@@ -135,4 +135,4 @@ def announce_error(message, result)
 Concierge::Announcer.on('metadata.Poplidays') do |host, args|
   Workers::Suppliers::Poplidays::Metadata.new(host).perform
   Result.new({})
-end
+end

apps/workers/suppliers/rentals_united/metadata.rb

@@ -49,15 +49,15 @@ def perform
 
         unless location
           message = "Failed to find location with id `#{location_id}`"
-          announce_context_error(message, Result.error(:location_not_found))
+          announce_context_error(message, Result.error(:location_not_found, message))
           next
         end
 
         location.currency = currencies[location.id]
 
         unless location.currency
           message = "Failed to find currency for location with id `#{location_id}`"
-          announce_context_error(message, Result.error(:currency_not_found))
+          announce_context_error(message, Result.error(:currency_not_found, message))
           next
         end
 
@@ -239,6 +239,7 @@ def announce_context_error(message, result)
         operation:   'sync',
         supplier:    RentalsUnited::Client::SUPPLIER_NAME,
         code:        result.error.code,
+        description: result.error.data,
         context:     Concierge.context.to_h,
         happened_at: Time.now
       })

apps/workers/suppliers/waytostay.rb

@@ -84,6 +84,7 @@ def announce_error(result)
         operation:   "sync",
         supplier:    ::Waytostay::Client::SUPPLIER_NAME,
         code:        result.error.code,
+        description: result.error.data,
         context:     Concierge.context.to_h,
         happened_at: Time.now
       })

lib/concierge/roomorama/diff.rb

@@ -1,6 +1,7 @@
 require_relative "mappers"
 require_relative "property"
 require_relative "unit"
+require_relative "translated"
 
 module Roomorama
 
@@ -17,6 +18,7 @@ def initialize(message)
 
     attr_accessor *Roomorama::Property::ATTRIBUTES
 
+    include Roomorama::Translated
     include Roomorama::Mappers
 
     ChangeSet = Struct.new(:created, :updated, :deleted)
@@ -106,6 +108,8 @@ def to_h
         subtype:                        subtype,
         title:                          title,
         description:                    description,
+        description_append:             description_append,
+        translations:                   translations,
         address:                        address,
         apartment_number:               apartment_number,
         postal_code:                    postal_code,

lib/concierge/roomorama/property.rb

@@ -1,3 +1,4 @@
+require_relative "translated"
 module Roomorama
 
   # +Roomorama::Property+
@@ -23,6 +24,7 @@ module Roomorama
   #   property.add_image(image)
   class Property
     include Roomorama::Mappers
+    include Roomorama::Translated
 
     # +Roomorama::Property::ValidationError+
     #
@@ -57,6 +59,12 @@ def self.load(attributes)
         instance.add_unit(Roomorama::Unit.load(data))
       end
 
+      attributes[:translations].to_h.each do |locale, translation|
+        translation.each do |key, value|
+          instance.send(locale)[key] = value
+        end
+      end
+
       instance.validate!
       Result.new(instance)
     rescue Roomorama::Error => err
@@ -82,7 +90,7 @@ def self.load(attributes)
       :services_cleaning_required, :services_airport_pickup, :services_car_rental,
       :services_car_rental_rate, :services_airport_pickup_rate, :services_concierge,
       :services_concierge_rate, :disabled, :instant_booking, :owner_name,
-      :owner_email, :owner_phone_number, :owner_city]
+      :owner_email, :owner_phone_number, :owner_city, :description_append]
 
     attr_accessor *ATTRIBUTES
 
@@ -175,6 +183,8 @@ def to_h
         subtype:                        subtype,
         title:                          title,
         description:                    description,
+        description_append:             description_append,
+        translations:                   translations,
         address:                        address,
         apartment_number:               apartment_number,
         postal_code:                    postal_code,

lib/concierge/roomorama/translated.rb

@@ -0,0 +1,74 @@
+# This module adds some translated fields to the class that includes it.
+# The default locale (:en) should be accessed directly on the base class.
+#
+# Usage
+#
+#   class Property
+#     attr_accessor :title, :description, :terms_and_conditions
+#     include Roomorama::Translated
+#   end
+#
+#   p = Property.new
+#   p.title = "Default title in english"
+#   p.es.title = "Translated title in spanish"
+#
+module Roomorama::Translated
+  TRANSLATED_LOCALES = %i(es de zh zh_tw)
+
+  class Translation
+    TRANSLATED_FIELDS = [:title,
+                         :description,
+                         :terms_and_conditions,
+                         :check_in_instructions,
+                         :description_append]
+
+    attr_accessor *TRANSLATED_FIELDS
+
+    def initialize
+      @erased = []
+    end
+
+    def erase(key)
+      @erased << key
+    end
+
+    def []=(attr, value)
+      attr = attr.to_sym
+      if TRANSLATED_FIELDS.include?(attr)
+        setter = [attr, "="].join
+        public_send(setter, value)
+      end
+    end
+
+    def to_h
+      {
+        title:                 title,
+        description:           description,
+        terms_and_conditions:  terms_and_conditions,
+        check_in_instructions: check_in_instructions,
+        description_append:    description_append,
+      }.tap do |hash|
+        hash.delete_if { |k, v| v.nil? && !@erased.include?(k) }
+      end
+    end
+  end
+
+  def self.included(base)
+
+    def es; @es ||= Translation.new() end
+    def de; @de ||= Translation.new() end
+    def zh; @zh ||= Translation.new() end
+    def zh_tw; @zh_tw ||= Translation.new() end
+
+    def translations
+      hash = {}
+      TRANSLATED_LOCALES.collect do |locale|
+        locale_hash = self.send(locale).to_h
+        hash[locale] = locale_hash unless locale_hash.empty?
+      end
+
+      hash.empty? ? nil : hash
+    end
+  end
+
+end

lib/concierge/roomorama/unit.rb

@@ -1,3 +1,4 @@
+require_relative "translated"
 module Roomorama
 
   # +Roomorama::Unit+
@@ -16,6 +17,7 @@ module Roomorama
   #   unit.add_image(image)
   class Unit
     include Roomorama::Mappers
+    include Roomorama::Translated
 
     # +Roomorama::Unit::ValidationError+
     #
@@ -105,6 +107,7 @@ def to_h
         identifier:            identifier,
         title:                 title,
         description:           description,
+        translations:          translations,
         nightly_rate:          nightly_rate,
         weekly_rate:           weekly_rate,
         monthly_rate:          monthly_rate,