qrfy 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 629f1ee8024da3f88e97bb5e061e7a0b967a3c4b7f90fc561e5841cf6023a0ca
+  data.tar.gz: c3f2ec5cda144a854bc31e8119d43083020b75880a29b39ceec4141c33e3009f
+SHA512:
+  metadata.gz: 3ff77ce7959d10523f0957fa81fd13e3d96e9fb0ffcc4ea8b5c3fa49982ceae414dcb6b8502dc36d5d0cdca94813e1ae3f9d2d70d7a23a6076b6ab650c254401
+  data.tar.gz: 37cc82b523d1b002e509b4d6035319e1cb622f8ed38cf2af5cbe6fc41740ddca75ee2cbf276b61f7ce6dfd5bf04ca4a814b35776c5108632a281aa59cdd6a3b4

data/.rubocop.yml

@@ -0,0 +1,12 @@
+AllCops:
+  TargetRubyVersion: 2.7.8
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Metrics/AbcSize:
+  Exclude:
+    - "test/**/*"

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-08-05
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Wojciech Zygmuntowicz
+
+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,89 @@
+# Qrfy
+
+A really simple wrapper around https://qrfy.com/ API. Documentation of the API is here https://qrfy.com/docs/QR. To use that API you have to setup your API key first.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add qrfy
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install qrfy
+
+## Usage
+
+First setup the API key in the rails initializers
+
+```ruby
+# config/initializers/qrfy.rb
+Qrfy.configure do |config|
+    config.api_key = ENV["QRFY_API_KEY"]
+end
+```
+
+You could setup the API key during the client initialization as well (if you set it up in the initializer, then it'll be used by default):
+```ruby
+client = Qrfy::Client.new(api_key: ENV["QRFY_API_KEY"])
+```
+
+## Resources
+
+### QR
+
+
+#### Create
+Create a new QR code:
+```ruby
+id = client.qrs.create(qr_params)
+```
+
+Create many QR codes at once:
+```ruby
+ids = client.qrs.create([qr_params1, qr_params2])
+```
+
+You can also attach global style for your qr images and folder in which it should be saved.
+```ruby
+id = client.qrs.create(qr_params, style: { shape: { style: :sparkle } }, folder_id: 1)
+```
+
+
+### Folder
+
+You can list folders by following that code:
+```ruby
+client.folders.list.each do |folder|
+    puts "Folder ##{folder.id} with name: #{folder.name} was created at: #{folder.created_at} and has #{folder.qrs} images attached."
+end
+```
+
+And create new folders using:
+```ruby
+folder_id = client.folders.create({ name: "My first folder" })
+```
+
+## Error handling
+
+This gem follows the exception error handling. All errors raised by this gem inherits from `Qrfy::Errors::Base` class and belong to the following categories:
+    
+    * `Qrfy::Errors::RecordInvalid`
+    * `Qrfy::Errors::Unauthorized`
+    * `Qrfy::Errors::RecordNotFound`
+    * `Qrfy::Errors::TooManyRequests`
+    * `Qrfy::Errors::InternalServerError`
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/w-zygmuntowicz/qrfy.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/qrfy/client.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+module Qrfy
+  # # Qrfy Client
+  #
+  # Hides actual implementation of HTTP API calls. You can overwrite the global configuration
+  # (api key or http adapter) passing values in the initializer.
+  class Client
+    BASE_URL = "https://qrfy.com/api/public"
+
+    attr_reader :api_key, :adapter
+
+    def initialize(config = {})
+      @api_key = config.key?(:api_key) ? config[:api_key] : Qrfy.configuration.api_key
+      @adapter = config.key?(:adapter) ? config[:adapter] : Qrfy.configuration.adapter
+
+      @stubs = config[:stubs]
+    end
+
+    def connection
+      @connection ||= Faraday.new(url: BASE_URL) do |conn|
+        conn.request :json
+
+        conn.response :parse_dates
+        conn.response :json, content_type: "application/json"
+
+        conn.adapter adapter, @stubs
+      end
+    end
+
+    def folders
+      Resources::Folders.new(self)
+    end
+
+    def qrs
+      Resources::Qrs.new(self)
+    end
+  end
+end

data/lib/qrfy/collection.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+module Qrfy
+  # # Qrfy Collection
+  #
+  # A way to abstract collection API responses.
+  class Collection
+    def initialize(data:, total:, next_cursor:, prev_cursor:)
+      @data = data
+      @total = total
+      @next_cursor = next_cursor
+      @prev_cursor = prev_cursor
+    end
+
+    class << self
+      def from_response(data, type:)
+        data.map { |attrs| type.new(attrs) }
+      end
+    end
+  end
+end

data/lib/qrfy/configuration.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+module Qrfy
+  # # Configuration
+  #
+  # A way to store connection configuration such as api_key or http adapter.
+  class Configuration
+    attr_accessor :api_key, :adapter
+
+    def initialize
+      @api_key = nil
+      @adapter = nil
+    end
+  end
+end

data/lib/qrfy/errors/base.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+module Qrfy
+  module Errors
+    # # Base Qrfy Error
+    #
+    # All of the namespaced errors should subclass the Base Qrfy Error.
+    class Base < StandardError; end
+  end
+end

data/lib/qrfy/errors/internal_server_error.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+module Qrfy
+  module Errors
+    # # Internal Server Qrfy Error
+    #
+    # Wrapper around the internal server error HTTP call response (codes 5XX).
+    class InternalServerError < Base; end
+  end
+end

data/lib/qrfy/errors/record_invalid.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+module Qrfy
+  module Errors
+    # # Record Invalid Qrfy Error
+    #
+    # Wrapper around the record invalid HTTP call response (code 400).
+    class RecordInvalid < Base; end
+  end
+end

data/lib/qrfy/errors/record_not_found.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+module Qrfy
+  module Errors
+    # # Record Not Found Qrfy Error
+    #
+    # Wrapper around the record not found HTTP call response (code 404).
+    class RecordNotFound < Base; end
+  end
+end

data/lib/qrfy/errors/too_many_requests.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+module Qrfy
+  module Errors
+    # # Too Many Requests Qrfy Error
+    #
+    # Wrapper around the too many requests HTTP call response (code 429).
+    class TooManyRequests < Base; end
+  end
+end

data/lib/qrfy/errors/unauthorized.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+module Qrfy
+  module Errors
+    # # Unauthorized Qrfy Error
+    #
+    # Wrapper around the unauthorized HTTP call response (code 401).
+    class Unauthorized < Base; end
+  end
+end

data/lib/qrfy/errors.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+module Qrfy
+  # # Qrfy Errors
+  #
+  # Each error raised by 3rd party gems should be catched and reraised with a custom namespaced errors.
+  module Errors
+    autoload :Base, "qrfy/errors/base"
+    autoload :InternalServerError, "qrfy/errors/internal_server_error"
+    autoload :RecordInvalid, "qrfy/errors/record_invalid"
+    autoload :RecordNotFound, "qrfy/errors/record_not_found"
+    autoload :TooManyRequests, "qrfy/errors/too_many_requests"
+    autoload :Unauthorized, "qrfy/errors/unathorized"
+  end
+end

data/lib/qrfy/objects/base.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+require "ostruct"
+
+module Qrfy
+  module Objects
+    # # Base Qrfy Object
+    #
+    # Base class to be subclassed from for each object generated from HTTP response.
+    class Base < OpenStruct
+      def initialize(attributes)
+        super to_ostruct(attributes)
+      end
+
+      def to_ostruct(obj)
+        if obj.is_a?(Hash)
+          OpenStruct.new(obj.transform_values { |val| to_ostruct(val) })
+        elsif obj.is_a?(Array)
+          obj.map { |o| to_ostruct(o) }
+        else
+          obj
+        end
+      end
+    end
+  end
+end

data/lib/qrfy/objects/folder.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+module Qrfy
+  module Objects
+    # # Folder Qrfy Object
+    #
+    # A way to organize or namespace your Qrs.
+    class Folder < Base
+      def created_at
+        createdAt
+      end
+    end
+  end
+end

data/lib/qrfy/objects/qr.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+module Qrfy
+  module Objects
+    # # Qr Qrfy Object
+    #
+    # The abstraction on the actual Qr image. Each Qr has it's id by which it should be referenced.
+    # For each Qr you can generate actual image in different image formats (png, webp, etc.).
+    class Qr < Base
+      def created_at
+        Time.at(createdAt)
+      end
+    end
+  end
+end

data/lib/qrfy/objects.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+module Qrfy
+  # # Qrfy Objects
+  #
+  # Hide implementation of the actual objects generated from response.
+  module Objects
+    autoload :Base, "qrfy/objects/base"
+    autoload :Folder, "qrfy/objects/folder"
+    autoload :Qr, "qrfy/objects/qr"
+  end
+end

data/lib/qrfy/resources/base.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+module Qrfy
+  module Resources
+    # # Base Qrfy Resource
+    #
+    # Implements a structure for specific REST qrfy resources and encapsulate API calls implementation.
+    class Base
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      private
+
+      def get_request(url, params: {}, headers: {})
+        handle_response client.connection.get(url, params, headers.merge({ "API-KEY" => client.api_key }))
+      end
+
+      def post_request(url, body:, headers: {})
+        handle_response client.connection.post(url, body, headers.merge({ "API-KEY" => client.api_key }))
+      end
+
+      def put_request(url, body:, headers: {})
+        handle_response client.connection.put(url, body, headers.merge({ "API-KEY" => client.api_key }))
+      end
+
+      def handle_response(response) # rubocop:disable Metrics/MethodLength
+        message = response.body["error"] if response.body.is_a?(Hash)
+
+        case response.status
+        when 400
+          raise Qrfy::Errors::RecordInvalid, "Your request was malformed. #{message}"
+        when 401
+          raise Qrfy::Errors::Unauthorized,
+                "You did not supply valid authentication credentials. #{message}"
+        when 404
+          raise Qrfy::Errors::RecordNotFound, "Not found (check if folder exists). #{message}"
+        when 429
+          raise Qrfy::Errors::TooManyRequests, "Your request exceeded the API rate limit. #{message}"
+        when 500, 503
+          raise Qrfy::Errors::InternalServerError,
+                "Could not perform the request due to server-side problems. #{message}"
+        end
+
+        response
+      end
+
+      def array_wrap(value)
+        value.is_a?(Array) ? value : [value]
+      end
+
+      def array_unwrap(ary)
+        return ary.first if ary.length == 1
+
+        ary
+      end
+    end
+  end
+end

data/lib/qrfy/resources/folders.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+module Qrfy
+  module Resources
+    # # Folder Qrfy Resource
+    #
+    # You can list and create new folders.
+    class Folders < Base
+      def list
+        response = get_request("folders")
+        Collection.from_response(response.body, type: Qrfy::Objects::Folder)
+      end
+
+      def create(**attributes)
+        response = post_request("folders", body: attributes)
+        response.body["id"]
+      end
+    end
+  end
+end

data/lib/qrfy/resources/qrs.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+module Qrfy
+  module Resources
+    # # Qrs Qrfy Resource
+    #
+    # A CRUD interface for the actual Qr API calls.
+    class Qrs < Base
+      def batch_delete(ids:)
+        post_request("qrs/batch-delete", body: { ids: ids })
+
+        true
+      end
+
+      def create(qrs, style: nil, folder_id: nil)
+        qrs = array_wrap(qrs)
+
+        body = { qrs: qrs }
+        body.merge(style: style) unless style.nil?
+        body.merge(folder: folder_id) unless folder_id.nil?
+
+        response = post_request("qrs", body: body)
+        array_unwrap(response.body["ids"])
+      end
+
+      def list
+        response = get_request("qrs")
+        Collection.from_response(response.body["data"], type: Qrfy::Objects::Qr)
+      end
+
+      def get(id)
+        response = get_request("qrs/#{id}")
+
+        Qrfy::Objects::Qr.new(response.body)
+      end
+
+      def retrieve_image(id, format: :png)
+        response = get_request("qrs/#{id}/#{format}")
+
+        response.body
+      end
+    end
+  end
+end

data/lib/qrfy/resources.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+module Qrfy
+  # # Qrfy Resources
+  #
+  # Resources are a way to abstract REST resources. Each time you want to interact with API
+  # you should use a subclass of a Base Resource.
+  module Resources
+    autoload :Base, "qrfy/resources/base"
+    autoload :Folders, "qrfy/resources/folders"
+    autoload :Qrs, "qrfy/resources/qrs"
+  end
+end

data/lib/qrfy/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Qrfy
+  VERSION = "0.1.1"
+end

data/lib/qrfy.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday/parse_dates"
+
+require_relative "qrfy/version"
+
+# :markup: markdown
+# :include: ../README.md
+module Qrfy
+  autoload :Client, "qrfy/client"
+  autoload :Configuration, "qrfy/configuration"
+  autoload :Resources, "qrfy/resources"
+  autoload :Errors, "qrfy/errors"
+  autoload :Objects, "qrfy/objects"
+  autoload :Collection, "qrfy/collection"
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Qrfy::Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/sig/qrfy.rbs

@@ -0,0 +1,4 @@
+module Qrfy
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: qrfy
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Wojciech Zygmuntowicz
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+- !ruby/object:Gem::Dependency
+  name: faraday-parse_dates
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+description: A really simple wrapper for qrfy.com API written in pure ruby.
+email:
+- wojciech.zygmuntowicz@geeknauts.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/qrfy.rb
+- lib/qrfy/client.rb
+- lib/qrfy/collection.rb
+- lib/qrfy/configuration.rb
+- lib/qrfy/errors.rb
+- lib/qrfy/errors/base.rb
+- lib/qrfy/errors/internal_server_error.rb
+- lib/qrfy/errors/record_invalid.rb
+- lib/qrfy/errors/record_not_found.rb
+- lib/qrfy/errors/too_many_requests.rb
+- lib/qrfy/errors/unauthorized.rb
+- lib/qrfy/objects.rb
+- lib/qrfy/objects/base.rb
+- lib/qrfy/objects/folder.rb
+- lib/qrfy/objects/qr.rb
+- lib/qrfy/resources.rb
+- lib/qrfy/resources/base.rb
+- lib/qrfy/resources/folders.rb
+- lib/qrfy/resources/qrs.rb
+- lib/qrfy/version.rb
+- sig/qrfy.rbs
+homepage: https://github.com/w-zygmuntowicz/qrfy
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/w-zygmuntowicz/qrfy/issues
+  source_code_uri: https://github.com/w-zygmuntowicz/qrfy/tree/v0.1.1
+  changelog_uri: https://github.com/w-zygmuntowicz/qrfy/releases/tag/v0.1.1
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.5
+signing_key:
+specification_version: 4
+summary: Wrapper for qrfy.com API.
+test_files: []