blazer_json_api 0.1.1i → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07fd9c9b0b687bb830f8fe5bf216282965a5e0bb9c2390a9cc05e9eb56d22e4b
-  data.tar.gz: 2c1d60956fbb7637d68c652764a50b39934ed7f2b9b080a95b0cfe9ec06a7b7b
+  metadata.gz: b6fe3871a2a73e0d9ca277c700e7ec943bb20e1bc99efb484419d7b9df31207b
+  data.tar.gz: 179dddb823192971bd0c44e4ef6d69c1055a64814567daa5fb4e6044f1c303e1
 SHA512:
-  metadata.gz: 3f791140000106082ba74cddb0d0aefc81f2e4184e51572effa03501ed4cedf399706d1a94c6e994ad1975ee52e901e67ad6de758ea4f324964ff542ddf06b1d
-  data.tar.gz: 9ab2a52d7ee5f1df8652c52dd238eb04937360f65977cbdada0893d377bb9ac4685917f8508b42cb4e15b0b9bf6b9e559465408504504eac8e1bef6bdbfb41e1
+  metadata.gz: 747f31b055917096f5e155bab0e9b4629a9a83ac1ca9978f70007831336ca7eac69848628a59fa9e957ec041864f9d052a2f9df618824b109b4f38f54f5eaa97
+  data.tar.gz: 34835c4db9ec8a8af5db3300cc8f21a18836b4b8251458ffa77b8f74bfcc82eadac5cd29b28131966721b788d87f0bacb6b0cb4f2c12cd992211cb6e9ad62682

data/README.md

@@ -1,18 +1,20 @@
 # 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.
+An extension to [Blazer](https://github.com/ankane/blazer) to enable exposing your queries as JSON via API, so that they can be consumed outside of Blazer by your application.
+Use Blazer for powering in app charts using a charting library of your choice.
 
 ## Features
-- **Powered by SQL** Author APIs quickly using Blazers SQL based IDE. Particular useful for private/internal APIs that fall outside of your standard API endpoints
-- **No deploy APIs** Expermental APIs can be authored and iterated on quickly via Blazer without the need to do a deploy.
+- **Powered by SQL** Author APIs quickly using Blazers SQL based IDE. Particular useful for private/internal APIs that fall outside your standard API endpoints or where responses need to be taylored to suit a specific charting library.
+- **No deploy APIs** Experimental APIs can be authored and iterated on quickly via Blazer without the need to do a deploy. Were a team is split between frontend and backend, this greatly increases collaboration and speed.
 - **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 the standard Blazer auth model, so authentication is enabled using HTTP basic authentication to avoid granding everyone with access to Blazer also access to your APIs. 
+- **Security** You'll likely want to lock down API access so APIs are authenticated separately to the standard Blazer auth model, so authentication is enabled using HTTP basic authentication to avoid granting everyone with access to Blazer also access to your APIs.
 - **URL parameters** URL parameters are also supported via 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 data sources meaning you can potentially build APIs that access beyond the applications database (e.g. ElasticSearch, Google BigQuery, Salesforce)
-- **Permissions** Use Blazers [basic permissions mode](https://github.com/ankane/blazer#query-permissions) with your own naming conventions to control access to APIs based queries.
+- **Multiple data sources** Blazer supports multiple data sources meaning you can potentially build APIs that access beyond the applications' database (e.g. ElasticSearch, Google BigQuery, SalesForce etc)
+- **Permissions** Use Blazers [basic permissions mode](https://github.com/ankane/blazer#query-permissions) with your own naming conventions to control access and visibility of API based queries.
 
 ## Installation
 Follow the installation steps described to get [Blazer](https://github.com/ankane/blazer#installation) up and running.
+
 Then, add this line to your application's Gemfile:
 
 ```ruby
@@ -27,22 +29,40 @@ $ bundle
 And mount the engine in your `config/routes.rb`:
 
 ```ruby
-mount Blazer::Api::Engine, at: 'blazer-api'
+mount BlazerJsonAPI::Engine, at: 'blazer-api'
 ```
 
-Configure authentication in an initializer as follows (e.g. in `initializers/blazer_api.rb`)
+## Authentication
+
+Don’t forget to protect your Blazer APIs in production.
+
+### Basic authentication
+Configure authentication in an initializer as follows (e.g. in `initializers/blazer_json_api.rb`)
 
 ```ruby
-Blazer::Api::Config.username = <api-username>
-Blazer::Api::Config.password = <api-password>
+BlazerJsonAPI.configure do |config|
+  config.username = 'api-username'
+  config.password = 'api-password'
+end
+```
+
+### Devise
+Or alternatively, if you use devise, you can conditionally mount the engine using a policy or some user roles.
+
+```ruby
+authenticate :user, ->(user) { user.admin? } do
+  mount BlazerJsonAPI::Engine, at: 'blazer-api'
+end
 ```
 
 ## Usage
-Create queries as normal via Blazer and use the query identifier to render the JSON via the mounted location. 
+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` or `/blazer-api/queries/1`
+
 URL params can be added where necessary also
-e.g. `/blazer-api/queries/1-all-users?page=1&per_page=30`
+
+e.g. `/blazer-api/queries/1-all-users?username=blazer_user`
 
 ### Example queries
 
@@ -56,29 +76,29 @@ FROM users
 This would result in the following API response
 ```json
 [
-   {
-      "id":1,
-      "username":"blazer_tommy",
-      "first_name":"Tom",
-      "last_name":"Carey",
-      "email":"tom.carey@gmail.com",
-      "country":"Ireland"
-   },
-   {
-      "id":2,
-      "username":"blazer_john",
-      "first_name":"John",
-      "last_name":"Doyle",
-      "email":"john.doyle@gmail.com",
-      "country":"USA"
-   }
-  // ...
+  {
+    "id":1,
+    "username":"blazer_tommy",
+    "first_name":"Tom",
+    "last_name":"Carey",
+    "email":"tom.carey@gmail.com",
+    "country":"Ireland"
+  },
+  {
+    "id":2,
+    "username":"blazer_john",
+    "first_name":"John",
+    "last_name":"Doyle",
+    "email":"john.doyle@gmail.com",
+    "country":"USA"
+  }
 ]
 ```
 #### A simple single resource GET request using a variable
 
 Using a variable, a specific resource can be fetched.
-Note: the use of `LIMIT 1` can be used to be explicit in desiring a single record in the response, as opposed to a collection
+
+**Note:** the use of `LIMIT 1` can be used to be explicit in desiring a single record in the response, as opposed to a collection
 
 ```sql
 SELECT id, username, first_name, last_name, email, country
@@ -87,19 +107,28 @@ WHERE username={username}
 LIMIT 1
 ```
 Now, the username can be passed as a URL parameter to the API to fetch the relevant record.
+
+e.g. `/blazer-api/queries/1-all-users?username=blazer_john`
+
 It would result in the following response.
-```json
-{
-  "id":2,
-  "username":"blazer_john",
-  "first_name":"John",
-  "last_name":"Doyle",
-  "email":"john.doyle@gmail.com",
-  "country":"USA"
-}
+
+#### Using a variable/url parameter conditionally (e.g. optional filter)
+
+It's possible to make a filter optional directly in SQL as follows
+
+```sql
+SELECT id, username, first_name, last_name, email, country
+FROM users
+WHERE {username} IS NULL OR username={username}
 ```
+
+In this scenario, the url parameter/filter for `username` is optional. 
+
+If provided it will apply the filter, if not provided, it will return an unfiltered response.
+
 #### Controlling response structure
 Standard queries return flat JSON responses that correspond to the results table from executing the SQL.
+
 It's possible to control the JSON structure by using double underscores to denote the desired nesting
 
 Take, for example, the following query:
@@ -142,6 +171,7 @@ Deeper nesting is also possible, just continue the pattern e.g. `a__deeper__nest
 
 #### Paginating potentially large responses
 If your query could return a large response, it's generally a good idea to paginate it.
+
 Pagination can be achieved in many ways, but a basic example can be done as follows using a combination
 of variables in the query and `LIMIT` and `OFFSET`.
 
@@ -152,9 +182,11 @@ LIMIT {per_page}
 OFFSET ({page}-1)*{per_page}
 ```
 Using this technique, URL params can be used by the requester to control pagination.
+
 In this example, `page` corresponds to the desired page in the paginated collection and `per_page` corresponds to the desired size of records in each page
 
 This technique can be used in combination with some default settings for these parameters in blazers config file `blazer.yml`.
+
 Having defaults means if they are not specified by the requester, the defaults will automatically be applied.
 ```yaml
     variable_defaults:
@@ -163,6 +195,17 @@ Having defaults means if they are not specified by the requester, the defaults w
       page: 1
 ```
 
+Requests can then be as follows:
+
+`/blazer-api/queries/1-all-users` = returns first 30 users (pagination defaults apply automatically)
+
+`/blazer-api/queries/1-all-users?page=2` = returns second page containing 30 users
+
+`/blazer-api/queries/1-all-users?page=1&per_page=90` = returns first page containing 90 users
+
+
+etc...
+
 ## Contributing
 Want to improve this library, please do!
 

data/Rakefile

@@ -10,7 +10,7 @@ require 'rdoc/task'
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Blazer::Api'
+  rdoc.title    = 'BlazerJsonApi'
   rdoc.options << '--line-numbers'
   rdoc.rdoc_files.include('README.md')
   rdoc.rdoc_files.include('lib/**/*.rb')

data/app/assets/config/blazer_json_api_manifest.js

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

data/app/controllers/blazer_json_api/application_controller.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module BlazerJsonAPI
+  class ApplicationController < ActionController::Base
+
+    if BlazerJsonAPI.credentials_provided?
+      http_basic_authenticate_with name: BlazerJsonAPI.username, password: BlazerJsonAPI.password
+    end
+
+    protect_from_forgery with: :exception
+
+    def record_not_found
+      render json: [], status: :not_found
+    end
+
+    def render_errors(error_messages, status: :bad_request)
+      render json: { errors: error_messages }, status: status
+    end
+  end
+end

data/app/controllers/blazer_json_api/queries_controller.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module BlazerJsonAPI
+  class QueriesController < BlazerJsonAPI::ApplicationController
+    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

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

data/lib/blazer_json_api/configuration.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module BlazerJsonAPI
+  module Configuration
+
+    VALID_OPTIONS_KEYS = %i[username password nesting_column_separator].freeze
+
+    DEFAULT_USERNAME = nil
+    DEFAULT_PASSWORD = nil
+    DEFAULT_NESTING_COLUMN_SEPARATOR = '__'.freeze
+
+    attr_accessor(*VALID_OPTIONS_KEYS)
+
+    def self.extended(base)
+      base.reset_config!
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    # e.g. in an initializer for the application
+    def configure
+      yield self
+    end
+
+    def credentials_provided?
+      username.present? && password.present?
+    end
+
+    def reset_config!
+      self.username     = DEFAULT_USERNAME
+      self.password     = DEFAULT_PASSWORD
+      self.nesting_column_separator  = DEFAULT_NESTING_COLUMN_SEPARATOR
+    end
+  end
+end

data/lib/blazer_json_api/engine.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module BlazerJsonAPI
+  class Engine < ::Rails::Engine
+    isolate_namespace BlazerJsonAPI
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/blazer_json_api/process_statement_variables.rb

@@ -0,0 +1,53 @@
+# 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
+      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
+
+    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.4'
+end

data/lib/blazer_json_api.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'blazer_json_api/engine'
+require 'blazer_json_api/configuration'
+require 'blazer_json_api/process_statement_variables'
+require 'blazer_json_api/result_to_nested_json'
+
+module BlazerJsonAPI
+  extend BlazerJsonAPI::Configuration
+end

data/spec/rails_helper.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+require 'spec_helper'
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../config/environment', __dir__)
+# Prevent database truncation if the environment is production
+if Rails.env.production?
+  abort('The Rails environment is running in production mode!')
+end
+require 'rspec/rails'
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+# Dir[Rails.root.join('spec', 'support', '**', '*.rb')].sort.each do |f|
+#   require f
+# end
+
+# Checks for pending migrations and applies them before tests are run.
+# If you are not using ActiveRecord, you can remove these lines.
+begin
+  ActiveRecord::Migration.maintain_test_schema!
+rescue ActiveRecord::PendingMigrationError => e
+  puts e.to_s.strip
+  exit 1
+end
+RSpec.configure do |config|
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # You can uncomment this line to turn off ActiveRecord support entirely.
+  # config.use_active_record = false
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, type: :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+
+  # Filter lines from Rails gems in backtraces.
+  config.filter_rails_from_backtrace!
+  # arbitrary gems may also be filtered via:
+  # config.filter_gems_from_backtrace("gem name")
+end

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+# This file was generated by the `rails generate rspec:install` command.
+# Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # This allows you to limit a spec run to individual examples or groups
+  #   # you care about by tagging them with `:focus` metadata. When nothing
+  #   # is tagged with `:focus`, all examples get run. RSpec also provides
+  #   # aliases for `it`, `describe`, and `context` that include `:focus`
+  #   # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  #   config.filter_run_when_matching :focus
+  #
+  #   # Allows RSpec to persist some state between runs in order to support
+  #   # the `--only-failures` and `--next-failure` CLI options. We recommend
+  #   # you configure your source control system to ignore this file.
+  #   config.example_status_persistence_file_path = "spec/examples.txt"
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended. For more details, see:
+  #   #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  #   config.disable_monkey_patching!
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = "doc"
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by
+  #   # providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically
+  #   # reproduce
+  #   # test failures related to randomization by passing the same `--seed`
+  #   # value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: blazer_json_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1i
+  version: 0.1.4
 platform: ruby
 authors:
 - John Farrell
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-03 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: blazer
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '5'
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: blazer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -55,7 +55,7 @@ dependencies:
 description: An extension to the Blazer gem that makes it possible to expose queries
   as APIs
 email:
-- john.m.farrell1@gmail.com
+- john.farrell@andopen.co
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -64,28 +64,30 @@ files:
 - README.md
 - Rakefile
 - app/assets/config/blazer_json_api_manifest.js
-- app/assets/javascripts/blazer/api/application.js
-- app/assets/stylesheets/blazer/api/application.css
-- app/controllers/blazer/api/application_controller.rb
-- app/controllers/blazer/api/queries_controller.rb
-- app/helpers/blazer/api/application_helper.rb
-- app/jobs/blazer/api/application_job.rb
-- app/mailers/blazer/api/application_mailer.rb
-- app/models/blazer/api/application_record.rb
-- app/views/layouts/blazer/api/application.html.erb
+- 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/api.rb
-- lib/blazer/api/config.rb
-- lib/blazer/api/engine.rb
-- lib/blazer/api/process_statement_variables.rb
-- lib/blazer/api/result_to_nested_json.rb
-- lib/blazer/api/version.rb
+- lib/blazer_json_api.rb
+- lib/blazer_json_api/configuration.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
+- spec/rails_helper.rb
+- spec/spec_helper.rb
+homepage: https://gitlab.com/andopen/blazer_json_api
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -96,12 +98,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: An API extension to the Blazer gem
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/rails_helper.rb

data/app/controllers/blazer/api/application_controller.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Blazer
-  module Api
-    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
-end

data/app/controllers/blazer/api/queries_controller.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Blazer
-  module Api
-    class QueriesController < ApplicationController
-      if Blazer::Api::Config.username && Blazer::Api::Config.password
-        http_basic_authenticate_with name: Blazer::Api::Config.username, password: Blazer::Api::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: Blazer::Api::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)
-        Blazer::Api::ProcessStatementVariables.new(statement, data_source, params).call
-      end
-    end
-  end
-end

data/app/helpers/blazer/api/application_helper.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module Blazer
-  module Api
-    module ApplicationHelper
-    end
-  end
-end

data/app/jobs/blazer/api/application_job.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module Blazer
-  module Api
-    class ApplicationJob < ActiveJob::Base
-    end
-  end
-end

data/app/mailers/blazer/api/application_mailer.rb

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

data/app/models/blazer/api/application_record.rb

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

data/app/views/layouts/blazer/api/application.html.erb

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

data/lib/blazer/api/config.rb

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

data/lib/blazer/api/engine.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Blazer
-  module Api
-    class Engine < ::Rails::Engine
-      isolate_namespace Blazer::Api
-    end
-  end
-end

data/lib/blazer/api/process_statement_variables.rb

@@ -1,55 +0,0 @@
-# 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 Blazer
-  module Api
-    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
-          value = Blazer.transform_variable.call(variable, value) if Blazer.transform_variable
-          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
-end

data/lib/blazer/api/result_to_nested_json.rb

@@ -1,58 +0,0 @@
-# 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 Blazer
-  module Api
-    class ResultToNestedJson
-      delegate :nesting_column_separator, to: Blazer::Api::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
-end

data/lib/blazer/api/version.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Blazer
-  module Api
-    VERSION = '0.1.1i'
-  end
-end

data/lib/blazer/api.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require 'blazer/api'
-require 'blazer/api/engine'
-require 'blazer/api/config'
-require 'blazer/api/process_statement_variables'
-require 'blazer/api/result_to_nested_json'
-
-module Blazer
-  module Api
-  end
-end