app_rail-airtable 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9ec1d3dd50d2b81b46a1f6804319b97424192accf1e825830ade564c4901aa5
-  data.tar.gz: '0220939ea9dfd1ca57806f60328ca0bd4ea09417fdc2aeb1b61e70687024aeef'
+  metadata.gz: 208213f6a53029eb29b4d98ed9b6d4f9bb7bb0375d3a5de3866615c8701ec3d9
+  data.tar.gz: 5aea3eda06422225f87170aa3b1d8a8a3310123fb151a554b29ad8059db72847
 SHA512:
-  metadata.gz: d13146f0116ea27771ac901dcc514938fa5e3b23e1b1342f6123a76a7e39bdb3b1dd1c7a2ce1bd477cc2a579a7c313ed44e521652f99ca9e8dcb78dba6b7a364
-  data.tar.gz: e6cfc76d2a99c122d3643dd587bdef60a5e7131f04c4f7d0de0ed60ed76c2c130f6ded6d74123864fa6cb45c15cb904e0c7fcd2e4500720ce2479f4de6ae3132
+  metadata.gz: 975099138a2b7aef7ae085a09d7ace624f6b7eba9c892691807505ec44f8322dbf8b3a474113ecb3053b6d8243264db97531607ec2cfc3b4ad8907c253242dc0
+  data.tar.gz: 2b07588a9c2c375a0b4574a4500921c40f306c45bf153fd530520b7874716f4fbdb3b4cd56ade60c5dba9827b097052833e8827b4b564a83303af47bb4373af7

data/.gitignore

@@ -1,3 +1,7 @@
+.DS_STORE
+*.swp
+*.rbc
+*.sass-cache
 /.bundle/
 /.yardoc
 /_yardoc/
@@ -9,3 +13,7 @@
 
 # rspec failure tracking
 .rspec_status
+.byebug_history
+
+# dotenv
+.env

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# 0.4.6
+* Add authenticatable_resource POST / DELETE `/<resource>/session` routes for sign in and sign out
+* Simplify sign in methods & remove Authenticatable#create_session_as_json
+
+# 0.4.0
+
+### Breaking changes
+* `AppRail::Airtable::Sinatra` `.resources` and `.authenticable_resources` `only` argument defaults to `[:index, :show, :create, :update]` instead of `[:index, :show, :create]`
+
+### New features
+* Add `Authenticatable#initialize` method to initialize an Airrecord record without persisting it to airtable
+* Add `update` route (`PUT`), which points to the corresponding model method `self.update_as_json`
+

data/Gemfile

@@ -1,7 +1,11 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in app_rail-airtable.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
+gem 'byebug'
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'thor'

data/Gemfile.lock

@@ -1,55 +1,50 @@
 PATH
   remote: .
   specs:
-    app_rail-airtable (0.1.0)
+    app_rail-airtable (0.5.0)
       activesupport
       airrecord
+      app_rail-steps
+      bcrypt
+      faraday (~> 2.2)
+      faraday-net_http_persistent (~> 2.0)
       sinatra
+      thor
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4.1)
+    activesupport (7.0.4)
       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)
+    airrecord (1.0.10)
+      faraday (>= 1.0, < 3.0)
+      faraday-net_http_persistent
       net-http-persistent
-    concurrent-ruby (1.1.9)
-    connection_pool (2.2.5)
+    app_rail-steps (0.2.17)
+    bcrypt (3.1.18)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.10)
+    connection_pool (2.3.0)
     diff-lcs (1.4.4)
-    faraday (1.7.2)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0.1)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      multipart-post (>= 1.2, < 3)
+    faraday (2.6.0)
+      faraday-net_http (>= 2.0, < 3.1)
       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-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-net_http (3.0.1)
+    faraday-net_http_persistent (2.1.0)
+      faraday (~> 2.5)
+      net-http-persistent (~> 4.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.4)
-    multipart-post (2.1.1)
-    mustermann (1.1.1)
+    minitest (5.16.3)
+    mustermann (2.0.2)
       ruby2_keywords (~> 0.0.1)
     net-http-persistent (4.0.1)
       connection_pool (~> 2.2)
     rack (2.2.3)
-    rack-protection (2.1.0)
+    rack-protection (2.2.2)
       rack
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -68,24 +63,26 @@ GEM
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
     ruby2_keywords (0.0.5)
-    sinatra (2.1.0)
-      mustermann (~> 1.0)
+    sinatra (2.2.2)
+      mustermann (~> 2.0)
       rack (~> 2.2)
-      rack-protection (= 2.1.0)
+      rack-protection (= 2.2.2)
       tilt (~> 2.0)
-    tilt (2.0.10)
-    tzinfo (2.0.4)
+    thor (1.1.0)
+    tilt (2.0.11)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   app_rail-airtable!
+  byebug
   rack-test
   rake (~> 12.0)
   rspec (~> 3.0)
