taggun 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d9deac5b17f94465ce0b5060e0d547c2ebcacafdf0a2c367c31d8fa9a989dadf
+  data.tar.gz: 2ed516231a7833549f90b0c29a053b30065cb0a4434c3b225ef78628f88397ba
+SHA512:
+  metadata.gz: 1441dde576a9c23737f555c8b08c7e47e735a5d276b174441448038cf00692017d458880d5fbdd66bbbb9bbd0488256f8d476a48174c66f864fe5400828fe8b4
+  data.tar.gz: fff179cc0515758753104ce86374a5ca8cf3faaed324f64e750ffc7f999dac00e85b4b3b2981b249d8eee78adcfb91eb3737e571d289ef9aa458fe3f93392663

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Sebastian Menhofer
+
+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,58 @@
+# Taggun
+This is a ruby gem for the [Taggun](https://www.taggun.io) receipt OCR-Engine.
+
+Currently we support the following scan types:
+
+- [x] URL
+- [ ] encoded
+- [ ] file
+- [ ] storage
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'taggun'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install taggun
+```
+
+## Usage
+First you have to set your API key provided by Taggun.
+
+Create an initializer `taggun.rb` with
+```ruby
+Taggun.configure do |config|
+  config.api_key = 'your_api_key'
+end
+```
+
+Then you can just call the Parser with
+```ruby
+taggun = Taggun::Parser.new
+
+taggun.from_url(Taggun::SIMPLE, 'url_to_image')
+```
+
+The `form_xxx` methods return the Taggun responses. See https://api.taggun.io for details.
+
+## TODOs
+- Implement more scan types
+- Documentation
+- Add tests
+- Publish to RubyGems
+
+
+## Contributing
+TODO
+
+## 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,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Taggun'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/generators/taggun/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Creates an initializer file for taggun.
+
+Example:
+    rails generate taggun valid_api_key
+
+    This will create:
+        config/initializers/taggun.rb

data/lib/generators/taggun/taggun_generator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class TaggunGenerator < Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+
+  argument :api_key, required: false
+
+  desc 'Configures Taggun with your api_key'
+  def generate_layout
+    template 'initializer.rb.erb', 'config/initializers/taggun.rb'
+  end
+end

data/lib/generators/taggun/templates/initializer.rb.erb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Configure Taggun here.
+# This file is filled with defaults.
+Taggun.configure do |config|
+  # Your Api-Key is required.
+  # You can get one from taggun.io
+<% if api_key %>
+  config.api_key = '<%= api_key %>'
+<% else %>
+  config.api_key = 'your_api_key'
+<% end %>
+  # Set true to avoid saving the receipt in storage.
+  # config.incognito = true
+
+  # Set true to force re-process image transcription if the receipt is already in storage
+  # config.refresh = false
+end

data/lib/taggun/acts_as_taggun.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Taggun
+  module ActsAsTaggun
+    extend ActiveSupport::Concern
+
+    included do
+      def parse_receipt_by_url(receipt_url)
+        Taggun::Parser.new.parse(SIMPLE, receipt_url)
+      end
+    end
+
+    class_methods do
+      def acts_as_taggun(options = {})
+      end
+    end
+  end
+end

data/lib/taggun/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Taggun
+  class Configuration
+    attr_accessor :api_key, :incognito, :refresh
+
+    def initialize
+      @api_key = nil
+      @incognito = true
+      @refresh = false
+    end
+  end
+end

data/lib/taggun/parser.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Taggun
+  # Basic parser class
+  class Parser
+    def initialize
+      raise(ArgumentError, 'Initializer missing. See README for details') if Taggun.configuration.nil?
+      raise(ArgumentError, 'Api Key not set. See README for details.') if Taggun.configuration.api_key.nil?
+    end
+
+    # Parse the receipt from url
+    #
+    # === Arguments
+    #
+    # * +url+ - The URL to parse from as +String+
+    #
+    # * +method+ - The method to get. Valid values are +Taggun::Simple+
+    #   and +Taggun::Verbose+. Default is +Taggun::Simple+
+    #
+    # Returns a +JSON+ with the result from Taggun.io
+    def from_url(url, method = Taggun::SIMPLE)
+      uri = URI.parse("#{BASE_URL}/#{RECEIPT_URL}/#{API_VERSION}/#{method}/#{URL}")
+
+      body = {
+        url: url,
+        incognito: Taggun.configuration.incognito,
+        refresh: Taggun.configuration.refresh
+      }
+
+      parse(uri, body)
+    end
+
+    def from_file(method, file)
+      # TODO
+    end
+
+    def from_encoded(method, encoded)
+      # TODO
+    end
+
+    def from_storage(method, md5)
+      # TODO
+    end
+
+    def parse(uri, body)
+      http         = ::Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+
+      request = ::Net::HTTP::Post.new(
+        uri.request_uri,
+        'Content-Type': 'application/json'
+      )
+      request['apikey'] = Taggun.configuration.api_key
+
+      request.body = body.to_json
+
+      response = http.request(request)
+
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/taggun/railtie.rb

@@ -0,0 +1,4 @@
+module Taggun
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/taggun/version.rb

@@ -0,0 +1,3 @@
+module Taggun
+  VERSION = '0.4.0'
+end

data/lib/taggun.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "taggun/railtie"
+require 'taggun/acts_as_taggun'
+require 'taggun/configuration'
+require 'taggun/parser'
+require 'net/http'
+
+module Taggun
+
+  # The base taggun api URL
+  BASE_URL    = 'https://api.taggun.io/api'.freeze
+
+  # The Api version to use
+  API_VERSION = 'v1'.freeze
+
+  # URL for receipt actions
+  RECEIPT_URL = 'receipt'.freeze
+
+  # URL for account actions
+  ACCOUNT_URL = 'account'.freeze
+
+  # API endpoint to use file parsing
+  FILE = 'file'.freeze
+
+  # API endpoint to use encoded parsing
+  ENCODED = 'encoded'.freeze
+
+  # API endpoint to use storage parsing
+  STORAGE = 'storage'.freeze
+
+  # API endpoint to use URL parsing
+  URL = 'url'.freeze
+
+  # API endpoint to get simple response
+  SIMPLE  = 'simple'.freeze
+
+  # API endpoint to get detailed response
+  VERBOSE = 'verbose'.freeze
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  require 'taggun/railtie' if defined?(Rails)
+end

data/lib/tasks/taggun_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :taggun do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: taggun
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Sebastian Menhofer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.2.1
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby gem for the Taggun receipt OCR-Engine
+email:
+- sebastian.menhofer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/taggun/USAGE
+- lib/generators/taggun/taggun_generator.rb
+- lib/generators/taggun/templates/initializer.rb.erb
+- lib/taggun.rb
+- lib/taggun/acts_as_taggun.rb
+- lib/taggun/configuration.rb
+- lib/taggun/parser.rb
+- lib/taggun/railtie.rb
+- lib/taggun/version.rb
+- lib/tasks/taggun_tasks.rake
+homepage: https://github.com/pabse/taggun-rb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Ruby gem for the Taggun receipt OCR-Engine
+test_files: []