nineflats-api 0.0.3 → 0.0.4

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+.rvmrc

data/Gemfile

@@ -1,6 +1,2 @@
 source "http://rubygems.org"
-
 gemspec
-
-gem 'rspec'
-gem 'fakeweb'

data/README.md

@@ -0,0 +1,15 @@
+Read about the API here: http://9flats.github.com/api_docs/
+
+### How to update this gem
+
+    $ git clone git@github.com:9flats/nineflats-api.git
+
+[make your changes]
+
+    $ git commit -am "my changes"
+    $ git push
+    $ rake install
+    $ gem push pkg/nineflats-api-0.0.3.gem
+    
+When you push a new gem version, update the [nineflats-api-example](https://github.com/9flats/nineflats-api-example) app to use the latest one. You need to change the version in the `Gemfile`, and you might to adapt the code, too.
+

data/Rakefile

@@ -1,5 +1,18 @@
+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 "bundler/gem_tasks"
-require 'rspec/core/rake_task'
 
-desc "Run all RSpec tests"
-RSpec::Core::RakeTask.new(:spec)
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+task :default => 'spec'

data/lib/nineflats-api/base.rb

@@ -9,11 +9,17 @@ module Nineflats
     end
 
     def self.base_url
-      "http://api.9flats.com/api"
+      "http://api.9flats.com/api/v1"
     end
     
     def self.api_call
       raise "override me!"
     end
+    
+    def self.object_link(name, array)
+      link = array.select{ |link|
+        link["rel"] == name
+      }.first["href"]
+    end
   end
 end

data/lib/nineflats-api/calendar.rb

@@ -0,0 +1,17 @@
+module Nineflats
+  class Calendar < Base
+    attr_accessor :year, :month, :days
+    
+    def initialize(json)
+      calendar = json.first[1]
+
+      @year  = calendar["year"]
+      @month = calendar["month"]
+      @days  = calendar["days"]
+    end
+    
+    def self.api_call(slug, year, month)
+      base_url + "/places/#{slug}/calendar/#{year}/#{month}?client_id=#{Nineflats::Base.client_app_key}"
+    end
+  end
+end

data/lib/nineflats-api/paginated_array.rb

@@ -0,0 +1,10 @@
+module Nineflats
+  class PaginatedArray < Array
+    attr_accessor :total_entries, :total_pages, :current_page, :per_page,
+                  :self_url, :full_url, :next_page_url
+    
+    def next_page
+      Place.search_result(next_page_url)
+    end
+  end
+end

data/lib/nineflats-api/photo.rb

@@ -0,0 +1,17 @@
+module Nineflats
+  class Photo < Base
+    attr_accessor :title, :caption, :url
+    
+    def initialize(json)
+      photo = json.first[1]
+
+      @title   = photo["title"]
+      @caption = photo["caption"]
+      @url     = photo["url"]
+    end
+    
+    def self.api_call(slug)
+      base_url + "/places/#{slug}/photos?client_id=#{Nineflats::Base.client_app_key}"
+    end
+  end
+end

data/lib/nineflats-api/place.rb

@@ -6,8 +6,10 @@ module Nineflats
                   :size, :house_rules, :pets_around, :bathroom_type, :cleaning_fee, 
                   :charge_per_extra_person_limit, :favorites_count, :amenities_list,
                   :featured_photo_url, :price, :charge_per_extra_person, :country,
-                  :category, :place_type, :bed_type, :bathroom_type,
-                  :host, :self_url, :full_url, :prices
+                  :category, :place_type, :bed_type, :bathroom_type, :description,
+                  :host, :self_url, :full_url, :photos_url, :prices_url, :reviews_url,
+                  :calendar_current_month_url, :calendar_next_month_url, 
+                  :prices, :reviews, :photos
     
     def initialize(json)
       place = json.first[1]
@@ -41,11 +43,49 @@ module Nineflats
       @lat                           = place["lat"]
       @lng                           = place["lng"]
       @district                      = place["district"]
+      @description                   = place["description"]
 
-      @host = User.new({"user"=>place["host"]})
+      @host = User.new({"user" => place["host"]})
 
-      @self_url = place["links"].first.select{|link| link["rel"] == "self"}["href"]
-      @full_url = place["links"].first.select{|link| link["rel"] == "full"}["href"]
+      @self_url                   = Nineflats::Base.object_link("self", place["links"])
+      @full_url                   = Nineflats::Base.object_link("full", place["links"])
+      @photos_url                 = Nineflats::Base.object_link("photos", place["links"])
+      @prices_url                 = Nineflats::Base.object_link("prices", place["links"])
+      @reviews_url                = Nineflats::Base.object_link("reviews", place["links"])
+      @calendar_current_month_url = Nineflats::Base.object_link("calendar: current month", place["links"])
+      @calendar_next_month_url    = Nineflats::Base.object_link("calendar: next month", place["links"])
+    end
+
+    def self.search(params = nil)
+      params ||= {}
+      
+      queries = params.collect do |key, value|
+        "&search[#{key}]=#{value}"
+      end
+      
+      search_url = base_url + "/places?client_id=#{Nineflats::Base.client_app_key}" + queries.join
+      
+      Place.search_result(search_url)
+    end
+
+    def self.search_result(search_url)
+      json = Helpers.get_data(search_url)
+      
+      places = json["places"].collect do |place_json|
+        Place.new(place_json)
+      end
+      
+      result = Nineflats::PaginatedArray.new(places)
+      
+      result.total_entries = json["total_entries"]
+      result.total_pages   = json["total_pages"]
+      result.current_page  = json["current_page"]
+      result.per_page      = json["per_page"]
+      
+      result.self_url      = Nineflats::Base.object_link("self", json["links"])
+      result.full_url      = Nineflats::Base.object_link("full", json["links"])
+      result.next_page_url = Nineflats::Base.object_link("next_page", json["links"])
+      result
     end
 
     def self.fetch(slug, lang)
@@ -53,11 +93,45 @@ module Nineflats
     end
     
     def prices
-      @prices = Prices.new(Helpers.get_data(Prices.api_call(slug)))
+      return @prices if @prices
+      
+      json = Helpers.get_data(Prices.api_call(slug))
+      
+      @prices = Prices.new(json) if json && json["place_prices"]
+    end
+    
+    def reviews
+      return @reviews if @reviews
+      
+      json = Helpers.get_data(Review.api_call(slug))
+      
+      if json && json["reviews"]
+        @reviews = json["reviews"].collect do |review_hash|
+          Review.new(review_hash)
+        end
+      end
+    end
+    
+    def photos
+      return @photos if @photos
+      
+      json = Helpers.get_data(Photo.api_call(slug))
+      
+      if json && json["place_photos"]
+        @photos = json["place_photos"].collect do |photo_hash|
+          Photo.new(photo_hash)
+        end
+      end
+    end
+    
+    def calendar(year, month)
+      json = Helpers.get_data(Calendar.api_call(slug, year, month))
+
+      Calendar.new(json) if json && json["calendar"]
     end
     
     def self.api_call(slug, lang)
-      base_url + "/places/#{slug}.json?client_id=#{Nineflats::Base.client_app_key}&language=#{lang}"
+      base_url + "/places/#{slug}?client_id=#{Nineflats::Base.client_app_key}&lang=#{lang}"
     end
   end
 end

data/lib/nineflats-api/prices.rb

@@ -13,14 +13,13 @@ module Nineflats
       @weekly_discount_in_percent  = prices["weekly_discount_in_percent"]
       @monthly_discount_in_percent = prices["monthly_discount_in_percent"]
       
-      @seasons = []
-      prices["seasons"].each do |season|
-        @seasons << Season.new(season)
+      @seasons = prices["seasons"].collect do |season|
+        Season.new(season)
       end
     end
     
     def self.api_call(slug)
-      base_url + "/places/#{slug}/prices.json?client_id=#{Nineflats::Base.client_app_key}"
+      base_url + "/places/#{slug}/prices?client_id=#{Nineflats::Base.client_app_key}"
     end
   end
 end

data/lib/nineflats-api/review.rb

@@ -0,0 +1,18 @@
+module Nineflats
+  class Review < Base
+    attr_accessor :user_text, :place_text, :place_stars, :language
+    
+    def initialize(json)
+      review = json.first[1]
+
+      @user_text   = review["user_text"]
+      @place_text  = review["place_text"]
+      @place_stars = review["place_stars"]
+      @language    = review["language"]
+    end
+    
+    def self.api_call(slug)
+      base_url + "/places/#{slug}/reviews?client_id=#{Nineflats::Base.client_app_key}"
+    end
+  end
+end

data/lib/nineflats-api/user.rb

@@ -1,6 +1,7 @@
 module Nineflats
   class User < Base
-    attr_accessor :name, :slug, :user_photo_url, :self_url, :favorites_url
+    attr_accessor :name, :slug, :user_photo_url, :favorites,
+                  :self_url, :favorites_url, :full_url
     
     def initialize(json)
       user = json.first[1]
@@ -10,17 +11,30 @@ module Nineflats
       @user_photo_url = user["user_photo_url"]
       
       if user["links"]
-        @self_url = user["links"].first.select{|link| link["rel"] == "self"}["href"]
-        @favorites_url = user["links"].first.select{|link| link["rel"] == "favorites"}["href"]
+        @self_url      = Nineflats::Base.object_link("self", user["links"])
+        @full_url      = Nineflats::Base.object_link("full", user["links"])
+        @favorites_url = Nineflats::Base.object_link("favorites", user["links"])
+      end
+    end
+    
+    def favorites
+      return @favorites if @favorites
+      
+      json = Helpers.get_data(favorites_url)
+      
+      if json && json["places"]
+        @favorites = json["places"].collect do |place_hash|
+          Place.new(place_hash)
+        end
       end
     end
 
-    def self.fetch(slug, lang)
-      User.new(Helpers.get_data(User.api_call(slug, lang)))
+    def self.fetch(slug)
+      User.new(Helpers.get_data(User.api_call(slug)))
     end
-    
-    def self.api_call(slug, lang)
-      base_url + "/users/#{slug}.json?client_id=#{Nineflats::Base.client_app_key}&language=#{lang}"
+        
+    def self.api_call(slug)
+      base_url + "/users/#{slug}?client_id=#{Nineflats::Base.client_app_key}"
     end
   end
 end

data/lib/nineflats-api/version.rb

@@ -1,5 +1,5 @@
 module Nineflats
   module Api
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/nineflats-api.gemspec

@@ -11,10 +11,13 @@ Gem::Specification.new do |s|
   s.summary     = %q{9flats API}
   s.description = %q{Let's you use the 9flats API'}
 
-  s.rubyforge_project = "nineflats-api"
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+
   s.require_paths = ["lib"]
+
+  s.add_development_dependency('rake', '~> 0.9.0')
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('fakeweb')
 end

data/spec/fixtures/place.json

@@ -0,0 +1,66 @@
+{
+    "place": {
+        "name": "Great river view, Colorful and Cozy",
+        "city": "Lisboa",
+        "slug": "apt-no-centro-histrico-de-lisboa",
+        "zipcode": "1100-188",
+        "number_of_beds": 4,
+        "number_of_bedrooms": 1,
+        "currency": "EUR",
+        "lat": 38.7173993,
+        "lng": -9.1204621,
+        "district": "",
+        "number_of_bathrooms": 1,
+        "minimum_nights": 2,
+        "maximum_nights": 365,
+        "bed_type": "Real bed",
+        "size": 70.0,
+        "house_rules": "",
+        "pets_around": false,
+        "bathroom_type": "Private",
+        "cleaning_fee": null,
+        "charge_per_extra_person_limit": 4,
+        "favorites_count": 5,
+        "amenities_list": ["Internet", "Wifi (Wireless LAN)", "TV", "Air Conditioning", "Kitchen", "Washer", "Smoking allowed", "Family/Kid friendly", "Pets allowed", "Balcony", "Dishwasher", "Fridge/freezer", "Shower/bathtub", "Baby crib", "Final cleaning", "Panoramic view", "Gay friendly"],
+        "featured_photo_url": "http://img1.9flats.com/place_photos/photos/62387-1311446301/medium.jpg",
+        "description": "Panoramic terrace in the historic center of Lisbon, close to Subway and Airport",
+        "price": 90.0,
+        "charge_per_extra_person": 20.0,
+        "content_language": "en",
+        "country": "Portugal",
+        "category": "Apartment",
+        "place_type": "Entire place",
+        "links": [{
+            "rel": "self",
+            "href": "http://api.9flats.com/api/v1/places/apt-no-centro-histrico-de-lisboa?client_id=WfKWrPywnEbMhlifGlrsLu2ULfvTwxrKQji5eg0S"
+        },
+        {
+            "rel": "full",
+            "href": "http://www.9flats.com/places/apt-no-centro-histrico-de-lisboa"
+        },
+        {
+            "rel": "photos",
+            "href": "http://api.9flats.com/api/v1/places/apt-no-centro-histrico-de-lisboa/photos?client_id=WfKWrPywnEbMhlifGlrsLu2ULfvTwxrKQji5eg0S"
+        },
+        {
+            "rel": "prices",
+            "href": "http://api.9flats.com/api/v1/places/apt-no-centro-histrico-de-lisboa/prices?client_id=WfKWrPywnEbMhlifGlrsLu2ULfvTwxrKQji5eg0S"
+        },
+        {
+            "rel": "reviews",
+            "href": "http://api.9flats.com/api/v1/places/apt-no-centro-histrico-de-lisboa/reviews?client_id=WfKWrPywnEbMhlifGlrsLu2ULfvTwxrKQji5eg0S"
+        },
+        {
+            "rel": "calendar: current month",
+            "href": "http://api.9flats.com/api/v1/places/apt-no-centro-histrico-de-lisboa/calendar/2011/10?client_id=WfKWrPywnEbMhlifGlrsLu2ULfvTwxrKQji5eg0S"
+        },
+        {
+            "rel": "calendar: next month",
+            "href": "http://api.9flats.com/api/v1/places/apt-no-centro-histrico-de-lisboa/calendar/2011/11?client_id=WfKWrPywnEbMhlifGlrsLu2ULfvTwxrKQji5eg0S"
+        }],
+        "host": {
+            "name": "Paulo M.",
+            "slug": "paulo-m"
+        }
+    }
+}

data/spec/fixtures/place_calendar.json

@@ -0,0 +1,47 @@
+{
+    "calendar": {
+        "year": 2011,
+        "month": 10,
+        "days": {
+            "1": true,
+            "2": true,
+            "3": true,
+            "4": true,
+            "5": false,
+            "6": false,
+            "7": false,
+            "8": false,
+            "9": true,
+            "10": false,
+            "11": true,
+            "12": true,
+            "13": true,
+            "14": true,
+            "15": true,
+            "16": true,
+            "17": true,
+            "18": true,
+            "19": true,
+            "20": false,
+            "21": false,
+            "22": false,
+            "23": true,
+            "24": false,
+            "25": true,
+            "26": true,
+            "27": true,
+            "28": true,
+            "29": true,
+            "30": true,
+            "31": false
+        }
+    },
+    "links": [{
+        "rel": "self",
+        "href": "http://www.9flats.com/api/v1/places/harmony-villas-close-to-the-sea/calendar/2011/10?client_id=WfKWrPywnEbMhlifGlrsLu2ULfvTwxrKQji5eg0S"
+    },
+    {
+        "rel": "calendar: next month",
+        "href": "http://www.9flats.com/api/v1/places/harmony-villas-close-to-the-sea/calendar/2011/11?client_id=WfKWrPywnEbMhlifGlrsLu2ULfvTwxrKQji5eg0S"
+    }]
+}

data/spec/fixtures/place_photos.json

@@ -0,0 +1,163 @@
+{
+  "place_photos": [
+    {
+      "place_photo": {
+          "title": "Terrace with National Pantheon view",
+          "caption": null,
+          "url": "http://img2.9flats.com/place_photos/photos/62387-1311446301/large.jpg"
+      }
+    },
+    {
+        "place_photo": {
+            "title": "Terrace with river Tagus view",
+            "caption": null,
+            "url": "http://img3.9flats.com/place_photos/photos/62388-1311446306/large.jpg"
+        }
+    },
+    {
+        "place_photo": {
+            "title": "Family room with removable dining table",
+            "caption": null,
+            "url": "http://img3.9flats.com/place_photos/photos/62389-1311446311/large.jpg"
+        }
+    },
+    {
+        "place_photo": {
+            "title": "Family room with river view",
+            "caption": null,
+            "url": "http://img0.9flats.com/place_photos/photos/62390-1311446315/large.jpg"
+        }
+    },
+    {
+        "place_photo": {
+            "title": "Double room with river view",
+            "caption": null,
+            "url": "http://img2.9flats.com/place_photos/photos/62391-1311446320/large.jpg"
+        }
+    },
+    {
+        "place_photo": {
+            "title": "Double room with big wardrobes",
+            "caption": null,
+            "url": "http://img1.9flats.com/place_photos/photos/62392-1311446325/large.jpg"
+        }
+    },
+    {
+        "place_photo": {
+            "title": "Kitchen with fridge freezer",
+            "caption": null,
+            "url": "http://img2.9flats.com/place_photos/photos/62393-1311446330/large.jpg"
+        }
+    },
+    {
+        "place_photo": {
+            "title": "Kitchen fully equipped",
+            "caption": null,
+            "url": "http://img0.9flats.com/place_photos/photos/62394-1311446334/large.jpg"
+        }
+    },
+    {
+        "place_photo": {
+            "title": "Bathroom",
+            "caption": null,
+            "url": "http://img1.9flats.com/place_photos/photos/62395-1311446339/large.jpg"
+        }
+    },
+    {
+        "place_photo": {
+            "title": "Family room with French doors",
+            "caption": null,
+            "url": "http://img1.9flats.com/place_photos/photos/62396-1311446344/large.jpg"
+        }
+    },
+    {
+        "place_photo": {
+            "title": "Terrace with National Pantheon view",
+            "caption": null,
+            "url": "http://img1.9flats.com/place_photos/photos/62397-1311446348/large.jpg"
+        }
+    },
+    {
+        "place_photo": {
+            "title": "Terrace with panoramic view",
+            "caption": null,
+            "url": "http://img3.9flats.com/place_photos/photos/62398-1311446353/large.jpg"
+        }
+    },
+    {
+        "place_photo": {
+            "title": "Night view",
+            "caption": null,
+            "url": "http://img3.9flats.com/place_photos/photos/62399-1311446357/large.jpg"
+        }
+    },
+    {
+        "place_photo": {
+            "title": "Cruise at night view",
+            "caption": null,
+            "url": "http://img0.9flats.com/place_photos/photos/62400-1311446362/large.jpg"
+        }
+    },
+    {
+        "place_photo": {
+            "title": "Double room with full mirror",
+            "caption": null,
+            "url": "http://img0.9flats.com/place_photos/photos/62401-1311446366/large.jpg"
+        }
+    },
+    {
+        "place_photo": {
+            "title": "Hall",
+            "caption": null,
+            "url": "http://img3.9flats.com/place_photos/photos/62402-1311446371/large.jpg"
+        }
+    },
+    {
+        "place_photo": {
+            "title": "Family room with TV, DVD and Stereo",
+            "caption": null,
+            "url": "http://img1.9flats.com/place_photos/photos/62403-1311446376/large.jpg"
+        }
+    },
+    {
+        "place_photo": {
+            "title": "Family room with sofa bed",
+            "caption": null,
+            "url": "http://img2.9flats.com/place_photos/photos/62404-1311446380/large.jpg"
+        }
+    },
+    {
+        "place_photo": {
+            "title": "Double room with French doors",
+            "caption": null,
+            "url": "http://img2.9flats.com/place_photos/photos/62405-1311446385/large.jpg"
+        }
+    },
+    {
+        "place_photo": {
+            "title": "Double room with terrace access",
+            "caption": null,
+            "url": "http://img3.9flats.com/place_photos/photos/62406-1311446389/large.jpg"
+        }
+    },
+    {
+        "place_photo": {
+            "title": "Terrace with river Tagus view",
+            "caption": null,
+            "url": "http://img2.9flats.com/place_photos/photos/62407-1311446394/large.jpg"
+        }
+    },
+    {
+        "place_photo": {
+            "title": "Terrace with river Tagus view",
+            "caption": null,
+            "url": "http://img0.9flats.com/place_photos/photos/62408-1311446399/large.jpg"
+        }
+    }
+  ],
+  "total_entries": 22,
+  "links": [{
+      "rel": "self",
+      "href": "http://api.9flats.com/api/v1/places/harmony-villas-close-to-the-sea/photos?client_id=WfKWrPywnEbMhlifGlrsLu2ULfvTwxrKQji5eg0S"
+  }]
+}

data/spec/fixtures/place_prices.json

@@ -0,0 +1,29 @@
+{
+  "place_prices": {
+    "currency": "EUR",
+    "default_price": 90.0,
+    "weekend_night_price": 90.0,
+    "weekly_discount_in_percent": 5.55,
+    "monthly_discount_in_percent": 11.11,
+    "seasons": [{
+      "season": {
+        "from": "2011-09-05",
+        "to": "2011-09-30",
+        "price": 100.0,
+        "weekend_night_price": 110.0
+      }
+    },
+    {
+      "season": {
+        "from": "2011-10-01",
+        "to": "2011-10-31",
+        "price": 75.0,
+        "weekend_night_price": 75.0
+      }
+    }]
+  },
+  "links": [{
+      "rel": "self",
+      "href": "http://api.9flats.com/api/v1/places/harmony-villas-close-to-the-sea/prices?client_id=WfKWrPywnEbMhlifGlrsLu2ULfvTwxrKQji5eg0S"
+  }]
+}