re-pricing-nl 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2011-11-22
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,16 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+development_notes.txt
+Rakefile
+lib/re-pricing-nl/cpi_value.rb
+lib/re-pricing-nl/data_wrapper.rb
+lib/re-pricing-nl/rent_increment_calculator.rb
+lib/re-pricing-nl/data_wrapper.rb
+lib/re-pricing-nl.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_re-pricing-nl.rb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on re-pricing-nl, see http://re-pricing-nl.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,55 @@
+= re-pricing-nl
+
+* http://github.com/cmdjohnson/re-pricing-nl
+
+== DESCRIPTION:
+
+Real Estate Price change module for the Netherlands. 
+
+In the Netherlands, one of the ways to index rent prices is to multiply the price with the Dutch Bureau of Statistics' (CBS, http://www.cbs.nl/) Consumer Price Index (CPI).
+The CPI is a float number larger than 1.0 that indicates the multiplication factor with which the old rent is to be multiplied.
+A Web service was set up at https://cpi-nl.heroku.com/ that serves these CPI numbers.
+
+== FEATURES/PROBLEMS:
+
+Query CPI numbers from the CpiNL web service to facilitate automatic rent indexation.
+
+== SYNOPSIS:
+
+RePricingNl::RentIncrementCalculator.get_rent_increment( :month => 1, :year => 2012 ) # => 1.027
+
+== REQUIREMENTS:
+
+Gems required:
+ - activeresource
+ - activesupport
+ - options_checker
+
+== INSTALL:
+
+ $ sudo gem install re-pricing-nl
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 Commander Johnson <commanderjohnson@gmail.com>
+
+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/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/re-pricing-nl'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 're-pricing-nl' do
+  self.developer 'Commander Johnson', 'commanderjohnson@gmail.com'
+  #self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # TODO this is default value
+  self.extra_deps         = ['options_checker', 'activeresource', 'activesupport' ]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/development_notes.txt

@@ -0,0 +1,61 @@
+re-pricing-nl
+--------------------------------------------------------------------------------
+
+CPI = Consumer Price Index
+
+DataWrapper < IntegrationWrapper
+===
+ - get_cpi_index(options)
+
+Returns a float > 1.0 (e.g. 1.025 = 2,5%) that specifies the CPI for this period.
+
+Mandatory arguments:
+ - month: Month for the CPI.
+ - year: Year for the CPI.
+
+Optional arguments:
+ - cpi_value, a Hash with keys:
+   - cpi_method: CPI method
+   - period: CPI period
+   - cpi_type: CPI type
+   - base_year: CPI base year
+
+Returns Float or nil if not available.
+
+RentIncrementCalculator
+===
+ - get_rent_increment(options)
+ 
+Mandatory arguments:
+ - month: The month in which the rent increase shall take place.
+ - year: The year in which the rent increase shall take place.
+ 
+Optional arguments:
+ - cpi_value, a Hash with keys:
+   - cpi_method: CPI method
+   - period: CPI period
+   - cpi_type: CPI type
+   - base_year: CPI base year
+
+The cpi_value option is passed to both DataWrapper.get_rent_increment calls as a parameter.
+
+First, two dates are determined using DataWrapper:
+Date1 = CPI of specified year 4 months into the past
+Date2 = CPI of last year, also 4 months earlier
+
+e.g. input = 2012-01-01
+
+Then 
+Date1 = 2011-09
+Date2 = 2010-09
+
+For Date1 and Date2, the index is determined through DataWrapper (returns a Float)
+
+Date1 is then divided by Date2
+
+E.g.
+
+110.18/107.26 = 1.027 (2,7%)
+
+Returns Float or nil.
+

data/lib/re-pricing-nl.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module RePricingNl
+  VERSION = '0.0.1'
+end

data/lib/re-pricing-nl/cpi_value.rb

@@ -0,0 +1,12 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+require 'rubygems'
+require 'active_resource'
+
+module RePricingNl
+  class CpiValue < ActiveResource::Base
+    #self.site = "http://localhost:3000/frontend/"
+    self.site = "https://cpi-nl.heroku.com/frontend/"
+  end
+end

