airtable_base_builder 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 239324ebba69f84f6210c2b191908ce8201efdc532e345019706da461283a961
+  data.tar.gz: 8414cdd71d0126a85b886e544e8b3483db99d1a524439f1893fc3f7a495e8249
+SHA512:
+  metadata.gz: f026377a5c05b3ed53499e2e18190448e798083dcf06bf4512b9b8608be41ec007a2db8287a93c1310f5097280c1275c94b17d5cd0ec22b5eed22d65b3db977e
+  data.tar.gz: 7f369be2db51bcd5e853edb58c5c0811e65bf93c7dd39a03b4dd7060e5a30cf2e2caba11d2191ea3bcb33de1b5823e8b1ff26072cca35c726f61ef1dc5006ab9

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-05-23
+
+- Initial release

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in airtable_base_builder.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,93 @@
+PATH
+  remote: .
+  specs:
+    airtable_base_builder (1.0.0)
+      faraday
+      require_all (~> 3.0)
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (2.1.0)
+      bundler (>= 1.17, < 3.0)
+      childprocess (>= 2.0, < 5.0)
+      contracts (>= 0.16.0, < 0.18.0)
+      cucumber (>= 4.0, < 9.0)
+      rspec-expectations (~> 3.4)
+      thor (~> 1.0)
+    builder (3.2.4)
+    childprocess (4.1.0)
+    coderay (1.1.3)
+    contracts (0.17)
+    cucumber (8.0.0)
+      builder (~> 3.2, >= 3.2.4)
+      cucumber-ci-environment (~> 9.0, >= 9.0.4)
+      cucumber-core (~> 11.0, >= 11.0.0)
+      cucumber-cucumber-expressions (~> 15.1, >= 15.1.1)
+      cucumber-gherkin (~> 23.0, >= 23.0.1)
+      cucumber-html-formatter (~> 19.1, >= 19.1.0)
+      cucumber-messages (~> 18.0, >= 18.0.0)
+      diff-lcs (~> 1.5, >= 1.5.0)
+      mime-types (~> 3.4, >= 3.4.1)
+      multi_test (~> 1.1, >= 1.1.0)
+      sys-uname (~> 1.2, >= 1.2.2)
+    cucumber-ci-environment (9.2.0)
+    cucumber-core (11.0.0)
+      cucumber-gherkin (~> 23.0, >= 23.0.1)
+      cucumber-messages (~> 18.0, >= 18.0.0)
+      cucumber-tag-expressions (~> 4.1, >= 4.1.0)
+    cucumber-cucumber-expressions (15.2.0)
+    cucumber-gherkin (23.0.1)
+      cucumber-messages (~> 18.0, >= 18.0.0)
+    cucumber-html-formatter (19.2.0)
+      cucumber-messages (~> 18.0, >= 18.0.0)
+    cucumber-messages (18.0.0)
+    cucumber-tag-expressions (4.1.0)
+    diff-lcs (1.5.0)
+    faraday (2.7.5)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    ffi (1.15.5)
+    method_source (1.0.0)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2023.0218.1)
+    multi_test (1.1.0)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.6)
+    require_all (3.0.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    ruby2_keywords (0.0.5)
+    sys-uname (1.2.3)
+      ffi (~> 1.1)
+    thor (1.2.2)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  airtable_base_builder!
+  aruba
+  cucumber
+  pry
+  rake (~> 13.0)
+  rspec
+
+BUNDLED WITH
+   2.4.13

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Jeremy Oglesby
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# AirtableBaseBuilder
+
+TODO: Delete this and the text below, and describe your gem
+
+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/airtable_base_builder`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 the created tag, 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]/airtable_base_builder.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/config/pat.txt

@@ -0,0 +1 @@
+patzShunx1ILUq95k.885cf325c6d5fa5cddfca2ce0e6525afae1618b9183c1316d06322bba5372be9

data/config/workspace_id.txt

@@ -0,0 +1 @@
+wspI6Yx5z1nIZhwni

data/exe/atbb

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'airtable_base_builder/cli'
+ENV['THOR_SILENCE_DEPRECATION'] = 'true'
+AirtableBaseBuilder::CLI.start(ARGV)

data/lib/airtable_base_builder/airtable/base.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'client'
+
+module AirtableBaseBuilder
+  module Airtable
+    class Base < Client
+      def initialize(table_names, fields)
+        @table_names = table_names
+        @fields = fields
+      end
+
+      def tables
+        @table_names.map do |table_name|
+          table_fields = @fields.select { |field| field[:table] == table_name }
+          Airtable::Table.new(table_name, table_fields).build
+        end
+      end
+    end
+  end
+end

data/lib/airtable_base_builder/airtable/client.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module AirtableBaseBuilder
+  module Airtable
+    class Client
+      def initialize
+        @pat = AirtableBaseBuilder::Config.new.pat
+      end
+
+      # params: { name: 'My Base', workspaceId: 'wrk123', tables: [{}, {}] }
+      def post(params: {})
+        http_connection.post(
+          "https://api.airtable.com/v0/meta/bases",
+          params.to_json
+        )
+        rescue Faraday::ClientError => e
+          errors_response(e.response[:body].values)
+        rescue Faraday::ServerError
+          errors_response(["The server responded with status 500"])
+      end
+
+      private
+
+      def http_connection
+        @http_connection ||= Faraday.new do |f|
+          f.request :json
+          f.response :raise_error
+          f.response :json
+          f.headers = { 'Authorization' => "Bearer #{@pat}" }
+        end
+      end
+
+      def errors_response(errors)
+        { "errors" => errors }
+      end
+    end
+  end
+end

data/lib/airtable_base_builder/airtable/field.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require_relative 'client'
+
+module AirtableBaseBuilder
+  module Airtable
+    class Field < Client
+      include Thor::Shell
+
+      FIELD_TYPES = %w[
+        singleLineText email url multilineText number percent currency singleSelect multipleSelects
+        singleCollaborator multipleCollaborators date dateTime phoneNumber
+        multipleAttachments checkbox barcode rating richText duration
+      ].freeze
+
+      def initialize(data)
+        @data = data
+      end
+
+      def build
+        validate_field_type
+
+        field = {
+          name: @data[:name],
+          type: @data[:type],
+        }
+
+        field[:options] = options if options
+
+        field
+      end
+
+      def options
+        case @data[:type]
+        when 'singleSelect', 'multipleSelects'
+          { choices: [{ name: 'Option 1' }, { name: 'Option 2' }] }
+        when 'number', 'percent'
+          { precision: 0 }
+        when 'currency'
+          { precision: 0, symbol: '$' }
+        when 'date'
+          { dateFormat: { name: "local" } }
+        when 'dateTime'
+          { timeZone: "utc", dateFormat: { name: "local" }, timeFormat: { name: "12hour" } }
+        # when 'multipleAttachments'
+        #   { isReversed: true }
+        when 'checkbox'
+          { color: "greenBright", icon: "check" }
+        when 'rating'
+          { color: "yellowBright", icon: "star", max: 5 }
+        when 'duration'
+          { durationFormat: "h:mm" }
+        else
+          nil
+        end
+      end
+
+      def validate_field_type
+        return if FIELD_TYPES.include?(@data[:type])
+
+        valid_field_types = FIELD_TYPES.join("\n  - ")
+        say_error("Invalid field type provided: #{@data[:type]}", color = :red)
+        say("Valid field types are:\n  - #{valid_field_types}", color = :green)
+
+        exit
+      end
+    end
+  end
+end

data/lib/airtable_base_builder/airtable/table.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'client'
+
+module AirtableBaseBuilder
+  module Airtable
+    class Table < Client
+      def initialize(name, fields)
+        @name = name
+        @fields = fields
+      end
+
+      def build
+        {
+          name: @name,
+          fields: @fields.map do |field|
+            Airtable::Field.new(field).build
+          end
+        }
+      end
+    end
+  end
+end

data/lib/airtable_base_builder/base_builder.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'csv'
+
+module AirtableBaseBuilder
+  class BaseBuilder < Thor::Group
+    include Thor::Actions
+
+    def initialize(name, csv, delete_file)
+      @name = name
+      @csv = csv
+      @delete_file = delete_file
+    end
+
+    def build
+      csv = CSV.read(@csv, headers: true)
+
+      csv_errors = check_for_csv_errors(csv)
+      if csv_errors
+        say_error(csv_errors, color = :red)
+        exit
+      end
+
+      table_names = csv.by_col["Table"].uniq
+      fields = csv.each.map do |row|
+        { table: row["Table"], name: row["Name"], type: row["Type"], primary: row["Primary"] }
+      end
+
+      atb = Airtable::Base.new(table_names, fields)
+      response = Airtable::Client.new.post(params: {
+        name: @name,
+        workspaceId: Config.new.workspace_id,
+        tables: atb.tables
+      })
+
+      if response["errors"]
+        say_error("There were errors creating the base:", color = :red)
+        say_error(response["errors"].join("\n"), color = :red)
+      else
+        say("Base created successfully!", color = :green)
+        base_link = set_color("https://airtable.com/#{response.body["id"]}", :blue, :bold)
+        say("You can view it here: #{base_link}")
+      end
+
+      File.delete(@csv) if @delete_file
+    end
+
+    def check_for_csv_errors(csv)
+      return "CSV must have a 'Table' column defining the Table each field should be in" unless
+        csv.headers.include?("Table")
+      return "CSV must have a 'Name' column defining the Name of each field" unless
+        csv.headers.include?("Name")
+      return "CSV must have a 'Type' column defining the Type of field each should be" unless
+        csv.headers.include?("Type")
+    end
+  end
+end

data/lib/airtable_base_builder/cli.rb

@@ -0,0 +1,20 @@
+require 'thor'
+require 'require_all'
+require_all 'lib/airtable_base_builder'
+
+require 'pry'
+
+module AirtableBaseBuilder
+  class CLI < Thor
+    desc "config OPTION VALUE", "Configuration options"
+    def config(option, value)
+      AirtableBaseBuilder::Config.new.add_option(option, value)
+    end
+
+    desc "build_base BASE_NAME PATH_TO_CSV_FILE", "Builds a base in Airtable from a CSV file"
+    method_option :delete_file, type: :boolean, default: false, aliases: "-d"
+    def build_base(name, csv)
+      AirtableBaseBuilder::BaseBuilder.new(name, csv, options[:delete_file]).build
+    end
+  end
+end

data/lib/airtable_base_builder/config.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module AirtableBaseBuilder
+  class Config < Thor::Group
+    include Thor::Actions
+
+    VALID_OPTIONS = %w[pat workspace_id].freeze
+
+    def add_option(option, value)
+      # TODO: Handle this option validation with thor conventions
+      unless VALID_OPTIONS.include?(option)
+        say_error("Option must be one of: #{VALID_OPTIONS.join(', ')}", color = :red)
+        exit
+      end
+
+      unless File.directory?('config')
+        say("Creating `config/` directory", color = :green)
+        empty_directory('config')
+      end
+
+      if File.exist?("config/#{option}.txt")
+        say("Removing old `config/#{option}.txt`", color = :green)
+        remove_file("config/#{option}.txt")
+      end
+
+      say("Creating `config/#{option}.txt` to store your value", color = :green)
+      create_file("config/#{option}.txt", value)
+    end
+
+    def pat
+      File.read("config/pat.txt")
+    end
+
+    def workspace_id
+      File.read("config/workspace_id.txt")
+    end
+  end
+end

data/lib/airtable_base_builder/csv_importer.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module AirtableBaseBuilder
+  class CsvImporter
+
+  end
+end

data/lib/airtable_base_builder/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AirtableBaseBuilder
+  VERSION = "1.0.0"
+end

data/lib/airtable_base_builder.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "require_all"
+require_all "lib/airtable_base_builder"
+
+module AirtableBaseBuilder
+  class Error < StandardError; end
+  # Your code goes here...
+  puts 'attb running'
+end

data/sig/airtable_base_builder.rbs

@@ -0,0 +1,4 @@
+module AirtableBaseBuilder
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: airtable_base_builder
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jeremy Oglesby
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This command line tool ingests a CSV file with a specific format and
+  creates an Airtable base out of the contents.
+email:
+- jeremy@oglesby.life
+executables:
+- atbb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/pat.txt
+- config/workspace_id.txt
+- exe/atbb
+- lib/airtable_base_builder.rb
+- lib/airtable_base_builder/airtable/base.rb
+- lib/airtable_base_builder/airtable/client.rb
+- lib/airtable_base_builder/airtable/field.rb
+- lib/airtable_base_builder/airtable/table.rb
+- lib/airtable_base_builder/base_builder.rb
+- lib/airtable_base_builder/cli.rb
+- lib/airtable_base_builder/config.rb
+- lib/airtable_base_builder/csv_importer.rb
+- lib/airtable_base_builder/version.rb
+- sig/airtable_base_builder.rbs
+homepage: https://github.com/jmoglesby/airtable_base_builder
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/jmoglesby/airtable_base_builder
+  source_code_uri: https://github.com/jmoglesby/airtable_base_builder
+  changelog_uri: https://github.com/jmoglesby/airtable_base_builder/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.13
+signing_key:
+specification_version: 4
+summary: A command line tool for generating Airtable bases
+test_files: []