app_rail-airtable 0.2.6 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d893dd5ef7b42015a34fe0dd55738ef1296799ba40bd235c4fd1c84665d6048
-  data.tar.gz: 0bd37ae820e88d1198cd7e82a0d8a965d893d0d4c8dc32bc33975f7f7a95cbcc
+  metadata.gz: 3e57f8d279b01f1a7672be43fce5dda36da9df13bc3152399646f5be729d522c
+  data.tar.gz: 7928368ae9d1b4edfd75c651af688be2aa0e7697f31fd5c87afb1a9e96e3945c
 SHA512:
-  metadata.gz: 4a4fe2f30b7b4ef404062e5396d304abf584873b1bfb5bf32d81ed3f8d5f04a01172bac29600ed83f7e347ba28267e670ce083e5aa0b93e886357b00042bfe73
-  data.tar.gz: 23cf52db82ae5ba37f9ea00751f867a93b7d1f800f480810b21e932e4cfec3792eede5a3569b3b0baba1143991d415e6a09c031bee7d981196d8ebcbfca2cfaf
+  metadata.gz: 5eef1c52f304ffe1b0050ff5a7278e47c825dce1e7e08a7af69550894070e23a465dc719fce7dddabfa06de9336f2b63d230685098d09a5c02711b17fe43394d
+  data.tar.gz: e3629a453d333d78aac608f45ac04b303b27c636f4350fb0f5c2b42c739756a274faabd55a08278b0cc445a5777f62ae57431acea477dae20575ff1cfac53e59

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    app_rail-airtable (0.2.6)
+    app_rail-airtable (0.2.10)
       activesupport
       airrecord
+      bcrypt
       sinatra
       thor
 
@@ -19,6 +20,7 @@ GEM
     airrecord (1.0.7)
       faraday (>= 0.10, < 2.0)
       net-http-persistent
+    bcrypt (3.1.16)
     byebug (11.1.3)
     concurrent-ruby (1.1.9)
     connection_pool (2.2.5)

data/README.md

@@ -31,7 +31,9 @@ You should create a model class for each table you want to use in your App. Mode
 To provide support for routes, models can implement
 * ar_list_item (index)
 * ar_stack (show)
-* self.create_from_params (create) 
+* self.create_as_json (create)
+
+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.

data/app_rail-airtable.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'sinatra'
   spec.add_dependency 'airrecord'
   spec.add_dependency 'thor'
+  spec.add_dependency 'bcrypt'
   
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rack-test'

data/lib/app_rail/airtable/application_record.rb

@@ -43,7 +43,7 @@ module AppRail
       # Customisable behaviour
       
       # Override to provide custom sorting or filtering for index
-      def self.index
+      def self.index(user:)
         all
       end
       

data/lib/app_rail/airtable/authenticatable.rb

@@ -0,0 +1,47 @@
+require 'bcrypt'
+require 'securerandom'
+
+module AppRail
+  module Airtable
+    module Authenticatable
+      include BCrypt
+  
+      def self.included(klass)
+        klass.extend(ClassMethods)
+      end
+      
+      module ClassMethods
+        def create(email:, password:)
+          user = User.new("Email" => email, "Password Hash" => password_hash(password), "Access Token" => access_token)
+          user.create
+          user
+        end
+        
+        def create_session_as_json(email:, password:)
+          user = find_by_email_and_password(email, password)
+          user&.oauth_session
+        end
+  
+        def find_by_email_and_password(email, password)
+          all(filter: "AND({Email} = \"#{email}\",{Password Hash} = \"#{password_hash(password)}\")").first
+        end
+  
+        def find_by_access_token(access_token)
+          all(filter: "{Access Token} = \"#{access_token}\"").first 
+        end
+        
+        def password_hash(password)
+          BCrypt::Password.create(password)
+        end   
+        
+        def access_token
+          SecureRandom.hex
+        end    
+      end
+    
+      def oauth_session
+        { access_token: self["Access Token"], scope: :user, refresh_token: "", token_type: :bearer, expires_in: 60000 }
+      end
+    end
+  end
+end

data/lib/app_rail/airtable/authentication_helpers.rb

