immoscout 1.0.0

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "immoscout"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/immoscout.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "immoscout/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "immoscout"
+  spec.version       = Immoscout::VERSION
+  spec.authors       = ["Marcus Geissler"]
+  spec.email         = ["marcus.geissler@hanseventures.com"]
+
+  spec.summary       = 'Ruby client for the Immobilienscout24 REST API'
+  spec.homepage      = "https://github.com/hausgold/immoscout"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org.
+  # To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this
+  # section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency "activesupport", ">= 3.2.0"
+  spec.add_dependency "faraday", "~> 0.13.0"
+  spec.add_dependency "faraday_middleware", "~> 0.12.0"
+  spec.add_dependency "simple_oauth", ">= 0.3"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-json_expectations", "~> 1.4.0"
+  spec.add_development_dependency "vcr", "~> 3.0.0"
+  spec.add_development_dependency "webmock", "~> 2.3.0"
+  spec.add_development_dependency "simplecov"
+end

data/lib/immoscout.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'active_support/configurable'
+require 'active_support/core_ext/hash'
+
+require "immoscout/version"
+require 'immoscout/configuration'
+require 'immoscout/models'
+
+module Immoscout
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.reset_configuration!
+    self.configuration = Configuration.new
+  end
+end

data/lib/immoscout/api/client.rb

@@ -0,0 +1,27 @@
+require 'singleton'
+require_relative "connection"
+require_relative "request"
+
+module Immoscout
+  module Api
+    class Client
+      include Singleton
+      include Immoscout::Api::Connection
+      include Immoscout::Api::Request
+
+      attr_writer :user_name
+
+      def user_name
+        @user_name || config.user_name
+      end
+
+      def url
+        config.use_sandbox ? config.api_url_sandbox : config.api_url_live
+      end
+
+      def config
+        Immoscout.configuration
+      end
+    end
+  end
+end

data/lib/immoscout/api/connection.rb

@@ -0,0 +1,34 @@
+require "faraday"
+require "faraday_middleware"
+
+module Immoscout
+  module Api
+    module Connection
+      # :reek:FeatureEnvy
+      def connection
+        @connection ||= Faraday::Connection.new(url: url) do |builder|
+          configure_oauth(builder)
+          builder.request   :multipart
+          builder.request   :url_encoded
+          builder.request   :json
+          builder.response  :follow_redirects
+          builder.response  :json, content_type: /\bjson$/
+          builder.adapter   :net_http
+        end
+        @connection
+      end
+
+      private
+
+      def configure_oauth(builder)
+        builder.request(
+          :oauth,
+          token: config.oauth_token,
+          token_secret: config.oauth_token_secret,
+          consumer_key: config.consumer_key,
+          consumer_secret: config.consumer_secret
+        )
+      end
+    end
+  end
+end

data/lib/immoscout/api/request.rb

@@ -0,0 +1,33 @@
+module Immoscout
+  module Api
+    module Request
+      def get(path, payload = nil, multipart = nil)
+        request(:get, path, payload, multipart)
+      end
+
+      def post(path, payload = nil, multipart = nil)
+        request(:post, path, payload, multipart)
+      end
+
+      def put(path, payload = nil, multipart = nil)
+        request(:put, path, payload, multipart)
+      end
+
+      def delete(path, payload = nil, multipart = nil)
+        request(:delete, path, payload, multipart)
+      end
+
+      def request(method, path, payload = nil, multipart = nil)
+        connection.send(method, path, multipart) do |request|
+          if multipart
+            request.headers['Content-Type'] = "multipart/form-data"
+          else
+            request.body                    = payload if payload
+            request.headers['Content-Type'] = "application/json;charset=UTF-8"
+          end
+          request.headers['Accept'] = "application/json"
+        end
+      end
+    end
+  end
+end

data/lib/immoscout/configuration.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Immoscout
+  class Configuration
+    include ActiveSupport::Configurable
+    config_accessor(:consumer_key) { ENV["IMMOSCOUT_CONSUMER_KEY"] }
+    config_accessor(:consumer_secret) { ENV["IMMOSCOUT_CONSUMER_SECRET"] }
+
+    config_accessor(:oauth_token) { ENV["IMMOSCOUT_OAUTH_TOKEN"] }
+    config_accessor(:oauth_token_secret) { ENV["IMMOSCOUT_OAUTH_TOKEN_SECRET"] }
+
+    config_accessor(:use_sandbox) { false }
+
+    config_accessor(:api_version) { "v1.0" }
+
+    config_accessor(:user_name) { 'me' }
+
+    config_accessor(:api_url_live) do
+      "https://rest.immobilienscout24.de/" \
+      "restapi/api/offer/#{api_version}"
+    end
+    config_accessor(:api_url_sandbox) do
+      "https://rest.sandbox-immobilienscout24.de/" \
+      "restapi/api/offer/#{api_version}"
+    end
+  end
+end

data/lib/immoscout/errors/failed.rb

@@ -0,0 +1,11 @@
+module Immoscout
+  module Errors
+    class Failed < StandardError
+      def initialize(response)
+        @status = response.status
+        @body   = response.body
+        super(["HTTP #{@status}", @body])
+      end
+    end
+  end
+end

data/lib/immoscout/models.rb

@@ -0,0 +1,9 @@
+require_relative 'errors/failed'
+require_relative 'api/client'
+# renderable models
+require_relative 'models/house_buy'
+require_relative 'models/apartment_buy'
+require_relative 'models/contact'
+require_relative 'models/publish'
+require_relative 'models/picture'
+require_relative 'models/document'

data/lib/immoscout/models/actions/attachment.rb

@@ -0,0 +1,82 @@
+require 'json'
+require_relative '../concerns/modelable'
+
+module Immoscout
+  module Models
+    module Actions
+      module Attachment
+        extend ActiveSupport::Concern
+
+        included do
+          include Immoscout::Models::Concerns::Modelable
+
+          self.unpack_collection = proc do |hash|
+            hash
+              .fetch("common.attachments")
+              .first
+              .fetch("attachment")
+          end
+
+          def save
+            attachable_id = attachable.try(:id) || attachable
+            response = api.post(
+              "user/#{api.user_name}/realestate/#{attachable_id}/attachment",
+              nil,
+              attachment: Faraday::UploadIO.new(file, content_type, file_name),
+              metadata: as_json
+            )
+            handle_response(response)
+            self.id = id_from_response(response)
+            self
+          end
+
+          def destroy
+            attachable_id = attachable.try(:id) || attachable
+            response = api.delete(
+              "user/#{api.user_name}/realestate/#{attachable_id}/attachment/#{id}",
+            )
+            handle_response(response)
+            self
+          end
+
+          private
+
+          def file_extension
+            File.extname(file_name)
+          end
+
+          def file_name
+            File.basename(file)
+          end
+
+          def content_type
+            self.class.content_type_from_extension file_extension.downcase
+          end
+        end
+
+        class_methods do
+          def content_type_from_extension(ext)
+            {
+              ".jpg"  => "image/jpeg",
+              ".jpeg" => "image/jpeg",
+              ".gif"  => "image/gif",
+              ".png"  => "image/png",
+              ".pdf"  => "application/pdf"
+            }.fetch(ext)
+          end
+
+          def all(real_estate_id)
+            response = api.get(
+              "user/#{api.user_name}/realestate/#{real_estate_id}/attachment"
+            )
+            handle_response(response)
+            objects = unpack_collection.call(response.body)
+            objects
+              .map { |object| new(object) }
+              .select { |object| object.type =~ /#{name.demodulize}/i }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/immoscout/models/actions/contact.rb

@@ -0,0 +1,75 @@
+require 'json'
+require_relative '../concerns/modelable'
+
+module Immoscout
+  module Models
+    module Actions
+      module Contact
+        extend ActiveSupport::Concern
+
+        included do
+          include Immoscout::Models::Concerns::Modelable
+
+          self.unpack_collection = proc do |hash|
+            hash
+              .fetch("common.realtorContactDetailsList", {})
+              .fetch("realtorContactDetails", nil)
+          end
+
+          def save
+            response = \
+              if id
+                api.put("user/#{api.user_name}/contact/#{id}", as_json)
+              else
+                api.post("user/#{api.user_name}/contact", as_json)
+              end
+
+            handle_response(response)
+            self.id = id_from_response(response) unless id
+            self
+          end
+
+          def destroy
+            response = api.delete("user/#{api.user_name}/contact/#{id}")
+            handle_response(response)
+            self
+          end
+        end
+
+        class_methods do
+          def find(id)
+            response = api.get("user/#{api.user_name}/contact/#{id}")
+            handle_response(response)
+            from_raw(response.body)
+          end
+
+          def find_by(hash)
+            external_id = hash.symbolize_keys.fetch(:external_id)
+            find("ext-#{external_id}")
+          end
+
+          def all
+            response = api.get("user/#{api.user_name}/contact")
+            handle_response(response)
+            objects = unpack_collection.call(response.body)
+            objects.map { |object| new(object) }
+          end
+
+          def first
+            all.first
+          end
+
+          def last
+            all.last
+          end
+
+          def create(hash)
+            instance = new(hash)
+            instance.save
+            instance
+          end
+        end
+      end
+    end
+  end
+end

data/lib/immoscout/models/actions/publish.rb

@@ -0,0 +1,33 @@
+require 'json'
+require_relative '../concerns/modelable'
+
+module Immoscout
+  module Models
+    module Actions
+      module Publish
+        extend ActiveSupport::Concern
+
+        included do
+          include Immoscout::Models::Concerns::Modelable
+
+          def save
+            response = api.post("publish", as_json)
+            handle_response(response)
+            self
+          end
+
+          def destroy
+            response = api.delete(
+              "publish/#{real_estate.id}_#{publish_channel.id}"
+            )
+            handle_response(response)
+            self
+          end
+        end
+
+        class_methods do
+        end
+      end
+    end
+  end
+end