realogy 0.6.1 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12d8e93945c23e56e01fbe630bec8fdbe5ce249bd3b005a86d4a6912d9784db4
-  data.tar.gz: 4d10e4f50b4966dc5c9ba7f3b520db7d521f9406799822bd80cf9f422c4589a5
+  metadata.gz: 8bd21ebae2bdd067d907b8be8b4205f91874e8074f83189bcb719d793e251672
+  data.tar.gz: a9afc5328a86797ec677fd28aaaf1d1932bc29cf65a84e906b956c9d7ac76897
 SHA512:
-  metadata.gz: bd20fd303e29928de9b4f087dca56ccaf4c42934bb17d1e71439bf343b02add61d9c449a0fa94b9bfe6fc959273006bb987cdcd7381dc7542134b844fef18a6b
-  data.tar.gz: ba898e4b69cd3db029e63db391117a337f10d66a2770a7ba932eb85885f44d8708c6c5dc2474688fef4cfed5123f388fa676675ed6ad67098ed5d6020074b94f
+  metadata.gz: fb23e4584877fb4a473f05ee86d68a7a325adde0a7941a43f643d18b94238522673188f0d2adb8f80b332b2eb02614d97503c0404d9239072ec4247eff9b90de
+  data.tar.gz: 79329f73bdcc2f6467b46246e105bad993ee24bc335d3bd64e0fdd2001cc8cedb309a2949ef26be20ad7badd6b024ff1c22f5f25c8136ff09f7695ca1c39bc7b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    realogy (0.5.9)
+    realogy (0.6.3)
       activerecord (>= 5.0)
       oauth2
 

data/README.md

@@ -128,9 +128,10 @@ config.active_job.queue_adapter = :delayed_job
 ```ruby
 realogy = Realogy::DataSync.client
 ```
-#### Retrieve array of objects
 
-The calls to retrieve entities are:
+#### Get active objects
+
+The calls to retrieve active entities are:
 
 ```ruby
 realogy.get_active_agents
@@ -140,20 +141,31 @@ 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:
+When no argument is submitted, all active entities are returned. 
+
+Filters can be applied for `brandCode` and `countryCode`. For example:
 
 ```ruby
 # Fetch all active agents, for all brands, in all countries:
-realogy.get_active_agents()
+realogy.get_active_agents
 
 # Fetch all active agents, for all brands, in Sweden:
-realogy.get_active_agents({countryCode: "SE"})
+realogy.get_active_companies(countryCode: "SE")
 
+# Allowed brandCode values: C21, CB, ERA, SIR, BHG, CBC, ZIP, CLB, & COR
 # Fetch all active Sotheby's agents in all countries:
-realogy.get_active_agents({brandCode: "SIR"})
+realogy.get_active_offices(brandCode: "SIR")
 
 # Fetch all active Sotheby's agents in Sweden:
-realogy.get_active_agents({brandCode: "SIR", countryCode: "SE"})
+realogy.get_active_teams(brandCode: "SIR", countryCode: "SE")
+```
+
+When fetching listings, the type of listing can also be specified:
+
+```ruby
+# Allowed type values: ForSale, ForRent, ForSaleCommercial, & ForLeaseCommercial
+# Fetch all active agents, for all brands, in all countries:
+realogy.get_active_listings(type: "ForSale")
 ```
 
 #### Retrieve delta of objects
@@ -170,16 +182,77 @@ 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:
+When no argument is passed, the delta returned is for the last 20 minutes. A custom minutes delta can be passed in:
+
+```ruby
+realogy.get_agents_delta(since: 20.minutes.ago)     # 20 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)
+```
+
+A few additional parameters are allowed:
+
+```ruby
+realogy.get_listings_delta(brandCode: "SIR")
+realogy.get_listings_delta(companyIds: "12345")
+realogy.get_listings_delta(companyIds: "12345, 23456, 34567")
+realogy.get_listings_delta(countryCode: "IT")
+realogy.get_listings_delta(limit: 10)
+realogy.get_listings_delta(type: "ForSale")
+```
+
+In case there are more entities available than is returned by the initial call, there will be a `nextLink` value present in the JSON response. By calling the `nextLink` URL as long as it is present, you will make retrieve all results. 
+
+If you want to automatically return all entities, pass in the flag `followNext: true` in your call:
+
+```ruby
+realogy.get_listings_delta( ... , followNext: true)
+```
+
+When passing in `followNext: true`, the returned result will be an array of entities rather than the JSON object returned if it is omitted.
+
+
+#### Get all listings
+
+To retrieve all listings, `fromDate` and `brandCode` are mandatory parameters. A minimum call to retrieve all listing entities could look like this:
+
+```ruby
+realogy.get_all_listings(brandCode: "COR", fromDate: 1.week.ago.to_query_string)
+```
+
+These are additional filters that can be applied:
+
+```ruby
+# fromDate and toDate must be converted to supported text format. This is done with to_query_string:
+realogy.get_all_listings(brandCode: "COR", fromDate: 1.week.ago.to_query_string, toDate: DateTime.now.to_query_string)
+
+# Allowed type values: ForSale, ForRent, ForSaleCommercial, & ForLeaseCommercial
+realogy.get_all_listings(brandCode: "C21", fromDate: 1.week.ago.to_query_string, type: "ForSale")
+
+# Allowed status values: Active, Available, Pending, & Closed
+realogy.get_all_listings(brandCode: "CB", fromDate: 1.week.ago.to_query_string, status: "Active")
+
+# Limit results to a particular country
+realogy.get_all_listings(brandCode: "SIR", fromDate: 1.week.ago.to_query_string, countryCode: "IT")
+
+# Limit number of listings per result batch. Allowed span: 10–1000.
+realogy.get_all_listings(brandCode: "BHG", fromDate: 1.week.ago.to_query_string, limit: 10)
+
+```
+
+In case there are more listings available than is returned by the `get_all_listings` call, there will be a `nextLink` value present in the JSON response. By calling the `nextLink` URL as long as it is present, you will traverse through all results. 
+
+If you want to automatically return all results, pass in the flag `followNext: true` in your call:
 
 ```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})
+realogy.get_all_listings( ... , followNext: true)
 ```
 
+When passing in `followNext: true`, the returned result will be an array of entities rather than the JSON object returned if it is omitted.
+
+
 #### Retrieve JSON object
 
 ```ruby

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

@@ -23,6 +23,10 @@ module Realogy
       get_active_teams: "teams/active"
     }
   
+    ALL_API_ENDPOINTS = {
+      get_all_listings: "listings/all"
+    }
+  
     DELTA_API_ENDPOINTS = {
       get_agents_delta: "agents/delta",
       get_companies_delta: "companies/delta",
@@ -47,25 +51,69 @@ module Realogy
         endpoint = ACTIVE_API_ENDPOINTS[method_name]
         params = {
           'brandCode': hash[:brandCode],
-          'countryCode': hash[:countryCode]
+          'countryCode': hash[:countryCode],
+          'type': hash[:type]
         }.compact
         return perform_api_call(endpoint, params)
       end
     end
 
+    ALL_API_ENDPOINTS.keys.each do |method_name|
+      define_method method_name do |*args|
+        hash = args.first.is_a?(::Hash) ? args.first : {}
+        endpoint = ALL_API_ENDPOINTS[method_name]
+        params = {
+          'brandCode': hash[:brandCode],
+          'countryCode': hash[:countryCode],
+          'cursor': hash[:cursor],
+          'fromDate': hash[:fromDate],
+          'limit': hash[:limit],
+          'status': hash[:status],
+          'toDate': hash[:toDate],
+          'type': hash[:type],
+          'followNext': hash[:followNext]
+        }.compact
+        if hash[:followNext]
+          entities = []
+          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
+        else
+          return perform_api_call(endpoint, params)
+        end
+      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]}
+        hash = args.first.is_a?(::Hash) ? args.first : {}
+        hash[:since] = JSON(20.minutes.ago.to_json) if hash[:since].blank?
         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"])
+        params = {
+          'since': JSON[hash[:since].to_json],
+          'brandCode': hash[:brandCode],
+          'companyIds': hash[:companyIds].to_s.split(',').map(&:strip),
+          'countryCode': hash[:countryCode],
+          'limit': hash[:limit],
+          'type': hash[:type],
+          'followNext': hash[:followNext]
+        }.compact
+        if hash[:followNext]
+          entities = []
+          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
+        else
+          return perform_api_call(endpoint, params)
         end
-        return entities.flatten
       end
     end
   
@@ -128,14 +176,18 @@ module Realogy
       return client.client_credentials.get_token(scope: scope)
     end
   
+    def oauth2_token_path
+      return File.join(Dir.tmpdir, [Rails.application.credentials.dig(:realogy, :client_id).parameterize, "-oauth-token.json"].join)
+    end
+  
     def oauth2_client_credentials_token(client_id, client_secret, token_url, scope)
-      @token = OAuth2::AccessToken.read_token_from_file(".oauth-access-token.json")
+      @token = OAuth2::AccessToken.read_token_from_file(oauth2_token_path)
       expiry = @token.try(:expires_at).present? ? DateTime.strptime(@token.expires_at.to_s, '%s') : 1.day.ago
       if expiry > DateTime.now.utc
         return @token.token
       else
         @token = oauth2_client_credentials_token_object(client_id, client_secret, token_url, scope)
-        @token.save_token_to_file(".oauth-access-token.json")
+        @token.save_token_to_file(oauth2_token_path)
         return @token.token
       end
     end

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

@@ -0,0 +1,11 @@
+DateTime.class_eval do
+  def to_query_string
+    self.to_json.split("\"").last
+  end  
+end
+
+ActiveSupport::TimeWithZone.class_eval do
+  def to_query_string
+    self.to_datetime.to_json.split("\"").last
+  end  
+end

data/lib/realogy/tasks/realogy.rake

@@ -108,31 +108,31 @@ namespace :realogy do
   
   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)
+    args.with_defaults(since_minutes: 20)
     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)
+    args.with_defaults(since_minutes: 20)
     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)
+    args.with_defaults(since_minutes: 20)
     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)
+    args.with_defaults(since_minutes: 20)
     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)
+    args.with_defaults(since_minutes: 20)
     perform_delta_update_for Realogy::Team, args[:since_minutes]
   end
 

data/lib/realogy/version.rb

@@ -1,3 +1,3 @@
 module Realogy
-  VERSION = "0.6.1"
+  VERSION = "0.6.4"
 end

data/lib/realogy.rb

@@ -2,6 +2,7 @@ require "realogy/version"
 require "realogy/railtie" if defined?(Rails)
 require "realogy/app/models/application_record.rb"
 require "realogy/app/models/data_sync.rb"
+require "realogy/app/models/date_time.rb"
 require "realogy/app/models/hash.rb"
 require "realogy/app/models/realogy/entity.rb"
 require "realogy/app/models/realogy/agent.rb"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: realogy
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.4
 platform: ruby
 authors:
 - Michael Edlund
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-14 00:00:00.000000000 Z
+date: 2022-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -120,6 +120,7 @@ files:
 - lib/realogy/app/jobs/populate_realogy_entity_job.rb
 - lib/realogy/app/models/application_record.rb
 - lib/realogy/app/models/data_sync.rb
+- lib/realogy/app/models/date_time.rb
 - lib/realogy/app/models/hash.rb
 - lib/realogy/app/models/realogy/agent.rb
 - lib/realogy/app/models/realogy/company.rb