nestoria 1.0.0

data/.document

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

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem 'json'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.4.6)
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  json
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Dan Wentworth
+
+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.md

@@ -0,0 +1,76 @@
+Ruby Nestoria API Library
+=========================
+
+This is a simple library designed to facilitate the usage of the Nestoria API. The library supports all current Nestoria services, including:
+
+  * nestoria.com.au
+  * nestoria.com.br
+  * nestoria.de
+  * nestoria.es
+  * nestoria.fr
+  * nestoria.in
+  * nestoria.it
+  * nestoria.co.uk
+
+Usage
+=====
+
+Initialize
+----------
+
+To initialize the library call new with the TLD of Nestoria service you wish to use.
+
+    require 'nestoria/api'
+    Nestoria::Api.new(:uk)
+
+Echo
+----
+
+The echo command simply sends back any data you give it along with Nestoria's response headers:
+
+    Nestoria::Api.new(:uk).echo :foo => "bar"
+    # {"created_unix"=>1294588256, "encoding"=>"json", "action"=>"echo", "version"=>"1.19", "status_text"=>"OK", "status_code"=>"200", "foo"=>"bar", "sort"=>"nestoria_rank", "created_http"=>"Sun, 09 Jan 2011 15:50:56 GMT"}
+
+Search
+------
+
+To search Nestoria's property listings call Nestoria::Api#search along with a hash of parameters specifying the search values. The keys are the same as those listed on the Nestoria API site here: [http://www.nestoria.co.uk/help/api-search-listings](http://www.nestoria.co.uk/help/api-search-listings)
+
+keywords and keywords\_exclude take an Array object instead of a comma separated list. updated\_min can take a Time object instead of a UNIX timestamp.
+
+    Nestoria::Api.new(:uk).search :listing_type => "buy", :place_name => "Wimborne", :keywords => ["off_street_parking", "unfurnished"]
+    
+You should receive a hash containing all the values in the Nestoria response, further details can be found on the link above.
+
+Keywords
+--------
+
+For a list of valid keywords that can be used with the keywords and keywords\_exclude parameter in the search call Nestoria::Api#keywords. This will give you a set of keys and friendly names.
+
+    Nestoria::Api.new(:uk).keywords
+    # {"terrace"=>"Terrace", "studio"=>"Studio", "refurbished"=>"Refurbished", "patio"=>"Patio" ...
+
+Metadata/Average House Prices
+-----------------------------
+
+There's also support for fetching the average house price information on an area, just use Nestoria::Api#metadata with a set of location parameters.
+
+    Nestoria::Api.new(:uk).metadata :south_west => [50.965, -5.504], :north_east => [50.156, -5.136]
+
+Contributing to Nestoria API Library
+====================================
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+=========
+
+Copyright (c) 2011 Dan Wentworth. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "nestoria"
+  gem.homepage = "http://github.com/darkphnx/nestoria"
+  gem.license = "MIT"
+  gem.summary = %Q{A simple library to interface with Nestoria's API}
+  gem.description = %Q{A simple library to interface with Nestoria's API, currently compatible with v1.19}
+  gem.email = "dan.wentworth@gmail.com"
+  gem.authors = ["Dan Wentworth"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+  gem.add_runtime_dependency 'json'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "nestoria #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/nestoria/api.rb

@@ -0,0 +1,123 @@
+require 'json'
+require 'net/http'
+require 'uri'
+
+# Easy url encoding of hashes
+class Hash
+  def to_query
+    self.map{|k,v| "#{k}=#{v}"}.join("&")
+  end
+end
+
+module Nestoria
+  
+  class BadLocation < StandardError; end
+  class InvalidRequest < StandardError; end
+  class InternalError < StandardError; end
+  class InvalidVersion < StandardError; end
+  
+  class Api
+    
+    API_VERSION = 1.19
+    
+    # Valid search parameters - See http://www.nestoria.co.uk/help/api-search-listings for key/value details
+    LOCATION_KEYS = [ :place_name, :south_west, :north_east, :centre_point, :radius ]
+    SEARCH_KEYS   = [ :guid, :listing_type, :property_type, :min_price, :max_price, 
+      :bedroom_min, :bedroom_max, :room_min, :room_max, :bathroom_min, :bathroom_max, 
+      :size_min, :size_max, :keywords, :keywords_exclude, :has_photo, :updated_min, 
+      :number_of_results, :page, :sort ] + LOCATION_KEYS
+    
+    def initialize(country)
+      @country = country
+    end
+    
+    # Search nestoria property listings - See http://www.nestoria.co.uk/help/api-search-listings
+    def search(params)        
+      invalid_keys = params.keys - SEARCH_KEYS
+      raise InvalidRequest.new "Invalid keys: #{invalid_keys.join(", ")}" unless invalid_keys.empty?
+      
+      # Convert arrays into CSVs
+      [:keywords, :keywords_exclude].each do |key|
+        params[key] = params[key].join(",") unless params[key].nil?
+      end
+      
+      # Convert any Time/DateTime objects to UNIX time integers
+      params[:updated_min] = params[:updated_min].to_i unless params[:updated_min].nil?
+      
+      process_location! params
+      
+      request :search_listings, params
+    end
+    
+    # List of keywords that can be used in search - See http://www.nestoria.co.uk/help/api-keywords
+    def keywords
+      response = request :keywords
+      keywords = Hash.new
+      response["labels"].each do |label|
+        keywords[label["keyword"]] = label["content"]
+      end
+      keywords
+    end
+    
+    # Average house price for an area - See http://www.nestoria.co.uk/help/api-metadata
+    def metadata(params)
+      invalid_keys = params.keys - LOCATION_KEYS
+      raise InvalidRequest.new "Invalid keys: #{invalid_keys.join(", ")}" unless invalid_keys.empty?
+      
+      process_location! params
+      
+      request :metadata, params
+    end
+    
+    # Test URL request, returns whatever params you put in
+    def echo(params = {:foo => "bar"})
+      request :echo, params
+    end
+    
+    private
+    
+    def base_url
+      domains = {:au => "api.nestoria.com.au",
+                 :br => "api.nestoria.com.br",
+                 :de => "api.nestoria.de",
+                 :es => "api.nestoria.es",
+                 :fr => "api.nestoria.fr",
+                 :in => "api.nestoria.in",
+                 :it => "api.nestoria.it",
+                 :uk => "api.nestoria.co.uk"}
+       "http://#{domains[@country]}/api"
+    end
+    
+    def process_location!(params)
+      [:south_west, :north_east, :centre_point].each do |key|
+        params[key] = params[key].join(",") unless params[key].nil?
+      end
+    end
+    
+    def request(action, params = {})
+      url = "#{base_url}?version=#{API_VERSION}&action=#{action}&encoding=json&#{params.to_query}"
+      puts url
+      res = Net::HTTP.get_response(URI.parse(url))
+      data = JSON.parse(res.body)
+      
+      # Catch any errors returned from the API and raise an appropriate exception
+      if action.to_s == "search"
+        application_response_code = data["response"]["application_response_code"]
+        application_response_text = data["response"]["application_response_text"]
+        case application_response_code.to_i
+        when 200...299
+          raise BadLocation.new "#{application_response_code}, #{application_response_text}"
+        when 500
+          raise InternalError.new "#{application_response_code}, #{application_response_text}"
+        when 910...911
+          raise InvaidVersion.new "#{application_response_code}, #{application_response_text}"
+        when 900...999
+          raise InvalidRequest.new "#{application_response_code}, #{application_response_text}"
+        end
+      end
+      
+      data["response"]
+    end
+    
+  end
+end

data/nestoria.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{nestoria}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dan Wentworth"]
+  s.date = %q{2011-01-09}
+  s.description = %q{A simple library to interface with Nestoria's API, currently compatible with v1.19}
+  s.email = %q{dan.wentworth@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/nestoria/api.rb",
+    "nestoria.gemspec"
+  ]
+  s.homepage = %q{http://github.com/darkphnx/nestoria}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A simple library to interface with Nestoria's API}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+    else
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification 
+name: nestoria
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Dan Wentworth
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-09 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  name: json
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: shoulda
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  name: bundler
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  name: jeweler
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: rcov
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  name: json
+  prerelease: false
+  version_requirements: *id006
+description: A simple library to interface with Nestoria's API, currently compatible with v1.19
+email: dan.wentworth@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/nestoria/api.rb
+- nestoria.gemspec
+has_rdoc: true
+homepage: http://github.com/darkphnx/nestoria
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simple library to interface with Nestoria's API
+test_files: []
+