app_rail-airtable 0.1.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9ec1d3dd50d2b81b46a1f6804319b97424192accf1e825830ade564c4901aa5
-  data.tar.gz: '0220939ea9dfd1ca57806f60328ca0bd4ea09417fdc2aeb1b61e70687024aeef'
+  metadata.gz: c2f18121969b1289392808cbd8d44b13c24fdadee380024e1f84815f9c439197
+  data.tar.gz: 7d81150a6b3a7c23f147a536488d24461e074ae13b51558164ce1006ab9e7e79
 SHA512:
-  metadata.gz: d13146f0116ea27771ac901dcc514938fa5e3b23e1b1342f6123a76a7e39bdb3b1dd1c7a2ce1bd477cc2a579a7c313ed44e521652f99ca9e8dcb78dba6b7a364
-  data.tar.gz: e6cfc76d2a99c122d3643dd587bdef60a5e7131f04c4f7d0de0ed60ed76c2c130f6ded6d74123864fa6cb45c15cb904e0c7fcd2e4500720ce2479f4de6ae3132
+  metadata.gz: 7177fc23a347032cc2b03041e6d74238789b937e9e73fea3fee66584c78ddf6928ece275780be6882af03fc624f665797049eb70266412589cb52d3ec810d4d5
+  data.tar.gz: d137d55da455f248203ed5b6996d23b54f2f7cb1301a8e07f8506c37bed397d44456076e61819faaa370d2412cff06e90aa47a824fbe990c1f60495709bc22a7

data/.byebug_history

@@ -0,0 +1,14 @@
+exit
+@table_definitions.first.all.first.fields.keys
+@table_definitions.first.all.first.fields
+@table_definitions.first.all.first
+@table_definitions.first.first
+@table_definitions.first.instance_variable_get("@fields")
+@table_definitions.first.instance_variable_get("fields")
+@table_definitions.first.instance_variable_get("@fields")
+@table_definitions.first.fields
+@table_definitions.first.table_name
+@table_definitions.first.name
+@table_definitions.first.all
+@table_definitions.first
+@table_definitions

data/Gemfile

@@ -5,3 +5,5 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
+gem "thor"
+gem "byebug"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    app_rail-airtable (0.1.0)
+    app_rail-airtable (0.2.3)
       activesupport
       airrecord
       sinatra
@@ -18,10 +18,11 @@ GEM
     airrecord (1.0.7)
       faraday (>= 0.10, < 2.0)
       net-http-persistent
+    byebug (11.1.3)
     concurrent-ruby (1.1.9)
     connection_pool (2.2.5)
     diff-lcs (1.4.4)
-    faraday (1.7.2)
+    faraday (1.8.0)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -73,6 +74,7 @@ GEM
       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)
@@ -83,9 +85,11 @@ PLATFORMS
 
 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,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/bin/ara_generator

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

data/lib/app_rail/airtable/application_record.rb

@@ -1,18 +1,35 @@
 require 'airrecord'
+require 'active_support/core_ext/string/inflections'
 
 module AppRail
   module Airtable
     class ApplicationRecord < Airrecord::Table
+      include ActiveSupport::Inflector
     
-      def self.ar_list_item(text:, detail_text:, image: nil, sf_symbol: nil, material_icon: nil)
+      def self.base_key
+        ENV.fetch("AIRTABLE_BASE_ID")
+      end
+      
+      def self.table_name
+        self.name.pluralize
+      end
+    
+      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: nil, 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 +49,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/generator.rb

@@ -0,0 +1,28 @@
+require 'active_support/core_ext/string/inflections'
+require 'thor'
+require 'airrecord'
+require 'app_rail/airtable/string_ext'
+
+class AppRail::Airtable::Generator < Thor::Group
+  include Thor::Actions
+
+  argument :output_directory
+  argument :api_key
+  argument :base_id
+  argument :tables
+
+  def self.source_root
+    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) }
+    directory('templates/project', output_directory)
+  end
+  
+  def self.exit_on_failure?
+    true
+  end
+
+end

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

@@ -0,0 +1,5 @@
+class String
+  def snake_case
+    gsub(" ", "_").underscore
+  end
+end

data/lib/app_rail/airtable/version.rb

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

data/lib/app_rail/airtable.rb

@@ -1,6 +1,8 @@
 require "app_rail/airtable/version"
 require "app_rail/airtable/application_record"
 require "app_rail/airtable/sinatra"
+require "app_rail/airtable/generator"
+require "app_rail/airtable/string_ext"
 
 module AppRail
   module Airtable

