stellar_base-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8d0e5b43c48cfd30442bc1a761a5d17ddf3f4b196c1735a88961c4b77a453de9
+  data.tar.gz: 21533790d1d003725f0af18694e4af58bf258c3cbe0564fd87f36e9046481bb8
+SHA512:
+  metadata.gz: d620231cb1bc60a96b3db04532f275a8d57524477ba7b9bd709d01217f9df061267e8a47bbf849620a8bb979ccfa045f76f62c3a0070f57d06cf9fc76057c8a4
+  data.tar.gz: d6cf26b7969fb6915a6d1f12f1425f2804fb216a0fc926a0a7bfb15dbcab656d01b2dfa47d2e8397893b38d7a60713c0517a275598fd0f932ea4ff01b55a8d5c

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,51 @@
+# stellar_base-rails
+
+When building Rails apps, we’d always implement /.well-known/stellar and other bits and pieces of the required endpoints in the Stellar Protocol. This gem solves receiving and responding to requests from some parts of the Stellar Protocol
+
+## Usage
+
+### Mounting
+Adding modules to your routes:
+
+```
+mount StellarBase::Engine => "/stellar_base"
+```
+
+### Configuration
+Create an initializer in your rails application:
+
+```
+# config/initializers/stellar_base-rails.rb
+
+StellarBase.configure do |c|
+  c.modules = %i(bridge_callbacks)
+  c.on_bridge_callback = "StellarBridgeReceive::SaveTxn"
+end
+```
+
+#### c.modules
+- You can supply what endpoints you want to activate with the gem
+- `bridge_callbacks` - this will mount a HTTP/S POST endpoint that acts as callback receiver for bridge server payments on the path. It will call your `.on_bridge_callback` class.
+
+#### c.on_bridge_callback
+- Once the bridge_receive endpoint receives a callback, the class will be called with .call
+- The class will be passed with the bridge server callback payload contained in a `StellarBase::BridgeCallback` object.
+- The class will be expected to return a boolean, return true if the callback was processed properly
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stellar_base-rails'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## 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    = 'StellarBase'
+  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_base_manifest.js

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

data/app/assets/javascripts/stellar_base/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_base/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/concepts/stellar_base/application_contract.rb

@@ -0,0 +1,5 @@
+module StellarBase
+  class ApplicationContract < Reform::Form
+    include Reform::Form::Coercion
+  end
+end

data/app/concepts/stellar_base/application_operation.rb

@@ -0,0 +1,6 @@
+module StellarBase
+  class ApplicationOperation < Trailblazer::Operation
+
+  end
+
+end

data/app/concepts/stellar_base/bridge_callbacks/contracts/process.rb

@@ -0,0 +1,20 @@
+module StellarBase
+  module BridgeCallbacks
+    module Contracts
+      class Process < ApplicationContract
+
+        property :id
+        property :from
+        property :route
+        property :amount
+        property :asset_code
+        property :asset_issuer
+        property :memo_type
+        property :memo
+        property :data
+        property :transaction_id
+
+      end
+    end
+  end
+end

data/app/concepts/stellar_base/bridge_callbacks/operations/process.rb

@@ -0,0 +1,21 @@
+module StellarBase
+  module BridgeCallbacks
+    module Operations
+      class Process < ApplicationOperation
+        step :model!
+        step Contract::Build(constant: Contracts::Process)
+        step Contract::Validate(key: :bridge_callback)
+        step Contract::Persist(method: :sync)
+        step :process!
+
+        def model!(options, **)
+          options["model"] = BridgeCallback.new
+        end
+
+        def process!(options, **)
+          BridgeCallbacks::Process.(options["model"])
+        end
+      end
+    end
+  end
+end

data/app/controllers/stellar_base/application_controller.rb

@@ -0,0 +1,6 @@
+module StellarBase
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+    skip_before_action :verify_authenticity_token
+  end
+end

data/app/controllers/stellar_base/bridge_callbacks_controller.rb

@@ -0,0 +1,34 @@
+module StellarBase
+  class BridgeCallbacksController < ApplicationController
+    def create
+      op = BridgeCallbacks::Operations::Process.(bridge_callback: callback_params)
+
+      respond_to do |f|
+        f.json do
+          if op.success?
+            head :ok
+          else
+            head :unprocessable_entity
+          end
+        end
+      end
+    end
+
+    private
+
+    def callback_params
+      params.permit(
+        :id,
+        :from,
+        :route,
+        :amount,
+        :asset_code,
+        :asset_issuer,
+        :memo_type,
+        :memo,
+        :data,
+        :transaction_id,
+      )
+    end
+  end
+end

data/app/helpers/stellar_base/application_helper.rb

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

data/app/jobs/stellar_base/application_job.rb

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

data/app/mailers/stellar_base/application_mailer.rb

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

