intermix-client 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 87731151937f4cd67118f193d514e5f91dff0f1d4e2c10b6420fa65a35534393
+  data.tar.gz: 2057a99edf427f0266194a57f5b53cc2207173830eddbe5aff9914056bb43e4b
+SHA512:
+  metadata.gz: db718e660550a3f38b5dee9ffd990a5255112f78e1bc5c03850e12738c8946b59177c5d2d03e1b751880e2d3a8ba1fd1148244355a1823f6c2b2cd98367325a0
+  data.tar.gz: f1fe04612f3adf8d9f6351f3dee6fce280a70586b4976936c8e282fa19cbdacb9b05b6cddc920bedbb5efb9b097659ccdc52e788d998135ce190af6a20702596

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+Gemfile.lock
+/.approvals
+/.bundle
+/coverage
+.DS_Store
+.idea

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,40 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/BlockLength:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Layout/ElseAlignment:
+  Enabled: false
+Layout/EndAlignment:
+  Enabled: false
+Layout/IndentationWidth:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/MutableConstant:
+  Enabled: false
+Style/RedundantConditional:
+  Enabled: false
+
+# https://github.com/lovewithfood/rubocop-rspec-focused
+require:
+  - rubocop/rspec/focused
+
+RSpec/Focused:
+  Enabled: true

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.8
+script:
+  - bundle exec rubocop
+  - bundle exec rake
+cache: bundler

