realogy 0.5.9 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 702562782515233ac1a57e61324cf10b14f66eb2d94bf886453cc8cc14901aa0
-  data.tar.gz: 24c5a742636e90ba401f524eff9f222d90a5c6bdc8745b3ef799bd8ba2f9a367
+  metadata.gz: f02721407645903a2d9ac60db41b1d8cbf634ca114dda8a59d30adc2f965de8c
+  data.tar.gz: 71e9bdeccb476d4410210361cc296a3185c683f63601da6d01f9560b1e9e8c3c
 SHA512:
-  metadata.gz: 6d3bdf26acc313331628f242681dc63a0ae8ce3668adff8c1f1496a40d2519b28f376bf129a0b79f8d1a8e2ed44652e2c8a2c83d88aba10b7f71d35ed4afd8ca
-  data.tar.gz: 9879729daada8cdc0f75acb0d5367ae22769d417f40ea5660312cff6eec63bf4dde6a477aca62529adac3a1d193dcb55b2586c72ff639af58afbaa55114b39e5
+  metadata.gz: f761f642d02074648b93393a673e8174f1152b3f5b4227a073bcfbabbd9fef33edd806c65742becbd1f27a7dcd4a7a4e2e1847a2071afe51774b68a7b07de179
+  data.tar.gz: 5c0327820519b16c455ef8b6b4f7b8da293c4a4ac2b9558dbaca5f1feaf4217c9a60b104bca774d6434d45db67abdd47fceb8ef4372fc7cd25a165ce6ffac7ed

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    realogy (0.5.9)
+      activerecord (>= 5.0)
+      oauth2
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activerecord (7.0.2.3)
+      activemodel (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activesupport (7.0.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.5.0)
+    faraday (2.2.0)
+      faraday-net_http (~> 2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (2.0.1)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    jwt (2.3.0)
+    minitest (5.15.0)
+    multi_json (1.15.0)
+    multi_xml (0.6.0)
+    oauth2 (1.4.9)
+      faraday (>= 0.17.3, < 3.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    rack (2.2.3)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    ruby2_keywords (0.0.5)
+    sqlite3 (1.4.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  bundler (~> 2.3)
+  rake (>= 12.3.3)
+  realogy!
+  rspec (~> 3.0)
+  sqlite3
+
+BUNDLED WITH
+   2.3.7

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,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
@@ -81,13 +104,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 +124,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 +135,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 +171,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.5.9"
+  VERSION = "0.6.2"
 end

data/lib/realogy.rb

@@ -2,7 +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/search.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"

data/realogy.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "bundler", "~> 2.3"
   spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency 'sqlite3'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: realogy
 version: !ruby/object:Gem::Version
-  version: 0.5.9
+  version: 0.6.2
 platform: ruby
 authors:
 - Michael Edlund
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-03 00:00:00.000000000 Z
+date: 2022-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +107,7 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -119,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
@@ -134,7 +136,7 @@ homepage: https://github.com/arcticleo/realogy
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,8 +151,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Encapsulation of Realogy's DataSync API.
 test_files: []