simplyrets 0.1 → 1.0.0

data/lib/simplyrets/simplyrets/request.rb

@@ -0,0 +1,213 @@
+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

data/lib/simplyrets/simplyrets/response.rb

@@ -0,0 +1,156 @@
+module SimplyRetsClient
+  module SimplyRets
+    class Response
+      require 'json'
+      require 'date'
+      require 'tempfile'
+
+      attr_accessor :raw
+
+      def initialize(raw)
+        self.raw = raw
+      end
+
+      def code
+        raw.code
+      end
+
+      def status_message
+        raw.status_message
+      end
+
+      def body
+        raw.body
+      end
+
+      def success?
+        raw.success?
+      end
+
+      # Deserialize the raw response body to the given return type.
+      #
+      # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
+      def deserialize(return_type)
+        return nil if body.nil? || body.empty?
+
+        # handle file downloading - save response body into a tmp file and return the File instance
+        return download_file if return_type == 'File'
+
+        # ensuring a default content type
+        content_type = raw.headers['Content-Type'] || 'application/json'
+
+        unless content_type.start_with?('application/json')
+          fail "Content-Type is not supported: #{content_type}"
+        end
+
+        begin
+          data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
+        rescue JSON::ParserError => e
+          if %w(String Date DateTime).include?(return_type)
+            data = body
+          else
+            raise e
+          end
+        end
+
+        convert_to_type data, return_type
+      end
+
+      # Convert data to the given return type.
+      def convert_to_type(data, return_type)
+        return nil if data.nil?
+        case return_type
+        when 'String'
+          data.to_s
+        when 'Integer'
+          data.to_i
+        when 'Float'
+          data.to_f
+        when 'BOOLEAN'
+          data == true
+        when 'DateTime'
+          # parse date time (expecting ISO 8601 format)
+          DateTime.parse data
+        when 'Date'
+          # parse date time (expecting ISO 8601 format)
+          Date.parse data
+        when 'Object'
+          # generic object, return directly
+          data
+        when /\AArray<(.+)>\z/
+          # e.g. Array<Pet>
+          sub_type = $1
+          data.map {|item| convert_to_type(item, sub_type) }
+        when /\AHash\<String, (.+)\>\z/
+          # e.g. Hash<String, Integer>
+          sub_type = $1
+          {}.tap do |hash|
+            data.each {|k, v| hash[k] = convert_to_type(v, sub_type) }
+          end
+        else
+          # models, e.g. Pet
+          SimplyRetsClient.const_get(return_type).new.tap do |model|
+            model.build_from_hash data
+          end
+        end
+      end
+
+      # Save response body into a file in (the defined) temporary folder, using the filename
+      # from the "Content-Disposition" header if provided, otherwise a random filename.
+      #
+      # @see Configuration#temp_folder_path
+      # @return [File] the file downloaded
+      def download_file
+        tmp_file = Tempfile.new '', SimplyRets.configuration.temp_folder_path
+        content_disposition = raw.headers['Content-Disposition']
+        if content_disposition
+          filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+          path = File.join File.dirname(tmp_file), filename
+        else
+          path = tmp_file.path
+        end
+        # close and delete temp file
+        tmp_file.close!
+
+        File.open(path, 'w') { |file| file.write(raw.body) }
+        SimplyRets.logger.info "File written to #{path}. Please move the file to a proper folder for further processing and delete the temp afterwards"
+        return File.new(path)
+      end
+
+      # `headers_hash` is a Typhoeus-specific extension of Hash,
+      # so simplify it back into a regular old Hash.
+      def headers
+        h = {}
+        raw.headers_hash.each {|k,v| h[k] = v }
+        h
+      end
+
+      # Extract the response format from the header hash
+      # e.g. {'Content-Type' => 'application/json'}
+      def format
+        headers['Content-Type'].split("/").last.downcase
+      end
+
+      def json?
+        format == 'json'
+      end
+
+      def xml?
+        format == 'xml'
+      end
+
+      def pretty_body
+        return unless body
+        if format == 'json'
+          JSON.pretty_generate(JSON.parse(body)).gsub(/\n/, '<br/>')
+        else
+          body
+        end
+      end
+
+      def pretty_headers
+        JSON.pretty_generate(headers).gsub(/\n/, '<br/>')
+      end
+    end
+  end
+end

data/lib/simplyrets/simplyrets/version.rb

@@ -0,0 +1,5 @@
+module SimplyRetsClient
+  module SimplyRets
+    VERSION = "1.0.0"
+  end
+end

