app_rail-airtable 0.3.7 → 0.4.2

data/lib/app_rail/airtable/authenticatable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bcrypt'
 require 'securerandom'
 
@@ -5,56 +7,67 @@ module AppRail
   module Airtable
     module Authenticatable
       include BCrypt
-  
+
       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
-        
+
         def create_session_as_json(email:, password:)
           user = find_by_email_and_password(email, password)
           return nil unless user
-          
-          user["Access Token"] = next_access_token
+
+          user['Access Token'] = next_access_token
           user.save
           user&.oauth_session
         end
-  
+
         def find_by_email_and_password(email, password)
           user = all(filter: "{Email} = \"#{email}\"").first
           user&.valid_password?(password) ? user : nil
         end
 
         def find_by_access_token(access_token)
-          all(filter: "{Access Token} = \"#{access_token}\"").first 
+          all(filter: "{Access Token} = \"#{access_token}\"").first
         end
-        
+
         def password_hash(password)
           BCrypt::Password.create(password)
-        end   
-        
+        end
+
         def next_access_token
           SecureRandom.hex
-        end    
+        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
-      
+
       def password_hash
-        self["Password Hash"]
+        self['Password Hash']
       end
-    
+
       def oauth_session
-        { access_token: self["Access Token"], scope: :user, refresh_token: "", token_type: :bearer, expires_in: 60000 }
+        { access_token: self['Access Token'], scope: :user, refresh_token: '', token_type: :bearer, expires_in: 60_000 }
       end
     end
   end
-end
+end

data/lib/app_rail/airtable/authentication_helpers.rb

@@ -1,27 +1,30 @@
+# frozen_string_literal: true
+
 module AppRail
   module Airtable
     module AuthenticationHelpers
       def current_user
         @current_user ||= find_current_user
       end
-  
+
       def find_current_user
         authorization_header && bearer_token ? find_authenticatable_resource(access_token: bearer_token) : nil
       end
-  
+
       def bearer_token
-        authorization_values = authorization_header.split(" ")
+        authorization_values = authorization_header.split(' ')
         return nil unless authorization_values.count > 1
+
         authorization_values[1]
       end
-  
+
       def authorization_header
-        request.env["HTTP_AUTHORIZATION"]
+        request.env['HTTP_AUTHORIZATION']
       end
-  
+
       def authenticate!
         halt 401 unless current_user
       end
     end
   end
-end
+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

@@ -1,89 +1,101 @@
+# frozen_string_literal: true
+
 require 'sinatra'
 require 'json'
 require 'active_support'
 
 # TODO: MBS - move to configure block or other
-Airrecord.api_key = ENV.fetch("AIRTABLE_API_KEY")
+Airrecord.api_key = ENV.fetch('AIRTABLE_API_KEY')
 
 class Symbol
-  
   def pluralize
     ActiveSupport::Inflector.pluralize(self)
   end
-  
+
   def classify
-    ActiveSupport::Inflector.classify(self)  
+    ActiveSupport::Inflector.classify(self)
   end
-  
+
   def classify_constantize
     ActiveSupport::Inflector.constantize(classify)
   end
-  
 end
 
 module AppRail
   module Airtable
     class Sinatra < Sinatra::Base
       @@authenticated_route = false
-      
+
       helpers do
         def request_body_as_json
           request.body.rewind
           JSON.parse(request.body.read)
         end
-        
+
         def params_and_body_as_json
           request_body_as_json.merge(params)
         end
       end
-      
-      def self.authenticatable_resources(name, only: [:index, :show, :create])
-        
+
+      def self.authenticatable_resources(name, only: %i[index show create update])
         # If authentication is used then include the correct helpers
         # Allowing the routes to use `authenticate!` and `current_user`
         helpers AppRail::Airtable::AuthenticationHelpers
-        
+
         resources(name, only: only)
-        
+
         return unless block_given?
+
         @@authenticated_route = true
         yield
         @@authenticated_route = false
       end
 
-      def self.resources(name, only: [:index, :show, :create])
+      def self.resources(name, only: %i[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)
-        get "/#{name.to_s}" do
+        get "/#{name}" do
           authenticate! if authenticated_route
           name.classify_constantize.index(user: authenticated_route ? current_user : nil).map(&:ar_list_item_as_json).to_json
         end
       end
-      
+
       def self.show_route(name, authenticated_route)
-        get "/#{name.to_s}/:id" do
+        get "/#{name}/:id" do
           authenticate! if authenticated_route
           name.classify_constantize.find(params['id']).ar_stack_as_json.to_json
         end
       end
-      
+
       def self.create_route(name, authenticated_route)
-        post "/#{name.to_s}" do
+        post "/#{name}" do
           authenticate! if authenticated_route
-          as_json = name.classify_constantize.create_as_json(current_user: authenticated_route ? current_user : nil, params: params_and_body_as_json)
-          [201, as_json.to_json] 
+          as_json = name.classify_constantize.create_as_json(current_user: authenticated_route ? current_user : nil,
+                                                             params: params_and_body_as_json)
+          [201, as_json.to_json]
         end
       end
-      
+
+      def self.update_route(name, authenticated_route)
+        put "/#{name}/: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
     end
   end
-end
+end

data/lib/app_rail/airtable/string_ext.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 class String
   def snake_case
-    gsub(" ", "_").underscore
+    gsub(' ', '_').underscore
   end
-end
+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.2'
   end
 end

data/lib/app_rail/airtable.rb

@@ -1,10 +1,12 @@
-require "app_rail/airtable/version"
-require "app_rail/airtable/string_ext"
-require "app_rail/airtable/application_record"
-require "app_rail/airtable/authenticatable"
-require "app_rail/airtable/authentication_helpers"
-require "app_rail/airtable/sinatra"
-require "app_rail/airtable/generator"
+# frozen_string_literal: true
+
+require 'app_rail/airtable/version'
+require 'app_rail/airtable/string_ext'
+require 'app_rail/airtable/application_record'
+require 'app_rail/airtable/authenticatable'
+require 'app_rail/airtable/authentication_helpers'
+require 'app_rail/airtable/sinatra'
+require 'app_rail/airtable/generator'
 
 module AppRail
   module Airtable

data/templates/project/Gemfile

@@ -5,7 +5,8 @@ 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'
+gem 'app_rail-steps'
 
 group :development do
   gem 'dotenv'

data/templates/project/config.ru

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $stdout.sync = true
 
 ENV['RACK_ENV'] ||= 'development'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # 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
@@ -19,8 +21,9 @@ ENV['AIRTABLE_API_KEY'] = 'keyABC123'
 ENV['AIRTABLE_BASE_ID'] = 'appABC123'
 ENV['RACK_ENV'] = 'test'
 
-require "rack/test"
-require "app_rail/airtable"
+require 'rack/test'
+require 'app_rail/airtable'
+require 'byebug'
 
 require './lib/server'
 
@@ -55,60 +58,57 @@ RSpec.configure do |config|
   # 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
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # 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
 
   config.include Rack::Test::Methods
-
 end