immobilienscout24 0.0.1 → 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWNlNWZjZmJlZmI5ZWVlNmNjOGQ5NzQyNjAzMjM5MTcwODk3NTlkMw==
+  data.tar.gz: !binary |-
+    YzNlMDY4YzM4N2NkMzA5NDNkODEwMjY2ZGU3ZWRhZGU1MTNiMzk0Yg==
+SHA512:
+  metadata.gz: !binary |-
+    ZmU3NjZkNWM1MDIzZTM4ZTYyOGRlNGNkNTkyMDA5YThkY2MxMjk4NGQyOGZi
+    MGI2ZWM0ZTRkNDkxMmIzMzZmNWI2NjkxNTczNzI4OTE2NGJhOTk2N2Y4ZjRk
+    ZDgxMTY4OWM3MGU5YWI4Y2I3YmRhOTk4OGE3ZTgyZmM5MTZmNWU=
+  data.tar.gz: !binary |-
+    ZDRhMzk2ZTBlNGViOGQ0NWExYjUyN2Q5YjE3Nzg3MjJlYzk2ODUwZGQ0NDAz
+    ZjA3NmFmN2QyYzA3YTRhZjFmMDVlMTUxNjY4OTJlMjM1MjllMTI2NWQzMjBj
+    MTMxZmQ3ZTlkYjU5MTZkNmVkMDg0OWY3MTUwYjA3Y2UzODEwYmM=

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 .DS_Store
+auth.yml

data/Gemfile

@@ -8,4 +8,5 @@ group :test do
   gem 'pry'
   gem 'vcr'
   gem 'json_spec'
+  gem 'hashie'
 end

data/README.md

@@ -1,9 +1,10 @@
 # Immobilienscout24
 
-*WORK IN PROGRESS*
-Expected release: end of april 2014
+A Ruby wrapper for the Immobilienscout24 REST API. This wrapper has all the important parts to create and maintain the real estate of a broker on Immobilienscout24.
 
-## Installation
+*Warning: This gem is not complete. There are still some parts of the Immobilienscout24 that we haven't had the time to implement. We will extend the functionallity as soon as we have more time. In the spirit of free software, everyone is encouraged to help improve this project.*
+
+## Quick start
 
 Add this line to your application's Gemfile:
 
@@ -17,9 +18,25 @@ Or install it yourself as:
 
     $ gem install immobilienscout24
 
-## Usage
+API methods are available from the `Immobilienscout24.client`.
+
+```ruby
+# Provide authentication credentials
+
+Immobilienscout24.configure do |config|
+  config.consumer_key = 'your_consumer_key'
+  config.consumer_secret = 'your_consumer_secret'
+end
+
+# Fetch your real estates
+client = Immobilienscout24.client(token: 'your_oauth_token', token_secret: 'your_oauth_token_secret')
+client.real_estates
+```
+
+For the oauth process you can use the excellent [omniauth-immobilienscout24][oauthgem] gem.
+
+[oauthgem]: https://github.com/endil/omniauth-immobilienscout24
 
-TODO: Write usage instructions here
 
 ## Contributing
 
@@ -28,3 +45,12 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## TODO
+
+* Extend API
+* Write more tests
+* Extend README
+* Write wiki about multi-tanent management
+
+

data/immobilienscout24.gemspec

@@ -2,10 +2,10 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "immobilienscout24"
-  spec.version       = "0.0.1"
+  spec.version       = "0.1.0"
   spec.author        = ["Converate Consulting Group GmbH"]
   spec.email         = ["info@converate.com"]
-  spec.description   = %q{Immobilienscout 24 API}
+  spec.description   = %q{A Ruby wrapper for the Immobilienscout24 REST API}
   spec.summary       = spec.description
   spec.homepage      = "https://github.com/converate-consulting-group/immobilienscout24"
   spec.license       = "MIT"
@@ -18,7 +18,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "faraday_middleware", ">= 0.9.0"
   spec.add_runtime_dependency "multi_xml", ">= 0"
   spec.add_runtime_dependency "hashie", ">= 0"
-  spec.add_runtime_dependency "activesupport", ">= 3.0.0"
   spec.add_runtime_dependency "simple_oauth", ">= 0"
 
   spec.add_development_dependency "bundler", "~> 1.3"

data/lib/immobilienscout24/api.rb

@@ -3,12 +3,23 @@ require "immobilienscout24/api/request"
 require "immobilienscout24/api/request/base"
 require "immobilienscout24/api/request/json"
 require "immobilienscout24/api/request/xml"
+require "immobilienscout24/api/search"
+require "immobilienscout24/api/user"
+require "immobilienscout24/api/real_estate"
+require "immobilienscout24/api/publish"
+require "immobilienscout24/api/attachment"
+require "immobilienscout24/api/contact"
 
 module Immobilienscout24
   module Api
     include Connection
     include Request
-
+    include Search
+    include User
+    include RealEstate
+    include Publish
+    include Attachment
+    include Contact
 
   end
 end

data/lib/immobilienscout24/api/attachment.rb

@@ -0,0 +1,39 @@
+module Immobilienscout24
+  module Api
+
+    # Methods for the Attachment API
+    #
+    # @see http://developerwiki.immobilienscout24.de/wiki/User/Realestate/attachment
+    module Attachment
+
+      def attachments(options = {})
+        get attachment_endpoint("/attachment", options)
+      end
+
+      def create_attachment(metadata, attachment, options = {})
+        attachment = ::Immobilienscout24::Helper::Attachment.new(attachment).build
+        multipart  = {metadata: metadata, attachment: Faraday::UploadIO.new(*attachment)}
+
+        with_request_options(multipart: true) do |client|
+          client.post attachment_endpoint("/attachment", options), multipart
+        end
+      end
+
+      def delete_attachment(id, options = {})
+        delete attachment_endpoint("/attachment/#{id}", options)
+      end
+
+      # -- endpoint
+
+      def attachment_endpoint(resource, options = {})
+        estate = options.fetch(:estate)
+        estate_attachment_endpoint(estate, resource, options)
+      end
+
+      def estate_attachment_endpoint(estate, resource, options = {})
+        [real_estate_endpoint("/realestate/#{estate}", options), resource].join
+      end
+
+    end
+  end
+end

data/lib/immobilienscout24/api/connection.rb

@@ -2,25 +2,30 @@ module Immobilienscout24
   module Api
     module Connection
 
-      def connection(options = {})
-        options = {raw: false}.merge(options)
-
-        ::Faraday::Connection.new(configuration.faraday_connection) do |builder|
+      def connection
+        connection = ::Faraday::Connection.new(configuration.faraday_connection) do |builder|
           builder.request  :oauth, oauth_credentials
+          builder.request  :multipart
           builder.request  :url_encoded
-          builder.response(*configuration.faraday_logger) unless configuration.disable_logging
-          builder.response :raise_error
+
+          if configuration.logging?
+            builder.response(*configuration.faraday_logger)
+          end
+
           builder.response :follow_redirects
 
-          unless options.fetch(:raw)
+          unless request_options[:raw_response]
             builder.response :mashify
             builder.response :xml, content_type: /\bxml$/
             builder.response :json, content_type: /\bjson$/
           end
 
-          builder.use :instrumentation
           builder.adapter configuration.faraday_adapter
+
+          configuration.build_extension.call(builder, request_options)
         end
+
+        connection
       end
 
     end

data/lib/immobilienscout24/api/contact.rb

@@ -0,0 +1,39 @@
+module Immobilienscout24
+  module Api
+
+    # Methods for the Contact API
+    #
+    # @see http://developerwiki.immobilienscout24.de/wiki/User/Contact
+    module Contact
+
+      def contacts(options = {})
+        get contact_endpoint("/contact", options)
+      end
+
+      def contact(id)
+        get contact_endpoint("/contact/#{id}")
+      end
+
+      def create_contact(contact, options = {})
+        post contact_endpoint("/contact", options), contact
+      end
+
+      def update_contact(id, contact, options = {})
+        put contact_endpoint("/contact/#{id}", options), contact
+      end
+
+      # -- endpoint
+
+      def contact_endpoint(resource, options = {})
+        options = {user: "me"}.merge(options)
+        user_contact_endpoint(options.fetch(:user), resource, options)
+      end
+
+      def user_contact_endpoint(user, resource, options = {})
+        [user_endpoint("/user/#{user}"), resource].join
+      end
+
+    end
+
+  end
+end

data/lib/immobilienscout24/api/publish.rb

@@ -0,0 +1,39 @@
+module Immobilienscout24
+  module Api
+
+    # Methods for the Publish API
+    #
+    # @see http://developerwiki.immobilienscout24.de/wiki/Publish
+    # @see http://developerwiki.immobilienscout24.de/wiki/PublishChannel/GET
+    module Publish
+
+      def publications(estate, params = {})
+        params = {realestate: estate}.merge(params)
+        get publish_endpoint("/publish"), params
+      end
+
+      def publication(id)
+        get publish_endpoint("/publish/#{id}")
+      end
+
+      def create_publications(publications)
+        post publish_endpoint("/publish/list"), publications
+      end
+
+      def create_publication(publication)
+        post publish_endpoint("/publish"), publication
+      end
+
+      def delete_publication(id)
+        delete publish_endpoint("/publish/#{id}")
+      end
+
+      # -- endpoint
+
+      def publish_endpoint(resource)
+        ["api/offer/#{api_version}", resource].join
+      end
+
+    end
+  end
+end

data/lib/immobilienscout24/api/real_estate.rb

