realogy 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12d8e93945c23e56e01fbe630bec8fdbe5ce249bd3b005a86d4a6912d9784db4
-  data.tar.gz: 4d10e4f50b4966dc5c9ba7f3b520db7d521f9406799822bd80cf9f422c4589a5
+  metadata.gz: f02721407645903a2d9ac60db41b1d8cbf634ca114dda8a59d30adc2f965de8c
+  data.tar.gz: 71e9bdeccb476d4410210361cc296a3185c683f63601da6d01f9560b1e9e8c3c
 SHA512:
-  metadata.gz: bd20fd303e29928de9b4f087dca56ccaf4c42934bb17d1e71439bf343b02add61d9c449a0fa94b9bfe6fc959273006bb987cdcd7381dc7542134b844fef18a6b
-  data.tar.gz: ba898e4b69cd3db029e63db391117a337f10d66a2770a7ba932eb85885f44d8708c6c5dc2474688fef4cfed5123f388fa676675ed6ad67098ed5d6020074b94f
+  metadata.gz: f761f642d02074648b93393a673e8174f1152b3f5b4227a073bcfbabbd9fef33edd806c65742becbd1f27a7dcd4a7a4e2e1847a2071afe51774b68a7b07de179
+  data.tar.gz: 5c0327820519b16c455ef8b6b4f7b8da293c4a4ac2b9558dbaca5f1feaf4217c9a60b104bca774d6434d45db67abdd47fceb8ef4372fc7cd25a165ce6ffac7ed

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
@@ -180,6 +192,35 @@ realogy.get_offices_delta({since: 5.minutes.ago})
 realogy.get_teams_delta({since: 1.day.ago})
 ```
 
+#### 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)
+
+```
+
+
 #### 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,7 +51,26 @@ 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]
         }.compact
         return perform_api_call(endpoint, params)
       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/version.rb

@@ -1,3 +1,3 @@
 module Realogy
-  VERSION = "0.6.1"
+  VERSION = "0.6.2"
 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.2
 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