putqr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 894df85665fbab9c06ad27bff808f806ff9e552915ad0ad0776d078bee5581d4
+  data.tar.gz: '006614608e3afd5b73943854e8811fd05fe08a49c60b8cdbb4dce5ac30536c0e'
+SHA512:
+  metadata.gz: 24045838704daf36f8ad32221e4477a85a1818890619a45f475e5392184e7c502af475b436218e1911e6526980f1a03c60b6450c068812ab04422fdcd2db0095
+  data.tar.gz: e4bae898597198756aad237d9f831f092eacf977ed6207008e5e45faee5ece117ce5361a1430674815f31267185d49a6250a71bafb74f0d4c8fc907ccd8c0ebc

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Liam Cooke
+
+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,50 @@
+# putqr
+
+Display a QR code in your terminal.
+
+If you're using [iTerm2](https://iterm2.com) on macOS,
+the QR code will be displayed as an image.
+
+## Install
+
+Install `putqr` from [RubyGems](https://rubygems.org/):
+
+```
+gem install putqr
+```
+
+## Usage
+
+Run the `putqr` command with the string you want to encode, like:
+
+```
+putqr https://example.com/
+```
+
+Run the command without arguments to read the data from standard input:
+
+```
+putqr < example.txt
+```
+
+## Development
+
+To run the latest source code, check out the repository from GitHub:
+
+```
+git clone https://github.com/ljcooke/putqr.git
+```
+
+Install the dependencies using Bundler:
+
+```
+gem install bundler
+bundle install
+```
+
+Run the tests and the `putqr` command using Bundler:
+
+```
+bundle exec rspec
+bundle exec putqr
+```

data/bin/putqr

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'putqr'
+
+if ARGV.any?
+  content = ARGV.first
+  STDERR.puts 'warning: only encoding first argument' if ARGV.size > 1
+else
+  content = STDIN.read
+end
+
+output = PutQR::QRCode.new(content).render
+exit(1) if output.nil?
+puts output

data/lib/putqr.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'rqrcode'
+
+require 'putqr/version'
+
+module PutQR
+  # Display a QR code in your terminal.
+  class QRCode
+    attr_reader :qrcode
+
+    # Initialize the QR code with a string.
+    def initialize(content)
+      @qrcode = QRCode.generate_qrcode(content)
+    end
+
+    # Can the string be encoded as a QR code?
+    def valid?
+      !qrcode.nil?
+    end
+
+    # Render the QR code for display in the terminal.
+    # Returns a string.
+    def render
+      if ENV['TERM_PROGRAM'].start_with? 'iTerm'
+        render_image_iterm2
+      else
+        render_ansi
+      end
+    end
+
+    # Render the QR code using ANSI escape codes.
+    # Returns a string.
+    def render_ansi
+      qrcode.as_ansi if valid?
+    end
+
+    # Render the QR code as an inline image for iTerm2.
+    # Returns a string.
+    def render_image_iterm2
+      return nil unless valid?
+
+      png = qrcode.as_png(size: 600)
+      png_base64 = Base64.encode64(png.to_s).chomp
+      options = 'inline=1'
+      "\033]1337;File=#{options}:#{png_base64}\007"
+    end
+
+    def self.generate_qrcode(content)
+      # Try each size until one fits
+      (min_qr_version(content.size)..40).each do |version|
+        begin
+          return RQRCode::QRCode.new(content, level: :h, size: version)
+        rescue RQRCode::QRCodeRunTimeError
+          next
+        end
+      end
+      nil
+    end
+
+    def self.min_qr_version(input_size)
+      # Skip the lower QR code versions where the input is known to be too
+      # long. These figures are based on the maximum number of characters
+      # that can be encoded for a numeric string with high error correction.
+      if    input_size >= 2_524 then 36
+      elsif input_size >= 1_897 then 31
+      elsif input_size >=   969 then 21
+      elsif input_size >=   331 then 11
+      else 1
+      end
+    end
+  end
+end

data/lib/putqr/version.rb

@@ -0,0 +1,3 @@
+module PutQR
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: putqr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Liam Cooke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rqrcode
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+description: putqr displays a QR code in your terminal.
+email: putqr@liamcooke.com
+executables:
+- putqr
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/putqr
+- lib/putqr.rb
+- lib/putqr/version.rb
+homepage: https://github.com/ljcooke/putqr
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Displays a QR code in your terminal.
+test_files: []