reso_transport 1.5.4 → 1.5.9

data/lib/reso_transport/errors.rb

@@ -0,0 +1,69 @@
+module ResoTransport
+  class ResourceError < StandardError
+    attr_reader :resource
+
+    def initialize(resource)
+      @resource = resource
+      super message
+    end
+
+    def resource_name
+      return resource.name if resource.respond_to?(:name)
+
+      resource || 'unknown'
+    end
+
+    def message
+      "Request error for #{resource_name}"
+    end
+  end
+
+  class EncodeError < ResourceError
+    def initialize(resource, property)
+      @property = property
+      super resource
+    end
+
+    def message
+      "Property #{@property} not found for #{resource_name}"
+    end
+  end
+
+  class LocalizationRequired < ResourceError
+    def message
+      "Localization required for #{resource_name}"
+    end
+  end
+
+  class RequestError < ResourceError
+    attr_reader :request, :response
+
+    def initialize(request, response, resource = nil)
+      @response = response.respond_to?(:to_hash) ? response.to_hash : response
+      @request = request
+      super resource
+    end
+
+    def message
+      "Received #{response[:status]} for #{resource_name}"
+    end
+  end
+
+  class NoResponse < RequestError
+    def message
+      "No response for #{resource_name}"
+    end
+  end
+
+  class ResponseError < RequestError
+    def message
+      "Request succeeded for #{resource_name} with response errors"
+    end
+  end
+
+  class AccessDenied < RequestError
+    def message
+      "Access denied: #{response.reason_phrase}"
+    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,17 @@ 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]
+        @request = req
       end
-
-      if resp.success?
-        resp.body
-      else
-        puts resp.body
-        raise "Error getting metadata!"
-      end
+    rescue Faraday::ConnectionFailed
+      raise NoResponse.new(request, nil, '$metadata')
     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,67 +25,70 @@ 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
-      p compile_params
       limit(1).include_count
-      resp = resource.get(compile_params)
-      parsed_body = JSON.parse(resp.body)
-      parsed_body.fetch("@odata.count", 0)
+      parsed = handle_response response
+      parsed.fetch('@odata.count', 0)
     end
 
     def results
-      resp = execute
+      parsed = handle_response response
 
-      if resp[:success]
-        resp[:results]
-      else
-        puts resp[:meta]
-        raise "Request Failed"
-      end
+      @next_link = parsed.fetch('@odata.nextLink')
+      results = Array(parsed.delete('value'))
+      resource.parse(results)
     end
 
-    def execute
-      resp = resource.get(compile_params)
-      parsed_body = JSON.parse(resp.body)
-      results = Array(parsed_body.delete("value"))
+    # Can only be accessed after results call
+    def next_link
+      @next_link
+    end
 
-      {
-        success: resp.success? && !parsed_body.has_key?("error"),
-        meta: parsed_body,
-        results: resource.parse(results)
-      }
+    def response
+      resource.get(compile_params)
+    rescue Faraday::ConnectionFailed
+      raise NoResponse.new(resource.request, nil, resource)
+    end
+
+    def handle_response(response)
+      raise RequestError.new(resource.request, response, resource) unless response.success?
+
+      parsed = JSON.parse(response.body)
+      raise ResponseError.new(resource.request, response, resource) if parsed.key?('error')
+
+      parsed
     end
 
     def new_query_context(context)
@@ -110,7 +112,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 +122,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
+      raise EncodeError.new(resource, key) if field.nil?
 
+      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,31 @@ 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'
+        @request = req
       end
     end
 
+    def url
+      return local['ResourcePath'].gsub(%r{^/}, '') if local
+
+      raise LocalizationRequired, self 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
@@ -51,5 +66,10 @@ module ResoTransport
       to_s
     end
 
+    def request
+      return @request.to_h if @request.respond_to? :to_h
+
+      {}
+    end
   end
 end

data/lib/reso_transport/version.rb

@@ -1,3 +1,3 @@
 module ResoTransport
-  VERSION = "1.5.4"
+  VERSION = '1.5.9'.freeze
 end

data/lib/reso_transport.rb

@@ -5,41 +5,28 @@ 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'
+require 'reso_transport/errors'
+
+Faraday::Utils.default_space_encoding = '%20'
 
 module ResoTransport
-  class Error < StandardError; end
-  class AccessDenied < StandardError; end
-  ODATA_TIME_FORMAT = "%Y-%m-%dT%H:%M:%S%Z"
+  ODATA_TIME_FORMAT = '%Y-%m-%dT%H:%M:%SZ'.freeze
 
   class << self
     attr_writer :configuration
@@ -53,8 +40,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/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