blazer_json_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f9997698b1f7539ecc259833efc06cb6b673c3afe970113ce6f898218392bd4f
+  data.tar.gz: 025bf36ee3a803271b062446c4b7b1bbba2eae9b9ed8f5c59e0e87a92d10c0e9
+SHA512:
+  metadata.gz: e557025ae1c358e7bcc0d3aac99bed5968b0ab4af95bd3e10fb55ca7f959fc06c10f2d169916635db75125c35e857a9c940d613e5557d2fd85f25536f199e569
+  data.tar.gz: 9dc9425a8908209ae17b4148ac82115db3122c283bacab2d1b64819a2cefff0b183da4637cb9ec65ecf6f534a42a3cd2ec1e22e3cb8efe6b690df02be546cd25

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 john.farrell
+
+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,55 @@
+# Blazer JSON API
+An extension to [Blazer](https://github.com/ankane/blazer) to enable exposing your queries as JSON via API so it can be consumed outside of Blazer by your application.
+
+## Features
+- **Powered by SQL** Author APIs quickly using Blazers IDE. Particular useful for private/internal APIs that fall outside of your standard API endpoints
+- **No deploy APIs** Expermental APIs can be authored quickly via Blazer without the need to do a deploy
+- **Flexible structure** JSON response structure can be controlled directly in SQL by using a column naming convention (double underscore denotes a nesting by default, but can be overridden)
+- **Security** You'll likely want to lock down API access so APIs are authenticated separately to standard Blazer authentication using HTTP basic authentication to avoid granding everyone with access to Blazer also access to your APIs. 
+- **URL parameters** URL parameters are also supported built on Blazers query variables meaning the APIs can be highly dynamic and flexible
+- **Pagination** Pagination can be controlled using query variables in combination with limits and offsets
+- **Multiple data sources** Blazer supports multiple datasources meaning you can potentially build APIs that access beyond the applications database (e.g. ElasticSearch, Google BigQuery, Salesforce)
+
+## Installation
+Follow the installation steps described to get Blazer up and running.
+Then, add this line to your application's Gemfile:
+
+```ruby
+gem 'blazer_json_api'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+And mount the engine in your `config/routes.rb`:
+
+```ruby
+mount BlazerJsonAPI, at: 'blazer-api'
+```
+
+Configure authentication in an initializer as follows (e.g. in `initializers/blazer_json_api.rb`)
+
+```ruby
+BlazerJsonAPI::Config.username = <api-username>
+BlazerJsonAPI::Config.password = <api-password>
+```
+
+## Usage
+Create queries as normal via Blazer and use the query identifier to render the JSON via the mounted location. 
+
+e.g. `/blazer-api/queries/1-all-users`
+
+### Example queries
+
+
+> TODO
+
+## Contributing
+
+
+> TODO
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BlazerJsonApi'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/blazer_json_api_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/blazer_json_api .js
+//= link_directory ../stylesheets/blazer_json_api .css

data/app/assets/javascripts/blazer_json_api/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/blazer_json_api/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/blazer_json_api/application_controller.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module BlazerJsonAPI
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+
+    def record_not_found
+      render json: [], status: :not_found
+    end
+
+    def render_errors(error_messages)
+      render json: { errors: error_messages }, status: :bad_request
+    end
+  end
+end

data/app/controllers/blazer_json_api/queries_controller.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module BlazerJsonAPI
+  class QueriesController < ApplicationController
+    if BlazerJsonAPI::Config.username && BlazerJsonAPI::Config.password
+      http_basic_authenticate_with name: BlazerJsonAPI::Config.username, password: BlazerJsonAPI::Config.password
+    end
+    before_action :set_query
+
+    def show
+      @statement = @query.statement
+      data_source = @query.data_source
+      process_variables(@statement, data_source)
+      result = Blazer.data_sources[data_source].run_statement(@statement)
+
+      if result.error.present?
+        render_errors(Array(result.error))
+      else
+        render json: BlazerJsonAPI::ResultToNestedJson.new(@statement, result).call
+      end
+    end
+
+    private
+
+    def set_query
+      @query = Blazer::Query.find_by(id: params[:id].to_s.split('-').first)
+      record_not_found && return if @query.blank?
+    end
+
+    def process_variables(statement, data_source)
+      BlazerJsonAPI::ProcessStatementVariables.new(statement, data_source, params).call
+    end
+  end
+end

data/app/helpers/blazer_json_api/application_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module BlazerJsonAPI
+  module ApplicationHelper
+  end
+end

data/app/jobs/blazer_json_api/application_job.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module BlazerJsonAPI
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/blazer_json_api/application_mailer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module BlazerJsonAPI
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/blazer_json_api/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module BlazerJsonAPI
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/blazer_json_api/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Blazer json api</title>
+  <%= stylesheet_link_tag    "blazer_json_api/application", media: "all" %>
+  <%= javascript_include_tag "blazer_json_api/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+BlazerJsonAPI::Engine.routes.draw do
+  resources :queries, only: :show
+end

data/lib/blazer_json_api/config.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module BlazerJsonAPI
+  class Config
+    # defaults
+    @@nesting_column_separator = '__'
+
+    cattr_accessor :username
+    cattr_accessor :password
+    cattr_accessor :nesting_column_separator
+  end
+end

data/lib/blazer_json_api/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module BlazerJsonAPI
+  class Engine < ::Rails::Engine
+    isolate_namespace BlazerJsonAPI
+  end
+end

data/lib/blazer_json_api/process_statement_variables.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# Taken from: https://github.com/ankane/blazer/blob/ac7e02e0fe19ee6c0bc8c7f3ba87be0d260f8255/app/controllers/blazer/base_controller.rb#L35
+# Necessary for processing any query variables safely
+# Refactored to avoid rubocop breaches
+module BlazerJsonAPI
+  class ProcessStatementVariables
+    attr_reader :statement, :data_source, :params
+
+    def initialize(statement, data_source, params)
+      @statement = statement
+      @data_source = data_source
+      @params = params
+    end
+
+    def call
+      return unless bind_variables.all? { |v| params[v] }
+
+      bind_variables.each do |variable|
+        value = params[variable].presence
+        if value
+          if variable.end_with?('_at')
+            begin
+              value = Blazer.time_zone.parse(value)
+            rescue StandardError
+              # do nothing
+            end
+          end
+
+          if /\A\d+\z/.match?(value.to_s)
+            value = value.to_i
+          elsif /\A\d+\.\d+\z/.match?(value.to_s)
+            value = value.to_f
+          end
+        end
+        if Blazer.transform_variable
+          value = Blazer.transform_variable.call(variable, value)
+      end
+        statement.gsub!("{#{variable}}", ActiveRecord::Base.connection.quote(value))
+      end
+    end
+
+    private
+
+    def bind_variables
+      @bind_variables ||=
+        begin
+          (bind_variables ||= []).concat(Blazer.extract_vars(statement)).uniq!
+          bind_variables.each do |variable|
+            params[variable] ||= Blazer.data_sources[data_source].variable_defaults[variable]
+          end
+        end
+    end
+  end
+end

data/lib/blazer_json_api/result_to_nested_json.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# Converts a blazer query result table into nested JSON
+# Used the convention of a double underscore in the column header to denote a parent key or nesting
+# e.g. { 'parent__child': '1' } becomes { 'parent': { 'child': 1 }}
+module BlazerJsonAPI
+  class ResultToNestedJson
+    delegate :nesting_column_separator, to: BlazerJsonAPI::Config
+
+    attr_reader :statement, :blazer_result
+
+    def initialize(statement, blazer_result)
+      @statement = statement
+      @blazer_result = blazer_result
+    end
+
+    def call
+      transformed_result =
+        blazer_result_to_json(blazer_result).each do |hash|
+          hash.keys.select { |key| key =~ /#{nesting_column_separator}/ }.each do |namespaced_key|
+            nested_keys = namespaced_key.to_s.split(nesting_column_separator)
+            hash.deep_merge!(deep_hash_set(*nested_keys[0..nested_keys.size], hash[namespaced_key]))
+            hash.delete(namespaced_key)
+          end
+        end
+      collection_or_single_record(transformed_result)
+    end
+
+    private
+
+    def blazer_result_to_json(blazer_result)
+      blazer_result.rows.map do |row|
+        row_hash = {}
+        row.each_with_index do |value, value_index|
+          row_hash[blazer_result.columns[value_index]] = value
+        end
+        row_hash
+      end
+    end
+
+    # recursively sets a nested key in a hash (like the opposite to Hash.dig)
+    # e.g. deep_hash_set(*['a', 'b' , 'c'], 4)
+    # { a => { b => { c => 4 } } }
+    # @return Hash
+    def deep_hash_set(*keys, value)
+      keys.empty? ? value : { keys.first => deep_hash_set(*keys.drop(1), value) }
+    end
+
+    # Use the presence of LIMIT 1 in the query to decide whether to render
+    # a collection response (like an index)
+    # or a single entry response
+    def collection_or_single_record(result)
+      /LIMIT 1$/i.match?(statement) ? result.first : result
+    end
+  end
+end

data/lib/blazer_json_api/version.rb

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

data/lib/blazer_json_api.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'blazer_json_api/engine'
+require 'blazer_json_api/config'
+require 'blazer_json_api/process_statement_variables'
+require 'blazer_json_api/result_to_nested_json'
+
+module BlazerJsonAPI
+end

data/lib/tasks/blazer_json_api_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :blazer_json_api do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: blazer_json_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Farrell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: blazer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: An extension to the Blazer gem that makes it possible to expose queries
+  as APIs
+email:
+- john.m.farrell1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/blazer_json_api_manifest.js
+- app/assets/javascripts/blazer_json_api/application.js
+- app/assets/stylesheets/blazer_json_api/application.css
+- app/controllers/blazer_json_api/application_controller.rb
+- app/controllers/blazer_json_api/queries_controller.rb
+- app/helpers/blazer_json_api/application_helper.rb
+- app/jobs/blazer_json_api/application_job.rb
+- app/mailers/blazer_json_api/application_mailer.rb
+- app/models/blazer_json_api/application_record.rb
+- app/views/layouts/blazer_json_api/application.html.erb
+- config/routes.rb
+- lib/blazer_json_api.rb
+- lib/blazer_json_api/config.rb
+- lib/blazer_json_api/engine.rb
+- lib/blazer_json_api/process_statement_variables.rb
+- lib/blazer_json_api/result_to_nested_json.rb
+- lib/blazer_json_api/version.rb
+- lib/tasks/blazer_json_api_tasks.rake
+homepage: https://github.com/johnmfarrell1/blazer_json_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: An API extension to the Blazer gem
+test_files: []