fragments 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6d28fa6573e083f8919cc3ee9bc699b3ba9be79
+  data.tar.gz: d42bfe69397e74b5347c31946fa2eda15ed66f9d
+SHA512:
+  metadata.gz: 348337f6e8be8c6371d76acc7375f832de2207fc49c6eaac563e3e8c2593bdffa617086747cf6de28b90531615e2cc32de557e7f32b11baf5b73ef4123574f52
+  data.tar.gz: 27bf7fb197caa399d520f36317546b97ec30368aa3d03b4a1165ec22357c875943636c5d1c7441263e86cfb9137cc3bcab11ce48d0edaa57dfd759f7117e9361

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.swp
+/*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.15.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in fragments.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Sergio Gernyak
+
+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,52 @@
+# Fragments
+
+Provides a common functionality to be able to use layout fragments inside Rails applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fragments'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fragments
+
+## Usage
+
+Provide configuration for the library:
+
+```ruby
+::Fragments.config do |config|
+  config.host = ENV["FRAGMENT_HOST"]
+  config.uri_prefixes = {
+    nl: ENV["FRAGMENT_URI_PREFIX_NL"],
+    fr: ENV["FRAGMENT_URI_PREFIX_FR"]
+  }
+  config.is_enabled = ENV["USE_FRAGMENTS"] == "true"
+end
+```
+
+Include extention for controller, which provides needed view helpers:
+
+```ruby
+class ApplicationController
+  include Fragments::Helpers::Controller
+end
+```
+
+Inside view you will have the following helper methods:
+
+* `header_html` - provides a HTML structure for the header
+* `common_html` - provides common assets
+* `footer_html` - provides a HTML structure for the footer
+
+Also you will have an ability to check are fragments enabled or not by calling:
+
+`::Fragments.enabled?`

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fragments"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fragments.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fragments/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fragments"
+  spec.version       = Fragments::VERSION
+  spec.authors       = ["Sergio Gernyak"]
+  spec.email         = ["sergey.gernyak@diymaxeda.com"]
+
+  spec.summary       = "Provides an ability to use HTML fragments inside Rails applications"
+  spec.description   = spec.summary
+  spec.homepage      = "https://bitbucket.org/maxedadiy/fragments_rb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/fragments.rb

@@ -0,0 +1,40 @@
+require "fragments/version"
+require "fragments/config"
+require "fragments/requester"
+require "fragments/helpers/controller"
+
+# Top level module for the Fragments library
+#
+# This module should be considered as a Facade, so some internal functionality
+# should not be used from the outside. So, use an API, which is provided by this
+# module instead!
+module Fragments
+  # Get or set a configuration for the library
+  def self.config(&block)
+    @config ||= ::Fragments::Config.new
+    block_given? ? yield(@config) : @config
+  end
+
+  # Specifies either should fragments be used or not
+  #
+  # @return [Boolean] - a value which specifies enableness
+  def self.enabled?
+    config.is_enabled
+  end
+
+  # Provides a html structure for a fragment with a specified code
+  #
+  # @param code [String] - a code of a fragment which you want to request
+  # @param request [Request] - a reference to an object which represents an income HTTP request
+  # @return [String] a html structure of a needed fragment
+  def self.get_html(code, request)
+    ::Fragments::Requester.call(
+      fragment_code: code,
+      current_host: ::Fragments.config.host,
+      cookies: request.headers["HTTP_COOKIE"],
+      current_url: request.original_url
+    )
+  rescue Exception => e
+    ""
+  end
+end

data/lib/fragments/config.rb

@@ -0,0 +1,54 @@
+module Fragments
+  # Contains a current config to request fragments properly
+  # 
+  # @author Sergey Gernyak
+  class Config
+    # Set or get a host to which request should be sent to get fragment's html structure
+    attr_accessor :host
+
+    # Contains URL prefixes
+    # It should be a hash where:
+    # - key is a locale in ISO2 format
+    # - value is an URL prefix
+    attr_accessor :uri_prefixes
+
+    # Specifies either fragments usage is enabled or not
+    attr_accessor :is_enabled
+
+    # Provides an URI prefix for a given locale
+    # @param locale [String] - A locale for which URI prefix should be returned
+    # @return [String] an URI prefix
+    def uri_prefix(locale)
+      uri_prefixes[normalize_key(locale)] || ""
+    end
+
+    # Setter for the URI prefixes mapping hash
+    # @param value [Hash] - A hash with URI prefix per locale mappings
+    # @raise ArgumentError - when an invalid value has been passed
+    def uri_prefixes=(value)
+      raise ::ArgumentError, "Value should be a valid Hash!" unless value.is_a?(Hash)
+      @uri_prefixes = Hash[value.map { |k, v| [normalize_key(k), v] }]
+    end
+
+    # Setter for enableness flag
+    # @param value [Boolean] - A value of the flag
+    # @raise ArgumentError - when an invalid boolean value has been passed
+    def is_enabled=(value)
+      raise ::ArgumentError, "Value should be a valid boolean one!" if !value.is_a?(TrueClass) && !value.is_a?(FalseClass)
+      @is_enabled = value
+    end
+
+    # Provides a value which specifies are fragments enabled or not
+    # By default it returns false.
+    # @return [Boolean]
+    def is_enabled
+      !!@is_enabled
+    end
+
+    private
+
+    def normalize_key(value)
+      value.downcase.to_sym
+    end
+  end
+end

data/lib/fragments/helpers/controller.rb

@@ -0,0 +1,26 @@
+module Fragments
+  module Helpers
+    module Controller
+      def self.included(base)
+        base.send :include, InstanceMethods
+        base.class_eval do
+          helper_method :header_html, :common_html, :footer_html
+        end
+      end
+
+      module InstanceMethods
+        def header_html
+          ::Fragments.get_html('header', request)
+        end
+
+        def common_html
+          ::Fragments.get_html('service', request)
+        end
+
+        def footer_html
+          ::Fragments.get_html('footer', request)
+        end
+      end
+    end
+  end
+end

data/lib/fragments/requester.rb

@@ -0,0 +1,58 @@
+require 'open-uri'
+require 'net/http'
+require 'net/https'
+
+module Fragments
+  class Requester
+    attr_reader :fragment_code, :current_host, :cookies, :current_url
+
+    def initialize(fragment_code:, current_host:, cookies:, current_url:)
+      @fragment_code = fragment_code
+      @current_host = current_host
+      @cookies = cookies
+      @current_url = current_url
+    end
+
+    def self.call(*opts, &block)
+      new(*opts).call(&block)
+    end
+
+    def call
+      uri = build_uri
+      http = Net::HTTP.new(uri.host, uri.port)
+      get_request = Net::HTTP::Get.new(uri.path)
+      apply_https(http, uri)
+      apply_headers(get_request)
+      get_response_body(http, get_request)
+    end
+
+    private
+
+    def build_uri
+      path = current_host + '/' + fragment_code;
+      URI.parse(path)
+    end
+
+    def apply_https(http, uri)
+      return if uri.scheme != "https"
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    end
+
+    def apply_headers(request)
+      request.add_field("Cookie", cookies)
+      request.add_field("frontend-uri", fetch_fragment_uri_prefix)
+      request.add_field("current-url", current_url)
+      request.add_field("host", current_host.gsub(/^https?\:\/\/(www.)?/,''))
+    end
+
+    def get_response_body(http, request)
+      get_response = http.request(request)
+      get_response.body
+    end
+
+    def fetch_fragment_uri_prefix
+      ::Fragments.config.uri_prefix(I18n.locale)
+    end
+  end
+end

data/lib/fragments/version.rb

@@ -0,0 +1,3 @@
+module Fragments
+  VERSION = "0.1.2"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: fragments
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Sergio Gernyak
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Provides an ability to use HTML fragments inside Rails applications
+email:
+- sergey.gernyak@diymaxeda.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fragments.gemspec
+- lib/fragments.rb
+- lib/fragments/config.rb
+- lib/fragments/helpers/controller.rb
+- lib/fragments/requester.rb
+- lib/fragments/version.rb
+homepage: https://bitbucket.org/maxedadiy/fragments_rb
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Provides an ability to use HTML fragments inside Rails applications
+test_files: []