zilch-authorisation 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 433b19fae52cfe196363bea6f17d45e6cb1dbc9b
+  data.tar.gz: 33b502c5c925507d44a3269be82c82f8fdddd513
+SHA512:
+  metadata.gz: 53c9fc71053e3f69fc905f525274af252855ad1d984b0c7abf092375e7e73d218c871d217fd0c6e844c962c72433122eac8a53f792bd53029d1d1014ba8e74c1
+  data.tar.gz: 095881123a96e2a3e6ba177fa396e2b2f2b81e2d512c2f85f70188b106aa81776f78f0e11cb1d262d97558f9410abf21528c8dd2bd4b80585e2b478d9055eec0

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Rob Yurkowski and Philip Arndt
+
+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,32 @@
+# Zilch-Authorisation
+
+Zilch-Authorisation is a zero-dependency authorisation interface.
+
+The idea is that Zilch stands in for any authentication or authorisation calls
+that your application makes and fulfills them by passing them to a registered
+adapter that implements its interface with common libraries.
+
+Once you are ready to implement a different authentication and/or authorisation
+mechanism, you can write an adapter that implements the interfaces that Zilch
+provides. In this way, you can easily swap out implementation details and not
+affect your code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zilch', '~> 1.0'
+```
+
+And then execute:
+
+    $ bundle
+
+## Contributing
+
+1. Fork it ( https://github.com/robyurkowski/zilch/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/zilch-authorisation.rb

@@ -0,0 +1,2 @@
+require "zilch/authorisation"
+require "zilch/authorisation/version"

data/lib/zilch/authorisation.rb

@@ -0,0 +1,4 @@
+module Zilch
+  module Authorisation
+  end
+end

data/lib/zilch/authorisation/adapters/default.rb

@@ -0,0 +1,23 @@
+require 'zilch/authorisation/nil_user'
+
+module Zilch
+  module Authorisation
+    module Adapters
+      class Default
+
+        def allow?(operation, resource)
+          true
+        end
+
+        def authenticate!
+          true
+        end
+
+        def current_user
+          Zilch::Authorisation::NilUser.new
+        end
+
+      end
+    end
+  end
+end

data/lib/zilch/authorisation/authorisation_manager.rb

@@ -0,0 +1,54 @@
+require 'forwardable'
+require 'zilch/authorisation/adapters/default'
+
+module Zilch
+  module Authorisation
+    # Interface for interacting with authentication and authorisation.
+    #
+    # @since x.x.x
+    class AuthorisationManager
+      extend Forwardable
+
+
+      def_delegators :adapter, :authenticate, :authenticated?, :current_user, :allow?
+
+
+      # Exception-raising version of `#authenticate`. Raise if not
+      # authenticated.
+      #
+      # @since x.x.x
+      def authenticate!
+        raise Zilch::Authorisation::NotAuthorisedException unless adapter.authenticate!
+        adapter.current_user
+      end
+
+
+      # Reader for the adapter which implements this interface.
+      #
+      # @since x.x.x
+      def adapter
+        @adapter ||= default_adapter
+      end
+
+
+      # Setter for the adapter which implements the interface. The given
+      # adapter must respond to
+      #
+      # @since x.x.x
+      attr_writer :adapter
+
+
+      # Specifies the default adapter to use.
+      #
+      # @since x.x.x
+      def default_adapter
+        Zilch::Authorisation::Adapters::Default.new
+      end
+
+
+    end
+
+    class NotAuthorisedException < Exception
+    end
+  end
+end

data/lib/zilch/authorisation/nil_user.rb

@@ -0,0 +1,9 @@
+module Zilch
+  module Authorisation
+    class NilUser
+      def to_s
+        self.class.to_s
+      end
+    end
+  end
+end

data/lib/zilch/authorisation/users_manager.rb

@@ -0,0 +1,37 @@
+require 'forwardable'
+
+module Zilch
+  module Authorisation
+    # Interface for interacting with users.
+    #
+    # @since x.x.x
+    class UsersManager
+      extend Forwardable
+
+
+      def_delegators :adapter, :primary_user
+
+
+      # Reader for the adapter which implements this interface.
+      #
+      # @since x.x.x
+      def adapter
+        @adapter ||= default_adapter
+      end
+
+
+      # Setter for the adapter which implements the interface.
+      #
+      # @since x.x.x
+      attr_writer :adapter
+
+
+      # Specifies the default adapter to use.
+      #
+      # @since x.x.x
+      def default_adapter
+        Zilch::Authorisation::Adapters::Default.new
+      end
+    end
+  end
+end

data/lib/zilch/authorisation/version.rb

@@ -0,0 +1,5 @@
+module Zilch
+  module Authorisation
+    VERSION = "0.0.1"
+  end
+end

data/spec/lib/zilch/authorisation/authorisation_manager_spec.rb

