redash_rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5269cd78babd83be129e45972e43e7b9868422f5b063da0736565e26eeac626b
+  data.tar.gz: 6e84bc25bc8976227bc836505b791792a13377b9285e20265c7e397e7aed1b52
+SHA512:
+  metadata.gz: dca18f3cd22bc8d39b623d197e2feec1d4556933f9d54e59f30f312360d6269f3acbb5d9241477ce02e5a326f398ea8d0c955cb48f910decfa0bb2b363048daa
+  data.tar.gz: 5269aba43574f995d5ad4b446723e96a5320493dc0fd4bc6143da94a73859bf572eece5f77aeb068a64386848c5c2601c92d86a642ce4ff3f176c28303563c29

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mkawasaki@sbihg.co.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in redash_rb.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    redash_rb (0.1.0)
+      faraday
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    multipart-post (2.1.1)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  redash_rb!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Masumi Kawasaki
+
+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,62 @@
+# RedashRb
+
+[![Build Status](https://travis-ci.org/geeknees/redash_rb.svg?branch=master)](https://travis-ci.org/geeknees/redash_rb)
+
+A Ruby client for Redash APIs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redash_rb'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install redash_rb
+
+## Usage
+
+#### Configure 
+
+```ruby
+require 'redash_rb'
+
+Redash.configure do | config |
+   config.host = 'https://app.redash.io/<slug>'
+   config.api_token = '<api_token>'
+end
+```
+
+#### API call
+
+```ruby
+client = Redash.client
+client.get('api/queries')
+```
+
+
+
+## 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/[USERNAME]/redash_rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/redash_rb/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RedashRb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/redash_rb/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'redash'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

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/lib/redash.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'redash/client'
+require 'redash/configuration'
+
+module Redash
+  module ClassMethods
+    def client
+      @client ||= Client.new(config)
+    end
+
+    def client=(new_client)
+      @client = new_client
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield config
+    end
+  end
+
+  extend ClassMethods
+end

data/lib/redash/client.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'redash/query'
+
+require 'faraday'
+require 'json'
+
+module Redash
+  class Client
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    # for recent API, please check the follwings
+    # https://github.com/getredash/redash/blob/master/redash/handlers/api.py
+    def get(uri, params = {})
+      connection.get(uri, params)
+    end
+
+    def connection
+      @connection ||= build_connection
+    end
+
+    def queries
+      res_queries = JSON.parse(get('api/queries').body)
+      queries = []
+      res_queries['results'].each do |q|
+        q = Redash::Query.new(q)
+        queries << q
+      end
+
+      queries
+    end
+
+    private
+
+    def build_connection
+      Faraday.new(url: config.host) do |builder|
+        builder.authorization('Key', config.api_token) if config.api_token
+        builder.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/redash/configuration.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module Redash
+  class Configuration
+    attr_accessor :host
+    attr_accessor :api_token
+  end
+end

data/lib/redash/query.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Redash
+  class Query
+    attr_accessor :id, :latest_query_data_id, :name,
+                  :description, :query, :query_hash, :schedule,
+                  :api_key, :is_archived, :is_draft,
+                  :updated_at, :created_at
+
+    def initialize(attrs = {})
+      @id = attrs['id']
+      @latest_query_data_id = attrs['latest_query_data_id']
+      @name = attrs['name']
+      @description = attrs['description']
+      @query = attrs['query']
+      @query_hash = attrs['query_hash']
+      @schedule = attrs['schedule']
+      @api_key = attrs['api_key']
+      @is_archived = attrs['is_archived']
+      @is_draft = attrs['is_draft']
+      @updated_at = attrs['updated_at']
+      @created_at = attrs['created_at']
+    end
+  end
+end

data/lib/redash/version.rb

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

data/redash_rb.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/redash/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redash_rb"
+  spec.version       = Redash::VERSION
+  spec.authors       = ["Masumi Kawasaki"]
+  spec.email         = ["mkawasaki@sbihg.co.jp"]
+
+  spec.summary       = %q{Redash API Client.}
+  spec.description   = %q{Redash API Wrapper wirtten in ruby.}
+  spec.homepage      = "https://github.com/geeknees/redash_rb"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/geeknees/redash_rb"
+  spec.metadata["changelog_uri"] = "https://github.com/geeknees/redash_rb"
+
+  # 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"]
+  spec.add_dependency 'faraday'
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: redash_rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masumi Kawasaki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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'
+description: Redash API Wrapper wirtten in ruby.
+email:
+- mkawasaki@sbihg.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/redash.rb
+- lib/redash/client.rb
+- lib/redash/configuration.rb
+- lib/redash/query.rb
+- lib/redash/version.rb
+- redash_rb.gemspec
+homepage: https://github.com/geeknees/redash_rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/geeknees/redash_rb
+  source_code_uri: https://github.com/geeknees/redash_rb
+  changelog_uri: https://github.com/geeknees/redash_rb
+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: Redash API Client.
+test_files: []