data/templates/project/.env.tt

@@ -0,0 +1,2 @@
+AIRTABLE_API_KEY=<%= api_key %>
+AIRTABLE_BASE_ID=<%= base_id %>

data/templates/project/.gitignore

@@ -0,0 +1,8 @@
+.DS_STORE
+*.swp
+*.rbc
+*.sass-cache
+/pkg
+/coverage
+.yardoc
+/doc

data/templates/project/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby '2.7.4'
+
+gem 'app_rail-airtable'
+
+# dev
+gem 'dotenv'
+
+# test
+gem "rspec"
+gem "rack-test"

data/templates/project/Gemfile.lock

@@ -0,0 +1,90 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.4.1)
+      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)
+      net-http-persistent
+    app_rail-airtable (0.2.2)
+      activesupport
+      airrecord
+      sinatra
+    concurrent-ruby (1.1.9)
+    connection_pool (2.2.5)
+    diff-lcs (1.4.4)
+    dotenv (2.7.6)
+    faraday (1.8.0)
+      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)
+      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)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    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
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    ruby2_keywords (0.0.5)
+    sinatra (2.1.0)
+      mustermann (~> 1.0)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
+      tilt (~> 2.0)
+    tilt (2.0.10)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  app_rail-airtable
+  dotenv
+  rack-test
+  rspec
+
+RUBY VERSION
+   ruby 2.7.4p191
+
+BUNDLED WITH
+   2.1.4

data/templates/project/app.json

@@ -0,0 +1,17 @@
+{
+  "name": "App Rail Airtable Service",
+  "description": "A barebones template to convert Airtable data to App Rail format",
+  "buildpacks": [
+    {
+      "url": "heroku/ruby"
+    }
+  ],
+  "env": {
+    "AIRTABLE_API_KEY": {
+      "description": "Your Airtable API key."
+    },
+    "AIRTABLE_BASE_ID": {
+      "description": "The ID of the Base you'd like to connect to."
+    }
+  }
+}

data/templates/project/config.ru

@@ -0,0 +1,5 @@
+$stdout.sync = true
+
+require 'dotenv/load'
+require './lib/server'
+run Server

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

@@ -0,0 +1,15 @@
+require 'app_rail/airtable'
+
+<% @table_definitions.each do |td| -%>
+<% keys = td.all.first.fields.keys -%>
+class <%= td.table_name.singularize %> < AppRail::Airtable::ApplicationRecord  
+  airtable_attr <%= keys.map{|f| "\"#{f}\""}.join(", ") %>
+  ar_list_item text: :<%= keys.first.snake_case %>
+end
+
+<% end -%>
+class Server < AppRail::Airtable::Sinatra
+<% @table_definitions.each do |td| -%>
+  resources :<%= td.table_name.snake_case %>
+<% end -%>
+end

data/templates/project/spec/server_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+RSpec.describe Server do
+  
+  def app
+    Server
+  end
+
+end

data/templates/project/spec/spec_helper.rb

@@ -0,0 +1,115 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+# Dummy ENV Setup
+ENV['AIRTABLE_API_KEY'] = 'keyABC123'
+ENV['AIRTABLE_BASE_ID'] = 'appABC123'
+ENV['RACK_ENV'] = 'test'
+
+require "rack/test"
+require "app_rail/airtable"
+
+require './lib/server'
+require './lib/item_recommender'
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+
+  config.include Rack::Test::Methods
+
+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.3
 platform: ruby
 authors:
 - Matt Brooke-Smith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-15 00:00:00.000000000 Z
+date: 2021-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -88,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".DS_Store"
+- ".byebug_history"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -97,12 +98,24 @@ files:
 - README.md
 - Rakefile
 - app_rail-airtable.gemspec
+- bin/ara_generator
 - bin/console
 - bin/setup
 - lib/app_rail/airtable.rb
 - lib/app_rail/airtable/application_record.rb
+- lib/app_rail/airtable/generator.rb
 - lib/app_rail/airtable/sinatra.rb
+- lib/app_rail/airtable/string_ext.rb
 - lib/app_rail/airtable/version.rb
+- templates/project/.env.tt
+- templates/project/.gitignore
+- templates/project/Gemfile
+- templates/project/Gemfile.lock
+- templates/project/app.json
+- templates/project/config.ru
+- templates/project/lib/server.rb.tt
+- templates/project/spec/server_spec.rb
+- templates/project/spec/spec_helper.rb
 homepage: https://github.com/FutureWorkshops/app_rail-airtable
 licenses:
 - MIT