app_rail-airtable 0.2.11 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4042e0d7f3f72204f26f22d018c4e6fff171a76379e6961ac93511930566e43d
-  data.tar.gz: 95e44a95a516a1ef1afdaf14f47ff145deae55021c4b939e874033567515f234
+  metadata.gz: 15aed8edd922ec35c782dd42d03b7beb8e6a797b4bbc68a32f7db968b905c92c
+  data.tar.gz: d864fd4adc4f4fdf2c96d7751e9c7ab7005d629ce0d4109f8221f3173796c7e1
 SHA512:
-  metadata.gz: 71120e0e952456e41fb9f950d45b763306a038571694f37976c72e23824b4501bc8f87e141b765878e76dca4e438f6a12440da4112ba9803957902706865964d
-  data.tar.gz: 1da004d48fb6e02c0871a941423d191efcccf0b6a56d2c34123bf556e6b12756c589fab1ebca055ce6f5cd7eb0003cff19e815743bb2b7afc130bc0868674f13
+  metadata.gz: 6876774d54ef6775fdebc8dc435a33f44ce4a298ac420031c369dcc049e7298d79a204bff276f7f19dba0e4322cce0aee7b089b142ad2d55fdbeeb477f55adc7
+  data.tar.gz: f77814cfdecf5792443e48cc22be7faf05a533c9f798597f39a65c2cd311763a77a1e729e906b746e6c4a7331a9fd42b1a5456b2d2205102be64badfba8ac556

data/.gitignore

@@ -1,3 +1,7 @@
+.DS_STORE
+*.swp
+*.rbc
+*.sass-cache
 /.bundle/
 /.yardoc
 /_yardoc/
@@ -10,3 +14,6 @@
 # rspec failure tracking
 .rspec_status
 .byebug_history
+
+# dotenv
+.env

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    app_rail-airtable (0.2.11)
+    app_rail-airtable (0.3.1)
       activesupport
       airrecord
       bcrypt

data/README.md

@@ -36,7 +36,18 @@ To provide support for routes, models can implement
 In order to support authentication you should create a class (normally `User`) and inherit from `AppRail::Airtable::AuthenticationRecord`. Your table needs `Email`, `Password Hash` and `Access Token` columns.
     
 ### Servers
-You should create a single server which extends `AppRail::Airtable::Sinatra`, then add routes with the `resources` macro to add `index`, `show` and `create` routes. You can also provide your own routes.
+You should create a single server which extends `AppRail::Airtable::Sinatra`.
+
+App Rail Airtable provides two helpers to generate routes
+
+**resources(name, only:)**
+Creates routes that map to a table. It delegates from the route to a model method
+* `index` to `ar_list_item`
+* `show` to `ar_stack`
+* `create` to `self.create_as_json`
+
+**authenticable_resources(name, , only:)** 
+Acts as `resources` but also takes a block of routes. Those nested routes will all call the `authenticate!` helper method before running. The `authenticate!` helper will call a lookup helper `find_authenticatable_resource(access_token:)` with the bearer token found in the `HTTP_AUTHORIZATION` header, which should be used to look up the correct object or return nil if none is found (resulting in a 401 response).
 
 ## License
 

data/lib/app_rail/airtable/authenticatable.rb

@@ -12,19 +12,21 @@ module AppRail
       
       module ClassMethods
         def create(email:, password:)
-          user = User.new("Email" => email, "Password Hash" => password_hash(password), "Access Token" => access_token)
+          user = User.new("Email" => email, "Password Hash" => password_hash(password), "Access Token" => next_access_token)
           user.create
           user
         end
         
         def create_session_as_json(email:, password:)
           user = find_by_email_and_password(email, password)
+          user["Access Token"] = next_access_token
+          user.save
           user&.oauth_session
         end
   
         def find_by_email_and_password(email, password)
-          user = all(filter: "AND({Email} = \"#{email}\"").first
-          user.valid_password? ? user : nil
+          user = all(filter: "{Email} = \"#{email}\"").first
+          user.valid_password?(password) ? user : nil
         end
 
         def find_by_access_token(access_token)
@@ -35,7 +37,7 @@ module AppRail
           BCrypt::Password.create(password)
         end   
         
-        def access_token
+        def next_access_token
           SecureRandom.hex
         end    
       end

data/lib/app_rail/airtable/authentication_helpers.rb

@@ -6,7 +6,7 @@ module AppRail
       end
   
       def find_current_user
-        authorization_header && bearer_token ? User.find_by_access_token(bearer_token) : nil
+        authorization_header && bearer_token ? find_authenticatable_resource(access_token: bearer_token) : nil
       end
   
       def bearer_token

