app_rail-airtable 0.1.0 → 0.5.0

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

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+<% authenticatable_table = @tables.select { |table| table['authenticatable'] == 'True' }&.first -%>
+<% authenticatable_resource = authenticatable_table['name'] if authenticatable_table -%>
+require 'spec_helper'
+
+RSpec.describe Server do
+  let(:json_response) { JSON.parse(response.body, symbolize_names: true) }
+  let(:access_token) { SecureRandom.hex }
+  let(:auth_headers) { { 'HTTP_AUTHORIZATION' => "Bearer: #{access_token}" } }
+
+  def app
+    Server
+  end
+
+<% if authenticatable_resource -%>
+<% auth_model_name = authenticatable_resource.singularize -%>
+<% auth_path_name = authenticatable_resource.snake_case.pluralize -%>
+  describe 'POST /<%= auth_path_name %>' do
+    let(:params) { { payload: { email: 'test@test.com', password: 'Secret000' } } }
+    let(:response) { post "/<%= auth_path_name %>", params.to_json }
+    let(:mock_resource) { double(<%= auth_model_name %>) }
+
+    before { allow_any_instance_of(<%= auth_model_name %>).to receive(:create) { mock_resource } } 
+
+    it { expect(response.status).to eq 201 }
+    it { expect(json_response[:oauth_session][:access_token]).to_not be_nil }
+  end
+
+  describe 'POST /sessions' do
+    let(:params) { { username: 'test@test.com', password: 'Secret000' } }
+    let(:response) { post "/sessions", params }
+
+    context 'ok' do
+      let(:oauth_session) { { access_token: SecureRandom.hex } }
+
+      before { allow(<%= auth_model_name %>).to receive(:create_session_as_json).with({ email: params[:username], password: params[:password] }) { oauth_session } }
+
+      it { expect(response.status).to eq 200 }
+      it { expect(json_response[:access_token]).to_not be_nil }
+    end
+
+    context 'invalid' do
+      before { allow(<%= auth_model_name %>).to receive(:create_session_as_json).with({ email: params[:username], password: params[:password] }) { nil } }
+
+      it { expect(response.status).to eq 401 }
+      it { expect(response.body).to eq '' }
+    end
+  end
+
+<% @tables.each do |table| -%>
+<% next if table['name'] == authenticatable_resource -%>
+<% model_name = table['name'].singularize -%>
+<% path_name = table['name'].snake_case.pluralize -%>
+  describe 'GET /<%= path_name %>' do
+    let(:params) { {} }
+    let(:response) { get '/<%= path_name %>', params.to_json, auth_headers}
+    let(:mock_auth_resource) { double(<%= auth_model_name %>) }
+    let(:mock_resource) { double(<%= model_name %>, id: '1') }
+    let(:resource_to_json) { { 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(:all) { [mock_resource] }
+      allow(mock_resource).to receive(:ar_list_item_as_json) { resource_to_json }
+    end
+
+    it { expect(response.status).to eq 200 }
+    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| -%>
+<% model_name = table['name'].singularize -%>
+<% path_name = table['name'].snake_case.pluralize -%>
+  describe 'GET /<%= path_name %>' do
+    let(:params) { {} }
+    let(:response) { get '/<%= path_name %>', params.to_json, auth_headers}
+    let(:mock_resource) { double(<%= model_name %>, id: '1') }
+    let(:resource_to_json) { { id: '1' } }
+
+    before do
+      allow(<%= model_name %>).to receive(:all) { [mock_resource] }
+      allow(mock_resource).to receive(:ar_list_item_as_json) { resource_to_json }
+    end
+
+    it { expect(response.status).to eq 200 }
+    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

@@ -0,0 +1,114 @@
+# 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
+# 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 'byebug'
+
+require './lib/server'
+
+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.
+  #   # 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: app_rail-airtable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Matt Brooke-Smith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-15 00:00:00.000000000 Z
+date: 2022-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,76 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: airrecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: app_rail-steps
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: airrecord
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -83,7 +153,8 @@ dependencies:
 description:
 email:
 - matt@futureworkshops.com
-executables: []
+executables:
+- ara_generator
 extensions: []
 extra_rdoc_files: []
 files:
@@ -91,18 +162,36 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - app_rail-airtable.gemspec
+- 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
+- lib/app_rail/airtable/authentication_helpers.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/app.json
+- templates/project/boot.rb
+- templates/project/config.ru
+- templates/project/lib/server.rb.tt
+- templates/project/spec/server_spec.rb.tt
+- templates/project/spec/spec_helper.rb
 homepage: https://github.com/FutureWorkshops/app_rail-airtable
 licenses:
 - MIT
@@ -124,7 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Gem to help building App Rail servers using Airtable as a backend