+  thor
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,8 +1,6 @@
-# AppRail::Airtable
+# App Rail Airtable
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/app_rail/airtable`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+App Rail Airtable is a micro-framework based on Sinatra and [Airrecord](https://github.com/sirupsen/airrecord) which faciliates use of Airtable as a backend for App Rail Apps. You can deploy a template repo to Heroku for fast start.
 
 ## Installation
 
@@ -12,29 +10,79 @@ Add this line to your application's Gemfile:
 gem 'app_rail-airtable'
 ```
 
-And then execute:
+## Usage
 
-    $ bundle install
+App Rail Airtable has two important concepts, models and servers.
 
-Or install it yourself as:
+### Models
+App Rail Airtable makes the following assumptions
+1. Your App will connect to a single Airtable Base
+2. Your Airtable Base implements a normalised datamodel
+3. Your tables in Airtable are plural versions of the models you create in Ruby
 
-    $ gem install app_rail-airtable
+**API keys have account scope in Airtable so it is recommended to create a new account for each project so that API keys do not leak data, e.g. bob+<project name>@gmail.com. You can share the project with your main account so you don't need to login to separate accounts for each project.**
 
-## Usage
+You should create a model class for each table you want to use in your App. Model classes should extend `AppRail::Airtable::ApplicationRecord` and define [table name](https://github.com/sirupsen/airrecord#table) and [associations](https://github.com/sirupsen/airrecord#associations)
+    
+To provide support for routes, models can implement
+* ar_list_item (index)
+* ar_stack (show)
+* self.create_as_json (create)
+* self.update_as_json (update)
+
+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`.
+
+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`
+* `update` to `self.update_as_json`
 
-TODO: Write usage instructions here
+**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).
 
-## Development
+### Generator
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```bash
+bin/ara_generator <output_directory> <airtable_api_key> <airtable_base_id> [<json_schema>]
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+#### Example
 
-## Contributing
+```bash
+bin/ara_generator ./test key1234567890 appwertyuiop '{"tables": [{"name": "DailyLogs", "fields": [{"name": "Date", "type": "date"}, {"name": "Score", "type": "integer"}], "associations": [{"name": "User", "type": "belongs_to", "model": "User"}], "ar_class_methods": [{"name": "ar_list_item", "properties": [{"type": "text", "value": "date"}, {"type": "detail_text", "value": "score"}]}], "ar_instance_methods": [{"name": "ar_stack_item", "properties": [{"type": "text", "label": "Date", "value": "date"}, {"type": "button", "label": "Score", "value": "score", "modalWorkflow": "", "style": "primary", "onSuccess": "forward", "sfSymbolName": ""}]}]}, {"name": "Users", "fields": [{"name": "Email", "type": "string"}, {"name": "Password Hash", "type": "string"}, {"name": "Access Token", "type": "string"}], "associations": [{"name": "DailyLogs", "type": "has_many", "model": "DailyLog"}], "authenticatable": "True"}]}'
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/app_rail-airtable.
+You can find more examples of schemas in [/examples/schemas](/examples/schemas)
 
+## Debugging
 
+### Listing Existing Routes
+To get a complete list of the available routes in your Sinatra application, run the following code snippet:
+```ruby
+Server.routes.map do |method, routes|
+    routes.map { |r| r.first.to_s }.map do |route|
+      "#{method.rjust(7, ' ')} #{route}"
+    end
+  end.flatten.sort.each do |route|
+    puts route
+  end
+```
+Output:
+```
+    GET /mock_items
+    GET /mock_items/:id
+    PUT /mock_items/:id
+   HEAD /mock_items
+   HEAD /mock_items/:id
+   POST /mock_items
+```
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/app_rail-airtable.gemspec

@@ -1,29 +1,40 @@
+# frozen_string_literal: true
+
 require_relative 'lib/app_rail/airtable/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "app_rail-airtable"
+  spec.name          = 'app_rail-airtable'
   spec.version       = AppRail::Airtable::VERSION
-  spec.authors       = ["Matt Brooke-Smith"]
-  spec.email         = ["matt@futureworkshops.com"]
+  spec.authors       = ['Matt Brooke-Smith']
+  spec.email         = ['matt@futureworkshops.com']
 
-  spec.summary       = %q{Gem to help building App Rail servers using Airtable as a backend}
-  spec.homepage      = "https://github.com/FutureWorkshops/app_rail-airtable"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.summary       = 'Gem to help building App Rail servers using Airtable as a backend'
+  spec.homepage      = 'https://github.com/FutureWorkshops/app_rail-airtable'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/FutureWorkshops/app_rail-airtable"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/FutureWorkshops/app_rail-airtable'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.require_paths = ["lib"]
+
+  spec.bindir = 'bin'
+  spec.executables << 'ara_generator'
+
+  spec.require_paths = ['lib']
   spec.add_dependency 'activesupport'
-  spec.add_dependency 'sinatra'
   spec.add_dependency 'airrecord'
