reso_transport 1.5.5 → 1.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e936cab60989d16c28cef1265638fee97c6d10e94b9d2814de93f69f237c5ffd
-  data.tar.gz: 0e597dea0da08a2aada6b54cc4a5243e8352b442538d78d584555bb1be05dfcb
+  metadata.gz: 49293478c0827ccb4bdca1bb6c9974900f8c0c16853b247487120a0ed3bb79df
+  data.tar.gz: c9d8c93979377ed18d22a179bae44175961b44e8641eb091930f99542d1e610f
 SHA512:
-  metadata.gz: a4d69fc29b8dde541d9665e80ab60973df81b1f794dbee2e9fffe1877b3fbff3fec62ebe2ff69899c4cc7d4287e7e5f4570d02f66338d8c84d8a4341f0a9aed1
-  data.tar.gz: ad04f1a60eeecf6731d619be5c16830fd6887d8783f10cbaa44c29a70e6c28491dae55bf49ce29d0f415c6e58b458d73e7bc7161f99767c7e4b402c7f74077d8
+  metadata.gz: 4464fe0a9aa0006f25c5eab29dab8422401ac2ebf435b712e65d5727e43606bb0df4fdf895e5a1d6a1e3e44d4937d19c42389577d28568351832ccae64d55ebb
+  data.tar.gz: 729d643455ddd8e7a827ddc6aea2a8512f93bc65a3e469993da5d2cd5085ecdc5eed4befee4f376cd9986f51a81d363fdeb042a1f8f51e2e51d7230f265c2d7a

data/.gitignore

@@ -13,5 +13,7 @@
 /log/**
 /test/vcr_cassettes/**
 md_cache/**
+ds_cache/**
 .byebug_history
 secrets.yml
+/.history/

data/.gitpod.yml

@@ -0,0 +1,2 @@
+tasks:
+  - init: bundle install

data/.rubocop.yml

@@ -0,0 +1,33 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Layout/FirstHashElementIndentation:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+    - test/**/*
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/ModuleLength:
+  Max: 150
+
+Style/ColonMethodCall:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/README.md

