you_got_listed 0.2.0

data/lib/you_got_listed/error.rb

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

data/lib/you_got_listed/lead.rb

@@ -0,0 +1,13 @@
+module YouGotListed
+  class Lead < Resource
+    
+    def create(lead_params = {}, raise_error = false)
+      process_post("/leads/insert.php", lead_params, raise_error)
+    end
+    
+    def create!(lead_params = {})
+      create(lead_params, true)
+    end
+    
+  end
+end

data/lib/you_got_listed/listing.rb

@@ -0,0 +1,73 @@
+module YouGotListed
+  class Listing
+    
+    attr_accessor :client
+    
+    def initialize(listing, client)
+      listing.each do |key, value|
+        self.instance_variable_set('@'+key, value)
+        unless ["latitude", "longitude"].include?(key)
+          self.class.send(:define_method, key, proc{self.instance_variable_get("@#{key}")})
+        end
+      end
+      self.client = client
+    end
+    
+    def similar_listings(limit = 6)
+      min_baths = ((self.baths.to_i - 1) <= 0 ? 0 : (self.baths.to_i - 1))
+      max_baths = self.baths.to_i + 1
+      min_rent = (self.price.to_i * 0.9).to_i
+      max_rent = (self.price.to_i * 1.1).to_i
+      search_params = {
+        :limit => limit + 1,
+        :min_rent => min_rent,
+        :max_rent => max_rent,
+        :min_bed => ((self.beds.to_i - 1) <= 0 ? 0 : (self.beds.to_i - 1)),
+        :max_bed => self.beds.to_i + 1,
+        :baths => [min_baths, self.baths, max_baths].join(','),
+        :city_neighborhood => self.city_neighborhood
+      }
+      
+      similar = []
+      listings = YouGotListed::Listings.new(self.client)
+      listings.search(search_params).properties.each do |prop|
+        similar << prop unless prop.id == self.id
+        break if similar.size == limit
+      end
+      similar
+    end
+    
+    def town_neighborhood
+      str = self.city
+      str += " - #{neighborhood}" unless self.neighborhood.blank?
+      str
+    end
+    
+    def city_neighborhood
+      str = self.city
+      str += ":#{neighborhood}" unless self.neighborhood.blank?
+      str
+    end
+    
+    def pictures
+      self.photos.photo unless self.photos.blank? || self.photos.photo.blank?
+    end
+    
+    def main_picture
+      pictures.first if pictures
+    end
+    
+    def mls_listing?
+      source && source == "MLS"
+    end
+    
+    def latitude
+      @latitude.to_f unless @latitude.blank?
+    end
+    
+    def longitude
+      @longitude.to_f unless @longitude.blank?
+    end
+    
+  end
+end

data/lib/you_got_listed/listings.rb

@@ -0,0 +1,110 @@
+module YouGotListed
+  class Listings < Resource
+    
+    def search(params = {})
+      params[:page_count] ||= 20
+      params[:page_index] ||= 1
+      params[:sort_name] ||= "rent"
+      params[:sort_dir] ||= "asc"
+      params[:detail_level] ||= 2
+      SearchResponse.new(self.client.perform_request(:get, '/rentals/search.php', params), self.client, params[:page_count])
+    end
+    
+    def featured(params = {}, featured_tag = 'Featured Rentals')
+      if params[:tags].blank?
+        params[:tags] = featured_tag
+      else
+        params[:tags] += (params[:tags].ends_with?(',') ? featured_tag : ",#{featured_tag}")
+      end
+      search(params)
+    end
+    
+    def find_by_id(listing_id)
+      params = {:listing_id => listing_id, :detail_level => 2}
+      response = SearchResponse.new(self.client.perform_request(:get, '/rentals/search.php', params), self.client, 20)
+      (response.success? && response.properties.size > 0) ? response.properties.first : nil
+    end
+    
+    def find_all(params = {})
+      params[:page_count] ||= 20
+      all_listings = []
+      response = search(params)
+      if response.success?
+        all_listings << response.properties
+        total_pages = (response.ygl_response.total.to_i/params[:page_count].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, include_off_market = true)
+      listing_ids = listing_ids.split(',') if listing_ids.is_a?(String)
+      mls_ids = []
+      ygl_ids = []
+      all_listings = []
+      listing_ids.each do |list_id|
+        if list_id =~ /[A-Z]{3}-[0-9]{3}-[0-9]{3}/
+          ygl_ids << list_id
+        else
+          mls_ids << list_id
+        end
+      end
+      ygl_ids.in_groups_of(500, false).each_with_index do |group, index|
+        search_params = {:listing_ids => group.join(','), :page_count => 500, :page_index => (index + 1)}
+        search_params[:include_off_market] = 1 if include_off_market
+        group.delete_if{|x| x.nil?}
+        all_listings << find_all({:listing_ids => group.join(','), :page_count => 500, :page_index => (index + 1)})
+      end
+      mls_ids.each do |mls_id|
+        all_listings << find_by_id(mls_id)
+      end
+      all_listings.compact.flatten
+    end
+    
+    class SearchResponse < YouGotListed::Response
+      
+      attr_accessor :limit, :paginator_cache, :client
+      
+      def initialize(response, client, limit = 20, raise_error = false)
+        super(response, raise_error)
+        self.limit = limit
+        self.client = client
+      end
+      
+      def properties
+        return [] if self.ygl_response.listings.blank?
+        props = []
+        if self.ygl_response.listings.listing.is_a?(Array)
+          self.ygl_response.listings.listing.each do |listing|
+            props << YouGotListed::Listing.new(listing, self.client)
+          end
+        else
+          props << YouGotListed::Listing.new(self.ygl_response.listings.listing, self.client)
+        end
+        props
+      end
+      
+      def mls_results?
+        @has_mls_properties ||= properties.any?{|property| property.mls_listing?}
+      end
+      
+      def paginator
+        paginator_cache if paginator_cache
+        self.paginator_cache = WillPaginate::Collection.create(
+          (self.ygl_response.page_index ? self.ygl_response.page_index : 1), 
+          self.limit, 
+          (self.ygl_response.total ? self.ygl_response.total : properties.size)) do |pager|
+          pager.replace properties
+        end
+      end
+    end
+    
+  end
+end

data/lib/you_got_listed/resource.rb

@@ -0,0 +1,19 @@
+module YouGotListed
+  class Resource
+    
+    attr_accessor :client
+    
+    def initialize(client)
+      self.client = client
+    end
+    
+    def process_get(path, params = {}, raise_error = false)
+      Response.new(self.client.perform_request(:get, path, params), raise_error)
+    end
+    
+    def process_post(path, params = {}, raise_error = false)
+      Response.new(self.client.perform_request(:post, path, params), raise_error)
+    end
+    
+  end
+end

data/lib/you_got_listed/response.rb

@@ -0,0 +1,25 @@
+module YouGotListed
+  class Response
+    
+    attr_accessor :ygl_response
+    
+    def initialize(response, raise_error = true)
+      rash = Hashie::Rash.new(response)
+      self.ygl_response = rash.ygl_response
+      raise Error.new(self.ygl_response.response_code, self.ygl_response.error) if !success? && raise_error
+    end
+    
+    def success?
+      self.ygl_response.response_code.to_i < 300
+    end
+    
+    def method_missing(method_name, *args)
+      if self.ygl_response.respond_to?(method_name)
+        self.ygl_response.send(method_name)
+      else
+        super
+      end
+    end
+    
+  end
+end

data/lib/you_got_listed/version.rb

@@ -0,0 +1,3 @@
+module YouGotListed
+  VERSION = '0.2.0'
+end

data/spec/fixtures/responses/error.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" standalone="yes"?> 
+<YGLResponse responseCode="998"><Error>Invalid key.</Error></YGLResponse>

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'you_got_listed'
+require 'rspec'
+require 'webmock/rspec'
+require 'vcr'
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end
+
+VCR.config do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.stub_with :webmock
+  c.default_cassette_options = { :record => :new_episodes }
+end