-  
-  spec.add_development_dependency 'rspec'
+  spec.add_dependency 'app_rail-steps'
+  spec.add_dependency 'bcrypt'
+  spec.add_dependency 'faraday', '~> 2.2'
+  spec.add_dependency 'faraday-net_http_persistent', '~> 2.0' # workaround to make Faraday work after upgrading to 2.2.0
+  spec.add_dependency 'sinatra'
+  spec.add_dependency 'thor'
+
   spec.add_development_dependency 'rack-test'
-end
+  spec.add_development_dependency 'rspec'
+end

data/bin/ara_generator

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

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "app_rail/airtable"
+require 'bundler/setup'
+require 'app_rail/airtable'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "app_rail/airtable"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/examples/schemas/daily_logs.json

@@ -0,0 +1,86 @@
+{
+  "tables": [
+    {
+      "name": "DailyLogs",
+      "fields": [
+        {
+          "name": "Date",
+          "type": "date"
+        },
+        {
+          "name": "Score",
+          "type": "integer"
+        }
+      ],
+      "associations": [
+        {
+          "name": "User",
+          "type": "belongs_to",
+          "model": "User"
+        }
+      ],
+      "ar_class_methods": [
+        {
+          "name": "ar_list_item",
+          "properties": [
+            {
+              "type": "text",
+              "value": "date"
+            },
+            {
+              "type": "detail_text",
+              "value": "score"
+            }
+          ]
+        }
+      ],
+      "ar_instance_methods": [
+        {
+          "name": "ar_stack_item",
+          "properties": [
+            {
+              "type": "text",
+              "label": "Date",
+              "value": "date"
+            },
+            {
+              "type": "button",
+              "label": "Score",
+              "value": "score",
+              "modalWorkflow": "",
+              "style": "primary",
+              "onSuccess": "forward",
+              "sfSymbolName": ""
+            }
+          ]
+        }
+      ],
+      "authenticatable": "True"
+    },
+    {
+      "name": "Users",
+      "fields": [
+        {
+          "name": "Email",
+          "type": "string"
+        },
+        {
+          "name": "Password Hash",
+          "type": "string"
+        },
+        {
+          "name": "Access Token",
+          "type": "string"
+        }
+      ],
+      "associations": [
+        {
+          "name": "DailyLogs",
+          "type": "has_many",
+          "model": "DailyLog"
+        }
+      ],
+      "authenticatable": "True"
+    }
+  ]
+}

data/examples/schemas/locations.json

@@ -0,0 +1,85 @@
+{
+  "tables": [
+    {
+      "name": "DailyLogs",
+      "fields": [
+        {
+          "name": "Date",
+          "type": "date"
+        },
+        {
+          "name": "Score",
+          "type": "integer"
+        }
+      ],
+      "associations": [
+        {
+          "name": "User",
+          "type": "belongs_to",
+          "model": "User"
+        }
+      ],
+      "ar_class_methods": [
+        {
+          "name": "ar_list_item",
+          "properties": [
+            {
+              "type": "text",
+              "value": "date"
+            },
+            {
+              "type": "detail_text",
+              "value": "score"
+            }
+          ]
+        }
+      ],
+      "ar_instance_methods": [
+        {
+          "name": "ar_stack_item",
+          "properties": [
+            {
+              "type": "text",
+              "label": "Date",
+              "value": "date"
+            },
+            {
+              "type": "button",
+              "label": "Score",
+              "value": "score",
+              "modalWorkflow": "",
+              "style": "primary",
+              "onSuccess": "forward",
+              "sfSymbolName": ""
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "name": "Users",
+      "fields": [
+        {
+          "name": "Email",
+          "type": "string"
+        },
+        {
+          "name": "Password Hash",
+          "type": "string"
+        },
+        {
+          "name": "Access Token",
+          "type": "string"
+        }
+      ],
+      "associations": [
+        {
+          "name": "DailyLogs",
+          "type": "has_many",
+          "model": "DailyLog"
+        }
+      ],
+      "authenticatable": "True"
+    }
+  ]
+}

data/examples/schemas/users.json

@@ -0,0 +1,51 @@
+{
+  "tables": [
+    {
+      "name": "Users",
+      "fields": [
+        {
+          "name": "Forename",
+          "type": "string"
+        },
+        {
+          "name": "Surname",
+          "type": "string"
+        },
+        {
+          "name": "NHS Number",
+          "type": "integer"
+        },
+        {
+          "name": "Date of Birth",
+          "type": "date"
+        },
+        {
+          "name": "Vaccine",
+          "type": "string"
+        }
+      ],
+      "associations": [
+        {
+          "name": "Vaccination Appointments",
+          "type": "has_many",
+          "model": "VaccinationAppointment"
+        }
+      ],
+      "ar_class_methods": [
+        {
+          "name": "ar_list_item",
+          "properties": [
+            {
+              "type": "text",
+              "value": "forename"
+            },
+            {
+              "type": "detail_text",
+              "value": "surname"
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}