data/lib/app_rail/airtable/sinatra.rb

@@ -24,6 +24,7 @@ end
 module AppRail
   module Airtable
     class Sinatra < Sinatra::Base
+      @@authenticated_route = false
       
       helpers do
         def request_body_as_json
@@ -35,36 +36,54 @@ module AppRail
           request_body_as_json.merge(params)
         end
       end
+      
+      def self.authenticatable_resources(name, only: [:index, :show, :create])
+        
+        # If authentication is used then include the correct helpers
+        # Allowing the routes to use `authenticate!` and `current_user`
+        helpers AppRail::Airtable::AuthenticationHelpers
+        
+        resources(name, only: only)
+        
+        return unless block_given?
+        @@authenticated_route = true
+        yield
+        @@authenticated_route = false
+      end
 
-      def self.resources(name, only: [:index, :show, :create], authenticated: false)
+      def self.resources(name, only: [:index, :show, :create])
         only = [only] if only.is_a?(Symbol)
         
-        index_route(name, authenticated) if only.include?(:index)
-        show_route(name, authenticated) if only.include?(:show)
-        create_route(name, authenticated) if only.include?(:create)
+        index_route(name, authenticated_route?) if only.include?(:index)
+        show_route(name, authenticated_route?) if only.include?(:show)
+        create_route(name, authenticated_route?) if only.include?(:create)
       end
       
-      def self.index_route(name, authenticated)
+      def self.index_route(name, authenticated_route)
         get "/#{name.to_s}" do
-          authenticate! if authenticated
-          name.classify_constantize.index(user: authenticated ? current_user : nil).map(&:ar_list_item_as_json).to_json
+          authenticate! if authenticated_route
+          name.classify_constantize.index(user: authenticated_route ? current_user : nil).map(&:ar_list_item_as_json).to_json
         end
       end
       
-      def self.show_route(name, authenticated)
+      def self.show_route(name, authenticated_route)
         get "/#{name.to_s}/:id" do
-          authenticate! if authenticated
+          authenticate! if authenticated_route
           name.classify_constantize.find(params['id']).ar_stack_as_json.to_json
         end
       end
       
-      def self.create_route(name, authenticated)
+      def self.create_route(name, authenticated_route)
         post "/#{name.to_s}" do
-          authenticate! if authenticated
-          as_json = name.classify_constantize.create_as_json(current_user: authenticated ? current_user : nil, params: params_and_body_as_json)
+          authenticate! if authenticated_route
+          as_json = name.classify_constantize.create_as_json(current_user: authenticated_route ? current_user : nil, params: params_and_body_as_json)
           [201, as_json.to_json] 
         end
       end
+      
+      def self.authenticated_route?
+        @@authenticated_route
+      end
     end
   end
 end

data/lib/app_rail/airtable/version.rb

@@ -1,5 +1,5 @@
 module AppRail
   module Airtable
-    VERSION = "0.2.11"
+    VERSION = "0.3.1"
   end
 end

data/templates/project/.gitignore

@@ -2,7 +2,18 @@
 *.swp
 *.rbc
 *.sass-cache
-/pkg
-/coverage
-.yardoc
-/doc
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.byebug_history
+
+# dotenv
+.env

data/templates/project/Gemfile

@@ -7,9 +7,15 @@ ruby '2.7.4'
 
 gem 'app_rail-airtable'
 
-# dev
-gem 'dotenv'
+group :development do
+  gem 'dotenv' 
+end
 
-# test
-gem "rspec"
-gem "rack-test"
+group :test do
+  gem "rspec"
+  gem "rack-test"  
+end
+
+group :development, :test do
+  gem 'byebug' 
+end

data/templates/project/config.ru

@@ -1,5 +1,11 @@
 $stdout.sync = true
 
-require 'dotenv/load'
+ENV['RACK_ENV'] ||= 'development'
+require 'dotenv/load' if ENV['RACK_ENV'] == 'development'
+require 'bundler'
+Bundler.require(:default, ENV['RACK_ENV'].to_sym)
+
+require 'dotenv/load' if ENV['RACK_ENV'] == 'development'
+
 require './lib/server'
 run Server

data/templates/project/spec/spec_helper.rb

@@ -23,7 +23,6 @@ require "rack/test"
 require "app_rail/airtable"
 
 require './lib/server'
-require './lib/item_recommender'
 
 RSpec.configure do |config|
   # rspec-expectations config goes here. You can use an alternate

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: app_rail-airtable
 version: !ruby/object:Gem::Version
-  version: 0.2.11
+  version: 0.3.1
 platform: ruby
 authors:
 - Matt Brooke-Smith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-06 00:00:00.000000000 Z
+date: 2021-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport