tetadata 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 01d95b1b040821a885b16f288d8d8959a2f49850177048324e829b84378ca0c9
+  data.tar.gz: 92895f5ad1eb193a896d63948b5f077609c6916fab113e674f0e8b6495ebb985
+SHA512:
+  metadata.gz: 9ae99df7f8a94e9e4db8c9f1ad3801fe3d0cdfb263dc89660d87abb3cec360bddd3f140f6b8a1532d7437430187b801ac3899c67cb4a62e7f50c499ff15b3785
+  data.tar.gz: 70e7c28638e5b6c998d7e3c634508ce219d26fb0221c35a8b296e47324981a6e7aff3ae63076ad6b5601565a5b53a815e73635c896aec1cef0b562854a49dbfa

data/README.md

@@ -0,0 +1,28 @@
+# Metadatastore
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'metadatastore'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install metadatastore
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,22 @@
+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    = 'Metadatastore'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/controllers/concerns/exception_handlers.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ExceptionHandlers
+  def self.included(base)
+    base.instance_eval do
+
+      rescue_from ActiveRecord::RecordInvalid do |e|
+        record = e.record
+        class_name = record.model_name.singular
+        errors = record.errors.api_messages.map { |err| "#{class_name}.#{err}" }
+        errors_response(errors)
+      end
+
+      rescue_from ActiveRecord::RecordNotFound do |_e|
+        error_response("record.not_found", 404)
+      end
+    end
+  end
+end

data/app/controllers/concerns/jwt_payload.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module JWTPayload
+  def jwt_payload
+    @jwt_payload ||= request.env.fetch("jwt.payload", {}).symbolize_keys
+  end
+
+  def uid
+    jwt_payload[:uid]
+  end
+
+  def email
+    jwt_payload[:email]
+  end
+
+  def role
+    jwt_payload[:role]
+  end
+end

data/app/controllers/concerns/response.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Response
+  def json_response(object, status=:ok)
+    render json: object, status: status
+  end
+
+  def error_response(error, status=422)
+    data = "#{controller_namespace}.#{error}"
+    json_response({errors: [data]}, status)
+  end
+
+  def errors_response(errors, status=422)
+    data = errors.map { |error| "#{controller_namespace}.#{error}" }
+    json_response({errors: data}, status)
+  end
+
+  def not_found
+    render plain: "404 Not Found", status: 404
+  end
+
+  def controller_namespace
+    self.class.module_parent.name.split("::").last.underscore
+  end
+end

data/app/controllers/metadatastore/api/v2/admin/base_controller.rb

@@ -0,0 +1,22 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+module Metadatastore
+  module API
+    module V2
+      module Admin
+        class BaseController < ApplicationController
+          include JWTPayload
+
+          ADMIN_ROLES = %w[superadmin admin accountant compliance support technical].freeze
+
+          before_action :authorize_admin!
+
+          def authorize_admin!
+            not_found unless role.to_s.in?(ADMIN_ROLES)
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/metadatastore/api/v2/admin/metadata_controller.rb

@@ -0,0 +1,45 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+module Metadatastore
+  module API
+    module V2
+      module Admin
+        class MetadataController < BaseController
+          def index
+            json_response(Metadata.all, 200)
+          end
+
+          def search
+            json_response(Metadata.find_by!(key: params[:key]))
+          end
+
+          def create
+            metadata = Metadata.new(key: params[:key], value: JSON.parse(params[:value]))
+            metadata.save!
+
+            json_response(metadata, 201)
+          rescue JSON::ParserError => _e
+            json_response(error_response("metadata.invalid_metadata_value"), 422)
+          end
+
+          def update
+            metadata = Metadata.find_by!(key: params[:key])
+
+            metadata.update!(value: JSON.parse(sale_params['value']))
+
+            json_response(metadata, 200)
+          rescue JSON::ParserError => _e
+            json_response(error_response("metadata.invalid_metadata_value"), 422)
+          end
+
+          private
+
+          def sale_params
+            params.permit(:key, :value)
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/metadatastore/api/v2/public/base_controller.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+module Metadatastore
+  module API
+    module V2
+      module Public
+        class BaseController < ApplicationController
+        end
+      end
+    end
+  end
+end

data/app/controllers/metadatastore/api/v2/public/metadata_controller.rb

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+module Metadatastore
+  module API
+    module V2
+      module Public
+        class MetadataController < BaseController
+          def index
+            json_response(Metadata.all, 200)
+          end
+
+          def search
+            json_response(Metadata.find_by!(key: params[:key]))
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/metadatastore/application_controller.rb

@@ -0,0 +1,8 @@
+module Metadatastore
+  class ApplicationController < ActionController::Base
+    include Response
+    include ExceptionHandlers
+
+    skip_before_action :verify_authenticity_token
+  end
+end

data/app/helpers/metadatastore/application_helper.rb

@@ -0,0 +1,4 @@
+module Metadatastore
+  module ApplicationHelper
+  end
+end

data/app/helpers/metadatastore/metadata_helper.rb

@@ -0,0 +1,4 @@
+module Metadatastore
+  module MetadataHelper
+  end
+end

data/app/models/metadatastore/application_record.rb

@@ -0,0 +1,5 @@
+module Metadatastore
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/metadatastore/metadata.rb

@@ -0,0 +1,6 @@
+module Metadatastore
+  class Metadata < ApplicationRecord
+    validates :key, :value, presence: { message: "missing_" }
+    validates :key, uniqueness: { message: "_is_duplicated" }
+  end
+end

