rentjuicer 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+spec/rentjuicer_api_key.yml

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tom Cocca
+
+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.rdoc

@@ -0,0 +1,17 @@
+= rentjuicer
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Tom Cocca. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rentjuicer"
+    gem.summary = %Q{ruby api wrapper for rentjuice}
+    gem.description = %Q{Ruby API wrapper for rentjuice.com built with httparty}
+    gem.email = "tom.cocca@gmail.com"
+    gem.homepage = "http://github.com/tcocca/rentjuicer"
+    gem.authors = ["tcocca"]
+    gem.add_dependency "httparty", ">= 0.6.1"
+    gem.add_dependency "hashie", ">= 0.3.1"
+    gem.add_dependency "rash", ">= 0.1.1"
+    gem.add_dependency "will_paginate", ">= 2.3.4"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "webmock", ">= 1.3.4"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rentjuicer #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/rentjuicer/client.rb

@@ -0,0 +1,15 @@
+module Rentjuicer
+  class Client
+    
+    include HTTParty
+    format :json
+    
+    attr_accessor :api_key
+    
+    def initialize(api_key)
+      self.api_key = api_key
+      self.class.base_uri "app.rentjuice.com/api/#{self.api_key}"
+    end
+    
+  end
+end

data/lib/rentjuicer/error.rb

@@ -0,0 +1,17 @@
+module Rentjuicer
+  class Error < Exception
+    
+    attr_reader :code, :error
+    
+    def initialize(code, error)
+      @code = code
+      @error = error
+      super(message)
+    end
+    
+    def message
+      "Rentjuicer Error: #{@error} (code: #{@code})"
+    end
+    
+  end
+end

data/lib/rentjuicer/lead.rb

@@ -0,0 +1,21 @@
+module Rentjuicer
+  class Lead
+    
+    attr_accessor :client, :resource
+    
+    def initialize(client)
+      self.client = client
+      self.resource = "/leads.add.json"
+    end
+    
+    def create(name, params = {}, raise_error = false)
+      params.merge!(:name => name)
+      Response.new(self.client.class.get(resource, :query => params), raise_error)
+    end
+    
+    def create!(name, params = {})
+      create(name, params = {}, true)
+    end
+    
+  end
+end

data/lib/rentjuicer/listing.rb

@@ -0,0 +1,57 @@
+module Rentjuicer
+  class Listing
+    
+    def initialize(listing)
+      listing.keys.each do |key, value|
+        self.instance_variable_set('@'+key, listing.send(key))
+        self.class.send(:define_method, key, proc{self.instance_variable_get("@#{key}")})
+      end
+    end
+
+    def similar_listings(rj, limit = 6)
+      search_params = {
+        :limit => limit + 1,
+        :min_rent => self.rent * 0.9,
+        :max_rent => self.rent * 1.1,
+        :min_beds => if (self.bedrooms - 1) <= 0 then 0 else (self.bedrooms - 1) end,
+        :max_beds => self.bedrooms + 1,
+        :min_baths => if (self.bathrooms - 1) <= 0 then 0 else (self.bathrooms - 1) end,
+        :max_baths => self.bathrooms + 1,
+        :neighborhoods => self.neighborhood_name
+      }
+
+      similar = []
+      listings = Rentjuicer::Listings.new(rj)
+      listings.search(search_params).properties.each do |prop|
+        similar << prop unless prop.id == self.id
+        break if similar.size == limit
+      end
+      similar
+    end
+
+    def id
+      rentjuice_id
+    end
+
+    def thumb_pic
+      main_pic[:thumbnail] if sorted_photos
+    end
+
+    def first_pic
+      main_pic[:fullsize] if sorted_photos
+    end
+
+    def main_pic
+      sorted_photos.detect(lambda {return sorted_photos.first}) { |photo| photo[:main_photo] }
+    end
+
+    def sorted_photos
+      @sorted_pictures ||= self.photos.sort_by{|photo| photo[:sort_order]} if photos
+    end
+
+    def neighborhood_name
+      self.neighborhoods.first unless neighborhoods.blank?
+    end
+
+  end
+end

data/lib/rentjuicer/listings.rb

