app_rail-airtable 0.2.13 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b50f647ec9cbe6a4872a61db88b1bdb15eb9c960b90c219fc5023ea38078e940
-  data.tar.gz: ab041ecd7134b4f611460f0e7cacf94fdb1e873066d148d7e69217dc904a018c
+  metadata.gz: 6a8973236f81565186f4a9cf047fbe516cd7f3f452b551ab0e02c9406fce1c88
+  data.tar.gz: 313a3e40f5eb79bd17c6561e2f65f4946ae4df80afdf16d901cf2bad21c23ad0
 SHA512:
-  metadata.gz: dbbe3242c32cf4a94a045e58085024224c1b18423936f89228dc00f6672f6c76db979ac6bc242ec89792d3f330626d0a0b900154efd941cb9314545b4109e033
-  data.tar.gz: 2c3827c50ebdda11aebd971160d45d2fedae642628f59f757f43c48ee020607eca527da0cc159ecb6b7387b371e5c74d27660e960746dff5bf4ad06c1f6442d9
+  metadata.gz: dc54fefbcb0f1ef89868e249b2c9b456322a3f78a39fe550e45c20716d1b723f989556281b91d5f437fdf21de0de1a1fbbe6bbd65dff14982d7aa93f570e2b26
+  data.tar.gz: b11d2a98504953e57c171b38f13f3e618bdcf8bb42b014e62c883c4deeb3d92dbf1bb20e70a30b70394ed5e83f9c330e25ce6da5627f46509d23f4da81ddc1d7

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.13)
+    app_rail-airtable (0.3.3)
       activesupport
       airrecord
       bcrypt
@@ -44,7 +44,7 @@ GEM
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
-    i18n (1.8.10)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     minitest (5.14.4)
     multipart-post (2.1.1)
@@ -81,7 +81,7 @@ GEM
     tilt (2.0.10)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby

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

@@ -17,6 +17,7 @@ module AppRail
       def self.airtable_attr(*attributes)
         attributes.each do |attribute|
           define_method(attribute.to_s.snake_case) { self[attribute] }
+          define_method("#{attribute.to_s.snake_case}=") { |value| self[attribute] = value }
         end
       end
     

data/lib/app_rail/airtable/authenticatable.rb

@@ -12,13 +12,15 @@ 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
   
@@ -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/generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/string/inflections'
 require 'app_rail/airtable/string_ext'
 require 'thor'
@@ -11,21 +13,48 @@ module AppRail
       argument :output_directory
       argument :api_key
       argument :base_id
-      argument :tables
+      argument :schema
 
       def self.source_root
-        File.join(File.dirname(__FILE__), "..", "..", "..")
+        File.join(File.dirname(__FILE__), '..', '..', '..')
       end
 
       def create_project
-        # Build tables
-        @table_definitions = tables.split(",").map {|t| Airrecord.table(api_key, base_id, t.strip) }
+        validate_airtable_schema
         directory('templates/project', output_directory)
       end
-  
+
       def self.exit_on_failure?
         true
       end
+
+      private
+
+      def validate_airtable_schema
+        tables.each do |table|
+          table_name = table['name']
+          table_fields = table['fields'].concat(table['associations']).map { |field| field['name'] }.compact
+
+          airtable_table = find_table(table_name)
+          compare_fields(table_fields, airtable_table)
+        end
+      end
+
+      def tables
+        @tables ||= JSON.parse(schema)['tables']
+      end
+
+      def find_table(table_name)
+        Airrecord.table(api_key, base_id, table_name)
+      end
+
+      def compare_fields(table_fields, airtable_table)
+        airtable_table.records.first.fields.each_key do |key|
+          next if table_fields.include? key
+
+          raise "ERROR! The key \"#{key}\" is not present in the schema definition."
+        end
+      end
     end
   end
-end
+end

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.13"
+    VERSION = "0.3.3"
   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

@@ -5,11 +5,17 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 ruby '2.7.4'
 
-gem 'app_rail-airtable'
+gem 'app_rail-airtable', '~> 0.3.3'
 
-# dev
-gem 'dotenv'
+group :development do
+  gem 'dotenv'
+end
 
-# test
-gem "rspec"
-gem "rack-test"
+group :test do
+  gem 'rack-test'
+  gem 'rspec'
+end
+
+group :development, :test do
+  gem 'byebug'
+end

data/templates/project/Gemfile.lock

@@ -10,10 +10,14 @@ GEM
     airrecord (1.0.7)
       faraday (>= 0.10, < 2.0)
       net-http-persistent
