riddler 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b32f298a7e738b115d8f94de7f1262566920a8ccc3acf51ae18c5219059772a
-  data.tar.gz: 65b5aaae401daf2614a0d0b63cf24c316b0016b6d444c534f4e026ab3584ad13
+  metadata.gz: a56c1db8c7d926edb5786eb578adf7189a1b70acebcc62f7ee7e67f615f67e7f
+  data.tar.gz: 64b7ca5382dbee480718022ff190839d8e2bf3f6e85538dbba47214c6a95945f
 SHA512:
-  metadata.gz: d2a7ad3240490a19b32b775d05b1dee2087949f73e49a489ea66d1e9a9562ea7dcfcbcc3386fe819dd6bbc935af30d9fa4cce6931c7d87ff5fe49a95d7260f8a
-  data.tar.gz: 7bb507769931285c23feb392f46e57adfd107130465d355357aaa42f7ace4e70b54fe6fc31af798451173e38f3d723a4306810b858562ba62a1cfff8772f2af7
+  metadata.gz: b0b87cca825ae1dbc3b27d226abe773b2299c5491c35a6afd8523adf4b612f5a6b84c0c61cc77493b86a10f310d5208fb954ef1568138287415f26768ede8311
+  data.tar.gz: 945736aaf732241402a00acb5e805ae1f1403adc67ef2d8868203b004591f6b65e0ff0a952b967764a6e95b885152f2256511fcea05db0fb11d5ee68596a6e79

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 JohnnyT
+Copyright (c) 2018-2019 John Thornton
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -2,12 +2,114 @@
 
 Riddler is a dynamic content and workflow engine.
 
+## Usage
+
+### Basic Example (using Liquid)
+
+Riddler combines a ContentDefinition with a Context to render the output (using
+Liquid - https://shopify.github.io/liquid/)
+
+```ruby
+require "riddler"
+
+content_definition = {
+  "id"=>"el_text",
+  "name"=>"text",
+  "content_type"=>"element",
+  "type"=>"text",
+  "text"=>"Hello {{ params.name }}!"
+}
+
+Riddler.render content_definition
+
+# {:content_type=>"element", :type=>"text", :id=>"el_text", :name=>"text", :text=>"Hello !"}
+
+Riddler.render content_definition, params: {name: "World"}
+
+# {:content_type=>"element", :type=>"text", :id=>"el_text", :name=>"text", :text=>"Hello World!"}
+```
+
+### Predicate Example (using Predicator)
+
+Pieces of content can define if they should be included or not. Here we use the
+`include_predicate` to specify that it should only be included if `params.name = 'foo'`.
+
+```ruby
+require "riddler"
+
+content_definition = {
+  "id"=>"el_text",
+  "name"=>"text",
+  "content_type"=>"element",
+  "type"=>"text",
+  "text"=>"Hello {{ params.name }}!",
+  "include_predicate" => "params.name = 'foo'"
+}
+
+Riddler.render content_definition
+
+# nil
+
+Riddler.render content_definition, params: {name: "foo"}
+
+# {:content_type=>"element", :type=>"text", :id=>"el_text", :name=>"text", :text=>"Hello foo!"}
+```
+
+
+### PokeAPI ContextBuilder example
+
+One way Riddler can be extended is by adding new ContextBuilders. Let's add the ability to look up a Pokemon at https://pokeapi.co/
+
+We will then pass in a `pokemon_id` as a param
+
+This also shows Liquid filters - capitalizing the name
+
+```ruby
+require "riddler"
+require "net/http"
+
+class PokemonContextBuilder < ::Riddler::ContextBuilder
+  # Does the current context have the data available for this builder to function
+  def data_available?
+    context.params.pokemon_id
+  end
+
+  # Extract IDs from the context (params, headers, JWTs, etc) and store
+  # them in context.ids
+  def extract_ids
+    add_id :pokemon_id, context.params.pokemon_id
+  end
+
+  def process
+    uri = URI "https://pokeapi.co/api/v2/pokemon/#{pokemon_id}/"
+    response_string = Net::HTTP.get uri
+    response = JSON.parse response_string
+
+    context.assign "pokemon", response
+  end
+end
+
+Riddler.configure { |c| c.context_builders << PokemonContextBuilder }
+
+content_definition = {
+  "id"=>"el_text",
+  "name"=>"text",
+  "content_type"=>"element",
+  "type"=>"text",
+  "text"=>"Hello {{ pokemon.name | capitalize }}!"
+}
+
+Riddler.render content_definition, params: {pokemon_id: "1"}
+
+# {:content_type=>"element", :type=>"text", :id=>"el_text", :name=>"text", :text=>"Hello Bulbasaur!"}
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'riddler'
+gem "riddler"
 ```
 
 And then execute:
@@ -18,9 +120,6 @@ Or install it yourself as:
 
     $ gem install riddler
 
-## Usage
-
-TODO: Write usage instructions here
 
 ## Development
 
@@ -30,7 +129,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/riddler. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/riddler/riddler. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -38,4 +137,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Riddler project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/riddler/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Riddler project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/riddler/riddler/blob/master/CODE_OF_CONDUCT.md).

data/lib/riddler.rb

@@ -1,19 +1,68 @@
 require "riddler/version"
 
+require "faraday"
+require "faraday_middleware"
 require "liquid"
+require "outlog"
+require "predicator"
+require "ulid"
 
+require "riddler/includeable"
+
+require "riddler/drops/hash_drop"
+
+require "riddler/configuration"
+
+require "riddler/context_builder"
+require "riddler/context_builders/faraday_builder"
+require "riddler/context_director"
 require "riddler/context"
 
 require "riddler/element"
-require "riddler/elements/copy"
 require "riddler/elements/heading"
+require "riddler/elements/image"
+require "riddler/elements/link"
+require "riddler/elements/text"
+require "riddler/elements/variant"
 
 require "riddler/step"
 require "riddler/steps/content"
+require "riddler/steps/variant"
 
-require "riddler/use_cases/preview_step"
+require "riddler/use_cases"
 
 module Riddler
   class Error < StandardError; end
-  # Your code goes here...
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.configuration
+    @configuration ||= ::Riddler::Configuration.new
+  end
+
+  def self.config; configuration; end
+
+  def self.logger
+    @logger ||= ::Outlog.logger
+  end
+
+  def self.render content_definition, context={}
+    unless context.kind_of? ::Riddler::Context
+      director = ::Riddler::ContextDirector.new context
+      context = director.context
+    end
+
+    case content_definition["content_type"]
+    when "element"
+      content = ::Riddler::Element.for content_definition, context
+    when "step"
+      content = ::Riddler::Step.for content_definition, context
+    end
+
+    return nil unless content.include?
+
+    content.to_hash
+  end
 end

data/lib/riddler/configuration.rb

@@ -0,0 +1,11 @@
+module Riddler
+
+  class Configuration
+    attr_accessor :context_builders
+
+    def initialize
+      @context_builders = []
+    end
+  end
+
+end

data/lib/riddler/context.rb

@@ -5,20 +5,58 @@ module Riddler
 
     def initialize input = nil
       input ||= {}
-      @variables = {}
+      @variables = {
+        "ids" => {}
+      }
       input.each do |key, value|
+        next if value.nil?
         assign key, value
       end
     end
 
     def assign name, value
-      variables[name.to_s] = value
+      variables[name.to_s] = drop_for value
+    end
+
+    def variable name
+      variables[name.to_s]
     end
 
     def render string
       template = ::Liquid::Template.parse string
       template.render variables
     end
+
+    def add_id name, value
+      variables["ids"][name.to_s] = value
+    end
+
+    def to_liquid
+      Liquid::Context.new [variables]
+    end
+
+    def to_hash
+      hash_array = variables.map do |key, value|
+        [key, value.to_hash]
+      end
+      Hash[hash_array]
+    end
+
+    def method_missing method_name, *_args
+      return super unless variables.key? method_name.to_s
+      variable method_name
+    end
+
+    private
+
+    def drop_for data
+      case data
+      when ::Liquid::Drop
+        data
+      else
+        ::Riddler::Drops::HashDrop.new data
+      end
+    end
   end
 
 end

data/lib/riddler/context_builder.rb

@@ -0,0 +1,35 @@
+module Riddler
+  class ContextBuilder
+    attr_reader :context
+
+    def initialize context
+      @context = context
+    end
+
+    # Does the current context have the data available for this builder
+    # to function
+    def data_available?
+      true
+    end
+
+    # Extract IDs from the context (params, headers, JWTs, etc) and store
+    # them in context.ids
+    def extract_ids
+      # no-op
+    end
+
+    # Inspect context for identifiers or data.
+    # Add any additional relevant information to the context
+    def process
+      # no-op
+    end
+
+    private
+
+    # Adds the ID to the context and defines a method for the ID
+    def add_id name, value
+      context.add_id name, value
+      define_singleton_method(name) { value }
+    end
+  end
+end

data/lib/riddler/context_builders/faraday_builder.rb

@@ -0,0 +1,23 @@
+module Riddler
+  module ContextBuilders
+    class FaradayBuilder < ::Riddler::ContextBuilder
+      def self.base_uri
+        raise "The Faraday builder must define a class .base_uri method"
+      end
+
+      def connection
+        @connection ||= build_connection
+      end
+
+      private
+
+      def build_connection
+        Faraday.new url: self.class.base_uri do |conn|
+          conn.response :json, :content_type => /\bjson$/
+          conn.request :url_encoded
+          conn.adapter Faraday.default_adapter
+        end
+      end
+    end
+  end
+end

data/lib/riddler/context_builders/user_agent.rb

@@ -0,0 +1,34 @@
+require "browser/aliases"
+Browser::Base.include Browser::Aliases
+
+module Riddler
+  module ContextBuilders
+
+    class UserAgent < ::Riddler::ContextBuilder
+      # Look for the user_agent header and build a drop for that
+      def process
+        drop = UserAgentDrop.new context.headers.user_agent
+        context.assign "user_agent", drop
+      end
+    end
+
+    class UserAgentDrop < ::Liquid::Drop
+      attr_reader :user_agent, :browser
+
+      def initialize user_agent
+        @user_agent = user_agent
+        @browser = Browser.new user_agent
+      end
+
+      def liquid_method_missing method
+        browser.public_send method
+      end
+
+      def method_missing method, *_args
+        return super unless browser.respond_to? method
+        liquid_method_missing method
+      end
+    end
+
+  end
+end

data/lib/riddler/context_director.rb

@@ -0,0 +1,67 @@
+module Riddler
+
+  class ContextDirector
+    attr_reader :params, :headers
+
+    def initialize options={}
+      options = {} if options.nil?
+      @params = options[:params] || options["params"]
+      @headers = options[:headers] || options["headers"]
+      @ctx = ::Riddler::Context.new params: params, headers: headers
+      @ids_extracted = false
+      @builders_applied = false
+    end
+
+    # Return the context with only IDs extracted
+    def simple_context
+      extract_ids
+      @ctx
+    end
+
+    # Create a new context and use registered builders to fill it in
+    def context
+      extract_ids
+      apply_builders
+      @ctx
+    end
+
+    private
+
+    def extract_ids
+      return if @ids_extracted
+
+      builders.each do |builder|
+        unless builder.data_available?
+          ::Riddler.logger.debug "data not available for builder", context_builder: builder.class.name
+          next
+        end
+        ::Riddler.logger.debug "extracting ids", context_builder: builder.class.name
+        builder.extract_ids
+      end
+
+      @ids_extracted = true
+    end
+
+    def apply_builders
+      return if @builders_applied
+
+      builders.each do |builder|
+        unless builder.data_available?
+          ::Riddler.logger.debug "data not available for builder", context_builder: builder.class.name
+          next
+        end
+        ::Riddler.logger.debug "processing context builder", context_builder: builder.class.name
+        builder.process
+      end
+
+      @builders_applied = true
+    end
+
+    def builders
+      @builders ||= ::Riddler.configuration.context_builders.map do |builder_class|
+        builder_class.new @ctx
+      end
+    end
+  end
+
+end