simplyrets 1.0.7 → 2.0.0

data/lib/simplyrets.rb~

@@ -1,34 +0,0 @@
-# SimplyRets common files
-require 'simplyrets/simplyrets'
-require 'simplyrets/simplyrets/configuration'
-require 'simplyrets/simplyrets/api_error'
-require 'simplyrets/simplyrets/request'
-require 'simplyrets/simplyrets/response'
-require 'simplyrets/simplyrets/version'
-
-# Models
-require 'simplyrets/models/base_object'
-require 'simplyrets/models/street_address'
-require 'simplyrets/models/property'
-require 'simplyrets/models/listing'
-require 'simplyrets/models/open_house'
-require 'simplyrets/models/office'
-require 'simplyrets/models/agent'
-require 'simplyrets/models/sales'
-require 'simplyrets/models/school'
-require 'simplyrets/models/parking'
-require 'simplyrets/models/contact_information'
-require 'simplyrets/models/tax'
-require 'simplyrets/models/geographic_data'
-require 'simplyrets/models/broker'
-require 'simplyrets/models/mls_information'
-require 'simplyrets/models/error'
-
-# APIs
-require 'simplyrets/api/default_api'
-
-module SimplyRetsClient
-  # Initialize the default configuration
-  SimplyRets.configuration = SimplyRets::Configuration.new
-  SimplyRets.configure { |config| }
-end

data/lib/simplyrets/api/#default_api.rb#