-    app_rail-airtable (0.2.2)
+    app_rail-airtable (0.3.3)
       activesupport
       airrecord
+      bcrypt
       sinatra
+      thor
+    bcrypt (3.1.16)
+    byebug (11.1.3)
     concurrent-ruby (1.1.9)
     connection_pool (2.2.5)
     diff-lcs (1.4.4)
@@ -37,7 +41,7 @@ GEM
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
-    i18n (1.8.10)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     minitest (5.14.4)
     multipart-post (2.1.1)
@@ -62,23 +66,25 @@ GEM
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+    rspec-support (3.10.3)
     ruby2_keywords (0.0.5)
     sinatra (2.1.0)
       mustermann (~> 1.0)
       rack (~> 2.2)
       rack-protection (= 2.1.0)
       tilt (~> 2.0)
+    thor (1.1.0)
     tilt (2.0.10)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  app_rail-airtable
+  app_rail-airtable (~> 0.3.3)
+  byebug
   dotenv
   rack-test
   rspec

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/lib/server.rb.tt

@@ -1,15 +1,62 @@
+# frozen_string_literal: true
+
 require 'app_rail/airtable'
+require 'active_support/inflector'
+
+<% @tables.each do |table| -%>
+<% keys = table['fields'].map { |field| field['name'] if field['type'] != 'association' }.compact -%>
+class <%= table['name'].singularize %> < AppRail::Airtable::ApplicationRecord  
+<% if table['authenticatable'] == 'True' -%>
+  include AppRail::Airtable::Authenticatable
 
-<% @table_definitions.each do |td| -%>
-<% keys = td.all.first.fields.keys -%>
-class <%= td.table_name.singularize %> < AppRail::Airtable::ApplicationRecord  
+<% end -%>
   airtable_attr <%= keys.map{|f| "\"#{f}\""}.join(", ") %>
-  ar_list_item text: :<%= keys.first.snake_case %>
+<% table['ar_class_methods']&.each do |method| -%>
+  <%= method['name'] %> <%= method['properties'].map {|prop| "#{prop['type']}: :#{prop['value']}" }.join(', ') %>
+<% end -%>
+
+<% table['associations']&.each do |association| -%>
+<% word_ending_method = association['type'] == 'has_many' ? :pluralize : :singularize -%>
+  <%= association['type'] %> <%= ":#{association['model'].snake_case.send(word_ending_method)}, class: \"#{association['model'].camelize.singularize}\", column: \"#{association['model'].camelize.send(word_ending_method)}\"" %>
+<% end -%>
+<% if table['authenticatable'] == 'True' -%>
+
+  def self.create_as_json(params:, current_user:)
+    record = <%= table['name'].singularize %>.create(email: params["payload"]["email"], password: params["payload"]["password"])
+    { response: { id: record.id }, oauth_session: record.oauth_session}
+  end
+<% end -%>
 end
 
 <% end -%>
+
+<% authenticatable_table = @tables.select { |table| table['authenticatable'] == 'True' }&.first -%>
+<% authenticatable_resource = authenticatable_table['name'] if authenticatable_table -%>
 class Server < AppRail::Airtable::Sinatra
-<% @table_definitions.each do |td| -%>
-  resources :<%= td.table_name.snake_case %>
+<% if authenticatable_resource -%>
+<% model_name = authenticatable_resource.singularize -%>
+  helpers do
+    def find_authenticatable_resource(access_token:)
+      <%= model_name %>.find_by_access_token(access_token)
+    end
+  end
+
+  authenticatable_resources :<%= authenticatable_resource.snake_case %> do
+<% @tables.each do |table| -%>
+<% next if table['name'] == authenticatable_resource -%>
+    resources :<%= table['name'].snake_case %>
+<% end -%>
+  end
+
+  post "/sessions" do
+    oauth_session = <%= model_name %>.create_session_as_json(email: params["username"], password: params["password"])
+    halt 401 unless oauth_session
+
+    oauth_session.to_json
+  end
+<% else -%>
+<% @tables.each do |table| -%>
+  resources :<%= table['name'].snake_case %>
+<% end -%>
 <% end -%>
 end

data/templates/project/spec/server_spec.rb.tt

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+<% authenticatable_table = @tables.select { |table| table['authenticatable'] == 'True' }&.first -%>
+<% authenticatable_resource = authenticatable_table['name'] if authenticatable_table -%>
+require 'spec_helper'
+
+RSpec.describe Server do
+  let(:json_response) { JSON.parse(response.body, symbolize_names: true) }
+  let(:access_token) { SecureRandom.hex }
+  let(:auth_headers) { { 'HTTP_AUTHORIZATION' => "Bearer: #{access_token}" } }
+
+  def app
+    Server
+  end
+
+<% if authenticatable_resource -%>
+<% auth_model_name = authenticatable_resource.singularize -%>
+<% auth_path_name = authenticatable_resource.snake_case.pluralize -%>
+  describe 'POST /<%= auth_path_name %>' do
+    let(:params) { { payload: { email: 'test@test.com', password: 'Secret000' } } }
+    let(:response) { post "/<%= auth_path_name %>", params.to_json }
+    let(:mock_resource) { double(<%= auth_model_name %>) }
+
+    before { allow_any_instance_of(<%= auth_model_name %>).to receive(:create) { mock_resource } } 
+
+    it { expect(response.status).to eq 201 }
+    it { expect(json_response[:oauth_session][:access_token]).to_not be_nil }
+  end
+
+  describe 'POST /sessions' do
+    let(:params) { { username: 'test@test.com', password: 'Secret000' } }
+    let(:response) { post "/sessions", params }
+
+    context 'ok' do
+      let(:oauth_session) { { access_token: SecureRandom.hex } }
+
+      before { allow(<%= auth_model_name %>).to receive(:create_session_as_json).with({ email: params[:username], password: params[:password] }) { oauth_session } }
+
+      it { expect(response.status).to eq 200 }
+      it { expect(json_response[:access_token]).to_not be_nil }
+    end
+
+    context 'invalid' do
+      before { allow(<%= auth_model_name %>).to receive(:create_session_as_json).with({ email: params[:username], password: params[:password] }) { nil } }
+
+      it { expect(response.status).to eq 401 }
+      it { expect(response.body).to eq '' }
+    end
+  end
+
+<% @tables.each do |table| -%>
+<% next if table['name'] == authenticatable_resource -%>
+<% model_name = table['name'].singularize -%>
+<% path_name = table['name'].snake_case.pluralize -%>
+  describe 'GET /<%= path_name %>' do
+    let(:params) { {} }
+    let(:response) { get '/<%= path_name %>', params.to_json, auth_headers}
+    let(:mock_auth_resource) { double(<%= auth_model_name %>) }
+    let(:mock_resource) { double(<%= model_name %>, id: '1') }
+    let(:resource_to_json) { { id: '1' } }
+
+    before do
+      allow(<%= auth_model_name %>).to receive(:find_by_access_token).with(access_token) { mock_auth_resource }
+      allow(<%= model_name %>).to receive(:all) { [mock_resource] }
+      allow(mock_resource).to receive(:ar_list_item_as_json) { resource_to_json }
+    end
+
+    it { expect(response.status).to eq 200 }
+    it { expect(json_response).to eq [resource_to_json] }
+  end
+
+<% end -%>
+<% else -%>
+<% @tables.each do |table| -%>
+<% model_name = table['name'].singularize -%>
+<% path_name = table['name'].snake_case.pluralize -%>
+  describe 'GET /<%= path_name %>' do
+    let(:params) { {} }
+    let(:response) { get '/<%= path_name %>', params.to_json, auth_headers}
+    let(:mock_resource) { double(<%= model_name %>, id: '1') }
+    let(:resource_to_json) { { id: '1' } }
+
+    before do
+      allow(<%= model_name %>).to receive(:all) { [mock_resource] }
+      allow(mock_resource).to receive(:ar_list_item_as_json) { resource_to_json }
+    end
+
+    it { expect(response.status).to eq 200 }
+    it { expect(json_response).to eq [resource_to_json] }
+  end
+
+<% end -%>
+<% end -%>
+end

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.13
+  version: 0.3.3
 platform: ruby
 authors:
 - Matt Brooke-Smith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-06 00:00:00.000000000 Z
+date: 2021-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -143,7 +143,7 @@ files:
 - templates/project/app.json
 - templates/project/config.ru
 - templates/project/lib/server.rb.tt
-- templates/project/spec/server_spec.rb
+- templates/project/spec/server_spec.rb.tt
 - templates/project/spec/spec_helper.rb
 homepage: https://github.com/FutureWorkshops/app_rail-airtable
 licenses:

data/templates/project/spec/server_spec.rb

@@ -1,9 +0,0 @@
-require "spec_helper"
-
-RSpec.describe Server do
-  
-  def app
-    Server
-  end
-
-end