mapexplorer-rails 1.0.0.pre.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8dbad4b829760587e41d9f421eec65970e36ad0
+  data.tar.gz: 7dfad63a4cbdd04e2255e918e22c7e03551efc42
+SHA512:
+  metadata.gz: 60941726ef993e82589fb13ed53b132508fa565e84bd6d0ba65f9b6dc39efbd4d5388b714f327e0c507270f850e6459871fb0ae6733302ed4f176f8e86d376c5
+  data.tar.gz: 1837b2dcbb1493981c0adeda58161bf04e828b5c61a421644cc30607abd80654b176334bbbfcbde109791f034ac1213c496fb3d3478e5322bc9c0b068064c576

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 adrien
+
+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,32 @@
+# Mapexplorer::Rails
+Exposes a simple view helper that displays a Map Explorer.
+
+## Usage
+```erb
+<%= mapexplorer(application_url: 'http://localhost:3333', map_id: '00583e40-2a91-497b-83bb-ab82ea143324') %>
+
+<%= mapexplorer(chainscript: my_chainscript_array) %>
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mapexplorer-rails'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install mapexplorer-rails
+```
+
+## 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,37 @@
+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    = 'Mapexplorer::Rails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/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 << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/mapexplorer-rails.js

@@ -0,0 +1,66 @@
+//= require jquery
+//= require turbolinks
+//= require d3
+//= require jsrender
+//= require dist/mapexplorer-core
+
+document.addEventListener('turbolinks:load', function() {
+
+  var segmentTemplate = $.templates("#segment-template");
+
+  $('.mapexplorer').each(function() {
+    var map = $(this);
+    var helpers = {
+      json: function(val) {
+        return JSON.stringify(val, undefined, 2);
+      },
+      merklePathTree: function(merklePath) {
+        setTimeout(function(){
+          var tree = new mapexplorerCore.MerklePathTree(map.find('.merkle-path-tree')[0]);
+          tree.display(merklePath);
+        });
+        return '<div class="merkle-path-tree"></div>';
+      },
+      argsFmt: function(args) {
+        return args.map(function(arg) {
+          return JSON.stringify(args, undefined, 2);;
+        }).join(', ');
+      }
+    };
+
+    var builder = new mapexplorerCore.ChainTreeBuilder(this);
+
+    builder.build({
+      id: map.data('mapId'),
+      applicationUrl: map.data('applicationUrl'),
+      chainscript: map.data('chainscript')
+    }, {
+      onclick: function(d, onHide) {
+        var segment = d.data;
+
+        var refresh = function() {
+          map.find('.segment').html(segmentTemplate.render({ segment: segment }, helpers));
+
+          map.find('.nav-link').on('click', function() {
+            segment.currentSection = $(this).data('target');
+            refresh();
+          });
+
+          map.find('a.close').on('click', function(){
+            map.find('.segment').html(null);
+            onHide();
+            return false;
+          });
+        };
+
+        segment.show = function(target) {
+          return this.currentSection === target;
+        };
+
+        segment.currentSection = 'state';
+        refresh();
+      },
+      onTag: function(){}
+    });
+  });
+});

data/app/assets/stylesheets/mapexplorer-rails.scss

@@ -0,0 +1,128 @@
+/*
+*= require assets/stylesheets/mapexplorer-core
+*/
+
+$brand-primary: #EC714A !default;
+
+.segment-container {
+
+  color: white;
+
+  .title {
+    background: #2E2E2E;
+    padding: 10px 100px;
+  }
+
+  .title md-icon {
+    color: white;
+  }
+
+  h1 {
+    margin-top: 0;
+    font-family: Gibson-SemiBold, 'Montserrat', sans-serif;
+    font-weight: 600;
+    font-size: 11px;
+    color: #CCCCCC;
+    text-transform: uppercase;
+  }
+
+  h2 {
+    margin-bottom: 0;
+    font-family: Gibson-Light, 'Montserrat', sans-serif;
+    font-weight: 300;
+    font-size: 18px;
+    color: #FFFFFF;
+    text-transform: none;
+  }
+
+  .body {
+    background: #3E3E3E;
+    padding: 0 100px;
+    max-height: 400px;
+  }
+
+  .content {
+    overflow-y: scroll;
+  }
+
+  li {
+    cursor: pointer;
+    font-family: 'Gibson-Regular', 'Montserrat', sans-serif;
+    font-size: 15px;
+    color: #CCCCCC;
+    margin: 20px 0;
+    width: 100px;
+  }
+
+  ul {
+    padding-left: 0;
+    padding-right: 5px;
+    list-style: none;
+  }
+
+  .ace_editor {
+    width: 100%;
+  }
+
+  .ace-tm .ace_gutter, .ace_scroller {
+    padding-top: 20px;
+  }
+
+  li.active {
+    color: $brand-primary;
+    border-bottom: 2px solid $brand-primary;
+  }
+
+  li {
+    outline: 0;
+  }
+
+  h4 {
+    font-family: Gibson-SemiBold, 'Montserrat', sans-serif;
+    font-weight: 600;
+    font-size: 11px;
+    color: #ADADAD;
+    text-transform: uppercase;
+    margin-bottom: 0;
+  }
+
+  p {
+    font-family: RationalTWText-Light, 'Roboto Mono', monospace;
+    font-size: 14px;
+    color: white;
+    margin-top: 0;
+  }
+
+  a {
+    font-family: 'Gibson-Regular', 'Montserrat', sans-serif;
+    font-size: 15px;
+    color: $brand-primary;
+    display: block;
+  }
+
+  a.close {
+    color: white;
+    text-decoration: none;
+    font-size: 24px;
+  }
+
+  .flex-row, .flex-column {
+      display: flex;
+  }
+
+  .flex-row {
+      flex-direction: horizontal;
+  }
+
+  .flex-column {
+      flex-direction: vertical;
+  }
+
+  .flex-grow {
+      flex-grow: 1;
+  }
+
+  .flex {
+      flex: 1;
+  }
+}

data/app/helpers/mapexplorer_helper.rb

@@ -0,0 +1,5 @@
+module MapexplorerHelper
+  def mapexplorer(application_url: nil, map_id: nil, chainscript: nil)
+    render 'mapexplorer', { application_url: application_url, map_id: map_id, chainscript: chainscript }
+  end
+end

data/app/views/application/_mapexplorer.html.erb

@@ -0,0 +1,11 @@
+<div class="mapexplorer" data-application-url=<%= application_url %> data-map-id=<%= map_id %> data-chainscript=<%= chainscript %>>
+    <%= render 'segment.jsr' %>
+    <div class="segment">
+    </div>
+    <svg>
+        <marker id="triangle" viewBox="0 0 10 10" refX="0" refY="5" markerUnits="strokeWidth"
+                markerWidth="4" markerHeight="3" orient="auto">
+            <path fill="#CCCCCC" d="M 0 0 L 10 5 L 0 10 z"/>
+        </marker>
+    </svg>
+</div>

data/app/views/application/_segment.jsr.html

@@ -0,0 +1,75 @@
+<script id="segment-template" type="text/x-jsrender">
+    <div class="segment-container">
+        <div class="title flex-row">
+            <div>
+                <h1>Segment</h1>
+                <h2>{{: segment.meta.linkHash }}</h2>
+            </div>
+            <span class="flex"></span>
+            <a href="#" class="close">&times;</a>
+        </div>
+        <div class="body flex-row">
+            <div class="menu">
+                <ul>
+                    <li class={{: (segment.show('state') ? 'active ' : '') + 'nav-link' }} data-target="state">State</li>
+                    <li class={{: (segment.show('link') ? 'active ' : '') + 'nav-link' }} data-target="link">Link</li>
+                    <li class={{: (segment.show('evidence') ? 'active ' : '') + 'nav-link' }} data-target="evidence">Evidence</li>
+                    <li class={{: (segment.show('json') ? 'active ' : '') + 'nav-link' }} data-target="json">JSON</li>
+                </ul>
+            </div>
+            <div class="content flex-grow">
+                {{if segment.show('state')}}
+                    <pre>{{:~json(segment.link.state)}}</pre>
+                {{/if}}
+                {{if segment.show('link')}}
+                    <div class="link">
+                        <h4>Map ID</h4>
+                        <p>{{: segment.link.meta.mapId}}</p>
+
+                        <h4>Agent Hash</h4>
+                        <p>{{: segment.link.meta.agentHash}}</p>
+
+                        <h4>State Hash</h4>
+                        <p>{{: segment.link.meta.stateHash}}</p>
+
+                        <h4>Previous Link hash</h4>
+                        <p>{{: segment.link.meta.prevLinkHash}}</p>
+
+                        <h4>Action</h4>
+                        <p>{{: segment.link.meta.action }}({{:~argsFmt(segment.link.meta.arguments)}})</p>
+                    </div>
+                {{/if}}
+                {{if segment.show('evidence')}}
+                    <div class="flex-row">
+                        <div class="info">
+                            <h4>State</h4>
+                            <p>{{: segment.meta.evidence.state }}</p>
+                            {{if segment.show('evidence')}}
+                                <h4>Bitcoin Transaction</h4>
+                                <p>
+                                {{if segment.meta.evidence.transactions}}
+                                    <a target="_blank"
+                                        href={{: "https://blockchain.info/tx/" + segment.meta.evidence.transactions['bitcoin:main'] }}>View
+                                        transaction on Blockchain.info</a>
+                                {{/if}}
+                                </p>
+
+                                <h4>Merkle root</h4>
+                                <p>{{: segment.meta.evidence.merkleRoot }}</p>
+                            {{/if}}
+                        </div>
+                        {{if segment.meta.evidence.state === 'COMPLETE'}}
+                            <div class="merkle-path">
+                                <h4>Merkle Path</h4>
+                                {{:~merklePathTree(segment.meta.evidence.merklePath)}}
+                            </div>
+                        {{/if}}
+                    </div>
+                {{/if}}
+                {{if segment.show('json')}}
+                    <pre>{{:~json(segment)}}</pre>
+                {{/if}}
+            </div>
+        </div>
+    </div>
+</script>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/mapexplorer/rails/engine.rb

@@ -0,0 +1,9 @@
+module Mapexplorer
+  module Rails
+    class Engine < ::Rails::Engine
+      require 'jquery-rails'
+      require 'turbolinks'
+      require 'sass-rails'
+    end
+  end
+end

data/lib/mapexplorer/rails/version.rb

@@ -0,0 +1,5 @@
+module Mapexplorer
+  module Rails
+    VERSION = '1.0.0-alpha'
+  end
+end

data/lib/mapexplorer/rails.rb

@@ -0,0 +1,7 @@
+require "mapexplorer/rails/engine"
+
+module Mapexplorer
+  module Rails
+    # Your code goes here...
+  end
+end

data/lib/tasks/mapexplorer/rails_tasks.rake

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

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: mapexplorer-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.alpha
+platform: ruby
+authors:
+- adrien
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+- !ruby/object:Gem::Dependency
+  name: turbolinks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.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'
+description: Rails Engine that provides an Action View helper thats displays a Map
+  Explorer
+email:
+- adrien@stratumn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/mapexplorer_rails_manifest.js
+- app/assets/javascripts/mapexplorer-rails.js
+- app/assets/stylesheets/mapexplorer-rails.scss
+- app/helpers/mapexplorer_helper.rb
+- app/views/application/_mapexplorer.html.erb
+- app/views/application/_segment.jsr.html
+- config/routes.rb
+- lib/mapexplorer/rails.rb
+- lib/mapexplorer/rails/engine.rb
+- lib/mapexplorer/rails/version.rb
+- lib/tasks/mapexplorer/rails_tasks.rake
+homepage: https://github.com/stratumn/mapexplorer-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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Rails Engine to display a Map Explorer
+test_files: []