@@ -0,0 +1,71 @@
+require "spec_helper"
+require "zilch/authorisation/authorisation_manager"
+
+RSpec.describe Zilch::Authorisation::AuthorisationManager do
+  describe "authentication" do
+    let(:adapter) { double("NewAdapter") }
+
+    before do
+      subject.adapter = adapter
+    end
+
+    describe "#authenticate" do
+      it "asks the adapter" do
+        expect(adapter).to receive(:authenticate)
+        subject.authenticate
+      end
+    end
+
+
+    describe "#authenticated?" do
+      it "asks the adapter" do
+        expect(adapter).to receive(:authenticated?)
+        subject.authenticated?
+      end
+    end
+
+
+    describe "#current_user" do
+      it "asks the adapter" do
+        expect(adapter).to receive(:current_user)
+        subject.current_user
+      end
+    end
+
+
+    describe "#allow?" do
+      it "asks the adapter" do
+        expect(adapter).to receive(:allow?)
+        subject.allow?
+      end
+    end
+
+
+    describe "#authenticate!" do
+      it "asks the adapter" do
+        allow(adapter).to receive(:current_user)
+        expect(adapter).to receive(:authenticate!).and_return true
+        subject.authenticate!
+      end
+
+      context "when not authenticated" do
+        it "throws an exception" do
+          allow(adapter).to receive(:authenticate!).and_return false
+          expect { subject.authenticate! }.to raise_exception Zilch::Authorisation::NotAuthorisedException
+        end
+      end
+
+      context "when authenticated" do
+        it "returns the current user" do
+          allow(adapter).to receive(:authenticate!).and_return true
+          expect(adapter).to receive(:current_user)
+          subject.authenticate!
+        end
+      end
+    end
+  end
+
+  describe "adapter" do
+    it_behaves_like "zilch adapter"
+  end
+end

data/spec/lib/zilch/authorisation/nil_user_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'zilch/authorisation/nil_user'
+
+RSpec.describe Zilch::Authorisation::NilUser do
+  it "has an approximate string representation" do
+    expect(subject.to_s).to eq("Zilch::Authorisation::NilUser")
+  end
+end

data/spec/lib/zilch/authorisation/users_manager_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+require "zilch/authorisation/users_manager"
+
+RSpec.describe Zilch::Authorisation::UsersManager do
+  describe "users" do
+    let(:adapter) { double("NewAdapter") }
+
+    before do
+      subject.adapter = adapter
+    end
+
+    describe "primary user" do
+      it "asks the adapter" do
+        expect(adapter).to receive(:primary_user)
+        subject.primary_user
+      end
+    end
+  end
+
+  describe "adapter" do
+    it_behaves_like "zilch adapter"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,87 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+Dir[File.expand_path("../support/**/*.rb", __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,23 @@
+shared_examples_for "zilch adapter" do
+  let(:adapter) { double("NewAdapter") }
+
+  describe "#adapter" do
+    context "when given an adapter" do
+      before do
+        subject.adapter = adapter
+      end
+
+      it "uses that adapter" do
+        expect(subject.adapter).to eq(adapter)
+      end
+    end
+
+    context "when not given an adapter" do
+      it "uses the default adapter" do
+        default_adapter = double("DefaultAdapter")
+        allow(subject).to receive(:default_adapter).and_return(default_adapter)
+        expect(subject.adapter).to eq(default_adapter)
+      end
+    end
+  end
+end

data/zilch-authorisation.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zilch/authorisation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zilch-authorisation"
+  spec.version       = Zilch::Authorisation::VERSION
+  spec.authors       = ["Rob Yurkowski", "Philip Arndt"]
+  spec.email         = ["rob@yurkowski.net", "p@arndt.io"]
+  spec.summary       = %q{A zero-dependency authorisation stub}
+  spec.description   = %q{A zero-dependency authorisation stub}
+  spec.homepage      = "https://github.com/robyurkowski/zilch-authorisation"
+  spec.license       = "MIT"
+
+  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 "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: zilch-authorisation
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rob Yurkowski
+- Philip Arndt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-06 00:00:00.000000000 Z
+dependencies:
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A zero-dependency authorisation stub
+email:
+- rob@yurkowski.net
+- p@arndt.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/zilch-authorisation.rb
+- lib/zilch/authorisation.rb
+- lib/zilch/authorisation/adapters/default.rb
+- lib/zilch/authorisation/authorisation_manager.rb
+- lib/zilch/authorisation/nil_user.rb
+- lib/zilch/authorisation/users_manager.rb
+- lib/zilch/authorisation/version.rb
+- spec/lib/zilch/authorisation/authorisation_manager_spec.rb
+- spec/lib/zilch/authorisation/nil_user_spec.rb
+- spec/lib/zilch/authorisation/users_manager_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+- zilch-authorisation.gemspec
+homepage: https://github.com/robyurkowski/zilch-authorisation
+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.6
+signing_key: 
+specification_version: 4
+summary: A zero-dependency authorisation stub
+test_files:
+- spec/lib/zilch/authorisation/authorisation_manager_spec.rb
+- spec/lib/zilch/authorisation/nil_user_spec.rb
+- spec/lib/zilch/authorisation/users_manager_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+has_rdoc: