rentjuicer 0.4.0 → 0.4.1

data/README.rdoc

@@ -158,7 +158,7 @@ and add require 'rentjuicer_extensions' to your config/environment.rb file.
 Now you can call @results.properties.first.neighborhood_list to get a nice comma separated list of neighborhood names.
 This class allows you to create any methods you want on a listing.
 
-=== The second group returns Rentjuicer::Listing responses
+==== The second group returns Rentjuicer::Listing responses
 
   :find_by_id - takes a rentjuice_id for a listing and returns a Rentjuicer::Listing if the property is found or nil if it is not found
   @property = @listings.find_by_id(18830) # returns either nil or a Rentjuicer::Listing
@@ -167,11 +167,31 @@ These methods just return a Rentjuicer::Listing or an array of Rentjuicer::Listi
 These methods work by making subsequent calls to go through the pagination of the results for you and compaction each request into a single array.  Use these methods only when absolutely necessary as they are expensive to use as they will make repeated api calls through the entire set of pages, so if there are 20 listings per page and 571 pages, this will make 29 api requests which is obviously quite time consuming.
 
   :find_all - take a hash of search params (same as :search above) and returns every result on every page of the response in an array 
-  :find_all_by_ids - takes a comma separated string of rentjuice_ids and returns every listing in an array
+  :find_all_by_ids - takes a comma separated string OR an array of rentjuice_ids and returns every listing in an array
   
   @results = @listings.find_all(:neighborhoods => 'Boston') # returns an array of every listing in Boston in a single array - no need for pagination
   @results = @listings.find_all_by_ids('200306,200221,200214,200121,199646,198560,197542,197540,197538) # returns an array of all of those listings that can be found
 
+==== Searching MLS listings 
+
+Rentjuice provides the option to return MLS listings for your account if you pass the include_mls=1 argument to the search.
+
+Rentjuicer adds some extra methods to the Rentjuicer::Listings::SearchResponse and Rentjuicer::Listing for working with the mls listings from Rentjuice due to the requirement that you display the attribution for each property.
+
+These attributions are typically in the following format:
+
+  "This listing courtesy of Holly Kampler at Classic Realty<br \/><br \/>The property listing data and information, or the Images, set forth herein were provided to MLS Property Information Network, Inc. from third party sources, including sellers, lessors and public records, and were compiled by MLS Property Information Network, Inc.  The property listing data and information, and the Images, are for the personal, non-commercial use of consumers having a good faith interest in purchasing or leasing listed properties of the type displayed to them and may not be used for any purpose other than to identify prospective properties which such consumers may have a good faith interest in purchasing or leasing.  MLS Property Information Network, Inc. and its subscribers disclaim any and all representations and warranties as to the accuracy of the property listing data and information, or as to the accuracy of any of the Images, set forth herein."
+
+===== On Rentjuicer::Listing we have added the following methods:
+
+  :mls_listing? - return true if the listing has a #source_type and that #source_type == 'mls'  (as opposed to internal)
+  :courtesy_of - returns the first half the attribution string after being split on the '<br /><br />'
+  :mls_disclaimer - returns the second half the attribution string after being split on the '<br /><br />'
+
+===== On Rentjuicer::Listings::SearchResponse we have added the following methods:
+
+  :mls_results? - return true if and listing in the #properties array is a mls_listing (uses #mls_listing? on the listing)
+  :mls_disclaimers - returns a array of the uniq #mls_disclaimer responses off the listings in the #properties array
 
 == Note on Patches/Pull Requests
  

data/Rakefile

@@ -10,6 +10,7 @@ begin
     gem.email = "tom.cocca@gmail.com"
     gem.homepage = "http://github.com/tcocca/rentjuicer"
     gem.authors = ["tcocca"]
+    gem.add_dependency "activesupport", '~> 2.3'
     gem.add_dependency "httparty", ">= 0.6.1"
     gem.add_dependency "hashie", ">= 0.4.0"
     gem.add_dependency "rash", ">= 0.2.0"

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/lib/rentjuicer/listing.rb

@@ -53,5 +53,23 @@ module Rentjuicer
       self.neighborhoods.first unless neighborhoods.blank?
     end
 
+    def mls_listing?
+      source_type && source_type == "mls"
+    end
+
+    def mls_disclaimer
+      attribution_split[1] if mls_listing?
+    end
+
+    def courtesy_of
+      attribution_split[0] if mls_listing?
+    end
+
+    private
+
+    def attribution_split
+      @attribution_parts ||= attribution.split('<br /><br />')
+    end
+
   end
 end

data/lib/rentjuicer/listings.rb

@@ -46,8 +46,9 @@ module Rentjuicer
     end
     
     def find_all_by_ids(listing_ids)
+      listing_ids = listing_ids.split(',') if listing_ids.is_a?(String)
       all_listings = []
-      listing_ids.split(',').in_groups_of(500).each do |group|
+      listing_ids.in_groups_of(500, false).each do |group|
         group.delete_if{|x| x.nil?}
         all_listings << find_all(:rentjuice_id => group.join(','))
       end
@@ -72,6 +73,14 @@ module Rentjuicer
         props
       end
       
+      def mls_results?
+        properties.any?{|property| property.mls_listing?}
+      end
+      
+      def mls_disclaimers
+        properties.collect{|property| property.mls_disclaimer}.compact.uniq
+      end
+      
       def paginator
         paginator_cache if paginator_cache
         self.paginator_cache = WillPaginate::Collection.create(

data/lib/rentjuicer.rb

@@ -1,4 +1,5 @@
 require 'rubygems'
+gem 'activesupport', '~> 2.3'
 require 'httparty'
 require 'hashie'
 require 'rash'

data/rentjuicer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rentjuicer}
-  s.version = "0.4.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["tcocca"]
-  s.date = %q{2010-10-06}
+  s.date = %q{2010-12-08}
   s.description = %q{Ruby API wrapper for rentjuice.com built with httparty}
   s.email = %q{tom.cocca@gmail.com}
   s.extra_rdoc_files = [
@@ -51,6 +51,7 @@ Gem::Specification.new do |s|
      "spec/responses/lead.json",
      "spec/responses/lead_error.json",
      "spec/responses/listings.json",
+     "spec/responses/mls_listings.json",
      "spec/responses/neighborhoods.json",
      "spec/responses/no_listings.json",
      "spec/spec.opts",
@@ -81,6 +82,7 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, ["~> 2.3"])
       s.add_runtime_dependency(%q<httparty>, [">= 0.6.1"])
       s.add_runtime_dependency(%q<hashie>, [">= 0.4.0"])
       s.add_runtime_dependency(%q<rash>, [">= 0.2.0"])
@@ -88,6 +90,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_development_dependency(%q<webmock>, [">= 1.3.4"])
     else
+      s.add_dependency(%q<activesupport>, ["~> 2.3"])
       s.add_dependency(%q<httparty>, [">= 0.6.1"])
       s.add_dependency(%q<hashie>, [">= 0.4.0"])
       s.add_dependency(%q<rash>, [">= 0.2.0"])
@@ -96,6 +99,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<webmock>, [">= 1.3.4"])
     end
   else
