rosette_api 1.14.4 → 1.27.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b38b4872ea8951d43abf562f7feed44bf672e2508ec78e34c6e05327293b8c35
-  data.tar.gz: 5608e8136b43a67a771fe860f51deee5c14da58aefa90211d6bb0be77a14834a
+  metadata.gz: 3d5037aff054e99e751a771f2f320382aeb888c42e50791c1a4c4ddcb17eebe0
+  data.tar.gz: f61eaa6cd0cf434208dba133666d9b3886ad9395858d871dcd4058cf5a293b74
 SHA512:
-  metadata.gz: 85f6244f0c40958eabe5165b85dc2ee13e849924f9a500404391541bfb490291e46b8461dcc4f3bfd90ca54ff04ba5585d3b9654d4df8b9b3d2d7c72a4f031ae
-  data.tar.gz: 2dea9f348e81a32fa8f6e692f66385fe0b4143b34902d03765d027087f0b83f670bb428845d77afded27a12bfa013a52b806d042e233266e3cd5924a805bcd64
+  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/categories.rb

@@ -10,9 +10,9 @@ rosette_api = if url
                 RosetteAPI.new(api_key)
               end
 
-categories_url_data = 'https://onlocationvacations.com/2018/02/06/downton-abbey-exhibition-extended-april-2-nyc/'
+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

@@ -12,8 +12,7 @@ rosette_api = if url
 
 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/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,7 +11,7 @@ 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
@@ -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.4'
+  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.4
+  version: 1.27.1
 platform: ruby
 authors:
 - Basis Technology Corp
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-16 00:00:00.000000000 Z
+date: 2024-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubysl-securerandom
@@ -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.1.2
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: A Ruby interface for Rosette Text Analytics Platform.
 test_files: []