ballonizer_proxy 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8dce4bdcd03abe3f75447233a598d6c7b49da8e
+  data.tar.gz: ce4ca0f0e626867707fd5d451e43fff6c56cfa2b
+SHA512:
+  metadata.gz: 62b8f945865cd830e4ed62e9924b899e36c2dcc332558731b93b9bb08de5599bdf21d38d3411bfc9551db2c3c1cee20be21a921ed71edfacb6d499d3c35b6f9b
+  data.tar.gz: bb25ea19747308172fc0191b1aab7d335ae39204aebd1ec001be79af98e1c71da9d04da9f4c49fdeb06cb1312fc5354e58e564551c36db58de21d48059c16003

data/Rakefile

@@ -0,0 +1,7 @@
+desc 'Run an example of the gem use with rackup'
+task :example do
+  sh 'rackup example/config.ru'
+end
+
+task :default => :example
+

data/example/config.ru

@@ -0,0 +1,9 @@
+require 'ballonizer_proxy'
+require 'json'
+
+path_rake_to_app = 'example'
+
+settings = JSON.parse(File.read("#{path_rake_to_app}/settings_example.json"))
+
+run BallonizerProxyGenerator.new(settings).app
+

data/example/settings_example.json

@@ -0,0 +1,22 @@
+{
+  "proxys_namespace": "/proxys/",
+  "ballonizer_proxys": [
+    {
+      "proxy_path": "/cardboard-crack/pt-br/",
+      "original_domain": "http://cardboard-crack.tumblr.com",
+      "original_paths": "/",
+      "img_to_ballonize_css_selector": ".stat-media-wrapper img",
+      "database_uri": "sqlite://example/cardboard-crack-pt-br.db",
+      "create_tables_if_none": true
+    },
+    {
+      "proxy_path": "/xkcd/pt-br/",
+      "original_domain": "http://xkcd.com",
+      "original_paths": "/",
+      "img_to_ballonize_css_selector": "#comic img",
+      "database_uri": "sqlite://example/xkcd-pt-br.db",
+      "create_tables_if_none": true
+    }
+  ]
+}
+

data/lib/ballonizer_proxy.rb

@@ -0,0 +1,164 @@
+require 'pretty_proxy'
+require 'ballonizer'
+require 'sequel'
+require 'rack'
+require 'addressable/uri'
+
+# A PrettyProxy (that is a Rack::Proxy, that is a rack app) subclass that
+# use an Ballonizer instance to allow the addition of speech bubbles (text
+# ballons) over any (X)HTML page that is requested through it.
+#
+# The first three parameters are equal to the PrettyProxy ones, and the last
+# two equal the Ballonizer ones. This class only deal in a special way with
+# the *_asset_path_for_link and form_handler_url that are joined with the
+# proxy site (scheme+host+port) to make a absolute url if the original
+# values are relative.
+#
+# @author Henrique Becker 
+class BallonizerProxy < PrettyProxy
+  attr_reader :ballonizer
+
+  def initialize(proxy_path, original_domain, original_paths, database, settings)
+    super(proxy_path, original_domain, original_paths)
+    @ballonizer = Ballonizer.new(database, settings)
+  end
+
+  def sugared_rewrite_response(triplet, requested_to_proxy_env, rewritten_env)
+    status, headers, page = triplet
+    original_url = Rack::Request.new(requested_to_proxy_env).url
+    requested_to_proxy_url = Rack::Request.new(requested_to_proxy_env).url
+    proxy_site = Addressable::URI.parse(requested_to_proxy_url).site
+
+    absolute_settings = {}
+    [ :css_asset_path_for_link,
+      :js_asset_path_for_link,
+      :form_handler_url].each do | conf_name |
+      relative_uri = @ballonizer.settings[conf_name]
+      next unless relative_uri 
+      absolute_settings[conf_name] = Addressable::URI.parse(proxy_site)
+                                                     .join(relative_uri).to_s
+    end
+
+    page = @ballonizer.ballonize_page(
+      page, original_url, headers['content-type'], absolute_settings
+    )
+
+    triplet = [status, headers, page]
+  end
+end
+
+# A class to automate the creation of an rack app that offer multiple
+# BallonizerProxys. The constructor only takes a hash (often parsed from
+# a JSON config file) and create a rack app that can be accessed by #app.
+# 
+# The hash format is as follows:
+#
+# h['proxys_namespace'] has a String path (that start and end with slashes)
+# all the proxy apps will be inside this namespace/'virtual directory'.
+#
+# h['ballonizer_proxys'] has an Array with the Hashes of the individual
+# settings of each ballonizer proxy. The 'proxy_path', 'original_domain',
+# 'original_paths' are as the PrettyProxy parameters with the same name.
+# The 'database_uri' is equivalent to the database parameter of the
+# Ballonizer constructor. These four are obrigatory.
+# The rest of the options are as the ones described for the settings hash
+# of the Ballonizer constructor. It's NOT RECOMMENDED to configure the
+# :form_handler_url, :add_required_*, :add_js_for_edition, :*_asset_path_for_link,
+# options, these options are automatically defined. The purpose of this
+# class is mainly to handle this configuration for you, so doesn't make
+# much sense to define these settings.
+#
+# Use 'rake example' to run the example. You can see the results in
+# http://localhost:your_server_port/proxys/xkcd/pt-br/ and
+# http://localhost:your_server_port/proxys/cardboad-crack/pt-br/.
+# The configuration file is in example/settings_example.json
+#
+# @author Henrique Becker 
+class BallonizerProxyGenerator
+  module PrivateUtils
+    def self.deep_freeze(o)
+      if o.is_a? Hash
+        o.each_pair { | k, v | deep_freeze(k); deep_freeze(v) }
+      else
+        if o.is_a? Array
+          o.each { | e | deep_freeze(e) }
+        end
+      end
+
+      o.freeze
+    end
+
+    def self.deep_clone(o)
+      JSON.parse(JSON.generate(o))
+    end
+  end
+
+  ASSET_PATH = '/assets/'
+
+  private_constant :PrivateUtils, :ASSET_PATH
+
+  def initialize(settings)
+    @settings = PrivateUtils.deep_freeze(settings)
+    @ballonizer_proxys = []
+    @settings['ballonizer_proxys'].each do | bp_config |
+      puts bp_config
+      ballonizer_settings = {}
+      Ballonizer::DEFAULT_SETTINGS.each_key do | key |
+        value = bp_config[key.to_s]
+        if value
+          ballonizer_settings[key] = value
+        end
+      end
+      ballonizer_settings = { 
+        form_handler_url: bp_config['proxy_path'] + 'request_handler',
+        add_required_css: true,
+        add_required_js_libs_for_edition: true,
+        create_tables_if_none: true,
+        # the paths for assets are made absolute in BallonizerProxy
+        css_asset_path_for_link: ASSET_PATH,
+        js_asset_path_for_link: ASSET_PATH
+      }.merge(ballonizer_settings)
+      @ballonizer_proxys << BallonizerProxy.new(
+        @settings['proxys_namespace'] + bp_config['proxy_path'][1..-1],
+        bp_config['original_domain'],
+        bp_config['original_paths'],
+        bp_config['database_uri'],
+        ballonizer_settings
+      )
+    end
+
+    proxys_namespace = @settings['proxys_namespace']
+    ballonizer_proxys = @ballonizer_proxys
+
+    @app = Rack::Builder.new do
+      map ASSET_PATH do
+        run Ballonizer.assets_app
+      end
+      ballonizer_proxys.each do | bp |
+        map bp.proxy_path do
+          run bp
+        end
+
+        map bp.ballonizer.settings[:form_handler_url] do
+          run(lambda do | env |
+            begin
+              bp.ballonizer.process_submit(env)
+              [200, {}, ['your changes are made with success']]
+            rescue Ballonizer::SubmitError => e
+              [200, {}, [e.message]]
+            end
+          end)
+        end
+      end
+    end
+  end
+
+  def app
+    @app
+  end
+
+  # The proxy namespace can't be assets
+  def self.validate_settings(settings)
+  end
+end
+

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: ballonizer_proxy
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Henrique Becker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ballonizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: pretty_proxy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.48'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.48'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: ''
+email: henriquebecker91@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- example/settings_example.json
+- example/xkcd-pt-br.db
+- example/config.ru
+- example/cardboard-crack-pt-br.db
+- lib/ballonizer_proxy.rb
+- Rakefile
+homepage: http://rubygems.org/gems/ballonizer_proxy
+licenses:
+- Public domain
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: 'ballonizer_proxy: rack app to create a proxy version of a site allowing
+  the edition of text ballons (speech bubbles) over the images'
+test_files: []
+has_rdoc: true