app_rail-airtable 0.3.6 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd8e78c130ea41fda991115396a84bd30971d1ca60f366988c84090bf1212e6d
-  data.tar.gz: cec97d555c6459fa03306e6572fb2528609fd26aea9bb10554d0a199a32df42c
+  metadata.gz: 635c1b4e200ee31f032f974ca3da84df53b766825c10ac3d4c867ac5b1533c2b
+  data.tar.gz: 5949f7165d856d5bfab33fb42cf157b859346651c5b927aa548b098841a5f5a5
 SHA512:
-  metadata.gz: '0391681d670ed7beb995a2061b9587ba069f84f2e5581187d9b03727619df97ed8b8a774094336ee4553d24ef1dd42dffd09818eeb89e26d65a3234281c7d142'
-  data.tar.gz: 32a4b9189c31b95c378c3637d43729d592308830e137c161e843f326f5b05541c82ef3dcec29c3225d047c582f697e9ec784553fa7c412ca0c6951303e1fc6bc
+  metadata.gz: 352a2c5566fa8b24966d8ce524a6d9b8fc0ebc91b3559b79d0bff16fd9c5436a9bbe6a0893084f15c4fbdd071382da25b455e7b915a271a5a45fcf8c11f9f5c6
+  data.tar.gz: 2febff28b74cf2b538b6d8767fc308946d48f7e75bff35991d8e30e4ac29a6794e21d75d37e213ef51a3d9dcf791a078c4890ec62fd931904d7199f74fd54d69

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# 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,9 +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 "thor"
-gem "byebug"
+gem 'byebug'
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'thor'

data/Gemfile.lock

@@ -1,62 +1,48 @@
 PATH
   remote: .
   specs:
-    app_rail-airtable (0.3.6)
+    app_rail-airtable (0.4.1)
       activesupport
       airrecord
       bcrypt
+      faraday (~> 2.2)
+      faraday-net_http_persistent (~> 2.0)
       sinatra
       thor
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.2.2)
+    activesupport (7.0.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    airrecord (1.0.7)
-      faraday (>= 0.10, < 2.0)
+    airrecord (1.0.9)
+      faraday (>= 0.10, < 3.0)
+      faraday-net_http_persistent
       net-http-persistent
-    bcrypt (3.1.16)
+    bcrypt (3.1.17)
     byebug (11.1.3)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     connection_pool (2.2.5)
     diff-lcs (1.4.4)
-    faraday (1.9.3)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0)
-      faraday-multipart (~> 1.0)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.0)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      faraday-retry (~> 1.0)
+    faraday (2.2.0)
+      faraday-net_http (~> 2.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)
-    faraday-retry (1.0.3)
-    i18n (1.9.1)
+    faraday-net_http (2.0.2)
+    faraday-net_http_persistent (2.0.1)
+      faraday-net_http
+      net-http-persistent (~> 4.0)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     minitest (5.15.0)
-    multipart-post (2.1.1)
     mustermann (1.1.1)
       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.0)
       rack
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -75,10 +61,10 @@ GEM
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
     ruby2_keywords (0.0.5)
-    sinatra (2.1.0)
+    sinatra (2.2.0)
       mustermann (~> 1.0)
       rack (~> 2.2)
-      rack-protection (= 2.1.0)
+      rack-protection (= 2.2.0)
       tilt (~> 2.0)
     thor (1.1.0)
     tilt (2.0.10)

data/README.md

@@ -2,10 +2,6 @@
 
 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.
 
-## Quick Start
-
-Visit [App Rail Airtable Template](https://github.com/FutureWorkshops/AppRailAirtableTemplate) and follow instructions.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -16,7 +12,7 @@ gem 'app_rail-airtable'
 
 ## Usage
 
-App Rail Airtable has two important concepts, models and servers. The [App Rail Petshop](https://github.com/FutureWorkshops/ar-petshop-airtable) provides useful examples.
+App Rail Airtable has two important concepts, models and servers.
 
 ### Models
 App Rail Airtable makes the following assumptions
@@ -32,6 +28,7 @@ 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.
     
@@ -45,10 +42,47 @@ Creates routes that map to a table. It delegates from the route to a model metho
 * `index` to `ar_list_item`
 * `show` to `ar_stack`
 * `create` to `self.create_as_json`
+* `update` to `self.update_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).
 
+### Generator
+
+```bash
+bin/ara_generator <output_directory> <airtable_api_key> <airtable_base_id> [<json_schema>]
+```
+
+#### Example
+
+```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"}]}'
+```
+
+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,35 +1,39 @@
+# 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.bindir = 'bin'
   spec.executables << 'ara_generator'
-  
-  spec.require_paths = ["lib"]
+
+  spec.require_paths = ['lib']
   spec.add_dependency 'activesupport'
-  spec.add_dependency 'sinatra'
   spec.add_dependency 'airrecord'
-  spec.add_dependency 'thor'
   spec.add_dependency 'bcrypt'
-  
-  spec.add_development_dependency 'rspec'
+  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

@@ -1,6 +1,8 @@
 #!/usr/bin/env ruby
-require "bundler/setup"
+# frozen_string_literal: true
+
+require 'bundler/setup'
 require 'app_rail/airtable/generator'
 require 'byebug'
 
-AppRail::Airtable::Generator.start(ARGV)
+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"
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

data/lib/app_rail/airtable/application_record.rb

@@ -1,64 +1,67 @@
+# frozen_string_literal: true
+
 require 'airrecord'
+require 'app_rail-steps'
 require 'active_support/core_ext/string/inflections'
 
 module AppRail
   module Airtable
     class ApplicationRecord < Airrecord::Table
       include ActiveSupport::Inflector
-    
+      include AppRail::Steps::Displayable
+
       def self.base_key
-        ENV.fetch("AIRTABLE_BASE_ID")
+        ENV.fetch('AIRTABLE_BASE_ID')
       end
-      
+
       def self.table_name
-        self.name.pluralize
+        name.pluralize
       end
-    
+
       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
-    
+
       # Step utilities
       def self.ar_list_item(text:, detail_text: nil, image: nil, sf_symbol: nil, material_icon: nil)
         define_method(:ar_list_item_as_json) do
           {
-            id: self.id, 
-            text: method_value(text).to_s, 
-            detailText: method_value(detail_text).to_s, 
-            imageURL: method_value(image), 
-            sfSymbolName: method_value(sf_symbol), 
+            id: id,
+            text: method_value(text).to_s,
+            detailText: method_value(detail_text).to_s,
+            imageURL: method_value(image),
+            sfSymbolName: method_value(sf_symbol),
             materialIconName: method_value(material_icon)
           }.compact
         end
       end
-      
+
       def self.ar_stack(text_items:)
         define_method(:ar_stack_as_json) do
-          text_items.map{|ti| {type: :text, label: ti, text: self[ti].to_s} }
+          text_items.map { |ti| { type: :text, label: ti, text: self[ti].to_s } }
         end
       end
-      
+
       # Customisable behaviour
-      
+
       # Override to provide custom sorting or filtering for index
       def self.index(user:)
         all
       end
-      
+
       private
-      
+
       def method_value(name)
         send(name) if name.present?
       end
-      
+
       # size is either :small, :large or :full
       def image(name, index: 0, size: :full)
-        self[name][index]["thumbnails"][size.to_s]["url"] if self[name] && self[name].length > index
+        self[name][index]['thumbnails'][size.to_s]['url'] if self[name] && self[name].length > index
       end
-      
     end
   end
-end
+end