data-world-activerecord-adapter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0dd97f1bb7c5a2538a603d4350e774d4a1df645d52a6826bc7cc736d69098429
+  data.tar.gz: aefddbc5f90890db9cd22c0b12f549e1c7ccd2e13dec5ffb3d5172d757922450
+SHA512:
+  metadata.gz: 37ea52d1963dd7954af4dd365a21d604006494d5063c6602632f7cec79b423c3ce963ca2f677755c355e0f90b4bff1bea7184026ab7d95a0a9a938b3506f373d
+  data.tar.gz: 1e80c2001038c400c26cbe001c358a02c8957464b66f42f55a6833c1941161f92152f913efd9ac413a0dc79ceb549ac0ee45d5b013b077a8d87c1020bf946759

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in data-world-activerecord-adapter.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,142 @@
+PATH
+  remote: .
+  specs:
+    data-world-activerecord-adapter (0.1.0)
+      rails (~> 6.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.3.3)
+      actionpack (= 6.0.3.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.3.3)
+      actionpack (= 6.0.3.3)
+      activejob (= 6.0.3.3)
+      activerecord (= 6.0.3.3)
+      activestorage (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
+      mail (>= 2.7.1)
+    actionmailer (6.0.3.3)
+      actionpack (= 6.0.3.3)
+      actionview (= 6.0.3.3)
+      activejob (= 6.0.3.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.3.3)
+      actionview (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.3.3)
+      actionpack (= 6.0.3.3)
+      activerecord (= 6.0.3.3)
+      activestorage (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.3.3)
+      activesupport (= 6.0.3.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.3.3)
+      activesupport (= 6.0.3.3)
+      globalid (>= 0.3.6)
+    activemodel (6.0.3.3)
+      activesupport (= 6.0.3.3)
+    activerecord (6.0.3.3)
+      activemodel (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
+    activestorage (6.0.3.3)
+      actionpack (= 6.0.3.3)
+      activejob (= 6.0.3.3)
+      activerecord (= 6.0.3.3)
+      marcel (~> 0.3.1)
+    activesupport (6.0.3.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.7)
+    crass (1.0.6)
+    erubi (1.9.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    loofah (2.7.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.2)
+    nio4r (2.5.4)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.3.3)
+      actioncable (= 6.0.3.3)
+      actionmailbox (= 6.0.3.3)
+      actionmailer (= 6.0.3.3)
+      actionpack (= 6.0.3.3)
+      actiontext (= 6.0.3.3)
+      actionview (= 6.0.3.3)
+      activejob (= 6.0.3.3)
+      activemodel (= 6.0.3.3)
+      activerecord (= 6.0.3.3)
+      activestorage (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
+      bundler (>= 1.3.0)
+      railties (= 6.0.3.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.3)
+      actionpack (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (12.3.3)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  data-world-activerecord-adapter!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Spencer Oberstadt
+
+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,68 @@
+# DataWorld::Activerecord::Adapter
+
+This gem was written in one day. It works, but I wouldn't trust it further than I could throw it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'data-world-activerecord-adapter'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install data-world-activerecord-adapter
+
+## Usage
+
+Add something like this to your database config:
+```ruby
+default: &default
+  adapter: 'data_world'
+  owner: 'marvel'
+  id: 'avengers-dataset'
+  auth_token: <%= ENV['DATA_WORLD_TOKEN'] %>
+```
+
+or if you want one model to do this, you can do so with:
+```ruby
+class AssembledModel < ApplicationRecord
+  establish_connection({
+    adapter: 'data_world',
+    owner: 'marvel',
+    id: 'avengers-dataset',
+    auth_token: <%= ENV['DATA_WORLD_TOKEN'] %>
+  })
+end
+```
+
+You will probably want to manually set your table names and primary keys:
+```ruby
+class AssembledModel < ApplicationRecord
+  self.table_name = 'siu_donation'
+
+  def self.primary_key
+    'row_id'
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+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/soberstadt/data-world-activerecord-adapter.
+
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

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/data-world-activerecord-adapter.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "data-world-activerecord-adapter"
+  spec.version       = DataWorldAdapter::VERSION
+  spec.authors       = ["Spencer Oberstadt"]
+  spec.email         = ["soberstadt@gmail.com"]
+
+  spec.summary       = "Use ActiveRecord to connect with Data.World"
+  spec.homepage      = 'https://github.com/soberstadt/data-world-activerecord-adapter'
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # this likely works with other and older versions of rails, but I haven't tested it
+  spec.add_dependency 'rails', '~> 6.0.0'
+end

data/lib/active_record/connection_adapters/data_world_adapter.rb

@@ -0,0 +1,118 @@
+require 'active_record/connection_adapters/abstract_adapter'
+require 'uri'
+require 'net/http'
+require 'openssl'
+
+module ActiveRecord
+  class Base
+    class << self
+      def data_world_connection(config)
+        ConnectionAdapters::DataWorldAdapter.new({}, logger, config)
+      end
+    end
+  end
+
+  module ConnectionAdapters #:nodoc:
+
+    class DataWorldAdapter < AbstractAdapter
+      def adapter_name #:nodoc:
+        'Data.World'
+      end
+
+      def requires_reloading?
+        true
+      end
+
+      def supports_count_distinct? #:nodoc:
+        true
+      end
+
+
+      # DATABASE STATEMENTS ======================================
+
+      def execute(sql, name = nil) #:nodoc:
+        url = URI("https://api.data.world/v0/sql/#{@config[:owner]}/#{@config[:id]}")
+
+        http = Net::HTTP.new(url.host, url.port)
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+        request = Net::HTTP::Post.new(url)
+        request["content-type"] = 'application/json'
+        request["authorization"] = "Bearer #{@config[:auth_token]}"
+        request.body = {
+          query: sql,
+          includeTableSchema: true
+        }.to_json
+
+        response = http.request(request)
+
+        try_json response.read_body
+      end
+
+      def exec_query(sql, name = nil, binds = [], prepare: false)
+        if preventing_writes? && write_query?(sql)
+          raise ActiveRecord::ReadOnlyError, "Data.World is read-only, query not accepted: #{sql}"
+        end
+
+        type_casted_binds = type_casted_binds(binds)
+
+        log(sql, name, binds, type_casted_binds) do
+          raw = execute(sql_bind(sql, binds))
+          cols = raw.dig(0, 'fields')&.map { |h| h['name'] }
+          records = raw[1..-1].map(&:values)
+
+          ActiveRecord::Result.new(cols, records)
+        end
+      end
+
+      # do our best job binding the variables into the query
+      def sql_bind(sql, binds)
+        new_sql = sql.clone
+        binds.each do |attribute|
+          value = if attribute.value.is_a?(String)
+            "'#{attribute.value}'"
+          else
+            attribute.value.to_s
+          end
+
+          new_sql = new_sql.sub('?', value)
+        end
+        new_sql
+      end
+
+      def try_json(string)
+        JSON.parse(string)
+      rescue
+        raise string
+      end
+
+
+      # SCHEMA STATEMENTS ========================================
+
+      def tables(name = nil) #:nodoc:
+        sql = "SELECT tableName FROM Tables"
+        execute(sql, name).map { |row| row[0] }
+      end
+
+      def views
+        []
+      end
+
+      def columns(table_name, name = nil) #:nodoc:
+        table_structure(table_name).map do |field|
+          type_metadata = SqlTypeMetadata.new(sql_type: field['columnDatatype'])
+          ActiveRecord::ConnectionAdapters::Column.new(field['columnName'], nil, type_metadata)
+        end
+      end
+
+      protected
+
+      def table_structure(table_name)
+        columns = execute("SELECT * FROM TableColumns WHERE tableName = \"#{table_name}\"")[1..-1]
+        raise(ActiveRecord::StatementInvalid, "Could not find table '#{table_name}'") if columns.empty?
+        columns
+      end
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module DataWorldAdapter
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: data-world-activerecord-adapter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Spencer Oberstadt
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description:
+email:
+- soberstadt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/setup
+- data-world-activerecord-adapter.gemspec
+- lib/active_record/connection_adapters/data_world_adapter.rb
+- lib/version.rb
+homepage: https://github.com/soberstadt/data-world-activerecord-adapter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/soberstadt/data-world-activerecord-adapter
+  source_code_uri: https://github.com/soberstadt/data-world-activerecord-adapter
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Use ActiveRecord to connect with Data.World
+test_files: []