omniauth-osm 0.1.0

data/.gitignore

@@ -0,0 +1,40 @@
+*.gem
+*.rbc
+*.sw[a-p]
+*.tmproj
+*.tmproject
+*.un~
+*~
+.DS_Store
+.Spotlight-V100
+.Trashes
+._*
+.bundle
+.config
+.directory
+.elc
+.emacs.desktop
+.emacs.desktop.lock
+.redcar
+.yardoc
+Desktop.ini
+Gemfile.lock
+Icon?
+InstalledFiles
+Session.vim
+Thumbs.db
+\#*\#
+_yardoc
+auto-save-list
+coverage
+doc
+lib/bundler/man
+pkg
+pkg/*
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags
+tramp

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.8.7@omniauth-osm

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2011 Christoph Bünte
+
+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,35 @@
+# OmniAuth OpenStreetMap
+
+This gem contains the OpenStreetMap strategy for OmniAuth.
+
+OpenStreetMap uses the OAuth 1.0a flow, you can read about it here: http://wiki.openstreetmap.org/wiki/OAuth
+
+## How To Use It
+
+Usage is as per any other OmniAuth 1.0 strategy. So let's say you're using Rails, you need to add the strategy to your `Gemfile` along side omniauth:
+
+    gem 'omniauth'
+    gem 'omniauth-osm'
+
+Of course if one or both of these are unreleased, you may have to pull them in directly from github e.g.:
+
+    gem 'omniauth', :git => 'https://github.com/intridea/omniauth.git'
+    gem 'omniauth-osm', :git => 'https://github.com/sozialhelden/omniauth-osm.git'
+
+Once these are in, you need to add the following to your `config/initializers/omniauth.rb`:
+
+    Rails.application.config.middleware.use OmniAuth::Builder do
+      provider :osm, "consumer_key", "consumer_secret"
+    end
+
+You will obviously have to put in your key and secret, which you get when you register your app with OpenStreetMap.
+
+Now just follow the README at: https://github.com/intridea/omniauth
+
+## Note on Patches/Pull Requests
+
+- Fork the project.
+- Make your feature addition or bug fix.
+- Add tests for it. This is important so I don’t break it in a future version unintentionally.
+- Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+- Send me a pull request. Bonus points for topic branches.

data/Rakefile

@@ -0,0 +1,18 @@
+#!/usr/bin/env rake
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec
+
+require 'yard'
+namespace :doc do
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['LICENSE.md', 'lib/**/*.rb']
+    task.options = ['--markup', 'markdown']
+  end
+end

data/lib/omniauth/osm/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Osm
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniauth/osm.rb

@@ -0,0 +1 @@
+require 'omniauth/strategies/osm'

data/lib/omniauth/strategies/osm.rb

@@ -0,0 +1,54 @@
+require 'omniauth-oauth'
+
+module OmniAuth
+  module Strategies
+    class Osm < OmniAuth::Strategies::OAuth
+      option :name, "osm"
+
+      option :client_options, {
+        :site               => 'http://www.openstreetmap.org',
+        :request_token_url => 'http://www.openstreetmap.org/oauth/request_token',
+        :access_token_url  => 'http://www.openstreetmap.org/oauth/access_token',
+        :authorize_url     => 'http://www.openstreetmap.org/oauth/authorize'
+      }
+
+      uid{ raw_info['user']['id'] }
+
+      info do
+      {
+        'name'       => raw_info['user']['display_name'],
+        'languages'  => languages,
+        'lat'        => lat,
+        'lon'        => lon,
+        'image_url'  => image_url
+      }
+      end
+
+      def lat
+        raw_info['user']['home']['lat'].to_f rescue nil
+      end
+
+      def lon
+        raw_info['user']['home']['lon'].to_f rescue nil
+      end
+
+      def languages
+        raw_info['user']['languages']['lang'] rescue []
+      end
+
+      def image_url
+        raw_info['user']['img']['href'] rescue nil
+      end
+
+      extra do
+        { 'raw_info' => raw_info }
+      end
+
+      def raw_info
+        @raw_info ||= Hash.from_xml(access_token.get('/api/0.6/user/details.json').body)['osm']
+        rescue ::Errno::ETIMEDOUT
+        raise ::Timeout::Error
+      end
+    end
+  end
+end

data/lib/omniauth-osm.rb

@@ -0,0 +1 @@
+require 'omniauth/osm'

data/omniauth-osm.gemspec

@@ -0,0 +1,28 @@
+# encoding: utf-8
+require File.expand_path('../lib/omniauth/osm/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'omniauth-osm'
+  gem.version     = OmniAuth::Osm::VERSION
+  gem.homepage    = 'https://github.com/sozialhelden/omniauth-osm'
+
+  gem.author      = "Christoph Bünte"
+  gem.email       = 'christoph@sozialhelden.de'
+  gem.description = 'OpenStreetMap strategy for OmniAuth 1.0'
+  gem.summary     = gem.description
+
+  gem.add_dependency "omniauth-oauth", "~> 1.0"
+
+  gem.add_development_dependency 'rake', '~> 0.9'
+  gem.add_development_dependency 'rdiscount', '~> 1.6'
+  gem.add_development_dependency 'rspec', '~> 2.7'
+  gem.add_development_dependency 'simplecov', '~> 0.5'
+  gem.add_development_dependency 'yard', '~> 0.7'
+  gem.add_development_dependency 'webmock', '~> 1.7'
+
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  gem.files       = `git ls-files`.split("\n")
+  gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  gem.require_paths = ['lib']
+end

data/spec/integration.spec

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe 'OmniAuth::Strategies::OSM Integration' do
+  pending 'write some tests yo'
+end

data/spec/omniauth/strategies/osm_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Osm do
+  before :each do
+    @request = double('Request')
+    @request.stub(:params) { {} }
+  end
+
+  subject do
+    OmniAuth::Strategies::Osm.new(nil, @options || {}).tap do |strategy|
+      strategy.stub(:request) { @request }
+    end
+  end
+
+  describe '#client_options' do
+    it 'has correct Osm site' do
+      subject.options.client_options.site.should eq('http://www.openstreetmap.org')
+    end
+
+    it 'has correct authorize url' do
+      subject.options.client_options.authorize_url.should eq('http://www.openstreetmap.org/oauth/authorize')
+    end
+
+    it 'has correct request token url' do
+      subject.options.client_options.request_token_url.should eq('http://www.openstreetmap.org/oauth/request_token')
+    end
+
+    it 'has correct access token url' do
+      subject.options.client_options.access_token_url.should eq('http://www.openstreetmap.org/oauth/access_token')
+    end
+  end
+
+  describe '#id' do
+    it 'returns the id from raw_info' do
+      subject.stub(:raw_info) {{ 'user' => { 'id' => '123' } } }
+      subject.uid.should eq('123')
+    end
+  end
+
+  describe '#info' do
+    before :each do
+      @raw_info ||= { 'user' => { 'display_name' => 'Fred', 'languages' => {'lang' => ["de-DE", "de"]}, 'home' => {'lat' => '52.0', 'lon' => '13.4', 'zoom' => '3' }, 'img' => {'href' => 'http://somewhere.com/image.jpg'} } }
+      subject.stub(:raw_info) { @raw_info }
+    end
+
+    context 'when data is present in raw info' do
+      it 'returns the name' do
+        subject.info['name'].should eq('Fred')
+      end
+
+      it 'returns the languages' do
+        subject.info['languages'].should eq(['de-DE', 'de'])
+      end
+
+      it 'returns no languages if missing' do
+        @raw_info['user'].delete('languages')
+        subject.info['languages'].should eq([])
+      end
+
+      it 'returns the lat' do
+        subject.info['lat'].should eq(52.0)
+      end
+
+      it 'returns no lat if missing' do
+        @raw_info['user'].delete('home')
+        subject.info['lat'].should eq(nil)
+      end
+
+      it 'returns the lon' do
+        subject.info['lon'].should eq(13.4)
+      end
+
+      it 'returns no lon if missing' do
+        @raw_info['user'].delete('home')
+        subject.info['lon'].should eq(nil)
+      end
+
+      it 'returns the image' do
+        subject.info['image_url'].should eq('http://somewhere.com/image.jpg')
+      end
+
+      it 'returns no image of missing' do
+        @raw_info['user'].delete('img')
+        subject.info['image_url'].should eq(nil)
+
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
+require 'omniauth-osm'
+require 'rspec'
+require 'webmock/rspec'

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification 
+name: omniauth-osm
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Christoph B\xC3\xBCnte"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-28 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: omniauth-oauth
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rdiscount
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 6
+        version: "1.6"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 2
+        - 7
+        version: "2.7"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 0
+        - 5
+        version: "0.5"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 7
+        version: "0.7"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 7
+        version: "1.7"
+  type: :development
+  version_requirements: *id007
+description: OpenStreetMap strategy for OmniAuth 1.0
+email: christoph@sozialhelden.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/omniauth-osm.rb
+- lib/omniauth/osm.rb
+- lib/omniauth/osm/version.rb
+- lib/omniauth/strategies/osm.rb
+- omniauth-osm.gemspec
+- spec/integration.spec
+- spec/omniauth/strategies/osm_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sozialhelden/omniauth-osm
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: OpenStreetMap strategy for OmniAuth 1.0
+test_files: 
+- spec/integration.spec
+- spec/omniauth/strategies/osm_spec.rb
+- spec/spec_helper.rb
+has_rdoc: