immobilienscout 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b25d3436d988c560e5b5cbc17fe0e4ab6dc5b5d
+  data.tar.gz: '059a52d68bcaf1cc768681b00546e4e9c3024c46'
+SHA512:
+  metadata.gz: e848fdd1d25c07d6923a3a47ef31c87c100f05a24ad5dc8ab21d3f997b94e93924081714a749687851b3923c18c64cef4f50e306b53fc7e4ef845f7d0f50c560
+  data.tar.gz: 07c04b9b76c7715a62c9673c18f1c18f2992eacc83f171bf62d365efd68a50e667aa591e1877f214306c4de91c197a0375e93897d9aea6ec28f55200ece71ab5

data/README.md

@@ -0,0 +1,53 @@
+# Immobilienscout gem
+
+This is an interface for Immobilienscout API
+
+## Example
+Set up your keys in `immobilienscout.rb` inside initializers.
+```ruby
+Immobilienscout.configure do |config|
+  config.consumer_key = 'consumer_key'
+  config.consumer_secret = 'consumer_secret'
+  config.access_token = 'access_token'
+  config.access_token_secret = 'access_token_secret'
+  config.use_sandbox = true
+end
+
+```
+
+## Methods
+
+#### Property
+ - Create property
+```ruby
+Immobilienscout::API::Property.create({params})
+```
+
+- Publish property
+```ruby
+Immobilienscout::API::Property.publish({params})
+```
+
+- Delete property
+```ruby
+Immobilienscout::API::Property.destroy(is24_id)
+```
+
+#### Attachment
+ - Add attachments to property
+```ruby
+Immobilienscout::API::Attachment.add(is24_id, binary_file, {metadata})
+```
+
+#### Report
+- Get scout report
+```ruby
+Immobilienscout::API::Report.retrieve(is24_id, date_from, date_to)
+```
+
+#### IMPORTANT: Check Immobilienscout API Documentation about the needed params.
+
+
+## Immobilienscout API
+
+ https://api.immobilienscout24.de/our-apis/import-export.html

data/lib/immobilienscout.rb

@@ -0,0 +1,27 @@
+require 'byebug'
+require 'timecop'
+require 'active_support'
+require 'active_support/core_ext'
+require 'immobilienscout/authenticator'
+require 'immobilienscout/request'
+require 'immobilienscout/response_parser'
+require 'immobilienscout/client'
+require 'immobilienscout/api/property'
+require 'immobilienscout/api/attachment'
+require 'immobilienscout/api/report'
+require 'immobilienscout/errors/invalid_request'
+
+module Immobilienscout
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :consumer_key, :consumer_secret, :access_token, :access_token_secret, :use_sandbox
+  end
+end

data/lib/immobilienscout/api/attachment.rb

@@ -0,0 +1,31 @@
+module Immobilienscout
+  module API
+    class Attachment
+      class << self
+        def add(is24_id, binary_file, metadata)
+          raise ArgumentError unless is24_id.present? && binary_file.present? && metadata.present?
+
+          url = add_url(is24_id)
+          metadata_file = create_metadata_file(metadata)
+          params = { attachment: binary_file, metadata: metadata_file }
+          parsed_response = Immobilienscout::Request.new(url, params).post_with_multipart
+
+          raise Immobilienscout::Errors::InvalidRequest, parsed_response.messages.map(&:messages) unless parsed_response.success?
+
+          parsed_response
+        end
+
+        private
+
+        def create_metadata_file(params)
+          metadata_object = StringIO.new(params.to_json)
+          UploadIO.new(metadata_object, 'application/json')
+        end
+
+        def add_url(is24_id)
+          "#{Immobilienscout::Client.api_url}/restapi/api/offer/v1.0/user/me/realestate/#{is24_id}/attachment"
+        end
+      end
+    end
+  end
+end

data/lib/immobilienscout/api/property.rb

@@ -0,0 +1,55 @@
+module Immobilienscout
+  module API
+    module Property
+      class << self
+        def create(params)
+          raise ArgumentError unless params.present?
+
+          execute_post_request(create_url, params)
+        end
+
+        def publish(params)
+          raise ArgumentError unless params.present?
+
+          execute_post_request(publish_url, params)
+        end
+
+        def destroy(is24_id)
+          raise ArgumentError unless is24_id.present?
+
+          destroy_url = destroy_url(is24_id)
+
+          execute_delete_request(destroy_url)
+        end
+
+        private
+
+        def execute_post_request(url, params)
+          parsed_response = Immobilienscout::Request.new(url, params).post
+          raise Immobilienscout::Errors::InvalidRequest, parsed_response.messages.map(&:messages) unless parsed_response.success?
+
+          parsed_response
+        end
+
+        def execute_delete_request(url)
+          parsed_response = Immobilienscout::Request.new(url).delete
+          raise Immobilienscout::Errors::InvalidRequest, parsed_response.messages.map(&:messages) unless parsed_response.success?
+
+          parsed_response
+        end
+
+        def create_url
+          "#{Immobilienscout::Client.api_url}/restapi/api/offer/v1.0/user/me/realestate"
+        end
+
+        def publish_url
+          "#{Immobilienscout::Client.api_url}/restapi/api/offer/v1.0/publish"
+        end
+
+        def destroy_url(is24_id)
+          "#{Immobilienscout::Client.api_url}/restapi/api/offer/v1.0/user/me/realestate/#{is24_id}"
+        end
+      end
+    end
+  end
+end

data/lib/immobilienscout/api/report.rb

@@ -0,0 +1,36 @@
+module Immobilienscout
+  module API
+    class Report
+      class << self
+        def retrieve(is24_id, date_from, date_to)
+          raise ArgumentError unless is24_id.present? && date_from.present? && date_to.present?
+
+          query_params = query_params(date_from, date_to)
+          url = retrieve_url(is24_id)
+
+          execute_get_request(url, query_params)
+        end
+
+        private
+
+        def execute_get_request(url, query_params)
+          parsed_response = Immobilienscout::Request.new(url, query_params).get
+          raise Immobilienscout::Errors::InvalidRequest, parsed_response.messages.map(&:messages) unless parsed_response.success?
+
+          parsed_response
+        end
+
+        def query_params(date_from, date_to)
+          {
+            dateFrom: date_from.to_s,
+            dateTo: date_to.to_s
+          }
+        end
+
+        def retrieve_url(is24_id)
+          "#{Immobilienscout::Client.api_url}/restapi/api/offer/v1.0/user/me/realestate/#{is24_id}/dailyreport"
+        end
+      end
+    end
+  end
+end

data/lib/immobilienscout/authenticator.rb

@@ -0,0 +1,89 @@
+require 'open-uri'
+
+module Immobilienscout
+  class Authenticator
+    ALLOWED_METHODS = %w(POST GET DELETE).freeze
+    OAUTH_SIGNATURE_METHOD = 'HMAC-SHA1'.freeze
+    OAUTH_VERSION = '1.0'.freeze
+    HASH_DIGEST = 'sha1'.freeze
+
+    def initialize(url, method, query_params = nil)
+      @url = url
+      @method = method
+      @query_params = query_params
+
+      raise ArgumentError unless valid?
+    end
+
+    def call
+      header_params.merge!(@query_params) if @query_params
+      auth_headers = auth_headers(header_params)
+
+      auth_header_string(auth_headers)
+    end
+
+    private
+
+    def valid?
+      @url.present? && @method.present? && ALLOWED_METHODS.include?(@method)
+    end
+
+    def header_params
+      @header_params ||= {
+        oauth_consumer_key: Immobilienscout.configuration.consumer_key,
+        oauth_nonce: generate_nonce,
+        oauth_signature_method: OAUTH_SIGNATURE_METHOD,
+        oauth_timestamp: generate_timestamp,
+        oauth_token: Immobilienscout.configuration.access_token,
+        oauth_version: OAUTH_VERSION
+      }
+    end
+
+    def signing_key
+      "#{url_encode(Immobilienscout.configuration.consumer_secret)}&#{url_encode(Immobilienscout.configuration.access_token_secret)}"
+    end
+
+    def generate_nonce
+      Base64.encode64(random_bytes).gsub(/\W/, '')
+    end
+
+    def random_bytes(size=7)
+      OpenSSL::Random.random_bytes(size)
+    end
+
+    def generate_timestamp
+      Time.now.utc.to_i.to_s
+    end
+
+    def signature_base_string(params)
+      "#{@method}&#{url_encode(@url)}&#{url_encode(params.to_query)}"
+    end
+
+    def generate_signature(signature_base_string)
+      url_encode(sign(signing_key, signature_base_string))
+    end
+
+    def url_encode(string)
+      CGI.escape(string)
+    end
+
+    def sign(key, base_string)
+      digest = OpenSSL::Digest.new(HASH_DIGEST)
+      hmac = OpenSSL::HMAC.digest(digest, key, base_string)
+      Base64.encode64(hmac).chomp.delete(' ')
+    end
+
+    def auth_headers(header_params)
+      signature_base_string = signature_base_string(header_params)
+      header_params['oauth_signature'] = generate_signature(signature_base_string)
+      header_params
+    end
+
+    def auth_header_string(params)
+      header_params = params.each_with_object('OAuth ') do |(key, value), header|
+        header << "#{key}=#{value},"
+      end
+      header_params.chop
+    end
+  end
+end

data/lib/immobilienscout/client.rb

@@ -0,0 +1,12 @@
+module Immobilienscout
+  class Client
+    SANDBOX_URL = 'https://rest.sandbox-immobilienscout24.de'.freeze
+    LIVE_URL = 'https://rest.immobilienscout24.de'.freeze
+
+    def self.api_url
+      return SANDBOX_URL if Immobilienscout.configuration.use_sandbox
+
+      LIVE_URL
+    end
+  end
+end

data/lib/immobilienscout/errors/invalid_request.rb

@@ -0,0 +1,9 @@
+module Immobilienscout
+  module Errors
+    class InvalidRequest < StandardError
+      def initialize(msg = message)
+        super
+      end
+    end
+  end
+end

data/lib/immobilienscout/request.rb

@@ -0,0 +1,86 @@
+require 'net/http/post/multipart'
+require 'uri'
+
+module Immobilienscout
+  class Request
+    def initialize(url, params = nil)
+      @url = url
+      @params = params
+
+      raise ArgumentError unless valid?
+    end
+
+    def get
+      auth_header = generate_auth_header('GET', @params)
+      headers = generate_headers(auth_header)
+
+      url_with_query = "#{@url}?#{@params.to_query}"
+      uri = URI.parse(url_with_query)
+
+      request = Net::HTTP::Get.new(uri)
+      request.initialize_http_header(headers)
+
+      execute_request(uri, request)
+    end
+
+    def post
+      auth_header = generate_auth_header('POST')
+      headers = generate_headers(auth_header)
+
+      uri = URI.parse(@url)
+
+      request = Net::HTTP::Post.new(uri)
+      request.body = @params.to_json
+      request.initialize_http_header(headers)
+
+      execute_request(uri, request)
+    end
+
+    def post_with_multipart
+      auth_header = generate_auth_header('POST')
+
+      uri = URI.parse(@url)
+
+      request = Net::HTTP::Post::Multipart.new(uri, @params)
+      request.add_field('Authorization', auth_header)
+      request.add_field('Accept', 'application/json')
+
+      execute_request(uri, request)
+    end
+
+    def delete
+      auth_header = generate_auth_header('DELETE')
+      headers = generate_headers(auth_header)
+
+      uri = URI.parse(@url)
+
+      request = Net::HTTP::Delete.new(uri)
+      request.initialize_http_header(headers)
+
+      execute_request(uri, request)
+    end
+
+    private
+
+    def valid?
+      @url.present?
+    end
+
+    def generate_auth_header(method_type, query_params = nil)
+      Immobilienscout::Authenticator.new(@url, method_type, query_params).call
+    end
+
+    def generate_headers(auth_header)
+      {
+        'Authorization' => auth_header,
+        'Content-Type' => 'application/json',
+        'Accept' => 'application/json'
+      }
+    end
+
+    def execute_request(uri, request)
+      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request request }
+      Immobilienscout::ResponseParser.new(response).call
+    end
+  end
+end

data/lib/immobilienscout/response_parser.rb

@@ -0,0 +1,48 @@
+module Immobilienscout
+  class ResponseParser
+    HTTP_OK = %w(200 201).freeze
+
+    Message = Struct.new(:success?, :code, :messages, :id)
+
+    def initialize(response)
+      @response = response
+
+      raise ArgumentError unless valid?
+    end
+
+    def call
+      response_body = JSON.parse(@response.body)
+
+      Message.new(success?, code, messages(response_body), id(response_body))
+    end
+
+    private
+
+    def valid?
+      @response.present?
+    end
+
+    def success?
+      HTTP_OK.include? @response.code
+    end
+
+    def code
+      @response.code
+    end
+
+    def messages(response_body)
+      return response_body unless response_body['common.messages']
+
+      messages = response_body['common.messages'].first['message']
+      messages = [messages] if messages.is_a? Hash
+      messages.map { |msg| Message.new(nil, msg['messageCode'], msg['message'], msg['id']) }
+    end
+
+    def id(response_body)
+      return unless response_body['common.messages']
+
+      messages = response_body['common.messages'].first['message']
+      messages['id'] if messages.is_a? Hash
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: immobilienscout
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Angela Guette
+- Wiebke Frey
+- Laura Garcia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem provides HTTP endpoints to connect your app with Immobilienscout
+  API
+email: backend-team@homeday.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/immobilienscout.rb
+- lib/immobilienscout/api/attachment.rb
+- lib/immobilienscout/api/property.rb
+- lib/immobilienscout/api/report.rb
+- lib/immobilienscout/authenticator.rb
+- lib/immobilienscout/client.rb
+- lib/immobilienscout/errors/invalid_request.rb
+- lib/immobilienscout/request.rb
+- lib/immobilienscout/response_parser.rb
+homepage: https://github.com/homeday-de/immobilienscout
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.3
+signing_key: 
+specification_version: 4
+summary: A ruby gem to handle Immobilienscout API
+test_files: []