is24 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 796f124dc5b42c1ee9f57e39c53fadddc1d58114
+  data.tar.gz: 793b91c0edc90b4d7bfedbd687a018853fb9019c
+SHA512:
+  metadata.gz: 0c6cb236fbc76269422ac79adcb30f32618dd464292cc6caf5ad99e4e5d60d1b1d908fccbcf62dc13fc68e790ae46caed76d9f37a4dfba5fec18e0c97b0d708e
+  data.tar.gz: 9e8318bc6f05d68200d337b68d47f64d1ea36edfd772f7b791dfcaee361b51cd1716afff5af21fa65c838506f0ba1b22f136629772c358cc81622f7f1d611204

data/lib/is24.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 require 'is24/logger'
 require 'faraday'
 require 'faraday_middleware'
@@ -9,23 +11,90 @@ module Is24
     include Is24::Logger
 
     API_ENDPOINT = "http://rest.immobilienscout24.de/restapi/api/search/v1.0/"
+    API_OFFER_ENDPOINT = "http://rest.immobilienscout24.de/restapi/api/offer/v1.0/"
     API_AUTHORIZATION_ENDPOINT = "http://rest.immobilienscout24.de/restapi/security/"
 
+    # TODO move in separate module
+    MARKETING_TYPES = {
+      "PURCHASE" => "Kauf",
+      "PURCHASE_PER_SQM" => "Kaufpreis/ Quadratmeter",
+      "RENT" => "Miete",
+      "RENT_PER_SQM" => "Mietpreis/ Quadratmeter",
+      "LEASE" => "Leasing",
+      "LEASEHOLD" => "",
+      "BUDGET_RENT" => "",
+      "RENT_AND_BUY" => ""
+    }
+
+    PRICE_INTERVAL_TYPES = {
+      "DAY" => "Tag",
+      "WEEK" => "Woche",
+      "MONTH" => "Monat",
+      "YEAR" => "Jahr",
+      "ONE_TIME_CHARGE" => "einmalig"
+    }
+
+    REAL_ESTATE_TYPES = {
+      "APARTMENT_RENT" => "Wohnung Miete",
+      "APARTMENT_BUY" => "Wohnung Kauf",
+      "HOUSE_RENT" => "Haus Miete",
+      "HOUSE_BUY" => "Haus Kauf",
+      "GARAGE_RENT" => "Garage / Stellplatz Miete",
+      "GARAGE_BUY" => "Garage / Stellplatz Kauf",
+      "LIVING_RENT_SITE" => "Grundstück Wohnen Miete",
+      "LIVING_BUY_SITE" => "Grundstück Wohnen Kauf",
+      "TRADE_SITE" => "Grundstück Gewerbe",
+      "HOUSE_TYPE" => "Typenhäuser",
+      "FLAT_SHARE_ROOM" => "WG-Zimmer",
+      "SENIOR_CARE" => "Altenpflege",
+      "ASSISTED_LIVING" => "Betreutes Wohnen",
+      "OFFICE" => "Büro / Praxis",
+      "INDUSTRY" => "Hallen / Produktion",
+      "STORE" => "Einzelhandel",
+      "GASTRONOMY" => "Gastronomie / Hotel",
+      "SPECIAL_PURPOSE" => "",
+      "INVESTMENT" => "Gewerbeprojekte",
+      "COMPULSORY_AUCTION" => "",
+      "SHORT_TERM_ACCOMMODATION" => ""
+    }
+
+    # transforms, eg.
+    # "SPECIAL_PURPOSE" => ""
+    # to
+    # "search:SpecialPurpose" => ""
+    XSI_SEARCH_TYPES = lambda {
+      return Hash[*REAL_ESTATE_TYPES.map{ |v|
+          [
+            "search:"+v.first.downcase.split("_").map!(&:capitalize).join,
+            v[1]
+          ]
+        }.flatten
+      ]
+    }.()
+
+    def self.format_marketing_type(marketing_type)
+      MARKETING_TYPES[marketing_type] || ""
+    end
+
+    def self.format_price_interval_type(price_interval_type)
+      PRICE_INTERVAL_TYPES[price_interval_type] || ""
+    end
+
     def initialize( options = {} )
       logger "Initialized b'nerd IS24 with options #{options}"
-      
+
       @token = options[:token] || nil
       @secret = options[:secret] || nil
       @consumer_secret = options[:consumer_secret] || nil
       @consumer_key = options[:consumer_key] || nil
-      
+
       raise "Missing Credentials!" if @consumer_secret.nil? || @consumer_key.nil?
     end
-    
+
     def request_token( callback_uri )
       # TODO error handling
       response = connection(:authorization, callback_uri).get("oauth/request_token")
-      
+
       body = response.body.split('&')
       response = {
         :oauth_token => CGI::unescape(body[0].split("=")[1]),
@@ -41,75 +110,106 @@ module Is24
       @secret = params[:oauth_token_secret]
 
       response = connection(:authorization).get("oauth/access_token")
-      puts response.inspect
       body = response.body.split('&')
-      
+
       response = {
         :oauth_token => body[0].split('=')[1],
         :oauth_token_secret => CGI::unescape(body[1].split('=')[1]),
       }
-      
+
       # set credentials in client
       @token = response[:oauth_token]
       @token_secret = response[:oauth_token_secret]
-      
+
       # return access token and secret
       response
     end
-    
+
     def search(options)
       defaults = {
         :channel => "hp",
-        :realestatetype => "housebuy",
+        :realestatetype => ["housebuy"],
         :geocodes => 1276,
-        :username => "me"    
+        :username => "me"
       }
       options = defaults.merge(options)
-      
-      response = connection.get("search/region", options )
-      response.body["resultlist.resultlist"]
+      types = options[:realestatetype]
+
+      case types
+        when String
+          types = [types]
+      end
+
+      objects = []
+
+      types.each do |type|
+        options[:realestatetype] = type
+        response = connection.get("search/region", options )
+        if response.status == 200
+          if response.body["resultlist.resultlist"].resultlistEntries[0]['@numberOfHits'] == "0"
+            response.body["resultlist.resultlist"].resultlistEntries[0].resultlistEntries = []
+          end
+          objects.push response.body["resultlist.resultlist"].resultlistEntries[0]
+        end
+      end
+
+      objects
     end
-    
+
     def expose(id)
       response = connection.get("expose/#{id}")
       response.body["expose.expose"]
     end
-    
+
+    def list_exposes
+      response = connection(:offer).get("user/me/realestate?publishchannel=IS24")
+      response.body
+    end
+
+    def short_list
+      response = connection.get("searcher/me/shortlist/0/entry")
+      response.body["shortlist.shortlistEntries"].first["shortlistEntry"]
+    end
+
     protected
-    
+
     def connection(connection_type = :default, callback_uri = nil)
-    
+
       # set request defaults
       defaults = {
         :url => API_ENDPOINT,
-        :accept =>  'application/json',
         :headers => {
           :accept =>  'application/json',
-          :user_agent => 'b\'nerd .media IS24 Ruby Client'}      
+          :user_agent => 'b\'nerd .media IS24 Ruby Client'}
       }
-      
+
       defaults.merge!( {
         :url => API_AUTHORIZATION_ENDPOINT
       } ) if connection_type =~ /authorization/i
-      
+
+      defaults.merge!( {
+        :url => API_OFFER_ENDPOINT
+      } ) if connection_type =~ /offer/i
+
+
       # define oauth credentials
       oauth = {
-        :consumer_key => @consumer_key, 
-        :consumer_secret => @consumer_secret, 
-        :token => @token, 
+        :consumer_key => @consumer_key,
+        :consumer_secret => @consumer_secret,
+        :token => @token,
         :token_secret => @secret
       }
-      
+
       # merge callback_uri if present
       oauth.merge!( {
         :callback => callback_uri
       } ) if connection_type =~ /authorization/i && callback_uri
-      
+
       # merge verifier if present
       oauth.merge!( {
         :verifier => @oauth_verifier
       } ) if connection_type =~ /authorization/i && @oauth_verifier
-      
+
       Faraday::Connection.new( defaults ) do |builder|
             builder.request :oauth, oauth
             builder.response :mashify
@@ -117,6 +217,6 @@ module Is24
             builder.adapter Faraday.default_adapter
           end
     end
-    
+
   end
