app_rail-airtable 0.2.5 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfc0c7a8abdd811b4b70a4ef1bf1d5a42a9212712cfdf35fada50d1db81c670b
-  data.tar.gz: 133f6b44dc502297d1bdfeb085f896a62eb155d0483ce8cf60c493ee2db84c7d
+  metadata.gz: 3e09f5f21d40b2186a9b4d985d85305c0f4e54e4066d74ee45a5c43a32a303ad
+  data.tar.gz: 0ab6b313e24780b1f83e2359638e783ff3d7ca7b6958b14c7c80ba479262e07c
 SHA512:
-  metadata.gz: 482b3617a8e4ee7d2628e1efb7d6a4674ecf258c77dbd1594aaa1246dcfa0d06d56846f0606e75de39c76902b3101c2e10646e6587ccf98ef06965f5eca8eca8
-  data.tar.gz: 2d3fdcd70ed7f14166fa8c301a5745b5aa8aeaaef6dd0202da440570dfe8d537ffad48eb6debd1d4fa05092a560bd8bdd396aad7c523a9aefbda23b8abb1c769
+  metadata.gz: 5cdd4ff73e660d69000ac91e1204047f7637a7d58e351e1253639a60423828ccf3c8417083aeaadf1d4d3660584302cbfab9a39f5f737a5b501257fdf6f0359e
+  data.tar.gz: b9e534d2132bf753fd8cdf8d1126cdf629921177bbaf164e6ca21cabd64b9b207830dcbc9087a09f480c03d0c5ebb8e0101a8ae1d6625da851dc8bc8e589eee3

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+.byebug_history

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    app_rail-airtable (0.2.5)
+    app_rail-airtable (0.2.9)
       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/bin/ara_generator

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 require "bundler/setup"
-require 'app_rail/airtable'
+require 'app_rail/airtable/generator'
 require 'byebug'
 
 AppRail::Airtable::Generator.start(ARGV)

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/authentication_record.rb

@@ -0,0 +1,27 @@
+require 'bcrypt'
+
+module AppRail
+  module Airtable
+    class AuthenticationRecord < ApplicationRecord
+      include BCrypt
+      airtable_attr "Email", "Password Hash", "Access Token"
+  
+      def self.create_session_as_json(email:, password:)
+        user = find_by_email_and_password(email, Password.create(password))
+        user&.oauth_session
+      end
+  
+      def self.find_by_email_and_password(email, password_hash)
+        all(filter: "AND({Email} = \"#{email}\",{Password Hash} = \"#{password_hash}\")").first
+      end
+  
+      def self.find_by_access_token(access_token)
+        all(filter: "{Access Token} = \"#{access_token}\"").first 
+      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/generator.rb

@@ -1,7 +1,7 @@
 require 'active_support/core_ext/string/inflections'
+require 'app_rail/airtable/string_ext'
 require 'thor'
 require 'airrecord'
-require 'app_rail/airtable/string_ext'
 
 module AppRail
   module Airtable

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
@@ -23,24 +24,47 @@ end
 module AppRail
   module Airtable
     class Sinatra < Sinatra::Base
+      
+      helpers do
+        def request_body_as_json
+          request.body.rewind
+          JSON.parse(request.body.read)
+        end
+        
+        def params_and_json_body
+          request_body_as_json.merge(params)
+        end
+      end
 
-      def self.resources(name)
+      def self.resources(name, only: [:index, :show, :create], authenticated: false)
+        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)
+      end
+      
+      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, 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, authenticated)
         post "/#{name.to_s}" do
-          request.body.rewind # in case someone already read it
-          data = JSON.parse(request.body.read)
-          new_record = name.classify_constantize.create_from_params(data.merge(params)) 
-          [201, {id: new_record.id}.to_json] 
+          authenticate! if authenticated
+          as_json = name.classify_constantize.create_as_json(current_user: authenticated ? current_user : nil, params: params_and_json_body)
+          [201, as_json.to_json] 
         end
       end
-
     end
   end
 end

data/lib/app_rail/airtable/version.rb

@@ -1,5 +1,5 @@
 module AppRail
   module Airtable
-    VERSION = "0.2.5"
+    VERSION = "0.2.9"
   end
 end

data/lib/app_rail/airtable.rb

@@ -1,8 +1,9 @@
 require "app_rail/airtable/version"
+require "app_rail/airtable/string_ext"
 require "app_rail/airtable/application_record"
+require "app_rail/airtable/authentication_record"
 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.5
+  version: 0.2.9
 platform: ruby
 authors:
 - Matt Brooke-Smith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-20 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
@@ -102,7 +116,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".DS_Store"
-- ".byebug_history"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -117,6 +130,7 @@ files:
 - bin/setup
 - lib/app_rail/airtable.rb
 - lib/app_rail/airtable/application_record.rb
+- lib/app_rail/airtable/authentication_record.rb
 - lib/app_rail/airtable/generator.rb
 - lib/app_rail/airtable/sinatra.rb
 - lib/app_rail/airtable/string_ext.rb

data/.byebug_history

@@ -1,14 +0,0 @@
-exit
-@table_definitions.first.all.first.fields.keys
-@table_definitions.first.all.first.fields
-@table_definitions.first.all.first
-@table_definitions.first.first
-@table_definitions.first.instance_variable_get("@fields")
-@table_definitions.first.instance_variable_get("fields")
-@table_definitions.first.instance_variable_get("@fields")
-@table_definitions.first.fields
-@table_definitions.first.table_name
-@table_definitions.first.name
-@table_definitions.first.all
-@table_definitions.first
-@table_definitions