flayyer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e5822ca789be9267bee7ee619207c7e6fca6b0da10149d802c47ac794975d8bf
+  data.tar.gz: 1996d8b0432671c590e80299d8ed41fea657771489a9735589253cf9de1bb592
+SHA512:
+  metadata.gz: 20d466ce769a0b1b1fd6c0e4d6f26a5b165796d68b13eb3dae64e4834539c7271c5efdd8aa5d9d1cc5e99c8376ea03b7aa650006f9bdc427a2ebfd444ed2e2c8
+  data.tar.gz: a0a6a27576c0ce834db173f1c97eb2f71a996a3af2e1efec455539b6d027751714946b7ba9ec2f3dcab56e9060d0664b8999ce3e1d7cca6c196df99dbffc6ebc

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.7
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in flayyer.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    flayyer (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  flayyer!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Patricio López Juri
+
+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,91 @@
+# flayyer-ruby
+
+This gem is agnostic to any Ruby framework.
+
+To create a template please refer to: [flayyer.com](https://flayyer.com?ref=flayyer-ruby)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flayyer'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install flayyer
+
+## Usage
+
+After installing the gem you can format URL as:
+
+```ruby
+require 'flayyer'
+
+flayyer = Flayyer::FlayyerURL.create do |f|
+  f.tenant = 'flayyer'
+  f.deck = 'deck'
+  f.template = 'template'
+  f.variables = {
+      title: 'Hello world!'
+  }
+end
+
+# Use this image in your <head/> tags
+url = flayyer.href
+# > https://flayyer.host/v2/flayyer/deck/template.jpeg?__v=1596906866&title=Hello+world%21
+```
+
+Variables can be complex arrays and hashes. 
+
+```ruby
+flayyer = Flayyer::FlayyerURL.create do |f|
+  # ...
+  f.variables = {
+      items: [
+          { text: 'Oranges', count: 12 },
+          { text: 'Apples', count: 14 },
+      ],
+  }
+end
+```
+
+**IMPORTANT: variables should be serializable.**
+
+To decode the URL for debugging purposes:
+
+```ruby
+print(CGI.unescape(url))
+# > https://flayyer.host/v2/flayyer/deck/template.jpeg?title=Hello+world!&__v=123
+```
+
+## Ruby on Rails
+
+Ruby on Rails will try to safely render strings into the HTML. Any FLAYYER string is already safe-serialized and should not be serialized again.
+
+To prevent double serialization make sure to call `.html_safe` like this:
+
+```ruby
+url = flayyer.href.html_safe
+```
+
+> https://apidock.com/rails/String/html_safe
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/flayyer/flayyer-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flayyer"
+
+# 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/flayyer.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/flayyer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flayyer"
+  spec.version       = Flayyer::VERSION
+  spec.authors       = ["Patricio López Juri"]
+  spec.email         = ["patricio@flayyer.com"]
+
+  spec.summary       = "FLAYYER.com helper classes and methods"
+  # spec.summary       = %q{TODO: Write a short summary, because RubyGems requires one.}
+  spec.description   = "FLAYYER.com helper classes and methods"
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/flayyer/flayyer-ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/flayyer/flayyer-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/flayyer/flayyer-ruby"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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"]
+end

data/lib/flayyer.rb

@@ -0,0 +1,71 @@
+require "flayyer/version"
+require "uri"
+
+module Flayyer
+  class Error < StandardError; end
+
+  class FlayyerURL
+    attr_accessor :version, :tenant, :deck, :template, :extension, :variables
+
+    def self.create(&block)
+      self.new(&block)
+    end
+
+    def initialize(tenant = nil, deck = nil, template = nil, version = nil, extension = 'jpeg', variables = {})
+      @tenant = tenant
+      @deck = deck
+      @template = template
+      @version = version
+      @extension = extension
+      @variables = variables
+      yield(self) if block_given?
+    end
+
+    def querystring
+      defaults = {
+        __v: Time.now.to_i, # This forces crawlers to refresh the image
+      }
+      result = FlayyerHash.new(@variables.nil? ? defaults : defaults.merge(@variables))
+      result.to_query
+    end
+
+    # Create a https://FLAYYER.com string.
+    # If you are on Ruby on Rails please use .html_safe when rendering this string into the HTML
+    def href
+      raise Error.new("Missing 'tenant' property") if @tenant.nil?
+      raise Error.new("Missing 'deck' property") if @deck.nil?
+      raise Error.new("Missing 'template' property") if @template.nil?
+
+      if @version.nil?
+        "https://flayyer.host/v2/#{@tenant}/#{@deck}/#{@template}.#{@extension}?#{self.querystring}"
+      else
+        "https://flayyer.host/v2/#{@tenant}/#{@deck}/#{@template}.#{@version}.#{@extension}?#{self.querystring}"
+      end
+    end
+  end
+
+  # A compatible qs stringify/parse (https://github.com/ljharb/qs)
+  class FlayyerHash
+    @hash = {}
+    def initialize(hash)
+      @hash = hash
+    end
+
+    def to_query_hash(key)
+      @hash.reduce({}) do |h, (k, v)|
+        new_key = key.nil? ? k : "#{key}[#{k}]"
+        v = Hash[v.each_with_index.to_a.map(&:reverse)] if v.is_a?(Array)
+        if v.is_a?(Hash)
+          h.merge!(FlayyerHash.new(v).to_query_hash(new_key))
+        else
+          h[new_key] = v
+        end
+        h
+      end
+    end
+
+    def to_query(key = nil)
+      URI.encode_www_form(self.to_query_hash(key))
+    end
+  end
+end

data/lib/flayyer/version.rb

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

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: flayyer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Patricio López Juri
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-08 00:00:00.000000000 Z
+dependencies: []
+description: FLAYYER.com helper classes and methods
+email:
+- patricio@flayyer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- flayyer.gemspec
+- lib/flayyer.rb
+- lib/flayyer/version.rb
+homepage: https://github.com/flayyer/flayyer-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/flayyer/flayyer-ruby
+  source_code_uri: https://github.com/flayyer/flayyer-ruby
+  changelog_uri: https://github.com/flayyer/flayyer-ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: FLAYYER.com helper classes and methods
+test_files: []