reso_transport 1.3.2 → 1.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43f4e6124d81f3d7a48fd835b8c985a778f04f0e324a939c0d441a1b75e07c4a
-  data.tar.gz: 995d0d656dff3dee41f5d91225dc0954b936ddd3aead58e709eacd9b6e7944e8
+  metadata.gz: 9d8d276bf6165281a38be1f3eecda4f50c530bb7a2a2d40b2f8382ae44211bf9
+  data.tar.gz: 2ecab6485d270956e91e5e3278fd46a9c1cd65a8960914dfccf86fa530d4c561
 SHA512:
-  metadata.gz: 916850bf4bb78db885f3d8aa1bb881ceb047ebbf4437a22852435af110a596de7b5aca024ffccd681e2b65f2590cc2c3ebe9b0d7feb466928bf656eeb458e1fc
-  data.tar.gz: 7487380619478a974d19ba623bca052067c3f6aca7b7db3d6846d331c74bf0612adba1eb1917cebc150a72334fd542f3bd1714341180f80def8b5a1742bc35d9
+  metadata.gz: 55b29a0d927e87fa2aef9736bed074b72dfdce04d866ec6b4f1b9f1e4a237d4d7ef44199e19956b45bdf879954f5575e055049adb3b550f80eb10ec2ad42ca10
+  data.tar.gz: 91366382060311726be58cf26c1439aad63e6fcfb96f1b6044465fdc630bc499d8ef0edcd6c1443d4ce06b0acc881009977584faed9b2bc6ebe3efbcc121bcb4

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/Gemfile.lock

@@ -1,33 +1,33 @@
 PATH
   remote: .
   specs:
-    reso_transport (1.3.0)
-      faraday (~> 0.15.0)
+    reso_transport (1.5.2)
+      faraday (~> 1.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     byebug (11.0.1)
-    faraday (0.15.4)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
     minitest (5.13.0)
     minitest-rg (5.2.0)
       minitest (~> 5.0)
     multipart-post (2.1.1)
-    rake (10.5.0)
-    vcr (5.0.0)
+    rake (13.0.1)
+    vcr (6.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler (~> 2)
   byebug
   minitest (~> 5.0)
   minitest-rg (~> 5.0)
-  rake (~> 10.0)
+  rake (~> 13)
   reso_transport!
-  vcr (~> 5.0)
+  vcr (~> 6.0)
 
 BUNDLED WITH
-   1.17.2
+   2.1.4

data/README.md

@@ -30,6 +30,25 @@ This gem has been tested to work with:
 * [Bridge Interactive](https://www.bridgeinteractive.com)
 
 
+### Logging
+
+You can either set a global logger in an initializer file:
+
+```ruby
+ResoTransport.configure do |c|
+  c.logger = Logger.new("some_log_file")
+  # OR
+  c.logger = Rails.logger
+end
+
+```
+Or you can set a logger for each specific instance of a client which can be useful for debugging:
+
+```ruby
+@client = ResoTransport::Client.new(config.merge(logger: Logger.new("logfile")))
+```
+
+
 ### Getting Connected
 
 There are 2 strategies for authentication. 
@@ -63,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"
     }
   })
 ```
@@ -71,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:
@@ -189,6 +266,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/reso_transport. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/bin/console

@@ -22,9 +22,9 @@ require 'byebug'
 
 SECRETS = YAML.load_file("secrets.yml")
 
-@trestle = ResoTransport::Client.new(SECRETS[:trestle])
-@bridge = ResoTransport::Client.new(SECRETS[:bridge])
-@spark = ResoTransport::Client.new(SECRETS[:spark])
-@crmls = ResoTransport::Client.new(SECRETS[:crmls])
+@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])
 
 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"
@@ -21,17 +22,19 @@ require "reso_transport/query"
 
 
 
-module Faraday
-  module Utils
+# 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")
+#     def escape(str)
+#       str.to_s.gsub(ESCAPE_RE) do |match|
+#         '%' + match.unpack('H2' * match.bytesize).join('%').upcase
+#       end.gsub(" ","%20")
 
-    end
-  end
-end
+#     end
+#   end
+# end
+
+Faraday::Utils.default_space_encoding = "%20"
 
 module ResoTransport
   class Error < StandardError; end
@@ -51,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)
@@ -8,11 +8,13 @@ module ResoTransport
       @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|
         faraday.request  :url_encoded
-        faraday.response :logger, ResoTransport.configuration.logger if ResoTransport.configuration.logger
-        #yield faraday if block_given?
+        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?)
       end

data/lib/reso_transport/enum.rb

@@ -7,7 +7,7 @@ module ResoTransport
 
   Enum = Struct.new(:name, :type, :is_flags) do
     def self.from_stream(args)
-      new("#{args[:schema].namespace}.#{args["Name"]}", args["UnderlyingType"], args["IsFlags"])
+      new("#{args[:schema].namespace}.#{args["Name"]}", args["UnderlyingType"], args["IsFlags"].to_s.downcase == "true")
     end
     
     def members

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

@@ -59,6 +59,7 @@ module ResoTransport
     end
 
     def count
+      p compile_params
       limit(1).include_count
       resp = resource.get(compile_params)
       parsed_body = JSON.parse(resp.body)

data/lib/reso_transport/version.rb

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

data/reso_transport.gemspec

@@ -24,12 +24,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "faraday", "~> 0.15.0"
+  spec.add_dependency "faraday", "~> 1.0.1"
 
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
+  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", "~> 5.0"
+  spec.add_development_dependency "vcr", "~> 6.0"
   spec.add_development_dependency "byebug"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reso_transport
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.5.4
 platform: ruby
 authors:
 - Jon Druse
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-27 00:00:00.000000000 Z
+date: 2021-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -138,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
@@ -165,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A utility for consuming RESO Web API connections