stellar_federation-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b52f4c6be8d224343880279ca916a5a7db62164d87ea92e6e2104b26957ddccd
+  data.tar.gz: f42f86334b6564cb22364da7fcb67bb29c69a0245bf783b31da3c5709e402c7f
+SHA512:
+  metadata.gz: 48d0a350099900e65ab44f3e58d0da996d196d0628422d28cd7b17b2aa230fb17c82351e5b1781101d75bd0d8c3e829e2342084bdbb3aa9f1206d5284c7d4629
+  data.tar.gz: d0be5f0b258cfcc918aa34ec0c09dc26f8c35d536560bbbbb4de68a3ef7e93cd7cb46b6d2081eb02781735abfb004001e7b7e74a8d19364b362ff231c06ac6ef

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Ace Subido
+
+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,63 @@
+# StellarFederation
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stellar_federation'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install stellar_federation
+```
+
+## Usage
+
+### Configure
+
+
+A [federation server](https://www.stellar.org/developers/guides/anchor/3-federation-server.html) will respond to the following request with a response:
+
+```
+curl "https://www.your_org.com:8002/federation?q=tunde_adebayo*your_org.com&type=name"
+
+{
+  "stellar_address": "tunde_adebayo*your_org.com",
+  "account_id": "GAIGZHHWK3REZQPLQX5DNUN4A32CSEONTU6CMDBO7GDWLPSXZDSYA4BU",
+  "memo_type": "text",
+  "memo": "tunde_adebayo"
+}
+```
+
+The engine helps produce that output by configuring the engine in an initializer:
+
+```ruby
+StellarFederation.configure do |c|
+  c.on_query = "FindStellarFederatedAddress"
+end
+```
+
+`c.on_query` - is a class the you define: The `on_query` class should also return a `StellarFederation::QueryResponse`. If it doesn't, the Rails engine will throw an exception. The `on_query` class will be called with `.call`, it should have a method that accepts a hash with the following parameters:
+  - `address_name` - ex: `tunder_adebayo*your_org.com`
+
+Add to your routes:
+
+```ruby
+mount StellarFederation::Engine => "/stellar_federation"
+```
+
+## 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,36 @@
+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    = 'StellarFederation'
+  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", __FILE__)
+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 << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/config/stellar_federation_manifest.js

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

data/app/assets/javascripts/stellar_federation/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/stellar_federation/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/stellar_federation/api/v1/queries_controller.rb

@@ -0,0 +1,42 @@
+module StellarFederation
+  module Api
+    module V1
+      class QueriesController < ApplicationController
+        def index
+          check_parameters = Queries::CheckParameters.(query_params)
+
+          if check_parameters
+            @query_response = Queries::ProcessQuery.(query_params: query_params)
+              .query_response
+
+            respond_to do |format|
+              format.json do
+                render json: @query_response.to_json, status: :ok
+              end
+            end
+          else
+            respond_to do |format|
+              format.json do
+                render(
+                  json: {
+                    status: "Unprocessable Entity",
+                    message: "Invalid Parameters",
+                  },
+                  status: :unprocessable_entity,
+                )
+              end
+            end
+
+          end
+
+        end
+
+        private
+
+        def query_params
+          params.permit(:q, :type).to_hash.with_indifferent_access
+        end
+      end
+    end
+  end
+end

data/app/controllers/stellar_federation/application_controller.rb

@@ -0,0 +1,5 @@
+module StellarFederation
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/stellar_federation/application_helper.rb

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

data/app/jobs/stellar_federation/application_job.rb

@@ -0,0 +1,4 @@
+module StellarFederation
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/stellar_federation/application_mailer.rb

@@ -0,0 +1,6 @@
+module StellarFederation
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/stellar_federation/application_record.rb

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

data/app/models/stellar_federation/base_model.rb

@@ -0,0 +1,9 @@
+module StellarFederation
+  module DryTypes
+    include Dry::Types.module
+  end
+
+  class BaseModel < Dry::Struct
+    constructor_type :schema
+  end
+end

data/app/models/stellar_federation/query_response.rb

@@ -0,0 +1,22 @@
+module StellarFederation
+  class QueryResponse < BaseModel
+
+    attribute :account_id, DryTypes::String.optional
+    attribute :memo, DryTypes::String.optional
+    attribute :stellar_address, DryTypes::String.optional
+    attr_writer :memo, :account_id, :stellar_address
+
+    def memo_type
+      "text"
+    end
+
+    def to_json
+      {
+        account_id: account_id,
+        stellar_address: stellar_address,
+        memo_type: memo_type,
+        memo: memo,
+      }.to_json
+    end
+  end
+end

data/app/services/stellar_federation/queries/check_parameters.rb

@@ -0,0 +1,16 @@
+module StellarFederation
+  module Queries
+    class CheckParameters
+      def self.call(params)
+        params[:q].present? && check_type(params[:type])
+      end
+
+      private
+
+      def self.check_type(type)
+        type.present? && type == "name"
+      end
+
+    end
+  end
+end

data/app/services/stellar_federation/queries/prepare_on_query_parameters.rb

@@ -0,0 +1,13 @@
+module StellarFederation
+  module Queries
+    class PrepareOnQueryParameters
+      extend LightService::Action
+      expects :query_params
+
+      executed do |c|
+        c.query_params[:address_name] = c.query_params[:q]
+        c.query_params.except!(:q, :type)
+      end
+    end
+  end
+end

data/app/services/stellar_federation/queries/process_query.rb

@@ -0,0 +1,14 @@
+module StellarFederation
+  module Queries
+    class ProcessQuery
+      extend LightService::Organizer
+
+      def self.call(query_params:)
+        with(query_params: query_params).reduce(
+          PrepareOnQueryParameters,
+          TriggerOnQueryCallbackClass,
+        )
+      end
+    end
+  end
+end

data/app/services/stellar_federation/queries/trigger_on_query_callback_class.rb

@@ -0,0 +1,38 @@
+module StellarFederation
+  module Queries
+    class TriggerOnQueryCallbackClass
+      extend LightService::Action
+      expects :query_params
+      promises :query_response
+
+      executed do |c|
+        begin
+          c.query_response = callback_class.(c.query_params)
+
+          if !c.query_response.is_a? StellarFederation::QueryResponse
+            raise_return_error
+          end
+        rescue NameError => e
+          raise NameError, "StellarFederation.on_query isn't configured"
+        end
+      end
+
+      private
+
+      def self.callback_class
+        StellarFederation.configuration.on_query.constantize
+      end
+
+      def self.raise_return_error
+        raise(
+          StandardError,
+          [
+            StellarFederation.configuration.on_query,
+            "must return a StellarFederation::QueryResponse",
+          ].join(" ")
+        )
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Stellar federation</title>
+  <%= stylesheet_link_tag    "stellar_federation/application", media: "all" %>
+  <%= javascript_include_tag "stellar_federation/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,7 @@
+StellarFederation::Engine.routes.draw do
+  namespace :api do
+    namespace :v1 do
+      resources :queries, only: [:index], defaults: { format: "json" }
+    end
+  end
+end

data/lib/stellar_federation-rails.rb

@@ -0,0 +1,2 @@
+require "stellar_federation"
+

data/lib/stellar_federation.rb

@@ -0,0 +1,13 @@
+require "gem_config"
+require "light-service"
+require "dry-struct"
+require "stellar_federation/engine"
+
+module StellarFederation
+  include GemConfig::Base
+
+  with_configuration do
+    has :on_query
+  end
+end
+

data/lib/stellar_federation/engine.rb

@@ -0,0 +1,14 @@
+module StellarFederation
+  class Engine < ::Rails::Engine
+    isolate_namespace StellarFederation
+
+    config.to_prepare do
+      Engine.routes.default_url_options =
+        Rails.application.routes.default_url_options
+    end
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/stellar_federation/version.rb

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

data/lib/tasks/stellar_federation_tasks.rake

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

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: stellar_federation-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ace Subido
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: gem_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: light-service
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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-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: API Endpoint to query for federated addresses
+email:
+- ace.subido@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/stellar_federation_manifest.js
+- app/assets/javascripts/stellar_federation/application.js
+- app/assets/stylesheets/stellar_federation/application.css
+- app/controllers/stellar_federation/api/v1/queries_controller.rb
+- app/controllers/stellar_federation/application_controller.rb
+- app/helpers/stellar_federation/application_helper.rb
+- app/jobs/stellar_federation/application_job.rb
+- app/mailers/stellar_federation/application_mailer.rb
+- app/models/stellar_federation/application_record.rb
+- app/models/stellar_federation/base_model.rb
+- app/models/stellar_federation/query_response.rb
+- app/services/stellar_federation/queries/check_parameters.rb
+- app/services/stellar_federation/queries/prepare_on_query_parameters.rb
+- app/services/stellar_federation/queries/process_query.rb
+- app/services/stellar_federation/queries/trigger_on_query_callback_class.rb
+- app/views/layouts/stellar_federation/application.html.erb
+- config/routes.rb
+- lib/stellar_federation-rails.rb
+- lib/stellar_federation.rb
+- lib/stellar_federation/engine.rb
+- lib/stellar_federation/version.rb
+- lib/tasks/stellar_federation_tasks.rake
+homepage: https://github.com/bloom-solutions/stellar_federation-rails
+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: Mountable Stellar Federation API Endpoint for Rails
+test_files: []