@@ -0,0 +1,86 @@
+module Rentjuicer
+  class Listings
+    
+    attr_accessor :client, :resource
+    
+    def initialize(client)
+      self.client = client
+      self.resource = "/listings.json"
+    end
+    
+    def find_by_id(listing_id)
+      SearchResponse.new(self.client.class.get(resource, :query => {:rentjuice_id => listing_id}))
+    end
+    
+    def search(params = {})
+      limit = params[:limit] || 20
+      params[:order_by] ||= "rent"
+      params[:order_direction] ||= "asc"
+      SearchResponse.new(self.client.class.get(resource, :query => params), limit)
+    end
+    
+    def featured(params = {})
+      params.merge!(:featured => 1)
+      search(params)
+    end
+    
+    def find_all(params = {})
+      per_page = params[:limit] || 20
+      all_listings = []
+      
+      response = search(params)
+      if response.success?
+        all_listings << response.properties
+        total_pages = (response.body.total_count/per_page.to_f).ceil
+        if total_pages > 1
+          (2..total_pages).each do |page_num|
+            resp = search(params.merge(:page => page_num))
+            if resp.success?
+              all_listings << resp.properties
+            end
+          end
+        end
+      end
+      all_listings.flatten
+    end
+    
+    def find_all_by_ids(listing_ids)
+      all_listings = []
+      listing_ids.split(',').in_groups_of(500).each do |group|
+        group.delete_if{|x| x.nil?}
+        all_listings << find_all(:rentjuice_id => group.join(','))
+      end
+      all_listings.flatten
+    end
+    
+    class SearchResponse < Rentjuicer::Response
+      
+      attr_accessor :limit, :paginator_cache
+      
+      def initialize(response, limit = 20)
+        super(response)
+        @limit = limit
+      end
+      
+      def properties
+        return [] if @body.listings.blank?
+        props = []
+        @body.listings.each do |listing|
+          props << Rentjuicer::Listing.new(listing)
+        end
+        props
+      end
+      
+      def paginator
+        paginator_cache if paginator_cache
+        self.paginator_cache = WillPaginate::Collection.create(
+          @body.page, 
+          @limit, 
+          (@body.total_count ? @body.total_count : properties.size)) do |pager|
+          pager.replace properties
+        end
+      end
+    end
+    
+  end
+end

data/lib/rentjuicer/neighborhoods.rb

@@ -0,0 +1,16 @@
+module Rentjuicer
+  class Neighborhoods
+    
+    attr_accessor :client, :resource
+    
+    def initialize(client)
+      self.client = client
+      self.resource = "/neighborhoods.json"
+    end
+    
+    def find_all
+      Response.new(self.client.class.get(resource))
+    end
+    
+  end
+end

data/lib/rentjuicer/response.rb

@@ -0,0 +1,35 @@
+module Rentjuicer
+  class Response
+    
+    attr_accessor :body
+    
+    def initialize(response, raise_error = true)
+      @body = rash_response(response)
+      raise Error.new(@body.code, @body.message) if !success? && raise_error
+    end
+    
+    def success?
+      @body.status == "ok"
+    end
+    
+    private
+    
+    def rash_response(response)
+      if response.is_a?(Array)
+        self.body = []
+        response.each do |b|
+          if b.is_a?(Hash)
+            self.body << Hashie::Rash.new(b)
+          else
+            self.body << b
+          end
+        end
+      elsif response.is_a?(Hash)
+        self.body = Hashie::Rash.new(response)
+      else
+        self.body = response
+      end
+    end
+    
+  end
+end

data/lib/rentjuicer.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'httparty'
+require 'hashie'
+require 'rash'
+require 'will_paginate'
+
+require 'rentjuicer/client'
+require 'rentjuicer/response'
+require 'rentjuicer/error'
+require 'rentjuicer/lead'
+require 'rentjuicer/listings'
+require 'rentjuicer/listing'
+require 'rentjuicer/neighborhoods'

data/spec/rentjuicer/client_spec.rb

@@ -0,0 +1,17 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Rentjuicer::Client do
+  
+  before do
+    @rentjuicer = new_rentjuicer
+  end
+  
+  it "should set the api_key" do
+    @rentjuicer.api_key.should == RENTJUICER_API_KEY
+  end
+  
+  it "should set the base uri" do
+    @rentjuicer.class.base_uri.should == "http://app.rentjuice.com/api/#{RENTJUICER_API_KEY}"
+  end
+  
+end

data/spec/rentjuicer/error_spec.rb

@@ -0,0 +1,17 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Rentjuicer::Error do
+  
+  before do
+    @rentjuicer = new_rentjuicer
+    @neighborhoods = Rentjuicer::Neighborhoods.new(@rentjuicer)
+    mock_get(@neighborhoods.resource, 'error.json')
+  end
+  
+  it "should return an error" do
+    lambda {
+      @neighborhoods.find_all
+    }.should raise_exception(Rentjuicer::Error, "Rentjuicer Error: Invalid API key. (code: 1)")
+  end
+  
+end

data/spec/rentjuicer/lead_spec.rb

@@ -0,0 +1,55 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Rentjuicer::Lead do
+  before do
+    @rentjuicer = new_rentjuicer
+    @lead = Rentjuicer::Lead.new(@rentjuicer)
+  end
+  
+  context "a successfull creation" do
+    before do
+      mock_get(@lead.resource, 'lead.json', :name => 'Tom Cocca')
+    end
+  
+    it "should not return an error on create" do
+      lambda {
+        @lead.create('Tom Cocca')
+      }.should_not raise_exception
+    end
+    
+    it "should not return an error on create!" do
+      lambda {
+        @lead.create!('Tom Cocca')
+      }.should_not raise_exception
+    end
+    
+    it "should be a success?" do
+      @response = @lead.create('Tom Cocca')
+      @response.success?.should be_true
+    end
+  end
+  
+  
+  context "unsucessful submission" do
+    before do
+      mock_get(@lead.resource, 'lead_error.json', :name => '')
+    end
+    
+    it "should return an error on create!" do
+      lambda {
+        @lead.create!('')
+      }.should raise_exception(Rentjuicer::Error, "Rentjuicer Error: invalid parameter - `name` is required (code: 3)")
+    end
+    
+    it "should not return an error on create" do
+      lambda {
+        @lead.create('')
+      }.should_not raise_exception
+    end
+    
+    it "should not be a successful submission on create" do
+      @result = @lead.create('')
+      @result.success?.should be_false
+    end
+  end
+end

data/spec/rentjuicer/listing_spec.rb

@@ -0,0 +1,97 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Rentjuicer::Listing do
+  
+  before do
+    @listing = Rentjuicer::Listing.new(valid_listing_rash)
+  end
+  
+  it "should create methods from all hash keys" do
+    @listing.should respond_to(
+      "address", "agent_phone", "bedrooms", "latitude", "title", "photos", "featured", "url", "date_available", 
+      "square_footage", "agent_email", "rental_terms", "street", "fee", "property_type", "cross_street", "unit_number", 
+      "custom_fields", "last_updated", "features", "bathrooms", "rent", "neighborhoods", "street_number", "floor_number", 
+      "longitude", "description", "agent_name", "rentjuice_id"
+    )
+  end
+  
+  it "should return rentjuice_id for id" do
+    @listing.id.should == 200306
+  end
+  
+  it "should return the first neighborhood in the array for neighborhood_name" do
+    @listing.neighborhood_name.should == 'South Boston'
+  end
+  
+  it "should return the thumbnail url of the first sorted pic for thumb_pic" do
+    @listing.thumb_pic.should == "http://static.rentjuice.com/frames/2010/08/25/3008760.jpg"
+  end
+  
+  it "should return the fullsize url of the first sorted pic for first_pic" do
+    @listing.first_pic.should == "http://static.rentjuice.com/frames/2010/08/25/3008757.jpg"
+  end
+  
+  it "should return the first element of the sorted photos for main_pic" do
+    @listing.main_pic.should == Hashie::Rash.new({
+      "thumbnail" => "http://static.rentjuice.com/frames/2010/08/25/3008760.jpg",
+      "sort_order" => 1,
+      "main_photo" => true,
+      "fullsize" => "http://static.rentjuice.com/frames/2010/08/25/3008757.jpg"
+    })
+  end
+  
+  it "should return an array of photos sorted by the sort_order key for sorted_photos" do
+    @listing.sorted_photos.should == sorted_photos_array
+  end
+  
+  context "default similar listings" do
+    before do
+      @rentjuicer = new_rentjuicer
+      mock_get('/listings.json', 'listings.json', {
+          :neighborhoods => "South Boston", 
+          :min_rent => "2250.0",
+          :max_rent => "2750.0",
+          :min_beds => "2",
+          :max_beds => "4",
+          :min_baths => "0",
+          :max_baths => "2",
+          :limit => "7",
+          :order_by => "rent",
+          :order_direction => "asc"
+      })
+      @similar_props = @listing.similar_listings(@rentjuicer)
+    end
+    
+    it "should return an array of listings" do
+      @similar_props.should be_kind_of(Array)
+      @similar_props.should have_at_most(6).listings
+      @similar_props.collect{|x| x.id}.should_not include(@listing.id)
+    end
+  end
+  
+  context "similar listings with custom limit" do
+    before do
+      @rentjuicer = new_rentjuicer
+      mock_get('/listings.json', 'listings.json', {
+          :neighborhoods => "South Boston", 
+          :min_rent => "2250.0",
+          :max_rent => "2750.0",
+          :min_beds => "2",
+          :max_beds => "4",
+          :min_baths => "0",
+          :max_baths => "2",
+          :limit => "5",
+          :order_by => "rent",
+          :order_direction => "asc"
+      })
+      @similar_props = @listing.similar_listings(@rentjuicer, 4)
+    end
+    
+    it "should return an array of listings" do
+      @similar_props.should be_kind_of(Array)
+      @similar_props.should have_at_most(4).listings
+      @similar_props.collect{|x| x.id}.should_not include(@listing.id)
+    end
+  end
+  
+end