stellar_base-rails 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb6ead7f2864989a152ec231b9f320433c14e940371fe949eb496b5f23a29aba
-  data.tar.gz: e7690ffa217717e9f2f9dd2c874cca7f9b2b806e6cba1091184604147883364f
+  metadata.gz: 0df38a89228d4c990c8e2eaa9c44e355dd327c4a2a064ac87f299ba630f38943
+  data.tar.gz: 3a1431e4c406d8922aeb9dce46a4445bd573a3a282de9a9702d28d39560c872c
 SHA512:
-  metadata.gz: 9b66865fe56899570bd53211966355517b36bec6f90bd807494f8cd0db94b5969957eca420e33b03ebd141e20b0215651d4605f1ff9c0a63cb83774eca938126
-  data.tar.gz: 895c7d45a3eef849c1034f9f1d99162c76c58eda9605ad20896a71a97fba898eb241e37b9cc3b91027aa074d2ecaa14621d7bbee5fb48869ced9e4d15ac07de6
+  metadata.gz: ef07f9dab7dd4083a1382d079eac8649fb871a603fa013dca4e8e37b06ee053c2ba7a64868c28cb0043390cda7f306f322c622acadf2fce9c389300c2f3746aa
+  data.tar.gz: bfa822784f4a078d0eab736f981d7ea9c18eac76493f78b97e24d1dc98208d875c9ba5a7ca56cac1d7b82eb28d53e7ada0a6c1776d7062515c7ce3f1f51d787d

data/README.md

@@ -8,7 +8,10 @@ When building Rails apps, we’d always implement /.well-known/stellar and other
 Adding modules to your routes:
 
 ```
-mount StellarBase::Engine => "/stellar_base"
+mount StellarBase::Engine => "/stellar"
+
+# Optionally, you can mount /.well-known/stellar
+mount_stellar_base_well_known
 ```
 
 ```sh
@@ -33,7 +36,6 @@ StellarBase.configure do |c|
 end
 ```
 
-
 #### c.modules
 You can supply what endpoints you want to activate with the gem
 
@@ -50,6 +52,23 @@ This is the same distribution account that is setup in bridge. Currently, it is
 - Default: https://horizon.stellar.org
 - This is where the engine will check bridge callbacks if `c.check_bridge_callbacks_authenticity` is turned on
 
+### c.stellar_toml
+- Value(s): Hash, follow Stellar's [documentation](https://www.stellar.org/developers/guides/concepts/stellar-toml.html) for `stellar.toml`
+- Example:
+```
+c.stellar_toml = {
+  TRANSFER_SERVER: ...,
+  FEDERATION_SERVER: ...,
+  AUTH_SERVER: ...,
+}
+```
+- Default:
+```
+c.stellar_toml = {
+  TRANSFER_SERVER: # if withdraw module is set, this is automatically set to the withdraw_endpoint unless overridden
+}
+```
+
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -62,7 +81,7 @@ And then execute:
 $ bundle
 ```
 
-## Contributing
+## Development
 
 ```ruby
 cp spec/config.yml{.sample,}
@@ -70,5 +89,13 @@ cp spec/config.yml{.sample,}
 
 Edit the `spec/config.yml` file.
 
+```sh
+cd spec/dummy
+rails db:migrate
+rails db:migrate RAILS_ENV=test
+```
+
+Now you can run `rspec spec`
+
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/app/controllers/stellar_base/home_controller.rb

@@ -0,0 +1,24 @@
+module StellarBase
+  class HomeController < ApplicationController
+
+    before_action :set_cors_headers, only: %i[show]
+    skip_before_action :verify_authenticity_token
+
+    def show
+      stellar_toml = StellarToml.new(StellarBase.configuration.stellar_toml)
+
+      respond_to do |f|
+        f.toml do
+          render plain: TomlRB.dump(stellar_toml.to_hash)
+        end
+      end
+    end
+
+    private
+
+    def set_cors_headers
+      response.headers["Access-Control-Allow-Origin"] = "*"
+    end
+
+  end
+end

data/app/models/stellar_base/stellar_toml.rb

@@ -0,0 +1,16 @@
+module StellarBase
+  class StellarToml
+
+    include Virtus.model
+
+    attribute(:TRANSFER_SERVER, String, {
+      lazy: true, default: :default_transfer_server
+    })
+
+    def default_transfer_server
+      return "" unless StellarBase.included_module?(:withdraw)
+      StellarBase::Engine.routes.url_helpers.withdraw_url
+    end
+
+  end
+end

data/config/spring.rb

@@ -0,0 +1 @@
+Spring.application_root = "./spec/dummy"

data/lib/stellar_base.rb

@@ -28,6 +28,8 @@ module StellarBase
 
     has :withdrawable_assets, classes: [NilClass, Array, String, Pathname]
     has :on_withdraw
+
+    has :stellar_toml, classes: Hash
   end
 
   after_configuration_change do
@@ -58,7 +60,7 @@ module StellarBase
     YAML.load_file(str.to_s)
   rescue Errno::ENOENT
   end
-
 end
 
 require "stellar_base/horizon_client"
+require "stellar_base/rails/routes"

data/lib/stellar_base/engine.rb

@@ -1,5 +1,6 @@
 module StellarBase
   class Engine < ::Rails::Engine
+
     isolate_namespace StellarBase
 
     config.to_prepare do
@@ -7,6 +8,11 @@ module StellarBase
         Rails.application.routes.default_url_options
     end
 
+    initializer "register.mime_types" do
+      return if Mime::Type.lookup_by_extension("toml").present?
+      Mime::Type.register "application/toml", :toml
+    end
+
     config.generators do |g|
       g.test_framework :rspec
     end

data/lib/stellar_base/rails/routes.rb

@@ -0,0 +1,15 @@
+module ActionDispatch
+  module Routing
+    class Mapper
+
+      def mount_stellar_base_well_known
+        get(
+          "/.well-known/stellar" => "stellar_base/home#show",
+          :as => :stellar_toml,
+          :defaults => { format: "toml" },
+        )
+      end
+
+    end
+  end
+end

data/lib/stellar_base/version.rb

@@ -1,3 +1,3 @@
 module StellarBase
-  VERSION = '0.4.1'
+  VERSION = "0.5.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stellar_base-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Ace Subido
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-28 00:00:00.000000000 Z
+date: 2018-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -285,12 +285,14 @@ files:
 - app/concepts/stellar_base/withdrawal_requests/withdrawal_request_policy.rb
 - app/controllers/stellar_base/application_controller.rb
 - app/controllers/stellar_base/bridge_callbacks_controller.rb
+- app/controllers/stellar_base/home_controller.rb
 - app/controllers/stellar_base/withdraw_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_record.rb
 - app/models/stellar_base/bridge_callback.rb
+- app/models/stellar_base/stellar_toml.rb
 - app/models/stellar_base/withdrawal_request.rb
 - app/representers/application_representer.rb
 - app/representers/withdrawal_request_representer.rb
@@ -316,6 +318,7 @@ files:
 - app/twins/withdrawal_request_twin.rb
 - app/views/layouts/stellar_base/application.html.erb
 - config/routes.rb
+- config/spring.rb
 - db/migrate/20180816014433_create_stellar_base_bridge_callbacks.rb
 - db/migrate/20180816110314_create_stellar_base_withdrawal_requests.rb
 - db/migrate/20180816135847_unique_stellar_base_bridge_callbacks_operation_id.rb
@@ -326,6 +329,7 @@ files:
 - lib/stellar_base/factories/bridge_callbacks.rb
 - lib/stellar_base/factories/withdrawal_requests.rb
 - lib/stellar_base/horizon_client.rb
+- lib/stellar_base/rails/routes.rb
 - lib/stellar_base/version.rb
 - lib/tasks/stellar_base_tasks.rake
 homepage: https://github.com/bloom-solutions/stellar_base-rails
@@ -348,7 +352,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Mountable Stellar API Endpoints for Rails