@@ -0,0 +1,43 @@
+module Immobilienscout24
+  module Api
+
+    # Methods for the RealEstate API
+    #
+    # @see http://developerwiki.immobilienscout24.de/wiki/User/Realestate
+    module RealEstate
+
+      def real_estates(options = {})
+        get real_estate_endpoint("/realestate", options)
+      end
+
+      def real_estate(id, options = {})
+        get real_estate_endpoint("/realestate/#{id}", options)
+      end
+
+      def create_real_estate(estate, options = {})
+        post real_estate_endpoint("/realestate", options), estate
+      end
+
+      def update_real_estate(id, estate, options = {})
+        put real_estate_endpoint("/realestate/#{id}", options), estate
+      end
+
+      def delete_real_estate(id, options = {})
+        delete real_estate_endpoint("/realestate/#{id}", options)
+      end
+
+      # -- endpoint
+
+      def real_estate_endpoint(resource, options = {})
+        options = {user: "me"}.merge(options)
+        user_real_estate_endpoint(options.fetch(:user), resource, options)
+      end
+
+      def user_real_estate_endpoint(user, resource, options = {})
+        [user_endpoint("/user/#{user}"), resource].join
+      end
+
+    end
+
+  end
+end

data/lib/immobilienscout24/api/request.rb

@@ -2,37 +2,51 @@ module Immobilienscout24
   module Api
     module Request
 
-      def get(path, request_data = {}, request_options = {})
-        request(:get, path, request_data, request_options)
+      def get(path, request_data = nil, &block)
+        request(:get, path, request_data, &block)
       end
 
-      def post(path, request_data = {}, request_options = {})
-        request(:post, path, request_data, request_options)
+      def post(path, request_data = nil, &block)
+        request(:post, path, request_data, &block)
       end
 
-      def put(path, request_data = {}, request_options = {})
-        request(:put, path, request_data, request_options)
+      def put(path, request_data = nil, &block)
+        request(:put, path, request_data, &block)
       end
 
-      def delete(path, request_data = {}, request_options = {})
-        request(:delete, path, request_data, request_options)
+      def delete(path, request_data = nil, &block)
+        request(:delete, path, request_data, &block)
       end
 
-      def request(method, path, request_data = {}, request_options = {})
-        request_options = {raw: false, raw_data: false}.merge(request_options)
+      def request(method, path, request_data = nil, &block)
+        response = connection.send(method) do |request|
+          request_config = {method: method, path: path, request_data: request_data, request_options: request_options}
+          strategy = configuration.request_strategy.new(request, request_config)
+          configured_request = strategy.configure
 
-        response = connection(request_options).send(method) do |request|
-          req = configuration.request_strategy.
-            new(request).configure(method, path, request_data, request_options)
-
-          yield req if block_given?
+          yield configured_request if block_given?
         end
 
-        return response if request_options.fetch(:raw)
+        return response if request_options[:raw_response]
 
         response.body
       end
 
+      def with_request_options(options = {})
+        @request_options = request_option_defaults.merge(options)
+
+        yield self
+      ensure
+        @request_options = {}
+      end
+
+      def request_options
+        @request_options ||= {}
+      end
+
+      def request_option_defaults
+        {raw_response: false, raw_request: false}
+      end
 
     end
   end

data/lib/immobilienscout24/api/request/base.rb

@@ -1,17 +1,108 @@
-require 'delegate'
-
 module Immobilienscout24
   module Api
     module Request
 
-      class Base < SimpleDelegator
+      class Base
+
+        attr_reader :request
+        attr_reader :configuration
+
+        def initialize(request, configuration = {})
+          @request = request
+          @configuration = configuration
+        end
+
+        def serialized_data(data)
+          raise NotImplementedError
+        end
+
+        def content_type
+          raise NotImplementedError
+        end
+
+        def extension
+          raise NotImplementedError
+        end
+
+        def configure
+          set_accept_header
+
+          return configure_multipart_request if multipart?
+
+          set_content_type
+
+          return configure_get_request if get?
+          configure_post_request
+        end
+
+        def set_accept_header
+          request.headers['Accept'] = content_type
+        end
+
+        def set_content_type
+          request.headers['Content-Type'] = "#{content_type};charset=UTF-8"
+        end
+
+        def configure_multipart_request
+          request.path = path
+          request.body = prepared_multipart_data
+          request
+        end
+
+        def configure_get_request
+          request.url(path, request_data)
+          request
+        end
+
+        def configure_post_request
+          request.path = path
+          if raw_request?
+            request.body = request_data
+          else
+            request.body = serialized_data(request_data) unless request_data.nil?
+          end
+
+          request
+        end
+
+        def path
+          configuration[:path]
+        end
+
+        def multipart?
+          !!request_options[:multipart]
+        end
+
+        def raw_request?
+          !!request_options[:raw_request]
+        end
+
+        def request_data
+          configuration[:request_data]
+        end
+
+        def request_options
+          configuration[:request_options]
+        end
+
+        def request_method
+          configuration[:method]
+        end
 
-        def initialize(request)
-          super(request)
+        def get?
+          request_method == :get
         end
 
-        def configure(method, path, request_data = {}, request_options = {})
-          # implement
+        def prepared_multipart_data
+          request_data.inject({}) do |memo, (key, value)|
+            if !value.is_a?(Faraday::UploadIO)
+              io_value  = StringIO.new(serialized_data(value))
+              memo[key] = Faraday::UploadIO.new(io_value, content_type, "#{key}.#{extension}")
+            else
+              memo[key] = value
+            end
+            memo
+          end
         end
 
       end