activerecord-bq-adapter 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord-bq-adapter.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Dan Draper
+
+MIT License
+
+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,51 @@
+# Activerecord::Bq::Adapter
+
+Basic Implementation of an ActiveRecord Adapter for Google's Big Query. Just handles queries right now. See TODO list in the Readme for whats coming.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord-bq-adapter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-bq-adapter
+
+## Usage
+
+Set your model to use the adapter. You probably won't want to do it for your entire app but rather just specific models like:
+
+    class MyModel < ActiveRecord::Base
+      set_table_name "<bq_dataset>.<bq_table>"
+      establish_connection(
+        :adapter    => "bq",
+        :project_id => <project_id>,
+        :client_id  => "<project_id>.apps.googleusercontent.com",
+        :client_secret => <client-secret>,
+        :refresh_token => <token>
+      )
+    end
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## TODO
+
+* Asynchronous Queries, Inserts, Job handling
+* Insert
+* Bulk Inserts (from file, URL)
+* Append vs Rewrite on insertion
+* Specify table for results output
+* Handle select * type queries (BigQuery requires explicit column names in select) - possibly use the Browsing Data part of the API
+* Caching - perhaps using Faraday Middleware

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/activerecord-bq-adapter.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/activerecord-bq-adapter/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dan Draper"]
+  gem.email         = ["daniel@codefire.com"]
+  gem.description   = %q{Basic Implementation of an ActiveRecord Adapter for Google's Big Query. Just handles queries right now. See TODO list in the Readme for whats coming.}
+  gem.summary       = %q{Basic Implementation of an ActiveRecord Adapter for Google's Big Query}
+  gem.homepage      = ""
+
+  gem.add_dependency "multipart_body", "~> 0.2.1"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "activerecord-bq-adapter"
+  gem.require_paths = ["lib"]
+  gem.version       = Activerecord::Bq::Adapter::VERSION
+end

data/lib/active_record/connection_adapters/bq_adapter.rb

@@ -0,0 +1,157 @@
+
+module ActiveRecord
+  class Base
+    def self.bq_connection(config)
+      ConnectionAdapters::BQAdapter.new(logger, config)
+    end
+  end
+
+  module ConnectionAdapters
+
+    class BQColumn < Column
+      private
+        def simplified_type(field_type)
+          field_type.downcase.to_sym
+        end
+    end
+
+    class BQAdapter < AbstractAdapter
+      attr_reader :project_id
+
+      # Steal from SQLite for now :)
+      class BindSubstitution < Arel::Visitors::SQLite # :nodoc:
+        include Arel::Visitors::BindVisitor
+      end
+
+      def initialize(logger, config)
+        super(nil, logger)
+
+        @token           = nil
+        @project_id      = config[:project_id]
+        @client_id       = config[:client_id]
+        @client_secret   = config[:client_secret]
+        @refresh         = config[:refresh_token]
+        @visitor         = BindSubstitution.new(self)
+        @api_client_obj  = OAuth2::Client.new(@client_id, @client_secret, {:site => 'https://www.googleapis.com'})
+        establish_api_connection
+      end
+
+      def adapter_name
+        "BQ"
+      end
+
+      # This is really only suitable for queries
+      def execute(sql, kind = "bigquery#queryRequest")
+        log(sql, kind) do
+          do_api do
+            payload = { "kind" => kind, "query"  => "#{sql};" }
+            response = api_connection.post("#{base_url}/queries", :body => JSON(payload), :headers => { "Content-Type" => "application/json" })
+            JSON(response.body)
+          end
+        end
+      end
+
+      def select(sql, name, binds)
+        exec_query(sql, name, binds).to_a
+      end
+
+      def exec_query(sql, name = 'SQL', binds = [])
+        result = execute(sql)
+        ActiveRecord::Result.new(
+          result['schema']['fields'].map { |f| f['name'] },
+          result['rows'].map do |row|
+            row['f'].map { |col| col['v'] }
+          end
+        )
+      end
+
+      def exec_insert(sql, name, binds)
+        raise ActiveRecordError, "Cannot use create for BQ - call ActiveRecord::Base.bq_append instead"
+      end
+
+      def exec_update(sql, name, binds)
+        raise ActiveRecordError, "Update is not implemented for Google BigQuery"
+      end
+
+      def explain(sql, bind)
+        " -> {Explain not implemented}"
+      end
+
+      def lease
+        #TODO: NOt sure why this is needed
+      end
+
+      def columns(table, name = nil)
+        do_api do
+          puts "Calling columns for #{table}"
+          dataset, tablename = table.split(".")
+          response = api_connection.get("#{base_url}/datasets/#{dataset}/tables/#{tablename}")
+          JSON(response.body)['schema']['fields'].map do |field|
+            BQColumn.new(field["name"], nil, field["type"])
+          end
+        end
+      end
+
+      def table_exists?(table)
+        do_api do
+          puts "Calling table exists with #{table}"
+          dataset, tablename = table.split(".")
+          response = api_connection.get("#{base_url}/datasets/#{dataset}/tables/#{tablename}")
+          response.status == 200
+        end
+      end
+
+      def primary_key(table)
+        # TODO: Doesn't really apply for BQ
+        "id"
+      end
+
+      def schema_hash(table)
+        {
+          :schema => {
+            :fields => columns(table).map do |column|
+              { :name => column.name, :type => column.sql_type }
+            end
+          }
+        }
+      end
+
+      private
+        def do_api
+          attempt = 1
+          begin
+            yield if block_given?
+          rescue OAuth2::Error => e
+            if e.code["code"] == 401 && attempt < 2
+              puts "Auth failed: Attempting to reset token"
+              refresh_access_token
+              establish_api_connection
+              attempt += 1
+              retry
+            else
+              raise ActiveRecordError, e.code["message"]
+            end
+          end
+        end
+
+        def api_connection
+          @api_connection || establish_api_connection
+        end
+
+        def establish_api_connection
+          refresh_access_token if @token.blank?
+          @api_connection = OAuth2::AccessToken.new(@api_client_obj, @token)
+        end
+
+        def refresh_access_token
+          refresh_client_obj = OAuth2::Client.new(@client_id, @client_secret, {:site => 'https://accounts.google.com', :authorize_url => '/o/oauth2/auth', :token_url => '/o/oauth2/token'})
+          refresh_access_token_obj = OAuth2::AccessToken.new(refresh_client_obj, @token, {refresh_token: @refresh})
+          @token = refresh_access_token_obj.refresh!.token
+        end
+
+        def base_url
+          "/bigquery/v2/projects/#{@project_id}"
+        end
+    end
+  end
+end

data/lib/active_record/extra.rb

@@ -0,0 +1,7 @@
+require 'active_record/extra/bq'
+
+module ActiveRecord
+  class Base
+    extend ActiveRecord::Extra::BQ
+  end
+end

data/lib/active_record/extra/bq.rb

@@ -0,0 +1,34 @@
+require 'csv'
+require 'multipart_body'
+
+module ActiveRecord
+  module Extra
+    module BQ
+      # Can provide a CSV via the block
+      # Or specify a filename or URI
+      # 
+      def bq_append(options = {}, &block)
+        if block_given?
+          headers = columns.map(&:name)
+          # TODO: Validate row length (AND types?)
+          csv     = CSV.generate { |csv| yield(csv) }
+          data_part(csv)
+        end
+      end
+
+      # TODO: split these on table name
+      def table_id
+
+      end
+
+      def dataset_id
+
+      end
+
+      private
+        def data_part(csv)
+          Part.new(:body => csv, :content_type => "application/octet-stream")
+        end
+    end
+  end
+end

data/lib/activerecord-bq-adapter.rb

@@ -0,0 +1,13 @@
+
+require "arel/visitors/bind_visitor"
+require "activerecord-bq-adapter/version"
+require "active_record/connection_adapters/bq_adapter"
+
+require 'active_record/extra'
+
+module Activerecord
+  module Bq
+    module Adapter
+    end
+  end
+end

data/lib/activerecord-bq-adapter/version.rb

@@ -0,0 +1,7 @@
+module Activerecord
+  module Bq
+    module Adapter
+      VERSION = "0.0.1"
+    end
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-bq-adapter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dan Draper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multipart_body
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+description: Basic Implementation of an ActiveRecord Adapter for Google's Big Query.
+  Just handles queries right now. See TODO list in the Readme for whats coming.
+email:
+- daniel@codefire.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- activerecord-bq-adapter.gemspec
+- lib/active_record/connection_adapters/bq_adapter.rb
+- lib/active_record/extra.rb
+- lib/active_record/extra/bq.rb
+- lib/activerecord-bq-adapter.rb
+- lib/activerecord-bq-adapter/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Basic Implementation of an ActiveRecord Adapter for Google's Big Query
+test_files: []