data/config/initializers/active_model.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+Module.new do
+  def api_messages
+    map do |attr, err|
+      if err.start_with?("_")
+        [attr, err]
+      else
+        [err, attr]
+      end.join
+    end
+  end
+end.tap { |m| ActiveSupport.on_load(:active_record) { ActiveModel::Errors.include(m) } }

data/config/routes.rb

@@ -0,0 +1,22 @@
+Rails.application.routes.draw do
+  scope module: 'metadatastore' do
+    namespace :api do
+      namespace :v2 do
+        namespace :public do
+          resources :metadata, only: :index, param: :key do
+            collection do
+              get 'search'
+            end
+          end
+        end
+        namespace :admin do
+          resources :metadata, only: %i[index create update], param: :key do
+            collection do
+              get 'search'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/db/migrate/20191120145404_create_metadatastore_metadata.rb

@@ -0,0 +1,10 @@
+class CreateMetadatastoreMetadata < ActiveRecord::Migration[6.0]
+  def change
+    create_table :metadatastore_metadata do |t|
+      t.string :key
+      t.json :value
+
+      t.timestamps
+    end
+  end
+end

data/lib/metadatastore/engine.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metadatastore
+  class Engine < ::Rails::Engine
+    isolate_namespace Metadatastore
+
+    config.generators do |generators|
+      generators.test_framework :rspec
+      generators.fixture_replacement :factory_bot
+      generators.factory_bot dir: "spec/factories"
+    end
+
+    initializer "metadata.factories", after: "factory_bot.set_factory_paths" do
+      FactoryBot.definition_file_paths << File.expand_path("../../spec/factories", __dir__) if defined?(FactoryBot)
+    end
+  end
+end

data/lib/metadatastore/version.rb

@@ -0,0 +1,3 @@
+module Metadatastore
+  VERSION = '0.1.0'
+end

data/lib/metadatastore.rb

@@ -0,0 +1,5 @@
+require "metadatastore/engine"
+
+module Metadatastore
+  # Your code goes here...
+end

data/lib/tasks/metadastore_tasks.rake

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

data/spec/controllers/metadatastore/api/v2/admin/metadata_controller_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Metadatastore::API::V2::Admin::MetadataController, type: :controller do
+  let(:valid_attributes) do
+    {
+      key:   "IEO.BTC.1",
+      value: JSON.dump(
+        "summary": "Summary of IEO"
+      )
+    }
+  end
+
+  let(:invalid_attributes) do
+    {
+      key:   "IEO.BTC.1",
+      value: JSON.dump(nil)
+    }
+  end
+
+  let(:admin_jwt_payload) { generate(:admin_jwt_payload) }
+
+  before { inject_jwt_payload!(admin_jwt_payload) }
+
+  describe "GET #index" do
+    it "returns a success response" do
+      Metadatastore::Metadata.create! valid_attributes
+      get :index, params: {}
+      expect(response).to be_successful
+    end
+  end
+
+  describe "GET #search" do
+    it "returns a metadata by key" do
+      Metadatastore::Metadata.create! valid_attributes
+      get :search, params: {key: "IEO.BTC.1"}
+
+      result = JSON.parse(response.body)
+      expect(response).to be_successful
+      expect(result["key"]).to eq("IEO.BTC.1")
+    end
+  end
+
+  describe "POST #create" do
+    context "with valid params" do
+      it "creates a new Metadata" do
+        expect do
+          post :create, params: valid_attributes
+        end.to change(Metadatastore::Metadata, :count).by(1)
+      end
+    end
+
+    context "with invalid params" do
+      it "returns a success response" do
+        post :create, params: invalid_attributes
+        expect(response).to have_http_status 422
+      end
+    end
+  end
+
+  describe "PUT #update" do
+    it "returns a metadata by key" do
+      Metadatastore::Metadata.create! valid_attributes
+      put :update, params: {key: "IEO.BTC.1", value: JSON.dump("link": "link")}
+
+      result = JSON.parse(response.body)
+      expect(response).to be_successful
+      expect(result["key"]).to eq("IEO.BTC.1")
+    end
+  end
+end

data/spec/controllers/metadatastore/api/v2/public/metadata_controller_spec.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Metadatastore::API::V2::Public::MetadataController, type: :controller do
+
+  let(:valid_attributes) do
+    {
+      key:   "IEO.BTC.1",
+      value: {
+        summary: "Summary of IEO"
+      }
+    }
+  end
+
+  let(:invalid_attributes) do
+    {
+      key:   "IEO.BTC.1",
+      value: nil
+    }
+  end
+
+  describe "GET #index" do
+    it "returns a success response" do
+      Metadatastore::Metadata.create! valid_attributes
+      get :index, params: {}
+      expect(response).to be_successful
+    end
+  end
+
+  describe "GET #search" do
+    it "returns a metadata by key" do
+      Metadatastore::Metadata.create! valid_attributes
+      get :search, params: {key: "IEO.BTC.1"}
+
+      result = JSON.parse(response.body)
+      expect(response).to be_successful
+      expect(result["key"]).to eq("IEO.BTC.1")
+    end
+  end
+
+  describe "GET #serch" do
+    it "returns a success response" do
+      Metadatastore::Metadata.create! valid_attributes
+      get :index, params: {key: "IEO.BTC.1"}
+      expect(response).to be_successful
+    end
+  end
+end