vxod 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84dbcc2c6095ad15b11d1f1bea3d48bc7dd1d192
-  data.tar.gz: 569502dec522de57df1c3fdc19f294b60c39582e
+  metadata.gz: 008aab422391d21d786d637e7722ec0131c8a775
+  data.tar.gz: 8da28065880c08f5d822a016019cc9a38463be31
 SHA512:
-  metadata.gz: ef1f277a8d4dfe3a2a62fc0dc276a24d614ecf3d7845eb5381c1e46af4134e779a0cc0b5bef62ded49e3681770f39a9e29053d2d4f06ea9fa6cb1c69a637d94c
-  data.tar.gz: d6a4ef1805e63fee49087eeeb913ec331370d82fedb1bd7c2c49a5e1a7e38cb1d6fbe5a226509705f1b07f00d82fa1e2945670dc73dc039de5b0b44fd915f49b
+  metadata.gz: edcbc89295904c86953c8290fc4d1378f81747deab0f98fcfa9f8ee9898452b5735e835efb30e9c37e423b73b84ddfec63c150fd234ade6b263c80a19941785f
+  data.tar.gz: 4abbf46e19d202846411063f92df7f8ce3be40e61dbf976125e053a51c58a65a7e425583d64d6cffdb1dfbebac2287508b0eece6fa62903e6828c6d871886945

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+.DS_Store
+.sass-cache
+
+config_env.rb
+capybara-*.html

data/.ruby-gemset

@@ -0,0 +1 @@
+vxod

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+bundler_args: --without debug
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - jruby-head
+  - ruby-head
+  - rbx
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: ruby-head
+    - rvm: rbx
+
+services:
+  - mongodb

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'rake'
+end
+
+platforms :rbx do
+  gem 'racc'
+  gem 'rubysl', '~> 2.0'
+  gem 'psych'
+end
+
+# Specify your gem's dependencies in vxod.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Sergey Makridenkov
+
+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,77 @@
+# Vxod
+
+Social and password authorization solution
+
+[![Build Status](https://travis-ci.org/SergXIIIth/vxod.svg?branch=master)](https://travis-ci.org/SergXIIIth/vxod)
+[![Code Climate](https://codeclimate.com/github/SergXIIIth/vxod.png)](https://codeclimate.com/github/SergXIIIth/vxod)
+[![Dependency Status](https://gemnasium.com/SergXIIIth/vxod.svg)](https://gemnasium.com/SergXIIIth/vxod)
+[![Gem Version](https://badge.fury.io/rb/vxod.png)](http://badge.fury.io/rb/vxod)
+
+# Features
+
+- + social registration/login
+- password base registration/login, 
+- checkbox auto-generated password send to email
+- optional require email in social registration
+- reset password
+
+Future
+
+- profile with password reset, link other social servises to user
+- adminka for user management
+- support Sinatra, Mongoid, Rails, ActiveRecord, any Rack app, any DB
+
+
+# Installation
+
+- gem 'vxod'
+- configure email
+- provide key for open auth
+- provide layout to inject views
+
+## Config OmniAuth
+
+Gems
+
+    gem 'omniauth'
+    gem 'omniauth-twitter'
+    gem 'omniauth-vkontakte'
+    gem 'omniauth-facebook'
+    gem 'omniauth-google_oauth2'
+    gem 'omniauth-github'
+
+App
+
+    enable :sessions
+    set :sessions, secret: ENV['secret_secret']
+
+    use OmniAuth::Builder do
+      provider :twitter, ENV['omniauth.twitter'], ENV['omniauth.twitter_x']
+      provider :vkontakte, ENV['omniauth.vkontakte'], ENV['omniauth.vkontakte_x']
+      provider :facebook, ENV['omniauth.facebook'], ENV['omniauth.facebook_x']
+      provider :google_oauth2, ENV['omniauth.google'], ENV['omniauth.google_x']
+      provider :github, ENV['GITHUB_KEY'], ENV['GITHUB_SECRET']
+    end
+
+    use Vxod::Middleware # put it after use OmniAuth
+
+## Config Db
+
+    require 'vxod/db/mongoid'
+
+    Vxod::Db.identity = Vxod::Db::Mongoid::Identity
+    Vxod::Db.user = Vxod::Db::Mongoid::User
+
+
+
+# Usage
+
+TODO: Write usage instructions here
+
+# Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,21 @@
+require "bundler/gem_tasks"
+
+desc 'Run web server for example app'
+task 'web' do
+  system "bundle exec rerun --pattern '{**/*.rb}' -c 'puma -p 3000 --dir example'"
+end
+
+desc 'Console'
+task 'console' do
+  system "bundle exec irb -r ./example/app.rb"
+end
+
+desc 'Rub tests'
+task 'test' do
+  system %Q(bundle exec rerun --pattern '{**/*.rb}' -cx rspec -t ~feature)
+end
+
+# for CI
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default  => :spec

data/example/app.rb

@@ -0,0 +1,44 @@
+require 'sinatra'
+require 'vxod'
+require 'slim'
+require 'sass'
+require 'config_env'
+require 'mongoid'
+require 'omniauth'
+require 'omniauth-twitter'
+require 'omniauth-vkontakte'
+require 'omniauth-facebook'
+require 'omniauth-google-oauth2'
+require 'omniauth-github'
+
+
+config_env = "#{__dir__}/config_env.rb"
+require config_env if File.exists?(config_env)
+
+require_relative 'config_app'
+
+helpers do
+  def vxod 
+    @vxod = Vxod.api(self)
+  end
+end
+
+get '/' do
+  'Hello please try protected page at <a id="secret" href="/secret">/secret</a>'
+end
+
+get '/secret' do
+  vxod.required
+  slim :secret
+end
+
+template :secret do
+%q(
+
+p 
+  | I am secret page for 
+  strong = vxod.user.email
+p: a id='logout' href='/logout' Logout
+
+)
+end

data/example/config.ru

@@ -0,0 +1,3 @@
+require './app'
+
+run Sinatra::Application

data/example/config_app.rb

@@ -0,0 +1,27 @@
+# Mongoid
+
+Mongoid.load!(__dir__ + '/mongoid.yml')
+
+
+# OmniAuth
+
+enable :sessions
+set :sessions, secret: ENV['secret_secret']
+
+use OmniAuth::Builder do
+  provider :twitter, ENV['omniauth.twitter'], ENV['omniauth.twitter_x']
+  provider :vkontakte, ENV['omniauth.vkontakte'], ENV['omniauth.vkontakte_x']
+  provider :facebook, ENV['omniauth.facebook'], ENV['omniauth.facebook_x']
+  provider :google_oauth2, ENV['omniauth.google'], ENV['omniauth.google_x']
+  provider :github, ENV['GITHUB_KEY'], ENV['GITHUB_SECRET']
+end
+
+use Vxod::Middleware
+
+
+# Db
+
+require 'vxod/db/mongoid'
+
+Vxod::Db.identity = Vxod::Db::Mongoid::Identity
+Vxod::Db.user = Vxod::Db::Mongoid::User

data/example/mongoid.yml

@@ -0,0 +1,85 @@
+development:
+  # Configure available database sessions. (required)
+  sessions:
+    # Defines the default session. (required)
+    default:
+      # Defines the name of the default database that Mongoid can connect to.
+      # (required).
+      database: redsi_development
+      # Provides the hosts the default session can connect to. Must be an array
+      # of host:port pairs. (required)
+      hosts:
+        - 127.0.0.1:27017
+      options:
+        # Change whether the session persists in safe mode by default.
+        # (default: false)
+        # safe: false
+
+        # Change the default consistency model to :eventual or :strong.
+        # :eventual will send reads to secondaries, :strong sends everything
+        # to master. (default: :eventual)
+        # consistency: :eventual
+
+        # How many times Moped should attempt to retry an operation after
+        # failure. (default: 30)
+        # max_retries: 30
+
+        # The time in seconds that Moped should wait before retrying an
+        # operation on failure. (default: 1)
+        # retry_interval: 1
+  # Configure Mongoid specific options. (optional)
+  options:
+    # Configuration for whether or not to allow access to fields that do
+    # not have a field definition on the model. (default: true)
+    # allow_dynamic_fields: true
+
+    # Enable the identity map, needed for eager loading. (default: false)
+    # identity_map_enabled: false
+
+    # Includes the root model name in json serialization. (default: false)
+    # include_root_in_json: false
+
+    # Include the _type field in serializaion. (default: false)
+    # include_type_for_serialization: false
+
+    # Preload all models in development, needed when models use
+    # inheritance. (default: false)
+    # preload_models: false
+
+    # Protect id and type from mass assignment. (default: true)
+    # protect_sensitive_fields: true
+
+    # Raise an error when performing a #find and the document is not found.
+    # (default: true)
+    # raise_not_found_error: true
+
+    # Raise an error when defining a scope with the same name as an
+    # existing method. (default: false)
+    # scope_overwrite_exception: false
+
+    # Skip the database version check, used when connecting to a db without
+    # admin access. (default: false)
+    # skip_version_check: false
+
+    # User Active Support's time zone in conversions. (default: true)
+    # use_activesupport_time_zone: true
+
+    # Ensure all times are UTC in the app side. (default: false)
+    # use_utc: false
+test:
+  sessions:
+    default:
+      database: redsi_test
+      hosts:
+        - 127.0.0.1:27017
+      options:
+        consistency: :strong
+        # In the test environment we lower the retries and retry interval to
+        # low amounts for fast failures.
+        max_retries: 1
+        retry_interval: 0
+production:
+  sessions:
+    default:
+      uri: <%= ENV['MONGO_URI'] %>
+      options:         

data/lib/vxod.rb

@@ -0,0 +1,15 @@
+require 'sinatra/base'
+require 'vxod/version'
+
+module Vxod
+  autoload :Db, 'vxod/db'
+  autoload :Email, 'vxod/email'
+  autoload :BackPath, 'vxod/back_path'
+  autoload :Config, 'vxod/config'
+  autoload :App, 'vxod/app'
+  autoload :Api, 'vxod/api'
+  autoload :LoginWithOpenid, 'vxod/login_with_openid'
+  require 'vxod/api_static'
+  autoload :OmniAuthProvider, 'vxod/omni_auth_provider'
+  autoload :Middleware, 'vxod/middleware'
+end

data/lib/vxod/api.rb

@@ -0,0 +1,56 @@
+module Vxod
+  class Api
+    def initialize(rack_app)
+      @rack_app = rack_app
+    end
+
+    attr_reader :rack_app
+
+    # Authorize user right to make action on object
+    #
+    # Check that user login and have right to make 'action' on 'object'
+    # If not it redirects to login page
+    def required(action = nil, object = nil)
+      if user.nil?
+        BackPath.new(rack_app).save(app.request_path)
+        app.redirect(Vxod.config.login_path)
+      else
+        true
+      end
+    end
+
+    def login_with_openid
+      openid.login
+    end
+
+    def logout
+      app.detele_auth_key
+      app.redirect(Vxod.config.after_login_default_path)
+    end
+
+    # Save missing user data after openid registration
+    def openid_save_user_data
+      openid.save_user_data
+    end
+
+    # Return user for fill user data page
+    def user_to_fill_data
+      @user_to_fill_data ||= Db.user.find_by_auth_key(app.auth_key_for_fill_user_data)
+    end
+
+    # Current user
+    def user
+      @user ||= Db.user.find_by_auth_key(app.auth_key)
+    end
+
+  private
+
+    def openid
+      @openid ||= LoginWithOpenid.new(app)
+    end
+
+    def app
+      @app ||= Vxod::App.new(rack_app)
+    end
+  end
+end

data/lib/vxod/api_static.rb

@@ -0,0 +1,11 @@
+module Vxod
+  class << self
+    def api(rack_app)
+      Vxod::Api.new(rack_app)
+    end
+
+    def config
+      @config ||= Vxod::Config.new
+    end
+  end
+end