data/Gemfile

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rubocop-rspec-focused', '~> 0.1', require: false # Find focused specs.
+end
+
+group :development, :test do
+  gem 'awesome_print'
+  gem 'pry'
+  gem 'rake'
+  gem 'rubocop'
+end
+
+group :test do
+  gem 'approvals'
+  gem 'coveralls', require: false
+  gem 'rspec'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Joe Manley
+
+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,61 @@
+[![Build Status](https://travis-ci.org/tophatter/intermix-api-ruby.svg?branch=master)](https://travis-ci.org/tophatter/intermix-api-ruby)
+[![Coverage Status](https://coveralls.io/repos/github/tophatter/intermix-api-ruby/badge.svg?branch=master&t=nC87CM)](https://coveralls.io/github/tophatter/intermix-api-ruby?branch=master)
+
+# Intermix API client for Ruby
+
+Intermix is an analytics platform that instruments Amazon Redshift to improve performance, reduce costs, and eliminate downtime. Our SaaS product intelligently tunes databases in the cloud, provides deep analytics, recommendations, and predictions, so companies don't have to hire DBA experts, throw money at performance problems, or deal with slow queries.
+This gem helps to interact with the Intermix API.
+
+To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'intermix-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install intermix-client
+
+## Usage
+
+#### Creating a client
+Before performing any operation through the intermix api, we need an instance of `Intermix::Client`.
+```
+require 'intermix'
+
+configuration = Intermix::Configuration.new(api_token: api_token, cluster_id: cluster_id)
+client        = Intermix::Client.new(configuration)
+```
+
+#### Get list of tables
+```
+tables = client.tables # These are instances of `Intermix::Table`.
+```
+
+#### Generate vacuum script
+```
+vacuum = Intermix::Vacuum.new(client: client, delete_only: true, unsorted_threshold: 0.50)
+
+vacuum.generate_script # This returns the script in string format.
+vacuum.save_script # This saves the genered vacuum script in `output/vacuum_scripts/vacuum_databases.sh`.
+```
+
+## Development
+
+After checking out the repo, run `bundle install` 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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tophatter/intermix-client.
+
+## 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,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'intermix/client'
+require 'awesome_print'
+require 'pry'
+
+AwesomePrint.pry!
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/intermix-client.gemspec

@@ -0,0 +1,24 @@
+# To publish the next version:
+# gem build intermix-client.gemspec
+# gem push intermix-client-0.0.1.gem
+Gem::Specification.new do |spec|
+  spec.name          = 'intermix-client'
+  spec.version       = '0.0.2'
+  spec.authors       = ['Joe Manley']
+  spec.email         = ['joemanley201@gmail.com']
+
+  spec.summary       = 'Intermix API Client in Ruby'
+  spec.description   = 'Intermix API Client in Ruby'
+  spec.homepage      = 'https://github.com/tophatter/intermix-api-ruby'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '~> 2.3'
+
+  spec.add_dependency 'activesupport', '~> 4.2'
+  spec.add_dependency 'httparty',      '~> 0.14.0'
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/lib/intermix.rb

@@ -0,0 +1,8 @@
+require 'httparty'
+require 'active_support'
+require 'active_support/core_ext'
+
+require File.dirname(__FILE__) + '/intermix/client'
+require File.dirname(__FILE__) + '/intermix/configuration'
+require File.dirname(__FILE__) + '/intermix/table'
+require File.dirname(__FILE__) + '/intermix/vacuum'

data/lib/intermix/client.rb

@@ -0,0 +1,40 @@
+module Intermix
+  class Client
+    # paths
+    TABLES_PATH = '/tables'
+
+    attr_reader :configuration
+
+    def initialize(configuration)
+      raise ArgumentError, 'configuration cannot be nil.' unless configuration.present?
+
+      @configuration = configuration
+    end
+
+    def tables(fields = Table::FIELDS)
+      fields &&= Table::FIELDS
+      query = "fields=#{fields.join(',')}" if fields.any?
+
+      response = post(TABLES_PATH, query: query)
+
+      if response.success?
+        parsed_response = response.parsed_response
+        parsed_response['data'].map { |entry| Intermix::Table.new(entry) }
+      else
+        []
+      end
+    end
+
+    private
+
+    def post(path, query: nil)
+      uri = "#{@configuration.base_uri}#{path}?" + query
+
+      HTTParty.post(uri, headers: headers)
+    end
+
+    def headers
+      { 'Authorization' => "Token #{@configuration.api_token}" }
+    end
+  end
+end

data/lib/intermix/configuration.rb

@@ -0,0 +1,23 @@
+module Intermix
+  class Configuration
+    CLUSTER_TYPE = 'RedshiftCluster'
+    API_URL      = 'https://dashboard.intermix.io/api'
+
+    attr_reader :api_token, :cluster_id, :cluster_type, :api_url
+
+    def initialize(api_token:, cluster_id:)
+      raise ArgumentError, 'api_token cannot be nil.' unless api_token.present?
+      raise ArgumentError, 'cluster_id cannot be nil.' unless cluster_id.present?
+
+      @api_token  = api_token
+      @cluster_id = cluster_id
+
+      @cluster_type = CLUSTER_TYPE
+      @api_url      = API_URL
+    end
+
+    def base_uri
+      @base_uri = "#{@api_url}/#{@cluster_type}/#{@cluster_id}" unless defined?(@base_uri)
+    end
+  end
+end

data/lib/intermix/table.rb

@@ -0,0 +1,28 @@
+module Intermix
+  class Table
+    FIELDS = %w[
+      db_id
+      db_name
+      schema_id
+      schema_name
+      table_id
+      table_name
+      stats_pct_off
+      size_pct_unsorted
+      row_count
+      sort_key
+    ]
+
+    attr_accessor(*FIELDS)
+
+    def initialize(data)
+      raise ArgumentError, 'data cannot be nil.' unless data.present?
+
+      self.class::FIELDS.each { |field| send("#{field}=", data[field]) }
+    end
+
+    def full_name
+      "\"#{schema_name}\".\"#{table_name}\""
+    end
+  end
+end

data/lib/intermix/vacuum.rb

@@ -0,0 +1,121 @@
+module Intermix
+  class Vacuum
+    DEFAULT_STATS_OFF_THRESHOLD = 0.10
+    DEFAULT_UNSORTED_THRESHOLD  = 0.10
+    DEFAULT_VACUUM_THRESHOLD    = 0.95
+
+    REDSHIFT_USERNAME = ''
+    REDSHIFT_HOST     = ''
+    REDSHIFT_PORT     = 5439
+
+    IGNORED_SCHEMAS = %w[pg_internal]
+
+    attr_reader :client,
+                :full, :delete_only, :sort, :analyze,
+                :stats_off_threshold, :unsorted_threshold,
+                :admin_user, :host, :port
+
+    def initialize(client:,
+                   delete_only: false, full: false, sort: false,
+                   stats_off_threshold: DEFAULT_STATS_OFF_THRESHOLD, unsorted_threshold: DEFAULT_UNSORTED_THRESHOLD,
+                   vacuum_threshold: DEFAULT_VACUUM_THRESHOLD,
+                   admin_user: REDSHIFT_USERNAME, host: REDSHIFT_HOST, port: REDSHIFT_PORT)
+      raise ArgumentError, 'client cannot be nil.' unless client.present?
+      raise ArgumentError, 'invalid vacuum mode.' if full && [delete_only, sort].any?
+
+      @client = client
+
+      @full        = full
+      @delete_only = delete_only
+      @sort        = sort
+      @analyze     = true if full || delete_only
+
+      @stats_off_threshold  = stats_off_threshold
+      @unsorted_threshold   = unsorted_threshold
+      @vacuum_threshold_pct = [vacuum_threshold * 100, 100].min
+
+      @admin_user = admin_user
+      @host       = host
+      @port       = port
+    end
+
+    def eligible_tables
+      client.tables.select do |table|
+        if IGNORED_SCHEMAS.include?(table.schema_name)
+          false
+        elsif table.stats_pct_off.nil?
+          false
+        elsif table.size_pct_unsorted.nil?
+          false
+        elsif table.stats_pct_off <= @stats_off_threshold
+          false
+        elsif table.size_pct_unsorted <= @unsorted_threshold
+          false
+        else
+          true
+        end
+      end
+    end
+
+    def generate_script
+      output = script_header
+
+      eligible_tables.group_by(&:db_name).each do |db_name, tables|
+        output += "\n\\c #{db_name}\n\n"
+        tables.sort_by { |table| -table.size_pct_unsorted }.each do |table|
+          output += vacuum_command(table: table)
+          output += analyze_command(table: table) if @analyze
+          output += "\n"
+        end
+      end
+
+      output += "\n"
+
+      output
+    end
+
+    def save_script(location = 'output/vacuum_scripts/vacuum_databases.sh')
+      File.open(location, 'w') { |file| file.write(generate_script) }
+    end
+
+    private
+
+    def script_header
+      <<~SCRIPT
+        #!/bin/bash
+        # Intermix.io Vacuum Script
+        #
+        # This script requires the psql postgres command line client be installed prior
+        # to running.  The psql client is avaliable for download here,
+        # https://www.postgresql.org/download/.
+        #
+        #
+        # You will be prompted for the administrator password
+        # Override the administrator username here
+        adminuser="#{@admin_user}"
+        psqlcommand="psql -e"
+        # Don't edit anything beyond this point
+        logindb="dev"
+        redshiftport="#{@host}"
+        redshifthost="#{@port}"
+        ${{psqlcommand}} -d ${{logindb}} -U ${{adminuser}} -p ${{redshiftport}} -h ${{redshifthost}} <<EOF
+      SCRIPT
+    end
+
+    def vacuum_command(table:)
+      command = if @full
+        'FULL'
+      elsif @delete_only
+        'DELETE ONLY'
+      elsif @sort
+        table.sort_key == 'INTERLEAVED' ? 'REINDEX' : 'SORT ONLY'
+      end
+
+      "VACUUM #{command} #{table.full_name} to #{@vacuum_threshold_pct.to_i} percent;\n"
+    end
+
+    def analyze_command(table:)
+      "ANALYZE #{table.full_name};\n"
+    end
+  end
+end

data/output/vacuum_scripts/vacuum_databases.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+# Intermix.io Vacuum Script
+#
+# This script requires the psql postgres command line client be installed prior
+# to running.  The psql client is avaliable for download here,
+# https://www.postgresql.org/download/.
+#
+#
+# You will be prompted for the administrator password
+# Override the administrator username here
+adminuser=""
+psqlcommand="psql -e"
+# Don't edit anything beyond this point
+logindb="dev"
+redshiftport=""
+redshifthost="5439"
+${{psqlcommand}} -d ${{logindb}} -U ${{adminuser}} -p ${{redshiftport}} -h ${{redshifthost}} <<EOF
+
+\c db1
+
+VACUUM DELETE ONLY "public"."hello"
+ANALYZE "public"."hello";
+
+

data/spec/client_spec.rb

@@ -0,0 +1,46 @@
+# rspec spec/client_spec.rb
+RSpec.describe Intermix::Client do
+  describe '#initialize' do
+    subject { Intermix::Client.new(configuration) }
+
+    context 'when configuration is nil' do
+      let(:configuration) { nil }
+
+      it 'throws an error' do
+        expect { subject }.to raise_error(ArgumentError, 'configuration cannot be nil.')
+      end
+    end
+
+    context 'when configuration is present', :stubbed_client do
+      let(:configuration) { stubbed_configuration }
+
+      it 'returns a client object' do
+        expect(subject).to be_present
+      end
+    end
+  end
+
+  describe '#tables', :stubbed_client do
+    let(:client) { stubbed_client }
+
+    subject { client.tables(Intermix::Table::FIELDS) }
+
+    before { allow(HTTParty).to receive(:post).with(any_args).and_return(response) }
+
+    context 'when the response is successful' do
+      let(:response) { successful_response }
+
+      it 'returns instances of Intermix::Table' do
+        expect(subject.first.is_a?(Intermix::Table)).to be_truthy
+      end
+    end
+
+    context 'when the response is not successful' do
+      let(:response) { failed_response }
+
+      it 'returns an empty array' do
+        expect(subject).to be_empty
+      end
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,44 @@
+# rspec spec/configuration_spec.rb
+RSpec.describe Intermix::Configuration do
+  describe '#initialize' do
+    let(:api_token) { 'token' }
+    let(:cluster_id) { 1 }
+
+    subject { Intermix::Configuration.new(api_token: api_token, cluster_id: cluster_id) }
+
+    context 'when api_token is nil' do
+      let(:api_token) { nil }
+
+      it 'throws an error' do
+        expect { subject }.to raise_error(ArgumentError, 'api_token cannot be nil.')
+      end
+    end
+
+    context 'when cluster_id is nil' do
+      let(:cluster_id) { nil }
+
+      it 'throws an error' do
+        expect { subject }.to raise_error(ArgumentError, 'cluster_id cannot be nil.')
+      end
+    end
+
+    it 'assigns attributes correctly' do
+      expect(subject.api_token).to eq(api_token)
+      expect(subject.cluster_id).to eq(cluster_id)
+
+      expect(subject.cluster_type).to eq(Intermix::Configuration::CLUSTER_TYPE)
+      expect(subject.api_url).to eq(Intermix::Configuration::API_URL)
+    end
+  end
+
+  describe '#base_uri' do
+    let(:api_token) { 'token' }
+    let(:cluster_id) { 1 }
+
+    subject { Intermix::Configuration.new(api_token: api_token, cluster_id: cluster_id).base_uri }
+
+    it 'returns the correct uri based on api_url, cluster_type and cluster_type' do
+      expect(subject).to eq('https://dashboard.intermix.io/api/RedshiftCluster/1')
+    end
+  end
+end

data/spec/fixtures/approvals/intermix_vacuum/generate_script/when_it_is_in_delete_only_mode/generates_the_expected_script.approved.txt

@@ -0,0 +1,27 @@
+#!/bin/bash
+# Intermix.io Vacuum Script
+#
+# This script requires the psql postgres command line client be installed prior
+# to running.  The psql client is avaliable for download here,
+# https://www.postgresql.org/download/.
+#
+#
+# You will be prompted for the administrator password
+# Override the administrator username here
+adminuser=""
+psqlcommand="psql -e"
+# Don't edit anything beyond this point
+logindb="dev"
+redshiftport=""
+redshifthost="5439"
+${{psqlcommand}} -d ${{logindb}} -U ${{adminuser}} -p ${{redshiftport}} -h ${{redshifthost}} <<EOF
+
+\c db1
+
+VACUUM DELETE ONLY "public"."table2" to 99 percent;
+ANALYZE "public"."table2";
+
+VACUUM DELETE ONLY "public"."table1" to 99 percent;
+ANALYZE "public"."table1";
+
+

data/spec/fixtures/approvals/intermix_vacuum/generate_script/when_it_is_in_full_mode/generates_the_expected_script.approved.txt

@@ -0,0 +1,27 @@
+#!/bin/bash
+# Intermix.io Vacuum Script
+#
+# This script requires the psql postgres command line client be installed prior
+# to running.  The psql client is avaliable for download here,
+# https://www.postgresql.org/download/.
+#
+#
+# You will be prompted for the administrator password
+# Override the administrator username here
+adminuser=""
+psqlcommand="psql -e"
+# Don't edit anything beyond this point
+logindb="dev"
+redshiftport=""
+redshifthost="5439"
+${{psqlcommand}} -d ${{logindb}} -U ${{adminuser}} -p ${{redshiftport}} -h ${{redshifthost}} <<EOF
+
+\c db1
+
+VACUUM FULL "public"."table2" to 99 percent;
+ANALYZE "public"."table2";
+
+VACUUM FULL "public"."table1" to 99 percent;
+ANALYZE "public"."table1";
+
+

data/spec/fixtures/approvals/intermix_vacuum/generate_script/when_it_is_in_sort_mode/generates_the_expected_script.approved.txt

@@ -0,0 +1,25 @@
+#!/bin/bash
+# Intermix.io Vacuum Script
+#
+# This script requires the psql postgres command line client be installed prior
+# to running.  The psql client is avaliable for download here,
+# https://www.postgresql.org/download/.
+#
+#
+# You will be prompted for the administrator password
+# Override the administrator username here
+adminuser=""
+psqlcommand="psql -e"
+# Don't edit anything beyond this point
+logindb="dev"
+redshiftport=""
+redshifthost="5439"
+${{psqlcommand}} -d ${{logindb}} -U ${{adminuser}} -p ${{redshiftport}} -h ${{redshifthost}} <<EOF
+
+\c db1
+
+VACUUM SORT ONLY "public"."table2" to 99 percent;
+
+VACUUM SORT ONLY "public"."table1" to 99 percent;
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'intermix'
+require 'awesome_print'
+require 'approvals/rspec'
+require 'coveralls'
+
+Coveralls.wear!
+
+RSpec.configure do |rspec|
+  # This config option will be enabled by default on RSpec 4,
+  # but for reasons of backwards compatibility, you have to
+  # set it on RSpec 3.
+  #
+  # It causes the host group and examples to inherit metadata
+  # from the shared context.
+  rspec.shared_context_metadata_behavior = :apply_to_host_groups
+end
+
+Approvals.configure do |config|
+  config.approvals_path = 'spec/fixtures/approvals/'
+end
+
+gemspec = Gem::Specification.find_by_name('intermix-client')
+Dir["#{gemspec.gem_dir}/spec/support/**/*.rb"].each { |f| require f }

data/spec/support/shared_contexts/stubbed_client.rb

@@ -0,0 +1,30 @@
+RSpec.shared_context 'stubbed_client' do
+  let(:api_token) { 'token' }
+  let(:cluster_id) { 1 }
+
+  let(:stubbed_configuration) { Intermix::Configuration.new(api_token: api_token, cluster_id: cluster_id) }
+  let(:stubbed_client) { Intermix::Client.new(stubbed_configuration) }
+
+  # tables
+  let(:stubbed_table) do
+    {
+      db_id: '1',
+      db_name: 'db1',
+      schema_id: 1,
+      schema_name: 'public',
+      table_id: 1,
+      table_name: 'events',
+      stats_pct_off: 0.12,
+      size_pct_unsorted: 0.13,
+      row_count: 123_456,
+      sort_key: 'id'
+    }
+  end
+
+  let(:successful_response) { OpenStruct.new('code': 200, success?: true, 'data': [stubbed_table].to_json, parsed_response: { 'data' => [stubbed_table] }) }
+  let(:failed_response)     { OpenStruct.new('code': 403, 'data': nil) }
+end
+
+RSpec.configure do |rspec|
+  rspec.include_context 'stubbed_client', stubbed_client: true
+end

data/spec/table_spec.rb

@@ -0,0 +1,39 @@
+# rspec spec/table_spec.rb
+RSpec.describe Intermix::Table do
+  describe '#initialize', :stubbed_client do
+    subject { Intermix::Table.new(data) }
+
+    context 'when data is nil' do
+      let(:data) { nil }
+
+      it 'throws an error' do
+        expect { subject }.to raise_error(ArgumentError, 'data cannot be nil.')
+      end
+    end
+
+    context 'when data is present' do
+      let(:data) { stubbed_table.with_indifferent_access }
+
+      it 'assigns the attributes correctly' do
+        expect(subject.db_id).to eq('1')
+        expect(subject.db_name).to eq('db1')
+        expect(subject.schema_id).to eq(1)
+        expect(subject.schema_name).to eq('public')
+        expect(subject.table_id).to eq(1)
+        expect(subject.table_name).to eq('events')
+        expect(subject.stats_pct_off).to eq(0.12)
+        expect(subject.size_pct_unsorted).to eq(0.13)
+        expect(subject.row_count).to eq(123_456)
+        expect(subject.sort_key).to eq('id')
+      end
+    end
+  end
+
+  describe '#full_name', :stubbed_client do
+    subject { Intermix::Table.new(stubbed_table.with_indifferent_access) }
+
+    it 'returns the schema name along with the table name' do
+      expect(subject.full_name).to eq('"public"."events"')
+    end
+  end
+end

data/spec/vacuum_spec.rb

@@ -0,0 +1,136 @@
+# rspec spec/vacuum_spec.rb
+RSpec.describe Intermix::Vacuum do
+  describe '#initialize', :stubbed_client do
+    let(:delete_only) { false }
+    let(:full) { true }
+    let(:sort) { false }
+
+    subject { Intermix::Vacuum.new(client: client, full: full, delete_only: delete_only, sort: sort) }
+
+    context 'when client is nil' do
+      let(:client) { nil }
+
+      it 'throws an error' do
+        expect { subject }.to raise_error(ArgumentError, 'client cannot be nil.')
+      end
+    end
+
+    context 'invalid vacuum mode' do
+      context 'full and delete_only' do
+        let(:full) { true }
+        let(:delete_only) { true }
+        let(:sort) { false }
+
+        let(:client) { stubbed_client }
+
+        it 'throws an error' do
+          expect { subject }.to raise_error(ArgumentError, 'invalid vacuum mode.')
+        end
+      end
+
+      context 'full and sort' do
+        let(:full) { true }
+        let(:delete_only) { false }
+        let(:sort) { true }
+
+        let(:client) { stubbed_client }
+
+        it 'throws an error' do
+          expect { subject }.to raise_error(ArgumentError, 'invalid vacuum mode.')
+        end
+      end
+    end
+
+    context 'valid vacuum mode' do
+      context 'when it is only full' do
+        let(:full) { true }
+        let(:delete_only) { false }
+        let(:sort) { false }
+
+        let(:client) { stubbed_client }
+
+        it 'assigns the correct attributes' do
+          expect { subject }.not_to raise_error
+
+          expect(subject.client).to be_present
+
+          expect(subject.full).to be_truthy
+          expect(subject.delete_only).to be_falsey
+          expect(subject.sort).to be_falsey
+          expect(subject.analyze).to be_truthy
+
+          expect(subject.stats_off_threshold).to eq(0.10)
+          expect(subject.stats_off_threshold).to eq(0.10)
+
+          expect(subject.admin_user).to eq('')
+          expect(subject.host).to eq('')
+          expect(subject.port).to eq(5439)
+        end
+      end
+    end
+  end
+
+  describe '#generate_script', :stubbed_client do
+    let(:stats_off_threshold) { 0.21 }
+    let(:unsorted_threshold) { 0.22 }
+    let(:threshold_met) do
+      [
+        stubbed_table.merge(table_name: 'table1', stats_pct_off: 0.45, size_pct_unsorted: 0.41), # included
+        stubbed_table.merge(table_name: 'table2', stats_pct_off: 0.56, size_pct_unsorted: 0.78)  # included
+      ]
+    end
+    let(:threshold_unmet) do
+      [
+        stubbed_table.merge(table_name: 'table3', stats_pct_off: 0.45, size_pct_unsorted: nil),  # excluded
+        stubbed_table.merge(table_name: 'table4', stats_pct_off: 0.45, size_pct_unsorted: 0.20), # excluded
+        stubbed_table.merge(table_name: 'table5', stats_pct_off: 0.20, size_pct_unsorted: 0.41)  # excluded
+      ]
+    end
+    let(:excluded_schema) do
+      [
+        threshold_met.first.merge(schema_name: Intermix::Vacuum::IGNORED_SCHEMAS.first) # excluded
+      ]
+    end
+
+    let(:delete_only) { false }
+    let(:full) { false }
+    let(:sort) { false }
+
+    subject do
+      vacuum = Intermix::Vacuum.new(client: stubbed_client,
+                                    delete_only: delete_only, full: full, sort: sort,
+                                    stats_off_threshold: stats_off_threshold, unsorted_threshold: unsorted_threshold,
+                                    vacuum_threshold: 0.99)
+      vacuum.generate_script
+    end
+
+    before do
+      tables = [threshold_met + threshold_unmet + excluded_schema].flatten.map { |t| Intermix::Table.new(t.with_indifferent_access) }
+      allow(stubbed_client).to receive(:tables).and_return(tables)
+    end
+
+    context 'when it is in delete_only mode' do
+      let(:delete_only) { true }
+
+      it 'generates the expected script' do
+        verify(format: :txt) { subject }
+      end
+    end
+
+    context 'when it is in sort mode' do
+      let(:sort) { true }
+
+      it 'generates the expected script' do
+        verify(format: :txt) { subject }
+      end
+    end
+
+    context 'when it is in full mode' do
+      let(:full) { true }
+
+      it 'generates the expected script' do
+        verify(format: :txt) { subject }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: intermix-client
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Joe Manley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: Intermix API Client in Ruby
+email:
+- joemanley201@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- intermix-client.gemspec
+- lib/intermix.rb
+- lib/intermix/client.rb
+- lib/intermix/configuration.rb
+- lib/intermix/table.rb
+- lib/intermix/vacuum.rb
+- output/vacuum_scripts/vacuum_databases.sh
+- spec/client_spec.rb
+- spec/configuration_spec.rb
+- spec/fixtures/approvals/intermix_vacuum/generate_script/when_it_is_in_delete_only_mode/generates_the_expected_script.approved.txt
+- spec/fixtures/approvals/intermix_vacuum/generate_script/when_it_is_in_full_mode/generates_the_expected_script.approved.txt
+- spec/fixtures/approvals/intermix_vacuum/generate_script/when_it_is_in_sort_mode/generates_the_expected_script.approved.txt
+- spec/spec_helper.rb
+- spec/support/shared_contexts/stubbed_client.rb
+- spec/table_spec.rb
+- spec/vacuum_spec.rb
+homepage: https://github.com/tophatter/intermix-api-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.9
+signing_key: 
+specification_version: 4
+summary: Intermix API Client in Ruby
+test_files:
+- spec/client_spec.rb
+- spec/configuration_spec.rb
+- spec/fixtures/approvals/intermix_vacuum/generate_script/when_it_is_in_delete_only_mode/generates_the_expected_script.approved.txt
+- spec/fixtures/approvals/intermix_vacuum/generate_script/when_it_is_in_full_mode/generates_the_expected_script.approved.txt
+- spec/fixtures/approvals/intermix_vacuum/generate_script/when_it_is_in_sort_mode/generates_the_expected_script.approved.txt
+- spec/spec_helper.rb
+- spec/support/shared_contexts/stubbed_client.rb
+- spec/table_spec.rb
+- spec/vacuum_spec.rb