immobilienscout24 0.1.2 → 0.1.3

data/.travis.yml

@@ -0,0 +1,10 @@
+branches:
+  only:
+    - master
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+script: rspec
+before_script:
+  - cp spec/support/auth.yml.tmpl spec/support/auth.yml

data/README.md

@@ -1,5 +1,8 @@
 # Immobilienscout24
 
+[![Build Status](https://travis-ci.org/converate-consulting-group/immobilienscout24.svg?branch=master)](https://travis-ci.org/converate-consulting-group/immobilienscout24)
+[![Gem Version](https://badge.fury.io/rb/immobilienscout24.svg)](http://badge.fury.io/rb/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.
 
 Complete API's:

data/immobilienscout24.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "immobilienscout24"
-  spec.version       = "0.1.2"
+  spec.version       = "0.1.3"
   spec.author        = ["Converate Consulting Group GmbH"]
   spec.email         = ["info@converate.com"]
   spec.description   = %q{A Ruby wrapper for the Immobilienscout24 REST API}
@@ -14,12 +14,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "faraday", "< 0.9.0"
+  spec.add_runtime_dependency "faraday", "~> 0.8.9"
   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 "simple_oauth", ">= 0"
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
 end

data/lib/immobilienscout24/api/attachment.rb

@@ -51,8 +51,8 @@ module Immobilienscout24
       # @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)}
+        attachment = ::Immobilienscout24::Helper::Attachment.new(attachment)
+        multipart  = {metadata: metadata, attachment: attachment.build}
 
         with_request_options(multipart: true) do |client|
           client.post attachment_endpoint("/attachment", options), multipart

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

@@ -35,6 +35,8 @@ module Immobilienscout24
           configure_post_request
         end
 
+        protected
+
         def set_accept_header
           request.headers['Accept'] = content_type
         end

data/lib/immobilienscout24/helper/attachment.rb

@@ -38,13 +38,13 @@ module Immobilienscout24
           @file = attachment.path
         when Immobilienscout24::Helper::Attachment
           helper = attachment
-          @file, @content_type, @filename = helper.build
-          @file_extension = helper.file_extension
+          @file, @content_type = helper.file, helper.content_type
+          @filename, @file_extension = helper.filename, helper.file_extension
         end
       end
 
       def build
-        [file, content_type, filename]
+        Faraday::UploadIO.new(file, content_type, filename)
       end
 
       def file_extension

data/spec/support/auth.yml.tmpl

@@ -1,11 +1,10 @@
-# Can be generated from playground...
-#
 # You need to ask Immobilienscout24 for a valid
 # sandbox consumer_key and secret (with all permissions)
 #
 # You can still run all tests without valid credentials as
 # as long as you don't add new requests.
-
+#
+# The token and the token_secret can be generated from the playground.
 consumer_key: your_consumer_key
 consumer_secret: your_consumer_secret
 token: your_oauth_token

data/spec/support/shared_request_strategy.rb

@@ -0,0 +1,44 @@
+shared_examples :requests do
+  let(:request) { double(:request) }
+  subject { described_class.new(request) }
+
+  describe "#configure" do
+    let(:result) { double(:result) }
+
+    context "when multipart" do
+      it "should configure the request" do
+        expect(subject).to receive(:set_accept_header)
+        expect(subject).to receive(:multipart?).and_return(true)
+        expect(subject).not_to receive(:set_content_type)
+        expect(subject).to receive(:configure_multipart_request).and_return(result)
+
+        expect(subject.configure).to eq result
+      end
+    end
+
+    context "when get" do
+      it "should configure the request" do
+        expect(subject).to receive(:set_accept_header)
+        expect(subject).to receive(:multipart?).and_return(false)
+        expect(subject).to receive(:set_content_type)
+        expect(subject).to receive(:get?).and_return(true)
+        expect(subject).to receive(:configure_get_request).and_return(result)
+
+        expect(subject.configure).to eq result
+      end
+    end
+
+    context "when post" do
+      it "should configure the request" do
+        expect(subject).to receive(:set_accept_header)
+        expect(subject).to receive(:multipart?).and_return(false)
+        expect(subject).to receive(:set_content_type)
+        expect(subject).to receive(:get?).and_return(false)
+        expect(subject).to receive(:configure_post_request).and_return(result)
+
+        expect(subject.configure).to eq result
+      end
+    end
+  end
+
+end

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

@@ -1,7 +1,93 @@
 require 'spec_helper'
 
 describe Immobilienscout24::Api::Attachment do
+  subject { Class.new.send(:include, described_class).new }
+  let(:endpoint) { double(:endpoint) }
+  let(:response) { double(:response) }
 
-  # TODO: write specs
+  describe "#attachments" do
+    it "should return a response" do
+      expect(subject).to receive(:attachment_endpoint).with("/attachment", {}).and_return(endpoint)
+      expect(subject).to receive(:get).with(endpoint).and_return(response)
+
+      expect(subject.attachments).to eq response
+    end
+  end
+
+  describe "#attachment" do
+    let(:attachment_id) { 1 }
+    it "should return a response" do
+      expect(subject).to receive(:attachment_endpoint).with("/attachment/#{attachment_id}", {}).and_return(endpoint)
+      expect(subject).to receive(:get).with(endpoint).and_return(response)
+
+      expect(subject.attachment(attachment_id)).to eq response
+    end
+  end
+
+  describe "#create_attachment" do
+    let(:metadata) { double(:metadata) }
+    let(:attachment) { double(:attachment) }
+    let(:helper) { double(:helper) }
+    let(:fileio) { double(:fileio) }
+
+    it "should return a response" do
+      expect(Immobilienscout24::Helper::Attachment).to receive(:new).
+        with(attachment).and_return(helper)
+      expect(helper).to receive(:build).and_return(fileio)
+      expect(subject).to receive(:with_request_options).with(multipart: true).
+        and_return(response)
+
+      multipart = {metadata: metadata, attachment: attachment}
+      expect(subject.create_attachment(metadata, attachment)).to eq response
+    end
+  end
+
+  describe "#update_attachment" do
+    let(:attachment_id) { 1 }
+    let(:attachment) { double(:attachment) }
+
+    it "should return a response" do
+      expect(subject).to receive(:attachment_endpoint).with("/attachment/#{attachment_id}", {}).and_return(endpoint)
+      expect(subject).to receive(:put).with(endpoint, attachment).and_return(response)
+      expect(subject.update_attachment(attachment_id, attachment)).to eq response
+    end
+  end
+
+  describe "#delete_attachment" do
+    let(:attachment_id) { 1 }
+
+    it "should return a response" do
+      expect(subject).to receive(:attachment_endpoint).with("/attachment/#{attachment_id}", {}).and_return(endpoint)
+      expect(subject).to receive(:delete).with(endpoint).and_return(response)
+      expect(subject.delete_attachment(attachment_id)).to eq response
+    end
+  end
+
+  describe "#attachment_endpoint" do
+    let(:options) { double(:options) }
+    let(:estate) { double(:estate) }
+    let(:resource) { double(:resource) }
+
+    it "should return the endpoint" do
+      expect(options).to receive(:fetch).with(:estate).and_return(estate)
+      expect(subject).to receive(:estate_attachment_endpoint).with(estate, resource, options).and_return(endpoint)
+      expect(subject.attachment_endpoint(resource, options)).to eq endpoint
+    end
+  end
+
+  describe "#estate_attachment_endpoint" do
+    let(:estate_endpoint) { "estate_endpoint" }
+    let(:resource) { "/resource" }
+    let(:endpoint) { [estate_endpoint, resource].join }
+    let(:estate) { double(:estate) }
+
+    it "should return the endpoint" do
+      expect(subject).to receive(:real_estate_endpoint).
+        with("/realestate/#{estate}", {}).and_return(estate_endpoint)
+
+      expect(subject.estate_attachment_endpoint(estate, resource)).to eq endpoint
+    end
+
+  end
 
 end

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

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Immobilienscout24::Api::Contact do
+  subject { Class.new.send(:include, described_class).new }
+  let(:endpoint) { double(:endpoint) }
+  let(:response) { double(:response) }
+
+  describe "#contacts" do
+    it "should return a response" do
+      expect(subject).to receive(:contact_endpoint).with("/contact", {}).and_return(endpoint)
+      expect(subject).to receive(:get).with(endpoint).and_return(response)
+
+      expect(subject.contacts).to eq response
+    end
+  end
+
+  describe "#contact" do
+    let(:contact_id) { 1 }
+    it "should return a response" do
+      expect(subject).to receive(:contact_endpoint).with("/contact/#{contact_id}", {}).and_return(endpoint)
+      expect(subject).to receive(:get).with(endpoint).and_return(response)
+
+      expect(subject.contact(contact_id)).to eq response
+    end
+  end
+
+  describe "#create_contact" do
+    let(:contact) { double(:contact) }
+
+    it "should return a response" do
+      expect(subject).to receive(:contact_endpoint).with("/contact", {}).and_return(endpoint)
+      expect(subject).to receive(:post).with(endpoint, contact).and_return(response)
+
+      expect(subject.create_contact(contact)).to eq response
+    end
+  end
+
+  describe "#update_contact" do
+    let(:contact_id) { 1 }
+    let(:contact) { double(:contact) }
+
+    it "should return a response" do
+      expect(subject).to receive(:contact_endpoint).with("/contact/#{contact_id}", {}).and_return(endpoint)
+      expect(subject).to receive(:put).with(endpoint, contact).and_return(response)
+
+      expect(subject.update_contact(contact_id, contact)).to eq response
+    end
+  end
+
+  describe "#contact_endpoint" do
+    let(:options) { {} }
+    let(:resource) { double(:resource) }
+
+    it "should return the endpoint" do
+      expect(subject).to receive(:user_contact_endpoint).with("me", resource, {user: "me"}).and_return(endpoint)
+      expect(subject.contact_endpoint(resource, options)).to eq endpoint
+    end
+  end
+
+  describe "#user_contact_endpoint" do
+    let(:user) { "me" }
+    let(:resource) { "resource" }
+    let(:user_endpoint) { "/user" }
+    let(:endpoint) { [user_endpoint, resource].join }
+
+    it "should return the endpoint" do
+      expect(subject).to receive(:user_endpoint).with("/user/#{user}").and_return(user_endpoint)
+
+
+      expect(subject.user_contact_endpoint(user, resource)).to eq endpoint
+    end
+
+  end
+
+end

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

@@ -5,6 +5,25 @@ describe Immobilienscout24::Api::Publish do
   let(:endpoint) { double(:endpoint) }
   let(:response) { double(:response) }
 
+  describe "#publications" do
+    let(:estate) { double(:estate) }
+    it "should return a response" do
+      expect(subject).to receive(:publish_endpoint).with("/publish").and_return(endpoint)
+      expect(subject).to receive(:get).with(endpoint, {realestate: estate}).and_return(response)
+      expect(subject.publications(estate)).to eq response
+    end
+  end
+
+  describe "#publication" do
+    let(:publication) { 1 }
+    it "should return a response" do
+      expect(subject).to receive(:publish_endpoint).with("/publish/#{publication}").and_return(endpoint)
+      expect(subject).to receive(:get).with(endpoint).and_return(response)
+
+      expect(subject.publication(publication)).to eq response
+    end
+  end
+
   describe "#create_publications" do
     let(:publications) { double(:publications) }
 

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

@@ -5,6 +5,24 @@ describe Immobilienscout24::Api::RealEstate do
   let(:endpoint) { double(:endpoint) }
   let(:response) { double(:response) }
 
+  describe "#real_estates" do
+    it "should return a response" do
+      expect(subject).to receive(:real_estate_endpoint).with("/realestate", {}).and_return(endpoint)
+      expect(subject).to receive(:get).with(endpoint).and_return(response)
+
+      expect(subject.real_estates).to eq response
+    end
+  end
+
+  describe "#real_estate" do
+    let(:estate) { 1 }
+    it "should return a response" do
+      expect(subject).to receive(:real_estate_endpoint).with("/realestate/#{estate}", {}).and_return(endpoint)
+      expect(subject).to receive(:get).with(endpoint).and_return(response)
+
+      expect(subject.real_estate(estate)).to eq response
+    end
+  end
 
   describe "#create_real_estate" do
     let(:estate) { double(:estate) }
@@ -53,4 +71,18 @@ describe Immobilienscout24::Api::RealEstate do
     end
   end
 
+  describe "#user_real_estate_endpoint" do
+    let(:user) { "me" }
+    let(:resource) { "resource" }
+    let(:user_endpoint) { "/user" }
+    let(:endpoint) { [user_endpoint, resource].join }
+
+    it "should return the endpoint" do
+      expect(subject).to receive(:user_endpoint).with("/user/#{user}").and_return(user_endpoint)
+
+
+      expect(subject.user_real_estate_endpoint(user, resource)).to eq endpoint
+    end
+
+  end
 end

data/spec/unit/immobilienscout24/api/request/json_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Immobilienscout24::Api::Request::Json do
+  include_examples :requests
+
+  its(:content_type) { should eq "application/json" }
+  its(:extension) { should eq :json }
+
+  describe "#serialized_data" do
+    let(:data) { double(:data) }
+    let(:json) { double(:json) }
+    it "should call to_json" do
+      expect(data).to receive(:to_json).and_return(json)
+      expect(subject.serialized_data(data)).to eq json
+    end
+  end
+end

data/spec/unit/immobilienscout24/api/request/xml_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Immobilienscout24::Api::Request::Xml do
+  include_examples :requests
+
+  its(:content_type) { should eq "application/xml" }
+  its(:extension) { should eq :xml }
+
+  describe "#serialized_data" do
+    let(:data) { double(:data) }
+    let(:xml) { double(:xml) }
+    it "should call to_json" do
+      expect(data).to receive(:to_xml).and_return(xml)
+      expect(subject.serialized_data(data)).to eq xml
+    end
+  end
+end

metadata

@@ -1,32 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: immobilienscout24
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
+  prerelease: 
 platform: ruby
 authors:
 - Converate Consulting Group GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-16 00:00:00.000000000 Z
+date: 2014-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - <
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.8.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - <
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.8.9
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_xml
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -55,6 +62,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,6 +70,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -69,6 +78,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: simple_oauth
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -76,6 +86,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -83,20 +94,23 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -104,6 +118,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -118,6 +133,7 @@ files:
 - .gitignore
 - .ruby-gemset
 - .ruby-version
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -178,11 +194,15 @@ files:
 - spec/support/auth.yml.tmpl
 - spec/support/estate_support.rb
 - spec/support/integration_support.rb
+- spec/support/shared_request_strategy.rb
 - spec/support/vcr.rb
 - spec/unit/immobilienscout24/api/attachment_spec.rb
 - spec/unit/immobilienscout24/api/connection_spec.rb
+- spec/unit/immobilienscout24/api/contact_spec.rb
 - spec/unit/immobilienscout24/api/publication_spec.rb
 - spec/unit/immobilienscout24/api/real_estate_spec.rb
+- spec/unit/immobilienscout24/api/request/json_spec.rb
+- spec/unit/immobilienscout24/api/request/xml_spec.rb
 - spec/unit/immobilienscout24/api/request_spec.rb
 - spec/unit/immobilienscout24/api/search_spec.rb
 - spec/unit/immobilienscout24/api/user_spec.rb
@@ -192,26 +212,27 @@ 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'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: A Ruby wrapper for the Immobilienscout24 REST API
 test_files:
 - spec/fixtures/estate.jpg
@@ -253,11 +274,15 @@ test_files:
 - spec/support/auth.yml.tmpl
 - spec/support/estate_support.rb
 - spec/support/integration_support.rb
+- spec/support/shared_request_strategy.rb
 - spec/support/vcr.rb
 - spec/unit/immobilienscout24/api/attachment_spec.rb
 - spec/unit/immobilienscout24/api/connection_spec.rb
+- spec/unit/immobilienscout24/api/contact_spec.rb
 - spec/unit/immobilienscout24/api/publication_spec.rb
 - spec/unit/immobilienscout24/api/real_estate_spec.rb
+- spec/unit/immobilienscout24/api/request/json_spec.rb
+- spec/unit/immobilienscout24/api/request/xml_spec.rb
 - spec/unit/immobilienscout24/api/request_spec.rb
 - spec/unit/immobilienscout24/api/search_spec.rb
 - spec/unit/immobilienscout24/api/user_spec.rb

checksums.yaml

@@ -1,15 +0,0 @@
----
-!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=