oauth_bundle 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8579e9674631bb8ff6568bbedc7f7a48adb5cec
+  data.tar.gz: 4040b79f12c361e827a03e0a8b577b6253e27e0a
+SHA512:
+  metadata.gz: d6556fdfa40208d10cdae2863adc3cfafbdccc0b8c7b0ec7fe509eefc5221e75e589d19c03b5f25ed2c5605b42fb67ffcfd83993c63297606500e20db965db73
+  data.tar.gz: 5e6ec59eb9973e8e520b53e6a6369ab203ac0e7c0ffb28f2f946afc977d9f5e83c4dd4dd1d91d1b3d32c707feb288db5019c5eaae1cba8df649da2c629095396

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 James Yang
+
+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,84 @@
+# OauthBundle
+
+OauthBundle bundles __devise__ and Omniauth __twitter__, __facebook__, and __github__ strategies. It migrate required columns for your authentication model. Omniauth callbacks controller file is created and defined realted methods. This gem makes your life easier to build the omniauth services with devise gem. 
+
+###To-Do List:
+
+Support seperating authentication model from user model.
+
+## Installation
+
+Test in OS X system.
+
+Add this line to your application's Gemfile:
+
+    gem 'devise'
+    gem 'omniauth'
+    gem 'omniauth-facebook'
+    gem 'omniauth-twitter'
+    gem 'omniauth-github'
+    gem 'oauth_bundle'
+    
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install oauth_bundle
+
+## Usage
+
+#### Setup
+
+`rails g oauth_bundle:install`
+
+Update your app id and app secret for each provider:
+
+```ruby
+# config/initializers/devise.rb
+config.omniauth :github, 'APP_ID', 'APP_SECRET'
+config.omniauth :facebook, 'APP_ID', 'APP_SECRET'
+config.omniauth :twitter, 'APP_ID', 'APP_SECRET'
+```
+
+#### Handle Callback Data
+
+Each provider correspond to its named method in `app/controllers/#{models}/omniauth_callbacks_controller.rb`.
+
+#### Routing Path
+
+- `user_omniauth_authorize_path(:provider_name)`
+- `user_omniauth_callback_path(:provider_name)`
+
+#### More Information
+
+- [http://blog.railsrumble.com/2010/10/08/intridea-omniauth/](http://blog.railsrumble.com/2010/10/08/intridea-omniauth/)
+- [https://github.com/plataformatec/devise/wiki/OmniAuth:-Overview](https://github.com/plataformatec/devise/wiki/OmniAuth:-Overview)
+- [https://github.com/mkdynamic/omniauth-facebook](https://github.com/mkdynamic/omniauth-facebook)
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/oauth_bundle/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Development Digest
+
+1. Add migration for authentication model.
+2. Add `provider, uid` columns to authentication model.
+3. Setup before start to use it.
+4. Set tup provider in model.
+5. integrate `rails g devise:install` and `rails g devise user`
+6. `git add . && git commit --amend --no-edit && rake install`
+7. `"/app" => absolute path`
+8. `"app" => relative path, current execution path prefixed.`
+9. `test your sqlite db: sqlite3 /db/development.sqlite3`
+10. `http://localhost:3000/rails/info/routes` get route info
+11. Twitter dont like developers develop their app under `localhost` as callback url. :expressionless:
+    - [http://stackoverflow.com/questions/800827/twitter-oauth-callbackurl-localhost-development](http://stackoverflow.com/questions/800827/twitter-oauth-callbackurl-localhost-development)
+12. [http://www.rubydoc.info/github/erikhuda/thor/master/Thor/Actions#get-instance_method](http://www.rubydoc.info/github/erikhuda/thor/master/Thor/Actions#get-instance_method)
+13. [http://stackoverflow.com/questions/6338908/ruby-difference-between-exec-system-and-x-or-backticks](http://stackoverflow.com/questions/6338908/ruby-difference-between-exec-system-and-x-or-backticks)
+14. `rake build && gem push <gem>.gem`

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/generators/oauth_bundle/auth_seperation/auth_seperation_generator.rb

@@ -0,0 +1,9 @@
+module OauthBundle
+  module Generators
+    class AuthSeperationGenerator < ::Rails::Generators::Base
+      def preset
+        puts "Expect to seperate authentication data from user model."
+      end
+    end
+  end
+end

data/lib/generators/oauth_bundle/install/install_generator.rb

@@ -0,0 +1,65 @@
+module OauthBundle
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      # public method will be run automatically.
+      
+      def install_devise_auth_model
+        model = ask "Please provide authentication model name (default: users):"
+        model = (model.empty? ? "users" : model).tableize
+        @auth_model = model
+
+        install_devise model
+        config_devise_routes model
+      end
+
+      def create_migration_for_auth_model
+        system "rails g migration AddColumnsTo#{@auth_model.capitalize} provider uid"
+        system "rake db:migrate" 
+      end
+
+      def add_omniauth_to_devise_file
+        @providers = [:github, :facebook, :twitter]
+        inject_str = @providers.map do |e|
+          "  config.omniauth :#{e}, 'APP_ID', 'APP_SECRET'"
+        end.join("\n") + "\n"
+
+        inject_into_file "config/initializers/devise.rb", inject_str, 
+        :after => "scope: 'user,public_repo'\n"
+      end 
+
+      def add_devise_omniauth_to_user_model
+        inject_str = "  devise :omniauthable, :omniauth_providers => [:facebook, :twitter, :github]\n"
+        inject_into_file "app/models/user.rb", inject_str, :after => ":validatable\n"
+      end
+
+      def generate_omniauth_callback_controllers
+        path = "app/controllers/#{@auth_model}/omniauth_callbacks_controller.rb"
+        create_file path
+        append_file path, omniauth_callback_contrllers_content
+      end
+
+      private
+
+      def install_devise(model)
+        system "rails g devise:install"
+        unless File.exist?("app/models/#{model.singularize}.rb")
+          system "rails g devise #{model.singularize}"
+        end
+      end
+
+      def config_devise_routes(model)
+        gsub_file "config/routes.rb", /devise_for :#{model}$/, "devise_for :#{model}, :controllers => {:omniauth_callbacks => 'users/omniauth_callbacks'}"
+      end
+
+      def omniauth_callback_contrllers_content
+        content = "class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController\n"
+        providers = @providers.map do |e|
+          "  def #{e}\n    #handle callback data in here.\n  end\n"
+        end.join("\n")
+
+        "#{content}#{providers}end\n"
+      end
+    end
+  end
+end

data/lib/oauth_bundle.rb

@@ -0,0 +1,2 @@
+require "oauth_bundle/version"
+require "oauth_bundle/engine"

data/lib/oauth_bundle/engine.rb

@@ -0,0 +1,5 @@
+module OauthBundle
+  class Engine < ::Rails::Engine
+    # automatically load app/controllers, app/views, app/models.
+  end
+end

data/lib/oauth_bundle/version.rb

@@ -0,0 +1,3 @@
+module OauthBundle
+  VERSION = "1.0.2"
+end

data/oauth_bundle.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'oauth_bundle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "oauth_bundle"
+  spec.version       = OauthBundle::VERSION
+  spec.authors       = ["James Yang"]
+  spec.email         = ["jamesyang124@gmail.com"]
+  spec.summary       = %q{Bundle omniauth-facebook, omniauth-github, omniauth-twitter with Devise gem.}
+  spec.description   = %q{`Create new rails app, then run rails g oauth_bundle:install`}
+  spec.homepage      = "https://github.com/jamesyang124/oauth_bundle"
+  spec.license       = "MIT"
+
+  spec.add_dependency "devise"
+  spec.add_dependency "omniauth"
+  spec.add_dependency "omniauth-facebook"
+  spec.add_dependency "omniauth-twitter"
+  spec.add_dependency "omniauth-github"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: oauth_bundle
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- James Yang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-facebook
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-twitter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-github
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: "`Create new rails app, then run rails g oauth_bundle:install`"
+email:
+- jamesyang124@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/oauth_bundle/auth_seperation/auth_seperation_generator.rb
+- lib/generators/oauth_bundle/install/install_generator.rb
+- lib/oauth_bundle.rb
+- lib/oauth_bundle/engine.rb
+- lib/oauth_bundle/version.rb
+- oauth_bundle.gemspec
+homepage: https://github.com/jamesyang124/oauth_bundle
+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: Bundle omniauth-facebook, omniauth-github, omniauth-twitter with Devise gem.
+test_files: []