reso_transport 1.5.3 → 1.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40a3ea232e3c5de03eea4c842abd89c85747dc0e67af48ed60a27dcefca572e1
-  data.tar.gz: 68c92d6a7282c9de70d4667275da926a0ea160a24c5daa515e2cb09af9a17bee
+  metadata.gz: 9d8d276bf6165281a38be1f3eecda4f50c530bb7a2a2d40b2f8382ae44211bf9
+  data.tar.gz: 2ecab6485d270956e91e5e3278fd46a9c1cd65a8960914dfccf86fa530d4c561
 SHA512:
-  metadata.gz: adf38742bf879054b2c6a83ca4cec083ae2aae478ff132e896e3e73eef09de7ba39e385ecf5588cf71760a6e28e01f0fb67917379347b00729eb70837adb4210
-  data.tar.gz: 2d59a335393538b6902ae6db24963284894c24f5c092bbf02cb403ec55a88270d83b3733b19abc8906946f1ee3ede4127eb68d9d0cd9d6dfd9621ff8490dfd48
+  metadata.gz: 55b29a0d927e87fa2aef9736bed074b72dfdce04d866ec6b4f1b9f1e4a237d4d7ef44199e19956b45bdf879954f5575e055049adb3b550f80eb10ec2ad42ca10
+  data.tar.gz: 91366382060311726be58cf26c1439aad63e6fcfb96f1b6044465fdc630bc499d8ef0edcd6c1443d4ce06b0acc881009977584faed9b2bc6ebe3efbcc121bcb4

data/README.md

@@ -82,7 +82,7 @@ If the connection requires requesting a new token periodically, it's easy to pro
       client_id: CLIENT_ID,
       client_secret: CLIENT_SECRET,
       grant_type: "client_credentials", # these are the default and can be ommitted
-      scope: "api"                      # 
+      scope: "api"
     }
   })
 ```
@@ -90,6 +90,64 @@ 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.
 
 
+
+### Caching Metadata
+
+The metadata file itself is large and parsing it is slow, so ResoTransport has built in support for caching the metadata to your file system. In the example above
+you would replace `METADATA_CACHE` with a path to a file to store the metadata.
+
+```
+  md_file: "reso_md_cache/#{@mls.name}",
+```
+
+This will store the metadata to a file with `@mls.name` in a folder named `reso_md_cache` in the relative root of your app.
+
+**Customize your cache**
+
+If you don't have access to the file system, like on Heroku, or you just don't want to store the metadata on the file system, you can provide your down metadata cache class.
+
+```ruby
+class MyCacheStore < ResoTransport::MetadataCache
+  
+  def read
+    # read `name` from somewhere    
+  end
+
+  def write(data)
+    # write `name` with `data` somewhere
+    # return an IO instance
+  end
+
+end
+```
+
+The metadata parser expects to recieve an IO instance so just make sure your `read` and `write` methods return one.
+
+And you can instruct the client to use that cache store like so:
+
+```
+  md_file: "reso_md_cache/#{@mls.name}",
+  md_cache: MyCacheStore
+```
+
+
+**Skip cache altogether**
+
+Caching the metadata is not actually required, just be aware that it will be much slower. To skip caching just omit the related keys
+when instantiating a new Client.
+
+```ruby
+  @client = ResoTransport::Client.new({
+    endpoint: ENDPOINT_URL
+    authentication: {
+      endpoint: AUTH_ENDPOINT,
+      client_id: CLIENT_ID,
+      client_secret: CLIENT_SECRET,
+    }
+  })
+```
+
+
 ### Resources
 
 Once you have a successful connection you can explore what resources are available from the API:

data/bin/console

@@ -23,8 +23,8 @@ require 'byebug'
 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)))
+#@bridge = ResoTransport::Client.new(SECRETS[:bridge].merge(logger: Logger.new($stdout)))
 # @spark = ResoTransport::Client.new(SECRETS[:spark])
-@crmls = ResoTransport::Client.new(SECRETS[:crmls])
+#@crmls = ResoTransport::Client.new(SECRETS[:crmls])
 
 IRB.start(__FILE__)

data/lib/reso_transport.rb

@@ -11,6 +11,7 @@ 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"
@@ -53,7 +54,7 @@ module ResoTransport
   end
 
   def self.split_schema_and_class_name(s)
-    s.partition(/(\w+)$/).first(2).map {|s| s.sub(/\.$/, '') }
+    s.to_s.partition(/(\w+)$/).first(2).map {|s| s.sub(/\.$/, '') }
   end
 
 end

data/lib/reso_transport/client.rb

@@ -1,6 +1,6 @@
 module ResoTransport
   class Client
-    attr_reader :connection, :uid, :vendor, :endpoint, :auth, :md_file
+    attr_reader :connection, :uid, :vendor, :endpoint, :auth, :md_file, :md_cache
     
     def initialize(options)
       @endpoint        = options.fetch(:endpoint)
@@ -9,6 +9,7 @@ module ResoTransport
       @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|
         faraday.request  :url_encoded

data/lib/reso_transport/metadata.rb

@@ -18,15 +18,13 @@ module ResoTransport
       @parser ||= MetadataParser.new.parse(get_data)
     end
 
+    def md_cache
+      @md_cache ||= client.md_cache.new(client.md_file)
+    end
+
     def get_data
       if client.md_file 
-        if File.exist?(client.md_file) && File.size(client.md_file) > 0
-          File.new(client.md_file)
-        else
-          raw_md = raw
-          File.open(client.md_file, "w") {|f| f.write(raw.force_encoding("UTF-8")) } unless raw_md.length == 0
-          File.new(client.md_file)
-        end
+        md_cache.read || md_cache.write(raw)
       else
         raw
       end

data/lib/reso_transport/metadata_cache.rb

@@ -0,0 +1,21 @@
+module ResoTransport
+  class MetadataCache
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def read
+      if File.exist?(name) && File.size(name) > 0
+        File.new(name)
+      end
+    end
+
+    def write(raw)
+      File.open(name, "w") {|f| f.write(raw.force_encoding("UTF-8")) } unless raw.length == 0
+      File.new(name)
+    end
+
+  end
+end

data/lib/reso_transport/query.rb

@@ -77,18 +77,7 @@ module ResoTransport
       end
     end
 
-    def raw_results
-      resp = execute(false)
-
-      if resp[:success]
-        resp[:results]
-      else
-        puts resp[:meta]
-        raise "Request Failed"
-      end
-    end
-
-    def execute(parse_values=true)
+    def execute
       resp = resource.get(compile_params)
       parsed_body = JSON.parse(resp.body)
       results = Array(parsed_body.delete("value"))
@@ -96,7 +85,7 @@ module ResoTransport
       {
         success: resp.success? && !parsed_body.has_key?("error"),
         meta: parsed_body,
-        results: parse_values ? resource.parse(results) : results
+        results: resource.parse(results)
       }
     end
 

data/lib/reso_transport/version.rb

@@ -1,3 +1,3 @@
 module ResoTransport
-  VERSION = "1.5.3"
+  VERSION = "1.5.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reso_transport
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 1.5.4
 platform: ruby
 authors:
 - Jon Druse
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-26 00:00:00.000000000 Z
+date: 2021-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -139,6 +139,7 @@ files:
 - lib/reso_transport/entity_type.rb
 - lib/reso_transport/enum.rb
 - lib/reso_transport/metadata.rb
+- lib/reso_transport/metadata_cache.rb
 - lib/reso_transport/metadata_parser.rb
 - lib/reso_transport/property.rb
 - lib/reso_transport/query.rb
@@ -151,7 +152,7 @@ homepage: http://github.com/wrstudios/reso_transport
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -167,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key:
+signing_key: 
 specification_version: 4
 summary: A utility for consuming RESO Web API connections
 test_files: []