mls 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0238b89c67be7c1edb92e93c8f7f8679ba0728eb
-  data.tar.gz: ae42cc8446967251336c714fb277504ef026785e
+  metadata.gz: a331b7024dd4a8a7511c62cdada76b4cf718d9a1
+  data.tar.gz: a5f2066901baacf9976b43c8648c23d6c68357df
 SHA512:
-  metadata.gz: 526627382897b88bc1fe1fc2137a09ff7786f2e2b256941bfae0236a1e3a3132af3c9e473db237202ce890d92c0ec653132742ac38b95dbba33edf6fc1ae3cbc
-  data.tar.gz: e5c6cf46883d6e4249466f0c0f0291a91d0ae2c8dca2e4bf73722cbfa590a17806258b2fa26835aea56f00bee927aee98299436ae41ebc1c5a3291b36e707069
+  metadata.gz: 4efe6ad46a1c9f8a5fc2eb8510f9cce67597d467c1e019ab551b0eff79b0ae5870b8eae54ae3b8391feb629616bd3a393ba331e774f8514d2951d5a955ddff6f
+  data.tar.gz: 956edb5fded23ff4dcdd15fc3a5ad10440ba574c10a0aac975733595a12e42e18633e366c50b50ca38e38d87f22dcb5ed36f9bf4a46eaed1140d941c6d38a7cf

data/lib/mls/models/listing.rb

@@ -1,7 +1,6 @@
 class MLS::Listing < MLS::Resource
 
-  WORKFLOW_STATES = %w(visible processing invisible expired)
-  LEASE_STATES = %w(listed leased)
+  STATES = %w(processing listed leased expired)
   TYPES = %w(lease sublease coworking_space)
   SPACE_TYPES = %w(unit floor building)
   LEASE_TERMS = ['Full Service', 'NNN', 'Modified Gross']
@@ -9,7 +8,7 @@ class MLS::Listing < MLS::Resource
   USES = ["Office", "Creative", "Loft", "Medical Office", "Flex Space", "R&D", "Office Showroom", "Industrial", "Retail"]
   SOURCE_TYPES = %w(website flyer)
   CHANNELS = %w(excavator mls staircase broker_dashboard)
-
+  
   property :id,                           Fixnum,   :serialize => :false
   property :address_id,                   Fixnum,   :serialize => :false
   property :slug,                         String,   :serialize => :false
@@ -21,16 +20,16 @@ class MLS::Listing < MLS::Resource
   property :source_type,                  String, :serialize => :if_present
   property :channel,                      String, :serialize => :if_present
   property :photo_ids,                    Array,  :serialize => :if_present
-
+  
   property :name,                         String
   property :type,                         String,   :default => 'lease'
-  property :workflow_state,               String,   :default => 'visible'
-  property :lease_state,                  String,   :default => 'listed'
+  property :state,                        String,   :default => 'listed'
+  property :visible,                      Boolean, :default => true
   property :space_type,                   String,   :default => 'unit'
   property :unit,                         String
   property :floor,                        Fixnum
   property :description,                  String
-
+  
   property :size,                   Fixnum
   property :maximum_contiguous_size,      Fixnum
   property :minimum_divisible_size,       Fixnum
@@ -41,12 +40,8 @@ class MLS::Listing < MLS::Resource
   property :rate_units,                   String,   :default => '/sqft/mo'
   property :low_rate,                     Decimal,  :serialize => :false
   property :high_rate,                    Decimal,  :serialize => :false
-  property :rate_per_sqft_per_month,      Decimal,  :serialize => :false # need to make write methods for these that set rate to the according rate units. not accepted on api
-  property :rate_per_sqft_per_year,       Decimal,  :serialize => :false
-  property :rate_per_month,               Decimal,  :serialize => :false
-  property :rate_per_year,                Decimal,  :serialize => :false
   property :sublease_expiration,          DateTime
-
+  
   property :forecast_rate_per_year,             Decimal,  :serialize => :false
   property :forecast_rate_per_month,            Decimal,  :serialize => :false
   property :forecast_rate_per_sqft_per_month,   Decimal,  :serialize => :false
@@ -60,7 +55,7 @@ class MLS::Listing < MLS::Resource
   property :offices,                      Fixnum
   property :conference_rooms,             Fixnum
   property :bathrooms,                    Fixnum
-
+  
   property :kitchen,                      Boolean
   property :showers,                      Boolean
   property :patio,                        Boolean
@@ -69,7 +64,7 @@ class MLS::Listing < MLS::Resource
   property :furniture_available,          Boolean
   property :natural_light,                Boolean
   property :high_ceilings,                Boolean
-
+  
   property :created_at,                   DateTime,  :serialize => :false
   property :updated_at,                   DateTime,  :serialize => :false
   property :touched_at,                   DateTime,  :serialize => :false
@@ -77,17 +72,17 @@ class MLS::Listing < MLS::Resource
   property :photography_requested_on,     DateTime,  :serialize => :false
 
   property :awesome_score,                Fixnum
-  property :awesome_needs,                Array,  :serialize => :if_present
+  property :awesome_needs,                Array,  :serialize => :if_present                
   property :awesome_label,                String
 
   property :flyer_id,                     Fixnum,    :serialize => :if_present
   property :floorplan_id,                 Fixnum,    :serialize => :if_present
-
+  
   property :avatar_digest,                String,   :serialize => false
-
+  
   # Counter Caches
   property :photos_count,                 Fixnum, :serialize => :false
-
+  
   attr_accessor :address, :agents, :account, :photos, :flyer, :floorplan, :videos, :similar_photos
 
   def avatar(size='150x100#', protocol='http')
@@ -97,42 +92,27 @@ class MLS::Listing < MLS::Resource
       address.avatar(size, protocol)
     end
   end
-
-  def processing?
-    workflow_state == 'processing'
-  end
-
-  def leased?
-    lease_state == 'leased'
-  end
-
-  def active?
-    lease_state == 'listed' && workflow_state == 'visible'
-  end
-
-  def inactive?
-    !self.active?
-  end
-
+  
   def lease?
     type == 'lease'
   end
-
   def sublease?
     type == 'sublease'
   end
-
   def coworking?
     type == 'coworking_space'
   end
 
-
+  def leased?
+    state == 'leased'
+  end
+  
   def space_name
     return name if !name.nil?
-
+    
     case space_type
     when 'unit'
-      if unit
+      if unit 
         "Unit #{unit}"
       elsif floor
         "#{floor.ordinalize} Floor"
@@ -144,7 +124,7 @@ class MLS::Listing < MLS::Resource
     when 'floor'
       if floor
         "#{floor.ordinalize} Floor"
-      elsif unit
+      elsif unit 
         "Unit #{unit}"
       else
         "Floor Lease"
@@ -152,8 +132,87 @@ class MLS::Listing < MLS::Resource
     end
   end
 
+  # TODO: remove /desk/mo conversions
+  def rate(units='/sqft/mo')
+
+    if rate_units == '/sqft/mo'
+      if units == '/sqft/mo'
+        @rate
+      elsif units == '/sqft/yr'
+        @rate * 12.0
+      elsif units == '/mo'
+        @rate * @size
+      elsif units == '/yr'
+        @rate * @size * 12.0
+      elsif units == '/desk/mo'
+        @rate * 200.0
+      else
+        raise "Invalid rate conversion (#{rate_units} => #{units})"
+      end
+      
+    elsif rate_units == '/sqft/yr'
+      if units == '/sqft/mo'
+        @rate / 12.0
+      elsif units == '/sqft/yr'
+        @rate
+      elsif units == '/mo'
+        (@rate / 12.0) * @size
+      elsif units == '/yr'
+        @rate * @size
+      elsif units == '/desk/mo'
+        (@rate / 12.0) * 200.0
+      else
+        raise "Invalid rate conversion (#{rate_units} => #{units})"
+      end
+      
+    elsif rate_units == '/mo'
+      if units == '/sqft/mo'
+        @rate / @size.to_f
+      elsif units == '/sqft/yr'
+        (@rate * 12) / @size.to_f
+      elsif units == '/mo'
+        @rate
+      elsif units == '/yr'
+        @rate * 12
+      elsif units == '/desk/mo'
+        (@rate / @size.to_f) * 200.0
+      else
+        raise "Invalid rate conversion (#{rate_units} => #{units})"
+      end
 
-
+    elsif rate_units == '/yr'
+      if units == '/sqft/mo'
+        (@rate / 12.0) / @size.to_f
+      elsif units == '/sqft/yr'
+        @rate / @size.to_f
+      elsif units == '/mo'
+        @rate / 12.0
+      elsif units == '/yr'
+        @rate
+      elsif units == '/desk/mo'
+        ((@rate / 12.0) / @size.to_f) * 200.0
+      else
+        raise "Invalid rate conversion (#{rate_units} => #{units})"
+      end
+      
+    elsif rate_units == '/desk/mo'
+      if units == '/sqft/mo'
+        @rate / 200.0
+      elsif units == '/sqft/yr'
+        ((@rate / 200.0) * 12) / @size.to_f
+      elsif units == '/mo'
+        @rate
+      elsif units == '/yr'
+        @rate * 12
+      elsif units == '/desk/mo'
+        @rate
+      else
+        raise "Invalid rate conversion (#{rate_units} => #{units})"
+      end
+      
+    end
+  end
+  
   # Creates a tour request for the listing.
   #
   # Paramaters::
