rosette_api 1.12.1 → 1.14.3

data/examples/name_translation.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'rosette_api'
+
+api_key, url = ARGV
+
+rosette_api = if url
+                RosetteAPI.new(api_key, url)
+              else
+                RosetteAPI.new(api_key)
+              end
+
+translated_name_data = 'معمر محمد أبو منيار القذاف'
+begin
+  params = NameTranslationParameters.new(
+    translated_name_data,
+    'eng',
+    target_script: 'Latn'
+  )
+  response = rosette_api.get_name_translation(params)
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+end

data/examples/ping.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'rosette_api'
+
+api_key, url = ARGV
+
+rosette_api = if url
+                RosetteAPI.new(api_key, url)
+              else
+                RosetteAPI.new(api_key)
+              end
+
+begin
+  response = rosette_api.ping
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+end

data/examples/relationships.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'rosette_api'
+
+api_key, url = ARGV
+
+rosette_api = if url
+                RosetteAPI.new(api_key, url)
+              else
+                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.'
+
+begin
+  params = DocumentParameters.new(content: relationships_text_data)
+  response = rosette_api.get_relationships(params)
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+end

data/examples/semantic_vectors.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'rosette_api'
+
+api_key, url = ARGV
+
+rosette_api = if url
+                RosetteAPI.new(api_key, url)
+              else
+                RosetteAPI.new(api_key)
+              end
+
+semantic_vectors_data = 'Cambridge, Massachusetts'
+begin
+  params = DocumentParameters.new(content: semantic_vectors_data)
+  response = rosette_api.get_semantic_vectors(params)
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+end

data/examples/sentences.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'rosette_api'
+
+api_key, url = ARGV
+
+rosette_api = if url
+                RosetteAPI.new(api_key, url)
+              else
+                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.'
+
+begin
+  params = DocumentParameters.new
+  params.content = sentences_data
+  response = rosette_api.get_sentences(params)
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+end

data/examples/sentiment.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+require 'rosette_api'
+
+api_key, url = ARGV
+
+rosette_api = if url
+                RosetteAPI.new(api_key, url)
+              else
+                RosetteAPI.new(api_key)
+              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>'
+file.write(sentiment_file_data)
+file.close
+begin
+  params = DocumentParameters.new(file_path: file.path, language: 'eng')
+  response = rosette_api.get_sentiment(params)
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+end

data/examples/similar_terms.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'rosette_api'
+
+api_key, url = ARGV
+
+rosette_api = if url
+                RosetteAPI.new(api_key, url)
+              else
+                RosetteAPI.new(api_key)
+              end
+
+similar_terms_data = 'spy'
+begin
+  params = DocumentParameters.new(content: similar_terms_data)
+  params.rosette_options = { 'resultLanguages' => %w[spa deu jpn] }
+  response = rosette_api.get_similar_terms(params)
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+end

data/examples/syntax_dependencies.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'rosette_api'
+
+api_key, url = ARGV
+
+rosette_api = if url
+                RosetteAPI.new(api_key, url)
+              else
+                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.'
+
+begin
+  params = DocumentParameters.new(content: syntax_dependencies_data)
+  response = rosette_api.get_syntax_dependencies(params)
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+end

data/examples/tokens.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'rosette_api'
+
+api_key, url = ARGV
+
+rosette_api = if url
+                RosetteAPI.new(api_key, url)
+              else
+                RosetteAPI.new(api_key)
+              end
+
+tokens_data = '北京大学生物系主任办公室内部会议'
+begin
+  params = DocumentParameters.new(content: tokens_data)
+  response = rosette_api.get_tokens(params)
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+end

data/examples/topics.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'rosette_api'
+
+api_key, url = ARGV
+
+rosette_api = if url
+                RosetteAPI.new(api_key, url)
+              else
+                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.'
+begin
+  params = DocumentParameters.new(content: topics_data)
+  response = rosette_api.get_topics(params)
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+end

data/examples/transliteration.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'rosette_api'
+
+api_key, url = ARGV
+
+rosette_api = if url
+                RosetteAPI.new(api_key, url)
+              else
+                RosetteAPI.new(api_key)
+              end
+
+transliteration_content_data =
+  'Kareem Abdul Jabbar holds the records for most points in the NBA'
+
+begin
+  params = DocumentParameters.new
+  params.content = transliteration_content_data
+  response = rosette_api.get_transliteration(params)
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+end

data/lib/address_parameter.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+# This class represents an address in Rosette API.
+class AddressParameter
+  # house (optional)
+  attr_accessor :house
+  # house_number (optional)
+  attr_accessor :house_number
+  # road (optional)
+  attr_accessor :road
+  # unit (optional)
+  attr_accessor :unit
+  # level (optional)
+  attr_accessor :level
+  # staircase (optional)
+  attr_accessor :staircase
+  # entrance (optional)
+  attr_accessor :entrance
+  # suburb (optional)
+  attr_accessor :suburb
+  # city_district (optional)
+  attr_accessor :city_district
+  # city (optional)
+  attr_accessor :city
+  # island (optional)
+  attr_accessor :island
+  # state_district (optional)
+  attr_accessor :state_district
+  # state (optional)
+  attr_accessor :state
+  # country_region (optional)
+  attr_accessor :country_region
+  # country (optional)
+  attr_accessor :country
+  # world_region (optional)
+  attr_accessor :world_region
+  # post_code (optional)
+  attr_accessor :post_code
+  # po_box (optional)
+  attr_accessor :po_box
+
+  def initialize(options = {}) #:notnew:
+    options = {
+      house: nil,
+      house_number: nil,
+      road: nil,
+      unit: nil,
+      level: nil,
+      staircase: nil,
+      entrance: nil,
+      suburb: nil,
+      city_district: nil,
+      city: nil,
+      island: nil,
+      state_district: nil,
+      state: nil,
+      country_region: nil,
+      country: nil,
+      world_region: nil,
+      post_code: nil,
+      po_box: nil
+    }.update options
+    @house = options[:house]
+    @house_number = options[:house_number]
+    @road = options[:road]
+    @unit = options[:unit]
+    @level = options[:level]
+    @staircase = options[:staircase]
+    @entrance = options[:entrance]
+    @suburb = options[:suburb]
+    @city_district = options[:city_district]
+    @city = options[:city]
+    @island = options[:island]
+    @state_district = options[:state_district]
+    @state = options[:state]
+    @country_region = options[:country_region]
+    @country = options[:country]
+    @world_region = options[:world_region]
+    @post_code = options[:post_code]
+    @po_box = options[:po_box]
+  end
+
+  # Converts this class to Hash with its keys in lower CamelCase.
+  #
+  # 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
+  end
+
+  # Converts this class to Hash.
+  #
+  # Returns the new Hash.
+  def to_hash
+    {
+      house: @house,
+      house_number: @house_number,
+      road: @road,
+      unit: @unit,
+      level: @level,
+      staircase: @staircase,
+      entrance: @entrance,
+      suburb: @suburb,
+      city_district: @city_district,
+      city: @city,
+      island: @island,
+      state_district: @state_district,
+      state: @state,
+      country_region: @country_region,
+      country: @country,
+      world_region: @world_region,
+      post_code: @post_code,
+      po_box: @po_box
+    }
+  end
+end

data/lib/address_similarity_parameters.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative 'bad_request_error'
+require_relative 'address_parameter'
+
+# This class encapsulates parameters that are needed for address-similarity in
+# Rosette API.
+class AddressSimilarityParameters
+  # Address to be compared to address2
+  attr_accessor :address1
+  # Address to be compared to address1
+  attr_accessor :address2
+
+  def initialize(address1, address2) #:notnew:
+    @address1 = address1
+    @address2 = address2
+  end
+
+  # Validates the parameters by checking if address1 and address2 are instances
+  # of AddressParameter.
+  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 }
+
+    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 }
+  end
+
+  # Converts this class to Hash with its keys in lower CamelCase.
+  #
+  # Returns the new Hash.
+  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
+  end
+
+  # Converts this class to Hash.
+  #
+  # Returns the new Hash.
+  def to_hash
+    {
+      address1: @address1.is_a?(AddressParameter) ? @address1.load_param : @address1,
+      address2: @address2.is_a?(AddressParameter) ? @address2.load_param : @address2
+    }
+  end
+end