BarcodeLookup 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a28e213b6d64fb8bc3149d00c04748a55381b5f630a274d80d5cb4dcffebef6f
+  data.tar.gz: 16f23ea5e1a6380f879a5431641c2af6612a7f034b315145f77632e5bff16cba
+SHA512:
+  metadata.gz: 55b32aa5fac33197529cb6c8eb57dbd30894e30da3000318cd6d7fefeb85efa773a15cbaa5c970cab9986f3e47c76e42b53fc24fe6f78979edd2e7665e0ee735
+  data.tar.gz: 55a4d15030ba979c2fe59ff36f57b539fa5d2efccdab76bec791fb0339ae382003dd21365b973f4082878db17b969400dd6e9eccb3596803cc630af8ab0dc04d

data/lib/BarcodeLookup.rb

@@ -0,0 +1,166 @@
+require 'net/http'
+require 'cgi'
+require 'json'
+
+# Provide access to barcode lookup, validation and product search through the EAN-Search.org API
+class BarcodeLookup
+
+	class Version #:nodoc:
+		Major = 1
+		Minor = 0
+		Tiny  = 0
+
+		String = [Major, Minor, Tiny].join('.')
+	end
+
+    # Initialize the class with an API access token from ean-search.org
+    # See https://www.ean-search.org/ean-database-api.html
+    #
+    # Arguments:
+    # api_token: (String)
+    def initialize(api_token)
+        @token = api_token
+        @baseURL = 'https://api.ean-search.org/api?format=json&token='
+        @timeout = 180
+        @max_api_tries = 3
+        @remain = -1
+    end
+
+    # Lookup a single barcode (GTIN, EAN, UPC or ISBN-13)
+    # you can optionally specify a preferred language for the product name
+    #
+    # Arguments:
+    # barcode: (String)
+    # language code: (Integer)
+    def barcode_lookup(ean, preferred_lang = 1)
+        json = api_call("op=barcode-lookup&ean=#{ean}&language=#{preferred_lang}")
+        result = JSON.parse(json)
+        return nil if result.kind_of?(Array) && result[0].key?("error")
+        result[0]
+    end
+
+    # Lookup a single ISBN (ISBN-10)
+    #
+    # Arguments:
+    # isbn: (String)
+    def isbn_lookup(isbn)
+        json = api_call("op=barcode-lookup&isbn=#{isbn}")
+        result = JSON.parse(json)
+        return nil if result.kind_of?(Array) && result[0].key?("error")
+        result[0]
+    end
+
+    # Search for a product by name (exact match)
+    #
+    # Arguments:
+    # name: (String)
+    # language code: (Integer)
+    # page: (Integer)
+    def product_search(name, preferred_lang = 1, page = 0)
+        name = CGI.escape(name)
+        json = api_call("op=product-search&name=#{name}&language=#{preferred_lang}&page=#{page}")
+        result = JSON.parse(json)
+        raise result[0]['error'] if result.kind_of?(Array) && result[0].key?("error")
+        result['productlist']
+    end
+
+    # Search for a similar product by name
+    #
+    # Arguments:
+    # name: (String)
+    # language code: (Integer)
+    # page: (Integer)
+    def similar_product_search(name, preferred_lang = 1, page = 0)
+        name = CGI.escape(name)
+        json = api_call("op=similar-product-search&name=#{name}&language=#{preferred_lang}&page=#{page}")
+        result = JSON.parse(json)
+        raise result[0]['error'] if result.kind_of?(Array) && result[0].key?("error")
+        result['productlist']
+    end
+
+    # Search for a product by category and name (exact match)
+    #
+    # Arguments:
+    # category code: (Integer)
+    # name: (String)
+    # language code: (Integer)
+    # page: (Integer)
+    def category_search(category, name, preferred_lang = 1, page = 0)
+        name = CGI.escape(name)
+        json = api_call("op=category-search&category=#{category}&name=#{name}&language=#{preferred_lang}&page=#{page}")
+        result = JSON.parse(json)
+        raise result[0]['error'] if result.kind_of?(Array) && result[0].key?("error")
+        result['productlist']
+    end
+
+    # Search for all products that start with this barcode prefix
+    #
+    # Arguments:
+    # prefix: (String)
+    # language code: (Integer)
+    # page: (Integer)
+    # only results in the preferred language: (Boolean)
+    def barcode_prefix_search(prefix, preferred_lang = 1, page = 0, only_preferred_language = true)
+        only_preferred_language = (only_preferred_language ? 1 : 0)
+        json = api_call("op=barcode-prefix-search&prefix=#{prefix}&language=#{preferred_lang}&only-preferred-language=#{only_preferred_language}&page=#{page}")
+        result = JSON.parse(json)
+        raise result[0]['error'] if result.kind_of?(Array) && result[0].key?("error")
+        result['productlist']
+    end
+
+    # Lookup the issuing country for a single barcode (GTIN, EAN, UPC or ISBN-13)
+    # this works even if we don't have a product name for this barcode in our database
+    #
+    # Arguments:
+    # barcode: (String)
+    def issuing_country(ean)
+        json = api_call("op=issuing-country&ean=#{ean}")
+        result = JSON.parse(json)
+        return nil if result.kind_of?(Array) && result[0].key?("error")
+        result[0]['issuingCountry']
+    end
+
+    # Generate a PNG barcode image fort a code (GTIN, EAN, UPC or ISBN-13)
+    #
+    # Arguments:
+    # barcode: (String)
+    # width: (Integer)
+    # height: (Integer)
+    def barcode_image(ean, width = 102, height = 50)
+        json = api_call("op=barcode-image&ean=#{ean}&width=#{width}&height=#{height}")
+        result = JSON.parse(json)
+        return nil if result.kind_of?(Array) && result[0].key?("error")
+        result[0]['barcode']
+    end
+
+    # Set the HTTP timeout for API calls in second
+    #
+    # Arguments:
+    # second: (Integer)
+    def set_timeout(sec)
+        # Set HTTP timeout in seconds
+        @timeout = sec
+    end
+
+    # Get the number of credits remaining for API calls
+    # will return -1 before the first API call is made
+    def credits_remaining()
+        return @remain
+    end
+
+    protected
+
+    def api_call(params, tries = 1)
+        @uri = URI(@baseURL.to_s + @token.to_s + '&' + params)
+        response = Net::HTTP.start(@uri.host, @uri.port, use_ssl: true, read_timeout: @timeout) do |http|
+            request = Net::HTTP::Get.new(@uri.request_uri)
+            http.request(request)
+        end
+        if (response.code == "429" && tries < @max_api_tries)
+            sleep 1
+            return api_call(params, tries+1)
+        end
+        @remain = response['X-Credits-Remaining'] if response.key?("X-Credits-Remaining")
+        return response.body
+    end
+end

metadata

@@ -0,0 +1,44 @@
+--- !ruby/object:Gem::Specification
+name: BarcodeLookup
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Relaxed Communications GmbH
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-01-13 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby Gem for GTIN, UPC, EAN and ISBN barcode lookup and validation
+  using the API on ean-search.org
+email: info@relaxedcommunications.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/BarcodeLookup.rb
+homepage: https://github.com/eansearch/ruby-barcode-lookup
+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: []
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 4
+summary: A Ruby Gem for GTIN, UPC, EAN and ISBN barcode lookup and validation
+test_files: []