data/simplyrets.gemspec

@@ -1,25 +1,32 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-$:.push File.expand_path("../models", __FILE__)
-require "simplyrets/version"
+require "simplyrets/simplyrets/version"
 
 Gem::Specification.new do |s|
+
   s.name        = "simplyrets"
-  s.version     = SimplyRets::VERSION
+  s.version     = SimplyRetsClient::SimplyRets::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Christopher Reichert", "Cody Reichert"]
   s.email       = ["christopher@simplyrets.com", "cody@simplyrets.com"]
   s.homepage    = "https://simplyrets.com"
   s.summary     = %q{SimplyRETS Ruby SDK}
   s.description = %q{This gem provides a SimplyRETS SDK for creating real estate software with RETS data}
+  s.license     = "MIT"
 
-  s.add_dependency 'typhoeus', '>=0.2.1'
-  s.add_dependency 'addressable', '>=2.3.4'
-  s.add_dependency 'json', '>=1.8'
+  s.add_runtime_dependency 'typhoeus', '~> 0.2', '>= 0.2.1'
+  s.add_runtime_dependency 'json', '~> 1.4', '>= 1.4.6'
 
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rspec', '~> 3.2', '>= 3.2.0'
+  s.add_development_dependency 'vcr', '~> 2.9', '>= 2.9.3'
+  s.add_development_dependency 'webmock', '~> 1.6', '>= 1.6.2'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.10'
 
   s.files         = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
-  s.require_paths = ["lib", "models"]
+  #s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simplyrets
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 1.0.0
 platform: ruby
 authors:
 - Christopher Reichert
@@ -9,12 +9,15 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-23 00:00:00.000000000 Z
+date: 2015-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.1
@@ -22,65 +25,172 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.1
 - !ruby/object:Gem::Dependency
-  name: addressable
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.4
+        version: 1.4.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.4
+        version: 1.4.6
 - !ruby/object:Gem::Dependency
-  name: json
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :runtime
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 1.6.2
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: autotest
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.4.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.4.6
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: autotest-rails-pure
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.2
+- !ruby/object:Gem::Dependency
+  name: autotest-growl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.16
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.16
+- !ruby/object:Gem::Dependency
+  name: autotest-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.10
 description: This gem provides a SimplyRETS SDK for creating real estate software
   with RETS data
 email:
@@ -90,41 +200,48 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- "#example.rb#"
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.org
 - Rakefile
 - example.rb
-- lib/monkey.rb
-- lib/properties_api.rb
 - lib/simplyrets.rb
-- lib/simplyrets.rb~
-- lib/simplyrets/configuration.rb
-- lib/simplyrets/request.rb
-- lib/simplyrets/response.rb
-- lib/simplyrets/version.rb
-- models/agent.rb
-- models/contactinformation.rb
-- models/geographicdata.rb
-- models/listing.rb
-- models/mlsinformation.rb
-- models/office.rb
-- models/property.rb
-- models/school.rb
-- models/streetaddress.rb
-- models/tax.rb
-- pkg/simplyrets-0.1.gem
+- lib/simplyrets/#listing.rb#
+- lib/simplyrets/api/default_api.rb
+- lib/simplyrets/listing.rb~
+- lib/simplyrets/models/agent.rb
+- lib/simplyrets/models/base_object.rb
+- lib/simplyrets/models/broker.rb
+- lib/simplyrets/models/contact_information.rb
+- lib/simplyrets/models/error.rb
+- lib/simplyrets/models/geographic_data.rb
+- lib/simplyrets/models/listing.rb
+- lib/simplyrets/models/listing.rb~
+- lib/simplyrets/models/mls_information.rb
+- lib/simplyrets/models/office.rb
+- lib/simplyrets/models/open_house.rb
+- lib/simplyrets/models/parking.rb
+- lib/simplyrets/models/property.rb
+- lib/simplyrets/models/sales.rb
+- lib/simplyrets/models/school.rb
+- lib/simplyrets/models/street_address.rb
+- lib/simplyrets/models/tax.rb
+- lib/simplyrets/simplyrets.rb
+- lib/simplyrets/simplyrets/api_error.rb
+- lib/simplyrets/simplyrets/configuration.rb
+- lib/simplyrets/simplyrets/request.rb
+- lib/simplyrets/simplyrets/response.rb
+- lib/simplyrets/simplyrets/version.rb
 - simplyrets.gemspec
 homepage: https://simplyrets.com
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
-- models
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="