app_rail-airtable 0.3.7 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8efd41eb515627b2880f01a8c995cf40e32ce614a4c7f0ae89305c824f25419e
-  data.tar.gz: e1636ef443d7071ffd9132d0af76c4eeddff51bd3c6e2554a631e17ebaa8429d
+  metadata.gz: 5154709a34596c961227e058380aa927b7643df717e67289a6158b43f65b2213
+  data.tar.gz: 39b53b565d80d517aedc654f04b21f7d64189c4b0b62bd30ec1ea53252e9c1bb
 SHA512:
-  metadata.gz: 70f1a2b229234f404c9ead70cb0af42726d79c0e68d283e8a2b817f9f3921f9bde747de9afcc4b5bf2c13916e95ce18e7029e94fc6d306e1fc3b57805c5cd9f5
-  data.tar.gz: 25eb20b69b8942ca1f14f6341b7dbc0356f3c9e2a5856a4f09aa9487efb6dcb1881f55e6612c7e13dc7bb1dad47aef07989802b8bbdcb62331238f9be7475cc3
+  metadata.gz: 68bfcd69273296c2eca597bf4bceb3bfefdd41f153d94a020f96e2604e8dcf7426359ea74e4ddcab6197a7ecf3f319dbefe204af1f9471b31cd83d921afaa87c
+  data.tar.gz: 23ce7443a261f2eb431c42f2904d1b7d31a98c843adb3e601c6d2cc6610a02d15597e4b65bef49dffb4d599df17a07b97bb0550d66b5f4eb122c66141b94a6ab

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.lock

@@ -1,10 +1,12 @@
 PATH
   remote: .
   specs:
-    app_rail-airtable (0.3.7)
+    app_rail-airtable (0.4.0)
       activesupport
       airrecord
       bcrypt
+      faraday (~> 2.2)
+      faraday-net_http_persistent (~> 2.0)
       sinatra
       thor
 
@@ -16,47 +18,30 @@ GEM
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    airrecord (1.0.7)
-      faraday (>= 0.10, < 2.0)
+    airrecord (1.0.8)
+      faraday (>= 0.10, < 3.0)
       net-http-persistent
     bcrypt (3.1.16)
     byebug (11.1.3)
     concurrent-ruby (1.1.9)
     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.1)
+    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 +60,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/app_rail-airtable.gemspec

@@ -27,6 +27,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport'
   spec.add_dependency 'sinatra'
   spec.add_dependency 'airrecord'
+  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 'thor'
   spec.add_dependency 'bcrypt'
   

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

@@ -8,11 +8,12 @@ module AppRail
   
       def self.included(klass)
         klass.extend(ClassMethods)
+        klass.prepend(InstanceMethods) # prepends `initialize` instance method in order to take precedence over Airrecord::Table#initialize
       end
       
       module ClassMethods
         def create(email:, password:)
-          user = User.new("Email" => email, "Password Hash" => password_hash(password), "Access Token" => next_access_token)
+          user = new("Email" => email, "Password Hash" => password_hash(password), "Access Token" => next_access_token)
           user.create
           user
         end
@@ -43,7 +44,17 @@ module AppRail
           SecureRandom.hex
         end    
       end
-      
+
+      module InstanceMethods
+        def initialize(*args)
+          if (kwargs = args.first) && kwargs.is_a?(Hash) && kwargs.size == 2 && kwargs.key?(:email) && kwargs.key?(:password)
+            super("Email" => kwargs[:email], "Password Hash" => self.class.password_hash(kwargs[:password]), "Access Token" => self.class.next_access_token)
+          else
+            super
+          end
+        end
+      end
+
       def valid_password?(password)
         BCrypt::Password.new(password_hash) == password
       end

data/lib/app_rail/airtable/generator.rb

@@ -55,6 +55,21 @@ module AppRail
           raise "ERROR! The key \"#{key}\" is not present in the schema definition."
         end
       end
+
+      def fields_as_params_examples(fields)
+        fields.each_with_object({}) do |field, hsh|
+          hsh[field['name']] = case field['type']
+                               when 'date'
+                                 '01/01/2022'
+                               when 'string', 'text'
+                                 'MyString'
+                               when 'integer'
+                                 10
+                               else
+                                 'MyString'
+                               end
+        end
+      end
     end
   end
 end

data/lib/app_rail/airtable/sinatra.rb

@@ -37,7 +37,7 @@ module AppRail
         end
       end
       
-      def self.authenticatable_resources(name, only: [:index, :show, :create])
+      def self.authenticatable_resources(name, only: [:index, :show, :create, :update])
         
         # If authentication is used then include the correct helpers
         # Allowing the routes to use `authenticate!` and `current_user`
@@ -51,12 +51,13 @@ module AppRail
         @@authenticated_route = false
       end
 
-      def self.resources(name, only: [:index, :show, :create])
+      def self.resources(name, only: [:index, :show, :create, :update])
         only = [only] if only.is_a?(Symbol)
-        
+
         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)
+        update_route(name, authenticated_route?) if only.include?(:update)
       end
       
       def self.index_route(name, authenticated_route)
@@ -80,7 +81,16 @@ module AppRail
           [201, as_json.to_json] 
         end
       end
-      
+
+      def self.update_route(name, authenticated_route)
+        put "/#{name.to_s}/:id" do
+          authenticate! if authenticated_route
+          record = name.classify_constantize.find(params['id'])
+          as_json = record.update_as_json(current_user: authenticated_route ? current_user : nil, params: params_and_body_as_json)
+          [200, as_json.to_json]
+        end
+      end
+
       def self.authenticated_route?
         @@authenticated_route
       end

data/lib/app_rail/airtable/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module AppRail
   module Airtable
-    VERSION = "0.3.7"
+    VERSION = '0.4.0'
   end
 end

data/templates/project/Gemfile

@@ -5,7 +5,7 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 ruby '2.7.4'
 
-gem 'app_rail-airtable', '~> 0.3.3'
+gem 'app_rail-airtable', '~> 0.4.0'
 
 group :development do
   gem 'dotenv'

data/templates/project/Gemfile.lock

@@ -10,7 +10,7 @@ GEM
     airrecord (1.0.7)
       faraday (>= 0.10, < 2.0)
       net-http-persistent
-    app_rail-airtable (0.3.3)
+    app_rail-airtable (0.4.0)
       activesupport
       airrecord
       bcrypt
@@ -83,7 +83,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  app_rail-airtable (~> 0.3.3)
+  app_rail-airtable (~> 0.4.0)
   byebug
   dotenv
   rack-test

data/templates/project/lib/server.rb.tt

@@ -25,6 +25,12 @@ class <%= table['name'].singularize %> < AppRail::Airtable::ApplicationRecord
     record = <%= table['name'].singularize %>.create(email: params["payload"]["email"], password: params["payload"]["password"])
     { response: { id: record.id }, oauth_session: record.oauth_session}
   end
+
+  def update_as_json(params:, current_user:)
+    params['payload'].each { |attr, v| public_send("#{attr}=", v) }
+    save
+    { response: { id: id }, oauth_session: oauth_session }
+  end
 <% end -%>
 end
 

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

@@ -69,6 +69,24 @@ RSpec.describe Server do
     it { expect(json_response).to eq [resource_to_json] }
   end
 
+  describe 'PUT /<%= path_name %>/:id"' do
+    let(:params) { <%= fields_as_params_examples(table['fields']) %> }
+    let(:response) { put "/<%= path_name %>/#{id}", params.to_json, headers }
+    let(:mock_auth_resource) { instance_double(<%= auth_model_name %>) }
+    let(:mock_resource) { instance_double(<%= model_name %>, id: id) }
+    let(:resource_to_json) { { id: id } }
+    let(:headers) { auth_headers.merge('CONTENT_TYPE' => 'application/json') }
+    let(: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(:find).with(id) { mock_resource }
+      allow(mock_resource).to receive(:update_as_json).with(current_user: mock_auth_resource, params: { 'id' => '1' }.merge(params)) { 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| -%>
@@ -89,6 +107,22 @@ RSpec.describe Server do
     it { expect(json_response).to eq [resource_to_json] }
   end
 
+  describe 'PUT /<%= path_name %>/:id"' do
+    let(:params) { <%= fields_as_params_examples(table['fields']) %> }
+    let(:response) { put "/<%= path_name %>/#{id}", params.to_json, headers }
+    let(:mock_resource) { instance_double(<%= model_name %>, id: id) }
+    let(:resource_to_json) { { id: id } }
+    let(:headers) { auth_headers.merge('CONTENT_TYPE' => 'application/json') }
+    let(:id) { '1' }
+
+    before do
+      allow(<%= model_name %>).to receive(:find).with(id) { mock_resource }
+      allow(mock_resource).to receive(:update_as_json).with(current_user: mock_auth_resource, params: { 'id' => '1' }.merge(params)) { 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

@@ -21,6 +21,7 @@ ENV['RACK_ENV'] = 'test'
 
 require "rack/test"
 require "app_rail/airtable"
+require "byebug"
 
 require './lib/server'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: app_rail-airtable
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.4.0
 platform: ruby
 authors:
 - Matt Brooke-Smith
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-14 00:00:00.000000000 Z
+date: 2022-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: faraday-net_http_persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +136,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - matt@futureworkshops.com
 executables:
@@ -120,6 +148,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -129,6 +158,9 @@ files:
 - bin/ara_generator
 - bin/console
 - bin/setup
+- examples/schemas/daily_logs.json
+- examples/schemas/locations.json
+- examples/schemas/users.json
 - lib/app_rail/airtable.rb
 - lib/app_rail/airtable/application_record.rb
 - lib/app_rail/airtable/authenticatable.rb
@@ -152,7 +184,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/FutureWorkshops/app_rail-airtable
   source_code_uri: https://github.com/FutureWorkshops/app_rail-airtable
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -167,8 +199,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.3.6
+signing_key: 
 specification_version: 4
 summary: Gem to help building App Rail servers using Airtable as a backend
 test_files: []