+    s.add_dependency(%q<activesupport>, ["~> 2.3"])
     s.add_dependency(%q<httparty>, [">= 0.6.1"])
     s.add_dependency(%q<hashie>, [">= 0.4.0"])
     s.add_dependency(%q<rash>, [">= 0.2.0"])

data/spec/rentjuicer/listing_spec.rb

@@ -94,4 +94,19 @@ describe Rentjuicer::Listing do
     end
   end
   
+  context "mls_listing" do
+    before do
+      @listing = Rentjuicer::Listing.new(valid_listing_rash.merge({
+        "source_type" => "mls",
+        "source_name" => "MLS PIN",
+        "attribution" => "This listing courtesy of Holly Kampler at Classic Realty<br \/><br \/>The property listing data and information, or the Images, set forth herein were provided to MLS Property Information Network, Inc. from third party sources, including sellers, lessors and public records, and were compiled by MLS Property Information Network, Inc.  The property listing data and information, and the Images, are for the personal, non-commercial use of consumers having a good faith interest in purchasing or leasing listed properties of the type displayed to them and may not be used for any purpose other than to identify prospective properties which such consumers may have a good faith interest in purchasing or leasing.  MLS Property Information Network, Inc. and its subscribers disclaim any and all representations and warranties as to the accuracy of the property listing data and information, or as to the accuracy of any of the Images, set forth herein."
+      }))
+    end
+    
+    it { @listing.mls_listing?.should be_true }
+    it { @listing.source_name.should == "MLS PIN" }
+    it { @listing.attribution.should == "This listing courtesy of Holly Kampler at Classic Realty<br \/><br \/>The property listing data and information, or the Images, set forth herein were provided to MLS Property Information Network, Inc. from third party sources, including sellers, lessors and public records, and were compiled by MLS Property Information Network, Inc.  The property listing data and information, and the Images, are for the personal, non-commercial use of consumers having a good faith interest in purchasing or leasing listed properties of the type displayed to them and may not be used for any purpose other than to identify prospective properties which such consumers may have a good faith interest in purchasing or leasing.  MLS Property Information Network, Inc. and its subscribers disclaim any and all representations and warranties as to the accuracy of the property listing data and information, or as to the accuracy of any of the Images, set forth herein."}
+    it { @listing.courtesy_of.should == "This listing courtesy of Holly Kampler at Classic Realty"}
+    it { @listing.mls_disclaimer.should == "The property listing data and information, or the Images, set forth herein were provided to MLS Property Information Network, Inc. from third party sources, including sellers, lessors and public records, and were compiled by MLS Property Information Network, Inc.  The property listing data and information, and the Images, are for the personal, non-commercial use of consumers having a good faith interest in purchasing or leasing listed properties of the type displayed to them and may not be used for any purpose other than to identify prospective properties which such consumers may have a good faith interest in purchasing or leasing.  MLS Property Information Network, Inc. and its subscribers disclaim any and all representations and warranties as to the accuracy of the property listing data and information, or as to the accuracy of any of the Images, set forth herein."}
+  end
 end