data/app/models/stellar_base/application_data_model.rb

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

data/app/models/stellar_base/application_record.rb

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

data/app/models/stellar_base/bridge_callback.rb

@@ -0,0 +1,27 @@
+module StellarBase
+  class BridgeCallback < ApplicationDataModel
+    # Attributes and params from
+    # https://github.com/stellar/bridge-server/blob/master/readme_bridge.md#callbacksreceive
+    attribute :id, DryTypes::String.optional
+    attribute :from, DryTypes::String.optional
+    attribute :route, DryTypes::String.optional
+    attribute :amount, DryTypes::Decimal.optional
+    attribute :asset_code, DryTypes::String.optional
+    attribute :asset_issuer, DryTypes::String.optional
+    attribute :memo_type, DryTypes::String.optional
+    attribute :memo, DryTypes::String.optional
+    attribute :data, DryTypes::String.optional
+    attribute :transaction_id, DryTypes::String.optional
+
+    attr_writer :id
+    attr_writer :from
+    attr_writer :route
+    attr_writer :amount
+    attr_writer :asset_code
+    attr_writer :asset_issuer
+    attr_writer :memo_type
+    attr_writer :memo
+    attr_writer :data
+    attr_writer :transaction_id
+  end
+end

data/app/services/stellar_base/bridge_callbacks/process.rb

@@ -0,0 +1,23 @@
+module StellarBase
+  module BridgeCallbacks
+    class Process
+      def self.call(callback)
+        callback_class.(callback)
+      rescue NameError => e
+        error_message = [
+          "StellarBase.on_bridge_callback isn't configured or the",
+          "configured callback class doesn't exist:",
+          StellarBase.configuration.on_bridge_callback,
+        ].join(" ")
+
+        raise NameError, error_message
+      end
+
+      private
+
+      def self.callback_class
+        StellarBase.configuration.on_bridge_callback.constantize
+      end
+    end
+  end
+end

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

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

data/config/routes.rb

@@ -0,0 +1,6 @@
+StellarBase::Engine.routes.draw do
+  if StellarBase.included_module?(:bridge_callbacks)
+    resources :bridge_callbacks, only: [:create], defaults: { format: "json" }
+  end
+end
+

data/lib/stellar_base/engine.rb

@@ -0,0 +1,15 @@
+module StellarBase
+  class Engine < ::Rails::Engine
+    isolate_namespace StellarBase
+
+    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_base/version.rb

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

data/lib/stellar_base-rails.rb

@@ -0,0 +1 @@
+require "stellar_base"

data/lib/stellar_base.rb

@@ -0,0 +1,23 @@
+require "gem_config"
+require "light-service"
+require "dry-struct"
+require "trailblazer-rails"
+require "disposable"
+require "reform"
+require "reform/form/coercion"
+require "stellar_base/engine"
+
+module StellarBase
+  include GemConfig::Base
+
+  with_configuration do
+    has :modules, default: [:bridge_callbacks]
+    has :on_bridge_callback
+  end
+
+  def self.included_module?(module_name)
+    self.configuration.modules&.include?(module_name)
+  end
+end
+
+

data/lib/tasks/stellar_base_tasks.rake

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

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: stellar_base-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ace Subido
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-02 00:00:00.000000000 Z
+dependencies:
+- !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: 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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.6
+- !ruby/object:Gem::Dependency
+  name: trailblazer
+  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: trailblazer-rails
+  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 Endpoints for the Stellar Protocol
+email:
+- ace.subido@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/stellar_base_manifest.js
+- app/assets/javascripts/stellar_base/application.js
+- app/assets/stylesheets/stellar_base/application.css
+- app/concepts/stellar_base/application_contract.rb
+- app/concepts/stellar_base/application_operation.rb
+- app/concepts/stellar_base/bridge_callbacks/contracts/process.rb
+- app/concepts/stellar_base/bridge_callbacks/operations/process.rb
+- app/controllers/stellar_base/application_controller.rb
+- app/controllers/stellar_base/bridge_callbacks_controller.rb
+- app/helpers/stellar_base/application_helper.rb
+- app/jobs/stellar_base/application_job.rb
+- app/mailers/stellar_base/application_mailer.rb
+- app/models/stellar_base/application_data_model.rb
+- app/models/stellar_base/application_record.rb
+- app/models/stellar_base/bridge_callback.rb
+- app/services/stellar_base/bridge_callbacks/process.rb
+- app/views/layouts/stellar_base/application.html.erb
+- config/routes.rb
+- lib/stellar_base-rails.rb
+- lib/stellar_base.rb
+- lib/stellar_base/engine.rb
+- lib/stellar_base/version.rb
+- lib/tasks/stellar_base_tasks.rake
+homepage: https://github.com/bloom-solutions/stellar_base-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 API Endpoints for Rails
+test_files: []