simplyrets 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6c9398d25929ede70fc2f027ba8a048b72983fd
+  data.tar.gz: 9b7f142e7814cac26d553800a96505e171ce8ae8
+SHA512:
+  metadata.gz: 51d0f11bcc6eecd244d3ce9694396a335e90cbfc71a6a73d777d693be593545dbae2cc1b7baaeaecf1926082e055601560b3967853fcd47f9128e20481110f50
+  data.tar.gz: 432870f3d25ca223aea79c22e60127a015efddba29edf708662815f172158824619b00175eee1b253648d88e7bf03a465949d34e63a24eb5a7c9edfc349c0999

data/#example.rb#

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+%w(rubygems simplyrets).each {|lib| require lib}
+%w(rubygems simplyrets).each {|models| require models}
+
+require "simplyrets"
+require "properties_api"
+require "listing"
+
+p "SimplyRETS Ruby SDK"
+
+SimplyRets.configure do |config|
+  config.username = 'simplyrets'
+  config.password = 'simplyrets'
+end
+
+# Properties
+listings = Properties_api.properties({:minbeds => 2,:brokers => [ "COLD09" ]})
+listings.each do |l|
+  p l.property['bedrooms']
+  p l.office['brokerid']
+end
+
+
+# Single Properties
+# Single Listing
+p = Properties_api.property(47638976)
+Agentlist 47638976
+p "#{p.geo['lat']}, #{p.geo['lng']}"

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify dependencies in simplyrets.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    simplyrets (0.1)
+      addressable (>= 2.3.4)
+      json (>= 1.8)
+      typhoeus (>= 0.2.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.7)
+    ethon (0.7.3)
+      ffi (>= 1.3.0)
+    ffi (1.9.8)
+    json (1.8.2)
+    rake (10.4.2)
+    typhoeus (0.7.1)
+      ethon (>= 0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  rake
+  simplyrets!

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 SimplyRETS Inc. <support@simplyrets.com>
+
+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.org

@@ -0,0 +1,109 @@
+#+AUTHOR: SimplyRETS, Christopher Reichert, Cody Reichert
+#+TITLE: SimplyRETS Ruby SDK (Beta)
+
+The official Ruby SDK for the [[https://simplrets.com][SimplyRETS]] Listings API.
+
+SimplyRETS provides a modern and simple interface for building robust
+applications and websites with Real Estate data.
+
+** Installation
+
+   Clone the repo or install the =simplyrets= gem:
+
+   #+BEGIN_SRC bash
+     $ git clone git@github.com/SimplyRETS/simplyrets-ruby-sdk
+   #+END_SRC
+   or
+   #+BEGIN_SRC bash
+     $ gem install simplyrets
+   #+END_SRC
+
+
+** Quick Start
+
+   Here's a quick example to set up the client and make a request:
+
+   #+BEGIN_SRC ruby
+     %w(rubygems simplyrets).each {|lib| require lib}
+     %w(rubygems simplyrets).each {|models| require models}
+
+     require "simplyrets"
+     require "properties_api"
+     require "listing"
+
+     SimplyRets.configure do |config|
+       config.username = 'simplyrets'
+       config.password = 'simplyrets'
+     end
+
+     # all properties
+     ps = Properties_api.properties()
+     p ps
+   #+END_SRC
+
+
+** Setup the client
+
+   To start using the SDK, require =simplyrets= in your gemspec and
+   configure a client by setting your API key and API secret (we have
+   demo credentials available you can use for free!). Here's a short
+   example:
+
+   #+BEGIN_SRC ruby
+     require 'simplyrets'
+
+     SimplyRets.configure do |config|
+       config.username = 'simplyrets'
+       config.password = 'simplyrets'
+     end
+   #+END_SRC
+
+
+** Examples: Making Requests
+
+   Once you have instantiated the API Client, you can use the
+   Properties API to make requests for multiple or single listings.
+
+   Request all listings with no filters:
+   #+BEGIN_SRC ruby
+     require 'properties_api'
+
+     ps = Properties_api.properties()
+     p ps
+   #+END_SRC
+
+   Request a single listing by id:
+   #+BEGIN_SRC ruby
+     l = Properties_api.property(mls_id=19548526)
+     p l.mls
+   #+END_SRC
+
+
+   Multiple query parameters can be sent to the API to request more
+   refined results:
+   #+BEGIN_SRC ruby
+     # listings with minprice of $700,000 and minbeds of 4
+     ps = Properties_api.properties({:minprice => 700000, :minbeds => 4})
+     p ps
+   #+END_SRC
+
+   Sending back points to get listings in a geographical area:
+   #+BEGIN_SRC ruby
+     # listings within geographics points
+     points = ["29.723837146389066,-95.69778442382812" ,"29.938275329718987,-95.778442382812" ,"29.938275329718987,-95.32974243164061","29.723837146389066,-95.32974243164061"]
+     ps = Properties_api.properties({:points => points})
+     p ps
+   #+END_SRC
+
+
+** Additional Info
+
+   View the complete interactive API on [[https://docs.simplyrets.com/api/index.html][the docs page]]. Here you can
+   find all the available query parameters and the complete response
+   body. You can even see the URL made for that request.
+
+
+** Support
+
+   For support regarding the API or bugs in the SDK, can contact us at
+   support (at) simplyrets (dot) com - or leave an issue on the [[https://github.com/simplyrets/simplyrets-ruby-sdk][Github page]]!

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/example.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+%w(rubygems simplyrets).each {|lib| require lib}
+%w(rubygems simplyrets).each {|models| require models}
+
+require "simplyrets"
+require "properties_api"
+require "listing"
+
+p "SimplyRETS Ruby SDK"
+
+SimplyRets.configure do |config|
+  config.username = 'simplyrets'
+  config.password = 'simplyrets'
+end
+
+# Properties
+listings = Properties_api.properties({:minbeds => 2,:brokers => [ "SR1234", "ACME12" ]})
+listings.each do |l|
+  p l.property['bedrooms']
+  p l.office['brokerid']
+end
+
+# Single Listing
+prop = Properties_api.property(47639002)
+p "#{prop.geo['lat']}, #{prop.geo['lng']}"

data/lib/monkey.rb

@@ -0,0 +1,90 @@
+# module SimplyRets
+  class Object
+
+    unless Object.method_defined? :blank?
+      def blank?
+        respond_to?(:empty?) ? empty? : !self
+      end
+    end
+
+    unless Object.method_defined? :present?
+      def present?
+        !blank?
+      end
+    end
+
+  end
+
+  class String
+
+    unless String.method_defined? :underscore
+      def underscore
+        self.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+      end
+    end
+
+    unless String.method_defined? :camelize
+      def camelize(first_letter_in_uppercase = true)
+        if first_letter_in_uppercase != :lower
+          self.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+        else
+          self.to_s[0].chr.downcase + camelize(self)[1..-1]
+        end
+      end
+    end
+
+  end
+
+  class Hash
+
+    unless Hash.method_defined? :stringify_keys
+      def stringify_keys
+        inject({}) do |options, (key, value)|
+          options[key.to_s] = value
+          options
+        end
+      end
+    end
+
+    unless Hash.method_defined? :stringify_keys!
+      def stringify_keys!
+        self.replace(self.stringify_keys)
+      end
+    end
+
+    unless Hash.method_defined? :symbolize_keys
+      def symbolize_keys
+        inject({}) do |options, (key, value)|
+          options[(key.to_sym rescue key) || key] = value
+          options
+        end
+      end
+    end
+
+    unless Hash.method_defined? :symbolize_keys!
+      def symbolize_keys!
+        self.replace(self.symbolize_keys)
+      end
+    end
+
+    unless Hash.method_defined? :symbolize_and_underscore_keys
+      def symbolize_and_underscore_keys
+        inject({}) do |options, (key, value)|
+          options[(key.to_s.underscore.to_sym rescue key) || key] = value
+          options
+        end
+      end
+    end
+
+    unless Hash.method_defined? :symbolize_and_underscore_keys!
+      def symbolize_and_underscore_keys!
+        self.replace(self.symbolize_and_underscore_keys)
+      end
+    end
+
+  end
+# end

data/lib/properties_api.rb

@@ -0,0 +1,75 @@
+require "uri"
+
+class Properties_api
+  basePath = "https://api.simplyrets.com"
+
+  def self.escapeString(string)
+    URI.encode(string.to_s)
+  end
+
+  def self.properties (opts={})
+    query_param_keys = [:brokers,:features,:amenities,:agent,:maxarea,
+                        :minarea,:minprice,:minbaths,:maxbeds,:minbeds,
+                        :neighborhoods,:points,:counties,:status,:type,:q]
+
+    # set default values and merge with input
+    options = {
+      :brokers => nil ,
+      :features => nil ,
+      :amenities => nil ,
+      :agent => nil ,
+      :maxarea => nil ,
+      :minarea => nil ,
+      :minprice => nil ,
+      :minbaths => nil ,
+      :maxbeds => nil ,
+      :minbeds => nil ,
+      :neighborhoods => nil ,
+      :points => nil ,
+      :counties => nil ,
+      :status => nil ,
+      :type => nil ,
+      :q => nil }.merge(opts)
+
+    #resource path
+    path = "/properties".sub('{format}','json')
+
+    # pull querystring keys from options
+    queryopts = options.select do |key,value|
+      query_param_keys.include? key
+    end
+
+    headers = nil
+    post_body = nil
+    response = SimplyRets::Request.new(:GET, path,{:params=>queryopts, :headers=>headers, :body=>post_body }).make.body
+    response.map {|response|Listing.new(response)}
+
+  end
+
+  def self.property (mls_id=nil,opts={})
+     query_param_keys = []
+
+     # verify existence of params
+     raise "mls_id is required" if mls_id.nil?
+
+     # set default values and merge with input
+     options = {
+       :mls_id => nil
+     }.merge(opts)
+
+     #resource path
+     path = "/properties/{mlsId}".sub('{format}','json').sub('{' + 'mlsId' + '}', escapeString(mls_id))
+
+     # pull querystring keys from options
+     queryopts = options.select do |key,value|
+       query_param_keys.include? key
+     end
+
+     headers = nil
+     post_body = nil
+     response = SimplyRets::Request.new(:GET, path, {:params=>queryopts,:headers=>headers, :body=>post_body }).make.body
+     Listing.new(response)
+
+  end
+
+end

data/lib/simplyrets.rb

@@ -0,0 +1,57 @@
+
+require 'monkey'
+require 'simplyrets/configuration'
+require 'simplyrets/request'
+require 'simplyrets/response'
+require 'simplyrets/version'
+require 'logger'
+
+module SimplyRets
+
+  class << self
+    attr_accessor :logger
+
+    # A SimplyRets configuration object. Must act like a hash and
+    # return sensible values for all SimplyRets configuration
+    # options. See SimplyRets::Configuration.
+    attr_accessor :configuration
+
+    attr_accessor :resources
+
+    # Call this method to modify defaults in your initializers.
+    #
+    # @example
+    #   SimplyRets.configure do |config|
+    #     config.username = 'simplyrets'
+    #     config.password = 'simplyrets'
+    #     config.format = 'json'         # optional, defaults to 'json'
+    #   end
+    #
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration) if block_given?
+
+      # Configure logger.  Default to use Rails
+      self.logger ||= configuration.logger || (defined?(Rails) ? Rails.logger : Logger.new(STDOUT))
+
+      # remove :// from scheme
+      configuration.scheme.sub!(/:\/\//, '')
+
+      # remove http(s):// and anything after a slash
+      configuration.host.sub!(/https?:\/\//, '')
+      configuration.host = configuration.host.split('/').first
+
+      # Add leading and trailing slashes to base_path
+      configuration.base_path = "/#{configuration.base_path}".gsub(/\/+/, '/')
+      configuration.base_path = "" if configuration.base_path == "/"
+    end
+
+  end
+
+end
+
+class ServerError < StandardError
+end
+
+class ClientError < StandardError
+end