blazer-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e1f2c550cd4bef18a7a24b6f0a5bdef4a09bc7562248482345373d07c99d67fd
+  data.tar.gz: 847126aaa8b0ea5877a6be9102efe236784fa50c6c2f22ffbf8563d8b7ee276e
+SHA512:
+  metadata.gz: 6d1ddfdbf1c8fd04884136f053f0268d5d10976b63eb7b581fef9c75c65ef9067fe4e00029f2347883d7b04413890a00c3ae674926b280011ac870f81335b0f8
+  data.tar.gz: b408655c63ffd491d184fdd28847b0ea5de4d9e34ffc457b4728680b0c87800cccd712e7bab1d3354428afa784c46a6393f8040e855b2afae97f290cfa0a70ce

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Francisco Martins
+
+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,50 @@
+# Blazer::Api
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'blazer-api'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+We use the same env var that blazer uses to connect the database:
+
+```ruby
+ENV["BLAZER_DATABASE_URL"] = "postgres://user:password@hostname:5432/database"
+```
+
+Optionaly, you can create a initializer to handle authentication:
+
+```ruby
+# config/initializers/blazer-api.rb
+
+Blazer::Api.configure do |config|
+  config.authentication = -> (token, options) {
+    Admin.find_by(api_key: token)
+  }
+end
+```
+
+And mount on `config/routes.rb`:
+
+```ruby
+Rails.application.routes.draw do
+  mount Blazer::Api::Engine, at: 'blazer-api'
+  ...
+end
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,24 @@
+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    = 'Blazer::Api'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+

data/app/assets/config/blazer_api_manifest.js

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

data/app/assets/javascripts/blazer/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/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/api/application_controller.rb

@@ -0,0 +1,29 @@
+module Blazer
+  module Api
+    class ApplicationController < ActionController::Base
+      include ActionController::HttpAuthentication::Token::ControllerMethods
+
+      protect_from_forgery with: :exception
+      before_action :authenticate
+
+      delegate :db, :authentication, to: :configuration
+
+      def authenticate
+        authenticate_with_http_token do |token, options|
+          authentication.call(token, options)
+        end || render_unauthorized
+      end
+
+      private
+
+      def render_unauthorized
+        self.headers["WWW-Authenticate"] = "Token realm=\"Application\""
+        render json: { error: 'Bad credentials' }, status: :unauthorized
+      end
+
+      def configuration
+        Blazer::Api.configuration
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Blazer
+  module Api
+    class QueriesController < ApplicationController
+      def show
+        hashes = Blazer::Api.configuration.db[
+          Blazer::Query.find(params[:id]).statement
+        ].all
+
+        render json: JSON.generate(hashes)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+module Blazer
+  module Api
+    module ApplicationHelper
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+module Blazer
+  module Api
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+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

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

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Blazer 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/config/routes.rb

@@ -0,0 +1,3 @@
+Blazer::Api::Engine.routes.draw do
+  resources :queries, only: :show
+end

data/lib/blazer/api.rb

@@ -0,0 +1,15 @@
+require "blazer/api/engine"
+require "blazer/api/configuration"
+require "sequel"
+
+module Blazer
+  module Api
+    class << self
+      attr_accessor :configuration
+      def configure
+        self.configuration ||= Blazer::Api::Configuration.new
+        yield(configuration)
+      end
+    end
+  end
+end

data/lib/blazer/api/configuration.rb

@@ -0,0 +1,11 @@
+module Blazer
+  module Api
+    class Configuration
+      attr_accessor :authentication
+
+      def db
+        @db ||= Sequel.connect(ENV['BLAZER_DATABASE_URL'])
+      end
+    end
+  end
+end

data/lib/blazer/api/engine.rb

@@ -0,0 +1,13 @@
+module Blazer
+  module Api
+    class Engine < ::Rails::Engine
+      isolate_namespace Blazer::Api
+
+      config.generators do |g|
+        # g.test_framework :rspec
+        # g.fixture_replacement :factory_bot, dir: 'spec/factories'
+        g.assets false
+      end
+    end
+  end
+end

data/lib/blazer/api/version.rb

@@ -0,0 +1,5 @@
+module Blazer
+  module Api
+    VERSION = '0.1.0'
+  end
+end

data/lib/tasks/blazer/api_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :blazer_api do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: blazer-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Francisco Martins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: blazer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  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: pg
+  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: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: 
+email:
+- franciscomxs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/blazer_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
+- config/routes.rb
+- lib/blazer/api.rb
+- lib/blazer/api/configuration.rb
+- lib/blazer/api/engine.rb
+- lib/blazer/api/version.rb
+- lib/tasks/blazer/api_tasks.rake
+homepage: https://github.com/franciscomxs/blazer-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: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Add a JSON API to Blazer
+test_files: []