data/lib/re-pricing-nl/data_wrapper.rb

@@ -0,0 +1,48 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+require 'rubygems'
+require 'options_checker'
+require 'active_resource'
+require 're-pricing-nl/cpi_value'
+
+module RePricingNl
+  class DataWrapper
+    ENDPOINT = "https://cpi-nl.heroku.com/frontend/cpi_values"
+  
+    ##############################################################################
+    # get_cpi_index
+    # 
+    # Returns a float > 1.0 (e.g. 1.025 = 2,5%) that specifies the CPI for this period.
+    #
+    # Mandatory arguments:
+    #  - month: Month for the CPI.
+    #  - year: Year for the CPI.
+    # 
+    # Optional arguments:
+    #  - cpi_value, a Hash with keys:
+    #    - cpi_method: CPI method
+    #    - period: CPI period
+    #    - cpi_type: CPI type
+    #    - base_year: CPI base year
+    #
+    # Returns Float or nil if not available.
+    ##############################################################################
+  
+    def self.get_cpi_index(options = {})
+      OptionsChecker.check options, [ :month, :year ]
+    
+      ret = nil
+      
+      # Get the resource from the web service
+      # And mould it into a CpiValue object.
+      cpi_value = CpiValue.new(
+        CpiValue.get(
+          :show, :cpi_value => options))
+      # +_+ #
+      ret = cpi_value.index # Nice :D
+      
+      ret
+    end
+  end
+end

data/lib/re-pricing-nl/rent_increment_calculator.rb

@@ -0,0 +1,84 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+require 'rubygems'
+require 'options_checker'
+require 're-pricing-nl/data_wrapper'
+require 'date'
+
+module RePricingNl
+  class RentIncrementCalculator
+    ############################################################################
+    # get_rent_increment
+    # 
+    # Mandatory arguments:
+    #  - month: The month in which the rent increase shall take place.
+    #  - year: The year in which the rent increase shall take place.
+    #  
+    # Optional arguments:
+    #  - cpi_value, a Hash with keys:
+    #    - cpi_method: CPI method
+    #    - period: CPI period
+    #    - cpi_type: CPI type
+    #    - base_year: CPI base year
+    #
+    # The cpi_value option is passed to both DataWrapper.get_rent_increment calls as a parameter.
+    # 
+    # First, two dates are determined using DataWrapper:
+    # Date1 = CPI of specified year 4 months into the past
+    # Date2 = CPI of last year, also 4 months earlier
+    # 
+    # e.g. input = 2012-01-01
+    #
+    # Then 
+    # Date1 = 2011-09
+    # Date2 = 2010-09
+    # 
+    # For Date1 and Date2, the index is determined through DataWrapper (returns a Float)
+    #
+    # Date1 is then divided by Date2
+    #
+    # E.g.
+    #
+    # 110.18/107.26 = 1.027 (2,7%)
+    #
+    # Returns Float or nil.
+    ############################################################################
+    
+    def self.get_rent_increment(options = {})
+      OptionsChecker.check( options, [ :year, :month ] )
+      
+      year = options[:year]
+      month = options[:month]
+      
+      raise "Month must be >= 1 and <= 12. You specified: #{month}" unless month >= 1 && month <= 12
+      
+      # 4 months into the past
+      relative_date = get_relative_date(year, month, -4)
+      back_date_year = relative_date.year
+      back_date_month = relative_date.month
+      
+      # 4 months ago relative to the year and month specified
+      date1 = RePricingNl::DataWrapper.get_cpi_index(options.merge({ :month => back_date_month, :year => back_date_year })) # Pass along the options as well
+      # 1 year and 4 months ago, also relative to y and m specified.
+      date2 = RePricingNl::DataWrapper.get_cpi_index(options.merge({ :month => back_date_month, :year => back_date_year - 1 }))
+      
+      ret = nil
+      
+      if !date1.nil? && !date2.nil?
+        ret = ((date1 / date2) * 1000).round / 1000.0 # 1.8.7 doesn't have round(integer), 1.9.2 does
+      end
+      
+      ret
+    end
+    
+    # Returns a date object that is delta months into the past/future
+    def self.get_relative_date(year, month, delta, options = {})
+      Date.new(year, month, 1).advance :months => delta
+    end
+  end
+end
+

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/re-pricing-nl.rb'}"
+puts "Loading re-pricing-nl gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/re-pricing-nl'

