nineflats-api 0.0.4 → 0.0.5

data/README.md

@@ -1,4 +1,53 @@
-Read about the API here: http://9flats.github.com/api_docs/
+This gem helps you to use the 9flats.com API in your Ruby code. It always uses the latest API version. The current API version is 1.0.
+
+Find the full API documentation here: http://9flats.github.com/api_docs/
+
+You can also play around with the API [in your browser](http://nineflats-api-example.heroku.com/).
+
+### Usage
+
+Just a few examples:
+
+#### Get a place with all its attributes:
+
+    place = Place.fetch("schner-wohnen-im-belgischen")
+    place.name
+    place.city
+    
+#### Get more infos about the place:
+
+    place.photos
+    place.reviews
+    place.prices
+    place.calendar(2011, 10)
+    
+Except for the calendar, all data is cached.
+    
+#### Get info about a user:
+
+    user = User.fetch("jana-k-1")
+    user.name
+    user.favorites
+
+The user's favorites is an array of places, see above.
+
+#### Search for places:
+
+The search accepts all search parameters, [see the API documentation](http://9flats.github.com/api_docs/places.html).
+
+    result = Place.search({:query => "Berlin", :number_of_beds => 4})
+
+The result is a Nineflats::PaginatedArray. It contains the places that match the search queries. The default number of places you get is 9. The result also contains information about the search result, like
+    
+    result.total_entries
+    result.total_pages
+    result.current_page
+    result.per_page
+    
+You can also get the next 9 places:
+
+    result.next_page
+
 
 ### How to update this gem
 

data/lib/nineflats-api.rb

@@ -1 +1,2 @@
+require 'oauth'
 Dir[File.dirname(__FILE__) + "/nineflats-api/**/*.rb"].sort.each { |f| require File.expand_path(f) }

data/lib/nineflats-api/client.rb

@@ -0,0 +1,52 @@
+require 'nineflats-api/requests'
+module Nineflats
+  class Client < Base
+    # API_BASE_URI = "api.9flats.com/api/v1"
+    # API_BASE_URI = "http://localhost.com:3000/api/v1"
+    # WEB_BASE_URI = "http://www.9flats.com"
+    WEB_BASE_URI = "http://localhost.com:3000"
+
+    attr_accessor :request_token
+    attr_accessor :access_token
+    attr_reader :consumer
+
+    include Requests
+
+    def self.connect(api_key, api_secret, options={})
+      @@client = Client.new(api_key, api_secret, options)
+      if block_given?
+        yield @@client
+      end
+      @@client
+    end
+
+    def self.client
+      @@client
+    end
+
+    def self.consumer
+      @@client.consumer
+    end
+
+    def request_token(callback_url)
+      @consumer.get_request_token({:oauth_callback => callback_url})
+    end
+
+    def exchange_access_token(request_token, verifier)
+      request_token.get_access_token(:oauth_verifier => verifier)
+    end
+
+  private
+
+    def initialize(api_key, api_secret, options={})
+      @consumer = ::OAuth::Consumer.new(api_key, api_secret, {
+        :site               => WEB_BASE_URI,
+        :scheme             => :header,
+        :http_method        => :post
+       })
+      @access_token = options[:access_token]
+      # Client.default_options[:simple_oauth] = { :consumer => @consumer, :method => 'HMAC-SHA1' }.merge(options)
+    end
+
+  end
+end

data/lib/nineflats-api/query_string_normalizer.rb

@@ -0,0 +1,48 @@
+module Nineflats
+  module QueryStringNormalizer
+    def self.normalize(query)
+      Array(query).map do |key, value|
+        if value.nil?
+          key.to_s
+        elsif value.is_a?(Array)
+          value.map {|v| "#{key}=#{URI.encode(v.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))}"}
+        else
+          HashConversions.to_params(key => value)
+        end
+      end.flatten.sort.join('&')
+    end
+  end
+
+  module HashConversions
+    def self.to_params(hash)
+      params = hash.map { |k,v| normalize_param(k,v) }.join
+      params.chop! # trailing &
+      params
+    end
+
+    def self.normalize_param(key, value)
+      param = ''
+      stack = []
+
+      if value.is_a?(Array)
+        param << value.map { |element| normalize_param("#{key}[]", element) }.join
+      elsif value.is_a?(Hash)
+        stack << [key,value]
+      else
+        param << "#{key}=#{URI.encode(value.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))}&"
+      end
+
+      stack.each do |parent, hash|
+        hash.each do |key, value|
+          if value.is_a?(Hash)
+            stack << ["#{parent}[#{key}]", value]
+          else
+            param << normalize_param("#{parent}[#{key}]", value)
+          end
+        end
+      end
+
+      param
+    end
+  end
+end

data/lib/nineflats-api/requests.rb

@@ -0,0 +1,19 @@
+module Nineflats
+  module Requests
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def bookings(user_id)
+        params = {:client_id => consumer.key}
+        if client.access_token
+          response = client.access_token.request(:get, "/api/v1/users/#{user_id}/bookings?#{Nineflats::QueryStringNormalizer.normalize(params)}")
+          JSON.parse(response.body)
+        else
+          raise "So what?"
+        end
+      end
+    end
+  end
+end

data/lib/nineflats-api/user.rb

@@ -29,6 +29,10 @@ module Nineflats
       end
     end
 
+    def self.bookings(user_id)
+      Client.bookings(user_id)
+    end
+
     def self.fetch(slug)
       User.new(Helpers.get_data(User.api_call(slug)))
     end

data/lib/nineflats-api/version.rb

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

data/nineflats-api.gemspec

@@ -5,7 +5,7 @@ require "nineflats-api/version"
 Gem::Specification.new do |s|
   s.name        = "nineflats-api"
   s.version     = Nineflats::Api::VERSION
-  s.authors     = ["Lena Herrmann"]
+  s.authors     = ["Lena Herrmann", "Thorsten Böttger"]
   s.email       = ["lena@zeromail.org"]
   s.homepage    = "http://9flats.github.com/api_docs/index.html"
   s.summary     = %q{9flats API}
@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
 
   s.require_paths = ["lib"]
 
+  s.add_runtime_dependency('oauth')
   s.add_development_dependency('rake', '~> 0.9.0')
   s.add_development_dependency('rspec')
   s.add_development_dependency('fakeweb')

metadata

@@ -1,19 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: nineflats-api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
 - Lena Herrmann
+- Thorsten Böttger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-17 00:00:00.000000000Z
+date: 2011-11-02 00:00:00.000000000 +01:00
+default_executable: 
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: &2152240100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152240100
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2156944720 !ruby/object:Gem::Requirement
+  requirement: &2152239300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +34,10 @@ dependencies:
         version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *2156944720
+  version_requirements: *2152239300
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156943460 !ruby/object:Gem::Requirement
+  requirement: &2152238760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +45,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156943460
+  version_requirements: *2152238760
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &2156942040 !ruby/object:Gem::Requirement
+  requirement: &2152238080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +56,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156942040
+  version_requirements: *2152238080
 description: Let's you use the 9flats API'
 email:
 - lena@zeromail.org
@@ -59,11 +72,14 @@ files:
 - lib/nineflats-api.rb
 - lib/nineflats-api/base.rb
 - lib/nineflats-api/calendar.rb
+- lib/nineflats-api/client.rb
 - lib/nineflats-api/helpers.rb
 - lib/nineflats-api/paginated_array.rb
 - lib/nineflats-api/photo.rb
 - lib/nineflats-api/place.rb
 - lib/nineflats-api/prices.rb
+- lib/nineflats-api/query_string_normalizer.rb
+- lib/nineflats-api/requests.rb
 - lib/nineflats-api/review.rb
 - lib/nineflats-api/season.rb
 - lib/nineflats-api/user.rb
@@ -86,6 +102,7 @@ files:
 - spec/search_spec.rb
 - spec/spec_helper.rb
 - spec/user_spec.rb
+has_rdoc: true
 homepage: http://9flats.github.com/api_docs/index.html
 licenses: []
 post_install_message: 
@@ -100,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -743916347208877967
+      hash: -3354025967072406112
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -109,10 +126,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -743916347208877967
+      hash: -3354025967072406112
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: 9flats API