noxy 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69b63b40aba3c20978bbae0708d1d1c8e5ee59c7
+  data.tar.gz: 1790f0cbd28b5569b7f0fe237874cfd00b6dedfc
+SHA512:
+  metadata.gz: 5219740c32aa0f43c846e8f642d49b752efb42155704c58359820da9e9279ac0527bbfa5808794e9b4e11da59aabce07201c1742942e4c84168d64b54baa34d3
+  data.tar.gz: 25ad93fe3167dbedfb74b45104cccf4a853401c271be7eb2411b3d9ebbd1aae801aa5761b8ba727ba181ba765dfb05306a10259fa5cc4283bdb75b7bf879716b

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/test
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 D.Kainama
+
+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,101 @@
+# Noxy
+
+A simple gem for handling Google Domain Authorization.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'noxy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install noxy
+
+## Usage
+
+**WARNING:** You must enable Google Contacts API and Google Plus API when creating client, https://console.developers.google.com.
+
+
+Pre-Configure Noxy:
+
+    Noxy.configure do | option |
+      option.app     = "SoundFruit"
+      option.client  = "foo"
+      option.secret  = "bar20oo0)"
+      option.session = "some.shared.common.secret"
+      option.proxy   = -> { check(authorization)}
+    end
+
+Add Noxy to a Sinara app.
+
+    class Foo < Sinatra::Base
+      register Noxy::Auth
+    end
+
+Configure Noxy from a Sinara app.
+
+    class Foo < Sinatra::Base
+      ...
+      noxy.app   = "DogSmash"
+      noxy.proxy = -> {
+
+        # authorization hash is available.
+        authorization.info.email
+      }
+    end
+
+Following helpers available
+
+    class Foo < Sinatra::Base
+      ...
+      before do
+        unless authorized?
+          halt 401
+        end
+      end
+
+
+      get "/hit" do
+        "Hit the dog"
+      end
+    end
+
+
+To redirect to Google Auth page, visit this link
+
+    a href=("/auth/google_oauth2") Inloggen
+
+
+By default the following routes are defined:
+
+    [GET]  /auth/google_oauth2/callback
+    [POST] /auth/google_oauth2/callback
+
+Both are needed for handling the callback from Google.
+When the callback from Google is completed the `Noxy.proxy` will be called.
+
+
+
+## Todo (3.1.2)
+
+  * Make path in cookie configurable (./lib/noxy/sinatra.rb)
+  * Clean up test / example Sinatra app for push
+  * Write more specs.
+
+  * Make secreat / client_id readable from custom location
+    ,i.e: ~/.secure/app/.
+
+## Contributing
+
+1. Fork it ( https://github.com/amaniak/noxy/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

data/Rakefile

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

data/lib/noxy.rb

@@ -0,0 +1,51 @@
+# core
+require "rack"
+require "logger"
+require "hashie"
+require "omniauth-google-oauth2"
+require "delegate"
+
+# active_support
+require "active_support/core_ext/module/delegation"
+
+# version
+require "noxy/version"
+
+# configuration
+require "noxy/options"
+require "noxy/configuration"
+
+# domain validation
+require "noxy/sinatra"
+
+
+# Noxy module
+
+module Noxy
+
+  extend self
+
+  # Logging for module
+  # @param body [String] String to send to logger.
+
+  def self.log(body)
+    @logger ||= Logger.new(STDOUT)
+    @logger.debug "[Noxy]: #{body}"
+  end
+
+  # Make module configurable
+  # @param [block] accepts a optional block
+  # @return []
+
+  def configure
+    block_given? ? yield(Noxy::Configuration) : Noxy::Configuration
+  end
+
+  # Delegate all public
+  # instance methods from Configuration to Noxy
+
+  delegate(*(
+    Noxy::Configuration.public_instance_methods(false) <<
+    { to: Noxy::Configuration }))
+
+end

data/lib/noxy/configuration.rb

@@ -0,0 +1,28 @@
+module Noxy
+  module Configuration
+
+    LOCK = Mutex.new
+
+    extend self
+    extend Options
+
+    option :app,     default: ""
+    option :session, default: ""
+    option :client,  default: ""
+    option :secret,  default: ""
+    option :proxy,   default: -> {}
+
+    def options=(options)
+
+      # Mutex for future threaded env.
+      LOCK.synchronize do
+        if options
+          options.each_pair do |option, value|
+            send("#{option}=", value)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/noxy/options.rb

@@ -0,0 +1,33 @@
+module Noxy
+  module Options
+
+    def defaults
+      @defaults ||= {}
+    end
+
+    def option(name, options = {})
+      defaults[name] = settings[name] = options[:default]
+
+      class_eval <<-RUBY
+
+        def #{name}
+          settings[#{name.inspect}]
+        end
+
+        def #{name}=(value)
+          settings[#{name.inspect}] = value
+        end
+
+        def #{name}?
+          #{name}
+        end
+
+      RUBY
+    end
+
+    def settings
+      @settings ||= {}
+    end
+
+  end
+end

data/lib/noxy/sinatra.rb

@@ -0,0 +1,58 @@
+require "noxy"
+
+module Noxy
+  module Auth
+
+    # helpers
+    module Helpers
+
+      def authorized?
+        session['noxy.authorized']
+      end
+
+      def authorization
+        request.env['omniauth.auth']
+      end
+
+    end
+
+    # After register callback when Noxy
+    # is embedded in a Sinatra app.
+    # @param app [Hash] Base app.
+    # @return [Void]
+
+    def self.registered(app)
+
+      # Noxy
+      app.set :noxy, Proc.new { Noxy }
+
+      # Create a session cookie: store
+      # auth data securely accross multiple domains.
+
+      app.use Rack::Session::Cookie,
+              key: "#{app.noxy.app}.noxy.session",
+              secret: "#{app.noxy.session}",
+              path: '/'
+
+      # plug and play OmniAuth - Google OAuth2
+      app.use OmniAuth::Builder do
+        provider :google_oauth2, app.noxy.client, app.noxy.secret
+      end
+
+      # define proxy lambda, so the proxy lambda,
+      # from Noxy is configurable and
+      # is executed on app instance.
+
+      proxy = -> { self.instance_exec &app.noxy.proxy }
+
+      # setup, make sure it's handled on GET and POST
+      app.get  '/auth/:name/callback',  &proxy
+      app.post '/auth/:name/callback',  &proxy
+
+
+      # set module as helper
+      app.helpers Helpers
+
+    end
+  end
+end

data/lib/noxy/version.rb

@@ -0,0 +1,3 @@
+module Noxy
+  VERSION = "0.3.1"
+end

data/noxy.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'noxy/version'
+
+Gem::Specification.new do |gem|
+
+  gem.name          = "noxy"
+  gem.version       = Noxy::VERSION
+  gem.authors       = ["DK"]
+  gem.email         = ["amaniak@noxqs.nl"]
+  gem.summary       = %q{Google Apps domain authentication}
+  gem.description   = %q{Basic support for Google Apps authentication}
+  gem.homepage      = "http://noxqs.nl"
+  gem.license       = "MIT"
+
+
+  gem.files         = `git ls-files -z`.split("\x0")
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "hashie"
+  gem.add_dependency "sinatra-contrib"
+  gem.add_dependency "omniauth-google-oauth2"
+  gem.add_dependency "activesupport"
+
+  gem.add_development_dependency "bundler", "~> 1.7"
+  gem.add_development_dependency "rake", "~> 10.0"
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rack-test"
+  gem.add_development_dependency "yard"
+end

data/spec/noxy_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'securerandom'
+
+describe Noxy do
+
+  before do
+
+    @app = "Tindr"
+    @session = SecureRandom.hex(16)
+    @client = SecureRandom.hex(16)
+    @secret = SecureRandom.hex(16)
+    @proxy = lambda {}
+
+    Noxy.configure do | n |
+      n.app     = @app
+      n.session = @session
+      n.client  = @client
+      n.secret  = @secret
+      n.proxy   = @proxy
+    end
+  end
+
+  it "should have a settings object" do
+    expect(Noxy.configure).to eq(Noxy::Configuration)
+  end
+
+  it "should have a app property" do
+    expect(Noxy.app).to eq(@app)
+  end
+
+  it "should have a session object" do
+    expect(Noxy.session).to eq(@session)
+  end
+
+  it "should have a client object" do
+    expect(Noxy.client).to eq(@client)
+  end
+
+  it "should have a secret object" do
+    expect(Noxy.secret).to eq(@secret)
+  end
+
+  it "should have a proxy object" do
+    expect(Noxy.proxy).to eq(@proxy)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'noxy'
+
+RSpec.configure do |config|
+  config.color = true
+  config.formatter     = 'documentation'
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: noxy
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- DK
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  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: sinatra-contrib
+  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-google-oauth2
+  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: activesupport
+  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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rspec
+  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: rack-test
+  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: yard
+  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: Basic support for Google Apps authentication
+email:
+- amaniak@noxqs.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/noxy.rb
+- lib/noxy/configuration.rb
+- lib/noxy/options.rb
+- lib/noxy/sinatra.rb
+- lib/noxy/version.rb
+- noxy.gemspec
+- spec/noxy_spec.rb
+- spec/spec_helper.rb
+homepage: http://noxqs.nl
+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.4.4
+signing_key: 
+specification_version: 4
+summary: Google Apps domain authentication
+test_files:
+- spec/noxy_spec.rb
+- spec/spec_helper.rb
+has_rdoc: