alpr_ruby 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b031fd67ab51bd7f10c949eefe67c40397fdf5b
+  data.tar.gz: 6574be8152079036844d4088f408b8a9531f726c
+SHA512:
+  metadata.gz: 3088c41d85362dba221dc39e71848ca1bc521940bc9f50896c65fef3c5e6a02f969a73b786042062970ac6126e297676bb5ebc85c3ed348000d06fcd1ecd3475
+  data.tar.gz: bb996065090ca5023c4fe38ce0aff287c663016fff0f09a362ffedfc84fd379b091bf3e9367bdbe9e7c81bfb4732c0ad27536409a1cd7a206d9ef6471330b155

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

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 mateuszurbanski@yahoo.pl. 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 alpr_ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Mateusz Urbański
+
+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,43 @@
+[![Build Status](https://travis-ci.org/MatUrbanski/alpr_ruby.svg?branch=master)](https://travis-ci.org/MatUrbanski/alpr_ruby)
+
+# AlprRuby
+
+Ruby wrapper for OpenALPR REST API
+[API Documents/Play Ground](http://doc.openalpr.com/api/cloudapi.html#!/default/post_recognize)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'alpr_ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install alpr_ruby
+
+## Usage
+
+### Initialize client
+
+```ruby
+AlprRuby::Client.new(secret: 'your_secret_here')
+```
+
+### Send data to OpenALPR API
+
+```ruby
+params = {
+  image_url: 'http://www.motofilm.pl/wp-content/uploads/2010/04/audi_a8_prezentacja_270410_03_glo.jpg',
+  tasks: 'plate',
+  topn: 1,
+  country: 'eu'
+}
+
+client.recognize(params: params)
+```

data/Rakefile

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

data/alpr_ruby.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'alpr_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'alpr_ruby'
+  spec.version       = AlprRuby::VERSION
+  spec.authors       = ["Mateusz Urbański"]
+  spec.email         = ['mateuszurbanski@yahoo.pl']
+
+  spec.summary       = 'Ruby wrapper for OpenALPR Cloud API.'
+  spec.description   = 'Ruby wrapper for OpenALPR Cloud API. See
+                        https://http://doc.openalpr.com/bindings.html#cloud-api-commercial
+                        for more details'
+  spec.homepage      = 'https://github.com/MatUrbanski/alpr_ruby'
+  spec.license       = 'MIT'
+
+  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']
+
+  spec.add_dependency 'typhoeus'
+  spec.add_dependency 'virtus'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'vcr', '~> 3.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'alpr_ruby'
+
+# 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/alpr_ruby.rb

@@ -0,0 +1,18 @@
+require 'typhoeus'
+require 'virtus'
+
+require 'alpr_ruby/version'
+require 'alpr_ruby/error'
+require 'alpr_ruby/connection'
+require 'alpr_ruby/client'
+require 'alpr_ruby/candidate'
+require 'alpr_ruby/coordinate'
+require 'alpr_ruby/result'
+require 'alpr_ruby/plate'
+require 'alpr_ruby/color'
+require 'alpr_ruby/make'
+require 'alpr_ruby/model'
+require 'alpr_ruby/recognition'
+
+module AlprRuby
+end

data/lib/alpr_ruby/candidate.rb

@@ -0,0 +1,9 @@
+module AlprRuby
+  class Candidate
+    include Virtus.model
+
+    attribute :matches_template, Integer
+    attribute :plate, String
+    attribute :confidence, Float
+  end
+end

data/lib/alpr_ruby/client.rb

@@ -0,0 +1,17 @@
+module AlprRuby
+  class Client
+    def initialize(secret:)
+      @api = AlprRuby::Connection.new(secret: secret)
+    end
+
+    def recognize(params: {})
+      response = @api.call(
+        endpoint: 'recognize',
+        method: :post,
+        params: params
+      )
+
+      AlprRuby::Recognition.new(response)
+    end
+  end
+end

data/lib/alpr_ruby/color.rb

@@ -0,0 +1,8 @@
+module AlprRuby
+  class Color
+    include Virtus.model
+
+    attribute :confidence, Float
+    attribute :value, String
+  end
+end

data/lib/alpr_ruby/connection.rb

@@ -0,0 +1,25 @@
+require 'json'
+
+module AlprRuby
+  class Connection
+    BASE_URL = 'https://api.openalpr.com/v1'.freeze
+
+    def initialize(secret:)
+      @secret = secret
+    end
+
+    def call(endpoint:, method:, params: {})
+      response = Typhoeus::Request.new(
+        "#{BASE_URL}/#{endpoint}",
+        method: method,
+        params: { secret_key: @secret }.merge!(params),
+      ).run
+
+      if response.response_code != 200
+        AlprRuby::Error.new(code: response.response_code).render
+      end
+
+      JSON.parse(response.response_body)
+    end
+  end
+end

data/lib/alpr_ruby/coordinate.rb

@@ -0,0 +1,8 @@
+module AlprRuby
+  class Coordinate
+    include Virtus.model
+
+    attribute :y, Integer
+    attribute :x, Integer
+  end
+end

data/lib/alpr_ruby/error.rb

@@ -0,0 +1,23 @@
+module AlprRuby
+  class InvalidParametersError  < StandardError; end
+  class UnauthorizedError       < StandardError; end
+  class LimitUsageExceededError < StandardError; end
+  class TemporaryLimitExceeded  < StandardError; end
+
+  class Error
+    ERROR_TYPES = {
+      400 => InvalidParametersError,
+      401 => UnauthorizedError,
+      402 => LimitUsageExceededError,
+      403 => TemporaryLimitExceeded,
+    }
+
+    def initialize(code:)
+      @code = code
+    end
+
+    def render
+      fail ERROR_TYPES[@code]
+    end
+  end
+end

data/lib/alpr_ruby/make.rb

@@ -0,0 +1,8 @@
+module AlprRuby
+  class Make
+    include Virtus.model
+
+    attribute :confidence, Float
+    attribute :value, String
+  end
+end

data/lib/alpr_ruby/model.rb

@@ -0,0 +1,8 @@
+module AlprRuby
+  class Model
+    include Virtus.model
+
+    attribute :confidence, Float
+    attribute :value, String
+  end
+end

data/lib/alpr_ruby/plate.rb

@@ -0,0 +1,11 @@
+module AlprRuby
+  class Plate
+    include Virtus.model
+
+    attribute :img_height, Integer
+    attribute :img_width, Integer
+    attribute :results, Array[Result]
+    attribute :version, Integer
+    attribute :processing_time_ms, Float
+  end
+end

data/lib/alpr_ruby/recognition.rb

@@ -0,0 +1,18 @@
+module AlprRuby
+  class Recognition
+    include Virtus.model
+
+    attribute :plate, Plate
+    attribute :image_bytes, String
+    attribute :color, Array[Color]
+    attribute :make, Array[Make]
+    attribute :img_width, Integer
+    attribute :img_height, Integer
+    attribute :credits_monthly_used, Integer
+    attribute :makemodel, Array[Model]
+    attribute :total_processing_time, Float
+    attribute :credits_monthly_total, Integer
+    attribute :image_bytes_prefix, String
+    attribute :credit_cost, Integer
+  end
+end

data/lib/alpr_ruby/result.rb

@@ -0,0 +1,15 @@
+module AlprRuby
+  class Result
+    include Virtus.model
+
+    attribute :plate, String
+    attribute :confidence, Float
+    attribute :region_confidence, Integer
+    attribute :plate_index, Integer
+    attribute :processing_time_ms, Float
+    attribute :candidates, Array[Candidate]
+    attribute :coordinates, Array[Coordinate]
+    attribute :matches_template, Integer
+    attribute :requested_topn, Integer
+  end
+end

data/lib/alpr_ruby/version.rb

@@ -0,0 +1,3 @@
+module AlprRuby
+  VERSION = '0.2.0'.freeze
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: alpr_ruby
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Mateusz Urbański
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: vcr
+  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'
+description: |-
+  Ruby wrapper for OpenALPR Cloud API. See
+                          https://http://doc.openalpr.com/bindings.html#cloud-api-commercial
+                          for more details
+email:
+- mateuszurbanski@yahoo.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- alpr_ruby.gemspec
+- bin/console
+- bin/setup
+- lib/alpr_ruby.rb
+- lib/alpr_ruby/candidate.rb
+- lib/alpr_ruby/client.rb
+- lib/alpr_ruby/color.rb
+- lib/alpr_ruby/connection.rb
+- lib/alpr_ruby/coordinate.rb
+- lib/alpr_ruby/error.rb
+- lib/alpr_ruby/make.rb
+- lib/alpr_ruby/model.rb
+- lib/alpr_ruby/plate.rb
+- lib/alpr_ruby/recognition.rb
+- lib/alpr_ruby/result.rb
+- lib/alpr_ruby/version.rb
+homepage: https://github.com/MatUrbanski/alpr_ruby
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for OpenALPR Cloud API.
+test_files: []