quirc 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b098fadcd265ce357ef81036d89dd0a2c260f6fbf050389243fd2853efdcf2d6
-  data.tar.gz: 8aeecc5d6ae1067f73df6352d8a27fbd5e6a3103d12a0cfde7aaa06bbc78d96c
+  metadata.gz: 75f339f3801cedf03f79764d97d4d2fc0f7455fe63a390ab0894dd5894762eb5
+  data.tar.gz: ab831c1fdd0d0ed4fb6ac4fc04d2abe5b2950aff089e3155149a4e2687c783dc
 SHA512:
-  metadata.gz: 043eb2848bc2e10383a3815af8b867caf4bf90c923567942ad09664bbd0e0279cb7ca1bc7615cc859d2786b901559e4071dc20b7d2bbaa6b4815ce1244a1f1f9
-  data.tar.gz: 1912a957c0c56ffb6ad5714a0cdc13ac95c4c3cebefad94f00361afa614c53491954ce19f119ff5f33117b79d3645c45711213f89b7037a3e0de0f9078540237
+  metadata.gz: 409400fac11aafee4ed04e5ad57f9e89c4f1a270a7c33ffa4ed8d7569b0dd1f64f49d4627dec4b31a9c8e2ca3d323715eea93a35d7f7b227f63b920464a653cc
+  data.tar.gz: 7692bc1e8f75cc18d0b9fd70a7f77432d23f2d50ee09ee063e27a8f7641fda806d84a988f6d12f9916d28cf342cb4680f0caea01e3df117aad05ef1ba1b3a224

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2018 Jacob Middag
+Copyright (c) 2017-2019 Jacob Middag
 
 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

@@ -3,5 +3,35 @@
 [Quirc](https://github.com/dlbeer/quirc) is a small C library for extracting and decode QR codes from images.
 This project is a Ruby binding for that library with the library embedded.
 
+## Example
+You have to supply a [ChunkyPNG](http://chunkypng.com/) object or a binary string of the grayscale image with width and height.
+```ruby
+require 'chunky_png'
+require 'quirc'
+
+img = ChunkyPNG::Image.from_file('path_to_image.png')
+res = Quirc.decode(img).first
+puts res.payload
+```
+
+```ruby
+require 'base64'
+require 'zlib'
+require 'quirc'
+
+encoded = <<~EOD
+  eJzt0kEOwyAMRNHe/9LpFo1mwK1IYqQ/mwQDfl5wXYQQQgghT+cziZ7Tb+Ue
+  7vvurL76Vvvhvuvqu0jvqHoP9wx3dh73fHdWxz3Hrc5TvYfbx01RP83j7uH2
+  cCtzuf+7g7uvr74ZrY9r967cedxebrrjZtK9tMbt4Y7+L/V/Tdzn3DRH+td5
+  0hq3h5veR+qjNTcPbh+3Mpd7Qzt6497vat+Voe9Oa7j93GpdrXGt+7i9XO3j
+  +jknzYB7huvmGM+7GXHPcWeOM3B7upV5Rlvvun3cHm6K+qt5qibucy4hhBBC
+  yN58AXWDGDc=
+EOD
+
+img = Zlib::Inflate.inflate(Base64.decode64(encoded))
+res = Quirc.decode(img, 44, 44).first
+puts res.payload
+```
+
 ## License
 This software is licensed under the MIT License. [View the license](LICENSE).

data/lib/quirc.rb

@@ -2,6 +2,10 @@
 
 module Quirc
   def self.decode(image, width=nil, height=nil)
+    unless image.respond_to?(:to_grayscale_stream) || (width && height)
+      raise ArgumentError, "Arguments width and height are required if binary string is passed"
+    end
+
     width ||= image.public_send(:width)
     height ||= image.public_send(:height)
     if image.respond_to?(:to_grayscale_stream)

data/lib/quirc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Quirc
-  VERSION = "0.1.0".freeze
+  VERSION = "0.1.1"
 end

data/test/fixtures/hello.gz

@@ -0,0 +1 @@
+x���A� D������f��Hb�?�~^p]�B!O�3���o����V����H�z�wv�|wV�=ǭ�S����MQ?�����p+s����������k���y�^n��fҽ�����/�M���4G��y�����G�57n�2�{C;z���jߕ��Nk���j]�q����\���9'̀{���ϻq�qg�3p{��yF[�}�n���y�&�s.!�B��|
u�7

data/test/helper.rb

@@ -1,10 +1,17 @@
 # frozen_string_literal: true
 
+require "zlib"
+
 require "minitest/autorun"
 require "oily_png"
+
 require "quirc"
 
 module TestHelpers
+  def binary_fixture(*path)
+    Zlib::Inflate.inflate(File.binread(File.join(__dir__, "fixtures", *path)))
+  end
+
   def image_fixture(*path)
     ChunkyPNG::Image.from_file(File.join(__dir__, "fixtures", *path))
   end

data/test/test_decode.rb

@@ -3,6 +3,14 @@
 require "helper.rb"
 
 describe Quirc do
+  describe "binary string" do
+    it "should decode" do
+      result = Quirc.decode(binary_fixture("hello.gz"), 120, 120).first
+      assert_equal 1, result.ecc_level
+      assert_equal "Hello World!", result.payload
+    end
+  end
+
   describe "error levels" do
     it "should decode all error levels" do
       %i[m l h q].each_with_index do |level, no|
@@ -16,9 +24,24 @@ describe Quirc do
 
   describe "errors" do
     it "should throw error if image size is not equal to buffer" do
-      assert_raises ArgumentError, "Decoder is allocated for 1x2 images" do
+      e = assert_raises ArgumentError do
         Quirc::Decoder.new(1, 2).decode("abc")
       end
+      assert_equal "Decoder is allocated for 1x2 images", e.message
+    end
+
+    it "should throw error if width is not specified with binary string" do
+      e = assert_raises ArgumentError do
+        Quirc.decode("", nil, 1)
+      end
+      assert_equal "Arguments width and height are required if binary string is passed", e.message
+    end
+
+    it "should throw error if width height not specified with binary string" do
+      e = assert_raises ArgumentError, "Decoder is allocated for 1x2 images" do
+        Quirc.decode("", nil, 1)
+      end
+      assert_equal "Arguments width and height are required if binary string is passed", e.message
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quirc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jacob Middag
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-20 00:00:00.000000000 Z
+date: 2019-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.58'
+        version: '0.71'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.58'
+        version: '0.71'
 description: Ruby bindings for C library quirc that extracts and decode QR images
 email: jacob@gaddim.nl
 executables: []
@@ -91,6 +91,7 @@ files:
 - test/fixtures/hello-120-utf8-l.png
 - test/fixtures/hello-120-utf8-m.png
 - test/fixtures/hello-120-utf8-q.png
+- test/fixtures/hello.gz
 - test/helper.rb
 - test/test_decode.rb
 homepage: https://github.com/middagj/quirc-ruby
@@ -105,15 +106,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: QR decoder based on quirc
@@ -122,5 +122,6 @@ test_files:
 - test/fixtures/hello-120-utf8-l.png
 - test/fixtures/hello-120-utf8-m.png
 - test/fixtures/hello-120-utf8-q.png
+- test/fixtures/hello.gz
 - test/helper.rb
 - test/test_decode.rb