hobby-auth 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a695f776bd20babf3742458ff066a82b5afafe90
-  data.tar.gz: 625b7448fe38eb6e59abb4b29f6dac9f75113694
+  metadata.gz: 0fd7308d5de3ee1087bf4829558efeb555f18433
+  data.tar.gz: 383fd2c09d0fc8a72d63e0f6f6857df11439b690
 SHA512:
-  metadata.gz: cb4684a95506dead682cb9b696f41f2a980723e69aa420dcc9d9b188135fdbc4aa80fffd1e9a31e965eae2f04e082809ccde27a98bcd33827a12d97638fa1ace
-  data.tar.gz: e72b29085e987c5c16ce5a83b2e0839baa3f716a0ecde1cf4bec877e10f0ed7eb5672cecbb762958a8528a31a58063d9ce2119d53ae74870410fe657e0ad6e09
+  metadata.gz: bfc2f279d0e4f7979ea66adb086067c19f5e4320ea0a9aea0a7cb865ae6a9c4b5939e2e305902db56b222f0567b707c5c8ef3d14790d9bbc4f6e9492d9639345
+  data.tar.gz: c57175fc1f465f1524d0000342b36c2f1a192dfd37da8c5a78167ed409ab42d93a5487895eedfd0d9be4f3b33ce1ca715ae9c53340c9c2787979aa359e9e82b5

data/.gitignore

@@ -1 +1,2 @@
 Gemfile.lock
+*.gem

data/Gemfile

@@ -1,3 +1,3 @@
 source 'https://rubygems.org'
 
-gem 'hobby-devtools', '>=0.0.7'
+gem 'hobby-devtools', '>=0.0.11'

data/hobby-auth.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |g|
   g.name    = 'hobby-auth'
   g.files   = `git ls-files`.split($/)
-  g.version = '0.0.1'
-  g.summary = 'Authorize Hobby routes'
+  g.version = '0.0.2'
+  g.summary = 'A Hobby extension to authorize routes.'
   g.authors = ['Anatoly Chernow']
 end

data/lib/hobby/auth.rb

@@ -1,10 +1,12 @@
 module Hobby
   module Auth
     def self.[] *user_models
+      pairs = find_pairs user_models
+
       Module.new do
         define_singleton_method :included do |app|
-          user_models.each do |user_model|
-            app.define_singleton_method short_name_of user_model do |route|
+          pairs.each do |name, user_model|
+            app.define_singleton_method name do |route|
               action = route.action
               route.action = -> do
                 if user = (user_model.find_by_token env['HTTP_AUTHORIZATION'])
@@ -19,12 +21,35 @@ module Hobby
           end
         end
 
-        def self.short_name_of user_model
-          user_model.name.split('::').last.downcase
-        end
-
         attr_reader :user
       end
     end
+
+    class SameNames < StandardError
+      def initialize models, name
+        first, second = models
+        message = "The short names of #{first} and #{second} are the same: #{name}."
+        super message
+      end
+    end
+
+    def self.find_pairs user_models
+      pairs = user_models.map { |um| [(short_name_of um), um] }
+
+      names = {}
+      pairs.each do |name, model|
+        if first_model_with_that_name = names[name]
+          fail SameNames.new [first_model_with_that_name, model], name
+        else
+          names[name] = model
+        end
+      end
+
+      pairs
+    end
+
+    def self.short_name_of user_model
+      user_model.name.split('::').last.downcase
+    end
   end
-end # Ends should be optional. Block nesting can be inferred from two-space indent.
+end

data/readme.adoc

@@ -0,0 +1,95 @@
+= Hobby-Auth
+
+This repository provides a https://github.com/ch1c0t/hobby[Hobby] extension
+to authorize routes.
+
+== Installation
+
+[source,bash]
+----
+gem install hobby-auth
+----
+
+== Introduction
+
+You are expected to pass your user models as arguments to `Hobby::Auth.[]`:
+
+[source,ruby]
+----
+require 'hobby'
+require 'hobby/auth'
+
+class YourApp
+  include Hobby
+  include Auth[*array_of_user_models]
+
+  # some route defining logic goes here, after 'includes'
+end
+----
+
+A user model is any object that responds to these two methods:
+
+* `.name` which returns a `String` which might be in
+https://ruby-doc.org/core/Module.html#method-i-name[Module#name].
+* `.find_by_token` which takes one argument(a token `String`),
+and returns `nil`(if no user were found) or a user(which
+can be any object you would like to consider a user in your application).
+
+You can access that user via `user` method.
+
+Consider an example app where you need two user roles: managers and drivers.
+You can define `Manager` class as follows:
+
+[source,ruby]
+----
+class Manager
+  def self.find_by_token token
+    new if token == 'the only valid token at the moment'
+  end
+end
+----
+and `Driver` class similarly.
+
+Then, you can use them in your app:
+
+[source,ruby]
+----
+class App
+  include Hobby
+  include Auth[Manager, Driver]
+
+  manager post('/managers_route') {
+    # do something only managers can do
+    user # will return a `Manager` instance
+  }
+
+  driver get('/drivers_route') {
+    # do something only drivers can do
+    user # will return a `Driver` instance
+  }
+end
+----
+
+The token is expected to be passed via
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization[Authorization header].
+If no user were found, the response's status will be set to
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/403[403].
+
+NOTE: If your user models have names leading to the same decorator name
+(for example, `Manager` and `SomeNamespace::Manager`),
+a `Hobby::Auth::SameNames` error will be raised.
+
+== Development
+
+To run the specs:
+
+[source,bash]
+----
+bundle exec rspec
+----
+
+To perform mutation analysis:
+[source,bash]
+----
+bundle exec mutant --use rspec 'Hobby::Auth*'
+----

data/spec/http/getter_decorator.yml

@@ -0,0 +1,22 @@
+- get:
+    path: /decorator
+
+  response:
+    status: 403
+
+- get:
+    path: /decorator
+    headers:
+      Authorization: invalid token
+
+  response:
+    status: 403
+
+- get:
+    path: /decorator
+    headers:
+      Authorization: first valid getter token
+
+  response:
+    status: 200
+    body: decorator append

data/spec/http_spec.rb

@@ -10,6 +10,15 @@ Hobby::Devtools::RSpec.describe do
 
       getter get { 'oh my get' }
       poster post { "the user's token is #{user.token}" }
+
+
+      def self.append_decorator route
+        action = route.action
+        route.action = -> { "#{instance_exec(&action)} append" }
+        route
+      end
+
+      append_decorator getter get('/decorator') { 'decorator' }
     end.new
   end
 end

data/spec/name_shadowing_spec.rb

@@ -0,0 +1,27 @@
+require 'helper'
+
+class Same
+  def self.find_by_token _token
+    new
+  end
+end
+
+module Namespaced
+  class Same
+    def self.find_by_token _token
+      new
+    end
+  end
+end
+
+describe Hobby::Auth do
+  it 'raises an error when the short names are the same' do
+    expect {
+      Class.new do
+        include Hobby
+        include Hobby::Auth[Same, Namespaced::Same]
+      end
+    }.to raise_error Hobby::Auth::SameNames,
+    'The short names of Same and Namespaced::Same are the same: same.'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hobby-auth
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Anatoly Chernow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-03 00:00:00.000000000 Z
+date: 2017-06-14 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: 
@@ -20,10 +20,13 @@ files:
 - Gemfile
 - hobby-auth.gemspec
 - lib/hobby/auth.rb
+- readme.adoc
 - spec/helper.rb
 - spec/http/getter.yml
+- spec/http/getter_decorator.yml
 - spec/http/poster.yml
 - spec/http_spec.rb
+- spec/name_shadowing_spec.rb
 - spec/seed_users.rb
 homepage: 
 licenses: []
@@ -44,8 +47,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Authorize Hobby routes
+summary: A Hobby extension to authorize routes.
 test_files: []