-end  
+end

data/lib/is24/version.rb

@@ -1,3 +1,3 @@
 module Is24
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,94 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: is24
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - Bernd Suenkel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-13 00:00:00.000000000 Z
+date: 2014-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simple_oauth
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Simple Ruby API Client for Immobilienscout24.
@@ -98,41 +87,33 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/is24.rb~
+- lib/is24.rb
 - lib/is24/version.rb
 - lib/is24/logger.rb
-- lib/is24/logger.rb~
-- lib/is24/client.rb~
-- lib/is24/version.rb~
-- lib/bnerd-video.rb~
-- lib/bnerd_video.rb~
-- lib/bnerd.rb~
-- lib/is24.rb
 - LICENSE.txt
 - Rakefile
 - README.md
 homepage: http://github.com/bnerd/is24
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby API Client for Immobilienscout24.
 test_files: []

data/lib/bnerd-video.rb~

@@ -1,70 +0,0 @@
-require 'faraday'
-require 'faraday_middleware'
-require 'faraday_middleware/response/mashify'
-
-module Bnerd
-  class Api
-
-    def initialize( options = {} )
-      @secret = options[:secret] || nil
-      @api_key = options[:api_key] || nil
-      @public_key = options[:public_key] || nil
-      raise "Invalid Credentials" if @secret.nil? || @api_key.nil?
-    end
-    
-    def videos
-      connection.get('videos').body
-    end
-    
-    def video(id)
-      connection.get("videos/#{id}").body.video
-    end
-
-    def ingest
-      params = {
-        api_key: @api_key,
-        public_key: "f3bbb86e4d9b9a7a60e0b10ba0312535",
-        timestamp: 1360459978,
-        signature: '1325ea0ed234cbfceafcff19cc3732731da0d26af3a99f61f57195b271f190cc',
-        video: {
-          name: "foo",
-          description: "bar",
-          data: Faraday::UploadIO.new('/home/besu/Videos/second/178969.flv', 'video/mp4')              
-        } 
-      }
-      ingest_connection.post("/", params)
-    end
-
-    protected
-    
-    def ingest_connection
-      Faraday::Connection.new(
-        :url => "https://ingest.bnerd.net:8043",
-        :ssl => { verify: false },
-        :headers => { 
-          :user_agent => 'b\'nerd .video Ruby Client'}
-        ) do |builder|
-            builder.request :multipart
-            builder.request :url_encoded
-            builder.adapter Faraday.default_adapter
-          end
-    end
-    
-    def connection
-      Faraday::Connection.new(
-        :url => "http://video.bnerd.net/api/v1",
-        :accept =>  'application/json',
-        :params => {
-          auth_token: @secret,
-          api_key: @api_key
-        },
-        :headers => { 
-          :accept =>  'application/json',
-          :user_agent => 'b\'nerd .video Ruby Client'} ) do |builder|
-            builder.response :mashify
-            builder.response :json
-            builder.adapter Faraday.default_adapter
-          end
-    end
-  end
-end  

data/lib/bnerd.rb~

@@ -1,71 +0,0 @@
-require 'faraday'
-require 'faraday_middleware'
-require 'faraday_middleware/response/mashify'
-require './bnerd/api/logger'
-
-module Bnerd
-  class Api
-
-    def initialize( options = {} )
-      @secret = options[:secret] || nil
-      @api_key = options[:api_key] || nil
-      @public_key = options[:public_key] || nil
-      raise "Invalid Credentials" if @secret.nil? || @api_key.nil?
-    end
-    
-    def videos
-      connection.get('videos').body
-    end
-    
-    def video(id)
-      connection.get("videos/#{id}").body.video
-    end
-
-    def ingest
-      params = {
-        api_key: @api_key,
-        public_key: "f3bbb86e4d9b9a7a60e0b10ba0312535",
-        timestamp: 1360459978,
-        signature: '1325ea0ed234cbfceafcff19cc3732731da0d26af3a99f61f57195b271f190cc',
-        video: {
-          name: "foo",
-          description: "bar",
-          data: Faraday::UploadIO.new('/home/besu/Videos/second/178969.flv', 'video/mp4')              
-        } 
-      }
-      ingest_connection.post("/", params)
-    end
-
-    protected
-    
-    def ingest_connection
-      Faraday::Connection.new(
-        :url => "https://ingest.bnerd.net:8043",
-        :ssl => { verify: false },
-        :headers => { 
-          :user_agent => 'b\'nerd .video Ruby Client'}
-        ) do |builder|
-            builder.request :multipart
-            builder.request :url_encoded
-            builder.adapter Faraday.default_adapter
-          end
-    end
-    
-    def connection
-      Faraday::Connection.new(
-        :url => "http://video.bnerd.net/api/v1",
-        :accept =>  'application/json',
-        :params => {
-          auth_token: @secret,
-          api_key: @api_key
-        },
-        :headers => { 
-          :accept =>  'application/json',
-          :user_agent => 'b\'nerd .video Ruby Client'} ) do |builder|
-            builder.response :mashify
-            builder.response :json
-            builder.adapter Faraday.default_adapter
-          end
-    end
-  end
-end  

data/lib/bnerd_video.rb~

@@ -1,92 +0,0 @@
-require 'faraday'
-require 'faraday_middleware'
-require 'faraday_middleware/response/mashify'
-require 'bnerd_video/logger'
-require 'bnerd_video/model/video'
-
-module BnerdVideo
-  class Api
-    include BnerdVideo::Logger
-
-    # PRODUCTION
-    API_ENDPOINT = "http://video.bnerd.net/api/v1"
-    INGEST_ENDPOINT = "https://ingest.bnerd.net:8043"
-    
-    # DEVELOPMENT
-    API_ENDPOINT = "http://video.lvh.me:3000/api/v1"
-    INGEST_ENDPOINT = "https://ingest.bnerd.net:8043"
-
-    def initialize( options = {} )
-      logger "Initialized BnerdVideo with options #{options}"
-      
-      @secret = options[:secret] || nil
-      @api_key = options[:api_key] || nil
-      @public_key = options[:public_key] || nil
-      raise "Invalid Credentials" if @secret.nil? || @api_key.nil?
-    end
-    
-    def videos
-      response = connection.get('videos')
-      response.body.videos.map do |video|
-        BnerdVideo::Model::Video.new(video, self)
-      end
-    end
-    
-    def video(id)
-      response = connection.get("videos/#{id}")
-      BnerdVideo::Model::Video.new(response.body, self)
-    end
-
-    def ingest(media, params)
-      ingest_connection.post("/", params)
-    end
-
-    def update(model)
-      response = connection.put("videos/#{model.id}") do |req|
-        req.headers['Content-Type'] = 'application/json'
-        req.body = model.to_json
-      end
-      BnerdVideo::Model::Video.new(response.body, self)
-    end
-
-    def destroy(model)
-      response = connection.delete("videos/#{model.id}") do |req|
-        req.headers['Content-Type'] = 'application/json'
-        req.body = model.to_json
-      end
-      BnerdVideo::Model::Video.new(response.body, self)
-    end
-
-    protected
-    
-    def ingest_connection
-      Faraday::Connection.new(
-        :url => INGEST_ENDPOINT,
-        :ssl => { verify: false },
-        :headers => { 
-          :user_agent => 'b\'nerd .video Ruby Client'}
-        ) do |builder|
-            builder.request :multipart
-            builder.request :url_encoded
-            builder.adapter Faraday.default_adapter
-          end
-    end
-    
-    def connection
-      Faraday::Connection.new(
-        :url => API_ENDPOINT,
-        :accept =>  'application/json',
-        :params => {
-          auth_token: @secret,
-          api_key: @api_key
-        },
-        :headers => { 
-          :accept =>  'application/json',
-          :user_agent => 'b\'nerd .video Ruby Client'} ) do |builder|
-            builder.response :mashify
-            builder.response :json
-            builder.adapter Faraday.default_adapter
-          end
-    end
-  end
-end  

data/lib/is24.rb~

@@ -1,122 +0,0 @@
-require 'is24/logger'
-require 'faraday'
-require 'faraday_middleware'
-require 'faraday_middleware/response/mashify'
-require 'cgi'
-
-module Is24
-  class Api
-    include Is24::Logger
-
-    API_ENDPOINT = "http://rest.immobilienscout24.de/restapi/api/search/v1.0/"
-    API_AUTHORIZATION_ENDPOINT = "http://rest.immobilienscout24.de/restapi/security/"
-
-    def initialize( options = {} )
-      logger "Initialized b'nerd IS24 with options #{options}"
-      
-      @token = options[:token] || nil
-      @secret = options[:secret] || nil
-      @consumer_secret = options[:consumer_secret] || nil
-      @consumer_key = options[:consumer_key] || nil
-      
-      raise "Missing Credentials!" if @consumer_secret.nil? || @consumer_key.nil?
-    end
-    
-    def request_token( callback_uri )
-      # TODO error handling
-      response = connection(:authorization, callback_uri).get("oauth/request_token")
-      
-      body = response.body.split('&')
-      response = {
-        :oauth_token => CGI::unescape(body[0].split("=")[1]),
-        :oauth_token_secret => CGI::unescape(body[1].split("=")[1]),
-        :redirect_uri => "http://rest.immobilienscout24.de/restapi/security/oauth/confirm_access?#{body[0]}"
-      }
-    end
-
-    def request_access_token( params = {} )
-      # TODO error handling
-      @oauth_verifier = params[:oauth_verifier]
-      @token = params[:oauth_token]
-      @secret = params[:oauth_token_secret]
-
-      response = connection(:authorization).get("oauth/access_token")
-      puts response.inspect
-      body = response.body.split('&')
-      
-      response = {
-        :oauth_token => body[0].split('=')[1],
-        :oauth_token_secret => CGI::unescape(body[1].split('=')[1]),
-      }
-      
-      # set credentials in client
-      @token = response[:oauth_token]
-      @token_secret = response[:oauth_token_secret]
-      
-      # return access token and secret
-      response
-    end
-    
-    def search(options)
-      defaults = {
-        :channel => "hp",
-        :realestatetype => "housebuy",
-        :geocodes => 1276,
-        :username => "me"    
-      }
-      options = defaults.merge(options)
-      
-      response = connection.get("search/region", options )
-      response.body["resultlist.resultlist"]
-    end
-    
-    def expose(id)
-      response = connection.get("expose/#{id}")
-      response.body["expose.expose"]
-    end
-    
-    protected
-    
-    def connection(connection_type = :default, callback_uri = nil)
-    
-      # set request defaults
-      defaults = {
-        :url => API_ENDPOINT,
-        :accept =>  'application/json',
-        :headers => {
-          :accept =>  'application/json',
-          :user_agent => 'b\'nerd .media IS24 Ruby Client'}      
-      }
-      
-      defaults.merge!( {
-        :url => API_AUTHORIZATION_ENDPOINT
-      } ) if connection_type =~ /authorization/i
-      
-      # define oauth credentials
-      oauth = {
-        :consumer_key => @consumer_key, 
-        :consumer_secret => @consumer_secret, 
-        :token => @token, 
-        :token_secret => @secret
-      }
-      
-      # merge callback_uri if present
-      oauth.merge!( {
-        :callback => callback_uri
-      } ) if connection_type =~ /authorization/i && callback_uri
-      
-      # merge verifier if present
-      oauth.merge!( {
-        :verifier => @oauth_verifier
-      } ) if connection_type =~ /authorization/i && @oauth_verifier
-      
-      Faraday::Connection.new( defaults ) do |builder|
-            builder.request :oauth, oauth
-            builder.response :mashify
-            builder.response :json unless connection_type =~ /authorization/i
-            builder.adapter Faraday.default_adapter
-          end
-    end
-    
-  end
-end  

data/lib/is24/client.rb~

@@ -1,10 +0,0 @@
-module BnerdVideo
-  module Api
-    class Client
-      include BnerdVideo::Logger
-      
-      
-      
-    end
-  end
-end

data/lib/is24/logger.rb~

@@ -1,10 +0,0 @@
-require 'logger'
-
-module Is24
-  module Logger
-    def logger(msg)
-      @logger = ::Logger.new(STDOUT)
-      @logger.info msg
-    end
-  end
-end

data/lib/is24/version.rb~

@@ -1,3 +0,0 @@
-module Is24
-  VERSION = "0.0.1"
-end