@@ -174,13 +233,13 @@ class MLS::Listing < MLS::Resource
   #  listing = MLS::Listing.find(@id)
   #  info => {:company => 'name', :population => 10, :funding => 'string', :move_id => '2012-09-12'}
   #  listing.request_tour('name', 'email@address.com', info) # => #<MLS::Tour>
-  #
+  #  
   #  listing.request_tour('', 'emai', info) # => #<MLS::Tour> will have errors on account
   def request_tour(account, tour={})
     MLS::Tour.create(id, account, tour)
   end
-
-
+  
+  
   def create
     MLS.post('/listings', {:listing => to_hash}, 201, 400) do |response, code|
       raise MLS::Exception::UnexpectedResponse if ![201, 400].include?(code)
@@ -193,7 +252,7 @@ class MLS::Listing < MLS::Resource
     MLS.put("/listings/#{id}", {:listing => to_hash}, 400) do |response, code|
       if code == 200 || code == 400
         MLS::Listing::Parser.update(self, response.body)
-        code == 200
+        code == 200      
       else
         raise MLS::Exception::UnexpectedResponse, code
       end
@@ -208,7 +267,7 @@ class MLS::Listing < MLS::Resource
     hash[:videos_attributes] = videos.map(&:to_hash) unless videos.blank?
     hash
   end
-
+  
   def to_param
     "#{address.to_param}/#{id}"
   end
@@ -233,7 +292,7 @@ class MLS::Listing < MLS::Resource
     result
   end
 
-  def similar
+  def similar 
     [] # Similar Listings not supported for now
   end
 
@@ -244,7 +303,7 @@ class MLS::Listing < MLS::Resource
       MLS::Listing::Parser.parse(response.body)
     end
 
-    # currently supported options are filters, page, per_page, offset, order
+    # currently supported options are filters, page, per_page, offset, order 
     def all(options={})
       response = MLS.get('/listings', options)
       MLS::Listing::Parser.parse_collection(response.body)
@@ -270,7 +329,7 @@ end
 
 
 class MLS::Listing::Parser < MLS::Parser
-
+  
   def photos=(photos)
     @object.photos = photos.map {|p| MLS::Photo::Parser.build(p)}
   end
@@ -292,12 +351,13 @@ class MLS::Listing::Parser < MLS::Parser
   def flyer=(flyer)
     @object.flyer = MLS::Flyer::Parser.build(flyer)
   end
-
+   
   def address=(address)
     @object.address = MLS::Address::Parser.build(address)
   end
-
+  
   def agents=(agents)
     @object.agents = agents.map {|a| MLS::Account::Parser.build(a) }
   end
+  
 end

data/mls.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "mls"
-  s.version     = '0.8.2'
+  s.version     = '0.9.0'
   s.authors     = ["James R. Bracy", "Jon Bracy"]
   s.email       = ["james@42floors.com"]
   s.homepage    = "http://mls.42floors.com"

data/test/units/models/test_listing.rb

@@ -4,7 +4,7 @@ class TestListing < ::Test::Unit::TestCase
 
   def test_properties
     listing = MLS::Listing.new
-
+  
     assert listing.respond_to?(:id)
     assert listing.respond_to?(:address_id)
     assert listing.respond_to?(:use)
@@ -22,8 +22,6 @@ class TestListing < ::Test::Unit::TestCase
     assert listing.respond_to?(:lease_terms)
     assert listing.respond_to?(:rate)
     assert listing.respond_to?(:rate_units)
-    assert listing.respond_to?(:rate_per_sqft_per_month)
-    assert listing.respond_to?(:rate_per_sqft_per_year)
     assert listing.respond_to?(:sublease_expiration)
     assert listing.respond_to?(:available_on)
     assert listing.respond_to?(:maximum_term_length)
@@ -42,20 +40,20 @@ class TestListing < ::Test::Unit::TestCase
     assert listing.respond_to?(:created_at)
     assert listing.respond_to?(:updated_at)
   end
-
+  
   def test_attr_accessors
     listing = MLS::Listing.new
-
+  
     assert listing.respond_to?(:address)
     assert listing.respond_to?(:agents)
   end
-
+  
   def test_instance_methods
     listing = MLS::Listing.new
-
+  
     assert listing.respond_to?(:photos)
   end
