simple_mobile_oauth 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7dae4e339a5e998c95f6bfda287c99be2bdc272f
+  data.tar.gz: 38995f7cd9263b72f4598a966fb277c42813011e
+SHA512:
+  metadata.gz: 2e7f1c8907463723201d6b04445a5833e6a8f1ec214fe4d87efee3f2e734478e6d37cc5af44ba4d1a09889b6ee3656de2806b6c6afbf35eafff0764354e7586f
+  data.tar.gz: 4e15731713037c23788d34ba32fdd9b9cbc402d40b50af5671248ad6cdfe699385adc350da48e1ef85622372b97fa6ccbddd6f7ff6098c62df1c4428ea12333f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SimpleMobileOauth'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/generators/active_record/simple_mobile_oauth_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators/active_record'
+
+module ActiveRecord
+  module Generators
+    class SimpleMobileOauthGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def append_to_token_authenticatable_model
+        inject_into_class "app/models/#{name}.rb", name.camelize.constantize, <<-END
+  include SimpleMobileOauth::Identifiable
+        END
+      end
+    end
+  end
+end

data/lib/generators/simple_mobile_oauth/install_generator.rb

@@ -0,0 +1,39 @@
+require 'rails/generators/base'
+
+module SimpleMobileOauth
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Generates a SimpleMobileOauth migrations for identity model"
+
+      def self.orm
+        Rails::Generators.options[:rails][:orm]
+      end
+
+      def self.orm_has_migration?
+        [:active_record].include? orm
+      end
+
+      def self.next_migration_number(path)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+
+      def create_migration_file
+        if self.class.orm_has_migration?
+          migration_template 'migration.rb', 'db/migrate/simple_mobile_oauth_migration.rb'
+        end
+      end
+
+      # def copy_initializer
+      #   template "simple_mobile_oauth.rb", "config/initializers/simple_mobile_oauth.rb"
+      # end
+
+      def copy_identity_model
+        template "identity.rb", "app/models/identity.rb"
+      end
+    end
+  end
+end

data/lib/generators/simple_mobile_oauth/simple_mobile_oauth_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators/named_base'
+
+module SimpleMobileOauth
+  module Generators
+    class SimpleMobileOauthGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::ResourceHelpers
+
+      namespace 'simple_mobile_oauth'
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc 'Insert include for given NAME model'
+      hook_for :orm
+    end
+  end
+end

data/lib/generators/templates/identity.rb

@@ -0,0 +1,16 @@
+class Identity < ActiveRecord::Base
+  validates :uid, :provider, presence: true
+  validates_uniqueness_of :uid, scope: [:provider, :identifiable_type]
+
+  belongs_to :identifiable, polymorphic: true
+
+  serialize :info, JSON
+
+  def username
+    info["nickname"]
+  end
+
+  def avatar_url
+    info["image"]
+  end
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,14 @@
+class SimpleMobileOauthMigration < ActiveRecord::Migration
+  def change
+    create_table :identities do |t|
+      t.integer :identifiable_id
+      t.string :identifiable_type
+      t.string :image
+      t.string :uid,       null: false
+      t.string :provider,  null: false
+      t.text :info
+
+      t.timestamps
+    end
+  end
+end

data/lib/simple_mobile_oauth/authenticator.rb

@@ -0,0 +1,122 @@
+module SimpleMobileOauth
+  # SimpleMobileOauth::Authenticator
+  #
+  # Scenarios:
+  #
+  # 1. if identity with uid and provider exists
+  #    1. if user param is given
+  #       1. if identity's owner matches the user param, it returns the identity's owner
+  #       2. else it raises error because the identity exists with another user
+  #    2. if user param is not given (so it's a log in), it returns the identity's owner
+  # 2. if identity is not found by given oauth
+  #    1. if user_param is not given, then we return nil (most likely in mid of registration phase)
+  #    2. if user param is given
+  #       1. if user can be found by user_param, it creates the binds the identity to that user
+  #       2. if user can not be found by user param, it creates both user and identity (registration)
+  #
+  # Usage example:
+  #
+  #   class UserAuthenticator
+  #     include SimpleMobileOauth::Authenticator
+  #
+  #     find_identity do |params|
+  #       Identity.find_by params.merge(identifiable_type: 'User')
+  #     end
+  #
+  #     find_user do |params|
+  #       return nil unless params.present?
+  #       User.find_by email: params['email']
+  #     end
+  #
+  #     build_user do |params|
+  #       raise ArgumentError, 'missing params' unless params
+  #       attrs = {email: params['email'], password: Devise.friendly_token[0,20]}
+  #       User.new(attrs)
+  #     end
+  #   end
+  #
+  #   user = UserAuthenticator.new.call(params)
+  #
+  module Authenticator
+    BaseError                 = Class.new(StandardError)
+    IdentityMissingOwnerError = Class.new(BaseError)
+    IdentityAlreadyBoundError = Class.new(BaseError)
+    InvalidParamsError        = Class.new(BaseError)
+
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def find_identity(&block)
+        define_method(:_find_identity_strategy, &block)
+      end
+
+      def find_user(&block)
+        define_method(:_find_user_strategy, &block)
+      end
+
+      def build_user(&block)
+        define_method(:_build_user_strategy, &block)
+      end
+    end
+
+    class EmptyUser < Hash
+      def initialize(params={})
+        super
+        self[:user] = nil
+      end
+
+      def valid?
+        true
+      end
+    end
+
+    def call(params)
+      oauth_params    = params.fetch('auth')           { raise InvalidParamsError, "auth param is missing" }
+      oauth_uid       = oauth_params.fetch('uid')      { raise InvalidParamsError, "uid is missing"        }
+      oauth_provider  = oauth_params.fetch('provider') { raise InvalidParamsError, "provider is missing"   }
+      oauth_info      = oauth_params.fetch('info')     { {} }
+      user_params     = params['user']
+      identity_params = { uid: oauth_uid, provider: oauth_provider, info: oauth_info }
+      identity        = _find_identity_strategy(identity_params.slice(:uid, :provider))
+
+      return EmptyUser.new if start_of_registration_process?(identity, user_params)
+
+      if identity
+        identity_owner = identity.identifiable
+        raise IdentityMissingOwnerError, 'internal error' unless identity_owner
+
+        return identity_owner if login_request?(identity_owner, user_params)
+
+        user = _find_user_strategy(user_params)
+        raise InvalidParamsError, 'could not find user from params given' unless user
+        raise IdentityAlreadyBoundError, 'oauth identity exists with another user' \
+        if identity_already_bound_to_different_user?(identity_owner, user)
+
+          # So the identity owner and user found from param match
+          user
+        else
+          raise InvalidParamsError, 'missing user params' unless user_params
+
+          user = _find_user_strategy(user_params) || _build_user_strategy(user_params)
+
+          user.identities.build(identity_params)
+          user.save
+          user
+        end
+      end
+
+      private
+
+      def login_request?(identity_owner, user_params)
+        identity_owner && !user_params
+      end
+
+      def identity_already_bound_to_different_user?(identity_owner, user)
+        identity_owner && user && identity_owner != user
+      end
+
+      def start_of_registration_process?(identity, user_params)
+        !identity && !user_params
+      end
+    end
+  end

data/lib/simple_mobile_oauth/identifiable.rb

@@ -0,0 +1,23 @@
+module SimpleMobileOauth
+  module Identifiable
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :identities, as: :identifiable
+    end
+
+    def username
+      current_identity_info.try(:fetch, "nickname", "")
+    end
+
+    def avatar_url
+      current_identity_info.try(:fetch, "image", "")
+    end
+
+    private
+
+    def current_identity_info
+      identities.first.try(:info)
+    end
+  end
+end

data/lib/simple_mobile_oauth/version.rb

@@ -0,0 +1,3 @@
+module SimpleMobileOauth
+  VERSION = "0.0.1"
+end

data/lib/simple_mobile_oauth.rb

@@ -0,0 +1,5 @@
+module SimpleMobileOauth
+end
+
+require_relative 'simple_mobile_oauth/identifiable'
+require_relative 'simple_mobile_oauth/authenticator'

data/lib/tasks/simple_mobile_oauth_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :simple_mobile_oauth do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/identity.rb

@@ -0,0 +1,16 @@
+class Identity < ActiveRecord::Base
+  validates :uid, :provider, presence: true
+  validates_uniqueness_of :uid, scope: [:provider, :identifiable_type]
+
+  belongs_to :identifiable, polymorphic: true
+
+  serialize :info, JSON
+
+  def username
+    info["nickname"]
+  end
+
+  def avatar_url
+    info["image"]
+  end
+end

data/test/dummy/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  include SimpleMobileOauth::Identifiable
+end