maestrano-connector-rails 0.0.1

data/spec/dummy/app/models/entities/example_entitiy.rb

@@ -0,0 +1,26 @@
+# TODO
+# This file is provided as an example and should be removed
+# One such file needs to be created for each synchronizable entity,
+# with its associated mapper
+
+# class Entities::ExampleEntity < Maestrano::Connector::Rails::Entity
+#   def connec_entity_name
+#     'ExampleEntity'
+#   end
+
+#   def external_entity_name
+#     'Contact'
+#   end
+
+#   def mapper_class
+#     ExampleEntityMapper
+#   end
+# end
+
+# class ExampleEntityMapper < Maestrano::Connector::Rails::GenericMapper
+#   extend HashMapper
+
+#   map from('/title'), to('/Salutation')
+#   map from('/first_name'), to('/FirstName')
+#   map from('address_work/billing2/city'), to('City')
+# end

data/spec/dummy/app/models/maestrano/connector/rails/entity.rb

@@ -0,0 +1,10 @@
+class Maestrano::Connector::Rails::Entity
+  include Maestrano::Connector::Rails::Concerns::Entity
+
+  # Return an array of all the entities that the connector can synchronize
+  # If you add new entities, you need to generate
+  # a migration to add them to existing organizations
+  def self.entities_list
+    %w(entity1 entity2)
+  end
+end

data/spec/dummy/app/models/maestrano/connector/rails/external.rb

@@ -0,0 +1,11 @@
+class Maestrano::Connector::Rails::External
+  include Maestrano::Connector::Rails::Concerns::External
+
+  def self.external_name
+    'Dummy app'
+  end
+
+  def self.get_client(organization)
+    nil
+  end
+end

data/spec/dummy/app/views/admin/index.html.erb

@@ -0,0 +1,51 @@
+<!-- TODO -->
+<!-- This template is given as an example of the informations
+and functions available on the admin panel -->
+<!-- This view is designed according to the admin controller supplied -->
+<div class='admin'>
+  <% unless @organization %>
+    <p> You need to be Admin or Super Admin in your company to access this panel.</p>
+  <% else %>
+    <ul>
+      <li>
+        Maestrano account
+        <%= link_to "Disconnect your Maestrano account", maestrano_connector_rails.signout_path %>
+      </li>
+
+      <li>
+        External account
+        <% if @organization.oauth_uid %>
+          <%= link_to "Disconnect #{@organization.name} (#{@organization.uid})", 'some_path' %>
+        <% else %>
+          <%= link_to "Connect #{@organization.name} (#{@organization.uid})", 'some_other_path' %>
+        <% end %>
+      </li>
+
+      <li>
+        <%= link_to "Force a synchronization", admin_synchronize_path, method: :post %>
+      </li>
+    </ul>
+
+    <h3>Synchronized entities</h3>
+    <p>You can customize which entities are synchronized by the connector.</p>
+    <%= form_tag admin_update_path(id: @organization.id), method: :put do %>
+      <% @organization.synchronized_entities.each do |k, v| %>
+          <label for="<%= k %>">#{k.to_s.humanize}</label>
+          <input checked="<%= v %>" id="<%= k %>" name="<%= k %>" type="checkbox"></input>
+          <% if v  && @organization.oauth_uid %>
+            <%= link_to "Force a synchronization for #{k.to_s.pluralize} only", admin_synchronize_path(opts: {only_entities: [k.to_s]}), method: :post %>
+          <% end %>
+      <% end %>
+      <%= submit_tag :Update%>
+    <% end %>
+
+    <h3>IdMap</h3>
+    <% @idmaps.each do |idmap| %>
+      <%= idmap.connec_entity ? idmap.connec_entity.humanize : nil %>
+      <%= idmap.connec_id %>
+      <%= idmap.external_entity ? idmap.external_entity.humanize : nil %>
+      <%= idmap.external_id %>
+    <% end %>
+
+  <% end %>
+</div>

data/spec/dummy/app/views/home/index.html.erb

@@ -0,0 +1,36 @@
+<!-- TODO -->
+<!-- This template is given as an example of the informations that
+can be displayed on the home page -->
+<!-- This view is designed according to the home controller supplied -->
+<div class='home'>
+  <%= link_to 'Admin panel', admin_index_path %>
+  <% unless current_user %>
+    <%= link_to "Link your Maestrano account", maestrano_connector_rails.init_maestrano_auth_saml_index_path(tenant: :default) %>
+    <p>Some generic information about the connector</p>
+
+  <% else %>
+    <% unless @organization.oauth_uid %>
+      Not linked to external app
+      <% if is_admin?(current_user, @organization) %>
+        <%= link_to "Link this company to ...", 'some_path' %>
+      <% end %>
+    <% else %>
+      Linked to external app
+    <% end %>
+
+    <h2>Last synchronization</h2>
+    <% if @synchronizations.first %>
+      <%= "#{@synchronizations.first.updated_at} #{@synchronizations.first.status}" %>
+      <%= @synchronizations.first.message if @synchronizations.first.status == 'ERROR' %>
+    <% end %>
+
+    <h2>Synchronizations history</h2>
+    <% @synchronizations.each do |sync| %>
+      <%= sync.updated_at %>
+      <%= sync.status %>
+      <% if sync.status == 'ERROR' %>
+        <%= sync.message %>
+      <% end %>
+    <% end %>
+  <% end %>
+</div>

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment', __FILE__)
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "maestrano-connector-rails"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,41 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,79 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like
+  # NGINX, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.serve_static_files = ENV['RAILS_SERVE_STATIC_FILES'].present?
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Use the lowest log level to ensure availability of diagnostic information
+  # when problems arise.
+  config.log_level = :debug
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = 'http://assets.example.com'
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+end

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,42 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static file server for tests with Cache-Control for performance.
+  config.serve_static_files   = true
+  config.static_cache_control = 'public, max-age=3600'
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Randomize the order test cases are executed.
+  config.active_support.test_order = :random
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end