app_rail-airtable 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9ec1d3dd50d2b81b46a1f6804319b97424192accf1e825830ade564c4901aa5
-  data.tar.gz: '0220939ea9dfd1ca57806f60328ca0bd4ea09417fdc2aeb1b61e70687024aeef'
+  metadata.gz: b2aa2acf23c1a19d2da51975f9ffcc4df977bb2161671c17ec353fa927180ddc
+  data.tar.gz: 139e1d42de5b43f560e738b48675e8142b02f02662b67744d5a325c157f0e7be
 SHA512:
-  metadata.gz: d13146f0116ea27771ac901dcc514938fa5e3b23e1b1342f6123a76a7e39bdb3b1dd1c7a2ce1bd477cc2a579a7c313ed44e521652f99ca9e8dcb78dba6b7a364
-  data.tar.gz: e6cfc76d2a99c122d3643dd587bdef60a5e7131f04c4f7d0de0ed60ed76c2c130f6ded6d74123864fa6cb45c15cb904e0c7fcd2e4500720ce2479f4de6ae3132
+  metadata.gz: 2338dcc79c15c783900d9d5054e635f6dda8e6ca78802fb06d2cb3b9bdc2391e1be9839e6dc527a2d2746c64d56e5490256c6c1789240b3f54a81dad7e05d524
+  data.tar.gz: da5ba11679f264dc1c96f2f123ff0aa04d5288d55405be12d539f874b6d96bd53cba4d950b735cb7de5a71322f052e018a86719454f202a44e0c7fe637aa608f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    app_rail-airtable (0.1.0)
+    app_rail-airtable (0.2.0)
       activesupport
       airrecord
       sinatra

data/README.md

@@ -1,8 +1,10 @@
-# 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.
+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.
 
-TODO: Delete this and the text above, and describe your gem
+## Quick Start
+
+Visit [App Rail Airtable Template](https://github.com/FutureWorkshops/AppRailAirtableTemplate) and follow instructions.
 
 ## Installation
 
@@ -12,28 +14,27 @@ Add this line to your application's Gemfile:
 gem 'app_rail-airtable'
 ```
 
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install app_rail-airtable
-
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-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.
-
-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).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/app_rail-airtable.
-
+App Rail Airtable has two important concepts, models and servers. The [App Rail Petshop](https://github.com/FutureWorkshops/ar-petshop-airtable) provides useful examples.
+
+### 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
+
+**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.**
+
+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_from_params (create) 
+    
+### Servers
+You should create a single server which extends `AppRail::Airtable::Sinatra`, then add routes with the `resources` macro to add `index`, `show` and `create` routes. You can also provide your own routes.
 
 ## License
 

data/lib/app_rail/airtable/application_record.rb

@@ -1,18 +1,33 @@
 require 'airrecord'
+require 'active_support/core_ext/string/inflections'
+
+class String
+  def snake_case
+    gsub(" ", "_").underscore
+  end
+end
 
 module AppRail
   module Airtable
     class ApplicationRecord < Airrecord::Table
+      include ActiveSupport::Inflector
+    
+      def self.airtable_attr(*attributes)
+        attributes.each do |attribute|
+          define_method(attribute.to_s.snake_case) { self[attribute] }
+        end
+      end
     
+      # Step utilities
       def self.ar_list_item(text:, detail_text:, image: nil, sf_symbol: nil, material_icon: nil)
         define_method(:ar_list_item_as_json) do
           {
             id: self.id, 
-            text: method_value_or_property(text).to_s, 
-            detailText: method_value_or_property(detail_text).to_s, 
-            imageURL: method_value_or_property(image), 
-            sfSymbolName: sf_symbol, 
-            materialIconName: material_icon
+            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
@@ -32,11 +47,8 @@ module AppRail
       
       private
       
-      # TODO: Method call not working?
-      def method_value_or_property(name)
-        return nil unless name
-        
-        respond_to?(name) ? send(name) : self[name]
+      def method_value(name)
+        send(name) if name.present?
       end
       
       # size is either :small, :large or :full

data/lib/app_rail/airtable/sinatra.rb

@@ -24,7 +24,7 @@ module AppRail
   module Airtable
     class Sinatra < Sinatra::Base
 
-      def self.resource(name)
+      def self.resources(name)
         get "/#{name.to_s}" do
           name.classify_constantize.index.map(&:ar_list_item_as_json).to_json
         end

data/lib/app_rail/airtable/version.rb

@@ -1,5 +1,5 @@
 module AppRail
   module Airtable
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: app_rail-airtable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Matt Brooke-Smith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-15 00:00:00.000000000 Z
+date: 2021-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport