rack-identicon 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91e47361453e1627c892cec13a707b1853607fb5
+  data.tar.gz: ac7ce868b788671e4d694831d1a5283a8b07a5a6
+SHA512:
+  metadata.gz: 654d524cf8c8b1c78b7e9a14ce01a390331c9a375d97f3ac72a872cb32b700977ba720838daad24faa7dc37c106799aad95840c066d0f291f9985657dd9e85f6
+  data.tar.gz: df25355f4f40c907a69e0d2293e62d4abb5c846870caf2cae939887f0a97e593bff7eee68735384f5bb4e06f177d185e60e4f245fc5ea2fce65af6f36a90dad9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,18 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+  - ruby-head
+before_install: gem install bundler -v 2.1.4
+deploy:
+  provider: rubygems
+  gem: rake-identicon
+  api_key:
+    secure: VpqLsVFF5QepC59kIu32n11SGUIrAgWdHdFS2ubb4+xi4lIQps9ImZFxHAuZjeakNVYJ110AETG+BH6Lblw52xNIQgd+toX10Y/SmiRHVrkMS+AJ9wuuEhWjcxzNIu+2GWrpAVKFa6+dLNxkWaoF/6zGIA/KG2pUyH9jZv3XhYgVRD7unn3f3llEgEbVVkIAv5nx6PtWaYYi0KciCM57yQSTNsckhQQGhAXiVbHOcIDzas42EBtja+PT7IOITGTz5S8dDrTTn56RNnumCD6BUwJ3SayHf9Hsc4zdnYxHzHEAhL/TPv4/b8WcHj1COAliDU1Ko2GsZWn9Wa99xeGFN07553ezA/wvytd2z6YPwOg/Iy4J1XuiKC1XWI2mPEyZ/cbZ46ysZw7uIuN2n5stLRxTgE74Jczf2nFVGLTk7DyRQNdLuSDbzjRqso/cg1NpFXSv/EzFHve84ydAuPDiOx5VTaEv4zMyV224DzbjoI3xzb3wgF2b/BcgxnUKucrZDsRv0/tyKzhWj6SkgBubDKr+CBMl5zTW8XXofdiL7wStCRLBrUKBzBX9mxCWzPTs4F4UYYyrbIOsmm+UOJny1eTcq7AtAw+zH7swVH/Lknz+EyUy001OhrAf3nIu74671gLhyS1F8nQs7Jvnd+V6jLvD23lNyt5msI47+jo6Jr8=
+  on:
+    tags: true
+    rvm: 2.7

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 glaszig
+
+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,65 @@
+# Rack::Identicon
+
+Rack middleware to generate identicons through the [identicon gem](https://rubygems.org/gems/identicon).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-identicon'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rack-identicon
+
+## Usage
+
+Use the middleware with plain rack:
+
+```rb
+# config.ru
+require "rack/identicon"
+map("/__identicon__") { run Rack::Identicon.new }
+run lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['OK']] }
+```
+
+Use with Rails:
+
+```rb
+# config/routes.rb
+Rails.application.routes.draw do
+  mount Rack::Identicon.new, at: "/__identicon__", as: :identicon
+end
+```
+
+### Caching
+
+Rack::Identicon supports caching through any object implementing the methods
+`read(key)`, `write(key, data)`, `exist?(key)` and `fetch(key, &blk)`.
+When used with Rails it'll use `Rails.cache` automatically. Outside of Rails
+you'll need to configure your cache store like this:
+
+```rb
+Rack::Identicon.cache_store = MyStore.new
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/glaszig/rack-identicon.
+
+
+## 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,11 @@
+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"]
+  t.warning = false
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,4 @@
+require "rack/identicon"
+
+map("/__identicon__") { run Rack::Identicon.new }
+run lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['OK']] }

data/lib/rack/identicon.rb

@@ -0,0 +1,27 @@
+require "rack/identicon/version"
+require "rack/identicon/caching"
+require "rack/identicon/response"
+
+module Rack
+  module Identicon
+    class Error < StandardError; end
+
+    include Caching
+
+    def self.new *args
+      Middleware.new *args
+    end
+
+    def self.call env
+      new.call env
+    end
+
+    class Middleware
+      def call env
+        Response.new(env).triplet
+      end
+    end
+  end
+end
+
+require "rack/identicon/railtie" if defined? ::Rails

data/lib/rack/identicon/caching.rb

@@ -0,0 +1,38 @@
+module Rack
+  module Identicon
+    module Caching
+
+      NAMESPACE = "rack-identicon".freeze
+
+      def self.included base
+        base.extend ClassMethods
+        base.cache_store = NullCacheStore.new
+      end
+
+      class NullCacheStore
+        def exist? key
+          false
+        end
+
+        def read key
+        end
+
+        def write key, data
+        end
+
+        def fetch key
+          yield
+        end
+      end
+
+      module ClassMethods
+        attr_accessor :cache_store
+
+        def cache key, &blk
+          cache_store.fetch NAMESPACE + "/" + key, &blk
+        end
+      end
+
+    end
+  end
+end

data/lib/rack/identicon/railtie.rb

@@ -0,0 +1,9 @@
+module Rack
+  module Identicon
+    class Railtie < Rails::Railtie
+      initializer "rack_identicon.caching" do |app|
+        Rack::Identicon.cache_store = Rails.cache
+      end
+    end
+  end
+end

data/lib/rack/identicon/response.rb

@@ -0,0 +1,55 @@
+require "digest"
+require "identicon"
+
+module Rack
+  module Identicon
+    class Response
+      DEFAULT_SIZE = 128
+      DEFAULT_BG   = "ffffff".freeze
+
+      def initialize env
+        @request = Rack::Request.new env
+        @size = @request.params["s"] || DEFAULT_SIZE
+        @bg = parse_color @request.params.fetch "b", DEFAULT_BG
+      end
+
+      def body
+        cache { ::Identicon.blob_for hashed_payload, @size.to_i, @bg }
+      end
+
+      def triplet
+        if valid_request?
+          [ 200, { "Content-Type" => "image/png" }, [ body ] ]
+        else
+          [ 404, { "Content-Type" => "text/plain" }, [ "Not Found" ] ]
+        end
+      end
+
+      protected
+
+        def valid_request?
+          payload.length > 0
+        end
+
+        def hashed_payload
+          @hashed_payload ||= Digest::SHA2.hexdigest(payload)
+        end
+
+        def payload
+          @payload ||= @request.path_info[1..-1].to_s.strip
+        end
+
+        def parse_color hex_str
+          hex_str.scan(/.{2}/).map { |c| c.to_i 16 }
+        end
+
+        def cache &blk
+          Rack::Identicon.cache cache_key, &blk
+        end
+
+        def cache_key
+          hashed_payload + "?s=#{@size}&b=#{@bg}"
+        end
+    end
+  end
+end

data/lib/rack/identicon/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Identicon
+    VERSION = "1.0.0"
+  end
+end

data/rack-identicon.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/rack/identicon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-identicon"
+  spec.version       = Rack::Identicon::VERSION
+  spec.authors       = ["glaszig"]
+  spec.email         = ["glaszig@gmail.com"]
+
+  spec.summary       = %q{Generates Identicon for arbitrary data on the fly.}
+  spec.description   = %q{Gives you a Rack middleware to generate pictures representing data, like gravatar does.}
+  spec.homepage      = "https://github.com/glaszig/rack-identicon"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # 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"]
+
+  spec.add_runtime_dependency 'identicon'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: rack-identicon
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- glaszig
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: identicon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gives you a Rack middleware to generate pictures representing data, like
+  gravatar does.
+email:
+- glaszig@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config.ru
+- lib/rack/identicon.rb
+- lib/rack/identicon/caching.rb
+- lib/rack/identicon/railtie.rb
+- lib/rack/identicon/response.rb
+- lib/rack/identicon/version.rb
+- rack-identicon.gemspec
+homepage: https://github.com/glaszig/rack-identicon
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/glaszig/rack-identicon
+  source_code_uri: https://github.com/glaszig/rack-identicon
+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.5.2.3
+signing_key: 
+specification_version: 4
+summary: Generates Identicon for arbitrary data on the fly.
+test_files: []