-
+  
   def test_class_methods
     assert MLS::Listing.respond_to?(:find)
   end
@@ -65,8 +63,8 @@ class TestListing < ::Test::Unit::TestCase
     @name = Faker::Name.name
     @email = Faker::Internet.email
     tr = @listing.request_tour(@name, @email)
-
-
+  
+  
     assert_equal({}, tr.errors)
     assert_equal({}, tr.account.errors)
     # TODO assert_equal({}, tr.listing.errors)
@@ -87,7 +85,7 @@ class TestListing < ::Test::Unit::TestCase
   test '#request_tour for email on an account' do
     @account = FactoryGirl.create(:account)
     @listing = FactoryGirl.create(:listing)
-
+  
     tr = @listing.request_tour(@account.name, @account.email)
     assert_equal({}, tr.errors)
     assert_equal({}, tr.account.errors)
@@ -164,7 +162,7 @@ class TestListing < ::Test::Unit::TestCase
     
     info = {:company => '42Floors', :population => 10, :funding => 'string thing', :move_in_date => '2012-09-12'}
     tr = @listing.request_tour(Faker::Name.name, Faker::Internet.email, info)
-
+  
     assert tr.id
     assert_equal '42Floors', info[:company]
     assert_equal 10, info[:population]
@@ -179,4 +177,74 @@ class TestListing < ::Test::Unit::TestCase
     assert_equal '2012-09-12', info[:move_in_date]
   end
 
+  def test_rate_per_sqft_per_month
+    listing = MLS::Listing.new(:rate => 10.5, :rate_units => '/sqft/mo', :size => 5)
+
+    assert_equal 10.5,  listing.rate
+    assert_equal 10.5,  listing.rate('/sqft/mo')
+    assert_equal 126,   listing.rate('/sqft/yr')
+    assert_equal 52.5,  listing.rate('/mo')
+    assert_equal 630,   listing.rate('/yr')
+    assert_equal 2100,   listing.rate('/desk/mo')
+    assert_raises RuntimeError do
+      listing.rate('/random')
+    end
+  end
+  
+  def test_rate_per_sqft_per_year
+    listing = MLS::Listing.new(:rate => 126, :rate_units => '/sqft/yr', :size => 5)
+    
+    assert_equal 10.5,  listing.rate
+    assert_equal 10.5,  listing.rate('/sqft/mo')
+    assert_equal 126,   listing.rate('/sqft/yr')
+    assert_equal 52.5,  listing.rate('/mo')
+    assert_equal 630, listing.rate('/yr')
+    assert_equal 2100,   listing.rate('/desk/mo')
+    assert_raises RuntimeError do
+      listing.rate('/random')
+    end
+  end
+  
+  def test_rate_per_month
+    listing = MLS::Listing.new(:rate => 52.5, :rate_units => '/mo', :size => 5)
+    
+    assert_equal 10.5,  listing.rate
+    assert_equal 10.5,  listing.rate('/sqft/mo')
+    assert_equal 126,   listing.rate('/sqft/yr')
+    assert_equal 52.5,  listing.rate('/mo')
+    assert_equal 630, listing.rate('/yr')
+    assert_equal 2100,   listing.rate('/desk/mo')
+    assert_raises RuntimeError do
+      listing.rate('/random')
+    end
+  end
+  
+  def test_rate_per_year
+    listing = MLS::Listing.new(:rate => 630, :rate_units => '/yr', :size => 5)
+    
+    assert_equal 10.5,  listing.rate
+    assert_equal 10.5,  listing.rate('/sqft/mo')
+    assert_equal 126,   listing.rate('/sqft/yr')
+    assert_equal 52.5,  listing.rate('/mo')
+    assert_equal 630, listing.rate('/yr')
+    assert_equal 2100,   listing.rate('/desk/mo')
+    assert_raises RuntimeError do
+      listing.rate('/random')
+    end
+  end
+  
+  def test_rate_per_desk_per_month
+    listing = MLS::Listing.new(:rate => 630, :rate_units => '/yr', :size => 5)
+    
+    assert_equal 10.5,  listing.rate
+    assert_equal 10.5,  listing.rate('/sqft/mo')
+    assert_equal 126,   listing.rate('/sqft/yr')
+    assert_equal 52.5,  listing.rate('/mo')
+    assert_equal 630, listing.rate('/yr')
+    assert_equal 2100,   listing.rate('/desk/mo')
+    assert_raises RuntimeError do
+      listing.rate('/random')
+    end
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mls
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - James R. Bracy
@@ -273,7 +273,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: mls
-rubygems_version: 2.0.3
+rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
 summary: 42Floors MLS Client