Feature/audit supplier

.env.example

@@ -1,5 +1,6 @@
 CONCIERGE_DATABASE_URL="postgres://localhost/concierge_development"
 WAYTOSTAY_URL="https://apis.sandbox.waytostay.com:25443"
+ROOMORAMA_SECRET_AUDIT=xxx
 ROOMORAMA_SECRET_JTB=xxx
 ROOMORAMA_SECRET_KIGO_LEGACY=xxx
 ROOMORAMA_SECRET_KIGO=xxx

apps/api/config/environment_variables.yml

@@ -1,3 +1,4 @@
+- ROOMORAMA_SECRET_AUDIT
 - ROOMORAMA_SECRET_JTB
 - ROOMORAMA_SECRET_KIGO_LEGACY
 - ROOMORAMA_SECRET_KIGO

apps/api/config/initializers/validate_supplier_credentials.rb

@@ -2,6 +2,7 @@
 
 if enforce_on_envs.include?(Hanami.env)
   Concierge::Credentials.validate_credentials!({
+    audit:      %w(secret_key host),
     atleisure:  %w(username password test_mode),
     jtb:        %w(id user password company url),
     kigo:       %w(subscription_key),

apps/api/config/routes.rb

@@ -4,6 +4,7 @@
 post '/kigo/legacy/quote', to: 'kigo/legacy#quote'
 post '/poplidays/quote',   to: 'poplidays#quote'
 post '/waytostay/quote',   to: 'waytostay#quote'
+post '/audit/quote',       to: 'audit#quote'
 post '/ciirus/quote',      to: 'ciirus#quote'
 
 post '/jtb/booking',         to: 'j_t_b#booking'
@@ -12,8 +13,10 @@
 post '/ciirus/booking',      to: 'ciirus#booking'
 post '/kigo/booking',        to: 'kigo#booking'
 post '/kigo/legacy/booking', to: 'kigo/legacy#booking'
+post '/audit/booking',       to: 'audit#booking'
 
 post 'waytostay/cancel', to: 'waytostay#cancel'
+post '/audit/cancel',    to: 'audit#cancel'
 post 'ciirus/cancel',    to: 'ciirus#cancel'
 
 post 'checkout', to: 'static#checkout'

apps/api/controllers/audit/booking.rb

@@ -0,0 +1,20 @@
+require_relative "../booking"
+
+module API::Controllers::Audit
+
+  # API::Controllers::Audit::Booking
+  #
+  # Performs create booking for properties from Audit.
+  class Booking
+    include API::Controllers::Booking
+
+    def create_booking(params)
+      Audit::Client.new.book(params)
+    end
+
+    def supplier_name
+      Audit::Client::SUPPLIER_NAME
+    end
+  end
+end
+

apps/api/controllers/audit/cancel.rb

@@ -0,0 +1,19 @@
+require_relative "../cancel"
+
+module API::Controllers::Audit
+
+  # API::Controllers::Audit::Cancel
+  #
+  # Cancels reservation from Audit.
+  class Cancel
+    include API::Controllers::Cancel
+
+    def cancel_reservation(params)
+      Audit::Client.new.cancel(params)
+    end
+
+    def supplier_name
+      Audit::Client::SUPPLIER_NAME
+    end
+  end
+end

apps/api/controllers/audit/quote.rb

@@ -0,0 +1,20 @@
+require_relative "../quote"
+
+module API::Controllers::Audit
+
+  # API::Controllers::Audit::Quote
+  #
+  # Performs booking quotations for properties from Audit.
+  class Quote
+    include API::Controllers::Quote
+
+    def quote_price(params)
+      Audit::Client.new.quote(params)
+    end
+
+    def supplier_name
+      Audit::Client::SUPPLIER_NAME
+    end
+  end
+end
+

apps/api/middlewares/authentication.rb

@@ -46,6 +46,7 @@ class Authentication
       #   secrets.for(request_path) # => X32842I
       class Secrets
         APP_SECRETS = {
+          "/audit"       => ENV["ROOMORAMA_SECRET_AUDIT"],
           "/jtb"         => ENV["ROOMORAMA_SECRET_JTB"],
           "/kigo/legacy" => ENV["ROOMORAMA_SECRET_KIGO_LEGACY"],
           "/kigo"        => ENV["ROOMORAMA_SECRET_KIGO"],

apps/workers/suppliers/audit.rb

@@ -0,0 +1,68 @@
+module Workers::Suppliers
+
+  class Audit
+    SUPPLIER_NAME = "Audit"
+    attr_reader :property_sync, :calendar_sync, :host
+
+    def initialize(host)
+      @host = host
+      @property_sync = Workers::PropertySynchronisation.new(host)
+      @calendar_sync = Workers::CalendarSynchronisation.new(host)
+    end
+
+    def perform
+      result = importer.fetch_properties
+      if result.success?
+        result.value.each do |json|
+          property_sync.start(json['identifier']) do
+            importer.json_to_property(json) do |calendar_entries|
+              calendar_sync.start(json['identifier']) do
+                calendar = Roomorama::Calendar.new(json['identifier'])
+                calendar_entries.each {|entry| calendar.add entry }
+                Result.new(calendar)
+              end
+            end
+          end
+        end
+
+        property_sync.finish!
+        calendar_sync.finish!
+      else
+        message = "Failed to perform the `#fetch_properties` operation"
+        announce_error(message, result)
+      end
+    end
+
+    private
+
+    def importer
+      @properties ||= ::Audit::Importer.new(credentials)
+    end
+
+    def credentials
+      @credentials ||= Concierge::Credentials.for(SUPPLIER_NAME)
+    end
+
+    def announce_error(message, result)
+      message = {
+        label: 'Synchronisation Failure',
+        message: message,
+        backtrace: caller
+      }
+      context = Concierge::Context::Message.new(message)
+      Concierge.context.augment(context)
+
+      Concierge::Announcer.trigger(Concierge::Errors::EXTERNAL_ERROR, {
+        operation:   'sync',
+        supplier:    SUPPLIER_NAME,
+        code:        result.error.code,
+        context:     Concierge.context.to_h,
+        happened_at: Time.now
+      })
+    end
+  end
+end
+
+Concierge::Announcer.on("sync.#{Workers::Suppliers::Audit::SUPPLIER_NAME}") do |host|
+  Workers::Suppliers::Audit.new(host).perform
+end

config/credentials/production.yml

@@ -29,6 +29,11 @@ waytostay:
   client_id:     <%= ENV["WAYTOSTAY_CLIENT_ID"] %>
   client_secret: <%= ENV["WAYTOSTAY_CLIENT_SECRET"] %>
 
+audit:
+  secret_key: test_secret
+  host: http://localhost:9292
+  fetch_properties_endpoint: /spec/fixtures/audit/properties.json
+
 ciirus:
   url:      <%= ENV["CIIRUS_URL"] %>
   username: <%= ENV["CIIRUS_USERNAME"] %>

config/credentials/staging.yml

@@ -29,6 +29,11 @@ waytostay:
   client_id:     <%= ENV["WAYTOSTAY_CLIENT_ID"] %>
   client_secret: <%= ENV["WAYTOSTAY_CLIENT_SECRET"] %>
 
+audit:
+  secret_key: test_secret
+  host: http://localhost:9292
+  fetch_properties_endpoint: /spec/fixtures/audit/properties.json
+
 ciirus:
   url:      <%= ENV["CIIRUS_URL"] %>
   username: <%= ENV["CIIRUS_USERNAME"] %>

config/credentials/test.yml

@@ -35,6 +35,11 @@ waytostay:
   client_id:     test_id
   client_secret: test_secret
 
+audit:
+  secret_key: <%= ENV.fetch('AUDIT_SECRET_KEY', 'test_secret') %>
+  host: http://localhost:9292
+  fetch_properties_endpoint: /spec/fixtures/audit/properties.json
+
 ciirus:
   url:      "http://www.example.org"
   username: "roomorama-user"

config/suppliers.yml

@@ -21,9 +21,16 @@ WayToStay:
     availabilities:
       absence: "WayToStay calendar is synchronised with property metadata, due to the diff-like API provided."
 
+Audit:
+  workers:
+    metadata:
+      every: "1h"
+    availabilities:
+      every: "1h"
+
 Ciirus:
   workers:
     metadata:
       every: "1d"
     availabilities:
-      every: "5h"
+      every: "5h"

lib/concierge/suppliers/audit/client.rb

@@ -0,0 +1,70 @@
+module Audit
+  # +Audit::Client+
+  #
+  # This class is a convenience class for interacting with Audit.
+  #
+  # For more information on how to interact with Audit, check the project Wiki.
+  class Client
+
+    SUPPLIER_NAME = "Audit"
+
+    attr_reader :credentials
+
+    def initialize
+      @credentials = Concierge::Credentials.for("audit")
+    end
+
+    # On success, return Result wrapping Quotation object
+    # - When property_id is `success`, a successful response is returned
+    # - When property_id is `connection_timeout`, Faraday::TimeoutError should be raised by HTTP::Client
+    def quote(params)
+      client = Concierge::HTTPClient.new(credentials.host)
+      result = client.get("/spec/fixtures/audit/quotation.#{params[:property_id]}.json")
+      if result.success?
+        json = JSON.parse(result.value.body)
+        Result.new(Quotation.new(json['result']))
+      else
+        result
+      end
+    end
+
+    # On success, return Result wrapping Reservation object
+    # - When property_id is `success`, a successful response is returned
+    # - When property_id is `connection_timeout`, Faraday::TimeoutError should be raised by HTTP::Client
+    def book(params)
+      client = Concierge::HTTPClient.new(credentials.host)
+      result = client.get("/spec/fixtures/audit/booking.#{params[:property_id]}.json")
+      if result.success?
+        json = JSON.parse(result.value.body)
+        Result.new(Reservation.new(json['result']))
+      else
+        result
+      end
+    end
+
+    # On success, return Result wrapping reference_number String
+    # - When reference_number is `success`, a successful response is returned
+    # - When reference_number is `connection_timeout`, Faraday::TimeoutError should be raised by HTTP::Client
+    def cancel(params)
+      client = Concierge::HTTPClient.new(credentials.host)
+      result = client.get("/spec/fixtures/audit/cancel.#{params[:reference_number]}.json")
+      if result.success?
+        json = JSON.parse(result.value.body)
+        Result.new(json['result'])
+      else
+        result
+      end
+    end
+
+    def announce_error(operation, result)
+      Concierge::Announcer.trigger(Concierge::Errors::EXTERNAL_ERROR, {
+        operation:   operation,
+        supplier:    SUPPLIER_NAME,
+        code:        result.error.code,
+        context:     Concierge.context.to_h,
+        happened_at: Time.now
+      })
+    end
+
+  end
+end

lib/concierge/suppliers/audit/importer.rb

@@ -0,0 +1,68 @@
+module Audit
+  # +Audit::Importer+
+  #
+  # This class wraps supplier API and provides data for building properties.
+  #
+  # Usage
+  #
+  #   importer = Audit::Importer.new(credentials)
+  #   importer.fetch_properties
+  #
+  #   => #<Result:0x007ff5fc624dd8 @result=[{'HouseCode' => 'XX-12345-67', ...}, ...]
+  class Importer
+    attr_reader :credentials
+
+    def initialize(credentials)
+      @credentials = credentials
+    end
+
+    # retrieves the list of properties
+    def fetch_properties
+      client = Concierge::HTTPClient.new(credentials.host)
+      result = client.get(credentials.fetch_properties_endpoint)
+      if result.success?
+        json = JSON.parse(result.value.body)
+        Result.new(json['result'])
+      else
+        result
+      end
+    end
+
+    def json_to_property(json)
+      # `Roomorama::Property.load` prefer absolute urls, but our fixture `url` values are relative
+      # make it happy
+      fix_relative_urls!(URI.join(credentials.host, credentials.fetch_properties_endpoint), json)
+
+      Roomorama::Property.load(Concierge::SafeAccessHash.new json).tap do |property_result|
+        if property_result.success?
+          property = property_result.value
+          calendar_entries = json['availability_dates'].collect do |yyyymmdd, boolean|
+            Roomorama::Calendar::Entry.new(
+              date:             yyyymmdd,
+              available:        boolean,
+              nightly_rate:     property.nightly_rate,
+            )
+          end
+          yield calendar_entries
+        end
+      end
+    end
+
+    private
+
+    def fix_relative_urls!(base_uri, object)
+      case object
+      when Hash
+        object.each do |key, value|
+          if key == 'url'
+            object[key] = URI.join(base_uri, URI.escape(value)).to_s
+          elsif value.kind_of?(Hash) || value.kind_of?(Array)
+            fix_relative_urls!(base_uri, value)
+          end
+        end
+      when Array
+        object.each {|item| fix_relative_urls!(base_uri, item) }
+      end
+    end
+  end
+end