data/spec/rentjuicer/listings_spec.rb

@@ -38,6 +38,27 @@ describe Rentjuicer::Listing do
     end
   end
   
+  context "mls_search" do
+    before do
+      mock_get('/listings.json', 'mls_listings.json', {
+        :include_mls => "1",
+        :order_by => "rent",
+        :order_direction => "asc"
+      })
+      @result = @listings.search(:include_mls => "1")
+    end
+    
+    context "search response" do
+      it { @result.mls_results?.should be_true }
+      
+      it "should return an array of uniq property mls_disclaimers" do
+        @result.mls_disclaimers.should == [
+          "The property listing data and information, or the Images, set forth herein were provided to MLS Property Information Network, Inc. from third party sources, including sellers, lessors and public records, and were compiled by MLS Property Information Network, Inc.  The property listing data and information, and the Images, are for the personal, non-commercial use of consumers having a good faith interest in purchasing or leasing listed properties of the type displayed to them and may not be used for any purpose other than to identify prospective properties which such consumers may have a good faith interest in purchasing or leasing.  MLS Property Information Network, Inc. and its subscribers disclaim any and all representations and warranties as to the accuracy of the property listing data and information, or as to the accuracy of any of the Images, set forth herein."
+        ]
+      end
+    end
+  end
+  
   context "find_by_id" do
     before do
       mock_get('/listings.json', 'find_by_id.json', {
@@ -99,12 +120,33 @@ describe Rentjuicer::Listing do
       @properties = @listings.find_all_by_ids(@find_ids.join(','))
     end
     
-    it { @properties.should be_kind_of(Array) }
+    context "passing a string of ids" do
+      before do
+        @properties = @listings.find_all_by_ids(@find_ids.join(','))
+      end
+      
+      it { @properties.should be_kind_of(Array) }
+      
+      it "should only return properties for requested ids" do
+        @property_ids = @properties.collect{|p| p.rentjuice_id}
+        @find_ids.each do |id|
+          @property_ids.should include(id)
+        end
+      end
+    end
     
-    it "should only return properties for requested ids" do
-      @property_ids = @properties.collect{|p| p.rentjuice_id}
-      @find_ids.each do |id|
-        @property_ids.should include(id)
+    context "passing an array of ids" do
+      before do
+        @properties = @listings.find_all_by_ids(@find_ids)
+      end
+      
+      it { @properties.should be_kind_of(Array) }
+      
+      it "should only return properties for requested ids" do
+        @property_ids = @properties.collect{|p| p.rentjuice_id}
+        @find_ids.each do |id|
+          @property_ids.should include(id)
+        end
       end
     end
   end