web-connect-rails 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 73c737c4d369e6a8d3f964f9425675d7ce74c833
+  data.tar.gz: 064605e95ea9a6670569289ea225ba77d4df957a
+SHA512:
+  metadata.gz: 823c22989f50c57104f200d72274773b027e1e95cdf061c1fb4a22f33a29801c1cd201ec709473aff91135d101a145c4d5224d95815d2c85f11e72744eedc09f
+  data.tar.gz: b9ac5a6ab31e072eeda124dab77f05d2a43aa86c60219bb44ab03cd897dfad1a255c2d9140f34369a83c4ddf4b2feb6f7a692ef77646ba854246f302b118e68a

data/README.md

@@ -0,0 +1 @@
+This gem adds WebConnect support to existing Rails apps.

data/lib/generators/web_connect/install/install_generator.rb

@@ -0,0 +1,13 @@
+module WebConnect
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_initializer
+        template 'initializer.rb', 'config/initializers/web_connect.rb'
+      end
+
+    end
+  end
+end

data/lib/generators/web_connect/install/templates/initializer.rb

@@ -0,0 +1,43 @@
+Netfira::WebConnect::Rails.configure do |config|
+
+  # This will be WebConnect's URI namespace. All requests with this
+  # prefix will be routed to WebConnect, e.g. /webconnect/8/info
+  config.uri_namespace = 'webconnect'
+
+  # By default, WebConnect will use the host application's database.
+  # Uncomment this section if you want to use a different database.
+  # config.db = {
+  #     adapter: 'sqlite3',
+  #     database: "#{Rails.root}/db/wc_#{Rails.env}.sqlite3"
+  # }
+
+  # Tables created by WebConnect will be prefixed with this string.
+  # You can remove this option if WebConnect isn't sharing the host
+  # application's database.
+  config.db_table_prefix = 'wc_'
+
+  # WebConnect uses Paperclip for file storage. The hash below will
+  # be provided to Paperclip to determine where and how files are
+  # stored. If you remove the option completely, files will not be
+  # stored at all.
+  #
+  # WebConnect adds two additional interpolations for generating paths:
+  # :shop_id     The ID of the shop that owns the file
+  # :model_type  The type of file (plural), e.g. images, attachments
+  #
+  # See http://rdoc.info/gems/paperclip for specifics.
+  config.file_store = {
+      path: ':rails_root/public/system/uploaded_files/shop_:shop_id/:model_type/:filename'
+  }
+
+  # This callback will be used to authenticate incoming requests.
+  # Pass a block or proc that accepts two arguments (shop name and
+  # password), and returns true/false for success/fail.
+  #
+  # Your handler may also return a string that clients should use as
+  # a password in subsequent requests.
+  config.on_authenticate do |shop_name, password|
+    !shop_name.nil? && !password.nil?
+  end
+
+end

data/lib/netfira/web_connect/rails/configuration.rb

@@ -0,0 +1,23 @@
+require 'forwardable'
+
+module Netfira::WebConnect::Rails
+
+  class Configuration
+    attr_accessor :uri_namespace
+
+    %i[db_table_prefix= db= file_store= on_authenticate].each do |property|
+      define_method property do |*args, &block|
+        Netfira::WebConnect.configure do |c|
+          c.__send__ property, *args, &block
+        end
+      end
+    end
+
+  end
+
+  class << self
+    extend Forwardable
+    delegate %i[uri_namespace] => :@config
+  end
+
+end

data/lib/netfira/web_connect/rails/initializer.rb

@@ -0,0 +1,41 @@
+module Netfira::WebConnect::Rails
+
+  def self.initialize!
+    @config = Configuration.new
+
+    # Read end-user configuration data, which may include database connection details
+    # This will fail if the end-user hasn't run rails generate web_connect:install
+    begin
+      require Rails.root + 'config/initializers/web_connect'
+    rescue LoadError
+      raise 'To complete installation of WebConnect, run: rails generate web_connect:install'
+    end
+
+    # Add additional configuration to the web-connect gem
+    Netfira::WebConnect.configure do |c|
+
+      # Use a blank string as the default table prefix
+      c.db_table_prefix ||= ''
+
+      # Sharing the host app's DB with no table prefix will cause collisions in the
+      # schema_migrations table, and possibly other tables.
+      raise 'WebConnect cannot share the host application database without a table prefix.' if !c.db && c.db_table_prefix.empty?
+
+      # Use the default rails logger
+      c.logger = Rails.logger
+
+      # Use the Rails database connection if none was specified by the end-user
+      c.db ||= Rails.configuration.database_configuration[Rails.env]
+    end
+
+    # Ensure database is properly migrated, except when running rake tasks
+    if File.basename($0) != 'rake' && Netfira::WebConnect.needs_migration?
+      raise 'WebConnect has pending database migrations. Please run rake wc:migrate'
+    end
+  end
+
+  def self.configure
+    yield @config
+  end
+
+end

data/lib/netfira/web_connect/rails/railtie.rb

@@ -0,0 +1,14 @@
+module Netfira::WebConnect::Rails
+  class Railtie < ::Rails::Railtie
+
+    initializer 'web_connect_rails.init' do |app|
+      app.middleware.insert_before ActionDispatch::Cookies, RequestTrap
+      Netfira::WebConnect::Rails.initialize!
+    end
+
+    rake_tasks do
+      load GEM_ROOT + 'tasks/tasks.rake'
+    end
+
+  end
+end

data/lib/netfira/web_connect/rails/request_trap.rb

@@ -0,0 +1,19 @@
+module Netfira::WebConnect::Rails
+  class RequestTrap
+
+    def initialize(app)
+      @rails = app
+      @wc = Netfira::WebConnect::RequestFilter.new Netfira::WebConnect::RackApp.new
+    end
+
+    def call(env)
+      uri_namespace = Netfira::WebConnect::Rails.uri_namespace
+      if uri_namespace && !env['PATH_INFO'][1..-1].start_with?(uri_namespace)
+        @rails.call env
+      else
+        @wc.call env
+      end
+    end
+
+  end
+end

data/lib/netfira/web_connect/rails/version.rb

@@ -0,0 +1,7 @@
+module Netfira
+  module WebConnect
+    module Rails
+      VERSION = '0.1.1'
+    end
+  end
+end

data/lib/tasks/tasks.rake

@@ -0,0 +1,20 @@
+namespace :wc do
+
+  desc 'Migrate the WebConnect database'
+  task :migrate do
+    migration :migrate
+  end
+
+  desc 'Rollback the WebConnect database'
+  task :rollback do
+    migration :rollback
+  end
+
+  def migration(action)
+    Netfira::WebConnect::Rails.initialize!
+    require Rails.root + 'config/initializers/web_connect'
+    Netfira::WebConnect::Migration.log_to_stdout = true
+    Netfira::WebConnect.__send__ action
+  end
+
+end

data/lib/web_connect_rails.rb

@@ -0,0 +1,13 @@
+require 'web_connect'
+
+module Netfira::WebConnect
+  module Rails
+    GEM_ROOT = Pathname(__FILE__).parent
+  end
+end
+
+require_relative 'netfira/web_connect/rails/version'
+require_relative 'netfira/web_connect/rails/railtie'
+require_relative 'netfira/web_connect/rails/request_trap'
+require_relative 'netfira/web_connect/rails/configuration'
+require_relative 'netfira/web_connect/rails/initializer'

data/spec/dummy/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4.1'
+gem 'rspec-rails', '3.0.0.beta2'
+# gem 'web-connect', git: 'git@github.com:netfira/web-connect'
+gem 'web-connect', path: File.expand_path('../../../../web-connect', __FILE__)
+gem 'web-connect-rails', path: File.expand_path('../../..', __FILE__)
+gem 'sqlite3'

data/spec/dummy/Gemfile.lock

@@ -0,0 +1,140 @@
+PATH
+  remote: /Users/Neil/Documents/github.com/netfira/web-connect
+  specs:
+    web-connect (0.1.0)
+      activerecord (~> 4.1)
+      fastimage (~> 1.6)
+      locale (~> 2.1)
+      paperclip (~> 4.1)
+      rack (~> 1.5)
+
+PATH
+  remote: /Users/Neil/Documents/github.com/netfira/web-connect-rails
+  specs:
+    web-connect-rails (0.1.1)
+      rails (~> 4.1.0.rc2)
+      web-connect
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.1.1)
+      actionpack (= 4.1.1)
+      actionview (= 4.1.1)
+      mail (~> 2.5.4)
+    actionpack (4.1.1)
+      actionview (= 4.1.1)
+      activesupport (= 4.1.1)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.1)
+      activesupport (= 4.1.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.1)
+      activesupport (= 4.1.1)
+      builder (~> 3.1)
+    activerecord (4.1.1)
+      activemodel (= 4.1.1)
+      activesupport (= 4.1.1)
+      arel (~> 5.0.0)
+    activesupport (4.1.1)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    climate_control (0.0.3)
+      activesupport (>= 3.0)
+    cocaine (0.5.4)
+      climate_control (>= 0.0.3, < 1.0)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    fastimage (1.6.2)
+      addressable (~> 2.3, >= 2.3.5)
+    hike (1.2.3)
+    i18n (0.6.9)
+    json (1.8.1)
+    locale (2.1.0)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25.1)
+    minitest (5.3.4)
+    multi_json (1.10.1)
+    paperclip (4.1.1)
+      activemodel (>= 3.0.0)
+      activesupport (>= 3.0.0)
+      cocaine (~> 0.5.3)
+      mime-types
+    polyglot (0.3.5)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.1.1)
+      actionmailer (= 4.1.1)
+      actionpack (= 4.1.1)
+      actionview (= 4.1.1)
+      activemodel (= 4.1.1)
+      activerecord (= 4.1.1)
+      activesupport (= 4.1.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.1)
+      sprockets-rails (~> 2.0)
+    railties (4.1.1)
+      actionpack (= 4.1.1)
+      activesupport (= 4.1.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
+    rspec-collection_matchers (0.0.4)
+      rspec-expectations (>= 2.99.0.beta1)
+    rspec-core (3.0.0.beta2)
+      rspec-support (= 3.0.0.beta2)
+    rspec-expectations (3.0.0.beta2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (= 3.0.0.beta2)
+    rspec-mocks (3.0.0.beta2)
+      rspec-support (= 3.0.0.beta2)
+    rspec-rails (3.0.0.beta2)
+      actionpack (>= 3.0)
+      activemodel (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-collection_matchers
+      rspec-core (= 3.0.0.beta2)
+      rspec-expectations (= 3.0.0.beta2)
+      rspec-mocks (= 3.0.0.beta2)
+      rspec-support (= 3.0.0.beta2)
+    rspec-support (3.0.0.beta2)
+    sprockets (2.12.1)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.1.3)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    sqlite3 (1.3.9)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (1.2.1)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rails (~> 4.1)
+  rspec-rails (= 3.0.0.beta2)
+  sqlite3
+  web-connect!
+  web-connect-rails!

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/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 vendor/assets/javascripts of plugins, if any, 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.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/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 vendor/assets/stylesheets of plugins, if any, 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 styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end