reso_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d953ced633c6228fbb7dd33b4698d499121580a3d7f44b077d7571c6694adcc6
+  data.tar.gz: 3301e9b25719782a3c3ccd4a665668c0cec274edb540a8d8b679ed3930148afc
+SHA512:
+  metadata.gz: 107d644298494ff5d5cc3145713ff23ca8b442c296db4611a2502943600eb858b972fd83263743575923cbb96e09f2d871c25bc2cbc5ca78a901dc832a113d9e
+  data.tar.gz: ca3d8603f3e3d259169a94da52308c3ea3aa3df6d6c429cc30eeb82f5bd6a972dc86743b19465a9fbbd719f349bac40321fab6694642b92b6fecfaa46ccde5c3

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

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 medlund@mac.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_api.gemspec
+gemspec

data/README.md

@@ -0,0 +1,219 @@
+# RESO API
+
+Ruby wrapper for easy interaction with a RESO Web API compliant server.
+
+This document does not documentation for the RESO Web API. More information about the RESO Web API standard can be found on [RESO][]'s website.
+
+[RESO]: https://www.reso.org/reso-web-api/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'reso_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install reso_api
+
+## Usage
+
+### Authentication and Access
+
+To set up an API client and access a service, you need three pieces of information:
+
+- Client ID
+- Client Secret
+- Base API endpoint
+
+You pass these three pieces of information when creating an instance of an API client:
+
+```ruby
+client = RESO::API::Client.new(client_id: client_id, client_secret: client_secret, base_url: base_url)
+```
+
+When calling API endpoints using the initialized client, it will automatically fetch and manage access and authentication tokens transparently in the background.
+
+### Resources
+
+#### Supported
+
+- Property
+
+#### Planned 
+
+- Media
+- Member
+- Office
+
+### Retrieving Metadata
+
+You can fetch metadata for supported resources:
+
+```ruby
+client.metadata
+```
+
+The response will be an EDMX xml schema document that matches the [RESO Data Dictionary standard][].
+
+[RESO Data Dictionary standard]: https://www.reso.org/data-dictionary/
+
+### Listing Requests
+
+The simplest query is simply to call `properties` on the initialized client: 
+
+```ruby
+client.properties
+```
+
+The API will return a JSON response with an array of listing JSON objects.
+
+### Getting a single listing
+
+You can look up a single listing by sending a query with the listing's unique id (ListingKey). 
+
+```ruby
+client.property('3yd-BINDER-5508272')
+```
+
+The response will be a single listing JSON object.
+
+### Running queries
+
+#### $filter
+
+You can use `$filter` to send simple and complex queries to get a subset of listings depending on your particular use case.
+
+To use `$filter`, pass it an expression in the format `FieldName operator Value`. For example, this query will return listings where the `StandardStatus` field equals (`eq`) the value `'Active'`:
+
+```ruby
+client.properties(filter: "StandardStatus eq 'Active'")
+```
+
+You can combine expressions together with or and and to perform more complex queries.
+
+```ruby
+client.properties(filter: "StandardStatus eq 'Active' and BrokerName eq 'Doe Brokerage'")
+```
+RESO Web API is built on the OData standard, but only requires compliant servers to support a subset of queries:
+
+| Operator   | Description            | Example                      |
+|------------|------------------------|------------------------------|
+|    `eq`    | Equals                 | `StandardStatus eq 'Active'` |
+|    `ne`    | Not equals             | `StandardStatus ne 'Active'` |
+|    `ge`    | Greater than or equals | `ListPrice ge 100000`        |
+|    `gt`    | Greater than           | `ListPrice gt 100000`        |
+|    `le`    | Less than or equals    | `ListPrice le 100000`        |
+|    `lt`    | Less than              | `ListPrice lt 100000`        |
+
+#### $select
+
+Instead of returning all of the listing fields in the response, you can use `$select` to only return specific fields you need.
+
+```ruby
+client.properties(select: "ListingKey")
+client.properties(select: "ListingKey", filter: "StandardStatus eq 'Active'")
+```
+
+You can specify multiple fields to return by adding a "," between the fields in the `$select` parameter:
+
+```ruby
+client.properties(select: "ListingKey,StandardStatus")
+```
+
+#### $orderby
+
+You can order the results by a field using `$orderby`:
+
+```ruby
+client.properties(orderby: "City desc")
+```
+
+#### Pagination, $top, and $skip
+
+The default number of results returned is 100. You can override the default limit using the `$top` parameter. The higher the number specific for `$top`, the longer the API response will take, and pay attention to that different services does enforce a cap for number of records returned.
+
+You can paginate through multiple sets of results using `$skip`, this can help you process multiple records quickly. In addition, if you use `$select` to target only certain fields, the API response time will be faster.
+
+The following example API request will get the next 200 records starting at the 500th record:
+
+```ruby
+client.properties(select: "ListingKey", top: 200, skip: 500)
+```
+
+As you paginate through very large datasets, you might notice that the higher you set `$skip` the longer it takes for the API to return results. For those use cases, you should use `$skiptoken` to process very large datasets quickly.
+
+#### Using $skiptoken for large datasets
+
+`$skiptoken` can be used in combination with `$orderby` to process large datasets. To illustrate `$skiptoken`, we will use the following request to get 5 records ordered by `ListingKey`:
+
+```ruby
+client.properties(top: 5, orderby: "ListingKey")
+```
+
+An extract of the result could be:
+
+```
+{
+    "@odata.context": "http://some.server.com/odata/$metadata#Property(ListingKey)",
+    "value": [
+      {
+          "ListingKey": "3yd-AAABORMI-2813483"
+      },
+      {
+          "ListingKey": "3yd-AAABORMI-2910696"
+      },
+      {
+          "ListingKey": "3yd-AAABORMI-3101621"
+      },
+      {
+          "ListingKey": "3yd-AAABORMI-3101967"
+      },
+      {
+          "ListingKey": "3yd-AAABORMI-3200394"
+      }
+    ]
+}
+```
+
+To get the next set of records, you would then use the value of the ListingKey field for the last record in the current set (3yd-AAABORMI-3200394) as your value for `$skiptoken`:
+
+```ruby
+client.properties(top: 5, orderby: "ListingKey", skiptoken: "3yd-AAABORMI-3200394")
+```
+
+`$skiptoken` allows you to process large datasets from the API in a sequence without sacrificing performance. The drawback is that you cannot "skip" to a random page, for that you must use the regular `$skip` parameter.
+
+## Compatibility
+
+This gem should work with any RESO Web API compliant service, but these are those that have been confirmed to work.
+
+- [ListHub](https://www.listhub.com)
+
+If you use this gem to connect to another service or MLS, please submit a pull request with that service added in alphabetical order in this list.
+
+## Acknowledgment
+
+The inspiration for this gem and the outline and examples in this README is based on the [ListHub API][].
+
+[ListHub API]: https://developer.listhub.com/api/
+
+## 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/arcticleo/reso_api. 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.
+
+## Code of Conduct
+
+Everyone interacting in the RESO API project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/arcticleo/reso_api/blob/master/CODE_OF_CONDUCT.md).

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_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_api.rb