@@ -1,146 +0,0 @@
-require "uri"
-
-module SimplyRetsClient
-  class Properties_api
-
-    # The SimplyRets Listings API
-    # This is the main endpoint for accessing your properties. View\nall of the available query parameters and make requests below!\nThe API uses Basic Authorization, which most HTTP libraries\nwill handle for you. To use the test test data (which is what\nthis pages uses), you can use the api key `simplyrets` and\nsecret `simplyrets`. Note that the test listings are not live\nMLS listings but the data, query parameters, and response\nbodies will all work the same.\n
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :q A fuzzy keyword search.\n
-    # @option opts [Integer] :minprice Filter listings by a minimum price.\n
-    # @option opts [Integer] :maxprice Filter listings by a maximum price\n
-    # @option opts [String] :agent Filter the listings returned by an agent ID.  Note, the\nAgent ID is provided by your MLS.\n
-    # @option opts [Integer] :minarea Filter listings by a minimum area size in Sq Ft.\n
-    # @option opts [Integer] :maxarea Filter listings by a maximum area size in Sq Ft.\n
-    # @option opts [Integer] :minbaths Filter listings by a minimum number of bathrooms.\n
-    # @option opts [Integer] :maxbaths Filter listings by a maximum number of bathrooms.\n
-    # @option opts [Integer] :minbeds Filter listings by a minimum number of bedrooms.\n
-    # @option opts [Integer] :maxbeds Filter listings by a maximum number of bedrooms.\n
-    # @option opts [Integer] :limit Set the number of listings to return in the response.\nThis defaults to 20 listings, and can be a maximum of 50.\nTo paginate through to the next page of listings, take a\nlook at the `offset` parameter, or the Link in the HTTP\nHeader.\n
-    # @option opts [Integer] :offset Used as a cursor for pagination. Increase the offset parameter\nby the limit to go to the next \"page\" of listings. Also take\na look at the Link HTTP Header for pre-built pagination.\n
-    # @option opts [Array<String>] :brokers Filter the listings returned by brokerage with a Broker ID.\nYou can specific multiple broker parameters. Note, the Broker\nID is provided by your MLS.\n
-    # @option opts [Array<String>] :features Filter the listings returned by specific features.  You\ncan specify multiple.\n
-    # @option opts [Array<String>] :amenities Filter the listings returned by specific amenities.  You\ncan specify multiple amenities.\n
-    # @option opts [Array<String>] :neighborhoods Filter the listings returned by specific neighborhoods and\nsubdivisions. You can specify multiple.\n
-    # @option opts [Array<String>] :points A list of latitude longitude coordinates which contain\nthe property. Our documentation generator does not yet\nsupport using a list of parameters.\n
-    # @option opts [Array<String>] :counties Filter the listings returned by specific counties. You can\nspecify multiple.\n
-    # @option opts [Array<String>] :status Filter the listings returned by a specific status. You can\nspecify multiple.\n
-    # @option opts [String] :type Request listings by a specific property type. This\ndefaults to Residential, and you can only specify multiple property types in a single query.\n
-    # @option opts [String] :sort Sort the response by a specific field. Values starting\nwith a minus (-) denote descending order, while the others\nare ascending.\n
-    # @option opts [String] :include Include a limited set of extra fields which are not found\nin the default response body\n- &#39;rooms&#39; include parameter will include\n   any additional rooms as a list.\n- &#39;pool&#39; includes an additional pool description\n- &#39;association&#39; includes additional home owners association data\n
-    # @return [Array<Listing>]
-    def self.properties(opts = {})
-      if SimplyRets.configuration.debug
-        SimplyRets.logger.debug "Calling API: DefaultApi#properties ..."
-      end
-
-      if opts[:'sort'] && !['listprice', '-listprice', 'listdate', '-listdate', 'beds', '-beds', 'baths', '-baths'].include?(opts[:'sort'])
-        fail 'invalid value for "sort", must be one of listprice, -listprice, listdate, -listdate, beds, -beds, baths, -baths'
-      end
-
-      if opts[:'include'] && !['pool', 'rooms', 'association'].include?(opts[:'include'])
-        fail 'invalid value for "include", must be one of pool, rooms, association'
-      end
-
-      # resource path
-      path = "/properties".sub('{format}','json')
-
-      # query parameters
-      query_params = {}
-      query_params[:'q'] = opts[:'q'] if opts[:'q']
-      query_params[:'minprice'] = opts[:'minprice'] if opts[:'minprice']
-      query_params[:'maxprice'] = opts[:'maxprice'] if opts[:'maxprice']
-      query_params[:'agent'] = opts[:'agent'] if opts[:'agent']
-      query_params[:'minarea'] = opts[:'minarea'] if opts[:'minarea']
-      query_params[:'maxarea'] = opts[:'maxarea'] if opts[:'maxarea']
-      query_params[:'minbaths'] = opts[:'minbaths'] if opts[:'minbaths']
-      query_params[:'maxbaths'] = opts[:'maxbaths'] if opts[:'maxbaths']
-      query_params[:'minbeds'] = opts[:'minbeds'] if opts[:'minbeds']
-      query_params[:'maxbeds'] = opts[:'maxbeds'] if opts[:'maxbeds']
-      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
-      query_params[:'offset'] = opts[:'offset'] if opts[:'offset']
-      query_params[:'brokers'] = opts[:'brokers'] if opts[:'brokers']
-      query_params[:'features'] = opts[:'features'] if opts[:'features']
-      query_params[:'amenities'] = opts[:'amenities'] if opts[:'amenities']
-      query_params[:'neighborhoods'] = opts[:'neighborhoods'] if opts[:'neighborhoods']
-      query_params[:'points'] = opts[:'points'] if opts[:'points']
-      query_params[:'counties'] = opts[:'counties'] if opts[:'counties']
-      query_params[:'status'] = opts[:'status'] if opts[:'status']
-      query_params[:'type'] = opts[:'type'] if opts[:'type']
-      query_params[:'sort'] = opts[:'sort'] if opts[:'sort']
-      query_params[:'include'] = opts[:'include'] if opts[:'include']
-
-      # header parameters
-      header_params = {}
-
-      # HTTP header 'Accept' (if needed)
-      _header_accept = []
-      _header_accept_result = SimplyRets::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
-
-      # HTTP header 'Content-Type'
-      _header_content_type = []
-      header_params['Content-Type'] = SimplyRets::Request.select_header_content_type(_header_content_type)
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-
-
-      auth_names = ['basicAuth']
-      response = SimplyRets::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make
-      result = response.deserialize('Array<Listing>')
-      if SimplyRets.configuration.debug
-        SimplyRets.logger.debug "API called: DefaultApi#properties. Result: #{result.inspect}"
-      end
-      result
-    end
-
-    # Single Listing Endpoint
-    # Use this endpoint for accessing a single listing.\n
-    # @param listing_id A listings listingId (unique indentifier).
-    # @param [Hash] opts the optional parameters
-    # @return [Listing]
-    def self.property(listing_id, opts = {})
-      if SimplyRets.configuration.debug
-        SimplyRets.logger.debug "Calling API: DefaultApi#property ..."
-      end
-
-      # verify the required parameter 'listing_id' is set
-      fail "Missing the required parameter 'listing_id' when calling property" if listing_id.nil?
-
-      # resource path
-      path = "/properties/{listingId}".sub('{format}','json').sub('{' + 'listingId' + '}', listing_id.to_s)
-
-      # query parameters
-      query_params = {}
-
-      # header parameters
-      header_params = {}
-
-      # HTTP header 'Accept' (if needed)
-      _header_accept = []
-      _header_accept_result = SimplyRets::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
-
-      # HTTP header 'Content-Type'
-      _header_content_type = []
-      header_params['Content-Type'] = SimplyRets::Request.select_header_content_type(_header_content_type)
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-
-
-      auth_names = ['basicAuth']
-      response = SimplyRets::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make
-      result = response.deserialize('Listing')
-      if SimplyRets.configuration.debug
-        SimplyRets.logger.debug "API called: DefaultApi#property. Result: #{result.inspect}"
-      end
-      result
-    end
-  end
-end