@@ -0,0 +1,27 @@
+module AppRail
+  module Airtable
+    module AuthenticationHelpers
+      def current_user
+        @current_user ||= find_current_user
+      end
+  
+      def find_current_user
+        authorization_header && bearer_token ? User.find_by_access_token(bearer_token) : nil
+      end
+  
+      def bearer_token
+        authorization_values = authorization_header.split(" ")
+        return nil unless authorization_values.count > 1
+        authorization_values[1]
+      end
+  
+      def authorization_header
+        request.env["HTTP_AUTHORIZATION"]
+      end
+  
+      def authenticate!
+        halt 401 unless current_user
+      end
+    end
+  end
+end

data/lib/app_rail/airtable/sinatra.rb

@@ -2,6 +2,7 @@ require 'sinatra'
 require 'json'
 require 'active_support'
 
+# TODO: MBS - move to configure block or other
 Airrecord.api_key = ENV.fetch("AIRTABLE_API_KEY")
 
 class Symbol
@@ -29,33 +30,38 @@ module AppRail
           request.body.rewind
           JSON.parse(request.body.read)
         end
+        
+        def params_and_body_as_json
+          request_body_as_json.merge(params)
+        end
       end
 
-      def self.resources(name, only: [:index, :show, :create])
+      def self.resources(name, only: [:index, :show, :create], authenticated: false)
         only = [only] if only.is_a?(Symbol)
         
-        index_route(name) if only.include?(:index)
-        show_route(name) if only.include?(:show)
-        create_route(name) if only.include?(:create)
+        index_route(name, authenticated) if only.include?(:index)
+        show_route(name, authenticated) if only.include?(:show)
+        create_route(name, authenticated) if only.include?(:create)
       end
       
-      def self.index_route(name)
+      def self.index_route(name, authenticated)
         get "/#{name.to_s}" do
-          name.classify_constantize.index.map(&:ar_list_item_as_json).to_json
+          authenticate! if authenticated
+          name.classify_constantize.index(user: authenticated ? current_user : nil).map(&:ar_list_item_as_json).to_json
         end
       end
       
-      def self.show_route(name)
+      def self.show_route(name, authenticated)
         get "/#{name.to_s}/:id" do
+          authenticate! if authenticated
           name.classify_constantize.find(params['id']).ar_stack_as_json.to_json
         end
       end
       
-      def self.create_route(name)
+      def self.create_route(name, authenticated)
         post "/#{name.to_s}" do
-          request.body.rewind # in case someone already read it
-          data = JSON.parse(request.body.read)
-          as_json = name.classify_constantize.create_with_params_as_json(data.merge(params))
+          authenticate! if authenticated
+          as_json = name.classify_constantize.create_as_json(current_user: authenticated ? current_user : nil, params: params_and_body_as_json)
           [201, as_json.to_json] 
         end
       end

data/lib/app_rail/airtable/version.rb

@@ -1,5 +1,5 @@
 module AppRail
   module Airtable
-    VERSION = "0.2.6"
+    VERSION = "0.2.10"
   end
 end

data/lib/app_rail/airtable.rb

@@ -1,8 +1,10 @@
 require "app_rail/airtable/version"
+require "app_rail/airtable/string_ext"
 require "app_rail/airtable/application_record"
+require "app_rail/airtable/authenticatable"
+require "app_rail/airtable/authentication_helpers"
 require "app_rail/airtable/sinatra"
 require "app_rail/airtable/generator"
-require "app_rail/airtable/string_ext"
 
 module AppRail
   module Airtable

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: app_rail-airtable
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.10
 platform: ruby
 authors:
 - Matt Brooke-Smith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-01 00:00:00.000000000 Z
+date: 2021-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +130,8 @@ files:
 - bin/setup
 - lib/app_rail/airtable.rb
 - lib/app_rail/airtable/application_record.rb
+- lib/app_rail/airtable/authenticatable.rb
+- lib/app_rail/airtable/authentication_helpers.rb
 - lib/app_rail/airtable/generator.rb
 - lib/app_rail/airtable/sinatra.rb
 - lib/app_rail/airtable/string_ext.rb