omniauth-sense 0.1.1

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - ree
+  - 1.9.2
+  - 1.9.3

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,36 @@
+[![Build Status](https://travis-ci.org/senseobservationsystems/omniauth-sense.png)](https://travis-ci.org/senseobservationsystems/omniauth-sense)
+
+## Usage
+First register your application to CommonSense by visiting (OAuth registration page)[1]
+You will obtain application KEY and Application Secret
+
+```ruby
+use OmniAuth::Builder do
+ provider :sense, ENV['APPLICATION_KEY'], ENV['APPLICATION_SECRET']
+end
+```
+
+## Testing sample
+```bash
+$ bundle # this will install dependency
+$ bundle exec ruby sample sense_oauth.rb
+```
+
+it will start a sinatra app running on localhost port 4567
+
+## License
+
+Copyright (c) 2012 Sense Observation Systems B.V.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+[1]: http://api.sense-os.nl/oauth/register_app

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/omniauth/strategies/sense.rb

@@ -0,0 +1,32 @@
+require 'omniauth/strategies/oauth'
+
+module OmniAuth
+  module Strategies
+    class Sense < OmniAuth::Strategies::OAuth
+      option :name, 'sense'
+      option :client_options, {
+        :site => 'http://api.sense-os.nl',
+        :request_token_path => '/oauth/request_token',
+        :access_token_path => '/oauth/access_token',
+        :authorize_path => '/oauth/authorize'
+      }
+
+      uid { raw_info['user']['id'] }
+
+      info { raw_info['user'] }
+
+      extra do
+        { :raw_info => raw_info }
+      end
+
+      def raw_info
+        @raw_info ||=
+          begin
+            current_user_request = @access_token.get('/users/current.json')
+            body = current_user_request.body
+            MultiJson.load(body)
+          end
+      end
+    end
+  end
+end

data/lib/omniauth-sense/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Sense
+    VERSION = "0.1.1"
+  end
+end

data/lib/omniauth-sense.rb

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

data/omniauth-sense.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/omniauth-sense/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ahmy Yulrizka"]
+  gem.email         = ["ahmy@sense-os.nl"]
+  gem.description   = %q{OmniAuth strategy for sense-os.nl}
+  gem.summary       = %q{OmniAuth strategy for sense-os.nl}
+  gem.homepage      = "https://github.com/senseobservationsystems/omniauth-sense"
+
+  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.name          = "omniauth-sense"
+  gem.require_paths = ["lib"]
+  gem.version       = Omniauth::Sense::VERSION
+
+  gem.add_runtime_dependency     'omniauth-oauth', '~> 1.0'
+  gem.add_runtime_dependency     'multi_json', '~> 1.0'
+
+  gem.add_development_dependency 'rspec', '~> 2.7'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'sinatra'
+end

data/sample/sense_oauth.rb

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'sinatra'
+require 'json'
+require 'omniauth'
+require 'omniauth-sense'
+
+use Rack::Logger
+
+class SinatraApp < Sinatra::Base
+  configure do
+    set :sessions, true
+    set :inline_templates, true
+  end
+  use OmniAuth::Builder do
+    provider :sense, 'APPLICATION_KEY', 'APPLICATION_SECRET'
+  end
+
+  get '/' do
+    erb "<h1>Login to CommonSense</h1><a href='/auth/sense' class='btn btn-primary'>Login</a>"
+  end
+
+  get '/auth/:provider/callback' do
+    erb "<h1>#{params[:provider]}</h1>
+         <pre>#{JSON.pretty_generate(request.env['omniauth.auth'])}</pre>
+   <a href='/logout' class='btn'>Logout</a>"
+  end
+
+  get '/auth/failure' do
+    erb "<h1>Authentication Failed:</h1><h3>message:<h3> <pre>#{params}</pre>
+   <a href='/' class='btn'>Start over</a>"
+  end
+
+  get '/logout' do
+    session.clear
+    redirect '/'
+  end
+
+end
+
+SinatraApp.run! if __FILE__ == $0
+
+__END__
+
+@@ layout
+<html>
+  <head>
+    <link href='http://twitter.github.com/bootstrap/assets/css/bootstrap.css' rel='stylesheet' />
+  </head>
+  <body>
+    <div class='container'>
+      <div class='content'>
+        <%= yield %>
+      </div>
+    </div>
+  </body>
+</html>

data/spec/omniauth/strategies/sense_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+require 'ostruct'
+
+# Fix OpenStruct in Ruby 1.8
+if RUBY_VERSION <= "1.9"
+  class OpenStruct
+    undef id
+  end
+end
+
+describe OmniAuth::Strategies::Sense do
+  before do
+    @consumer_key = 'key'
+    @consumer_secret = 'secret'
+  end
+
+  subject do
+    args = [@consumer_key, @consumer_secret, @options].compact
+    OmniAuth::Strategies::Sense.new(nil, *args)
+  end
+
+  describe '#consumer' do
+    it 'has correct Sense site' do
+      subject.consumer.options[:site].should eq('http://api.sense-os.nl')
+    end
+
+    it 'has correct request token url' do
+      subject.consumer.options[:request_token_path].should eq('/oauth/request_token')
+    end
+
+    it 'has correct access token url' do
+      subject.consumer.options[:access_token_path].should eq('/oauth/access_token')
+    end
+
+    it 'has correct authorize url' do
+      subject.consumer.options[:authorize_path].should eq('/oauth/authorize')
+    end
+  end
+
+  describe "#uid" do
+    before do
+      subject.stub(:raw_info) do
+        {'user' => {'id' => '123'}}
+      end
+    end
+
+    it 'returns the id from raw_info' do
+      subject.uid.should eq('123')
+    end
+  end
+
+  describe "#info" do
+    before :each do
+      subject.stub(:raw_info) do
+        { "user" => 
+          {
+            "id" => "1",
+            "email" => "jan@test.nl",
+            "username" => "janjager",
+            "name" => "Jan",
+            "surname" => "Jager",
+            "mobile" => "0031612345678",
+            "UUID" => "377bc208-5333-102e-aa53-005056bc6a30"
+          }
+        }
+      end
+    end
+
+    it 'returns the name from raw_info' do
+      subject.info['name'].should eq('Jan')
+    end
+
+    it 'returns the email from raw_info' do
+      subject.info['email'].should eq('jan@test.nl')
+    end
+
+    it 'returns the username from raw_info' do
+      subject.info['username'].should eq('janjager')
+    end
+
+    it 'returns the surname from raw_info' do
+      subject.info['surname'].should eq('Jager')
+    end
+
+    it 'returns the mobile from raw_info' do
+      subject.info['mobile'].should eq('0031612345678')
+    end
+
+    it 'returns the UUID from raw_info' do
+      subject.info['UUID'].should eq('377bc208-5333-102e-aa53-005056bc6a30')
+    end
+  end
+
+  describe "#extra" do
+  end
+
+  describe "#raw_info" do
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+require 'rspec'
+Dir[File.expand_path('../support/**/*', __FILE__)].each { |f| require f }
+
+require 'omniauth-sense'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-sense
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Ahmy Yulrizka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-15 00:00:00.000000000 Z
+dependencies:
+- !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: multi_json
+  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: sinatra
+  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 sense-os.nl
+email:
+- ahmy@sense-os.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/omniauth-sense.rb
+- lib/omniauth-sense/version.rb
+- lib/omniauth/strategies/sense.rb
+- omniauth-sense.gemspec
+- sample/sense_oauth.rb
+- spec/omniauth/strategies/sense_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/senseobservationsystems/omniauth-sense
+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 sense-os.nl
+test_files: []
+has_rdoc: