metabase 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9cd5497b17c4b5f26ff1ca073954a7eceaeb791dc2c78e946ae00be1911004ad
+  data.tar.gz: 4c0f63527ff65f63c2a51ebec23b99d2b7ce2cdf42eb8023f7c1503efdf51b31
+SHA512:
+  metadata.gz: 28d3439dd61deb965936693503df407ec3e7c80232cfd881b29862323bb4442daecc32a201c7bea1dc3572b1916737c294a01a359e7adb678db50ea6adbbb45a
+  data.tar.gz: 539344d952ff67c4c2bcc7be1f7cbede918f4cb245c56e7e2ee978d49b9c6dd74f0cff828edc241b981e5213ef8792ab28da6089f5a4406f2d16a758728719f4

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/vendor/bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+    - '*.gemspec'
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - lib/metabase/error.rb
+
+Metrics/MethodLength:
+  Max: 20

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+rvm:
+  - 2.5
+  - 2.4
+  - 2.3
+
+script:
+  - bundle exec rubocop
+  - bundle exec rake spec
+
+cache: bundler
+
+branches:
+  only:
+    - master
+
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: .
+  specs:
+    metabase (0.2.0)
+      faraday (~> 0.8)
+      faraday_middleware
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    awesome_print (1.8.0)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    faraday (0.15.2)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
+    hashdiff (0.3.7)
+    json (2.1.0)
+    method_source (0.9.0)
+    multipart-post (2.0.0)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.2)
+    rainbow (3.0.0)
+    rake (12.3.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.56.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    safe_yaml (1.0.4)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.3.2)
+    vcr (4.0.0)
+    webmock (3.4.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    yard (0.9.12)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bundler
+  metabase!
+  pry
+  rake
+  rspec
+  rubocop
+  simplecov
+  vcr
+  webmock
+  yard
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Hiroshi Shimoju
+
+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,82 @@
+# Metabase Ruby Client
+
+Ruby client library for Metabase API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'metabase'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install metabase
+```
+
+## Usage
+
+### Authentication
+
+```ruby
+client = Metabase::Client.new(
+  url: 'https://example.com',
+  username: 'mb@example.com',
+  password: 'p@ssw0rd'
+)
+
+# Authenticate
+client.login
+
+# Fetch the current user
+client.current_user
+```
+
+Or specify valid session token:
+
+```ruby
+client = Metabase::Client.new(
+  url: 'https://example.com',
+  token: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
+)
+
+client.current_user
+```
+
+### Query results
+
+```ruby
+# Fetch query results of the card
+card_id = 1
+client.query_card(card_id)
+
+# Specify export format (csv, json, xlsx)
+client.query_card(card_id, format: :csv)
+
+# Fetch query results of the public card
+card_uuid = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
+client.query_public_card(card_uuid)
+client.query_public_card(card_uuid, format: :csv)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` 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.
+
+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/shimoju/metabase-ruby.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'metabase'
+require 'pry'
+
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/docker-compose.yml

@@ -0,0 +1,29 @@
+version: '3'
+services:
+  metabase:
+    image: metabase/metabase:v0.29.3
+    environment:
+      MB_DB_TYPE: postgres
+      MB_DB_DBNAME: metabase
+      MB_DB_PORT: 5432
+      MB_DB_USER: postgres
+      MB_DB_PASS: NOmEh1tcxKojeDAY6bV5icFpuhEp0xUkhykvynNTPc7bTiOKIyjk2O3IYmEmvfIK
+      MB_DB_HOST: db
+      MB_PASSWORD_COMPLEXITY: normal
+      MB_PASSWORD_LENGTH: 8
+      MB_ENCRYPTION_SECRET_KEY: JjN8BPWVlGoDTtifSbgP12GC8wsVUQni3nocbhiCsEgIldsmGNn6yRrqZDMJSQxO
+    ports:
+      - 3030:3000
+    depends_on:
+      - db
+
+  db:
+    image: postgres:10-alpine
+    environment:
+      POSTGRES_DB: metabase
+      POSTGRES_PASSWORD: NOmEh1tcxKojeDAY6bV5icFpuhEp0xUkhykvynNTPc7bTiOKIyjk2O3IYmEmvfIK
+    volumes:
+      - postgres:/var/lib/postgresql/data
+
+volumes:
+  postgres:

data/lib/metabase.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'metabase/version'
+require 'metabase/client'
+
+module Metabase
+end

data/lib/metabase/client.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'metabase/connection'
+require 'metabase/endpoint'
+
+module Metabase
+  class Client
+    include Connection
+    include Endpoint
+
+    def initialize(url:, username: nil, password: nil, token: nil)
+      @url = url
+      @username = username
+      @password = password
+      @token = token
+    end
+  end
+end

data/lib/metabase/connection.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+require 'metabase/error'
+
+module Metabase
+  module Connection
+    def get(path, **params)
+      request(:get, path, params)
+    end
+
+    def post(path, **params)
+      request(:post, path, params)
+    end
+
+    def put(path, **params)
+      request(:put, path, params)
+    end
+
+    def delete(path, **params)
+      request(:delete, path, params)
+    end
+
+    def head(path, **params)
+      request(:head, path, params)
+    end
+
+    private
+
+    def request(method, path, params)
+      response = connection.public_send(method, path, params) do |request|
+        request.headers['X-Metabase-Session'] = @token if @token
+      end
+
+      error = Error.from_response(response)
+      raise error if error
+      response.body
+    end
+
+    def connection
+      @connection ||= Faraday.new(url: @url) do |c|
+        c.request :json
+        c.response :json, content_type: /\bjson$/
+        c.adapter Faraday.default_adapter
+        c.headers['User-Agent'] =
+          "MetabaseRuby/#{VERSION} (#{RUBY_ENGINE}#{RUBY_VERSION})"
+      end
+    end
+  end
+end

data/lib/metabase/endpoint.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'metabase/endpoint/activity'
+require 'metabase/endpoint/alert'
+require 'metabase/endpoint/async'
+require 'metabase/endpoint/card'
+require 'metabase/endpoint/collection'
+require 'metabase/endpoint/dashboard'
+require 'metabase/endpoint/database'
+require 'metabase/endpoint/metric'
+require 'metabase/endpoint/permissions'
+require 'metabase/endpoint/public'
+require 'metabase/endpoint/pulse'
+require 'metabase/endpoint/revision'
+require 'metabase/endpoint/segment'
+require 'metabase/endpoint/session'
+require 'metabase/endpoint/setting'
+require 'metabase/endpoint/setup'
+require 'metabase/endpoint/table'
+require 'metabase/endpoint/user'
+require 'metabase/endpoint/util'
+require 'metabase/endpoint/x_ray'
+
+module Metabase
+  module Endpoint
+    include Activity
+    include Alert
+    include Async
+    include Card
+    include Collection
+    include Dashboard
+    include Database
+    include Metric
+    include Permissions
+    include Public
+    include Pulse
+    include Revision
+    include Segment
+    include Session
+    include Setting
+    include Setup
+    include Table
+    include User
+    include Util
+    include XRay
+  end
+end

data/lib/metabase/endpoint/activity.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metabase
+  module Endpoint
+    module Activity
+      #
+      # @param params [Hash] Query string
+      # @return [Array<Hash>] Parsed response JSON
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apiactivity
+      def activities(**params)
+        get('/api/activity', params)
+      end
+    end
+  end
+end

data/lib/metabase/endpoint/alert.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metabase
+  module Endpoint
+    module Alert
+      #
+      # @param params [Hash] Query string
+      # @return [Array<Hash>] Parsed response JSON
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apialert
+      def alerts(**params)
+        get('/api/alert', params)
+      end
+    end
+  end
+end

data/lib/metabase/endpoint/async.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metabase
+  module Endpoint
+    module Async
+      #
+      # @param params [Hash] Query string
+      # @return [Array<Integer>] Parsed response JSON
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apiasyncrunning-jobs
+      def running_jobs(**params)
+        get('/api/async/running-jobs', params)
+      end
+    end
+  end
+end

data/lib/metabase/endpoint/card.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Metabase
+  module Endpoint
+    module Card
+      #
+      # @param params [Hash] Query string
+      # @return [Array<Hash>] Parsed response JSON
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apicard
+      def cards(**params)
+        get('/api/card', params)
+      end
+
+      #
+      # @param card_id [Integer, String] Card ID
+      # @param params [Hash] Query string
+      # @return [Hash] Parsed response JSON
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apicardid
+      def card(card_id, **params)
+        get("/api/card/#{card_id}", params)
+      end
+
+      #
+      # @param card_id [Integer, String] Card ID
+      # @param params [Hash] Request body
+      # @return [Hash] Parsed response JSON
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#post-apicardcard-idquery
+      def query_card_with_metadata(card_id, **params)
+        post("/api/card/#{card_id}/query", params)
+      end
+
+      #
+      # @param card_id [Integer, String] Card ID
+      # @param format [Symbol, String] Export format (csv, json, xlsx)
+      # @param params [Hash] Request body
+      # @return [Array<Hash>, String] Query results
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#post-apicardcard-idqueryexport-format
+      def query_card(card_id, format: :json, **params)
+        post("/api/card/#{card_id}/query/#{format}", params)
+      end
+    end
+  end
+end

data/lib/metabase/endpoint/collection.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metabase
+  module Endpoint
+    module Collection
+      #
+      # @param params [Hash] Query string
+      # @return [Array<Hash>] Parsed response JSON
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apicollection
+      def collections(**params)
+        get('/api/collection', params)
+      end
+    end
+  end
+end

data/lib/metabase/endpoint/dashboard.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metabase
+  module Endpoint
+    module Dashboard
+      #
+      # @param params [Hash] Query string
+      # @return [Array<Hash>] Parsed response JSON
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apidashboard
+      def dashboards(**params)
+        get('/api/dashboard', params)
+      end
+    end
+  end
+end

data/lib/metabase/endpoint/database.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metabase
+  module Endpoint
+    module Database
+      #
+      # @param params [Hash] Query string
+      # @return [Array<Hash>] Parsed response JSON
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apidatabase
+      def databases(**params)
+        get('/api/database', params)
+      end
+    end
+  end
+end

data/lib/metabase/endpoint/metric.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metabase
+  module Endpoint
+    module Metric
+      #
+      # @param params [Hash] Query string
+      # @return [Array<Hash>] Parsed response JSON
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apimetric
+      def metrics(**params)
+        get('/api/metric', params)
+      end
+    end
+  end
+end

data/lib/metabase/endpoint/permissions.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metabase
+  module Endpoint
+    module Permissions
+      #
+      # @param params [Hash] Query string
+      # @return [Array<Hash>] Parsed response JSON
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apipermissionsgroup
+      def groups(**params)
+        get('/api/permissions/group', params)
+      end
+    end
+  end
+end

data/lib/metabase/endpoint/public.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Metabase
+  module Endpoint
+    module Public
+      #
+      # @param card_uuid [String] Card UUID
+      # @param params [Hash] Query string
+      # @return [Hash] Parsed response JSON
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apipubliccarduuid
+      def public_card(card_uuid, **params)
+        get("/api/public/card/#{card_uuid}", params)
+      end
+
+      #
+      # @param card_uuid [String] Card UUID
+      # @param params [Hash] Query string
+      # @return [Hash] Parsed response JSON
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apipubliccarduuidquery
+      def query_public_card_with_metadata(card_uuid, **params)
+        get("/api/public/card/#{card_uuid}/query", params)
+      end
+
+      #
+      # @param card_uuid [String] Card UUID
+      # @param format [Symbol, String] Export format (csv, json, xlsx)
+      # @param params [Hash] Query string
+      # @return [Array<Hash>, String] Query results
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apipubliccarduuidqueryexport-format
+      def query_public_card(card_uuid, format: :json, **params)
+        get("/api/public/card/#{card_uuid}/query/#{format}", params)
+      end
+    end
+  end
+end

data/lib/metabase/endpoint/pulse.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metabase
+  module Endpoint
+    module Pulse
+      #
+      # @param params [Hash] Query string
+      # @return [Array<Hash>] Parsed response JSON
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apipulse
+      def pulses(**params)
+        get('/api/pulse', params)
+      end
+    end
+  end
+end

data/lib/metabase/endpoint/revision.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metabase
+  module Endpoint
+    module Revision
+      #
+      # @param params [Hash] Query string
+      # @return [Array<Hash>] Parsed response JSON
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apirevision
+      def revisions(**params)
+        get('/api/revision', params)
+      end
+    end
+  end
+end

data/lib/metabase/endpoint/segment.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metabase
+  module Endpoint
+    module Segment
+      #
+      # @param params [Hash] Query string
+      # @return [Array<Hash>] Parsed response JSON
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apisegment
+      def segments(**params)
+        get('/api/segment', params)
+      end
+    end
+  end
+end

data/lib/metabase/endpoint/session.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Metabase
+  module Endpoint
+    module Session
+      # Login to Metabase.
+      #
+      # @param params [Hash] Request body
+      # @return [String] Session token
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#post-apisession
+      def login(**params)
+        params = { username: @username, password: @password }.merge(params)
+        response = post('/api/session', params)
+        @token = response['id']
+      end
+
+      #
+      # @param params [Hash] Request body
+      # @return [true] Always returns true
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#delete-apisession
+      def logout(**params)
+        params = { session_id: @token }.merge(params)
+        delete('/api/session', params)
+        @token = nil
+        true
+      end
+    end
+  end
+end

data/lib/metabase/endpoint/setting.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metabase
+  module Endpoint
+    module Setting
+      #
+      # @param params [Hash] Query string
+      # @return [Array<Hash>] Parsed response JSON
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apisetting
+      def settings(**params)
+        get('/api/setting', params)
+      end
+    end
+  end
+end

data/lib/metabase/endpoint/setup.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metabase
+  module Endpoint
+    module Setup
+      #
+      # @param params [Hash] Query string
+      # @return [Array<Hash>] Parsed response JSON
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apisetupadmin_checklist
+      def admin_checklists(**params)
+        get('/api/setup/admin_checklist', params)
+      end
+    end
+  end
+end

data/lib/metabase/endpoint/table.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metabase
+  module Endpoint
+    module Table
+      #
+      # @param params [Hash] Query string
+      # @return [Array<Hash>] Parsed response JSON
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apitable
+      def tables(**params)
+        get('/api/table', params)
+      end
+    end
+  end
+end

data/lib/metabase/endpoint/user.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metabase
+  module Endpoint
+    module User
+      #
+      # @param params [Hash] Query string
+      # @return [Array<Hash>] Parsed response JSON
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apiuser
+      def users(**params)
+        get('/api/user', params)
+      end
+
+      #
+      # @param params [Hash] Query string
+      # @return [Hash] Parsed response JSON
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apiusercurrent
+      def current_user(**params)
+        get('/api/user/current', params)
+      end
+    end
+  end
+end

data/lib/metabase/endpoint/util.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metabase
+  module Endpoint
+    module Util
+      #
+      # @param params [Hash] Query string
+      # @return [Array<String>] Parsed response JSON
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apiutillogs
+      def logs(**params)
+        get('/api/util/logs', params)
+      end
+    end
+  end
+end

data/lib/metabase/endpoint/x_ray.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Metabase
+  module Endpoint
+    module XRay
+      #
+      # @param card_id [Integer, String] Card ID
+      # @param params [Hash] Query string
+      # @return [Hash] Parsed response JSON
+      # @see https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apix-raycardid
+      def x_ray_card(card_id, **params)
+        get("/api/x-ray/card/#{card_id}", params)
+      end
+    end
+  end
+end

data/lib/metabase/error.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Metabase
+  class Error < StandardError
+    def self.from_response(response)
+      klass =
+        case response.status
+        when 400 then BadRequest
+        when 401 then Unauthorized
+        when 403 then Forbidden
+        when 404 then NotFound
+        when 400..499 then ClientError
+        when 500 then InternalServerError
+        when 502 then BadGateway
+        when 503 then ServiceUnavailable
+        when 500..599 then ServerError
+        end
+      klass&.new(response)
+    end
+
+    def initialize(response = nil)
+      @response = response
+      super(build_error_message)
+    end
+
+    private
+
+    def build_error_message
+      return nil if @response.nil?
+
+      "#{@response.env.method.upcase} #{@response.env.url}: " \
+      "#{@response.status} - #{@response.body}"
+    end
+  end
+
+  class ClientError < Error; end
+  class BadRequest < Error; end
+  class Unauthorized < Error; end
+  class Forbidden < Error; end
+  class NotFound < Error; end
+
+  class ServerError < Error; end
+  class InternalServerError < Error; end
+  class BadGateway < Error; end
+  class ServiceUnavailable < Error; end
+end

data/lib/metabase/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Metabase
+  VERSION = '0.2.0'
+end

data/metabase.gemspec

@@ -0,0 +1,41 @@
+
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'metabase/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'metabase'
+  spec.version       = Metabase::VERSION
+  spec.authors       = ['Hiroshi Shimoju']
+  spec.email         = ['hiroshi.shimoju@gmail.com']
+
+  spec.summary       = 'Ruby client library for Metabase API'
+  spec.description   = 'Ruby client library for Metabase API'
+  spec.homepage      = 'https://github.com/shimoju/metabase-ruby'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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']
+
+  spec.required_ruby_version = '>= 2.3'
+
+  spec.add_runtime_dependency 'faraday', '~> 0.8'
+  spec.add_runtime_dependency 'faraday_middleware'
+
+  spec.add_development_dependency 'awesome_print'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'yard'
+end

metadata

@@ -0,0 +1,251 @@
+--- !ruby/object:Gem::Specification
+name: metabase
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Hiroshi Shimoju
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  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: awesome_print
+  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: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: rubocop
+  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: simplecov
+  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: vcr
+  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: webmock
+  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: yard
+  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: Ruby client library for Metabase API
+email:
+- hiroshi.shimoju@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- lib/metabase.rb
+- lib/metabase/client.rb
+- lib/metabase/connection.rb
+- lib/metabase/endpoint.rb
+- lib/metabase/endpoint/activity.rb
+- lib/metabase/endpoint/alert.rb
+- lib/metabase/endpoint/async.rb
+- lib/metabase/endpoint/card.rb
+- lib/metabase/endpoint/collection.rb
+- lib/metabase/endpoint/dashboard.rb
+- lib/metabase/endpoint/database.rb
+- lib/metabase/endpoint/metric.rb
+- lib/metabase/endpoint/permissions.rb
+- lib/metabase/endpoint/public.rb
+- lib/metabase/endpoint/pulse.rb
+- lib/metabase/endpoint/revision.rb
+- lib/metabase/endpoint/segment.rb
+- lib/metabase/endpoint/session.rb
+- lib/metabase/endpoint/setting.rb
+- lib/metabase/endpoint/setup.rb
+- lib/metabase/endpoint/table.rb
+- lib/metabase/endpoint/user.rb
+- lib/metabase/endpoint/util.rb
+- lib/metabase/endpoint/x_ray.rb
+- lib/metabase/error.rb
+- lib/metabase/version.rb
+- metabase.gemspec
+homepage: https://github.com/shimoju/metabase-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.7
+signing_key: 
+specification_version: 4
+summary: Ruby client library for Metabase API
+test_files: []