bigquery-client 0.1.0

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/.ruby-version
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+
+script: bundle exec rake test

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Tsukuru Tanimichi
+
+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,53 @@
+# BigQuery Client [![Build Status](https://travis-ci.org/ttanimichi/bigquery-client.png)](https://travis-ci.org/ttanimichi/bigquery-client)
+
+A Ruby interface to the BigQuery API.
+
+## Installation
+
+```
+% gem install bigquery-client
+```
+
+## Usage
+
+```ruby
+require "bigquery-client"
+
+client = BigQuery::Client.new(
+  project:                "your-project-42",
+  dataset:                "your_dataset",
+  email:                  "1234567890@developer.gserviceaccount.com",
+  private_key_path:       "/path/to/keyfile.p12",
+  private_key_passphrase: "notasecret",
+  auth_method:            "private_key"
+)
+
+# insert
+client.insert("your_table", uid: "john", age: 42)
+
+# insert multiple rows
+rows = [
+  { uid: "foo", age: 43 },
+  { uid: "bar", age: 44 }
+]
+client.insert("your_table", rows)
+
+# create table
+schema = [
+  { name: "foo", type: "timestamp" },
+  { name: "bar", type: "string"    }
+]
+client.create_table("new_table", schema)
+
+# fetch schema
+client.fetch_schema("your_table")
+#=> [{"name"=>"uid", "type"=>"STRING"}, {"name"=>"age", "type"=>"INTEGER"}]
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/ttanimichi/bigquery-client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am "Add some feature"`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) { |task| task.libs << 'test' }
+task default: :test

data/bigquery-client.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bigquery-client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bigquery-client'
+  spec.version       = BigQuery::Client::VERSION
+  spec.authors       = ['Tsukuru Tanimichi']
+  spec.email         = ['ttanimichi@hotmail.com']
+  spec.summary       = 'A Ruby interface to the BigQuery API.'
+  spec.homepage      = 'https://github.com/ttanimichi/bigquery-client'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_runtime_dependency 'google-api-client', '~> 0.8.0'
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rr'
+  spec.add_development_dependency 'test-unit', '~> 3.0.2'
+  spec.add_development_dependency 'test-unit-rr', '~> 1.0.3'
+end

data/lib/bigquery-client.rb

@@ -0,0 +1,3 @@
+require 'bigquery-client/client'
+require 'bigquery-client/errors'
+require 'bigquery-client/version'

data/lib/bigquery-client/client.rb

@@ -0,0 +1,112 @@
+require 'json'
+require 'google/api_client'
+require 'google/api_client/client_secrets'
+require 'google/api_client/auth/installed_app'
+require 'google/api_client/auth/compute_service_account'
+
+module BigQuery
+  class Client
+    def initialize(attributes = {})
+      attributes.each { |name, value| instance_variable_set("@#{name}", value) }
+    end
+
+    def insert(table, args)
+      rows = args.is_a?(Array) ? args : [args]
+      result = access_api(
+        api_method: bigquery.tabledata.insert_all,
+        parameters: {
+          tableId: table
+        },
+        body_object: {
+          rows: rows.map { |row| { json: row } }
+        }
+      )
+      handle_error(result) if result.error?
+    end
+
+    def create_table(name, schema)
+      result = access_api(
+        api_method: bigquery.tables.insert,
+        body_object: {
+          tableReference: {
+            tableId: name
+          },
+          schema: {
+            fields: schema
+          }
+        }
+      )
+      handle_error(result) if result.error?
+    end
+
+    def fetch_schema(table)
+      result = access_api(
+        api_method: bigquery.tables.get,
+        parameters: {
+          tableId: table
+        }
+      )
+      handle_error(result) if result.error?
+      JSON.parse(result.body)['schema']['fields']
+    end
+
+    private
+
+    def access_api(params = {})
+      params[:parameters] ||= {}
+      params[:parameters][:projectId] ||= @project
+      params[:parameters][:datasetId] ||= @dataset
+      client.execute(params)
+    end
+
+    def bigquery
+      @bigquery ||= client.discovered_api('bigquery', 'v2')
+    end
+
+    def handle_error(result)
+      @client = nil
+      error =
+        case result.status
+        when 404      then NotFound
+        when 409      then Conflict
+        when 400..499 then ClientError
+        when 500..599 then ServerError
+        else UnexpectedError
+        end
+      fail error, result.error_message
+    end
+
+    def client
+      @client = nil if expired?
+      unless @client
+        @client = Google::APIClient.new(
+          application_name:    'bigquery-client',
+          application_version: BigQuery::Client::VERSION
+        )
+        authorize_client
+        @expiration = Time.now + 1800
+      end
+      @client
+    end
+
+    def expired?
+      @expiration && @expiration < Time.now
+    end
+
+    def authorize_client
+      case @auth_method
+      when 'private_key'
+        asserter = Google::APIClient::JWTAsserter.new(
+          @email,
+          'https://www.googleapis.com/auth/bigquery',
+          Google::APIClient::PKCS12.load_key(@private_key_path, @private_key_passphrase)
+        )
+        @client.authorization = asserter.authorize
+      when 'compute_engine'
+        auth = Google::APIClient::ComputeServiceAccount.new
+        auth.fetch_access_token!
+        @client.authorization = auth
+      end
+    end
+  end
+end

data/lib/bigquery-client/errors.rb

@@ -0,0 +1,23 @@
+module BigQuery
+  class APIError < StandardError
+  end
+
+  # HTTP 4xx Client Error
+  class ClientError < APIError
+  end
+
+  # HTTP 404 Not Found
+  class NotFound < ClientError
+  end
+
+  # HTTP 409 Conflict
+  class Conflict < ClientError
+  end
+
+  # HTTP 5xx Server Error
+  class ServerError < APIError
+  end
+
+  class UnexpectedError < APIError
+  end
+end

data/lib/bigquery-client/version.rb

@@ -0,0 +1,5 @@
+module BigQuery
+  class Client
+    VERSION = '0.1.0'
+  end
+end

data/test/helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'bigquery-client'
+require 'test/unit'
+require 'test/unit/rr'
+require 'rr'

data/test/test_client.rb

@@ -0,0 +1,171 @@
+require 'helper'
+
+class ClientTest < Test::Unit::TestCase
+  def setup
+    @client = BigQuery::Client.new(
+      project:                '1234567890',
+      dataset:                'my_dataset',
+      email:                  '1234567890@developer.gserviceaccount.com',
+      private_key_path:       '/path/to/keyfile.p12',
+      private_key_passphrase: 'itsasecret',
+      auth_method:            'private_key'
+    )
+  end
+
+  def test_initialize
+    actual = @client.instance_variables
+    expected = [:@project, :@dataset, :@email, :@private_key_path, :@private_key_passphrase, :@auth_method]
+    assert { actual.sort == expected.sort }
+  end
+
+  def test_create_table
+    params = {
+      api_method: 'create_table',
+      body_object: {
+        tableReference: {
+          tableId: 'my_table'
+        },
+        schema: {
+          fields: [
+            { name: 'foo', type: 'timestamp' },
+            { name: 'bar', type: 'string' }
+          ]
+        }
+      },
+      parameters: {
+        projectId: '1234567890',
+        datasetId: 'my_dataset'
+      }
+    }
+    auth = Object.new
+    mock(client = Object.new) do |client|
+      client.discovered_api('bigquery', 'v2') { mock!.tables.mock!.insert { 'create_table' } }
+      client.execute(params) { mock(Object.new).error? { false } }
+      client.authorization = auth
+    end
+    mock(Google::APIClient).new.with_any_args { client }
+    mock(Google::APIClient::JWTAsserter).new.with_any_args { mock(Object.new).authorize { auth } }
+    mock(Google::APIClient::PKCS12).load_key('/path/to/keyfile.p12', 'itsasecret')
+    schema = [{name: 'foo', type: 'timestamp'}, { name: 'bar', type: 'string'}]
+    assert { @client.create_table('my_table', schema).nil? }
+  end
+
+  def test_insert
+    params = {
+      api_method: 'insert_all',
+      parameters: {
+        projectId: '1234567890',
+        datasetId: 'my_dataset',
+        tableId:   'my_table'
+      },
+      body_object: {
+        rows: [ { json: { a: 'b', c: 'd' } } ]
+      }
+    }
+    auth = Object.new
+    mock(client = Object.new) do |client|
+      client.discovered_api('bigquery', 'v2') { mock!.tabledata.mock!.insert_all { 'insert_all' } }
+      client.execute(params) { mock(Object.new).error? { false } }
+      client.authorization = auth
+    end
+    mock(Google::APIClient).new.with_any_args { client }
+    mock(Google::APIClient::JWTAsserter).new.with_any_args { mock(Object.new).authorize { auth } }
+    mock(Google::APIClient::PKCS12).load_key('/path/to/keyfile.p12', 'itsasecret')
+    assert { @client.insert('my_table', a: 'b', c: 'd').nil? }
+  end
+
+  def test_insert_rows
+    params = {
+      api_method: 'insert_all',
+      parameters: {
+        projectId: '1234567890',
+        datasetId: 'my_dataset',
+        tableId:   'my_table'
+      },
+      body_object: {
+        rows: [
+          { json: { 'a' => 'b' } },
+          { json: { 'b' => 'c' } }
+        ]
+      }
+    }
+    auth = Object.new
+    mock(client = Object.new) do |client|
+      client.discovered_api('bigquery', 'v2') { mock!.tabledata.mock!.insert_all { 'insert_all' } }
+      client.execute(params) { mock(Object.new).error? { false } }
+      client.authorization = auth
+    end
+    mock(Google::APIClient).new.with_any_args { client }
+    mock(Google::APIClient::JWTAsserter).new.with_any_args { mock(Object.new).authorize { auth } }
+    mock(Google::APIClient::PKCS12).load_key('/path/to/keyfile.p12', 'itsasecret')
+    rows = [{'a' => 'b'}, {'b' => 'c'}]
+    assert { @client.insert('my_table', rows).nil? }
+  end
+
+  def test_fetch_schema
+    params = {
+      api_method: 'tables_get',
+      parameters: {
+        tableId:   'my_table',
+        projectId: '1234567890',
+        datasetId: 'my_dataset'
+      }
+    }
+    result_body = JSON.generate(
+      {
+        schema: {
+          fields: [
+            { name: 'time', type: 'TIMESTAMP' },
+            { name: 'tty',  type: 'STRING'    }
+          ]
+        }
+      }
+    )
+    auth = Object.new
+    mock(result = Object.new) do |result|
+      result.error? { false }
+      result.body   { result_body }
+    end
+    mock(client = Object.new) do |client|
+      client.discovered_api('bigquery', 'v2') { mock!.tables.mock!.get { 'tables_get' } }
+      client.execute(params) { result }
+      client.authorization = auth
+    end
+    mock(Google::APIClient).new.with_any_args { client }
+    mock(Google::APIClient::JWTAsserter).new.with_any_args { mock(Object.new).authorize { auth } }
+    mock(Google::APIClient::PKCS12).load_key('/path/to/keyfile.p12', 'itsasecret')
+    expected = [
+      { 'name' => 'time', 'type' => 'TIMESTAMP' },
+      { 'name' => 'tty',  'type' => 'STRING'    }
+    ]
+    assert { @client.fetch_schema('my_table') == expected }
+  end
+
+  def test_errors
+    errors = [
+      { code: 404, klass: BigQuery::NotFound        },
+      { code: 409, klass: BigQuery::Conflict        },
+      { code: 403, klass: BigQuery::ClientError     },
+      { code: 503, klass: BigQuery::ServerError     },
+      { code: 301, klass: BigQuery::UnexpectedError }
+    ]
+    errors.each do |error|
+      auth = Object.new
+      mock(result = Object.new) do |result|
+        result.error?        { true }
+        result.status        { error[:code] }
+        result.error_message { 'this is an error message' }
+      end
+      mock(client = Object.new) do |client|
+        client.execute.with_any_args { result }
+        client.authorization = auth
+      end
+      mock(@client).bigquery { mock!.tabledata.mock!.insert_all }
+      mock(Google::APIClient).new.with_any_args { client }
+      mock(Google::APIClient::JWTAsserter).new.with_any_args { mock(Object.new).authorize { auth } }
+      mock(Google::APIClient::PKCS12).load_key('/path/to/keyfile.p12', 'itsasecret')
+      rows = [{'a' => 'b'}, {'b' => 'c'}]
+      assert_raise(error[:klass]) { @client.insert('my_table', rows) }
+    end
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: bigquery-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Tsukuru Tanimichi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+- !ruby/object:Gem::Dependency
+  name: test-unit-rr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+description: 
+email:
+- ttanimichi@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bigquery-client.gemspec
+- lib/bigquery-client.rb
+- lib/bigquery-client/client.rb
+- lib/bigquery-client/errors.rb
+- lib/bigquery-client/version.rb
+- test/helper.rb
+- test/test_client.rb
+homepage: https://github.com/ttanimichi/bigquery-client
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1636212372983959579
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: A Ruby interface to the BigQuery API.
+test_files:
+- test/helper.rb
+- test/test_client.rb