@@ -0,0 +1,9 @@
+require "reso_api/version"
+# require "reso_api/railtie" if defined?(Rails)
+require "reso_api/config/inflections.rb"
+require "reso_api/app/models/reso.rb"
+require "reso_api/app/models/reso/api.rb"
+require "reso_api/app/models/reso/api/client.rb"
+
+module ResoApi
+end

data/lib/reso_api/app/models/reso.rb

@@ -0,0 +1,2 @@
+module RESO
+end

data/lib/reso_api/app/models/reso/api.rb

@@ -0,0 +1,2 @@
+module RESO::API
+end

data/lib/reso_api/app/models/reso/api/client.rb

@@ -0,0 +1,141 @@
+module RESO
+  module API
+    class Client
+
+      require 'net/http'
+      require 'oauth2'
+      require 'json'
+      require 'tmpdir'
+
+      attr_accessor :client_id, :client_secret, :base_url
+
+      def initialize(**opts)
+        @client_id, @client_secret, @base_url = opts.values_at(:client_id, :client_secret, :base_url)
+        validate!
+      end
+
+      def validate!
+        raise 'Missing Client ID `client_id`' if client_id.nil?
+        raise 'Missing Client Secret `client_secret`' if client_secret.nil?
+        raise 'Missing API Base URL `base_url`' if base_url.nil?
+      end
+
+      RESOURCE_KEYS = {
+        media: "MediaKey",
+        members: "MemberKey",
+        offices: "OfficeKey",
+        properties: "ListingKey"
+      }
+
+      DETAIL_ENDPOINTS = {
+        medium: "odata/Media",
+        member: "odata/Member",
+        office: "odata/Office",
+        property: "odata/Property"
+      }
+
+      FILTERABLE_ENDPOINTS = {
+        media: "odata/Media",
+        members: "odata/Member",
+        offices: "odata/Office",
+        properties: "odata/Property"
+      }
+
+      PASSTHROUGH_ENDPOINTS = {
+        metadata: "odata/$metadata"
+      }
+
+      FILTERABLE_ENDPOINTS.keys.each do |method_name|
+        define_method method_name do |*args|
+          hash = args.first.is_a?(Hash) ? args.first : {}
+          endpoint = FILTERABLE_ENDPOINTS[method_name]
+          params = {
+            "$select": hash[:select],
+            "$filter": hash[:filter],
+            "$top": hash[:top] ||= 100,
+            "$skip": hash[:skip] ||= 0,
+            "$orderby": hash[:orderby] ||= RESOURCE_KEYS[method_name],
+            "$skiptoken": hash[:skiptoken],
+            "$expand": hash[:expand],
+            "$count": hash[:count].to_s.presence
+          }.compact
+          return perform_call(endpoint, params)
+        end
+      end
+
+      DETAIL_ENDPOINTS.keys.each do |method_name|
+        define_method method_name do |*args|
+          endpoint = "#{DETAIL_ENDPOINTS[method_name]}('#{args.try(:first)}')"
+          perform_call(endpoint, nil)
+        end
+      end
+
+      PASSTHROUGH_ENDPOINTS.keys.each do |method_name|
+        define_method method_name do |*args|
+          endpoint = PASSTHROUGH_ENDPOINTS[method_name]
+          perform_call(endpoint, nil)
+        end
+      end
+
+      def oauth2_client
+        OAuth2::Client.new(
+          client_id,
+          client_secret,
+          token_url: [base_url, "oauth2/token"].join
+        )
+      end
+
+      def oauth2_token
+        payload = oauth2_payload
+        token = JWT.decode(payload.token, nil, false)
+        exp_timestamp = Hash(token.try(:first))["exp"].to_s
+        expiration = DateTime.strptime(exp_timestamp, '%s').utc rescue DateTime.now.utc
+        if expiration > DateTime.now.utc
+          return payload.token
+        else
+          @oauth2_payload = oauth2_client.client_credentials.get_token
+          File.write(oauth2_token_path, @oauth2_payload.to_hash.to_json)
+          return @oauth2_payload.token
+        end
+      end
+
+      def oauth2_token_path
+        File.join(Dir.tmpdir, [base_url.parameterize, "-oauth-token.json"].join)
+      end
+
+      def oauth2_payload
+        @oauth2_payload ||= get_oauth2_payload
+      end
+
+      def get_oauth2_payload
+        if File.exist?(oauth2_token_path)
+          persisted = File.read(oauth2_token_path)
+          payload = OAuth2::AccessToken.from_hash(oauth2_client, JSON.parse(persisted))
+        else
+          payload = oauth2_client.client_credentials.get_token
+          File.write(oauth2_token_path, payload.to_hash.to_json)
+        end
+        return payload
+      end
+
+      def uri_for_endpoint endpoint
+        return URI([base_url, endpoint].join)
+      end
+
+      def perform_call(endpoint, params)
+        uri = uri_for_endpoint(endpoint)
+        if params.present?
+          query = params.present? ? URI.encode_www_form(params).gsub("+", " ") : ""
+          uri.query && uri.query.length > 0 ? uri.query += '&' + query : uri.query = query
+        end
+        request = Net::HTTP::Get.new(uri.request_uri)
+        request['Authorization'] = "Bearer #{oauth2_token}"
+        response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+          http.request(request)
+        end
+        return JSON(response.body) rescue response.body
+      end
+
+    end
+  end
+end

data/lib/reso_api/config/inflections.rb

@@ -0,0 +1,4 @@
+ActiveSupport::Inflector.inflections(:en) do |inflect|
+  inflect.acronym "API"
+  inflect.acronym "RESO"
+end

data/lib/reso_api/version.rb

@@ -0,0 +1,3 @@
+module ResoApi
+  VERSION = "0.1.0"
+end

data/reso_api.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "reso_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "reso_api"
+  spec.version       = ResoApi::VERSION
+  spec.authors       = ["Michael Edlund"]
+  spec.email         = ["medlund@mac.com"]
+
+  spec.summary       = %q{RESO Web API Wrapper}
+  spec.description   = %q{Ruby wrapper for easy interaction with a RESO Web API compliant server.}
+  spec.homepage      = "https://github.com/arcticleo/reso_api"
+
+  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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "oauth2"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: reso_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Edlund
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-06 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for easy interaction with a RESO Web API compliant server.
+email:
+- medlund@mac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/reso_api.rb
+- lib/reso_api/app/models/reso.rb
+- lib/reso_api/app/models/reso/api.rb
+- lib/reso_api/app/models/reso/api/client.rb
+- lib/reso_api/config/inflections.rb
+- lib/reso_api/version.rb
+- reso_api.gemspec
+homepage: https://github.com/arcticleo/reso_api
+licenses: []
+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.7.6
+signing_key: 
+specification_version: 4
+summary: RESO Web API Wrapper
+test_files: []