reso_transport 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b1de660c3d25c774dbbb7165850c147879631167e4e22b9797d87b8e58649d8d
+  data.tar.gz: 9050fc9ed9d8f01d7649565c76951d968965f66135c4c8bef98a2892afa11390
+SHA512:
+  metadata.gz: d4415d6ab3b57518b46badbd31a1d55b1ba47450b2eab8063f595c28c94ea9a7088e4aebb87e8d4217fb75c33f538e43256b9f42f90ed760f5c4a5e12b460b4e
+  data.tar.gz: 8aec8759ac045f56e7a1e17d473875bfb8b081fb833a3cbe638606a141c702e768d82b3966df24a0f47408720b662a2968f1b240673acff6b545001c82ce0737

data/.gitignore

@@ -0,0 +1,15 @@
+.DS_Store
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/log/**
+/test/vcr_cassettes/**
+md_cache/**
+.byebug_history
+secrets.yml

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jon@jondruse.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in reso_transport.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    reso_transport (1.0.0)
+      faraday (~> 0.17.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.0.1)
+    faraday (0.17.0)
+      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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  byebug
+  minitest (~> 5.0)
+  minitest-rg (~> 5.0)
+  rake (~> 10.0)
+  reso_transport!
+  vcr (~> 5.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Jon Druse
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,193 @@
+# 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'reso_transport'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install reso_transport
+
+## Usage
+
+
+### Getting Connected
+
+There are 2 strategies for authentication. 
+
+**Bearer Token**
+
+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
+    authentication: {
+      access_token: TOKEN,
+      token_type: "Bearer" # this is the default and can be ommitted
+    }
+  })
+```
+
+
+**Authorization Endpoint**
+
+If the connection requires requesting a new token periodically, it's easy to provide that information:
+
+```ruby
+  @client = ResoTransport::Client.new({
+    md_file: METADATA_CACHE,
+    endpoint: ENDPOINT_URL
+    authentication: {
+      endpoint: AUTH_ENDPOINT,
+      client_id: CLIENT_ID,
+      client_secret: CLIENT_SECRET,
+      grant_type: "client_credentials", # these are the default and can be ommitted
+      scope: "api"                      # 
+    }
+  })
+```
+
+This will pre-fetch a token from the provided endpoint when the current token is either non-existent or has expired.
+
+
+### Resources
+
+Once you have a successful connection you can explore what resources are available from the API:
+
+
+```ruby
+  @client.resources
+  #=> {"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"> 
+
+  @client.resources["Property"].query.limit(1).results
+  #=> Results Array
+```
+
+#### Querying
+
+ResoTransport provides powerful querying capabilities:
+
+To get 10 listings in Los Angeles between 900K and 1M and at least 5 bedrooms:
+```ruby
+  @resource.query.
+    eq(City: "Los Angeles").
+    le(ListPrice: 1_000_000).
+    ge(ListPrice: 900_000, Bedrooms: 5).
+    limit(10).
+    results
+```
+
+To get 10 listings in Los Angeles OR Hollywood between 900K and 1M and at least 5 bedrooms:
+```ruby
+  @resource.query.
+  any {
+    eq(City: "Los Angeles").eq(City: "Hollywood")
+  }.
+  le(ListPrice: 1_000_000).
+  ge(ListPrice: 900_000, Bedrooms: 5).
+  limit(10).
+  results
+```
+
+#### Expanding Child Records
+
+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">> ...] 
+```
+
+Use `expand` to expand child records with the top level results.
+
+```ruby
+  @resource.query.expand("Media").limit(10).results
+  #=> Results Array
+```
+
+You have several options to expand multiple child record sets. Each of these will have the same result.
+
+```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
+```
+
+### Results Array
+
+The results are parsed according to the metadata with some things worth mentioning:
+
+* Date fields are parsed into ruby `DateTime` objects
+* Enumeration fields are parsed into either the `Name` or `Annotation -> String` of the member that is represented.
+* Collections or Enumerations with `is_flags=true` will also be parsed into an `Array`.
+
+### Enumerations
+
+Enumerations are essentially a mapping of system values and display values.  To see a mapping:
+
+```ruby
+  @resource.property("StandardStatus").enum.mapping
+
+  => {
+       "Active"=>"Active",
+       "ActiveUnderContract"=>"Active Under Contract",
+       "Canceled"=>"Canceled",
+       "Closed"=>"Closed",
+       "ComingSoon"=>"Coming Soon",
+       "Delete"=>"Delete",
+       "Expired"=>"Expired",
+       "Hold"=>"Hold",
+       "Incomplete"=>"Incomplete",
+       "Pending"=>"Pending",
+       "Withdrawn"=>"Withdrawn"
+     }
+```
+
+Most Enumerations will ultimately be used to fill a dropdown with options to select from.  Like so:
+
+```ruby
+  @resource.property("StandardStatus").enum.mapping.values
+  #=> ["Active", "Active Under Contract", "Canceled", "Closed", "Coming Soon", "Delete", "Expired", "Hold", "Incomplete", "Pending", "Withdrawn"]
+```
+
+When querying for an enumeration value, you can provide either the system name, or the display name and it will be converted to the correct value. This allows your programs to not worry too much about the system values.
+
+```ruby
+  @resource.query.eq(StandardStatus: "Active Under Contract").limit(1).compile_params
+  #=> {"$top"=>1, "$filter"=>"StandardStatus eq 'ActiveUnderContract'"} 
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ResoTransport project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/reso_transport/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+#
+
+ResoTransport.configure do |c|
+  c.logger = Logger.new("log/console.log")
+end
+
+
+require "irb"
+require 'yaml'
+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])
+
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/reso_transport/authentication/access.rb

@@ -0,0 +1,23 @@
+module ResoTransport
+  module Authentication
+    # Session class for TokenAuth. This stores the access token, the token type
+    # (usually `Bearer`), and the expiration date of the token.
+    class Access
+      attr_accessor :access_token, :expires, :token_type
+
+      def initialize(options = {})
+        @access_token = options[:access_token]
+        @expires      = Time.now + options[:expires_in]
+        @token_type   = options[:token_type]
+      end
+
+      def expired?
+        Time.now > expires
+      end
+
+      def valid?
+        !!access_token && !expired?
+      end
+    end
+  end
+end

data/lib/reso_transport/authentication/auth_strategy.rb

@@ -0,0 +1,26 @@
+module ResoTransport
+  module Authentication
+    # This base class defines the basic interface support by all client authentication implementations.
+    class AuthStrategy
+      attr_reader :access
+
+      # @abstract Perform requests to authenticate the client with the API
+      # @return [Access] The access token object
+      def authenticate(*)
+        raise NotImplementedError, 'Implement me!'
+      end
+
+      # Ensure that a valid access token is present or raise an exception
+      # @raise [ResoWebApi::Errors::AccessDenied] If authentication fails
+      def ensure_valid_access!
+        @access = authenticate unless access && access.valid?
+        access
+      end
+
+      # Resets access
+      def reset
+        @access = nil
+      end
+    end
+  end
+end

data/lib/reso_transport/authentication/fetch_token_auth.rb

@@ -0,0 +1,49 @@
+module ResoTransport
+  module Authentication
+    class FetchTokenAuth < AuthStrategy
+      attr_reader :connection, :endpoint, :client_id, :client_secret, :grant_type, :scope
+      
+      def initialize(options)
+        @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)
+
+        @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
+        end
+      end
+
+      def authenticate
+        response = connection.post nil, auth_params
+        json = JSON.parse response.body
+
+        unless response.success?
+          message = "#{response.reason_phrase}: #{json['error'] || response.body}"
+          raise ResoTransport::AccessDenied, response: response, message: message
+        end
+
+        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")
+        })
+      end
+
+      private
+
+      def auth_params
+        {
+          client_id:     client_id,
+          client_secret: client_secret,
+          grant_type:    grant_type,
+          scope:         scope
+        }
+      end
+    end
+  end
+end

data/lib/reso_transport/authentication/middleware.rb

@@ -0,0 +1,46 @@
+module ResoTransport
+  module Authentication
+    # Authentication middleware
+    # Ensures that each request is made with proper `Authorization` header set
+    # and raises an exception if a request yields a `401 Access Denied` response.
+    class Middleware < Faraday::Middleware
+      AUTH_HEADER = 'Authorization'.freeze
+
+      def initialize(app, auth)
+        super(app)
+        @auth = auth
+      end
+
+      def call(request_env)
+        retries = 1
+
+        begin
+          authorize_request(request_env)
+
+          @app.call(request_env).on_complete do |response_env|
+            raise_if_unauthorized(response_env)
+          end
+        rescue ResoTransport::AccessDenied
+          raise if retries == 0
+          @auth.reset
+          retries -= 1
+          retry
+        end
+      end
+
+      private
+
+      def authorize_request(request_env)
+        @auth.ensure_valid_access!
+
+        request_env[:request_headers].merge!(
+          AUTH_HEADER => "#{@auth.access.token_type} #{@auth.access.access_token}"
+        )
+      end
+
+      def raise_if_unauthorized(response_env)
+        raise ResoTransport::AccessDenied if response_env[:status] == 401
+      end
+    end
+  end
+end

data/lib/reso_transport/authentication/static_token_auth.rb

@@ -0,0 +1,24 @@
+module ResoTransport
+  module Authentication
+    # A simple auth strategy that uses a static, non-expiring token.
+    class StaticTokenAuth < AuthStrategy
+      attr_reader :access_token
+      attr_reader :token_type
+
+      def initialize(options)
+        @access_token = options.fetch(:access_token)
+        @token_type   = options.fetch(:token_type, "Bearer")
+      end
+
+      # Simply returns a static, never expiring access token
+      # @return [Access] The access token object
+      def authenticate
+        Access.new(
+          access_token: access_token,
+          token_type: token_type,
+          expires_in: 1 << (1.size * 8 - 2) - 1 # Max int value
+        )
+      end
+    end
+  end
+end

data/lib/reso_transport/authentication.rb

@@ -0,0 +1,5 @@
+require_relative 'authentication/access'
+require_relative 'authentication/auth_strategy'
+require_relative 'authentication/middleware'
+require_relative 'authentication/static_token_auth'
+require_relative 'authentication/fetch_token_auth'

data/lib/reso_transport/client.rb

@@ -0,0 +1,53 @@
+module ResoTransport
+  class Client
+    attr_reader :connection, :uid, :vendor, :endpoint, :auth, :md_file
+    
+    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, {})
+
+      @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.use Authentication::Middleware, @authentication
+        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!)
+    end
+
+    def metadata
+      @metadata ||= Metadata.new(self)
+    end
+
+    def to_s
+      %(#<ResoTransport::Client endpoint="#{endpoint}", md_file="#{md_file}">)
+    end
+
+    def inspect
+      to_s
+    end
+
+    private
+
+    def ensure_valid_auth_strategy(options)
+      case options
+      when Hash
+        if options.has_key?(:endpoint)
+          Authentication::FetchTokenAuth.new(options)
+        else
+          Authentication::StaticTokenAuth.new(options)
+        end
+      else
+        raise ArgumentError, "#{options.inspect} invalid:  cannot determine strategy"
+      end
+    end
+
+  end
+end

data/lib/reso_transport/configuration.rb

@@ -0,0 +1,6 @@
+module ResoTransport
+  class Configuration
+    attr_accessor :logger
+
+  end
+end

data/lib/reso_transport/entity_set.rb

@@ -0,0 +1,11 @@
+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"])
+
+      new(args["Name"], schema, entity_type)
+    end
+
+  end
+end