data/test/test_re-pricing-nl.rb

@@ -0,0 +1,63 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+require 're-pricing-nl/data_wrapper'
+require 're-pricing-nl/rent_increment_calculator'
+
+class TestRePricingNl < Test::Unit::TestCase
+  def setup
+    # Offline tests:
+    # rake test
+    # Online tests:
+    # TEST_MODE="online" rake test
+    @mode = ENV['TEST_MODE'] || "offline"
+    # Uncomment this if you want online tests
+    #@mode = "online"
+  end
+  
+  ##############################################################################
+  # normal "offline" tests
+  ##############################################################################
+  
+  def test_get_relative_date
+    map = [
+      # old date -- increment (can also be negative) -- expected result
+      [ [ 4, 2004 ],      4,   [ 8, 2004 ] ],
+      [ [ 3, 2004 ],      -3,  [ 12, 2003 ] ],
+      [ [ 11, 2001],      3,   [ 2, 2002 ] ],
+      [ [ 1, 2001],      -22,   [ 3, 1999 ] ],
+      [ [ 10, 2010],      15,   [ 1, 2012 ] ]
+    ]
+    
+    for ma_ in map
+      ret = RePricingNl::RentIncrementCalculator.get_relative_date(ma_[0][1], ma_[0][0], ma_[1])
+      assert_not_nil ret
+      assert_equal Date, ret.class
+      assert_equal ma_[2][0], ret.month
+      assert_equal ma_[2][1], ret.year
+    end
+  end
+  
+  ##############################################################################
+  # online tests
+  ##############################################################################
+  
+  # ONLINE test that WILL use your INTERNET
+  def test_get_cpi_index
+    return nil if @mode.eql?("offline")
+    
+    ret = RePricingNl::DataWrapper.get_cpi_index :month => 3, :year => Time.now.year
+    
+    assert_not_nil ret
+    assert_equal Float, ret.class
+  end
+  
+  def test_get_rent_increment
+    return nil if @mode.eql?("offline")
+    
+    ret = RePricingNl::RentIncrementCalculator.get_rent_increment( :month => 1, :year => 2012 )
+    
+    assert_not_nil ret
+    assert_equal Float, ret.class
+    assert_equal 1.027, ret
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification 
+name: re-pricing-nl
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Commander Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-28 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: options_checker
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 2
+        - 8
+        - 0
+        version: 2.8.0
+  type: :development
+  version_requirements: *id004
+description: |-
+  Real Estate Price change module for the Netherlands. 
+  
+  In the Netherlands, one of the ways to index rent prices is to multiply the price with the Dutch Bureau of Statistics' (CBS, http://www.cbs.nl/) Consumer Price Index (CPI).
+  The CPI is a float number larger than 1.0 that indicates the multiplication factor with which the old rent is to be multiplied.
+  A Web service was set up at https://cpi-nl.heroku.com/ that serves these CPI numbers.
+email: 
+- commanderjohnson@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- development_notes.txt
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- development_notes.txt
+- Rakefile
+- lib/re-pricing-nl/cpi_value.rb
+- lib/re-pricing-nl/data_wrapper.rb
+- lib/re-pricing-nl/rent_increment_calculator.rb
+- lib/re-pricing-nl.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_re-pricing-nl.rb
+has_rdoc: true
+homepage: http://github.com/cmdjohnson/re-pricing-nl
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: re-pricing-nl
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Real Estate Price change module for the Netherlands
+test_files: 
+- test/test_helper.rb
+- test/test_re-pricing-nl.rb