omniauth-bike-index 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c7076b1968d8dd1146f2464aa3f5a312c2b7c8b
+  data.tar.gz: 57e24cb405f9e07d8460699c4d542437c6ff909f
+SHA512:
+  metadata.gz: d77901f51616b78ff878d93aa899a9bfd5c2bf9ebf9f1597a7bc3da791a1214acfa13b090661b4964ea76c58bb3c41db0ee2e94b3f7fd67c35a23da690f66d73
+  data.tar.gz: 583f9cdf88a08cc72d433494e617adfe569e994103d31f3d80b036c7e0cc686216995eed447a24f5d94e5d82b42b71c3d47a86abfb72805ee08dcb5c4fd35a1c

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,17 @@
+bundler_args: --without development
+gemfile:
+  - Gemfile
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - rbx-2
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: ruby-head

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+
+group :test do
+  gem 'rspec', '~> 2.7'
+  gem 'guard'
+  gem 'guard-rspec', '4.2.8'
+  gem 'guard-livereload'
+end
+
+gemspec

data/Guardfile

@@ -0,0 +1,8 @@
+rspec_opts = {
+  failed_mode: :focus
+}
+
+guard :rspec, cmd: "bundle exec rspec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+end

data/README.md

@@ -0,0 +1,85 @@
+OmniAuth::BikeIndex
+==============
+
+Bike Index OAuth2 Strategy for OmniAuth 1.0.
+
+Supports the OAuth 2.0 server-side and client-side flows.
+
+
+## Creating an application
+
+To be able to use OAuth on the Bike Index, you have to create an application. Go to [BikeIndex.org/oauth/applications](https://bikeindex.org/oauth/applications) to add your application.
+
+Once you've added your application and your routes, you'll be able to see your Application ID and Secret, which you will need for omniauth.
+
+**Note**: Callback url has to be an exact match - if your url is `http://localhost:3001/users/auth/bike_index/callback` you _must_ enter that exactly - `http://localhost:3001/users/auth/` will not work.
+
+
+_Right now (Nov 12 2014) the Bike Index OAuth API is still in beta, and is accessible at /api/v2 - it can provide a list of bike ids for a given user, more functionality will be added soon._
+
+## Usage
+
+First add it to you Gemfile:
+
+`gem 'omniauth-bike-index'`
+
+Here's a quick example, adding the middleware to a Rails app in
+`config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :bike_index, ENV['BIKEINDEX_APP_ID'], ENV['BIKEINDEX_APP_SECRET']
+end
+```
+
+Your `BIKEINDEX_APP_ID` and your `BIKEINDEX_APP_SECRET` are both application specific. To create or view your applications go to [BikeIndex.org/oauth/applications](https://bikeindex.org/oauth/applications).
+
+Edit your routes.rb file to have:
+
+`devise_for :users, :controllers => { :omniauth_callbacks => "omniauth_callbacks" }`
+
+And create a file called `omniauth_callbacks_controller.rb` which should have this inside:
+
+```ruby
+class OmniauthCallbacksController < Devise::OmniauthCallbacksController
+
+  def bike_index
+    # Delete the code inside of this method and write your own.
+    # The code below is to show you where to access the data.
+    raise request.env["omniauth.auth"].to_json
+  end
+end
+```
+
+## Scopes
+
+The default scope is `public` - which will be submitted unless you configure additional scopes. You can set scopes in the configuration with a space seperated list, e.g. for Devise
+
+```ruby
+Devise.setup do |config|
+  config.omniauth :bike_index, ENV['BIKEINDEX_APP_ID'], ENV['BIKEINDEX_APP_SECRET'], scope: 'read_bikes write_user read_user`
+end
+```
+
+Available scopes: `read_user`, `write_user`, `read_bikes`, `write_bikes`, `create_bikes`, `read_bikewise`, `write_bikewise`
+
+
+## Credentials
+
+If you don't include a scope, the response will include a `uid` from Bike Index for the user and nothing else.
+
+If you include the `read_bikes` scope, the response will include an array of the ids the user has registered on the Index `bike_ids: [3414, 29367]`
+
+You can use these IDs to access information about the bikes - e.g. [BikeIndex.org/api/v1/bikes/3414](https://bikeindex.org/api/v1/bikes/3414) & [/api/v1/bikes/29367](https://bikeindex.org/api/v1/bikes/29367)
+
+_currently, you should use the v1 of the API ([documentation](https://bikeindex.org/documentation))_
+
+
+If you include the `read_user` scope, the response will include the user's username, email and name. You will also see their twitter handle and avatar if they have added them. The keys for these items - 
+`username`, `email`, `name`, `twitter` & `image` - all accessible in the `request.env['omniauth.auth']`, e.g. `request.env['omniauth.auth'].info.email`
+
+
+## Auth Hash
+
+You can also see the authetication hash (in JSON format) by going to the authentication url on the Bike Index with the user's access token - `https://bikeindex.org/api/v2/users/current?access_token=<OAUTH_ACCESS_TOKEN>`
+

data/Rakefile

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

data/lib/omniauth-bike-index.rb

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

data/lib/omniauth/bike_index/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module BikeIndex
+    VERSION = '0.0.2'
+  end
+end

data/lib/omniauth/strategies/bike_index.rb

@@ -0,0 +1,55 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class BikeIndex < OmniAuth::Strategies::OAuth2
+      option :name, :bike_index
+      DEFAULT_SCOPE = 'public'
+      option :client_options, :site          => 'https://bikeindex.org',
+                              :authorize_url => '/oauth/authorize'
+
+      uid { raw_info['id'] }
+
+      info do
+        prune!(
+          'username'    => raw_info['user']['username'],
+          'bike_ids'    => raw_info['bike_ids'],
+          'email'       => raw_info['user']['email'],
+          'name'        => raw_info['user']['name'],
+          'twitter'     => raw_info['user']['twitter'],
+          'image'       => raw_info['user']['image'],
+        )
+      end
+
+      extra do
+        hash = {}
+        hash['raw_info'] = raw_info unless skip_info?
+        prune! hash
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/api/v2/users/current').parsed || {}
+      end
+
+      def request_phase
+        options[:authorize_params] = {
+          # :client_id      => options['client_id'],
+          # :response_type  => 'code',
+          :scope          => (options['scope'] || DEFAULT_SCOPE)
+        }
+
+        super
+      end
+
+    private
+
+      def prune!(hash)
+        hash.delete_if do |_, value|
+          prune!(value) if value.is_a?(Hash)
+          value.nil? || (value.respond_to?(:empty?) && value.empty?)
+        end
+      end
+
+    end
+  end
+end

data/omniauth-bike-index.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'omniauth/bike_index/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'omniauth-bike-index'
+  s.version       = OmniAuth::BikeIndex::VERSION
+  s.authors       = ['Seth Herr']
+  s.email         = ['seth@bikeidnex.org']
+  s.summary       = 'Bike Index strategy for OmniAuth'
+  s.description   = 'Bike Index strategy for OmniAuth v1.2'
+  s.homepage      = 'https://github.com/bikeindex/omniauth-bike-index'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").collect { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'omniauth', '~> 1.2'
+  s.add_runtime_dependency 'omniauth-oauth2', '~> 1.1'
+
+  s.add_development_dependency 'dotenv', '~> 0'
+  s.add_development_dependency 'sinatra', '~> 0'
+end

data/spec/app.rb

@@ -0,0 +1,49 @@
+$LOAD_PATH.unshift File.expand_path('..', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'dotenv'
+require 'sinatra'
+require 'omniauth'
+require 'omniauth-bike-index'
+
+Dotenv.load
+
+use Rack::Session::Cookie, :key => 'key',
+                           :domain => 'localhost',
+                           :path => '/',
+                           :expire_after => 14_400,
+                           :secret => 'secret'
+
+use OmniAuth::Builder do
+  provider :bike_index, ENV['CLIENT_ID'], ENV['CLIENT_SECRET'], :scope => 'access_profile'
+end
+
+get '/' do
+  <<-HTML
+  <a href='/auth/venmo'>Sign in with Venmo</a>
+  HTML
+end
+
+get '/auth/failure' do
+  env['omniauth.error'].to_s
+end
+
+get '/auth/:name/callback' do
+  auth = request.env['omniauth.auth']
+
+  puts %Q(
+    >> UID
+      #{auth.uid.inspect}
+
+    >> ACCESS TOKEN
+      #{auth.credentials.token.inspect}
+
+    >> INFO
+      #{auth.info.inspect}
+      #
+    >> EXTRA
+      #{auth.extra.inspect}
+  )
+
+  'Check logs for user information.'
+end

data/spec/omniauth/strategies/bike_index_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::BikeIndex do
+  subject do
+    @subject ||= begin
+      args = ['client_id', 'client_secret', @options || {}].compact
+      OmniAuth::Strategies::BikeIndex.new(*args)
+    end
+  end
+
+  context 'client options' do
+    it 'has correct name' do
+      expect(subject.options.name).to eq(:bike_index)
+    end
+
+    it 'has correct site' do
+      expect(subject.options.client_options.site).to eq('https://bikeindex.org')
+    end
+
+    it 'has correct authorize url' do
+      expect(subject.options.client_options.authorize_url).to eq('/oauth/authorize')
+    end
+
+  end
+
+  context 'figuring stuff out' do 
+    it "gets log in" do 
+      app = lambda{|env| [200, {}, ["Hello World."]]}
+      OmniAuth::Strategies::Developer.new(app).options.uid_field                      # => :email
+      OmniAuth::Strategies::Developer.new(app, :uid_field => :name).options.uid_field # => :name
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift File.expand_path('..', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rspec'
+require 'omniauth'
+require 'omniauth-bike-index'
+
+RSpec.configure do |config|
+  config.extend OmniAuth::Test::StrategyMacros, :type => :strategy
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-bike-index
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Seth Herr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Bike Index strategy for OmniAuth v1.2
+email:
+- seth@bikeidnex.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- lib/omniauth-bike-index.rb
+- lib/omniauth/bike_index/version.rb
+- lib/omniauth/strategies/bike_index.rb
+- omniauth-bike-index.gemspec
+- spec/app.rb
+- spec/omniauth/strategies/bike_index_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bikeindex/omniauth-bike-index
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Bike Index strategy for OmniAuth
+test_files:
+- spec/app.rb
+- spec/omniauth/strategies/bike_index_spec.rb
+- spec/spec_helper.rb