realogy 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 158674314e0de0322caa8cfaea2a2dad52a45149
-  data.tar.gz: 4ee19dc86fcdb3ca33382f02e2ad7804ef6c025b
+SHA256:
+  metadata.gz: 027741bd06711d8a56533a97c36c400cb05e63971fbd208c44918bc65620899e
+  data.tar.gz: 8211d5c915eef8636890f90498e233b61717dec03f2ab14b8a1afcbf81153b54
 SHA512:
-  metadata.gz: acb855f47a001162b1fb682e6ae58520d7743554b84ce2d28d9aa652eb16cad5431884c6395d0e59d0339b9414f001c83638b2b782b7a2b8a9cbefdf1c60ea55
-  data.tar.gz: e16951a7df7497e26776d456e2bc44daddc2be4b7dcd7633b342cd8536579a20eee315d7dee11798cdbad0daae91af6df21ced83c19b397e19becc567bce98c1
+  metadata.gz: 321e8dfb8d03406ee0d3e21587c2a556bb72ded74b643e21c80238f016baef083419182da5b5108e36c237784f39e8a22b01ddf86ea3433aed560a7577598442
+  data.tar.gz: 8b31fd0668825b169f51a187b6506230842de9c0456a416d71bcaf572834121c74120edfe39bd0bae6b4228d3a42b234f54ad1e0068373036dac7a63ca9c7a2e

data/README.md

@@ -71,14 +71,35 @@ Catch-all that runs all other syncing tasks:
 rails realogy:sync_active_entities       # Sync all active entities
 ```
 
-#### Delete Expired Entities
+#### Syncing Entities Delta
+
+There are a number of rake tasks for syncing entities within a delta span of time. Tasks default to last 15 minutes if not otherwise specified. These tasks will both update new/updated entities, as well as delete expired ones. 
+
+```
+rails realogy:sync_agents_delta         # Sync agents delta for last 15 minutes 
+rails realogy:sync_agents_delta[10]     # Sync agents delta for last 10 minutes
+
+rails realogy:sync_companies_delta      # Sync companies delta for last 15 minutes
+rails realogy:sync_companies_delta[10]  # Sync companies delta for last 10 minutes
+
+rails realogy:sync_listings_delta       # Sync listings delta for last 15 minutes
+rails realogy:sync_listings_delta[10]   # Sync listings delta for last 10 minutes
+
+rails realogy:sync_offices_delta        # Sync offices delta for last 15 minutes
+rails realogy:sync_offices_delta[10]    # Sync offices delta for last 10 minutes
+
+rails realogy:sync_teams_delta          # Sync teams delta for last 15 minutes
+rails realogy:sync_teams_delta[10]      # Sync teams delta for last 10 minutes
+```
+
+#### Delete All Expired Entities
 
 ```
-rails realogy:delete_expired_agents         # Delete Expired Agents
-rails realogy:delete_expired_companies      # Delete Expired Companies
-rails realogy:delete_expired_listings       # Delete Expired Listings
-rails realogy:delete_expired_offices        # Delete Expired Offices
-rails realogy:delete_expired_teams          # Delete Expired Teams
+rails realogy:delete_expired_agents         # Delete All Expired Agents
+rails realogy:delete_expired_companies      # Delete All Expired Companies
+rails realogy:delete_expired_listings       # Delete All Expired Listings
+rails realogy:delete_expired_offices        # Delete All Expired Offices
+rails realogy:delete_expired_teams          # Delete All Expired Teams
 ```
 
 Catch-all that runs all other deletion tasks:
@@ -111,11 +132,11 @@ realogy = Realogy::DataSync.client
 The calls to retrieve entities are:
 
 ```ruby
-realogy.get_active_agents()
-realogy.get_active_companies()
-realogy.get_active_listings()
-realogy.get_active_offices()
-realogy.get_active_teams()
+realogy.get_active_agents
+realogy.get_active_companies
+realogy.get_active_listings
+realogy.get_active_offices
+realogy.get_active_teams
 ```
 
 When no argument is submitted, all entities are returned. Filters can be applied for `brandCode` or `countryCode` though, provided as keys in a hash. For example:
@@ -136,7 +157,27 @@ realogy.get_active_agents({brandCode: "SIR", countryCode: "SE"})
 
 #### Retrieve delta of objects
 
-TODO
+The calls to retrieve entities that have recently changed are:
+
+```ruby
+realogy.get_agents_delta
+realogy.get_companies_delta
+realogy.get_listings_delta
+realogy.get_offices_delta
+realogy.get_teams_delta
+```
+
+Each hash in the returned arrays includes a key `action` that returns either `Delete` or `Upsert` to indicate if the object has been deleted or created/updated.
+
+When no argument is passed, the delta returned is for the last 15 minutes. A custom minutes delta can be passed in:
+
+```ruby
+realogy.get_agents_delta({since: 15.minutes.ago})     # 15 minutes is the default
+realogy.get_companies_delta({since: 1.hour.ago})
+realogy.get_listings_delta({since: 2.hours.ago})
+realogy.get_offices_delta({since: 5.minutes.ago})
+realogy.get_teams_delta({since: 1.day.ago})
+```
 
 #### Retrieve JSON object
 

data/lib/realogy/app/models/data_sync.rb

@@ -23,11 +23,11 @@ module Realogy
     }
   
     DELTA_API_ENDPOINTS = {
-      get_agent_delta: "agents/delta",
-      get_company_delta: "companies/delta",
-      get_listing_delta: "listings/delta",
-      get_office_delta: "offices/delta",
-      get_team_delta: "teams/delta"
+      get_agents_delta: "agents/delta",
+      get_companies_delta: "companies/delta",
+      get_listings_delta: "listings/delta",
+      get_offices_delta: "offices/delta",
+      get_teams_delta: "teams/delta"
     }
   
     DETAILS_API_ENDPOINTS = {
@@ -51,6 +51,22 @@ module Realogy
         return perform_api_call(endpoint, params)
       end
     end
+
+    DELTA_API_ENDPOINTS.keys.each do |method_name|
+      define_method method_name do |*args|
+        entities = []
+        hash = args.first.is_a?(Hash) ? args.first : {since: 15.minutes.ago}
+        params = {'since': JSON[hash[:since].to_json]}
+        endpoint = DELTA_API_ENDPOINTS[method_name]
+        response = perform_api_call(endpoint, params)
+        entities << response["data"]
+        while response["nextLink"].present?
+          response = perform_simple_call(response["nextLink"])
+          entities << response["data"]
+        end
+        return entities.flatten
+      end
+    end
   
     DETAILS_API_ENDPOINTS.keys.each do |method_name|
       define_method method_name do |id|
@@ -67,6 +83,17 @@ module Realogy
       return URI([ENV["REALOGY_API_BASE_URL"], endpoint].join("/"))
     end
   
+    def perform_simple_call(url)
+      uri = URI(url)
+      request = Net::HTTP::Get.new(uri)
+      request['Ocp-Apim-Subscription-Key'] = ENV["REALOGY_SUBSCRIPTION_KEY"]
+      request['Authorization'] = "Bearer #{auth_token}"
+      response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+        http.request(request)
+      end
+      return JSON(response.body)
+    end
+  
     def perform_api_call(endpoint, params)
       query = params.present? ? URI.encode_www_form(params) : ""
       uri = uri_for_endpoint(endpoint)

data/lib/realogy/app/models/realogy/entity.rb

@@ -10,7 +10,7 @@ class Realogy::Entity < ApplicationRecord
   end
 
   def self.triage hash
-    @object = self.find_or_initialize_by(entity_id: hash["entityId"])
+    @object = self.find_or_initialize_by(entity_id: [hash["entityId"], hash["id"]].compact.first)
     @object.last_update_on = hash["lastUpdateOn"]
     @object.populate if @object.needs_updating?
   end

data/lib/realogy/tasks/realogy.rake

@@ -59,7 +59,7 @@ namespace :realogy do
     call = ["get_active_", plural].join.to_sym
     existing = klass.select(:entity_id).pluck(:entity_id)
     current = Realogy::DataSync.client.__send__(call).map{|e| e["entityId"]}
-    klass.where(entity_id: (existing - current)).delete_all
+    klass.where(entity_id: (existing - current)).destroy_all
   end
 
   desc "Delete all expired entities"
@@ -92,5 +92,49 @@ namespace :realogy do
     delete_expired_entities_of_type Realogy::Team
   end
 
+  def perform_delta_update_for klass, since
+    return unless %w(agents companies listings offices teams).include?(plural = klass.to_s.tableize.split("/").last)
+    call = "get_#{plural}_delta".to_sym
+    Realogy::DataSync.client.send(call, {since: since.to_i.minutes.ago}).each do |hash|
+      case hash["action"]
+      when "Delete"
+        klass.find_by(entity_id: hash["id"]).try(:destroy)
+      when "Upsert"
+        hash["class"] = klass.to_s
+        active_job_configured? ? PopulateRealogyEntityJob.perform_later(hash) : klass::triage(hash)
+      end
+    end
+  end
+  
+  desc "Delta update for Agents. Optionally provide delta in minutes."
+  task :sync_agents_delta, [:since_minutes] => [:environment] do |t, args|
+    args.with_defaults(since_minutes: 15)
+    perform_delta_update_for Realogy::Agent, args[:since_minutes]
+  end
+
+  desc "Delta update for Companies. Optionally provide delta in minutes."
+  task :sync_companies_delta, [:since_minutes] => [:environment] do |t, args|
+    args.with_defaults(since_minutes: 15)
+    perform_delta_update_for Realogy::Company, args[:since_minutes]
+  end
+
+  desc "Delta update for Listings. Optionally provide delta in minutes."
+  task :sync_listings_delta, [:since_minutes] => [:environment] do |t, args|
+    args.with_defaults(since_minutes: 15)
+    perform_delta_update_for Realogy::Listing, args[:since_minutes]
+  end
+
+  desc "Delta update for Offices. Optionally provide delta in minutes."
+  task :sync_offices_delta, [:since_minutes] => [:environment] do |t, args|
+    args.with_defaults(since_minutes: 15)
+    perform_delta_update_for Realogy::Office, args[:since_minutes]
+  end
+
+  desc "Delta update for Teams. Optionally provide delta in minutes."
+  task :sync_teams_delta, [:since_minutes] => [:environment] do |t, args|
+    args.with_defaults(since_minutes: 15)
+    perform_delta_update_for Realogy::Team, args[:since_minutes]
+  end
+
 
 end

data/lib/realogy/version.rb

@@ -1,3 +1,3 @@
 module Realogy
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: realogy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Michael Edlund
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-20 00:00:00.000000000 Z
+date: 2018-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,6 +126,7 @@ files:
 - lib/realogy/railtie.rb
 - lib/realogy/tasks/realogy.rake
 - lib/realogy/version.rb
+- realogy-0.1.0.gem
 - realogy.gemspec
 homepage: https://github.com/arcticleo/realogy
 licenses:
@@ -147,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Encapsulation of Realogy's DataSync API.