flyyer 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef1404087856253e14da6d226113d736d21cd5abb60cd8f52dfeb11f483bc8e1
-  data.tar.gz: 830b066c275d67436ef02dc16ea5f4deb75cefa2ce1a710d18963918947dcdc9
+  metadata.gz: c1e464a893bc3a20b7889928cd9ab42e630219f9a0b6949d7cc932c277fe10d9
+  data.tar.gz: d285616617397391d3f4c424980e39a014d662b3de85850ea50d8be8b931cb80
 SHA512:
-  metadata.gz: e5a9a5f581151cf0f7c5dde17a7bec9c24be0efe260bcf4632583aec215857a019a39fd4e245406e8490cb7709fa3630171bd44062ea98af9be7120dccc1ce2b
-  data.tar.gz: 8d258f240f0a74a37d7a0c06f2eeeda1fe165c4fb2b71b4d6f908f7c65e4aedb77c6b77b8ba8ca24b49183d244ade6482a76f91b0026360cd6719e11b29371ec
+  metadata.gz: 9068e285b85d5c3fd9d06c23e65eead115f629d99a82bd416441d190ea940a4902478381db17ebe2ee07338bb630b6882d9d9fee1f97e41a6dff5a4785a70528
+  data.tar.gz: 7846e196cbd31432133259794763300f21f332d4a9294f35582b7512f69933d0c228b666ce04b35d125f5797ed24502fc5b067c9ed0aa0fa81140f9a32bf8525

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    flyyer (2.0.0)
+    flyyer (2.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -75,7 +75,7 @@ You'll get the best results like this:
 
 ### 4. Create a `rule` for your project
 
-Login at [Flyyer.io](https://flyyer.io?ref=flyyer-ruby) > Go to your Dashboard > Manage rules and create a rule like the following:
+Go to your dashboard [here](https://flyyer.io/dashboard/_/projects/_/manage) and create a rule like the following:
 
 [![Flyyer basic rule example](https://github.com/useflyyer/create-flyyer-app/blob/master/.github/assets/rule-example.png?raw=true&v=1)](https://flyyer.io/dashboard)
 
@@ -93,7 +93,7 @@ Here you have a detailed full example for project `website-com` and path `/path/
 
 ```ruby
 flyyer = Flyyer::Flyyer.create do |f|
-  # [Required] Your project slug, find it in your dashboard https://flyyer.io/dashboard/.
+  # [Required] Your project slug, find it in your dashboard https://www.flyyer.io/dashboard/_/projects/_/integrate.
   f.project = 'website-com'
   # [Recommended] The current path of your website (by default it's `/`).
   f.path = '/path/to/product'

data/Rakefile

@@ -3,4 +3,4 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "flyyer"
+require 'bundler/setup'
+require 'flyyer'
 
 # 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.
@@ -10,5 +10,5 @@ require "flyyer"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/flyyer.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
 
   # 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
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = 'exe'

data/lib/flyyer.rb

@@ -72,7 +72,7 @@ module Flyyer
       end
     end
 
-    # Create a https://FLAYYER.com string.
+    # Create a https://FLYYER.io 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 "project" property') if @project.nil?
@@ -88,20 +88,22 @@ module Flyyer
   end
 
   class FlyyerRender
-    attr_accessor :version, :tenant, :deck, :template, :extension, :variables, :meta
+    attr_accessor :version, :tenant, :deck, :template, :extension, :variables, :meta, :secret, :strategy
 
     def self.create(&block)
       self.new(&block)
     end
 
-    def initialize(tenant = nil, deck = nil, template = nil, version = nil, extension = 'jpeg', variables = {}, meta = {})
+    def initialize(tenant = nil, deck = nil, template = nil, version = nil, extension = nil, variables = {}, meta = {}, secret = nil, strategy = nil)
       @tenant = tenant
       @deck = deck
       @template = template
       @version = version
       @extension = extension
-      @variables = variables
+      @variables = variables || {}
       @meta = meta
+      @secret = secret
+      @strategy = strategy
       yield(self) if block_given?
     end
 
@@ -115,16 +117,38 @@ module Flyyer
         end
       end
 
+      default_v = {__v: @meta[:v].nil? ? Time.now.to_i : @meta[:v]} # This forces crawlers to refresh the image
       defaults = {
-        __v: @meta[:v].nil? ? Time.now.to_i : @meta[:v], # This forces crawlers to refresh the image
         __id: @meta[:id] || nil,
         _w: @meta[:width] || nil,
         _h: @meta[:height] || nil,
         _res: @meta[:resolution] || nil,
-        _ua: @meta[:agent] || nil
+        _ua: @meta[:agent] || nil,
+      }
+      jwt_defaults = {
+        i: @meta[:id] || nil,
+        w: @meta[:width] || nil,
+        h: @meta[:height] || nil,
+        r: @meta[:resolution] || nil,
+        u: @meta[:agent] || nil,
+        var: @variables,
       }
-      result = FlyyerHash.new(@variables.nil? ? defaults : defaults.merge(@variables))
-      result.to_query
+      if @strategy && @secret
+        key = @secret
+        if @strategy.downcase == "hmac"
+          default_query = FlyyerHash.new(defaults).to_query
+          data = [@deck, @template, @version || "", @extension || "", default_query].join("#")
+          __hmac = OpenSSL::HMAC.hexdigest('SHA256', key, data)[0..15]
+          return FlyyerHash.new([defaults, default_v, @variables, {__hmac: __hmac}].inject(&:merge)).to_query
+        end
+        if @strategy.downcase == "jwt"
+          payload = [{ d: @deck, t: @template, v: @version, e: @extension }, jwt_defaults].inject(&:merge)
+          __jwt = JWT.encode(payload, key, 'HS256')
+          return FlyyerHash.new({ __jwt: __jwt }.merge(default_v)).to_query
+        end
+      else
+        return FlyyerHash.new([default_v, defaults, @variables].inject(&:merge)).to_query
+      end
     end
 
     # Create a https://flyyer.io string.
@@ -133,12 +157,20 @@ module Flyyer
       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?
+      raise Error.new('Got `secret` but missing `strategy`.  Valid options are `HMAC` or `JWT`.') if @secret && @strategy.nil?
+      raise Error.new('Got `strategy` but missing `secret`. You can find it in your project in Advanced settings.') if @strategy && @secret.nil?
+      raise Error.new('Invalid signing `strategy`. Valid options are `HMAC` or `JWT`.') if @strategy && @strategy.downcase != "jwt" && @strategy.downcase != "hmac"
 
-      if @version.nil?
-        "https://cdn.flyyer.io/render/v2/#{@tenant}/#{@deck}/#{@template}.#{@extension}?#{self.querystring}"
-      else
-        "https://cdn.flyyer.io/render/v2/#{@tenant}/#{@deck}/#{@template}.#{@version}.#{@extension}?#{self.querystring}"
+      base_href = "https://cdn.flyyer.io/render/v2/#{@tenant}"
+
+      if @strategy and @strategy.downcase == "jwt"
+        return "#{base_href}?#{self.querystring}"
       end
+
+      final_href = "#{base_href}/#{@deck}/#{@template}"
+      final_href << ".#{@version}" if @version
+      final_href << ".#{@extension}" if @extension
+      final_href << "?#{self.querystring}"
     end
   end
 

data/lib/flyyer/version.rb

@@ -1,3 +1,3 @@
 module Flyyer
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flyyer
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Patricio López Juri
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-11 00:00:00.000000000 Z
+date: 2021-08-18 00:00:00.000000000 Z
 dependencies: []
 description: FLYYER.io helper classes and methods
 email: