redash_exporter 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 737f047c800fcf2a4ddef570240e665ddf925605ecd216d7c27de59499b89c41
-  data.tar.gz: f7a0bb91f8b5f1d49d4f48ce1d3a5749d671b38496314440e405473f1930ed70
+  metadata.gz: 9df27c1739f533ddd0180af3c1147d81de24e1a19ed2ef72823fbafe537aad01
+  data.tar.gz: 0f6c00ae307b88fe96c2b7335d6ab3d90926b703028c5617b0b7008f2dc08172
 SHA512:
-  metadata.gz: f741e0b0c0bf0cf5e5e085b6af55f2815afca8243220bb3f981f6b18637769e27e0fe89282063bd54ec1d8165678473dd048fbf324c85765b64ea036cc8af810
-  data.tar.gz: 02caec93eeeb6a7df11df2254f48844e3bfde1e1ccce30d1e74ffc2e61e18e250815da003a82e73a75d5b1f29b2c4bee53b09a5f542d33f9e11d83d41d0fdc9f
+  metadata.gz: 459db10a244e260a466ddd3c33ddcec5d5158fca5c7a4919e70f51cdf91ed6763da87704baf72e6bea94ec5cbdf4e038eb778e1d4a474c63596ae427da90e86f
+  data.tar.gz: 0a0660d9d9bae7edd4abfe652514f2735cad7bfa3d6f21c8d0b0cc6f0afe46c8d63e9a996693cf422c8748bf81272b179ca2f2a9b8592453c6bca1db2829bc1b

data/.gitignore

@@ -12,3 +12,4 @@
 .rspec_status
 .byebug_history
 *.sql
+tags

data/.rubocop.yml

@@ -0,0 +1,25 @@
+Style/AsciiComments:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassVars:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'exe/**/*'
+
+Style/StringLiterals:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 20

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/.travis.yml

@@ -3,5 +3,7 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.6.0
-before_install: gem install bundler -v 2.0.0
+  - 2.6.3
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

data/Gemfile

@@ -1,4 +1,5 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-# Specify your gem's dependencies in redash_exporter.gemspec
+source "https://rubygems.org"
 gemspec
+gem "coveralls", require: false

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    redash_exporter (0.2.0)
-      activesupport
-      zaru
+    redash_exporter (0.3.0)
+      activesupport (~> 5.2.3)
+      zaru (~> 0.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -13,12 +13,27 @@ GEM
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+    ast (2.4.0)
     byebug (11.0.1)
     concurrent-ruby (1.1.5)
+    coveralls (0.8.22)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
     diff-lcs (1.3)
+    docile (1.3.1)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.2)
+    json (2.2.0)
     minitest (5.11.3)
+    parallel (1.17.0)
+    parser (2.6.2.1)
+      ast (~> 2.4.0)
+    psych (3.1.0)
+    rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -33,20 +48,41 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    rubocop (0.67.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.10.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (0.19.4)
     thread_safe (0.3.6)
+    tins (1.20.2)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    zaru (0.3.0)
+    unicode-display_width (1.5.0)
+    zaru (0.1.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 2.0)
-  byebug
+  bundler
+  byebug (~> 11.0.1)
+  coveralls
   rake (~> 10.0)
   redash_exporter!
   rspec (~> 3.0)
+  rubocop (~> 0.67.2)
 
 BUNDLED WITH
-   2.0.0
+   1.17.2

data/README.md

@@ -1,4 +1,6 @@
 [![Gem Version](https://badge.fury.io/rb/redash_exporter.svg)](https://badge.fury.io/rb/redash_exporter)
+[![Build Status](https://travis-ci.org/oieioi/redash_exporter.svg?branch=master)](https://travis-ci.org/oieioi/redash_exporter)
+[![Coverage Status](https://coveralls.io/repos/github/oieioi/redash_exporter/badge.svg?branch=master)](https://coveralls.io/github/oieioi/redash_exporter?branch=master)
 
 # RedashExporter
 
@@ -26,9 +28,9 @@ Shell
 
     $ redash_exporter --redash-url "http://your-redash-domain.example/<slug>" --api-key="your_api_key"
 
-With destination path
+With destination path and force to overwrite existed files
 
-    $ redash_exporter --redash-url "http://your-redash-domain.example/<slug>" --api-key="your_api_key" --dest=destination_directory
+    $ redash_exporter --redash-url "http://your-redash-domain.example/<slug>" --api-key="your_api_key" --dest=destination_directory --overwrite
 
 in Ruby Script
 

data/Rakefile

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

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "redash_exporter"

data/exe/redash_exporter

@@ -3,7 +3,28 @@
 require 'redash_exporter'
 require 'optparse'
 
-params = ARGV.getopts('', 'redash-url:', 'api-key:', "dest:#{Dir.pwd}")
+params = ARGV.getopts('',
+                      'redash-url:',
+                      'api-key:',
+                      "dest:#{Dir.pwd}",
+                      "overwrite",
+                      "version")
+
+if params['version']
+  puts RedashExporter::VERSION
+  return
+end
+
+if params['redash-url'].nil?
+  puts "--redash-url required!"
+  return
+end
+
+if params['api-key'].nil?
+  puts "--api-key required!"
+  return
+end
+
 queries = RedashExporter::Queries.new(params['redash-url'], params['api-key'], params['dest'])
 queries.fetch
-queries.export_all
+queries.export_all(force: params['overwrite'])

data/lib/redash_exporter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "redash_exporter/version"
 require "redash_exporter/queries"
 

data/lib/redash_exporter/exporter.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RedashExporter
+  module Exporter
+    module_function
+
+    # Export a file.
+    #
+    # @param file_path [String]
+    # @param content [String]
+    # @param option [Hash] force: force to overwrite file. default false.
+    def export(file_path, content, option = {})
+      unless should_overwrite?(file_path, option)
+        puts "Not create #{file_path}."
+        return
+      end
+
+      File.open(file_path, 'w') do |file|
+        file.print content
+      end
+    end
+
+    def should_overwrite?(path, option = {})
+      return true if option[:force]
+      return true unless File.exist?(path)
+
+      puts "Overwrite #{path}? [yes(y), no(n)]"
+      should_overwrite = %w[yes y].include?(STDIN.gets.strip)
+
+      should_overwrite
+    end
+  end
+end

data/lib/redash_exporter/fetcher.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'net/https'
+require 'json'
+
+module RedashExporter
+  class Fetcher
+    def initialize(url, api_key, params = {})
+      @url = url.gsub(%r{/$}, '')
+      @api_key = api_key
+      @params = params
+    end
+
+    def fetch
+      result = []
+      has_more = true
+
+      while has_more
+        body = request("#{@url}?#{@params.to_param}")
+
+        # old web API returns all queries as an array
+        return body if body.is_a?(Array)
+
+        # new web API
+        result.push(*body[:results])
+
+        has_more = @params[:page].present? && result.size < body[:count]
+
+        # wait for next request
+        if has_more
+          @params[:page] += 1
+          sleep 0.5
+        end
+      end
+
+      result
+    end
+
+    private
+
+    def request(url)
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == 'https'
+      req = Net::HTTP::Get.new(uri.to_s, header)
+      res = http.request(req)
+
+      raise "Failed to fetch #{uri}" unless res.is_a?(Net::HTTPSuccess)
+
+      JSON.parse(res.body, symbolize_names: true)
+    end
+
+    def header
+      {
+        Authorization: "Key #{@api_key}"
+      }
+    end
+  end
+end

data/lib/redash_exporter/queries.rb

@@ -1,73 +1,41 @@
-require 'net/https'
-require 'json'
+# frozen_string_literal: true
+
 require 'forwardable'
 require 'active_support'
 require 'active_support/core_ext'
+require 'redash_exporter/fetcher'
 require 'redash_exporter/query'
 
 module RedashExporter
   class Queries
     extend Forwardable
     include Enumerable
-    attr_accessor :api_key, :url, :queries
+    attr_accessor :api_key, :redash_url, :queries
     def_delegators :@queries, :each, :size
 
-    def initialize(url, api_key, dest = "#{__dir__}/../../dest")
-      @url = url
-      @url = "#{@url}/" unless @url.end_with?('/')
+    ENDPOINT = "/api/queries"
+
+    def initialize(redash_url, api_key, dest = "#{__dir__}/../../dest")
+      @redash_url = redash_url.gsub(%r{/$}, '')
       @api_key = api_key
       @dest = dest
       @queries = []
+      @fetcher = Fetcher.new("#{@redash_url}#{ENDPOINT}", @api_key, page: 1, page_size: 250)
+    end
+
+    def fetch
+      @queries = @fetcher.fetch.map { |q| Query.new(q) }
     end
 
-    def export_all
+    def export_all(force: false)
       dest_dir_path = File.expand_path(@dest)
       puts "Export SQL Files to #{dest_dir_path}"
 
       @queries.each do |query|
-        query.export(dest_dir_path)
+        query.export(dir: dest_dir_path, force: force)
       end
-      puts "done. Check out #{dest_dir_path}"
-    end
-
-    def fetch
-      uri = URI.parse("#{@url}api/queries")
-      header = {
-        Authorization: "Key #{@api_key}"
-      }
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true if uri.scheme == 'https'
 
-      page = 1
-      page_size = 250
-
-      loop do
-        uri.query = "page=#{page}&page_size=#{page_size}"
-        req = Net::HTTP::Get.new(uri.to_s, header)
-        res = http.request(req)
-        body = JSON.parse(res.body, symbolize_names: true)
-
-        raise "Failed to fetch queries. URI: #{uri}" unless res.is_a?(Net::HTTPSuccess)
-
-        # old API returns all queries as an array
-        if body.is_a?(Array)
-          @queries = body.map { |q| Query.new(q) }
-          break
-        end
-
-        # new API
-        @queries.push(*body[:results].map { |q| Query.new(q) })
-
-        # next page
-        if @queries.size < body[:count]
-          page += 1
-          # wait...
-          sleep 0.5
-          next
-        end
-
-        break
-      end
+      puts "Done. Check out #{dest_dir_path}"
     end
 
     def reject!(*args, &block)

data/lib/redash_exporter/query.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 require 'active_support'
 require 'active_support/core_ext'
-require 'forwardable'
 require 'zaru'
+require 'redash_exporter/exporter'
 
 module RedashExporter
   class Query
-    extend Forwardable
-    attr_accessor :sort_key
+    attr_accessor :sort_key, :data
+    include Comparable
 
     def initialize(raw)
-      @data = raw.symbolize_keys
-      @sort_key = :retrieved_at
+      @data = raw.deep_symbolize_keys
+      @sort_key = :id
     end
 
     def [](key)
@@ -18,37 +20,29 @@ module RedashExporter
     end
 
     def to_s
-      <<~EOS
-      /**
-       * #{@data[:name]}
-       * created at #{@data[:created_at]}
-       * last updated at #{@data[:updated_at]}
-       * created by #{@data.dig(:user, :name)} (#{@data.dig(:user, :email)})
-       **/
-
-      #{@data[:query]}
-      EOS
+      <<~SQL
+        /**
+         * #{@data[:name]}
+         *
+         * created at #{@data[:created_at]}
+         * last updated at #{@data[:updated_at]}
+         * created by #{@data.dig(:user, :name)} (#{@data.dig(:user, :email)})
+         **/
+         #{@data[:query]}
+      SQL
     end
 
-    def <=>
-      @data[@sort_key] || -1
+    def to_json(*_args)
+      JSON.generate(@data)
     end
 
-    def export(dir = '.')
-      path = File.expand_path("#{dir}/#{file_name}")
+    def <=>(other)
+      self[@sort_key] <=> other[@sort_key]
+    end
 
-      if File.exist?(path)
-        puts "overwrite #{path} [yes(y),no(n)] ?"
-        ok = %w[yes y ok].include?(STDIN.gets.strip)
-        unless ok
-          puts "Not create #{path}."
-          return
-        end
-      end
-
-      File.open(path, 'w') do |file|
-        file.print to_s
-      end
+    def export(dir: '.', force: false, **)
+      path = File.expand_path("#{dir}/#{file_name}")
+      Exporter.export(path, to_s, force: force)
     end
 
     private

data/lib/redash_exporter/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RedashExporter
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/redash_exporter.gemspec

@@ -1,4 +1,6 @@
-lib = File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "redash_exporter/version"
 
@@ -8,24 +10,26 @@ Gem::Specification.new do |spec|
   spec.authors       = ["oieioi"]
   spec.email         = ["atsuinatsu.samuifuyu@gmail.com"]
 
-  spec.summary       = %q{Export Redash queries as files}
-  spec.description   = %q{Export Redash queries as files}
+  spec.summary       = 'Export Redash queries as files'
+  spec.description   = 'Export Redash queries as files'
   spec.homepage      = "https://github.com/oieioi/redash_exporter"
   spec.license       = "MIT"
 
   # 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
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) 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 "activesupport"
-  spec.add_dependency "zaru"
-  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_dependency "activesupport", "~> 5.2.3"
+  spec.add_dependency "zaru", "~> 0.1.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "byebug", "~> 11.0.1"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "rubocop", "~> 0.67.2"
 end

metadata

@@ -1,37 +1,51 @@
 --- !ruby/object:Gem::Specification
 name: redash_exporter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - oieioi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-24 00:00:00.000000000 Z
+date: 2019-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.2.3
 - !ruby/object:Gem::Dependency
   name: zaru
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -39,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 11.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 11.0.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -81,19 +95,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.67.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.67.2
 description: Export Redash queries as files
 email:
 - atsuinatsu.samuifuyu@gmail.com
@@ -104,6 +118,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -116,6 +132,8 @@ files:
 - dest/.keep
 - exe/redash_exporter
 - lib/redash_exporter.rb
+- lib/redash_exporter/exporter.rb
+- lib/redash_exporter/fetcher.rb
 - lib/redash_exporter/queries.rb
 - lib/redash_exporter/query.rb
 - lib/redash_exporter/version.rb
@@ -139,8 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 3.0.0.beta3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Export Redash queries as files