qrcodeable 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e0687a8556dd0ceb06b30bbba60b3237ecdc47f
+  data.tar.gz: df6ccc2ff007448fe9873183ea1d5c5fb57c6b73
+SHA512:
+  metadata.gz: db1ec9c539196bc49f2afe3645765647a0fe83fb2c36ece84abee30c11ed0ea7c77e56468447a65a2cce3725d3714a8897a0cfc80d41482b76839722c5699b3a
+  data.tar.gz: 63d8dcda9713b3f3551b8c76d2afa22d4320ef1b1a49a943ca4c565f62ce133d5896e0865973df189321d7c63b3af6a8237cfbd6596cf9abf5d82d9ac021d8a3

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+README.html

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at m.yunan.helmy@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in qrcodeable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 yunanhelmy
+
+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,115 @@
+# Qrcodeable
+
+Add qrcode support to your activerecord model.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'qrcodeable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install qrcodeable
+
+## Usage
+
+Add
+
+```ruby
+qrcodeable
+```
+
+to your model. You will need to add column `key` in your model using migration.
+
+Options :
+
+- `identifier`. A QRCode value used to generate QRCOde. Default value is `:key`
+- `print_path`. Default direcory for this gem. Default value is `"qrcodes/download"`
+- `expire_mode`. Set to `true` if you want QRCode have expired_date. Default value is `false`. 
+- `expire_column`. You will need to add column `:expired_date` using migration if you set `expire_mode` to `true`. Default value is `:expired_date`
+
+## Examples
+
+### Example 1
+
+```ruby
+qrcodeable
+```
+
+- identifier `:key`
+- print_path `"qrcodes/download"`
+- cannot expiring
+
+### Example 2
+
+```ruby
+qrcodeable identifier: :code
+```
+
+- identifier `:code`
+- print_path `"qrcodes/download"`
+- cannot expiring
+
+### Example 3
+
+```ruby
+qrcodeable identifier: :code, print_path: "public/downloads"
+```
+
+- identifier `:code`
+- print_path `"public/download"`
+- cannot expiring
+
+### Example 4
+
+```ruby
+qrcodeable expired_mode: true
+```
+
+- identifier `:key`
+- print_path `"qrcodes/download"`
+- can expiring
+- expire_colum `:expired_date`
+
+### Example 5
+
+```ruby
+qrcodeable expired_mode: true, expire_column: :due_date
+```
+
+- identifier `:key`
+- print_path `"qrcodes/download"`
+- can expiring
+- expire_colum `:due_date`
+
+
+
+## TODO:
+
+- Complete rspec
+- Create dummy rails app
+- Add generators for migration
+- Add support for other ORM
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yunanhelmy/qrcodeable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "qrcodeable"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/qrcodeable/core.rb

@@ -0,0 +1,93 @@
+module Qrcodeable
+  module Core
+
+    class QrcodeableError < StandardError
+      def self.invalid_identifier(i)
+        "Please add column #{i} by running migration"
+      end
+
+      def self.no_directory(d = nil)
+        dir = d.nil? ? "qrcodes/downloads" : d
+        "Please create a directory #{dir} in #{Rails.root.to_s}"
+      end
+    end
+
+    extend ActiveSupport::Concern
+ 
+    included do
+    end
+ 
+    module ClassMethods
+      def qrcodeable(args = {})
+        mattr_accessor :identifier, :print_path, :expire_mode, :expire_column
+        self.identifier = args[:identifier] || :key
+        self.print_path = args[:print_path] || "qrcodes/downloads"
+        self.expire_mode = args[:expire_mode] || false
+        self.expire_column = args[:expire_column] || :expired_date
+      end
+    end
+
+    def generate_qrcode
+      begin
+        return ::RQRCode::QRCode.new(instance_value_of(self.identifier).to_s, level: :h)
+      rescue RuntimeError => e
+        raise QrcodeableError.invalid_identifier(self.identifier)
+      end
+    end
+
+    def print_qrcode
+      begin
+        qrcode = generate_qrcode
+        png = qrcode.as_png(
+                  resize_gte_to: false,
+                  resize_exactly_to: false,
+                  fill: 'white',
+                  color: 'black',
+                  size: 512,
+                  border_modules: 0,
+                  module_px_size: 1,
+                  file: nil # path to write
+                  )
+        path = qrcode_path
+        File.open(path, 'wb') do |file|
+          file.write(png.to_s)
+        end
+        return path
+      rescue Errno::ENOENT => e
+        raise QrcodeableError.no_directory(self.print_path)
+      rescue RuntimeError => e
+        raise QrcodeableError.invalid_identifier(self.identifier)
+      end
+    end
+
+    def qrcode_path
+      begin
+        ::Rails.root.to_s+"/"+self.print_path+"/"+instance_value_of(self.identifier).to_s+".png"
+      rescue RuntimeError => e
+        raise QrcodeableError.invalid_identifier(self.identifier)
+      end
+    end
+
+    def qrcode_expired?
+      if can_expire?
+        if instance_value_of(self.expire_column)
+          (Time.now > instance_value_of(self.expire_column))
+        else
+          false
+        end 
+      else
+        false
+      end
+    end
+
+    def can_expire?
+      self.expire_mode
+    end
+
+    private
+    def instance_value_of(column)
+      self.send(column)
+    end
+
+  end
+end

data/lib/qrcodeable/hook.rb

@@ -0,0 +1,10 @@
+module Qrcodeable
+  module Hook
+    def qrcodeable(*args)
+      options = args.extract_options!
+      
+      include Qrcodeable::Core
+      qrcodeable(options)
+    end
+  end
+end

data/lib/qrcodeable/railtie.rb

@@ -0,0 +1,7 @@
+module Qrcodeable
+  class Railtie < Rails::Railtie
+    config.to_prepare do
+      ActiveRecord::Base.send(:extend, Qrcodeable::Hook)
+    end
+  end
+end

data/lib/qrcodeable/version.rb

@@ -0,0 +1,3 @@
+module Qrcodeable
+  VERSION = "1.0.2"
+end

data/lib/qrcodeable.rb

@@ -0,0 +1,8 @@
+require "qrcodeable/version"
+require 'qrcodeable/railtie' if defined?(Rails)
+require 'qrcodeable/hook'
+require 'rqrcode'
+require 'qrcodeable/core'
+
+module Qrcodeable
+end

data/qrcodeable.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'qrcodeable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "qrcodeable"
+  spec.version       = Qrcodeable::VERSION
+  spec.authors       = ["yunanhelmy"]
+  spec.email         = ["m.yunan.helmy@gmail.com"]
+
+  spec.summary       = "Add qrcode support to your activerecord model."
+  spec.description   = "Add qrcode support to your activerecord model."
+  spec.homepage      = "https://github.com/yunanhelmy/qrcodeable"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib", "lib/qrcodeable"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "activesupport", ">= 4.2.6"
+  spec.add_dependency "rqrcode", ">= 0.10.1"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: qrcodeable
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- yunanhelmy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+- !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: Add qrcode support to your activerecord model.
+email:
+- m.yunan.helmy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/qrcodeable.rb
+- lib/qrcodeable/core.rb
+- lib/qrcodeable/hook.rb
+- lib/qrcodeable/railtie.rb
+- lib/qrcodeable/version.rb
+- qrcodeable.gemspec
+homepage: https://github.com/yunanhelmy/qrcodeable
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/qrcodeable
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Add qrcode support to your activerecord model.
+test_files: []