realogy 0.6.2 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f02721407645903a2d9ac60db41b1d8cbf634ca114dda8a59d30adc2f965de8c
-  data.tar.gz: 71e9bdeccb476d4410210361cc296a3185c683f63601da6d01f9560b1e9e8c3c
+  metadata.gz: a80f7fefc94aa78eeb2a8fcfc83807471d1b0b289dc3d8e6a42c1816f04aa0a0
+  data.tar.gz: fba2b29565b785c2bfd72e3365e87a5268e60026bedb583edd5669272f791de3
 SHA512:
-  metadata.gz: f761f642d02074648b93393a673e8174f1152b3f5b4227a073bcfbabbd9fef33edd806c65742becbd1f27a7dcd4a7a4e2e1847a2071afe51774b68a7b07de179
-  data.tar.gz: 5c0327820519b16c455ef8b6b4f7b8da293c4a4ac2b9558dbaca5f1feaf4217c9a60b104bca774d6434d45db67abdd47fceb8ef4372fc7cd25a165ce6ffac7ed
+  metadata.gz: b60f7e64694ccb74122bb9d1dc37cc9c7aafb2cd0cb967a708d884897709e92b80b1a605d8473904b081f4440c1f722043084960e375b797c74adedfbbc5fe30
+  data.tar.gz: 5a910405bee433c9330053d2487ccc92053aea27d3f746ffd638068bf2a2acb5ed5281855e56ed1267ce81306cac9dc5cd4ad0c68afa9a10d25860071cd6e802

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

@@ -182,44 +182,76 @@ 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: 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_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)
+realogy.get_all_listings(brandCode: "COR", fromDate: 1.week.ago.json_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)
+# fromDate and toDate must be converted to supported text format. This is done with json_string:
+realogy.get_all_listings(brandCode: "COR", fromDate: 1.week.ago.json_string, toDate: DateTime.now.json_string)
 
 # Allowed type values: ForSale, ForRent, ForSaleCommercial, & ForLeaseCommercial
-realogy.get_all_listings(brandCode: "C21", fromDate: 1.week.ago.to_query_string, type: "ForSale")
+realogy.get_all_listings(brandCode: "C21", fromDate: 1.week.ago.json_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")
+realogy.get_all_listings(brandCode: "CB", fromDate: 1.week.ago.json_string, status: "Active")
 
 # Limit results to a particular country
-realogy.get_all_listings(brandCode: "SIR", fromDate: 1.week.ago.to_query_string, countryCode: "IT")
+realogy.get_all_listings(brandCode: "SIR", fromDate: 1.week.ago.json_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)
+realogy.get_all_listings(brandCode: "BHG", fromDate: 1.week.ago.json_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_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
 

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

@@ -70,25 +70,50 @@ module Realogy
           'limit': hash[:limit],
           'status': hash[:status],
           'toDate': hash[:toDate],
-          'type': hash[:type]
+          'type': hash[:type],
+          'followNext': hash[:followNext]
         }.compact
-        return perform_api_call(endpoint, params)
+        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
   
@@ -151,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

@@ -1,11 +1,11 @@
 DateTime.class_eval do
-  def to_query_string
+  def json_string
     self.to_json.split("\"").last
   end  
 end
 
 ActiveSupport::TimeWithZone.class_eval do
-  def to_query_string
+  def json_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.2"
+  VERSION = "0.6.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: realogy
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.5
 platform: ruby
 authors:
 - Michael Edlund