app_rail-airtable 0.3.0 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 592d97e9fc6dbe4177847fdbfbc5c003620d179caee7887efb23f91d5f736ca7
-  data.tar.gz: 985e3ac9e23f4fe318c4944c2c3720a656faead5b5de3e3149fe58013aaa173c
+  metadata.gz: 66fa38f57c975b6de65ce8ab4548421e8063e50774245f37c9ed38ef13802747
+  data.tar.gz: a13a5199edac840e26ed2e70676c3eff4f36c000c4af80cdf710cf3a47fad56a
 SHA512:
-  metadata.gz: 80ae0eea7fbd168f1b469a5bfc9255940f0c62875d232427fd654d123e3b02aab822646cf6fa23313ca3fe7e653d0d73935927b8c6dff74dec8a01acf5edd431
-  data.tar.gz: 83e8736f2dc7dc42d276c45a83d8597c98d1f38faee8cf09e581f19256f22f64de81fa34a1acf9f290f9e4638a4bc00f14e25787d29bf2507d2bc3bbba44a13b
+  metadata.gz: 002c107e9dd70908b323f836240ec3c4253f9fa8393a2ce2312812d189804618fe0070a0a47485833111299ec6a8d0e6168ccc427d953eb6137cf367bc708e61
+  data.tar.gz: b5b4ff1a93cb0608a08a64bc2197f7b2961a5eadc876a9564d2d3a5e285ddf38b4185d03d68ba5c894f90ad974e32de93c0852b86a1dd34c28388e6b364003d3

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.3.0)
+    app_rail-airtable (0.3.4)
       activesupport
       airrecord
       bcrypt
@@ -11,12 +11,11 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4.1)
+    activesupport (7.0.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     airrecord (1.0.7)
       faraday (>= 0.10, < 2.0)
       net-http-persistent
@@ -25,28 +24,32 @@ GEM
     concurrent-ruby (1.1.9)
     connection_pool (2.2.5)
     diff-lcs (1.4.4)
-    faraday (1.8.0)
+    faraday (1.9.3)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
       faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
+      faraday-net_http_persistent (~> 1.0)
       faraday-patron (~> 1.0)
       faraday-rack (~> 1.0)
-      multipart-post (>= 1.2, < 3)
+      faraday-retry (~> 1.0)
       ruby2_keywords (>= 0.0.4)
     faraday-em_http (1.0.0)
     faraday-em_synchrony (1.0.0)
     faraday-excon (1.1.0)
     faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.3)
+      multipart-post (>= 1.2, < 3)
     faraday-net_http (1.0.1)
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
-    i18n (1.8.10)
+    faraday-retry (1.0.3)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.4)
+    minitest (5.15.0)
     multipart-post (2.1.1)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
@@ -81,7 +84,6 @@ GEM
     tilt (2.0.10)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/app_rail-airtable.gemspec

@@ -19,6 +19,10 @@ Gem::Specification.new do |spec|
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
+  
+  spec.bindir = 'bin'
+  spec.executables << 'ara_generator'
+  
   spec.require_paths = ["lib"]
   spec.add_dependency 'activesupport'
   spec.add_dependency 'sinatra'

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/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

@@ -44,6 +44,8 @@ module AppRail
         helpers AppRail::Airtable::AuthenticationHelpers
         
         resources(name, only: only)
+        
+        return unless block_given?
         @@authenticated_route = true
         yield
         @@authenticated_route = false

data/lib/app_rail/airtable/version.rb

@@ -1,5 +1,5 @@
 module AppRail
   module Airtable
-    VERSION = "0.3.0"
+    VERSION = "0.3.4"
   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.3.0
+  version: 0.3.4
 platform: ruby
 authors:
 - Matt Brooke-Smith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-09 00:00:00.000000000 Z
+date: 2022-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -111,7 +111,8 @@ dependencies:
 description:
 email:
 - matt@futureworkshops.com
-executables: []
+executables:
+- ara_generator
 extensions: []
 extra_rdoc_files: []
 files:
@@ -143,7 +144,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