reso_web_api 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4476a6c7c91ca11a6ee826b17173fb7f05875f9a
+  data.tar.gz: b926a43a312ee862f0139729cac0893bfbba53ac
+SHA512:
+  metadata.gz: f97635ef226ae6e694a5dacf135fac8c43b78b87af4b3c05659b07c2380e991a3866fe9b90b30c72ab9782f584da007052e8070751a5cc9f84aa26fd27e821a2
+  data.tar.gz: 944f6747aebf0ec3862548c919f79bf15b826a714d71451e12402bd1ed9205a783ca7c2ba07f7b5660f60c393623e3ca99362990108a6b5f39127c4c1e75344e

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/log/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Gemfile.lock should /not/ be checked in for gems
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+reso_web_api

data/.ruby-version

@@ -0,0 +1 @@
+2.2

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# CHANGELOG
+
+## 0.2.0
+
+* Refactored code and simplified design
+* Middleware-based authentication mechanism
+* Added comprehensive tests
+
+## 0.1.0
+
+* Initial release

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_web_api.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 W+R Studios
+
+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,88 @@
+# ResoWebApi
+
+A Ruby library to connects to MLS servers conforming to the [RESO Web API][reso-web-api] standard.
+
+[reso-web-api]: https://www.reso.org/reso-web-api/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'reso_web_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install reso_web_api
+
+## Usage
+
+### Authentication
+
+Instantiating an API client requires two things: an endpoint (i.e. service URL) and an authentication strategy.
+You may either instantiate the auth strategy directly and pass it to the client constructor (in the `:auth` parameter), or you may choose to pass a nested hash with options for configuring the strategy instead, as below:
+
+```ruby
+require 'reso_web_api'
+
+client = ResoWebApi::Client.new(
+  endpoint: 'https://api.my-mls.org/RESO/OData/',
+  auth: {
+    strategy:      ResoWebApi::Authentication::TokenAuth,
+    endpoint:      'https://oauth.my-mls.org/connect/token',
+    client_id:     'deadbeef',
+    client_secret: 'T0pS3cr3t',
+    scope:         'odata'
+  }
+end
+```
+
+Note that if you choose this option, you _may_ specify the strategy implementation by passing its _class_ as the `:strategy` option.
+If you omit the `:strategy` parameter, it will default to `ResoWebApi::Authentication::TokenAuth`.
+
+### Accessing Data
+
+#### Standard Resources
+
+Since most RESO Web API servers will likely adhere to the RESO Data Dictionary, we've created some shortcuts for the standard resources
+
+```ruby
+# Iterate over all properties -- WARNING! Might take a long time
+client.properties.each do |property|
+  puts "#{property['ListPrice']} #{property['StandardStatus']}"
+end
+```
+
+The following methods are provided:
+
+- Property: use `#properties`
+- Member: use `#members`
+- Office: use `#office`
+- Media: use `#media`
+
+#### Other Resources
+
+Other resources may be access using the `#resources` method on the client, which may be accessed as a hash like this:
+
+```ruby
+client.resources['OpenHouse'].first # Access the 'OpenHouse' collectionh
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/wrstudios/reso_web_api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "reso_web_api"
+
+# 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
+
+require "irb"
+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_web_api.rb

@@ -0,0 +1,30 @@
+require 'json'
+require 'logger'
+require 'odata4'
+
+require 'reso_web_api/version'
+require 'reso_web_api/errors'
+require 'reso_web_api/client'
+
+module ResoWebApi
+  def self.client(options = {})
+    Thread.current[:reso_web_api_client] ||= ResoWebApi::Client.new(options)
+  end
+
+  def self.reset
+    reset_configuration
+    Thread.current[:reso_web_api_client] = nil
+  end
+
+  def self.logger
+    if @logger.nil?
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logger::INFO
+    end
+    @logger
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+end

data/lib/reso_web_api/authentication.rb

@@ -0,0 +1,4 @@
+require_relative 'authentication/access'
+require_relative 'authentication/auth_strategy'
+require_relative 'authentication/middleware'
+require_relative 'authentication/token_auth'

data/lib/reso_web_api/authentication/access.rb

@@ -0,0 +1,23 @@
+module ResoWebApi
+  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 :token, :expires, :token_type
+
+      def initialize(options = {})
+        @token      = options['access_token']
+        @expires    = Time.now + options['expires_in']
+        @token_type = options['token_type']
+      end
+
+      def expired?
+        Time.now > expires
+      end
+
+      def valid?
+        !!token && !expired?
+      end
+    end
+  end
+end

data/lib/reso_web_api/authentication/auth_strategy.rb

@@ -0,0 +1,26 @@
+module ResoWebApi
+  module Authentication
+    # This base class defines the basic interface support by all client authentication implementations.
+    class AuthStrategy < BaseClient
+      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_web_api/authentication/middleware.rb

@@ -0,0 +1,46 @@
+module ResoWebApi
+  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 Errors::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.token}"
+        )
+      end
+
+      def raise_if_unauthorized(response_env)
+        raise Errors::AccessDenied if response_env[:status] == 401
+      end
+    end
+  end
+end

data/lib/reso_web_api/authentication/token_auth.rb

@@ -0,0 +1,40 @@
+module ResoWebApi
+  module Authentication
+    # This implements a basic token authentication, in which a username/password
+    # (or API key / secret) combination is sent to a special token endpoint in
+    # exchange for a HTTP Bearer token with a limited lifetime.
+    class TokenAuth < AuthStrategy
+      option :client_id
+      option :client_secret
+      option :grant_type, default: proc { 'client_credentials' }
+      option :scope
+
+      def authenticate
+        response = connection.post nil, auth_params
+        body = JSON.parse response.body
+
+        unless response.success?
+          message = "#{response.reason_phrase}: #{body['error'] || response.body}"
+          raise Errors::AccessDenied, response: response, message: message
+        end
+
+        Access.new(body)
+      end
+
+      def connection
+        super.basic_auth(client_id, client_secret) && super
+      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_web_api/base_client.rb

@@ -0,0 +1,36 @@
+require 'faraday'
+require 'dry-initializer'
+
+module ResoWebApi
+  # Base class for Faraday-based HTTP clients
+  class BaseClient
+    extend Dry::Initializer
+
+    option :endpoint
+    option :user_agent, default: proc { USER_AGENT }
+    option :adapter, default: proc { Faraday::default_adapter }
+    option :logger, default: proc { ResoWebApi.logger }
+
+    USER_AGENT = "Reso Web API Ruby Gem v#{VERSION}"
+
+    # Return the {Faraday::Connection} object for this client.
+    # Yields the connection object being constructed (for customzing middleware).
+    # @return [Faraday::Connection] The connection object
+    def connection(&block)
+      @connection ||= Faraday.new(url: endpoint, headers: headers) do |conn|
+        conn.request :url_encoded
+        conn.response :logger, logger
+        yield conn if block_given?
+        conn.adapter adapter unless conn.builder.send(:adapter_set?)
+      end
+    end
+
+    # Return the headers to be sent with every request.
+    # @return [Hash] The request headers.
+    def headers
+      {
+        :user_agent => user_agent
+      }
+    end
+  end
+end

data/lib/reso_web_api/client.rb

@@ -0,0 +1,53 @@
+require_relative 'base_client'
+require_relative 'authentication'
+require_relative 'resources'
+
+module ResoWebApi
+  # Main class to run requests against a RESO Web API server.
+  class Client < BaseClient
+    include Resources
+
+    option :auth
+
+    def initialize(options = {})
+      super(options)
+      ensure_valid_auth_strategy!
+    end
+
+    # Headers to be send along with requests
+    # @return [Hash] The request headers
+    def headers
+      super.merge({ accept: 'application/json' })
+    end
+
+    # Return the {Faraday::Connection} object for this client.
+    # Yields the connection object being constructed (for customzing middleware).
+    # @return [Faraday::Connection] The connection object
+    def connection(&block)
+      super do |conn|
+        conn.use Authentication::Middleware, @auth
+        yield conn if block_given?
+      end
+    end
+
+    # Returns a proxied {OData4::Service} that attempts to ensure a  properly
+    # authenticated and authorized connection
+    # @return [OData4::Service] The service instance.
+    def service
+      @service ||= OData4::Service.new(connection)
+    end
+
+    private
+
+    def ensure_valid_auth_strategy!
+      if auth.is_a?(Hash)
+        strategy = auth.delete(:strategy) || Authentication::TokenAuth
+        if strategy.is_a?(Class) && strategy <= Authentication::AuthStrategy
+          @auth = strategy.new(auth)
+        else
+          raise ArgumentError, "#{strategy} is not a valid auth strategy"
+        end
+      end
+    end
+  end
+end

data/lib/reso_web_api/errors.rb

@@ -0,0 +1,22 @@
+module ResoWebApi
+  class Error < StandardError; end
+
+  class NetworkError < Error
+    attr_reader :response
+
+    def initialize(options = {})
+      # Support the standard initializer for errors
+      opts = options.is_a?(Hash) ? options : { message: options.to_s }
+      @response = opts[:response]
+      super(opts[:message])
+    end
+
+    def status
+      response && response.status
+    end
+  end
+
+  module Errors
+    class AccessDenied < NetworkError; end
+  end
+end

data/lib/reso_web_api/resources.rb

@@ -0,0 +1,21 @@
+module ResoWebApi
+  # Grants access to a service's resources in a convenient manner
+  module Resources
+    STANDARD_RESOURCES = {
+      properties: 'Property',
+      members:    'Member',
+      offices:    'Office',
+      media:      'Media'
+    }
+
+    STANDARD_RESOURCES.each do |method, resource|
+      define_method(method) do
+        resources[resource]
+      end
+    end
+
+    def resources
+      service
+    end
+  end
+end

data/lib/reso_web_api/version.rb

@@ -0,0 +1,3 @@
+module ResoWebApi
+  VERSION = "0.2.0"
+end

data/reso_web_api.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "reso_web_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "reso_web_api"
+  spec.version       = ResoWebApi::VERSION
+  spec.authors       = ["Christoph Wagner"]
+  spec.email         = ["christoph@wrstudios.com"]
+
+  spec.summary       = %q{RESO Web API for Ruby}
+  spec.description   = %q{Allows communication with MLS systems conforming to the RESO Web API standard}
+  spec.homepage      = "https://github.com/wrstudios/reso_web_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  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 'odata4', '~> 0.9.1'
+  spec.add_dependency 'dry-initializer', '~> 1.4.1'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: reso_web_api
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Christoph Wagner
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+- !ruby/object:Gem::Dependency
+  name: odata4
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Allows communication with MLS systems conforming to the RESO Web API
+  standard
+email:
+- christoph@wrstudios.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/reso_web_api.rb
+- lib/reso_web_api/authentication.rb
+- lib/reso_web_api/authentication/access.rb
+- lib/reso_web_api/authentication/auth_strategy.rb
+- lib/reso_web_api/authentication/middleware.rb
+- lib/reso_web_api/authentication/token_auth.rb
+- lib/reso_web_api/base_client.rb
+- lib/reso_web_api/client.rb
+- lib/reso_web_api/errors.rb
+- lib/reso_web_api/resources.rb
+- lib/reso_web_api/version.rb
+- reso_web_api.gemspec
+homepage: https://github.com/wrstudios/reso_web_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: RESO Web API for Ruby
+test_files: []