omniauth-immobilienscout24 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.rvmrc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--backtrace

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ree
+  - jruby-18mode
+ 

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-immobilienscout24.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 endil GmbH
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+# Omniauth ImmobilienScout24
+
+This gem contains the [ImmobilienScout24](http://www.immobilienscout24.de/) strategy for [OmniAuth](https://github.com/intridea/omniauth/).
+
+ImmobilienScout24 uses [OAuth 1.0a](http://oauth.net/core/1.0a/). For information on the implementation details check out the [documentation](http://developerwiki.immobilienscout24.de/wiki/Authentication).
+
+## Preparation
+
+1. Contact the [ImmobilienScout24 API team](http://developer.immobilienscout24.de/rest-api/rest-api-zugang/) to obtain your CONSUMER_KEY and CONSUMER_SECRET.
+2. Make sure that you have already installed [OmniAuth](https://github.com/intridea/omniauth/wiki) into your application. Otherwise check out the [installation details](https://github.com/intridea/omniauth), the [documentation](https://github.com/intridea/omniauth/wiki) or follow this excellent [screencast](http://railscasts.com/episodes/241-simple-omniauth-revised) by [Ryan Bates](http://railscasts.com/about).
+
+## Installation
+
+First add the following line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-immobilienscout24'
+```
+
+Execute the ```bundle``` command to install the gem.
+
+Next, tell OmniAuth about the ImmobilienScout24 provider. For a Ruby on Rails application, your ```config/initializers/omniauth.rb``` file should look like:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :immobilienscout24, 'CONSUMER_KEY', 'CONSUMER_SECRET'
+end
+```
+
+Replace CONSUMER_KEY and CONSUMER_SECRET with the values given from the ImmobilienScout24 API team. And also make sure, that __the values are kept secret__!
+
+After restarting your application, point the authenticating user to ```/auth/immobilienscout24```, the rest will be handled by OmniAuth.
+
+## Authentication hash
+
+Here's an example authentication hash available in ```request.env['omniauth.auth']```:
+
+```ruby
+{
+  :provider => 'immobilienscout24',
+  :uid => '1234',
+  :info => {
+    :id => '5678',
+    :salutation => 'MALE',
+    :name => 'ABC XYZ'
+    :first_name => 'ABC'
+    :last_name => 'XYZ'
+    :url => 'http://www.example.com',
+  },
+  :credentials => {
+    :token => '123ABC...', # OAuth access_token, which you may want to store
+    :secret => 'abc123...' # OAuth access_secret, which you may want to store
+  },
+  :extra => {
+    :raw_info => {
+      ... # data from /api/search/v1.0/searcher/me
+    }
+  }
+}
+```
+
+## Supported Rubies
+[![Build Status](https://travis-ci.org/endil/omniauth-immobilienscout24.png?branch=master)](https://travis-ci.org/endil/omniauth-immobilienscout24)
+[![Gem Version](https://badge.fury.io/rb/omniauth-immobilienscout24.png)](https://badge.fury.io/rb/omniauth-immobilienscout24)
+
+OmniAuth ImmobilienScout24 is tested under 1.8.7, 1.9.2, 1.9.3 and Ruby Enterprise Edition.
+
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2013 by Niels Richter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/omniauth-immobilienscout24.rb

@@ -0,0 +1,2 @@
+require 'omniauth-immobilienscout24/version'
+require 'omniauth/strategies/immobilienscout24'

data/lib/omniauth-immobilienscout24/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Immobilienscout24
+    VERSION = '0.1.0'
+  end
+end

data/lib/omniauth/strategies/immobilienscout24.rb

@@ -0,0 +1,42 @@
+require 'omniauth/strategies/oauth'
+
+module OmniAuth
+  module Strategies
+    class ImmobilienScout24 < OmniAuth::Strategies::OAuth
+
+      args [:consumer_key, :consumer_secret]
+
+      option :client_options, {
+        :access_token_path => '/security/oauth/access_token',
+        :authorize_path => '/security/oauth/confirm_access',
+        :request_token_path => '/security/oauth/request_token',
+        :site => 'https://rest.immobilienscout24.de/restapi',
+      }
+
+      info do
+        {
+          :id => raw_info['@id'],
+          :salutation => raw_info['contactDetails']['salutation'],
+          :first_name => raw_info['contactDetails']['firstname'],
+          :last_name => raw_info['contactDetails']['lastname'],
+          :url => raw_info['contactDetails']['homepageUrl']
+        }
+      end
+
+      uid do
+        raw_info['@peid']
+      end
+
+      extra do
+        { 'raw_info' => raw_info }
+      end
+
+      def raw_info
+        @raw_info ||= MultiJson.decode(access_token.get('/api/search/v1.0/searcher/me', { 'Accept' => 'application/json' }).body)['searcher.searcher']
+      end
+
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'immobilienscout24', 'ImmobilienScout24'

data/omniauth-immobilienscout24.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth-immobilienscout24/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'omniauth-immobilienscout24'
+  s.version       = Omniauth::Immobilienscout24::VERSION
+  s.authors       = ['Niels Richter']
+  s.email         = ['niels@endil.de']
+  s.description   = 'OmniAuth strategy for ImmobilienScout24'
+  s.summary       = s.description
+  s.homepage      = 'https://github.com/endil/omniauth-immobilienscout24'
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+  
+  s.add_dependency 'multi_json', '~> 1.3'
+  s.add_runtime_dependency 'omniauth-oauth', '~> 1.0'
+  
+  s.add_development_dependency 'rspec', '~> 2.7'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'rack-test'
+end

data/spec/omniauth/strategies/immobilienscout24_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe 'OmniAuth::Strategies::ImmobilienScout24' do
+  subject do
+    OmniAuth::Strategies::ImmobilienScout24.new(nil, @options || {})
+  end
+
+  it 'should add a camelization for itself' do
+    OmniAuth::Utils.camelize('immobilienscout24').should == 'ImmobilienScout24'
+  end
+
+  context 'client options' do
+    it 'has correct site' do
+      subject.options.client_options.site.should eq('https://rest.immobilienscout24.de/restapi')
+    end
+
+    it 'has correct request token path' do
+      subject.options.client_options.request_token_path.should eq('/security/oauth/request_token')
+    end
+
+    it 'has correct access token path' do
+      subject.options.client_options.access_token_path.should eq('/security/oauth/access_token')
+    end
+    
+    it 'has correct authorize path' do
+      subject.options.client_options.authorize_path.should eq('/security/oauth/confirm_access')
+    end
+  end
+
+  context '#uid' do
+    before :each do
+      subject.stub(:raw_info) { { '@peid' => '123' } }
+    end
+
+    it 'returns the @peid from raw_info' do
+      subject.uid.should eq('123')
+    end
+  end
+  
+  context '#info' do
+    before :each do
+      subject.stub(:raw_info) {
+        {
+          '@id' => '123',
+          'contactDetails' => {
+            'salutation' => 'MALE',
+            'firstname' => 'John',
+            'lastname' => 'Doe',
+            'homepageUrl' => 'http://www.example.com/'
+          }
+        }
+      }
+    end
+
+    it 'returns the @id from raw_info' do
+      subject.info[:id].should eq('123')
+    end
+    
+    it 'returns the salutation from contactDetails in raw_info' do
+      subject.info[:salutation].should eq('MALE')
+    end
+    
+    it 'returns the first_name from contactDetails in raw_info' do
+      subject.info[:first_name].should eq('John')
+    end
+    
+    it 'returns the last_name from contactDetails in raw_info' do
+      subject.info[:last_name].should eq('Doe')
+    end
+    
+    it 'returns the url from contactDetails in raw_info' do
+      subject.info[:url].should eq('http://www.example.com/')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+require 'omniauth'
+require 'omniauth-immobilienscout24'
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+  config.extend OmniAuth::Test::StrategyMacros, :type => :strategy
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-immobilienscout24
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Niels Richter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: OmniAuth strategy for ImmobilienScout24
+email:
+- niels@endil.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth-immobilienscout24.rb
+- lib/omniauth-immobilienscout24/version.rb
+- lib/omniauth/strategies/immobilienscout24.rb
+- omniauth-immobilienscout24.gemspec
+- spec/omniauth/strategies/immobilienscout24_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/endil/omniauth-immobilienscout24
+licenses: []
+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: 1.8.24
+signing_key: 
+specification_version: 3
+summary: OmniAuth strategy for ImmobilienScout24
+test_files:
+- spec/omniauth/strategies/immobilienscout24_spec.rb
+- spec/spec_helper.rb