app_rail-airtable 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98fa16c4b212cd84ea0d9cd5caa37100c3f3bf9d97919cb1814d914d45fdf2c6
-  data.tar.gz: d16166e491328eaa897086cd43940e11b52e8345bfd8bef3bcb547537304e2cd
+  metadata.gz: 6a8973236f81565186f4a9cf047fbe516cd7f3f452b551ab0e02c9406fce1c88
+  data.tar.gz: 313a3e40f5eb79bd17c6561e2f65f4946ae4df80afdf16d901cf2bad21c23ad0
 SHA512:
-  metadata.gz: 2532b3183fba2e26b117e232a54d65120f9e08a874d46a1a08e6331bc11ee10de6a8460622d68c7bc46ec633090beb023d7de7b4a34dc2546c6013469b2157d6
-  data.tar.gz: ae372f1540f615fffd90045c6e2c6b4f1e4252278dcb256d4262d04a6356b50e1510676ed94f6d0358c4608f967caec00214fa6df4ebb6b9334f41846ec5a85d
+  metadata.gz: dc54fefbcb0f1ef89868e249b2c9b456322a3f78a39fe550e45c20716d1b723f989556281b91d5f437fdf21de0de1a1fbbe6bbd65dff14982d7aa93f570e2b26
+  data.tar.gz: b11d2a98504953e57c171b38f13f3e618bdcf8bb42b014e62c883c4deeb3d92dbf1bb20e70a30b70394ed5e83f9c330e25ce6da5627f46509d23f4da81ddc1d7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    app_rail-airtable (0.3.2)
+    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/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/version.rb

@@ -1,5 +1,5 @@
 module AppRail
   module Airtable
-    VERSION = "0.3.2"
+    VERSION = "0.3.3"
   end
 end

data/templates/project/Gemfile

@@ -5,17 +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'
 
 group :development do
-  gem 'dotenv' 
+  gem 'dotenv'
 end
 
 group :test do
-  gem "rspec"
-  gem "rack-test"  
+  gem 'rack-test'
+  gem 'rspec'
 end
 
 group :development, :test do
-  gem 'byebug' 
-end
+  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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: app_rail-airtable
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Matt Brooke-Smith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-13 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