@@ -1,3 +1,6 @@
+[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/wrstudios/reso_transport)
+[![Gem Version](https://badge.fury.io/rb/reso_transport.svg)](https://badge.fury.io/rb/reso_transport)
+
 # ResoTransport
 
 A Ruby gem for connecting to and interacting with RESO WebAPI services.  Learn more about what that is by checking out the [RESO WebAPI](https://www.reso.org/reso-web-api/) Documentation.
@@ -51,7 +54,7 @@ Or you can set a logger for each specific instance of a client which can be usef
 
 ### Getting Connected
 
-There are 2 strategies for authentication. 
+There are 2 strategies for authentication.
 
 **Bearer Token**
 
@@ -60,7 +63,8 @@ It's simple to use a static access token if your token never expires:
 ```ruby
   @client = ResoTransport::Client.new({
     md_file: METADATA_CACHE,
-    endpoint: ENDPOINT_URL
+    endpoint: ENDPOINT_URL,
+    use_replication_endpoint: false # this is the default and can be ommitted
     authentication: {
       access_token: TOKEN,
       token_type: "Bearer" # this is the default and can be ommitted
@@ -89,7 +93,8 @@ If the connection requires requesting a new token periodically, it's easy to pro
 
 This will pre-fetch a token from the provided endpoint when the current token is either non-existent or has expired.
 
-
+The `use_replication_endpoint` flag will append `/replication` to all resource queries if set to `true`. This is required
+by some data sources to query resources beyond 10,000 records.
 
 ### Caching Metadata
 
@@ -108,9 +113,9 @@ If you don't have access to the file system, like on Heroku, or you just don't w
 
 ```ruby
 class MyCacheStore < ResoTransport::MetadataCache
-  
+
   def read
-    # read `name` from somewhere    
+    # read `name` from somewhere
   end
 
   def write(data)
@@ -158,12 +163,25 @@ Once you have a successful connection you can explore what resources are availab
   #=> {"Property"=>#<ResoTransport::Resource entity_set="Property", schema="ODataService">, "Office"=>#<ResoTransport::Resource entity_set="Office", schema="ODataService">, "Member"=>#<ResoTransport::Resource entity_set="Member", schema="ODataService">}
 
   @client.resources["Property"]
-  #=> #<ResoTransport::Resource entity_set="Property", schema="ODataService"> 
+  #=> #<ResoTransport::Resource entity_set="Property", schema="ODataService">
 
   @client.resources["Property"].query.limit(1).results
   #=> Results Array
 ```
 
+If the resource contains localizations you can access those as well.
+
+```ruby
+@client.resources["Property"].localizations
+#=> {"CommercialSale"=>{"Name"=>"CommercialSale", "ResourcePath"=>"/Property?Class=CommercialSale", "Description"=>"Contains data for Commercial searches.", "DateTimeStamp"=>"2021-05-03T18:13:20.643-07:00"}, "Residential"=>{"Name"=>"Residential", "ResourcePath"=>"/Property?Class=Residential", "Description"=>"Contains data for Residential searches.", "DateTimeStamp"=>"2021-05-03T18:13:20.643-07:00"}}
+```
+
+If a resource contains localizations you must select one by name, before querying, like so:
+
+```ruby
+@client.resources["Property"].localization('Residential').query.limit(1).results
+```
+
 #### Querying
 
 ResoTransport provides powerful querying capabilities:
@@ -196,7 +214,7 @@ To see what child records can be expanded look at `expandable`:
 
 ```ruby
   @resource.expandable
-  #=> [#<struct ResoTransport::Property name="Media", data_type="Collection(RESO.Media)", attrs={"Name"=>"Media", "Type"=>"Collection(RESO.Media)"}, multi=true, enum=nil, complex_type=nil, entity_type=#<struct ResoTransport::EntityType name="Media", base_type=nil, primary_key="MediaKey", schema="CoreLogic.DataStandard.RESO.DD">> ...] 
+  #=> [#<struct ResoTransport::Property name="Media", data_type="Collection(RESO.Media)", attrs={"Name"=>"Media", "Type"=>"Collection(RESO.Media)"}, multi=true, enum=nil, complex_type=nil, entity_type=#<struct ResoTransport::EntityType name="Media", base_type=nil, primary_key="MediaKey", schema="CoreLogic.DataStandard.RESO.DD">> ...]
 ```
 
 Use `expand` to expand child records with the top level results.
@@ -210,7 +228,7 @@ You have several options to expand multiple child record sets. Each of these wil
 
 ```ruby
   @resource.query.expand("Media", "Office").limit(10).results
-  
+
   @resource.query.expand(["Media", "Office"]).limit(10).results
 
   @resource.query.expand("Media").expand("Office").limit(10).results
@@ -257,7 +275,7 @@ When querying for an enumeration value, you can provide either the system name,
 
 ```ruby
   @resource.query.eq(StandardStatus: "Active Under Contract").limit(1).compile_params
-  #=> {"$top"=>1, "$filter"=>"StandardStatus eq 'ActiveUnderContract'"} 
+  #=> {"$top"=>1, "$filter"=>"StandardStatus eq 'ActiveUnderContract'"}
 ```
 
 ## Development

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "reso_transport"
+require 'bundler/setup'
+require 'reso_transport'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -12,19 +12,19 @@ require "reso_transport"
 #
 
 ResoTransport.configure do |c|
-  c.logger = Logger.new("log/console.log")
+  c.logger = Logger.new('log/console.log')
 end
 
-
-require "irb"
+require 'irb'
 require 'yaml'
 require 'byebug'
 
-SECRETS = YAML.load_file("secrets.yml")
+SECRETS = YAML.load_file('secrets.yml')
 
-@trestle = ResoTransport::Client.new(SECRETS[:trestle].merge(logger: Logger.new($stdout)))
-#@bridge = ResoTransport::Client.new(SECRETS[:bridge].merge(logger: Logger.new($stdout)))
-# @spark = ResoTransport::Client.new(SECRETS[:spark])
-#@crmls = ResoTransport::Client.new(SECRETS[:crmls])
+SECRETS.each do |name, data|
+  data[:logger] = Logger.new($stdout)
+  client = ResoTransport::Client.new(data)
+  instance_variable_set("@#{name}", client)
+end
 
 IRB.start(__FILE__)

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/lib/reso_transport.rb

@@ -5,41 +5,30 @@ require 'faraday'
 require 'json'
 require 'time'
 
-require "reso_transport/version"
-require "reso_transport/configuration"
-require "reso_transport/authentication"
-require "reso_transport/client"
-require "reso_transport/resource"
-require "reso_transport/metadata"
-require "reso_transport/metadata_cache"
-require "reso_transport/metadata_parser"
-require "reso_transport/schema"
-require "reso_transport/entity_set"
-require "reso_transport/entity_type"
-require "reso_transport/enum"
-require "reso_transport/property"
-require "reso_transport/query"
-
-
-
-# module Faraday
-#   module Utils
-
-#     def escape(str)
-#       str.to_s.gsub(ESCAPE_RE) do |match|
-#         '%' + match.unpack('H2' * match.bytesize).join('%').upcase
-#       end.gsub(" ","%20")
-
-#     end
-#   end
-# end
-
-Faraday::Utils.default_space_encoding = "%20"
+require 'reso_transport/version'
+require 'reso_transport/configuration'
+require 'reso_transport/authentication'
+require 'reso_transport/client'
+require 'reso_transport/resource'
+require 'reso_transport/metadata'
+require 'reso_transport/metadata_cache'
+require 'reso_transport/metadata_parser'
+require 'reso_transport/datasystem'
+require 'reso_transport/datasystem_parser'
+require 'reso_transport/schema'
+require 'reso_transport/entity_set'
+require 'reso_transport/entity_type'
+require 'reso_transport/enum'
+require 'reso_transport/property'
+require 'reso_transport/query'
+
+Faraday::Utils.default_space_encoding = '%20'
 
 module ResoTransport
   class Error < StandardError; end
+
   class AccessDenied < StandardError; end
-  ODATA_TIME_FORMAT = "%Y-%m-%dT%H:%M:%SZ"
+  ODATA_TIME_FORMAT = '%Y-%m-%dT%H:%M:%SZ'.freeze
 
   class << self
     attr_writer :configuration
@@ -53,8 +42,7 @@ module ResoTransport
     yield(configuration)
   end
 
-  def self.split_schema_and_class_name(s)
-    s.to_s.partition(/(\w+)$/).first(2).map {|s| s.sub(/\.$/, '') }
+  def self.split_schema_and_class_name(text)
+    text.to_s.partition(/(\w+)$/).first(2).map { |s| s.sub(/\.$/, '') }
   end
-
 end

data/lib/reso_transport/authentication/fetch_token_auth.rb

@@ -1,20 +1,32 @@
 module ResoTransport
   module Authentication
     class FetchTokenAuth < AuthStrategy
-      attr_reader :connection, :endpoint, :client_id, :client_secret, :grant_type, :scope
-      
+      attr_reader :endpoint,
+                  :client_id,
+                  :client_secret,
+                  :grant_type,
+                  :scope,
+                  :username,
+                  :password
+
       def initialize(options)
-        @grant_type    = options.fetch(:grant_type, "client_credentials")
-        @scope         = options.fetch(:scope, "api")
+        super()
+
+        @grant_type    = options.fetch(:grant_type, 'client_credentials')
+        @scope         = options.fetch(:scope, 'api')
         @client_id     = options.fetch(:client_id)
         @client_secret = options.fetch(:client_secret)
         @endpoint      = options.fetch(:endpoint)
+        @username      = options.fetch(:username, nil)
+        @password      = options.fetch(:password, nil)
+      end
 
-        @connection = Faraday.new(@endpoint) do |faraday|
+      def connection
+        @connection ||= Faraday.new(@endpoint) do |faraday|
           faraday.request  :url_encoded
           faraday.response :logger, ResoTransport.configuration.logger if ResoTransport.configuration.logger
           faraday.adapter Faraday.default_adapter
-          faraday.basic_auth @client_id, @client_secret
+          faraday.basic_auth client_id, client_secret
         end
       end
 
@@ -30,19 +42,26 @@ module ResoTransport
         Access.new({
           access_token: json.fetch('access_token'),
           expires_in: json.fetch('expires_in', 1 << (1.size * 8 - 2) - 1),
-          token_type: json.fetch('token_type', "Bearer")
+          token_type: json.fetch('token_type', 'Bearer')
         })
       end
 
       private
 
       def auth_params
-        {
-          client_id:     client_id,
+        params = {
+          client_id: client_id,
           client_secret: client_secret,
-          grant_type:    grant_type,
-          scope:         scope
+          grant_type: grant_type,
+          scope: scope
         }
+
+        if grant_type == 'password'
+          params[:username] = username
+          params[:password] = password
+        end
+
+        params
       end
     end
   end

data/lib/reso_transport/base_metadata.rb

@@ -0,0 +1,61 @@
+module ResoTransport
+  class BaseMetadata
+    MIME_TYPES = {
+      xml: 'application/xml',
+      json: 'application/json'
+    }.freeze
+
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+      @prefix = nil
+      @classname = nil
+    end
+
+    def prefix
+      raise 'prefix not set' unless @prefix
+
+      @prefix
+    end
+
+    def classname
+      raise 'classname not set' unless @classname
+
+      @classname
+    end
+
+    def parser
+      @parser ||= Object::const_get("#{classname}Parser").new.parse(data)
+    end
+
+    def data
+      if cache_file
+        cache.read || cache.write(raw)
+      else
+        raw
+      end
+    end
+
+    def cache
+      @cache ||= client.send("#{prefix}_cache").new(cache_file)
+    end
+
+    def cache_file
+      @cache_file ||= client.send "#{prefix}_file"
+    end
+
+    def raw
+      if response.success?
+        response.body
+      else
+        puts response.body
+        raise "Error getting #{classname}!"
+      end
+    end
+
+    def response
+      raise 'Must implement response method'
+    end
+  end
+end

data/lib/reso_transport/client.rb

@@ -1,35 +1,52 @@
 module ResoTransport
   class Client
-    attr_reader :connection, :uid, :vendor, :endpoint, :auth, :md_file, :md_cache
-    
+    attr_reader :connection, :uid, :vendor, :endpoint, :authentication, :md_file, :md_cache, :ds_file, :ds_cache,
+                :use_replication_endpoint
+
     def initialize(options)
-      @endpoint        = options.fetch(:endpoint)
-      @md_file         = options.fetch(:md_file, nil)
-      @authentication  = ensure_valid_auth_strategy(options.fetch(:authentication))
-      @vendor          = options.fetch(:vendor, {})
-      @faraday_options = options.fetch(:faraday_options, {})
-      @logger          = options.fetch(:logger, nil)
-      @md_cache        = options.fetch(:md_cache, ResoTransport::MetadataCache)
-
-      @connection = Faraday.new(@endpoint, @faraday_options) do |faraday|
+      @use_replication_endpoint = options.fetch(:use_replication_endpoint, false)
+      @endpoint                 = options.fetch(:endpoint)
+      @md_file                  = options.fetch(:md_file, nil)
+      @ds_file                  = options.fetch(:ds_file, nil)
+      @authentication           = ensure_valid_auth_strategy(options.fetch(:authentication))
+      @vendor                   = options.fetch(:vendor, {})
+      @faraday_options          = options.fetch(:faraday_options, {})
+      @logger                   = options.fetch(:logger, nil)
+      @md_cache                 = options.fetch(:md_cache, ResoTransport::MetadataCache)
+      @ds_cache                 = options.fetch(:ds_cache, ResoTransport::MetadataCache)
+      @connection               = establish_connection
+    end
+
+    def establish_connection
+      Faraday.new(@endpoint, @faraday_options) do |faraday|
         faraday.request  :url_encoded
         faraday.response :logger, @logger || ResoTransport.configuration.logger
-        #yield faraday if block_given? 
         faraday.use Authentication::Middleware, @authentication
-        faraday.adapter Faraday.default_adapter #unless faraday.builder.send(:adapter_set?)
+        faraday.adapter Faraday.default_adapter # unless faraday.builder.send(:adapter_set?)
       end
     end
 
     def resources
-      @resources ||= metadata.entity_sets.map {|es| {es.name => Resource.new(self, es)} }.reduce(:merge!)
+      @resources ||= metadata.entity_sets.map { |es| { es.name => resource_for(es) } }.reduce(:merge!)
+    end
+
+    def resource_for(entity_set)
+      localizations = {}
+      localizations = datasystem.localizations_for(entity_set.entity_type) if metadata.datasystem?
+
+      Resource.new(self, entity_set, localizations)
     end
 
     def metadata
       @metadata ||= Metadata.new(self)
     end
 
+    def datasystem
+      @datasystem ||= Datasystem.new(self)
+    end
+
     def to_s
-      %(#<ResoTransport::Client endpoint="#{endpoint}", md_file="#{md_file}">)
+      %(#<ResoTransport::Client endpoint="#{endpoint}", md_file="#{md_file}", ds_file="#{ds_file}">)
     end
 
     def inspect
@@ -41,7 +58,7 @@ module ResoTransport
     def ensure_valid_auth_strategy(options)
       case options
       when Hash
-        if options.has_key?(:endpoint)
+        if options.key?(:endpoint)
           Authentication::FetchTokenAuth.new(options)
         else
           Authentication::StaticTokenAuth.new(options)
@@ -50,6 +67,5 @@ module ResoTransport
         raise ArgumentError, "#{options.inspect} invalid:  cannot determine strategy"
       end
     end
-
   end
 end

data/lib/reso_transport/datasystem.rb

@@ -0,0 +1,22 @@
+require_relative 'base_metadata'
+
+module ResoTransport
+  class Datasystem < BaseMetadata
+    def initialize(client)
+      super client
+      @prefix = 'ds'
+      @classname = self.class.name
+    end
+
+    def localizations_for(resource_name)
+      localizations = parser.resources.dig(resource_name, 'Localizations') || []
+      localizations.map { |l| [l['Name'], l] }.to_h
+    end
+
+    def response
+      @response ||= client.connection.get('DataSystem') do |req|
+        req.headers['Accept'] = 'application/json'
+      end
+    end
+  end
+end

data/lib/reso_transport/datasystem_parser.rb

@@ -0,0 +1,26 @@
+module ResoTransport
+  class DatasystemParser
+    def parse(doc)
+      begin
+        data = doc.is_a?(File) ? doc.read : doc
+        @json = JSON.parse data
+      rescue JSON::ParserError => e
+        @json = {}
+        puts e.message
+      end
+      self
+    end
+
+    # value ->
+    #   Resources ->
+    #     Name ->
+    #     ResourcePath ->
+    #     Localizations ->
+    #       Name ->
+    #       ResourcePath ->
+
+    def resources
+      @resources ||= @json['value'].map { |v| v['Resources'] }.flatten.compact.map { |r| [r['Name'], r] }.to_h
+    end
+  end
+end

data/lib/reso_transport/entity_set.rb

@@ -1,11 +1,9 @@
 module ResoTransport
   EntitySet = Struct.new(:name, :schema, :entity_type) do
-
     def self.from_stream(args)
-      schema, entity_type = ResoTransport.split_schema_and_class_name(args["EntityType"])
+      schema, entity_type = ResoTransport.split_schema_and_class_name(args['EntityType'])
 
-      new(args["Name"], schema, entity_type)
+      new(args['Name'], schema, entity_type)
     end
-
   end
 end

data/lib/reso_transport/entity_type.rb

@@ -1,30 +1,29 @@
 module ResoTransport
   EntityType = Struct.new(:name, :base_type, :primary_key, :schema) do
-
     def self.from_stream(args)
-      new(args["Name"], args["BaseType"])
+      new(args['Name'], args['BaseType'])
     end
 
     def parse(record)
-      record.each_pair do |k,v|
+      record.each_pair do |k, v|
         next if v.nil?
-        if property = (property_map[k] || navigation_property_map[k])
-          record[k] = property.parse(v)
-        end
+
+        property = property_map[k] || navigation_property_map[k]
+        record[k] = property.parse(v) if property
       end
     end
 
     def parse_value(record)
-      record.each_pair do |k,v|
+      record.each_pair do |k, v|
         next if v.nil?
-        if property = (property_map[k] || navigation_property_map[k])
-          record[k] = property.parse(v)
-        end
+
+        property = property_map[k] || navigation_property_map[k]
+        record[k] = property.parse(v) if property
       end
     end
 
     def property_map
-      @property_map ||= properties.inject({}) {|hsh, p| hsh[p.name] = p; hsh }
+      @property_map ||= properties.each_with_object({}) { |p, hsh| hsh[p.name] = p; }
     end
 
     def properties
@@ -32,7 +31,7 @@ module ResoTransport
     end
 
     def navigation_property_map
-      @navigation_property_map ||= navigation_properties.inject({}) {|hsh, p| hsh[p.name] = p; hsh }
+      @navigation_property_map ||= navigation_properties.each_with_object({}) { |p, hsh| hsh[p.name] = p; }
     end
 
     def navigation_properties
@@ -42,6 +41,5 @@ module ResoTransport
     def enumerations
       @enumerations ||= []
     end
-
   end
 end

data/lib/reso_transport/metadata.rb

@@ -1,10 +1,12 @@
-module ResoTransport
-  Metadata = Struct.new(:client) do 
+require_relative 'base_metadata'
 
-    MIME_TYPES = {
-      xml: "application/xml",
-      json: "application/json"
-    }
+module ResoTransport
+  class Metadata < BaseMetadata
+    def initialize(client)
+      super client
+      @prefix = 'md'
+      @classname = self.class.name
+    end
 
     def entity_sets
       parser.entity_sets
@@ -14,34 +16,14 @@ module ResoTransport
       parser.schemas
     end
 
-    def parser
-      @parser ||= MetadataParser.new.parse(get_data)
+    def datasystem?
+      parser.datasystem?
     end
 
-    def md_cache
-      @md_cache ||= client.md_cache.new(client.md_file)
-    end
-
-    def get_data
-      if client.md_file 
-        md_cache.read || md_cache.write(raw)
-      else
-        raw
-      end
-    end
-
-    def raw
-      resp = client.connection.get("$metadata") do |req|
+    def response
+      @response ||= client.connection.get('$metadata') do |req|
         req.headers['Accept'] = MIME_TYPES[client.vendor.fetch(:metadata_format, :xml).to_sym]
       end
-
-      if resp.success?
-        resp.body
-      else
-        puts resp.body
-        raise "Error getting metadata!"
-      end
     end
-
   end
 end

data/lib/reso_transport/metadata_cache.rb

@@ -7,15 +7,14 @@ module ResoTransport
     end
 
     def read
-      if File.exist?(name) && File.size(name) > 0
-        File.new(name)
-      end
+      return nil if !File.exist?(name) || File.size(name).zero?
+
+      File.new(name)
     end
 
     def write(raw)
-      File.open(name, "w") {|f| f.write(raw.force_encoding("UTF-8")) } unless raw.length == 0
+      File.open(name, 'w') { |f| f.write(raw.force_encoding('UTF-8')) } if raw.length.positive?
       File.new(name)
     end
-
   end
 end

data/lib/reso_transport/metadata_parser.rb

@@ -14,12 +14,14 @@ module ResoTransport
       @current_complex_type = nil
       @current_enum_type = nil
       @current_member = nil
+
+      @datasystem = nil
     end
 
     def parse(doc)
       REXML::Document.parse_stream(doc, self)
       finalize
-      return self
+      self
     end
 
     def finalize
@@ -54,55 +56,62 @@ module ResoTransport
 
     def tag_start(name, args)
       case name
-      when "Schema"
+      when 'Schema'
         @schemas << ResoTransport::Schema.from_stream(args)
-      when "EntitySet"
+      when 'EntitySet'
         @entity_sets << ResoTransport::EntitySet.from_stream(args)
-      when "EntityType"
+      when 'EntityType'
         @current_entity_type = ResoTransport::EntityType.from_stream(args)
-      when "ComplexType"
+      when 'ComplexType'
         @current_complex_type = ResoTransport::EntityType.from_stream(args)
-      when "PropertyRef"
+      when 'PropertyRef'
         @current_entity_type.primary_key = args['Name']
-      when "Property"
-        @current_entity_type.properties << ResoTransport::Property.from_stream(args.merge(schema: @schemas.last)) if @current_entity_type
-        @current_complex_type.properties << ResoTransport::Property.from_stream(args.merge(schema: @schemas.last)) if @current_complex_type
-      when "NavigationProperty"
+      when 'Property'
+        if @current_entity_type
+          @current_entity_type.properties << ResoTransport::Property.from_stream(args.merge(schema: @schemas.last))
+        end
+        if @current_complex_type
+          @current_complex_type.properties << ResoTransport::Property.from_stream(args.merge(schema: @schemas.last))
+        end
+      when 'NavigationProperty'
         @current_entity_type.navigation_properties << ResoTransport::Property.from_stream(args)
-      when "EnumType"
+      when 'EnumType'
         @current_enum_type = ResoTransport::Enum.from_stream(args.merge(schema: @schemas.last))
-      when "Member"
+      when 'Member'
         @current_member = ResoTransport::Member.from_stream(args)
-      when "Annotation"
+      when 'Annotation'
         if @current_enum_type && @current_member
           @current_member.annotation = args['String']
-        else
-          if @current_entity_type || @current_complex_type
-            #raise args.inspect
-          end
+        elsif @current_entity_type || @current_complex_type
+          # raise args.inspect
         end
       end
-    rescue => e
+    rescue StandardError => e
       puts e.inspect
       puts "Error processing Tag: #{[name, args].inspect}"
     end
 
     def tag_end(name)
       case name
-      when "EntityType"
+      when 'EntityType'
         @current_entity_type.schema = @schemas.last.namespace
         @schemas.last.entity_types << @current_entity_type
-      when "ComplexType"
+      when 'ComplexType'
         @current_complex_type.schema = @schemas.last.namespace
         @schemas.last.complex_types << @current_complex_type
-      when "EnumType"
+      when 'EnumType'
         @enumerations << @current_enum_type
         @current_enum_type = nil
-      when "Member"
+      when 'Member'
         @current_enum_type.members << @current_member
         @current_member = nil
       end
     end
 
+    def datasystem?
+      return @datasystem unless @datasystem.nil?
+
+      @datasystem = @schemas.any? { |s| s.entity_types.any? { |t| t.name == 'DataSystem' } }
+    end
   end
 end

data/lib/reso_transport/query.rb

@@ -1,23 +1,22 @@
 module ResoTransport
   Query = Struct.new(:resource) do
-
-    def all(*contexts, &block)
+    def all(*_contexts, &block)
       new_query_context('and')
       instance_eval(&block)
       clear_query_context
-      return self
+      self
     end
 
     def any(&block)
       new_query_context('or')
       instance_eval(&block)
       clear_query_context
-      return self
+      self
     end
 
-    [:eq, :ne, :gt, :ge, :lt, :le].each do |op|
+    %i[eq ne gt ge lt le].each do |op|
       define_method(op) do |conditions|
-        conditions.each_pair do |k,v|
+        conditions.each_pair do |k, v|
           current_query_context << "#{k} #{op} #{encode_value(k, v)}"
         end
         return self
@@ -26,36 +25,36 @@ module ResoTransport
 
     def limit(size)
       options[:top] = size
-      return self
+      self
     end
 
     def offset(size)
       options[:skip] = size
-      return self
+      self
     end
 
-    def order(field, dir=nil)
-      options[:orderby] = [field, dir].join(" ").strip
-      return self
+    def order(field, dir = nil)
+      options[:orderby] = [field, dir].join(' ').strip
+      self
     end
 
     def include_count
       options[:count] = true
-      return self
+      self
     end
 
     def select(*fields)
-      os = options.fetch(:select, "").split(",")
-      options[:select] = (os + Array(fields)).uniq.join(",")
+      os = options.fetch(:select, '').split(',')
+      options[:select] = (os + Array(fields)).uniq.join(',')
 
-      return self
+      self
     end
 
     def expand(*names)
-      ex = options.fetch(:expand, "").split(",")
-      options[:expand] = (ex + Array(names)).uniq.join(",")
+      ex = options.fetch(:expand, '').split(',')
+      options[:expand] = (ex + Array(names)).uniq.join(',')
 
-      return self
+      self
     end
 
     def count
@@ -63,7 +62,7 @@ module ResoTransport
       limit(1).include_count
       resp = resource.get(compile_params)
       parsed_body = JSON.parse(resp.body)
-      parsed_body.fetch("@odata.count", 0)
+      parsed_body.fetch('@odata.count', 0)
     end
 
     def results
@@ -72,21 +71,28 @@ module ResoTransport
       if resp[:success]
         resp[:results]
       else
-        puts resp.inspect
-        raise "Request Failed"
+        puts resp[:meta]
+        raise 'Request Failed'
       end
     end
 
     def execute
       resp = resource.get(compile_params)
-      parsed_body = JSON.parse(resp.body)
-      results = Array(parsed_body.delete("value"))
-
-      {
-        success: resp.success? && !parsed_body.has_key?("error"),
-        meta: parsed_body,
-        results: resource.parse(results)
-      }
+      if resp.success?
+        parsed_body = JSON.parse(resp.body)
+        results = Array(parsed_body.delete('value'))
+
+        {
+          success: resp.success? && !parsed_body.key?('error'),
+          meta: parsed_body,
+          results: resource.parse(results)
+        }
+      else
+        {
+          success: false,
+          meta: resp.body
+        }
+      end
     end
 
     def new_query_context(context)
@@ -110,7 +116,7 @@ module ResoTransport
     end
 
     def sub_queries
-      @sub_queries ||= Hash.new {|h,k| h[k] = { context: 'and', criteria: [] } }
+      @sub_queries ||= Hash.new { |h, k| h[k] = { context: 'and', criteria: [] } }
     end
 
     def compile_filters
@@ -120,36 +126,32 @@ module ResoTransport
 
       filter_chunks = []
 
-      if global && global[:criteria]&.any?
-        filter_chunks << global[:criteria].join(" #{global[:context]} ")  
-      end
+      filter_chunks << global[:criteria].join(" #{global[:context]} ") if global && global[:criteria]&.any?
 
       filter_chunks << filter_groups.map do |g|
         "(#{g[:criteria].join(" #{g[:context]} ")})"
-      end.join(" and ")
+      end.join(' and ')
 
-      filter_chunks.reject {|c| c == ""}.join(" and ")
+      filter_chunks.reject { |c| c == '' }.join(' and ')
     end
 
     def compile_params
       params = {}
 
-      options.each_pair do |k,v|
+      options.each_pair do |k, v|
         params["$#{k}"] = v
       end
 
-      if !sub_queries.empty?
-        params["$filter"] = compile_filters
-      end
+      params['$filter'] = compile_filters unless sub_queries.empty?
 
       params
     end
 
-    def encode_value(key, v)
+    def encode_value(key, val)
       field = resource.property(key.to_s)
       raise "Couldn't find property #{key} for #{resource.name}" if field.nil?
-      field.encode(v)
-    end
 
+      field.encode(val)
+    end
   end
 end

data/lib/reso_transport/resource.rb

@@ -1,6 +1,5 @@
 module ResoTransport
-  Resource = Struct.new(:client, :entity_set) do
-
+  Resource = Struct.new(:client, :entity_set, :localizations, :local) do
     def query
       Query.new(self)
     end
@@ -10,7 +9,7 @@ module ResoTransport
     end
 
     def property(name)
-      properties.detect {|p| p.name == name }
+      properties.detect { |p| p.name == name }
     end
 
     def properties
@@ -20,13 +19,13 @@ module ResoTransport
     def expandable
       entity_type.navigation_properties
     end
-    
+
     def entity_type
-      @entity_type ||= schema.entity_types.detect {|et| et.name == entity_set.entity_type }
+      @entity_type ||= schema.entity_types.detect { |et| et.name == entity_set.entity_type }
     end
 
     def schema
-      @schema ||= md.schemas.detect {|s| s.namespace == entity_set.schema }
+      @schema ||= md.schemas.detect { |s| s.namespace == entity_set.schema }
     end
 
     def md
@@ -34,15 +33,30 @@ module ResoTransport
     end
 
     def parse(results)
-      results.map {|r| entity_type.parse(r) }
+      results.map { |r| entity_type.parse(r) }
     end
 
     def get(params)
-      client.connection.get(name, params) do |req|
+      client.connection.get(url, params) do |req|
         req.headers['Accept'] = 'application/json'
       end
     end
 
+    def url
+      return local['ResourcePath'].gsub(%r{^/}, '') if local
+
+      raise 'Localization required' if localizations.any? && local.nil?
+
+      return "#{name}/replication" if client.use_replication_endpoint
+
+      name
+    end
+
+    def localization(name)
+      self.local = localizations[name] if localizations.key?(name)
+      self
+    end
+
     def to_s
       %(#<ResoTransport::Resource entity_set="#{name}", schema="#{schema&.namespace}">)
     end
@@ -50,6 +64,5 @@ module ResoTransport
     def inspect
       to_s
     end
-
   end
 end

data/lib/reso_transport/version.rb

@@ -1,3 +1,3 @@
 module ResoTransport
-  VERSION = "1.5.5"
+  VERSION = '1.5.7'.freeze
 end

data/reso_transport.gemspec

@@ -1,35 +1,35 @@
-
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "reso_transport/version"
+require 'reso_transport/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "reso_transport"
+  spec.name          = 'reso_transport'
   spec.version       = ResoTransport::VERSION
-  spec.authors       = ["Jon Druse"]
-  spec.email         = ["jon@wrstudios.com"]
+  spec.authors       = ['Jon Druse']
+  spec.email         = ['jon@wrstudios.com']
 
-  spec.summary       = "A utility for consuming RESO Web API connections"
-  spec.description   = "Supports Trestle, Spark, Bridge Interactive, MLS Grid"
-  spec.homepage      = "http://github.com/wrstudios/reso_transport"
-  spec.license       = "MIT"
+  spec.summary       = 'A utility for consuming RESO Web API connections'
+  spec.description   = 'Supports Trestle, Spark, Bridge Interactive, MLS Grid'
+  spec.homepage      = 'http://github.com/wrstudios/reso_transport'
+  spec.license       = 'MIT'
 
+  spec.required_ruby_version = '>= 2.6'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "faraday", "~> 1.0.1"
+  spec.add_dependency 'faraday', '~> 1.0.1'
 
-  spec.add_development_dependency "bundler", "~> 2"
-  spec.add_development_dependency "rake", "~> 13"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "minitest-rg", "~> 5.0"
-  spec.add_development_dependency "vcr", "~> 6.0"
-  spec.add_development_dependency "byebug"
+  spec.add_development_dependency 'bundler', '~> 2'
+  spec.add_development_dependency 'byebug', '~> 11'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-rg', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 13'
+  spec.add_development_dependency 'vcr', '~> 6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reso_transport
 version: !ruby/object:Gem::Version
-  version: 1.5.5
+  version: 1.5.7
 platform: ruby
 authors:
 - Jon Druse
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-25 00:00:00.000000000 Z
+date: 2021-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '11'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -81,33 +81,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '13'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
 description: Supports Trestle, Spark, Bridge Interactive, MLS Grid
 email:
 - jon@wrstudios.com
@@ -116,6 +116,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitpod.yml"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
@@ -125,6 +127,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/rake
 - bin/setup
 - lib/reso_transport.rb
 - lib/reso_transport/authentication.rb
@@ -133,8 +136,11 @@ files:
 - lib/reso_transport/authentication/fetch_token_auth.rb
 - lib/reso_transport/authentication/middleware.rb
 - lib/reso_transport/authentication/static_token_auth.rb
+- lib/reso_transport/base_metadata.rb
 - lib/reso_transport/client.rb
 - lib/reso_transport/configuration.rb
+- lib/reso_transport/datasystem.rb
+- lib/reso_transport/datasystem_parser.rb
 - lib/reso_transport/entity_set.rb
 - lib/reso_transport/entity_type.rb
 - lib/reso_transport/enum.rb
@@ -160,7 +166,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="