qrgo 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfa8ad4c5b03a4daa7f287f9854a60958c6cf141247e5ad83b560cff36a2c978
-  data.tar.gz: 026ca51e91f61d6049657e149b81369bcd321436d6aa83d69ab55536ffe55858
+  metadata.gz: b670d2aaf9453b0ff3a7c3eb58d9a0b59d6cc5ce44b2501144b8e82dd44a36fc
+  data.tar.gz: e344b78fb831c248016586495166c04e3642a3e523f85e7dfd6920c0ed8f9be2
 SHA512:
-  metadata.gz: 4773c0b14a9ea3376b1155358a16d7ca167e20e647eeea8386b0d85211c335fe8d9b6eca93b586fd2454c2fe1814c127f935170624c18d50935f2758e62f05d3
-  data.tar.gz: 8fc8e920d471eaaf30d38f95ffb955ecb23d08ee822b0fe1cd82d27ba5b96b82c0fa5332847696c1064a783cf27d09374374c0327f58c7abdd241f2082449f5c
+  metadata.gz: 5512558948b3b48115191eb07fe77e3c91cce2634fd0aa37773b1f73ebbd68ddec4f22011043fd610e0e0e35409815c9d20623b11cf8ab16c16150dca3498c89
+  data.tar.gz: 673154dcbbb35487e86864d67a84d11cb0028c2eef0ee4584b6ee2ec0bd2dc00fd2d2a12098bc9a2a066c1b9d5f731d24ac6c97222b48aa7981fbab8b4236cdf

data/CHANGELOG.md

@@ -3,3 +3,11 @@
 ## [0.1.0] - 2023-11-06
 
 - Initial release
+
+## [0.1.1] - 2024-02-06
+
+- Minor bug fixes
+
+## [0.1.2] - 2024-02-07
+
+- URLs are encoded, return type param for qr read method

data/README.md

@@ -1,28 +1,22 @@
-# QRCode
+# QR-GO Wrapper
+[![Gem Version](https://badge.fury.io/rb/qrgo.svg)](https://badge.fury.io/rb/qrgo)
 
-TODO: Delete this and the text below, and describe your gem
+This is a wrapper for the [GOQR api](https://goqr.me/), and can be found in the gem store here [https://rubygems.org/gems/qrgo](https://rubygems.org/gems/qrgo)
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    gem install qrgo
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Alternatively, you may add this to the Gemfile.
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    gem 'qrgo', '~> 0.1.1'
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Create and read QR Codes using the api's capability, within ruby applications.
 
 ## Contributing
 

data/lib/qrcode/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module QRCode
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/qrcode.rb

@@ -6,31 +6,36 @@ require 'json'
 module QRCode
   @base_url = "https://api.qrserver.com/v1/"
 
+  # @param [String] url = URL of the image of the QR Code
+  # @param [Integer] width = width of qr code image
+  # @param [Integer] url = height of qr code image
   def self.qr_create(url, width = 100, height = 100)
-    uri = URI("#{@base_url}create-qr-code/?data=#{url}&size=#{width.to_s}x#{height.to_s}")
+    uri = URI("#{@base_url}create-qr-code/?data=#{CGI.escape(url)}&size=#{width.to_s}x#{height.to_s}")
 
     begin
-        res = Net::HTTP.get_response(uri)
+      res = Net::HTTP.get_response(uri)
     rescue
-        return "Failed to connect with API endpoint."
+      return "Failed to connect with API endpoint."
     end
 
     return res.body if res.is_a?(Net::HTTPSuccess)
   end
 
-  def self.qr_read(url)
-    uri = URI("#{@base_url}read-qr-code/?fileurl=#{url}")
+  # @param [String] url = URL of the image of the QR Code
+  # @param [String] output = "json" or "xml"
+  def self.qr_read(url, output = 'json')
+    uri = URI("#{@base_url}read-qr-code/?fileurl=#{CGI.escape(url)}&outputformat=#{output}")
 
     begin
-        res = Net::HTTP.get_response(uri)
+      res = Net::HTTP.get_response(uri)
     rescue
-        return "Failed to connect with API endpoint."
+      return "Failed to connect with API endpoint."
     end
 
     parsed_json = JSON.parse(res.body)[0]["symbol"][0];
 
     if ! parsed_json['error'].nil?
-        return "Error: " + parsed_json['error'].to_s
+      return "Error: " + parsed_json['error'].to_s
     end
 
     return parsed_json['data'].to_s if res.is_a?(Net::HTTPSuccess)

data/qrcode.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["Dante Bradshaw"]
   spec.email = ["plansuperior@gmail.com"]
 
-  spec.summary = "Generate a QR Code using the goqr api at https://goqr.me/"
-#   spec.description = "TODO: Write a longer description or delete this line."
+  spec.summary = "Generate a QR Code using the GOQR api at https://goqr.me/"
+  spec.description = "This is a wrapper for the goqr.me api, it features methods for reading QR Codes as well as creating them."
   spec.homepage = "https://www.dantebradshaw.com"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"
@@ -17,7 +17,8 @@ Gem::Specification.new do |spec|
 #   spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
 
   spec.metadata["homepage_uri"] = spec.homepage
-#   spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  
+  spec.metadata["source_code_uri"] = "https://github.com/DanteB918/QRGo-Wrapper"
 #   spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
 
   # Specify which files should be added to the gem when it is released.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qrgo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Dante Bradshaw
@@ -10,7 +10,8 @@ bindir: exe
 cert_chain: []
 date: 2024-02-07 00:00:00.000000000 Z
 dependencies: []
-description: 
+description: This is a wrapper for the goqr.me api, it features methods for reading
+  QR Codes as well as creating them.
 email:
 - plansuperior@gmail.com
 executables: []
@@ -31,6 +32,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://www.dantebradshaw.com
+  source_code_uri: https://github.com/DanteB918/QRGo-Wrapper
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -49,5 +51,5 @@ requirements: []
 rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
-summary: Generate a QR Code using the goqr api at https://goqr.me/
+summary: Generate a QR Code using the GOQR api at https://goqr.me/
 test_files: []