immobilienscout24 0.1.1 → 0.1.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    M2U2NTE0NTQxOWRiODYyZDE3M2I0YTE1M2MxNGRiNzE0NjM1NjMzNQ==
+  data.tar.gz: !binary |-
+    MWUyMjQ1ZWY1MGM3OTAzZWVjODEyMTNiYmEyZTYzMGI0OWViMmE1MA==
+SHA512:
+  metadata.gz: !binary |-
+    NDRlMzcyZTYyZjQ5MmRiNTY2MjQzMDIxZDZmZTRmYzk1ZjFmMzI3ZGQyODFk
+    NDdhYmJiZGVjMjE4YzgyNjdkOGEyZjc3Nzc0MzNmNjEzMmNjNmZkZWZmMDdl
+    ZDBmMGY0ZjBhMGEwNGRlMTk3M2U2NTZiZWUyMzUzYzQ4ZDA3NmM=
+  data.tar.gz: !binary |-
+    ODY4NDUzYjFhM2U3Mzc2ZjI5ZjM5NmNhYWRmY2I3YThkOWY2Zjc5MzMzM2U5
+    Y2ZiMDdkNTA4ZGE1ODFmYWFkMmIzODYzMmM4ODJlMjk4NjA5MTUzNDVjMzRk
+    YzMyYTFhZGExZWRiYTY1MzgzOGIyODk1YWE2YjMzYzYxNjc2ZGY=

data/README.md

@@ -1,8 +1,25 @@
 # Immobilienscout24
 
-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.
+A Ruby wrapper for the Immobilienscout24 REST API. This wrapper has all the important parts for the import and export of real estates from and to Immobilienscout24.
 
-*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.*
+Complete API's:
+
+* Attachment
+* Contact
+* Publish
+* RealEstate
+* User
+
+Incomplete:
+
+* Search
+* Expose
+* Geo Services
+* Product Valuation Services
+* Realtor
+* Construction Financing Lead engine API
+
+In the spirit of free software, everyone is encouraged to help improve this project.
 
 ## Quick start
 
@@ -22,15 +39,14 @@ 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
+immoscout_client = Immobilienscout24.client(token: 'your_oauth_token', token_secret: 'your_oauth_token_secret')
+immoscout_client.real_estates
 ```
 
 For the oauth process you can use the excellent [omniauth-immobilienscout24][oauthgem] gem.
@@ -38,6 +54,70 @@ For the oauth process you can use the excellent [omniauth-immobilienscout24][oau
 [oauthgem]: https://github.com/endil/omniauth-immobilienscout24
 
 
+### Consuming resources
+
+Most methods return a [Hashie::Mash][hashie] object which provides dot notation and `[]` access for fields returned in the API response.
+
+[hashie]: https://github.com/intridea/hashie#mash
+
+```ruby
+# Fetch the real estates
+real_estates = immoscout_client.real_estates
+
+# Sorry, we haven't invented the Immobilienscout24 response...
+real_estates = real_estates["realestates.realEstates"].realEstateList.realEstateElement
+
+# Iterate over results
+real_estates.each do |real_estate|
+  puts real_estate.title
+  # etc.
+end
+```
+
+### Creating / Updating resources
+
+The creation / modification of resources follows one simple rule: If you make JSON requests then the object that you send via the api has to respond to `to_json`. If you make XML requests then it has to respond to `to_xml`.
+
+```ruby
+# Wrapper class for our request
+class ImmoscoutEstate
+
+  def to_json
+    # generates the json for
+    # the real estate that you want to create / update
+  end
+
+end
+
+immoscout_estate = ImmoscoutEstate.new
+
+# `to_json` will be called on the immoscout_estate object
+immoscout_client.create_real_estate(immoscout_estate)
+```
+
+### Configuration
+
+For a basic configuration you just enter your `consumer_key` and `consumer_secret`.
+
+```ruby
+Immobilienscout24.configure do |config|
+  config.consumer_key = 'your_consumer_key'
+  config.consumer_secret = 'your_consumer_secret'
+end
+
+# If you want to use the sandbox
+config.sandbox = true
+
+# If you want to generate a log file
+config.faraday_logger = [:logger, Logger.new('log/immobilienscout24.log')]
+
+# If you want to use xml
+config.request_strategy = Immobilienscout24::Api::Request::Xml
+```
+
+There are more advanced configuration options. Take a look at `Immobilienscout24::Configuration`.
+
+
 ## Contributing
 
 1. Fork it

data/immobilienscout24.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "immobilienscout24"
-  spec.version       = "0.1.1"
+  spec.version       = "0.1.2"
   spec.author        = ["Converate Consulting Group GmbH"]
   spec.email         = ["info@converate.com"]
   spec.description   = %q{A Ruby wrapper for the Immobilienscout24 REST API}

data/lib/immobilienscout24/api/attachment.rb

@@ -3,13 +3,53 @@ module Immobilienscout24
 
     # Methods for the Attachment API
     #
+    # For all methods you must provide the immoscout estate id in the options hash.
+    #
+    # @example
+    #   client.attachment(663515214, estate: estate_id)
+    #
+    # Per default the client will use the current user (`me`).
+    # If you want to use an other user then you have to provide
+    # the id in the options hash.
+    #
+    # @example
+    #   client.attachment(663515214, estate: estate_id, user: immoscout_user_id)
+    #
     # @see http://developerwiki.immobilienscout24.de/wiki/User/Realestate/attachment
     module Attachment
 
+      # Get a list of all attachments
+      #
+      # @param options [Hash] Additional options
+      # @return [Hashie::Mash] Immobilienscout24 response
+      # @see http://developerwiki.immobilienscout24.de/wiki/User/Realestate/attachment/GETALL
+      # @example
+      #   client.attachments(estate: 62412598)
       def attachments(options = {})
         get attachment_endpoint("/attachment", options)
       end
 
+      # Get an attachment by id
+      #
+      # @param id [String, Integer] Attachment id
+      # @param options [Hash] Additional options
+      # @return [Hashie::Mash] Immobilienscout24 response
+      # @see http://developerwiki.immobilienscout24.de/wiki/User/Realestate/attachment/GETbyID
+      # @example
+      #   client.attachment(663515214, estate: 62412598)
+      def attachment(id, options = {})
+        get attachment_endpoint("/attachment/#{id}", options)
+      end
+
+      # Create an attachment
+      #
+      # @param metadata [Hash] Object that contains the information about the attachment (title etc.)
+      # @param attachment [String, Hash, Array, Attachment, File] Contains the file information
+      # @param options [Hash] Additional options
+      # @return [Hashie::Mash] Immobilienscout24 response
+      # @see http://developerwiki.immobilienscout24.de/wiki/User/Realestate/attachment/POST
+      # @example
+      #   client.create_attachment(matadata, 'path/to/attachment.jpg', estate: 62412598)
       def create_attachment(metadata, attachment, options = {})
         attachment = ::Immobilienscout24::Helper::Attachment.new(attachment).build
         multipart  = {metadata: metadata, attachment: Faraday::UploadIO.new(*attachment)}
@@ -19,12 +59,38 @@ module Immobilienscout24
         end
       end
 
+      # Update an attachment
+      #
+      # @param id [String, Integer] Attachment id
+      # @param attachment [Hash] Attachment meta data to be updated (title etc.). You can't upload a new file.
+      # @param options [Hash] Additional options
+      # @return [Hashie::Mash] Immobilienscout24 response
+      # @see http://developerwiki.immobilienscout24.de/wiki/User/Realestate/attachment/PUTbyID
+      # @example
+      #   client.update_attachment(663515214, attachment, estate: 62412598)
+      def update_attachment(id, attachment, options = {})
+        put attachment_endpoint("/attachment/#{id}", options), attachment
+      end
+
+      # Delete an attachment
+      #
+      # @param id [String, Integer] Attachment id
+      # @param options [Hash] Additional options
+      # @return [Hashie::Mash] Immobilienscout24 response
+      # @see http://developerwiki.immobilienscout24.de/wiki/User/Realestate/attachment/DELETEbyID
+      # @example
+      #   client.delete_attachment(663515214, estate: 62412598)
       def delete_attachment(id, options = {})
         delete attachment_endpoint("/attachment/#{id}", options)
       end
 
       # -- endpoint
 
+      # Generates the attachment endpoint
+      #
+      # @param resource [String, Integer] In most cases the id of the attachment
+      # @param options [Hash] Additional options
+      # @return [String] The url to the attachment resource
       def attachment_endpoint(resource, options = {})
         estate = options.fetch(:estate)
         estate_attachment_endpoint(estate, resource, options)

data/lib/immobilienscout24/api/connection.rb

@@ -1,7 +1,13 @@
 module Immobilienscout24
   module Api
+
+    # Methods for the Immobilienscout24 connection
     module Connection
 
+      # Used for every API call to Immobilienscout24.
+      #
+      # @return [Faraday::Connection] Connection handler.
+      # @see https://github.com/lostisland/faraday
       def connection
         connection = ::Faraday::Connection.new(configuration.faraday_connection) do |builder|
           builder.request  :oauth, oauth_credentials

data/lib/immobilienscout24/api/contact.rb

@@ -3,27 +3,71 @@ module Immobilienscout24
 
     # Methods for the Contact API
     #
+    # Per default the client will use the current user (`me`).
+    # If you want to use an other user then you have to provide
+    # the id in the options hash.
+    #
+    # @example
+    #   client.contact(663515214, user: immoscout_user_id)
+    #
     # @see http://developerwiki.immobilienscout24.de/wiki/User/Contact
     module Contact
 
+      # Get a list of all contacts
+      #
+      # @param options [Hash] Additional options
+      # @return [Hashie::Mash] Immobilienscout24 response
+      # @see http://developerwiki.immobilienscout24.de/wiki/User/Contact/GETALL
+      # @example
+      #   client.contacts
       def contacts(options = {})
         get contact_endpoint("/contact", options)
       end
 
-      def contact(id)
-        get contact_endpoint("/contact/#{id}")
+      # Get a contact
+      #
+      # @param id [String, Integer] Contact id
+      # @param options [Hash] Additional options
+      # @return [Hashie::Mash] Immobilienscout24 response
+      # @see http://developerwiki.immobilienscout24.de/wiki/User/Contact/GETbyID
+      # @example
+      #   client.contact(663515214)
+      def contact(id, options = {})
+        get contact_endpoint("/contact/#{id}", options)
       end
 
+      # Create a contact
+      #
+      # @param contact [Hash] The new contact
+      # @param options [Hash] Additional options
+      # @return [Hashie::Mash] Immobilienscout24 response
+      # @see http://developerwiki.immobilienscout24.de/wiki/User/Contact/POST
+      # @example
+      #   client.create_contact(contact)
       def create_contact(contact, options = {})
         post contact_endpoint("/contact", options), contact
       end
 
+      # Update a contact
+      #
+      # @param id [String, Integer] Contact id
+      # @param contact [Hash] Data to update
+      # @param options [Hash] Additional options
+      # @return [Hashie::Mash] Immobilienscout24 response
+      # @see http://developerwiki.immobilienscout24.de/wiki/User/Contact/PUTbyID
+      # @example
+      #   client.update_contact(663515214, contact)
       def update_contact(id, contact, options = {})
         put contact_endpoint("/contact/#{id}", options), contact
       end
 
       # -- endpoint
 
+      # Generates the contact endpoint
+      #
+      # @param resource [String, Integer] In most cases the id of the contact
+      # @param options [Hash] Additional options
+      # @return [String] The url to the contact resource
       def contact_endpoint(resource, options = {})
         options = {user: "me"}.merge(options)
         user_contact_endpoint(options.fetch(:user), resource, options)

data/lib/immobilienscout24/api/publish.rb

@@ -7,29 +7,69 @@ module Immobilienscout24
     # @see http://developerwiki.immobilienscout24.de/wiki/PublishChannel/GET
     module Publish
 
+      # Get a list of all publications
+      #
+      # @param estate [Hash] Estate id
+      # @param params [Hash] Additional request parameters
+      # @return [Hashie::Mash] Immobilienscout24 response
+      # @see http://developerwiki.immobilienscout24.de/wiki/Publish/GET
+      # @example
+      #   client.publications(estate_id)
       def publications(estate, params = {})
         params = {realestate: estate}.merge(params)
         get publish_endpoint("/publish"), params
       end
 
+      # Get a single publication
+      #
+      # @param id [String] Publication id
+      # @return [Hashie::Mash] Immobilienscout24 response
+      # @see http://developerwiki.immobilienscout24.de/wiki/Publish/GETbyID
+      # @example
+      #   client.publication(publication_id)
       def publication(id)
         get publish_endpoint("/publish/#{id}")
       end
 
+      # Create multiple publications
+      #
+      # @param publications [Hash] Publication data
+      # @return [Hashie::Mash] Immobilienscout24 response
+      # @see http://developerwiki.immobilienscout24.de/wiki/Publish/POST
+      # @example
+      #   client.create_publications(publications)
       def create_publications(publications)
         post publish_endpoint("/publish/list"), publications
       end
 
+      # Create a single publication
+      #
+      # @param publication [Hash] Publication data
+      # @return [Hashie::Mash] Immobilienscout24 response
+      # @see http://developerwiki.immobilienscout24.de/wiki/Publish/POSTbyID
+      # @example
+      #   client.create_publication(publication)
       def create_publication(publication)
         post publish_endpoint("/publish"), publication
       end
 
+      # Delete a publication
+      #
+      # @param id [String] Publication id
+      # @return [Hashie::Mash] Immobilienscout24 response
+      # @see http://developerwiki.immobilienscout24.de/wiki/Publish/DELETEbyID
+      # @example
+      #   client.delete_publication(publication_id)
       def delete_publication(id)
         delete publish_endpoint("/publish/#{id}")
       end
 
       # -- endpoint
 
+      # Generates the publish endpoint
+      #
+      # @param resource [String, Integer] In most cases the id of the publication
+      # @return [String] The url to the publish resource
       def publish_endpoint(resource)
         ["api/offer/#{api_version}", resource].join
       end

data/lib/immobilienscout24/api/real_estate.rb

@@ -3,31 +3,83 @@ module Immobilienscout24
 
     # Methods for the RealEstate API
     #
+    # Per default the client will use the current user (`me`).
+    # If you want to use an other user then you have to provide
+    # the id in the options hash.
+    #
+    # @example
+    #   client.real_estate(663515214, user: immoscout_user_id)
+    #
     # @see http://developerwiki.immobilienscout24.de/wiki/User/Realestate
     module RealEstate
 
+      # Get a list of all real estates
+      #
+      # @param options [Hash] Additional options
+      # @return [Hashie::Mash] Immobilienscout24 response
+      # @see http://developerwiki.immobilienscout24.de/wiki/User/Realestate/GETALL
+      # @example
+      #   client.real_estates
       def real_estates(options = {})
         get real_estate_endpoint("/realestate", options)
       end
 
+      # Get a single real estate
+      #
+      # @param id [String, Integer] Real estate id
+      # @param options [Hash] Additional options
+      # @return [Hashie::Mash] Immobilienscout24 response
+      # @see http://developerwiki.immobilienscout24.de/wiki/User/Realestate/GETbyID
+      # @example
+      #   client.real_estate(real_estate_id)
       def real_estate(id, options = {})
         get real_estate_endpoint("/realestate/#{id}", options)
       end
 
+      # Create a real estate
+      #
+      # @param estate [Hash] Estate data
+      # @param options [Hash] Additional options
+      # @return [Hashie::Mash] Immobilienscout24 response
+      # @see http://developerwiki.immobilienscout24.de/wiki/User/Realestate/POST
+      # @example
+      #   client.create_real_estate(estate)
       def create_real_estate(estate, options = {})
         post real_estate_endpoint("/realestate", options), estate
       end
 
+      # Update a real estate
+      #
+      # @param id [String, Integer] Real estate id
+      # @param estate [Hash] Estate data
+      # @param options [Hash] Additional options
+      # @return [Hashie::Mash] Immobilienscout24 response
+      # @see http://developerwiki.immobilienscout24.de/wiki/User/Realestate/PUTbyID
+      # @example
+      #   client.update_real_estate(estate_id, data)
       def update_real_estate(id, estate, options = {})
         put real_estate_endpoint("/realestate/#{id}", options), estate
       end
 
+      # Delete a real estate
+      #
+      # @param id [String, Integer] Real estate id
+      # @param options [Hash] Additional options
+      # @return [Hashie::Mash] Immobilienscout24 response
+      # @see http://developerwiki.immobilienscout24.de/wiki/User/Realestate/DELETEbyID
+      # @example
+      #   client.delete_real_estate(estate_id, data)
       def delete_real_estate(id, options = {})
         delete real_estate_endpoint("/realestate/#{id}", options)
       end
 
       # -- endpoint
 
+      # Generates the real estate endpoint
+      #
+      # @param resource [String, Integer] In most cases the id of the real estate
+      # @param options [Hash] Additional options
+      # @return [String] The url to the real estate resource
       def real_estate_endpoint(resource, options = {})
         options = {user: "me"}.merge(options)
         user_real_estate_endpoint(options.fetch(:user), resource, options)

data/spec/fixtures/vcr_cassettes/Immobilienscout24_Api_Attachment/attachment/should_retrieve_a_single_attachment.json

@@ -0,0 +1 @@
+{"http_interactions":[{"request":{"method":"get","uri":"http://rest.sandbox-immobilienscout24.de/restapi/api/offer/v1.0/user/me/realestate/62412598/attachment/663515214","body":{"encoding":"US-ASCII","base64_string":""},"headers":{"User-Agent":["Faraday v0.8.9"],"Accept":["application/json"],"Content-Type":["application/json;charset=UTF-8"]}},"response":{"status":{"code":200,"message":null},"headers":{"server":["Apache-Coyote/1.1"],"date":["Wed, 16 Apr 2014 17:24:36 GMT"],"content-type":["application/json;charset=UTF-8"],"content-length":["1940"],"connection":["close"]},"body":{"encoding":"US-ASCII","base64_string":"eyJjb21tb24uYXR0YWNobWVudCI6eyJAeHNpLnR5cGUiOiJjb21tb246UGlj\ndHVyZSIsIkB4bGluay5ocmVmIjoiaHR0cDpcL1wvcmVzdC5zYW5kYm94LWlt\nbW9iaWxpZW5zY291dDI0LmRlXC9yZXN0YXBpXC9hcGlcL29mZmVyXC92MS4w\nXC91c2VyXC9tZVwvcmVhbGVzdGF0ZVwvNjI0MTI1OThcL2F0dGFjaG1lbnRc\nLzY2MzUxNTIxNFwvNjYzNTE1MjE0IiwiQGlkIjoiNjYzNTE1MjE0IiwidGl0\nbGUiOiJFc3RhdGUgUGljdHVyZSIsImZsb29ycGxhbiI6ImZhbHNlIiwidGl0\nbGVQaWN0dXJlIjoidHJ1ZSIsInVybHMiOlt7InVybCI6W3siQHNjYWxlIjoi\nU0NBTEUiLCJAaHJlZiI6Imh0dHA6XC9cL3RwaWN0dXJlLmltbW9iaWxpZW5z\nY291dDI0LmRlXC9waWNcL29yaWcwNFwvTlwvMTAzXC85NlwvNDIzXC8xMDMw\nOTY0MjMtMC5qcGdcL09SSUdcL3Jlc2l6ZVwvJVdJRFRIJXglSEVJR0hUJSUz\nRVwvZm9ybWF0XC9qcGc/OTkzOTM1NTA1In0seyJAc2NhbGUiOiJTQ0FMRV9B\nTkRfQ1JPUCIsIkBocmVmIjoiaHR0cDpcL1wvdHBpY3R1cmUuaW1tb2JpbGll\nbnNjb3V0MjQuZGVcL3BpY1wvb3JpZzA0XC9OXC8xMDNcLzk2XC80MjNcLzEw\nMzA5NjQyMy0wLmpwZ1wvT1JJR1wvbGVnYWN5X3RodW1ibmFpbFwvJVdJRFRI\nJXglSEVJR0hUJVwvZm9ybWF0XC9qcGc/OTkzOTM1NTA1In0seyJAc2NhbGUi\nOiJXSElURV9GSUxMSU5HIiwiQGhyZWYiOiJodHRwOlwvXC90cGljdHVyZS5p\nbW1vYmlsaWVuc2NvdXQyNC5kZVwvcGljXC9vcmlnMDRcL05cLzEwM1wvOTZc\nLzQyM1wvMTAzMDk2NDIzLTAuanBnXC9PUklHXC9yZXNpemVcLyVXSURUSCV4\nJUhFSUdIVCUlM0VcL2V4dGVudFwvJVdJRFRIJXglSEVJR0hUJVwvZm9ybWF0\nXC9qcGc/OTkzOTM1NTA1In0seyJAc2NhbGUiOiJTQ0FMRV81NDB4NTQwIiwi\nQGhyZWYiOiJodHRwOlwvXC90cGljdHVyZS5pbW1vYmlsaWVuc2NvdXQyNC5k\nZVwvcGljXC9vcmlnMDRcL05cLzEwM1wvOTZcLzQyM1wvMTAzMDk2NDIzLTAu\nanBnXC9PUklHXC9yZXNpemVcLzU0MHg1NDAlM0VcL2Zvcm1hdFwvanBnPzk5\nMzkzNTUwNSJ9LHsiQHNjYWxlIjoiU0NBTEVfMjEweDIxMCIsIkBocmVmIjoi\naHR0cDpcL1wvdHBpY3R1cmUuaW1tb2JpbGllbnNjb3V0MjQuZGVcL3BpY1wv\nb3JpZzA0XC9OXC8xMDNcLzk2XC80MjNcLzEwMzA5NjQyMy0wLmpwZ1wvT1JJ\nR1wvcmVzaXplXC8yMTB4MjEwJTNFXC9mb3JtYXRcL2pwZz85OTM5MzU1MDUi\nfSx7IkBzY2FsZSI6IlNDQUxFXzQwMHgzMDAiLCJAaHJlZiI6Imh0dHA6XC9c\nL3RwaWN0dXJlLmltbW9iaWxpZW5zY291dDI0LmRlXC9waWNcL29yaWcwNFwv\nTlwvMTAzXC85NlwvNDIzXC8xMDMwOTY0MjMtMC5qcGdcL09SSUdcL3Jlc2l6\nZVwvNDAweDMwMCUzRVwvZm9ybWF0XC9qcGc/OTkzOTM1NTA1In0seyJAc2Nh\nbGUiOiJTQ0FMRV8xMTh4MTE4IiwiQGhyZWYiOiJodHRwOlwvXC90cGljdHVy\nZS5pbW1vYmlsaWVuc2NvdXQyNC5kZVwvcGljXC9vcmlnMDRcL05cLzEwM1wv\nOTZcLzQyM1wvMTAzMDk2NDIzLTAuanBnXC9PUklHXC9yZXNpemVcLzExOHgx\nMTglM0VcL2V4dGVudFwvMTE4eDExOFwvZm9ybWF0XC9qcGc/OTkzOTM1NTA1\nIn0seyJAc2NhbGUiOiJTQ0FMRV82MHg2MCIsIkBocmVmIjoiaHR0cDpcL1wv\ndHBpY3R1cmUuaW1tb2JpbGllbnNjb3V0MjQuZGVcL3BpY1wvb3JpZzA0XC9O\nXC8xMDNcLzk2XC80MjNcLzEwMzA5NjQyMy0wLmpwZ1wvT1JJR1wvcmVzaXpl\nXC82MHg2MCUzRVwvZXh0ZW50XC82MHg2MFwvZm9ybWF0XC9qcGc/OTkzOTM1\nNTA1In0seyJAc2NhbGUiOiJTQ0FMRV83M3g3MyIsIkBocmVmIjoiaHR0cDpc\nL1wvdHBpY3R1cmUuaW1tb2JpbGllbnNjb3V0MjQuZGVcL3BpY1wvb3JpZzA0\nXC9OXC8xMDNcLzk2XC80MjNcLzEwMzA5NjQyMy0wLmpwZ1wvT1JJR1wvbGVn\nYWN5X3RodW1ibmFpbFwvNzN4NzNcL2Zvcm1hdFwvanBnPzk5MzkzNTUwNSJ9\nXX1dfX0=\n"},"http_version":null},"recorded_at":"Wed, 16 Apr 2014 17:24:36 GMT"}],"recorded_with":"VCR 2.9.0"}

data/spec/fixtures/vcr_cassettes/Immobilienscout24_Api_Attachment/update_attachment/should_update_the_attachment.json

@@ -0,0 +1 @@
+{"http_interactions":[{"request":{"method":"put","uri":"http://rest.sandbox-immobilienscout24.de/restapi/api/offer/v1.0/user/me/realestate/62412598/attachment/663515214","body":{"encoding":"UTF-8","base64_string":"eyJjb21tb24uYXR0YWNobWVudCI6eyJAeG1sbnMiOnsiY29tbW9uIjoiaHR0\ncDovL3Jlc3QuaW1tb2JpbGllbnNjb3V0MjQuZGUvc2NoZW1hL2NvbW1vbi8x\nLjAifSwiQHhzaS50eXBlIjoiY29tbW9uOlBpY3R1cmUiLCJ0aXRsZSI6IkVz\ndGF0ZSBQaWN0dXJlIiwiZmxvb3JwbGFuIjoiZmFsc2UiLCJ0aXRsZVBpY3R1\ncmUiOiJmYWxzZSJ9fQ==\n"},"headers":{"User-Agent":["Faraday v0.8.9"],"Accept":["application/json"],"Content-Type":["application/json;charset=UTF-8"]}},"response":{"status":{"code":200,"message":null},"headers":{"server":["Apache-Coyote/1.1"],"date":["Wed, 16 Apr 2014 17:28:22 GMT"],"content-type":["application/json;charset=UTF-8"],"content-length":["149"],"connection":["close"]},"body":{"encoding":"US-ASCII","base64_string":"eyJjb21tb24ubWVzc2FnZXMiOlt7Im1lc3NhZ2UiOnsibWVzc2FnZUNvZGUi\nOiJNRVNTQUdFX1JFU09VUkNFX1VQREFURUQiLCJtZXNzYWdlIjoiUmVzb3Vy\nY2UgW2F0dGFjaG1lbnRdIHdpdGggaWQgWzY2MzUxNTIxNF0gaGFzIGJlZW4g\ndXBkYXRlZC4gIn19XX0=\n"},"http_version":null},"recorded_at":"Wed, 16 Apr 2014 17:28:22 GMT"}],"recorded_with":"VCR 2.9.0"}

data/spec/integration/attachment_spec.rb

@@ -11,6 +11,13 @@ describe Immobilienscout24::Api::Attachment, vcr: true do
     end
   end
 
+  describe "attachment" do
+    it "should retrieve a single attachment" do
+      result = client.attachment(663515214, estate: 62412598)
+      expect(result).to include "common.attachment"
+    end
+  end
+
   describe "create attachment" do
     let(:attachment) { File.join(fixture_path, 'estate.jpg') }
     let(:meta) { mashify_fixture('raw_picture.json') }
@@ -21,6 +28,15 @@ describe Immobilienscout24::Api::Attachment, vcr: true do
     end
   end
 
+  describe "update attachment" do
+    let(:attachment) { mashify_fixture('raw_picture.json') }
+
+    it "should update the attachment" do
+      result = client.update_attachment(663515214, attachment, estate: 62412598)
+      expect(result.inspect).to include "MESSAGE_RESOURCE_UPDATED"
+    end
+  end
+
   describe "delete attachment" do
     it "should delete an attachment" do
       result = client.delete_attachment(663517286, estate: 62412598)

data/spec/unit/immobilienscout24/api/attachment_spec.rb

@@ -1,5 +1,7 @@
 require 'spec_helper'
 
 describe Immobilienscout24::Api::Attachment do
-  pending "todo"
+
+  # TODO: write specs
+
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: immobilienscout24
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.1.2
 platform: ruby
 authors:
 - Converate Consulting Group GmbH
@@ -14,7 +13,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - <
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - <
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_xml
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: simple_oauth
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -94,7 +83,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -110,7 +97,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -118,7 +104,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -161,9 +146,11 @@ files:
 - spec/fixtures/raw_picture.json
 - spec/fixtures/raw_publication.json
 - spec/fixtures/raw_publications.json
+- spec/fixtures/vcr_cassettes/Immobilienscout24_Api_Attachment/attachment/should_retrieve_a_single_attachment.json
 - spec/fixtures/vcr_cassettes/Immobilienscout24_Api_Attachment/attachments/should_retrieve_all_attachments.json
 - spec/fixtures/vcr_cassettes/Immobilienscout24_Api_Attachment/create_attachment/should_create_the_attachment.json
 - spec/fixtures/vcr_cassettes/Immobilienscout24_Api_Attachment/delete_attachment/should_delete_an_attachment.json
+- spec/fixtures/vcr_cassettes/Immobilienscout24_Api_Attachment/update_attachment/should_update_the_attachment.json
 - spec/fixtures/vcr_cassettes/Immobilienscout24_Api_Contact/contact/should_retrieve_a_signle_contact.json
 - spec/fixtures/vcr_cassettes/Immobilienscout24_Api_Contact/contacts/should_retrieve_all_contacts.json
 - spec/fixtures/vcr_cassettes/Immobilienscout24_Api_Contact/create_contact/should_create_the_contact.json
@@ -205,33 +192,26 @@ files:
 homepage: https://github.com/converate-consulting-group/immobilienscout24
 licenses:
 - MIT
+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'
-      segments:
-      - 0
-      hash: -928056505246667324
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -928056505246667324
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Ruby wrapper for the Immobilienscout24 REST API
 test_files:
 - spec/fixtures/estate.jpg
@@ -241,9 +221,11 @@ test_files:
 - spec/fixtures/raw_picture.json
 - spec/fixtures/raw_publication.json
 - spec/fixtures/raw_publications.json
+- spec/fixtures/vcr_cassettes/Immobilienscout24_Api_Attachment/attachment/should_retrieve_a_single_attachment.json
 - spec/fixtures/vcr_cassettes/Immobilienscout24_Api_Attachment/attachments/should_retrieve_all_attachments.json
 - spec/fixtures/vcr_cassettes/Immobilienscout24_Api_Attachment/create_attachment/should_create_the_attachment.json
 - spec/fixtures/vcr_cassettes/Immobilienscout24_Api_Attachment/delete_attachment/should_delete_an_attachment.json
+- spec/fixtures/vcr_cassettes/Immobilienscout24_Api_Attachment/update_attachment/should_update_the_attachment.json
 - spec/fixtures/vcr_cassettes/Immobilienscout24_Api_Contact/contact/should_retrieve_a_signle_contact.json
 - spec/fixtures/vcr_cassettes/Immobilienscout24_Api_Contact/contacts/should_retrieve_all_contacts.json
 - spec/fixtures/vcr_cassettes/Immobilienscout24_Api_Contact/create_contact/should_create_the_contact.json