BarcodeLookup 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffae6081b44cddfb461e26a8c4e486ff9889eb246405a0203d118f99dfcd0ce0
-  data.tar.gz: d497f3247141303c8a4278096e2c3a0950d6ab1ac76ab40d037716b8dded6337
+  metadata.gz: c2f38b0530ec5be37c36dfa7be524a647bbf9d9be259e4ce279fef52b902063d
+  data.tar.gz: 7dc47a5eff0f8c23a07fa16f50768009d84b7136369d3a904c5488be2dbc672a
 SHA512:
-  metadata.gz: 429a21ab7846c3701f0bb742ff63a7d1ac1dbeb5be8691e51dd40a3a9520514391f6cb37c5e66ca65c695ce08f745b94f106c0200b3e4cf6363c8d431c1509a5
-  data.tar.gz: 0dc6d618d4ec754291cc7f2eebca4cb712c5696f9466476655663015c9b33e1c6519ab3de5cd0a1ad890928195f4e0871d0ea1b2662878ae78ee25707c179ba7
+  metadata.gz: 6a35999870ff5c6a51db3a3b6060d5c5c2c05b0840a7abd04f8c6882f78bf49b8e73c7f66b984e536f8e24abeac5d7c515b55eac93162b13ef2d34d5c1013ce4
+  data.tar.gz: 5e137be0519a9ceb2b29c8cc8f5030168678a0aa9e2d3201fb043246d6afb4fa4cee044798708c7ced44a09347645e7b618de1da7fc08023c1114bc19b0612aa

data/lib/barcode_lookup.rb

@@ -8,7 +8,7 @@ class BarcodeLookup
   class Version # :nodoc:
     MAJOR = 1
     MINOR = 0
-    TINY  = 1
+    TINY  = 2
 
     String = [MAJOR, MINOR, TINY].join('.')
   end
@@ -35,7 +35,7 @@ class BarcodeLookup
   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.is_a?(Array) && result[0].key?('error')
+    return nil if no_result?(result)
 
     result[0]
   end
@@ -47,7 +47,7 @@ class BarcodeLookup
   def isbn_lookup(isbn)
     json = api_call("op=barcode-lookup&isbn=#{isbn}")
     result = JSON.parse(json)
-    return nil if result.is_a?(Array) && result[0].key?('error')
+    return nil if no_result?(result)
 
     result[0]
   end
@@ -61,10 +61,7 @@ class BarcodeLookup
   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.is_a?(Array) && result[0].key?('error')
-
-    result['productlist']
+    product_list(JSON.parse(json))
   end
 
   # Search for a similar product by name
@@ -76,10 +73,7 @@ class BarcodeLookup
   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.is_a?(Array) && result[0].key?('error')
-
-    result['productlist']
+    product_list(JSON.parse(json))
   end
 
   # Search for a product by category and name (exact match)
@@ -92,10 +86,7 @@ class BarcodeLookup
   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.is_a?(Array) && result[0].key?('error')
-
-    result['productlist']
+    product_list(JSON.parse(json))
   end
 
   # Search for all products that start with this barcode prefix
@@ -108,10 +99,7 @@ class BarcodeLookup
   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.is_a?(Array) && result[0].key?('error')
-
-    result['productlist']
+    product_list(JSON.parse(json))
   end
 
   # Lookup the issuing country for a single barcode (GTIN, EAN, UPC or ISBN-13)
@@ -122,7 +110,7 @@ class BarcodeLookup
   def issuing_country(ean)
     json = api_call("op=issuing-country&ean=#{ean}")
     result = JSON.parse(json)
-    return nil if result.is_a?(Array) && result[0].key?('error')
+    return nil if no_result?(result)
 
     result[0]['issuingCountry']
   end
@@ -136,11 +124,66 @@ class BarcodeLookup
   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.is_a?(Array) && result[0].key?('error')
+    return nil if no_result?(result)
 
     result[0]['barcode']
   end
 
+  # Find the Amazon ASIN for a barcode (GTIN, EAN, UPC or ISBN-13)
+  # returns nil if no ASIN was found
+  #
+  # Arguments:
+  # barcode: (String)
+  def find_asin_for_ean(ean)
+    json = api_call("op=asin-for-ean-lookup&ean=#{ean}")
+    result = JSON.parse(json)
+    return nil if !result.is_a?(Array) || no_result?(result)
+
+    result[0]['asin']
+  end
+
+  # Find the barcode (EAN) for an Amazon ASIN
+  # returns nil if no barcode was found
+  #
+  # Arguments:
+  # asin: (String)
+  def find_ean_for_asin(asin)
+    asin = CGI.escape(asin)
+    json = api_call("op=ean-for-asin-lookup&asin=#{asin}")
+    result = JSON.parse(json)
+    return nil if !result.is_a?(Array) || no_result?(result)
+
+    result[0]['ean']
+  end
+
+  # Find the Library of Congress Control Number (LCCN) for a barcode (GTIN, EAN, UPC or ISBN-13)
+  # returns nil if no LCCN was found
+  #
+  # Arguments:
+  # barcode: (String)
+  def find_lccn_for_ean(ean)
+    json = api_call("op=lccn-for-ean-lookup&ean=#{ean}")
+    result = JSON.parse(json)
+    return nil if !result.is_a?(Array) || no_result?(result)
+
+    result[0]['lccn']
+  end
+
+  # Find the barcode (EAN) for a Library of Congress Control Number (LCCN)
+  # there can be multiple barcodes for one LCCN, this returns the first one found
+  # returns nil if no barcode was found
+  #
+  # Arguments:
+  # lccn: (String)
+  def find_ean_for_lccn(lccn)
+    lccn = CGI.escape(lccn)
+    json = api_call("op=ean-for-lccn-lookup&lccn=#{lccn}")
+    result = JSON.parse(json)
+    return nil if !result.is_a?(Array) || no_result?(result)
+
+    result[0]['ean']
+  end
+
   # Set the HTTP timeout for API calls in seconds
   #
   # Arguments:
@@ -157,17 +200,31 @@ class BarcodeLookup
 
   protected
 
+  # true if the API returned an empty list or an error message instead of a result
+  def no_result?(result)
+    result.is_a?(Array) && (result.empty? || result[0].key?('error'))
+  end
+
+  # the product list of a search result, raises the error message if the API returned one
+  def product_list(result)
+    return [] if result.is_a?(Array) && result.empty?
+    raise result[0]['error'] if result.is_a?(Array) && result[0].key?('error')
+
+    result['productlist']
+  end
+
   def api_call(params, tries = 1)
     @uri = URI("#{@base_url}#{@token}&#{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)
+      request = Net::HTTP::Get.new(@uri.request_uri, {'User-Agent' => 'ruby-eansearch/1.0'})
       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')
+    credits = response['X-Credits-Remaining'].to_s.strip
+    @remain = credits.to_i if credits.match?(/\A\d+\z/)
     response.body
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: BarcodeLookup
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Relaxed Communications GmbH
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-13 00:00:00.000000000 Z
+date: 2026-09-20 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