xdomain-rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aabb3d0316915e2568b0570f28ddb8b717b347ab
+  data.tar.gz: 95a98c54896fd63983f12a42eee6792b4c16215d
+SHA512:
+  metadata.gz: 078fdf4317362d0a9e632d60b2f1d792f147806236802412d255a64b4c07da235b7225f0e5bae1de20b4f95d027b4429111acdea7c758f30c052a92f706d78c0
+  data.tar.gz: b5c6ec59e2525b7be0f923e6e607a5b16d18df5c62b3b6e4ab849ac01958df474e18a2b6969e488a82088efeba2896e50698b552fa5ce25c76996b7fb2cc25fb

data/.gitignore

@@ -0,0 +1,2 @@
+tmp
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in foundation-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Lucjan Suski lucjansuski at gmail
+
+MIT License
+
+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,142 @@
+# XDomain Rails
+
+XDomain Rails is a gem which simplifies usage of
+[XDomain](https://github.com/jpillora/xdomain) within Rails application.
+
+## Installation
+
+Add following line to your application's Gemfile:
+
+    $ gem 'xdomain-rails'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+The gem provides very simple API.
+
+Consulting [XDomain README](https://github.com/jpillora/xdomain)
+before using this gem is a good idea.
+
+I highly recommend and assume that you are using
+[dotenv-rails](https://github.com/bkeepers/dotenv).
+
+Let's say we want to configure http://master.example.com
+(the domain which you are making requests from) as master domain
+and http://slave.example.com (which receives requests) as slave domain.
+
+### Slave domain
+
+Add following line to your routes:
+
+```ruby
+mount XdomainRails::Engine, at: '/xdomain'
+```
+
+Add following ENV variable to your .env:
+
+```
+XDOMAIN_MASTERS=http://master.example.com
+```
+
+Note: you can also limit scope, use wildcards and add few domains,
+consult [configuration section](#configuration) for more informations:
+```
+XDOMAIN_MASTERS=*.example.com/api/*.json *.another.com
+```
+
+### Master domain
+
+Add following line **before** any other Javascripts ([why?](https://github.com/jpillora/xdomain#quick-usage))
+ to your main application layout:
+
+```erb
+<%= xdomain_slaves %>
+```
+
+Add following ENV variable:
+
+```
+XDOMAIN_SLAVES='["http://slave.example.com"]'
+```
+
+From now on, XHR requests will automagically work:
+
+```javascript
+$.get('http://slave.example.com/secret.json')
+```
+
+## Configuration
+
+More sophisticated configuration is supported.
+
+By default, gem will load domain configuration as JSON
+from following ENV variables:
+
+```
+XDOMAIN_MASTERS='{"http://a.example.com": "*", "http://*.b.com": "api/*"}'
+XDOMAIN_SLAVES='["http://first.example.com", "http://another.example.com/another/proxy"]'
+```
+
+As in XDomain, you can use wildcards in your master domains setup.
+
+To change path for proxy, which by default is `/xdomain/proxy`
+you can just add it in ENV variable:
+
+```
+XDOMAIN_SLAVES=http://slave.example.com/custom/proxy
+```
+
+If you don't like having configuration in ENV variables,
+or you want to customize variable names, just create file
+`config/initializers/xdomain_rails.rb` (**server restart required**):
+
+```ruby
+Xdomain.configure do |config|
+  # path to default xdomain proxy
+  # default: '/xdomain/proxy'
+
+  # config.proxy_path =
+
+  # hash / json string with master domains
+  # default: ENV['XDOMAIN_MASTERS']
+
+  # config.master_domains =
+
+  # array / json string of slave domains
+  # default: ENV['XDOMAIN_SLAVES']
+
+  # config.slave_domains =
+end
+```
+
+### Helpers
+
+Both `xdomain_slaves` and `xdomain_masters` helpers are available.
+
+You can pass domains as an argument:
+
+```erb
+<%= xdomain_slaves ['http://slave.example.com'] %>
+<%= xdomain_masters {'http://master.example.com': '/*.json'] %>
+```
+
+## Changelog
+
+#### v1.0.0
+  - first version
+  - XDomain 0.6.15
+
+## Tests
+
+[WIP] :grinning:
+
+## Contributing
+
+- Fork it (http://github.com/methyl/xdomain-rails/fork)
+- Create your feature branch (git checkout -b my-new-feature)
+- Commit your changes (git commit -am 'Add some feature')
+- Push to the branch (git push origin my-new-feature)
+- Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/controllers/xdomain_rails/xdomain_controller.rb

@@ -0,0 +1,8 @@
+module XdomainRails
+  class XdomainController < ApplicationController
+    layout false
+
+    def proxy
+    end
+  end
+end

data/app/helpers/xdomain_rails/xdomain_helper.rb

@@ -0,0 +1,27 @@
+module XdomainRails
+  module XdomainHelper
+    def xdomain_masters(domains=nil)
+      domains = (domains || master_domains).to_json.html_safe
+      javascript_include_tag("xdomain") + javascript_tag("xdomain.masters(#{domains})")
+    end
+
+    def xdomain_slaves(domains=nil)
+      domains = (domains || slave_domains).to_json.html_safe
+      javascript_include_tag("xdomain") + javascript_tag("xdomain.slaves(#{domains})")
+    end
+
+    private
+
+    def config
+      Rails.configuration.xdomain
+    end
+
+    def master_domains
+      config.master_domains
+    end
+
+    def slave_domains
+      config.slave_domains
+    end
+  end
+end

data/app/views/xdomain_rails/xdomain/proxy.html.erb

@@ -0,0 +1 @@
+<%= xdomain_masters %>

data/config/routes.rb

@@ -0,0 +1,3 @@
+XdomainRails::Engine.routes.draw do
+  get 'proxy' => 'xdomain#proxy'
+end

data/lib/xdomain-rails.rb

@@ -0,0 +1,15 @@
+require 'bundler/setup'
+
+require 'xdomain_rails/engine'
+require 'xdomain_rails/config'
+require 'xdomain_rails/version'
+
+module XdomainRails
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.configure
+    yield(config)
+  end
+end

data/lib/xdomain_rails/config.rb

@@ -0,0 +1,42 @@
+require 'uri'
+
+module XdomainRails
+  class Config
+    attr_reader :master_domains, :slave_domains
+    attr_accessor :proxy_path
+
+    def initialize
+      self.proxy_path   = '/xdomain/proxy'
+      self.master_domains = ENV["XDOMAIN_MASTERS"]
+      self.slave_domains  = ENV["XDOMAIN_SLAVES"]
+    end
+
+    def master_domains=(domains)
+      domains = parse_domains domains
+      @master_domains = domains if domains.any?
+    end
+
+    def slave_domains=(domains)
+      domains = domains_to_hash parse_domains(domains)
+      @slave_domains = domains if domains.any?
+    end
+
+    private
+
+    def parse_domains(domains)
+      (domains.is_a?(String) ? JSON.parse(domains) : domains) || []
+    end
+
+    def domains_to_hash(domains)
+      domains.inject({}) { |result, domain|
+        path = URI(domain).path
+        if path.present?
+          result[domain.sub(path, '')] = path
+        else
+          result[domain] = proxy_path
+        end
+        result
+      }
+    end
+  end
+end

data/lib/xdomain_rails/engine.rb

@@ -0,0 +1,19 @@
+module XdomainRails
+  class Engine < ::Rails::Engine
+    isolate_namespace XdomainRails
+
+    initializer "xdomain_rails.config" do |app|
+      app.config.xdomain = XdomainRails.config
+    end
+
+    initializer "xdomain_rails.assets.precompile" do |app|
+      app.config.assets.precompile += %w(xdomain.js)
+    end
+
+    initializer 'xdomain_rails.action_controller' do |app|
+      ActiveSupport.on_load :action_controller do
+        helper XdomainRails::XdomainHelper
+      end
+    end
+  end
+end

data/lib/xdomain_rails/version.rb

@@ -0,0 +1,3 @@
+module XdomainRails
+  VERSION = "1.0.0"
+end