qrcode_pix_ruby 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7d931df9ece2ebd9af528f72a1dda1efefda84c10524b3896194d0d34d96c22
-  data.tar.gz: dfb9495a14d4a1607f8451465bb009e8bff5a12816cb79f314e4b7572c60023b
+  metadata.gz: f7eb7efbeeae8bd694b4ba8b24ef1537237d3cb7d878eca2a1b3649bcd027263
+  data.tar.gz: bc78c8e7d4c7fb49b1420fdd7d6be4ba8075bacbae03b9f6c4783e4ea36d2f24
 SHA512:
-  metadata.gz: 5b58df6d23aa1f1c884218da52bacf1c0450e7534eef254522f32d021fda4be283b4d001b5a0b04488f208de62512e1e60ea1baccb54e13f98171f97825eae11
-  data.tar.gz: 7608914b8ef248a0f6705bc4d14483ffbb5a716009de911302fef9822136b5f51f5213999922df89a8053ba1cb32745887243f6c8f11df2ef5c84c9a8b1f1ed0
+  metadata.gz: a27ff9ff972c6b713df6ad9e3c5446229cba87df5ab5b821e6e836ac8cd068e49f196b866838e46e3c87e3d2cc00cfe7153a992683d4106dec5cbc0ea72da952
+  data.tar.gz: d1f7f61516434b3ccf71d3545c9361119c130315e4b565a108d277a5da052744e526bb2c2a43a5c6628ad1cd08f44b16abb83d97121f1118d648b1d8a11cd7e9

data/.github/mergeable.yml

@@ -0,0 +1,27 @@
+version: 2
+mergeable:
+  - when: pull_request.opened
+    validate: []
+    pass:
+      - do: comment
+        payload:
+          body: Thanks for creating a pull request! A maintainer will review your changes shortly.
+  - when: pull_request.*
+    validate:
+      - do: description
+        no_empty:
+          enabled: true
+          message: Please, provide for us an awesome description to your PR 🤝
+      - do: dependent
+        changed:
+          file: '*'
+          required: ['CHANGELOG.md']
+  - when: schedule.repository
+    validate:
+      - do: stale
+        days: 3
+        type: pull_request, issues
+    pass:
+      - do: comment
+        payload:
+          body: It looks old 🕰️

data/.github/workflows/ci.yml

@@ -18,7 +18,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: [2.3, 2.4, 2.5, 2.6, 2.7, 3.0]
+        ruby-version: [2.6, 2.7, 3.0]
     env:
       CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}
     steps:
@@ -29,6 +29,9 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby-version }}
 