data/lib/simplyrets/simplyrets/api_error.rb

@@ -1,26 +0,0 @@
-module SimplyRetsClient
-  module SimplyRets
-    class ApiError < StandardError
-      attr_reader :code, :response_headers, :response_body
-
-      # Usage examples:
-      #   ApiError.new
-      #   ApiError.new("message")
-      #   ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
-      #   ApiError.new(:code => 404, :message => "Not Found")
-      def initialize(arg = nil)
-        if arg.is_a? Hash
-          arg.each do |k, v|
-            if k.to_s == 'message'
-              super v
-            else
-              instance_variable_set "@#{k}", v
-            end
-          end
-        else
-          super arg
-        end
-      end
-    end
-  end
-end

data/lib/simplyrets/simplyrets/configuration.rb

@@ -1,101 +0,0 @@
-require 'logger'
-
-module SimplyRetsClient
-  module SimplyRets
-    class Configuration
-      attr_accessor :scheme, :host, :base_path, :user_agent, :format, :auth_token, :inject_format, :force_ending_format
-
-      # Defines the username used with HTTP basic authentication.
-      #
-      # @return [String]
-      attr_accessor :username
-
-      # Defines the password used with HTTP basic authentication.
-      #
-      # @return [String]
-      attr_accessor :password
-
-      # Defines API keys used with API Key authentications.
-      #
-      # @return [Hash] key: parameter name, value: parameter value (API key)
-      #
-      # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
-      #   config.api_key['api_key'] = 'xxx'
-      attr_accessor :api_key
-
-      # Defines API key prefixes used with API Key authentications.
-      #
-      # @return [Hash] key: parameter name, value: API key prefix
-      #
-      # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
-      #   config.api_key_prefix['api_key'] = 'Token'
-      attr_accessor :api_key_prefix
-
-      # Set this to false to skip verifying SSL certificate when calling API from https server.
-      # Default to true.
-      #
-      # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
-      #
-      # @return [true, false]
-      attr_accessor :verify_ssl
-
-      # Set this to customize the certificate file to verify the peer.
-      #
-      # @return [String] the path to the certificate file
-      #
-      # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
-      # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
-      attr_accessor :ssl_ca_cert
-
-      # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
-      # details will be logged with `logger.debug` (see the `logger` attribute).
-      # Default to false.
-      #
-      # @return [true, false]
-      attr_accessor :debug
-
-      # Defines the logger used for debugging.
-      # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
-      #
-      # @return [#debug]
-      attr_accessor :logger
-
-      # Defines the temporary folder to store downloaded files
-      # (for API endpoints that have file response).
-      # Default to use `Tempfile`.
-      #
-      # @return [String]
-      attr_accessor :temp_folder_path
-
-      # Defines the headers to be used in HTTP requests of all API calls by default.
-      #
-      # @return [Hash]
-      attr_accessor :default_headers
-
-      # Defaults go in here..
-      def initialize
-        @format = 'json'
-        @scheme = 'https'
-        @host = 'api.simplyrets.com'
-        @base_path = '/'
-        @user_agent = "ruby-simplyrets-#{SimplyRets::VERSION}"
-        @inject_format = false
-        @force_ending_format = false
-
-        @default_headers = {
-          'Content-Type' => "application/#{@format.downcase}",
-          'User-Agent' => @user_agent
-        }
-
-        # keys for API key authentication (param-name => api-key)
-        @api_key = {}
-        @api_key_prefix = {}
-
-        @verify_ssl = true
-
-        @debug = false
-        @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
-      end
-    end
-  end
-end

