fastlane-plugin-qr_code 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8ada11211f5a996a4730122f18efd8edd3d9efb7e624382911f1a101f6aefd9
-  data.tar.gz: 646373947b62f61c2d616cec2d808a696ffa6f5f4f21f6f362cb5605a5963a7c
+  metadata.gz: 6018e9ac9a71c9e5ba185e51223fcd8cd5f4c7e9f70686e88da37ce7ccfb7c37
+  data.tar.gz: d6ea0296c0321205dfcef8dbd7a7c3c2458ec442f03e82496bf5f78eb7770b43
 SHA512:
-  metadata.gz: 6327ad32bf8a9131f2613080ca1698aa358b614cc65e4a6f7fa9a4e877e84a7e6e0de7906064ad87f92233618b04a6424502f718eb415d903ca759aefeda7b53
-  data.tar.gz: 48fdbdec952f883100fda170a39f7ad851f7942b34b06c97260c1a0caabb36185209d1c190c0e6f81a864d297fff8bf8bd4b39514afa819322604141d0219bd7
+  metadata.gz: bd4231387216bd3e6fd5af820f5570a5e3993f7ef869301aac161ccf7b07921b44a9acc335a3c42b0a33bdd3fa2bd7a1c9c565e24754981def4020cde345ef79
+  data.tar.gz: a1d3fe523931d0d18998172beaac5411444a7ed496a7b27fe97bd7fdc0532c2a86a8efef7ad239491188b44ff9d069f518c198c420af663f57d0bb4cefe47f19

data/README.md

@@ -1,4 +1,4 @@
-# qr_code plugin
+# Fastlane qr_code plugin
 
 [![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-qr_code)
 
@@ -12,15 +12,51 @@ fastlane add_plugin qr_code
 
 ## About qr_code
 
-Generates QR codes that you may use in the rest of your workflow.
+You can use this plugin to generate QR codes that you may use in the rest of your Fastlane workflow. 
 
-**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+This plugin was created because I needed a Fastlane equivalent of the [Bitrise step 'Create install page QR code'](https://www.bitrise.io/integrations/steps/create-install-page-qr-code).
 
-## Example
+The main use case is to generate a QR code to your app's install page, and then automatically post this QR code to Slack.
+
+The plugin outputs a PNG image of the QR code as well as an ANSI text representation that can be printed to a console.
 
-Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+## Example
 
-**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+Example usage of this plugin:
+
+```ruby
+lane :test do
+  code = qr_code(contents: 'https://q42.com/')
+  
+  # Print a ANSI text-representation of the QR code to the console
+  puts code['QR_CODE_TEXT']
+
+  # Store the QR code somewhere a PNG file to use it later on
+  FileUtils.cp(code['QR_CODE_PNG_PATH'], './qr_code.png')
+
+  # Upload QR code to S3...
+  aws_s3(
+    access_key: ENV["S3_ACCESS_KEY"],
+    secret_access_key: ENV["S3_SECRET_ACCESS_KEY"],
+    bucket: ENV["S3_BUCKET"],
+    region: ENV["S3_REGION"],
+    files: [
+      code['QR_CODE_PNG_PATH']
+    ],
+    upload_metadata: false
+  )
+  qr_code_image_url = lane_context[SharedValues::S3_FILES_OUTPUT_PATHS][0]
+
+  # ...and post it to Slack!
+  slack(
+    message: "Build succeeded! Scan the code to install it on your device.",
+    slack_url: ENV["SLACK_WEB_HOOK_URL"],
+    attachment_properties: {
+      image_url: qr_code_image_url,
+    }
+  )
+end
+```
 
 ## Run tests for this plugin
 

data/lib/fastlane/plugin/qr_code/actions/qr_code_action.rb

@@ -12,6 +12,9 @@ module Fastlane
     end
 
     class QrCodeAction < Action
+      # Hold references to the temporary files, so that they aren't garbage collected (and deleted) before the Fastlane workflow is finished.
+      @@temp_files = []
+
       def self.run(params)
         qr_code_contents = params[:contents].to_s
         UI.user_error!("No QR code contents given, pass using `contents: 'http://example.com/123'`") unless qr_code_contents.length > 0
@@ -24,7 +27,7 @@ module Fastlane
         temp_file.write(qr_code_png.to_s)
         qr_code_png_path = temp_file.path
         temp_file.close
-        IO.binwrite(qr_code_png_path, qr_code_png.to_s)
+        @@temp_files.append(temp_file)
 
         # Setting action and environment variables
         Actions.lane_context[SharedValues::QR_CODE_PNG_PATH] = qr_code_png_path

data/lib/fastlane/plugin/qr_code/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module QrCode
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-qr_code
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Mathijs Bernson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-08 00:00:00.000000000 Z
+date: 2022-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rqrcode