rosette_api 1.14.3 → 1.27.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88f16158b8883961fecc410ce85c874914d8610a3e179955f5d2429fb2c4b7ab
-  data.tar.gz: 818932647be367d98c903e4487ba52bd8164f686f0c16be791a8cc54a3b30cc5
+  metadata.gz: 3d5037aff054e99e751a771f2f320382aeb888c42e50791c1a4c4ddcb17eebe0
+  data.tar.gz: f61eaa6cd0cf434208dba133666d9b3886ad9395858d871dcd4058cf5a293b74
 SHA512:
-  metadata.gz: c1cc5483c3e5e4ed59104c82a14c548b303f85d7be9bb74551b8dbec467de16b15b23fbc9bf7b4374aade07f41bd1d2ac2b16ec509293ceeccb4ca5f35922650
-  data.tar.gz: 0fa5063ae2d6765314df3b33c1a0620b974b24a8c0c3b627c5617b75ca9e13d1ac1d62a2d4522464004e654c24f4217c52e164d606690ff8697ccd83389fa2f2
+  metadata.gz: a0106a3b3b555bc4c49284740e348356262bce1b39a44dee87651127b8a07192fe5a26a726d1eb60d95af0d8c8e1087b3074f1440de4958752e5c2a1cd2b204e
+  data.tar.gz: 966fbc85cadb4b09b53879ee1b3d6f7d7c91a21c7ffb4bc51e1f43f58524bf5ed6c0e8f3547539341bf2a9132f092a6248953d3ab5f290b78c7d2cf204313d2b

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2016-2019 Basis Technology Corporation.
+Copyright (c) 2016-2024 Basis Technology Corporation.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -1,8 +1,8 @@
-<a href="https://www.rosette.com"><img src="https://s3.amazonaws.com/styleguide.basistech.com/logos/rosette-logo.png" width="181" height="47" /></a>
+<a href="https://www.babelstreet.com/rosette"><img src="https://s3.amazonaws.com/styleguide.basistech.com/logos/rosette-logo.png" width="181" height="47" /></a>
 
 ---
 
-[![Build Status](https://travis-ci.org/rosette-api/ruby.svg?branch=develop)](https://travis-ci.org/rosette-api/ruby) [![Gem Version](https://badge.fury.io/rb/rosette_api.svg)](https://badge.fury.io/rb/rosette_api)
+[![Gem Version](https://badge.fury.io/rb/rosette_api.svg)](https://badge.fury.io/rb/rosette_api)
 
 ## Rosette API
 The Rosette Text Analytics Platform uses natural language processing, statistical modeling, and machine learning to
@@ -12,7 +12,6 @@ comparing the similarity of names, categorizing and adding linguistic tags to te
 
 ## Rosette API Access
 - Rosette Cloud [Sign Up](https://developer.rosette.com/signup)
-- Rosette Enterprise [Evaluation](https://www.rosette.com/product-eval/)
 
 ## Quick Start
 

data/examples/README.md

@@ -13,7 +13,7 @@ A note on prerequisites. Rosette API only suports TLS 1.2 so ensure your toolcha
 ```
 git clone git@github.com:rosette-api/ruby.git
 cd ruby
-docker run -it -v $(pwd):/source --entrypoint bash ruby:2.6-slim-stretch
+docker run -it -v $(pwd):/source --entrypoint bash ruby:3.3-slim
 
 gem install rosette_api
 
@@ -25,7 +25,7 @@ ruby ping.rb $API_KEY
 ```
 git clone git@github.com:rosette-api/ruby.git
 cd ruby
-docker run -it -v $(pwd):/source --entrypoint bash ruby:2.6-slim-stretch
+docker run -it -v $(pwd):/source --entrypoint bash ruby:3.3-slim
 
 cd /source
 gem build rosette_api.gemspec

data/examples/address_similarity.rb

@@ -18,13 +18,7 @@ begin
     state: 'DC',
     post_code: '20500'
   )
-  address2 = AddressParameter.new(
-    house_number: '160',
-    road: 'Pennsilvana Avenue',
-    city: 'Washington',
-    state: 'D.C.',
-    post_code: '20500'
-  )
+  address2 = '160 Pennsilvana Avenue, Washington, D.C., 20500'
   params = AddressSimilarityParameters.new(address1, address2)
   response = rosette_api.get_address_similarity(params)
   puts JSON.pretty_generate(response)

data/examples/categories.rb

@@ -10,11 +10,9 @@ rosette_api = if url
                 RosetteAPI.new(api_key)
               end
 
-categories_url_data =
-  'https://onlocationvacations.com/2015/03/05/the-new-ghostbusters-movie-' \
-  'begins-filming-in-boston-in-june/'
+categories_text_data = 'If you are a fan of the British television series Downton Abbey and you are planning to be in New York anytime before April 2nd, there is a perfect stop for you while in town.'
 begin
-  params = DocumentParameters.new(content_uri: categories_url_data)
+  params = DocumentParameters.new(content: categories_text_data)
   response = rosette_api.get_categories(params)
   puts JSON.pretty_generate(response)
 rescue RosetteAPIError => e

data/examples/entities.rb

@@ -10,18 +10,9 @@ rosette_api = if url
                 RosetteAPI.new(api_key)
               end
 
-entities_text_data = 'The Securities and Exchange Commission today ' \
-  'announced the leadership of the agency\'s trial unit. Bridget Fitzpatrick ' \
-  'has been named Chief Litigation Counsel of the SEC and David Gottesman ' \
-  'will continue to serve as the agency\'s Deputy Chief Litigation Counsel. ' \
-  'Since December 2016, Ms. Fitzpatrick and Mr. Gottesman have served as ' \
-  'Co-Acting Chief Litigation Counsel.  In that role, they were jointly ' \
-  'responsible for supervising the trial unit at the agency\'s Washington ' \
-  'D.C. headquarters as well as coordinating with litigators in the SEC\'s ' \
-  '11 regional offices around the country.'
+entities_text_data = 'The Securities and Exchange Commission today announced the leadership of the agency\'s trial unit. Bridget Fitzpatrick has been named Chief Litigation Counsel of the SEC and David Gottesman will continue to serve as the agency\'s Deputy Chief Litigation Counsel. Since December 2016, Ms. Fitzpatrick and Mr. Gottesman have served as Co-Acting Chief Litigation Counsel.  In that role, they were jointly responsible for supervising the trial unit at the agency\'s Washington D.C. headquarters as well as coordinating with litigators in the SEC\'s 11 regional offices around the country.'
 begin
-  params = DocumentParameters.new(content: entities_text_data,
-                                  genre: 'social-media')
+  params = DocumentParameters.new(content: entities_text_data)
   response = rosette_api.get_entities(params)
   puts JSON.pretty_generate(response)
 rescue RosetteAPIError => e

data/examples/language_multilingual.rb

@@ -10,15 +10,7 @@ rosette_api = if url
                 RosetteAPI.new(api_key)
               end
 
-language_multilingual_data = 'On Thursday, as protesters gathered in ' \
-  'Washington D.C., the United States Federal Communications Commission ' \
-  'under Chairman Ajit Pai voted 3-2 to overturn a 2015 decision, commonly ' \
-  'called Net Neutrality, that forbade Internet service providers (ISPs) ' \
-  'such as Verizon, Comcast, and AT&T from blocking individual websites or ' \
-  'charging websites or customers more for faster load times.  Quatre ' \
-  'femmes ont été nommées au Conseil de rédaction de la loi du Qatar. Jeudi, ' \
-  'le décret royal du Qatar a annoncé que 28 nouveaux membres ont été nommés ' \
-  'pour le Conseil de la Choura du pays.  ذكرت مصادر أمنية يونانية، أن 9 موقوفين من منظمة \"د هـ ك ب ج\" الذين كانت قد أوقفتهم الشرطة اليونانية في وقت سابق كانوا يخططون لاغتيال الرئيس التركي رجب طيب أردوغان.'
+language_multilingual_data = 'On Thursday, as protesters gathered in Washington D.C., the United States Federal Communications Commission under Chairman Ajit Pai voted 3-2 to overturn a 2015 decision, commonly called Net Neutrality, that forbade Internet service providers (ISPs) such as Verizon, Comcast, and AT&T from blocking individual websites or charging websites or customers more for faster load times.  Quatre femmes ont été nommées au Conseil de rédaction de la loi du Qatar. Jeudi, le décret royal du Qatar a annoncé que 28 nouveaux membres ont été nommés pour le Conseil de la Choura du pays.  ذكرت مصادر أمنية يونانية، أن 9 موقوفين من منظمة \"د هـ ك ب ج\" الذين كانت قد أوقفتهم الشرطة اليونانية في وقت سابق كانوا يخططون لاغتيال الرئيس التركي رجب طيب أردوغان.'
 
 begin
   params = DocumentParameters.new(content: language_multilingual_data)

data/examples/morphology_complete.rb

@@ -10,8 +10,7 @@ rosette_api = if url
                 RosetteAPI.new(api_key)
               end
 
-morphology_complete_data = 'The quick brown fox jumped over the lazy ' \
-  'dog. 👍🏾 Yes he did. B)'
+morphology_complete_data = 'The quick brown fox jumped over the lazy dog. 👍🏾 Yes he did. B)'
 begin
   params = DocumentParameters.new(content: morphology_complete_data)
   response = rosette_api.get_morphology_complete(params)

data/examples/morphology_lemmas.rb

@@ -10,9 +10,7 @@ rosette_api = if url
                 RosetteAPI.new(api_key)
               end
 
-morphology_lemmas_data =
-  'The fact is that the geese just went back to get a rest and I\'m not ' \
-  'banking on their return soon'
+morphology_lemmas_data = 'The fact is that the geese just went back to get a rest and I\'m not banking on their return soon'
 begin
   params = DocumentParameters.new(content: morphology_lemmas_data)
   response = rosette_api.get_lemmas(params)

data/examples/{morphology_parts_of_speech.rb → morphology_parts-of-speech.rb}

@@ -10,9 +10,7 @@ rosette_api = if url
                 RosetteAPI.new(api_key)
               end
 
-morphology_parts_of_speech_data =
-  'The fact is that the geese just went back to get a rest and I\'m not ' \
-  'banking on their return soon'
+morphology_parts_of_speech_data = 'The fact is that the geese just went back to get a rest and I\'m not banking on their return soon'
 begin
   params = DocumentParameters.new(content: morphology_parts_of_speech_data)
   response = rosette_api.get_parts_of_speech(params)

data/examples/name_deduplication.rb

@@ -10,9 +10,7 @@ rosette_api = if url
                 RosetteAPI.new(api_key)
               end
 
-name_dedupe_data = 'Alice Terry,Alice Thierry,Betty Grable,Betty Gable,' \
-  'Norma Shearer,Norm Shearer,Brigitte Helm,Bridget Helem,Judy Holliday,' \
-  'Julie Halliday'
+name_dedupe_data = 'Alice Terry,Alice Thierry,Betty Grable,Betty Gable,Norma Shearer,Norm Shearer,Brigitte Helm,Bridget Helem,Judy Holliday,Julie Halliday'
 
 threshold = 0.75
 names = name_dedupe_data.split(',').map { |n| NameParameter.new(n) }

data/examples/relationships.rb

@@ -10,15 +10,7 @@ rosette_api = if url
                 RosetteAPI.new(api_key)
               end
 
-relationships_text_data = 'FLIR Systems is headquartered in Oregon and ' \
-  'produces thermal imaging, night vision, and infrared cameras and sensor ' \
-  'systems.  According to the SEC\'s order instituting a settled ' \
-  'administrative proceeding, FLIR entered into a multi-million dollar ' \
-  'contract to provide thermal binoculars to the Saudi government in ' \
-  'November 2008.  Timms and Ramahi were the primary sales employees ' \
-  'responsible for the contract, and also were involved in negotiations to ' \
-  'sell FLIR\'s security cameras to the same government officials.  At the ' \
-  'time, Timms was the head of FLIR\'s Middle East office in Dubai.'
+relationships_text_data = 'FLIR Systems is headquartered in Oregon and produces thermal imaging, night vision, and infrared cameras and sensor systems.  According to the SEC\'s order instituting a settled administrative proceeding, FLIR entered into a multi-million dollar contract to provide thermal binoculars to the Saudi government in November 2008.  Timms and Ramahi were the primary sales employees responsible for the contract, and also were involved in negotiations to sell FLIR\'s security cameras to the same government officials.  At the time, Timms was the head of FLIR\'s Middle East office in Dubai.'
 
 begin
   params = DocumentParameters.new(content: relationships_text_data)

data/examples/sentences.rb

@@ -10,11 +10,7 @@ rosette_api = if url
                 RosetteAPI.new(api_key)
               end
 
-sentences_data = 'This land is your land. This land is my land, from ' \
-  'California to the New York island; from the red wood forest to the Gulf ' \
-  'Stream waters. This land was made for you and Me. As I was walking that ' \
-  'ribbon of highway, I saw above me that endless skyway: I saw below me ' \
-  'that golden valley: This land was made for you and me.'
+sentences_data = 'This land is your land. This land is my land, from California to the New York island; from the red wood forest to the Gulf Stream waters. This land was made for you and Me. As I was walking that ribbon of highway, I saw above me that endless skyway: I saw below me that golden valley: This land was made for you and me.'
 
 begin
   params = DocumentParameters.new

data/examples/sentiment.rb

@@ -12,13 +12,7 @@ rosette_api = if url
               end
 
 file = Tempfile.new(%w[foo .html])
-sentiment_file_data =
-  '<html><head><title>New Ghostbusters Film</title></head><body><p>Original ' \
-  'Ghostbuster Dan Aykroyd, who also co-wrote the 1984 Ghostbusters film, ' \
-  'couldn\'t be more pleased with the new all-female Ghostbusters cast, ' \
-  'telling The Hollywood Reporter, "The Aykroyd family is delighted by this ' \
-  'inheritance of the Ghostbusters torch by these most magnificent women in ' \
-  'comedy."</p></body></html>'
+sentiment_file_data = '<html><head><title>New Ghostbusters Film</title></head><body><p>Original Ghostbuster Dan Aykroyd, who also co-wrote the 1984 Ghostbusters film, couldn\'t be more pleased with the new all-female Ghostbusters cast, telling The Hollywood Reporter, "The Aykroyd family is delighted by this inheritance of the Ghostbusters torch by these most magnificent women in comedy."</p></body></html>'
 file.write(sentiment_file_data)
 file.close
 begin

data/examples/syntax_dependencies.rb

@@ -10,9 +10,7 @@ rosette_api = if url
                 RosetteAPI.new(api_key)
               end
 
-syntax_dependencies_data =
-  'Yoshinori Ohsumi, a Japanese cell biologist, was awarded the Nobel Prize ' \
-  'in Physiology or Medicine on Monday.'
+syntax_dependencies_data = 'Yoshinori Ohsumi, a Japanese cell biologist, was awarded the Nobel Prize in Physiology or Medicine on Monday.'
 
 begin
   params = DocumentParameters.new(content: syntax_dependencies_data)

data/examples/topics.rb

@@ -10,14 +10,8 @@ rosette_api = if url
                 RosetteAPI.new(api_key)
               end
 
-topics_data =
-  'Lily Collins is in talks to join Nicholas Hoult in Chernin Entertainment ' \
-  "and Fox Searchlight's J.R.R. Tolkien biopic Tolkien. Anthony Boyle, known " \
-  'for playing Scorpius Malfoy in the British play Harry Potter and the ' \
-  'Cursed Child, also has signed on for the film centered on the famed ' \
-  'author. In Tolkien, Hoult will play the author of the Hobbit and Lord of ' \
-  'the Rings book series that were later adapted into two Hollywood ' \
-  'trilogies from Peter Jackson. Dome Karukoski is directing the project.'
+topics_data = 'Lily Collins is in talks to join Nicholas Hoult in Chernin Entertainment and Fox Searchlight\'s J.R.R. Tolkien biopic Tolkien. Anthony Boyle, known for playing Scorpius Malfoy in the British play Harry Potter and the Cursed Child, also has signed on for the film centered on the famed author. In Tolkien, Hoult will play the author of the Hobbit and Lord of the Rings book series that were later adapted into two Hollywood trilogies from Peter Jackson. Dome Karukoski is directing the project.'
+
 begin
   params = DocumentParameters.new(content: topics_data)
   response = rosette_api.get_topics(params)

data/examples/transliteration.rb

@@ -10,8 +10,7 @@ rosette_api = if url
                 RosetteAPI.new(api_key)
               end
 
-transliteration_content_data =
-  'Kareem Abdul Jabbar holds the records for most points in the NBA'
+transliteration_content_data = 'ana r2ye7 el gam3a el sa3a 3 el 3asr'
 
 begin
   params = DocumentParameters.new

data/lib/address_parameter.rb

@@ -39,7 +39,7 @@ class AddressParameter
   # po_box (optional)
   attr_accessor :po_box
 
-  def initialize(options = {}) #:notnew:
+  def initialize(options = {}) # :notnew:
     options = {
       house: nil,
       house_number: nil,
@@ -85,8 +85,7 @@ class AddressParameter
   # Returns the new Hash.
   def load_param
     to_hash.select { |_key, value| value }
-           .map { |key, value| [key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase), value] }
-           .to_h
+           .transform_keys { |key| key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase) }
   end
 
   # Converts this class to Hash.

data/lib/address_similarity_parameters.rb

@@ -11,19 +11,19 @@ class AddressSimilarityParameters
   # Address to be compared to address1
   attr_accessor :address2
 
-  def initialize(address1, address2) #:notnew:
+  def initialize(address1, address2) # :notnew:
     @address1 = address1
     @address2 = address2
   end
 
   # Validates the parameters by checking if address1 and address2 are instances
-  # of AddressParameter.
+  # of AddressParameters or Strings.
   def validate_params
-    a1_msg = 'address1 option can only be an instance of an AddressParameter'
-    raise BadRequestError.new(a1_msg) if [AddressParameter].none? { |clazz| @address1.is_a? clazz }
+    a1_msg = 'address1 option can only be an instance of an AddressParameter or a String'
+    raise BadRequestError.new(a1_msg) if [String, AddressParameter].none? { |clazz| @address1.is_a? clazz }
 
-    a2_msg = 'address2 option can only be an instance of an AddressParameter'
-    raise BadRequestError.new(a2_msg) if [AddressParameter].none? { |clazz| @address2.is_a? clazz }
+    a2_msg = 'address2 option can only be an instance of an AddressParameter or a String'
+    raise BadRequestError.new(a2_msg) if [String, AddressParameter].none? { |clazz| @address2.is_a? clazz }
   end
 
   # Converts this class to Hash with its keys in lower CamelCase.
@@ -32,9 +32,8 @@ class AddressSimilarityParameters
   def load_params
     validate_params
     to_hash
-      .reject { |_key, value| value.nil? }
-      .map { |key, value| [key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase), value] }
-      .to_h
+      .compact
+      .transform_keys { |key| key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase) }
   end
 
   # Converts this class to Hash.

data/lib/bad_request_error.rb

@@ -4,7 +4,7 @@ require_relative 'rosette_api_error'
 
 # This class represents Rosette API errors with badRequest status_code.
 class BadRequestError < RosetteAPIError
-  def initialize(message) #:notnew:
-    super 'badRequest', message
+  def initialize(message) # :notnew:
+    super('badRequest', message)
   end
 end

data/lib/bad_request_format_error.rb

@@ -4,7 +4,7 @@ require_relative 'rosette_api_error'
 
 # This class represents Rosette API errors with badRequestFormat status_code.
 class BadRequestFormatError < RosetteAPIError
-  def initialize(message) #:notnew:
-    super 'badRequestFormat', message
+  def initialize(message) # :notnew:
+    super('badRequestFormat', message)
   end
 end

data/lib/document_parameters.rb

@@ -22,7 +22,7 @@ class DocumentParameters
   # custom Rosette API headers
   attr_accessor :custom_headers
 
-  def initialize(options = {}) #:notnew:
+  def initialize(options = {}) # :notnew:
     options = {
       content: nil,
       content_uri: nil,
@@ -45,11 +45,11 @@ class DocumentParameters
   # set or no content provided at all.
   def validate_params
     content_msg = 'The format of the request is invalid: multiple content ' \
-      'sources; must be one of an attachment, an inline "content" field, or ' \
-      'an external "contentUri"'
+                  'sources; must be one of an attachment, an inline "content" field, or ' \
+                  'an external "contentUri"'
     no_content_msg = 'The format of the request is invalid: no content ' \
-      'provided; must be one of an attachment, an inline "content" field, or ' \
-      'an external "contentUri"'
+                     'provided; must be one of an attachment, an inline "content" field, or ' \
+                     'an external "contentUri"'
     opt_msg = 'rosette_options can only be an instance of a Hash'
     if [@content, @content_uri, @file_path].compact.length > 1
       raise BadRequestFormatError.new(content_msg)
@@ -67,8 +67,7 @@ class DocumentParameters
     validate_params
     to_hash
       .select { |_key, value| value }
-      .map { |key, value| [key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase), value] }
-      .to_h
+      .transform_keys { |key| key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase) }
   end
 
   # Converts this class to Hash.

data/lib/name_deduplication_parameters.rb

@@ -13,7 +13,7 @@ class NameDeduplicationParameters
   # Threshold for determining cluster size
   attr_accessor :threshold
 
-  def initialize(names, threshold, options = {}) #:notnew:
+  def initialize(names, threshold, options = {}) # :notnew:
     options = {
       rosette_options: nil
     }.update options
@@ -35,9 +35,7 @@ class NameDeduplicationParameters
       raise BadRequestError.new(thresh_msg) if @threshold.negative? || @threshold > 1
     end
     opt_msg = 'rosette_options can only be an instance of a Hash'
-    if @rosette_options
-      raise BadRequestError.new(opt_msg) unless @rosette_options.is_a? Hash
-    end
+    raise BadRequestError.new(opt_msg) if @rosette_options && !(@rosette_options.is_a? Hash)
   end
 
   # Converts this class to Hash with its keys in lower CamelCase.
@@ -47,8 +45,7 @@ class NameDeduplicationParameters
     validate_params
     to_hash
       .select { |_key, value| value }
-      .map { |key, value| [key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase), value] }
-      .to_h
+      .transform_keys { |key| key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase) }
   end
 
   # Converts this class to Hash.

data/lib/name_parameter.rb

@@ -11,7 +11,7 @@ class NameParameter
   # Name to be analyzed
   attr_accessor :text
 
-  def initialize(text, options = {}) #:notnew:
+  def initialize(text, options = {}) # :notnew:
     options = {
       entity_type: nil,
       language: nil,
@@ -29,8 +29,7 @@ class NameParameter
   def load_param
     to_hash
       .select { |_key, value| value }
-      .map { |key, value| [key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase), value] }
-      .to_h
+      .transform_keys { |key| key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase) }
   end
 
   # Converts this class to Hash.

data/lib/name_similarity_parameters.rb

@@ -15,7 +15,7 @@ class NameSimilarityParameters
   # Name to be compared to name1
   attr_accessor :name2
 
-  def initialize(name1, name2, options = {}) #:notnew:
+  def initialize(name1, name2, options = {}) # :notnew:
     options = {
       genre: nil,
       rosette_options: nil
@@ -36,9 +36,7 @@ class NameSimilarityParameters
     raise BadRequestError.new(n2_msg) if [String, NameParameter].none? { |clazz| @name2.is_a? clazz }
 
     opt_msg = 'rosette_options can only be an instance of a Hash'
-    if @rosette_options
-      raise BadRequestError.new(opt_msg) unless @rosette_options.is_a? Hash
-    end
+    raise BadRequestError.new(opt_msg) if @rosette_options && !(@rosette_options.is_a? Hash)
   end
 
   # Converts this class to Hash with its keys in lower CamelCase.
@@ -47,9 +45,8 @@ class NameSimilarityParameters
   def load_params
     validate_params
     to_hash
-      .reject { |_key, value| value.nil? }
-      .map { |key, value| [key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase), value] }
-      .to_h
+      .compact
+      .transform_keys { |key| key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase) }
   end
 
   # Converts this class to Hash.

data/lib/name_translation_parameters.rb

@@ -27,7 +27,7 @@ class NameTranslationParameters
   # ISO 15924 code of name's script (optional)
   attr_accessor :target_script
 
-  def initialize(name, target_language, options = {}) #:notnew:
+  def initialize(name, target_language, options = {}) # :notnew:
     options = {
       entity_type: nil,
       genre: nil,
@@ -54,9 +54,7 @@ class NameTranslationParameters
   # of a Hash.
   def validate_params
     msg = 'rosette_options can only be an instance of a Hash'
-    if @rosette_options
-      raise BadRequestError.new(msg) unless @rosette_options.is_a? Hash
-    end
+    raise BadRequestError.new(msg) if @rosette_options && !(@rosette_options.is_a? Hash)
   end
 
   # Converts this class to Hash with its keys in lower CamelCase.
@@ -66,8 +64,7 @@ class NameTranslationParameters
     validate_params
     to_hash
       .select { |_key, value| value }
-      .map { |key, value| [key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase), value] }
-      .to_h
+      .transform_keys { |key| key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase) }
   end
 
   # Converts this class to Hash.

data/lib/request_builder.rb

@@ -28,11 +28,11 @@ class RequestBuilder
     @http_client = http_client
     @binding_version = binding_version
     @params = params
-    @user_agent = 'Ruby/' + binding_version + '/' + RUBY_VERSION
+    @user_agent = "Ruby/#{binding_version}/#{RUBY_VERSION}"
 
     return unless url_parameters
 
-    @alternate_url = @alternate_url + '?' + URI.encode_www_form(url_parameters)
+    @alternate_url = "#{@alternate_url}?#{URI.encode_www_form(url_parameters)}"
   end
 
   # Prepares a plain POST request for Rosette API.
@@ -203,16 +203,16 @@ class RequestBuilder
   def get_response(http, request)
     response = http.request request
 
-    if response.code != '200'
-      message = JSON.parse(response.body)['message']
-      code = JSON.parse(response.body)['code']
-      raise RosetteAPIError.new code, message
-    else
+    if response.code == '200'
       response_headers = {}
       response.header.each_header { |key, value| response_headers[key] = value }
       response_headers = { responseHeaders: response_headers }
 
       JSON.parse(response.body).merge(response_headers)
+    else
+      message = JSON.parse(response.body)['message']
+      code = JSON.parse(response.body)['code']
+      raise RosetteAPIError.new code, message
     end
   end
 end

data/lib/rosette_api.rb

@@ -9,11 +9,12 @@ require_relative 'address_similarity_parameters'
 require_relative 'rosette_api_error'
 require_relative 'bad_request_error'
 require_relative 'bad_request_format_error'
+require 'logger'
 
 # This class allows you to access all Rosette API endpoints.
 class RosetteAPI
   # Version of Ruby binding
-  BINDING_VERSION = '1.14.3'
+  BINDING_VERSION = '1.27.1'
   # Rosette API language endpoint
   LANGUAGE_ENDPOINT = '/language'
   # Rosette API morphology endpoint
@@ -65,13 +66,12 @@ class RosetteAPI
   attr_accessor :url_parameters
 
   def initialize(user_key, alternate_url = 'https://api.rosette.com/rest/v1')
+    @log = Logger.new($stdout)
     @user_key = user_key
     @alternate_url = alternate_url
     @url_parameters = nil
 
-    if @alternate_url.to_s.end_with?('/')
-      @alternate_url = alternate_url.to_s.slice(0..-2)
-    end
+    @alternate_url = alternate_url.to_s.slice(0..-2) if @alternate_url.to_s.end_with?('/')
 
     uri = URI.parse alternate_url
     @http_client = Net::HTTP.new uri.host, uri.port
@@ -111,7 +111,7 @@ class RosetteAPI
 
     params = params.load_params
 
-    endpoint = MORPHOLOGY_ENDPOINT + '/complete'
+    endpoint = "#{MORPHOLOGY_ENDPOINT}/complete"
     RequestBuilder.new(@user_key, @alternate_url + endpoint, @http_client,
                        BINDING_VERSION, params, @url_parameters)
                   .send_post_request
@@ -131,7 +131,7 @@ class RosetteAPI
 
     params = params.load_params
 
-    endpoint = MORPHOLOGY_ENDPOINT + '/compound-components'
+    endpoint = "#{MORPHOLOGY_ENDPOINT}/compound-components"
     RequestBuilder.new(@user_key, @alternate_url + endpoint, @http_client,
                        BINDING_VERSION, params, @url_parameters)
                   .send_post_request
@@ -151,7 +151,7 @@ class RosetteAPI
 
     params = params.load_params
 
-    endpoint = MORPHOLOGY_ENDPOINT + '/han-readings'
+    endpoint = "#{MORPHOLOGY_ENDPOINT}/han-readings"
     RequestBuilder.new(@user_key, @alternate_url + endpoint, @http_client,
                        BINDING_VERSION, params, @url_parameters)
                   .send_post_request
@@ -170,7 +170,7 @@ class RosetteAPI
 
     params = params.load_params
 
-    endpoint = MORPHOLOGY_ENDPOINT + '/lemmas'
+    endpoint = "#{MORPHOLOGY_ENDPOINT}/lemmas"
     RequestBuilder.new(@user_key, @alternate_url + endpoint, @http_client,
                        BINDING_VERSION, params, @url_parameters)
                   .send_post_request
@@ -190,7 +190,7 @@ class RosetteAPI
 
     params = params.load_params
 
-    endpoint = MORPHOLOGY_ENDPOINT + '/parts-of-speech'
+    endpoint = "#{MORPHOLOGY_ENDPOINT}/parts-of-speech"
     RequestBuilder.new(@user_key, @alternate_url + endpoint, @http_client,
                        BINDING_VERSION, params, @url_parameters)
                   .send_post_request
@@ -530,5 +530,9 @@ class RosetteAPI
                    message = 'Expects a DocumentParameters type as an argument',
                    type = DocumentParameters)
     raise BadRequestError.new message unless params.is_a? type
+
+    return unless defined?(params.genre) && !params.genre.nil?
+
+    @log.warn('The genre parameter is deprecated and will be removed in a future release.')
   end
 end

data/lib/rosette_api_error.rb

@@ -8,8 +8,9 @@ class RosetteAPIError < StandardError
   # Rosette API error's message
   attr_accessor :message
 
-  def initialize(status_code, message) #:notnew:
+  def initialize(status_code, message) # :notnew:
     @status_code = status_code
     @message = message
+    super(message)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rosette_api
 version: !ruby/object:Gem::Version
-  version: 1.14.3
+  version: 1.27.1
 platform: ruby
 authors:
 - Basis Technology Corp
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-06 00:00:00.000000000 Z
+date: 2024-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubysl-securerandom
@@ -45,10 +45,10 @@ files:
 - examples/language.rb
 - examples/language_multilingual.rb
 - examples/morphology_complete.rb
-- examples/morphology_compound_components.rb
-- examples/morphology_han_readings.rb
+- examples/morphology_compound-components.rb
+- examples/morphology_han-readings.rb
 - examples/morphology_lemmas.rb
-- examples/morphology_parts_of_speech.rb
+- examples/morphology_parts-of-speech.rb
 - examples/name_deduplication.rb
 - examples/name_similarity.rb
 - examples/name_translation.rb
@@ -77,8 +77,9 @@ files:
 homepage: https://developer.rosette.com/
 licenses:
 - Apache-2.0
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -86,15 +87,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: A Ruby interface for Rosette Text Analytics Platform.
 test_files: []