+      - name: Update rubygems
+        run: gem update --system
+
       - name: Install dependencies
         run: bundle install
 

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  NewCops: enable
+  NewCops: disable
   SuggestExtensions: false
   Exclude:
     - spec/*

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+- ...
+
+## [0.6.0]- 2023-04-14
+
+- Fixed CI
+- Fixed CRC16 algorithm with rjust with 4 digits
+
 ## [0.5.0] - 2021-07-13
 
 - Add option to pass Pix informations directly in initializer

data/Dockerfile

@@ -1,5 +1,4 @@
-FROM ruby:3.0.0-alpine
-RUN apk update && apk add git
+FROM ruby:3.0.0
 WORKDIR /app
 COPY . .
 RUN bundle install

data/README.md

@@ -31,6 +31,19 @@ Or install it yourself as:
 
 ## Usage (examples)
 
+### Available parameters
+
+- pix_key/url
+- repeatable
+- currency
+- country_code
+- description
+- postal_code
+- merchant_name
+- merchant_city
+- transaction_id
+- amount
+
 ### Static QR Code
 
 ```ruby
@@ -87,7 +100,7 @@ puts pix.base64
 
 🚨 Important note: BACEN (Banco Central do Brasil) sets a variety of rules for each field in QRCode Payload (maximum number of characters, invalid values, mandatory and optional fields, and so on). So, pay attention that a QRCode payload+base64 generated by the gem can be valid, theorically, but may not be accepted in banking apps because of these restrictions (that are out of scope of gem).
 
-## Execute tests/specs
+## Execute tests/specs locally
 
 To execute gem tests locally, use Docker with the commands below:
 
@@ -102,13 +115,18 @@ docker build -t qrcode_pix_ruby_specs .
 docker run -v $(pwd):/app/ -it qrcode_pix_ruby_specs
 ```
 
-## Demo
+## Execute demo locally
 
-It's provided a simple demo app, in Heroku, that uses the gem always in latest commit. You can check and test your QRCodes here:
+To execute demo locally, use Docker with the commands below:
 
-https://qrcode-pix-ruby.herokuapp.com
+```bash
+git clone https://github.com/pedrofurtado/qrcode_pix_ruby
+cd qrcode_pix_ruby/demo/
+docker build -t qrcode_pix_ruby_demo .
 
-🚨 Important note: The first page load can be slow, because of Heroku free tier. But don't worry, the demo works well 🤓
+# Then, access http://localhost:3000 the see demo in action.
+docker run -p 3000:3000 -it qrcode_pix_ruby_demo
+```
 
 ## Useful links
 
@@ -135,6 +153,9 @@ https://qrcode-pix-ruby.herokuapp.com
 * https://github.com/EnssureIT/faz-um-pix
 * https://github.com/jesobreira/pixkey
 * https://github.com/pedrinholemes/pix-br
+* https://github.com/ceciliadeveza/gerarqrcodepix
+* https://www.bcb.gov.br/content/estabilidadefinanceira/SiteAssets/Manual%20do%20BR%20Code.pdf
+* https://www.bcb.gov.br/content/estabilidadefinanceira/spb_docs/ManualBRCode.pdf
 
 ## Contributing
 

data/demo/Dockerfile

@@ -0,0 +1,7 @@
+FROM ruby:3.0.0-alpine
+RUN apk update && apk add git
+WORKDIR /app
+COPY Gemfile Gemfile
+COPY config.ru config.ru
+RUN bundle install && bundle add webrick
+CMD bundle exec rackup -p 3000 --host 0.0.0.0

data/demo/Gemfile

@@ -3,3 +3,4 @@
 source 'https://rubygems.org'
 gem 'qrcode_pix_ruby', github: 'pedrofurtado/qrcode_pix_ruby', branch: 'master'
 gem 'rack'
+gem 'rackup'

data/demo/config.ru

@@ -9,17 +9,10 @@ def generate_html_with(env)
   pix         = QrcodePixRuby::Payload.new
 
   unless qrcode_data.empty?
-    pix.pix_key        = qrcode_data['pix_key']           if !qrcode_data['pix_key'].nil?        && !qrcode_data['pix_key'].empty?
-    pix.url            = qrcode_data['url']               if !qrcode_data['url'].nil?            && !qrcode_data['url'].empty?
-    pix.description    = qrcode_data['description']       if !qrcode_data['description'].nil?    && !qrcode_data['description'].empty?
-    pix.merchant_name  = qrcode_data['merchant_name']     if !qrcode_data['merchant_name'].nil?  && !qrcode_data['merchant_name'].empty?
-    pix.merchant_city  = qrcode_data['merchant_city']     if !qrcode_data['merchant_city'].nil?  && !qrcode_data['merchant_city'].empty?
-    pix.transaction_id = qrcode_data['transaction_id']    if !qrcode_data['transaction_id'].nil? && !qrcode_data['transaction_id'].empty?
-    pix.amount         = qrcode_data['amount']            if !qrcode_data['amount'].nil?         && !qrcode_data['amount'].empty?
-    pix.currency       = qrcode_data['currency']          if !qrcode_data['currency'].nil?       && !qrcode_data['currency'].empty?
-    pix.country_code   = qrcode_data['country_code']      if !qrcode_data['country_code'].nil?   && !qrcode_data['country_code'].empty?
-    pix.postal_code    = qrcode_data['postal_code']       if !qrcode_data['postal_code'].nil?    && !qrcode_data['postal_code'].empty?
-    pix.repeatable     = qrcode_data['repeatable'] == 't' if !qrcode_data['repeatable'].nil?     && !qrcode_data['repeatable'].empty?
+    qrcode_data.keys.each do |key|
+      v = qrcode_data[key]
+      pix.public_send("#{key}=", key == 'repeatable' ? v == 't' : v) unless v.empty? || v.nil?
+    end
 
     payload = <<-HTML
       <label for='payload'>Payload</label>
@@ -61,7 +54,7 @@ def generate_html_with(env)
               <strong>QRCode informations</strong>
               <br>
               <br>
-              <form action='https://qrcode-pix-ruby.herokuapp.com' method='post'>
+              <form action='/' method='post'>
                 <div class='mb-3'>
                   <div class='form-text'>
                     For static Pix, please fill the 'Pix key' field.<br>

data/lib/qrcode_pix_ruby/payload.rb

@@ -124,7 +124,7 @@ module QrcodePixRuby
         end
       end
 
-      "#{ID_CRC16}04#{result.to_s(16).upcase}"
+      "#{ID_CRC16}04#{result.to_s(16).upcase.rjust(4, '0')}"
     end
   end
 end

data/lib/qrcode_pix_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module QrcodePixRuby
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qrcode_pix_ruby
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Pedro Furtado
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-13 00:00:00.000000000 Z
+date: 2024-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rqrcode
@@ -80,8 +80,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/mergeable.yml"
 - ".github/workflows/ci.yml"
-- ".github/workflows/heroku.yml"
 - ".github/workflows/rubygems.yml"
 - ".gitignore"
 - ".rspec"
@@ -95,6 +95,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- demo/Dockerfile
 - demo/Gemfile
 - demo/config.ru
 - lib/qrcode_pix_ruby.rb
@@ -124,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: Ruby gem for Qrcode generation of Pix (Pagamento Instantâneo Brasileiro -

data/.github/workflows/heroku.yml

@@ -1,50 +0,0 @@
-name: Publish to Heroku
-
-on:
-  push:
-    branches: [master]
-
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Install Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 3.0
-
-      - name: Install dependencies
-        run: |
-          cd demo/
-          bundle install
-          bundle update qrcode_pix_ruby
-          cd ../
-
-      - name: Define Heroku credentials
-        run: |
-          cat > ~/.netrc <<EOF
-            machine api.heroku.com
-              login $HEROKU_EMAIL
-              password $HEROKU_API_KEY
-            machine git.heroku.com
-              login $HEROKU_EMAIL
-              password $HEROKU_API_KEY
-          EOF
-        env:
-          HEROKU_API_KEY: ${{ secrets.HEROKU_API_KEY }}
-          HEROKU_EMAIL: ${{ secrets.HEROKU_EMAIL }}
-
-      - name: Define Heroku git remote
-        run: heroku git:remote --app $HEROKU_APP_NAME
-        env:
-          HEROKU_APP_NAME: ${{ secrets.HEROKU_APP_NAME }}
-
-      - name: Publish to Heroku
-        run: |
-          git config user.name 'Pedro Furtado'
-          git config user.email 'pedro.felipe.azevedo.furtado@gmail.com'
-          git add --all
-          git commit -m 'Publish to Heroku'
-          git push heroku `git subtree split --prefix demo master`:master --force