data/spec/support/complex_helper.rb

@@ -0,0 +1,82 @@
+def valid_complex_rash
+  Hashie::Rash.new({
+    'id' => 'CP-000-676',
+    'name' => 'Church Park',
+    'addresses' => Hashie::Rash.new({
+      'address' => [
+        Hashie::Rash.new({
+          'id' => '1051',
+          'street_number' => '221',
+          'street_name' => 'Massachusetts Ave.`',
+          'city' => 'Boston',
+          'state' => 'MA',
+          'zip' => '02115',
+          'neighborhood' => 'Back Bay',
+          'latitude' => '42.344133',
+          'longitude' => '-71.086222'
+        }),
+        Hashie::Rash.new({
+          'id' => '1052',
+          'street_number' => '255',
+          'street_name' => 'Massachusetts Ave.`',
+          'city' => 'Boston',
+          'state' => 'MA',
+          'zip' => '02115',
+          'neighborhood' => 'Back Bay',
+          'latitude' => '42.343736',
+          'longitude' => '-71.086023'
+        }),
+        Hashie::Rash.new({
+          'id' => '1053',
+          'street_number' => '199',
+          'street_name' => 'Massachusetts Ave.`',
+          'city' => 'Boston',
+          'state' => 'MA',
+          'zip' => '02115',
+          'neighborhood' => 'Back Bay',
+          'latitude' => '42.344390',
+          'longitude' => '-71.086350'
+        })
+      ]
+    }),
+    'public_notes' => 'Our apartments mingle casual elegance with contemporary details. Gourmet kitchens with ceramic tile floors, granite counter tops, Gaggeneau, GE and Miele convection ovens and dishwashers, Sub Zero and GE refrigerators, Birchwood cabinets, and built-in pantries. Living areas with hardwood floors and crown molding, elegant baths, walk-in closets, private balconies and spectacular views make it home.',
+    'photos' => Hashie::Rash.new({
+      'photo' => [
+        'http://ygl-photos.s3.amazonaws.com/AC-000-010%2F516795.jpg',
+        'http://ygl-photos.s3.amazonaws.com/AC-000-010%2F516796.jpg',
+        'http://ygl-photos.s3.amazonaws.com/AC-000-010%2F516797.jpg',
+        'http://ygl-photos.s3.amazonaws.com/AC-000-010%2F516798.jpg',
+        'http://ygl-photos.s3.amazonaws.com/AC-000-010%2F516799.jpg',
+        'http://ygl-photos.s3.amazonaws.com/AC-000-010%2F516800.jpg'
+      ]
+    }),
+    'listings' => Hashie::Rash.new({
+      'listing' => [
+        Hashie::Rash.new({
+          'listing_id' => 'BOS-009-741',
+          'address_id' => '1051',
+          'type' => 'R',
+          'source' => 'F',
+          'price' => '1423',
+          'beds' => '1',
+          'baths' => '1',
+          'square_feet' => '',
+          'unit_level' => '',
+          'photo' => 'http://ygl-photos.s3.amazonaws.com/AC-000-010%2F65131.jpg'
+        }),
+        Hashie::Rash.new({
+          'listing_id' => 'BOS-331-359',
+          'address_id' => '1053',
+          'type' => 'R',
+          'source' => 'F',
+          'price' => '1423',
+          'beds' => '1',
+          'baths' => '1',
+          'square_feet' => '',
+          'unit_level' => '',
+          'photo' => 'http://ygl-photos.s3.amazonaws.com/AC-000-010%2F65130.jpg'
+        })
+      ]
+    })
+  })
+end

data/spec/support/listing_helper.rb

@@ -0,0 +1,59 @@
+def valid_listing_rash
+  Hashie::Rash.new({
+    "unit_level" => nil, 
+    "pet" => "Unknown", 
+    "include_hot_water" => "1", 
+    "square_footage" => nil, 
+    "external_id" => nil, 
+    "zip" => "02215", 
+    "student_policy" => "Student Ok", 
+    "building_id" => "1278", 
+    "parking" => "Available", 
+    "split" => "0", 
+    "city" => "Boston", 
+    "neighborhood" => "Fenway", 
+    "fee" => "None", 
+    "heat_source" => nil, 
+    "street_name" => "Park Dr.", 
+    "price" => "800", 
+    "building_type" => "Apartment Complex", 
+    "include_heat" => "1", 
+    "beds" => "0.5", 
+    "id" => "BOS-182-933", 
+    "agency_id" => "AC-000-010", 
+    "status" => "ONMARKET", 
+    "source" => "YGL", 
+    "longitude" => "-71.104427", 
+    "available_date" => "01/01/2011", 
+    "include_electricity" => "0", 
+    "latitude" => "42.346182", 
+    "street_number" => "463", 
+    "unit" => "17", 
+    "include_gas" => "0", 
+    "photos" => Hashie::Rash.new({
+      "photo" => [
+        "http://yougotlistings.com/photos/AC-000-103/500141.jpg", 
+        "http://yougotlistings.com/photos/AC-000-103/500143.jpg", 
+        "http://yougotlistings.com/photos/AC-000-103/500144.jpg", 
+        "http://yougotlistings.com/photos/AC-000-103/500145.jpg", 
+        "http://yougotlistings.com/photos/AC-000-103/500146.jpg", 
+        "http://yougotlistings.com/photos/AC-000-103/500147.jpg", 
+        "http://yougotlistings.com/photos/AC-000-103/500148.jpg", 
+        "http://yougotlistings.com/photos/AC-000-103/500149.jpg", 
+        "http://yougotlistings.com/photos/AC-000-103/500150.jpg", 
+        "http://yougotlistings.com/photos/AC-000-103/500151.jpg", 
+        "http://yougotlistings.com/photos/AC-000-103/500156.jpg", 
+        "http://yougotlistings.com/photos/AC-000-103/500160.jpg", 
+        "http://yougotlistings.com/photos/AC-000-103/500161.jpg", 
+        "http://yougotlistings.com/photos/AC-000-103/500162.jpg", 
+        "http://yougotlistings.com/photos/AC-000-103/500164.jpg", 
+        "http://yougotlistings.com/photos/AC-000-103/500166.jpg", 
+        "http://yougotlistings.com/photos/AC-000-103/500167.jpg", 
+        "http://yougotlistings.com/photos/AC-000-103/500168.jpg", 
+        "http://yougotlistings.com/photos/AC-000-103/140824.jpg"
+      ]
+    }), 
+    "state" => "MA", 
+    "baths" => "1"
+  })
+end

data/spec/support/webmock_helper.rb

@@ -0,0 +1,26 @@
+YGL_API_KEY = YAML.load_file(File.join(File.dirname(__FILE__), '/../you_got_listed_api_key.yml'))["api_key"]
+
+def new_ygl
+  YouGotListed::Client.new(YGL_API_KEY)
+end
+
+def mock_get(base_uri, method, response_fixture, params = {})
+  url = base_uri + method
+  unless params.blank?
+    stub_http_request(:get, url).with(:query => params).to_return(:body => mocked_response(response_fixture))
+  else
+    stub_http_request(:get, url).to_return(:body => mocked_response(response_fixture))
+  end
+end
+
+def mocked_response(response_fixture)
+  File.read(File.join(File.dirname(__FILE__), '/../fixtures/responses', "#{response_fixture}"))
+end
+
+def httparty_get(base_uri, method, response_fixture, params = {})
+  mock_get(base_uri, method, response_fixture, params)
+  url = base_uri + method
+  VCR.use_cassette(method.gsub('/', '_')) do
+    HTTParty.get url, :format => :xml, :query => params
+  end
+end