realogy 0.6.0 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd7ef6df4687d14ecd5f52c86533588c914184f0a9c3d68c78432d2ea5946aca
-  data.tar.gz: 5a4ad93bc7453b08427c0de9bce3231809915e6ba2e9d557e62bd5861b3fc266
+  metadata.gz: aab45e699e4b2c1f6ba3fef7e61a61b8b2f7fcc139ed4ff1da6aba33ce59111f
+  data.tar.gz: 9e71798f4f6b24b7ce0b6e1dd30ebf786a85c339a4469aa4b0e9e47caf774bd7
 SHA512:
-  metadata.gz: f43e3d9c6bb73e924a74d0788d116b81caee67a42d924a20c7f9f54217fd00b5934486bf618a8b2fb6f1733099881093c302945678ff0a9f034227dc65081372
-  data.tar.gz: 7020419b4f767b7ad66cb5a4de2c2624db5f2fd8909d98431032b30da2db3f5f93fe4521c820eb35d2f37d3c1f42b5387bf1a34cd3a9fb06be5cd31611c04e4c
+  metadata.gz: 5ad2a9d30633e053bd1349ce784f8fee960e1ae1dcf69d99d76d129f21827484709793dcf0a3c9608023157e5cdfbcfaa4ec32f8caecc1fc73a9e81348ff9e77
+  data.tar.gz: 3786088a323b5d662d61adcc410ee6c42fbd955e1022e1e3a52dfdc3ccd026cebaf3807b2c00e94cf47a61d7a8c414112e18e1c403743f5c61d198722b5a4ba5

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

@@ -31,15 +31,16 @@ Set up for usage by creating Realogy's migration and running it.
     rails g realogy:install
     rails db:migrate
 
-Realogy is expecting these ENV variables to be present to be able to function:
+Realogy is expecting these encrypted credentials to be present to be able to function:
 
 ```
-REALOGY_CLIENT_ID
-REALOGY_CLIENT_SECRET
-REALOGY_TOKEN_URL
-REALOGY_SCOPE
-REALOGY_SUBSCRIPTION_KEY
-REALOGY_API_BASE_URL
+realogy:
+  client_id: 
+  client_secret: 
+  token_url: 
+  scope: 
+  subscription_key: 
+  api_base_url: 
 ```
 
 ### Available Rake Tasks
@@ -127,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
@@ -139,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
@@ -179,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

@@ -4,13 +4,13 @@ module Realogy
     require 'net/http'
     require 'oauth2'
     require 'json'
-    
+
     @@instance = Realogy::DataSync.new
 
     def self.client
       return @@instance
     end
-
+    
     private_class_method :new
 
     # API endpoints by type
@@ -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,12 +51,43 @@ 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 = []
@@ -81,13 +116,13 @@ module Realogy
     # Utility
 
     def uri_for_endpoint endpoint
-      return URI([ENV["REALOGY_API_BASE_URL"], endpoint].join("/"))
+      return URI([Rails.application.credentials.dig(: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['Ocp-Apim-Subscription-Key'] = Rails.application.credentials.dig(:realogy, :subscription_key)
       request['Authorization'] = "Bearer #{auth_token}"
       response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
         http.max_retries = 10
@@ -101,7 +136,7 @@ module Realogy
       uri = uri_for_endpoint(endpoint)
       uri.query && uri.query.length > 0 ? uri.query += '&' + query : uri.query = query
       request = Net::HTTP::Get.new(uri.request_uri)
-      request['Ocp-Apim-Subscription-Key'] = ENV["REALOGY_SUBSCRIPTION_KEY"]
+      request['Ocp-Apim-Subscription-Key'] = Rails.application.credentials.dig(:realogy, :subscription_key)
       request['Authorization'] = "Bearer #{auth_token}"
       response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
         http.max_retries = 10
@@ -112,10 +147,10 @@ module Realogy
   
     def auth_token
       oauth2_client_credentials_token(
-        ENV["REALOGY_CLIENT_ID"],
-        ENV["REALOGY_CLIENT_SECRET"],
-        ENV["REALOGY_TOKEN_URL"],
-        ENV["REALOGY_SCOPE"]
+        Rails.application.credentials.dig(:realogy, :client_id),
+        Rails.application.credentials.dig(:realogy, :client_secret),
+        Rails.application.credentials.dig(:realogy, :token_url),
+        Rails.application.credentials.dig(:realogy, :scope)
       )
     end
   
@@ -148,9 +183,9 @@ OAuth2::AccessToken.class_eval do
     data = nil
     token = nil
     client = OAuth2::Client.new(
-      ENV["REALOGY_CLIENT_ID"],
-      ENV["REALOGY_CLIENT_SECRET"],
-      token_url:  ENV["REALOGY_TOKEN_URL"]
+      Rails.application.credentials.dig(:realogy, :client_id),
+      Rails.application.credentials.dig(:realogy, :client_secret),
+      token_url:  Rails.application.credentials.dig(:realogy, :token_url)
     )
     if File.exists?(path)
       File.open(path) do |f|

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.0"
+  VERSION = "0.6.3"
 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.0
+  version: 0.6.3
 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