data/lib/simplyrets/simplyrets/request.rb

@@ -1,248 +0,0 @@
-require 'uri'
-require 'typhoeus'
-
-module SimplyRetsClient
-  module SimplyRets
-    class Request
-      attr_accessor :host, :path, :format, :params, :body, :http_method, :headers, :form_params, :auth_names, :response
-
-      # All requests must have an HTTP method and a path
-      # Optionals parameters are :params, :headers, :body, :format, :host
-      def initialize(http_method, path, attributes = {})
-        @http_method = http_method.to_sym.downcase
-        @path = path
-
-        attributes.each { |name, value| send "#{name}=", value }
-
-        @format ||= SimplyRets.configuration.format
-        @params ||= {}
-
-        # Apply default headers
-        @headers = SimplyRets.configuration.default_headers.merge(@headers || {})
-
-        # Stick in the auth token if there is one
-        if SimplyRets.authenticated?
-          @headers.merge!({:auth_token => SimplyRets.configuration.auth_token})
-        end
-
-        update_params_for_auth!
-
-      end
-
-
-      # Update hearder and query params based on authentication settings.
-      def update_params_for_auth!
-        (@auth_names || []).each do |auth_name|
-          case auth_name
-          when 'basicAuth'
-            @headers ||= {}
-            http_auth_header = 'Basic ' + ["#{SimplyRets.configuration.username}:#{SimplyRets.configuration.password}"].pack('m').delete("\r\n")
-            @headers['Authorization'] = http_auth_header
-
-          end
-        end
-      end
-
-
-      # Get API key (with prefix if set).
-      # @param [String] param_name the parameter name of API key auth
-      def get_api_key_with_prefix(param_name)
-        if SimplyRets.configuration.api_key_prefix[param_name]
-          "#{SimplyRets.configuration.api_key_prefix[param_name]} #{SimplyRets.configuration.api_key[param_name]}"
-        else
-          SimplyRets.configuration.api_key[param_name]
-        end
-      end
-
-      # Construct the request URL.
-      def url(options = {})
-        _path = self.interpreted_path
-        _path = "/#{_path}" unless _path.start_with?('/')
-        "#{SimplyRets.configuration.scheme}://#{SimplyRets.configuration.host}#{_path}"
-      end
-
-      # Iterate over the params hash, injecting any path values into the path string
-      # e.g. /word.{format}/{word}/entries => /word.json/cat/entries
-      def interpreted_path
-        p = self.path.dup
-
-        # Stick a .{format} placeholder into the path if there isn't
-        # one already or an actual format like json or xml
-        # e.g. /words/blah => /words.{format}/blah
-        if SimplyRets.configuration.inject_format
-          unless ['.json', '.xml', '{format}'].any? {|s| p.downcase.include? s }
-            p = p.sub(/^(\/?\w+)/, "\\1.#{format}")
-          end
-        end
-
-        # Stick a .{format} placeholder on the end of the path if there isn't
-        # one already or an actual format like json or xml
-        # e.g. /words/blah => /words/blah.{format}
-        if SimplyRets.configuration.force_ending_format
-          unless ['.json', '.xml', '{format}'].any? {|s| p.downcase.include? s }
-            p = "#{p}.#{format}"
-          end
-        end
-
-        p = p.sub("{format}", self.format.to_s)
-
-        URI.encode [SimplyRets.configuration.base_path, p].join("/").gsub(/\/+/, '/')
-      end
-
-      # If body is an object, JSONify it before making the actual request.
-      # For form parameters, remove empty value
-      def outgoing_body
-        # http form
-        if headers['Content-Type'] == 'application/x-www-form-urlencoded'
-          data = form_params.dup
-          data.each do |key, value|
-            data[key] = value.to_s if value && !value.is_a?(File) # remove emtpy form parameter
-          end
-        elsif @body # http body is JSON
-          data = @body.is_a?(String) ? @body : @body.to_json
-        else
-          data = nil
-        end
-
-        if SimplyRets.configuration.debug
-          SimplyRets.logger.debug "HTTP request body param ~BEGIN~\n#{data}\n~END~\n"
-        end
-
-        data
-      end
-
-      def make
-        request_options = {
-          :method => self.http_method,
-          :headers => self.headers,
-          :params => self.params,
-          :ssl_verifypeer => SimplyRets.configuration.verify_ssl,
-          :cainfo => SimplyRets.configuration.ssl_ca_cert,
-          :verbose => SimplyRets.configuration.debug
-        }
-
-        if [:post, :patch, :put, :delete].include?(self.http_method)
-          request_options.update :body => self.outgoing_body
-        end
-
-        raw = Typhoeus::Request.new(self.url, request_options).run
-
-        @response = Response.new(raw)
-
-        if SimplyRets.configuration.debug
-          SimplyRets.logger.debug "HTTP response body ~BEGIN~\n#{@response.body}\n~END~\n"
-        end
-
-        # record as last response
-        SimplyRets.last_response = @response
-
-        unless @response.success?
-          fail ApiError.new(:code => @response.code,
-                            :response_headers => @response.headers,
-                            :response_body => @response.body),
-               @response.status_message
-        end
-
-        @response
-      end
-
-      def response_code_pretty
-        return unless @response
-        @response.code.to_s
-      end
-
-      def response_headers_pretty
-        return unless @response
-        # JSON.pretty_generate(@response.headers).gsub(/\n/, '<br/>') # <- This was for RestClient
-        @response.headers.gsub(/\n/, '<br/>') # <- This is for Typhoeus
-      end
-
-      # return 'Accept' based on an array of accept provided
-      # @param [Array] header_accept_array Array fo 'Accept'
-      # @return String Accept (e.g. application/json)
-      def self.select_header_accept header_accept_array
-        if header_accept_array.empty?
-          return
-        elsif header_accept_array.any?{ |s| s.casecmp('application/json')==0 }
-          'application/json' # look for json data by default
-        else
-          header_accept_array.join(',')
-        end
-      end
-
-      # return the content type based on an array of content-type provided
-      # @param [Array] content_type_array Array fo content-type
-      # @return String Content-Type (e.g. application/json)
-      def self.select_header_content_type content_type_array
-        if content_type_array.empty?
-          'application/json' # use application/json by default
-        elsif content_type_array.any?{ |s| s.casecmp('application/json')==0 }
-          'application/json' # use application/json if it's included
-        else
-          content_type_array[0]; # otherwise, use the first one
-        end
-      end
-
-      # static method to convert object (array, hash, object, etc) to JSON string
-      # @param model object to be converted into JSON string
-      # @return string JSON string representation of the object
-      def self.object_to_http_body model
-        return if model.nil?
-        _body = nil
-        if model.is_a?(Array)
-          _body = model.map{|m| object_to_hash(m) }
-        else
-          _body = object_to_hash(model)
-        end
-        _body.to_json
-      end
-
-      # static method to convert object(non-array) to hash
-      # @param obj object to be converted into JSON string
-      # @return string JSON string representation of the object
-      def self.object_to_hash obj
-        if obj.respond_to?(:to_hash)
-          obj.to_hash
-        else
-          obj
-        end
-      end
-
-    end
-  end
-end
-
-# PATCH: array parameter rendering
-#
-# Typheous defaults to rendering array query parameters with
-# an index:
-#
-# ?points[0]=23.232,-98.232&points[1]=23.232,-98.232
-#
-# The simplyrets api uses the form:
-#
-# ?points=23.232,-98.232&points=23.232,-98.232
-#
-# this monkey-patch removes the array index when the query
-# parameter is rendered.
-module Ethon
-  class Easy
-    module Queryable
-      private
-      def recursively_generate_pairs(h, prefix, pairs)
-        case h
-        when Hash
-          h.each_pair do |k,v|
-            key = prefix.nil? ? k : "#{prefix}"
-            pairs_for(v, key, pairs)
-          end
-        when Array
-          h.each_with_index do |v, i|
-            key = "#{prefix}"
-            pairs_for(v, key, pairs)
-          end
-        end
-      end
-    end
-  end
-end