rosette_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3179104e400cf9675967df11a64722393758fe06
+  data.tar.gz: 31bb38876a1964f3d0d35d9b98ea7dfb955f66d4
+SHA512:
+  metadata.gz: a16a11cb4cc29064a694f9878f81a74c4ceb861aec94509bb4fc33f981cefb439d09c4e55884f7a4a7333bf07854e70996c8f487f551b1898d9727dd49118b62
+  data.tar.gz: 4fd8a574f8c52f3502e8ed6dc3db810810c06cf10f081d4bef93d9339df2b774c88e3890e5966adb41d558ab91f4fc247cac579200b8061de37a911e0d7a548e

data/lib/bad_request_error.rb

@@ -0,0 +1,8 @@
+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
+  end
+end

data/lib/bad_request_format_error.rb

@@ -0,0 +1,8 @@
+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
+  end
+end

data/lib/document_parameters.rb

@@ -0,0 +1,66 @@
+require_relative 'bad_request_format_error'
+
+# This class encapsulates parameters that will be used by most of the endpoints
+# with exclusion of name-similarity and name-translation.
+class DocumentParameters
+  # Content to be analyzed (required if no content_uri and file_path)
+  attr_accessor :content
+  # URL to retrieve content from and analyze (required if no content and file_path)
+  attr_accessor :content_uri
+  # File path of the file to be analyzed (required if no content and content_uri)
+  attr_accessor :file_path
+  # genre to categorize the input data
+  attr_accessor :genre
+  # ISO 639-3 language code of the provided content (optional)
+  attr_accessor :language
+
+  def initialize(options = {}) #:notnew:
+    options = {
+      content: nil,
+      content_uri: nil,
+      file_path: nil,
+      genre: nil,
+      language: nil
+    }.update options
+    @content = options[:content]
+    @content_uri = options[:content_uri]
+    @file_path = options[:file_path]
+    @genre = options[:genre]
+    @language = options[:language]
+  end
+
+  # Validates the parameters by checking if there are multiple content sources
+  # set or no content provided at all.
+  def validate_params
+    if [@content, @content_uri, @file_path].compact.length > 1
+      raise BadRequestFormatError.new 'The format of the request is invalid: multiple content sources;' \
+                                      ' must be one of an attachment, an inline "content" field, or an external' \
+                                      '"contentUri"'
+    elsif [@content, @content_uri, @file_path].all?(&:nil?)
+      raise BadRequestFormatError.new 'The format of the request is invalid: no content provided; must' \
+                                      ' be one of an attachment, an inline "content" field, or an external "contentUri"'
+    end
+  end
+
+  # Converts this class to Hash with its keys in lower CamelCase.
+  #
+  # Returns the new Hash.
+  def load_params
+    self.validate_params
+    self.to_hash.select { |_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
+    {
+      content: @content,
+      content_uri: @content_uri,
+      file_path: @file_path,
+      language: @language
+    }
+  end
+end

data/lib/name_parameter.rb

@@ -0,0 +1,44 @@
+# This class represents an entity name in Rosette API.
+class NameParameter
+  # Name's entity type (PERSON, LOCATION, ORGANIZATION) (optional)
+  attr_accessor :entity_type
+  # ISO 639-3 code of the name's language (optional)
+  attr_accessor :language
+  # ISO 15924 code of the name's script (optional)
+  attr_accessor :script
+  # Name to be analyzed
+  attr_accessor :text
+
+  def initialize(text, options = {}) #:notnew:
+    options = {
+      entity_type: nil,
+      language: nil,
+      script: nil
+    }.update options
+    @text = text
+    @entity_type = options[:entity_type]
+    @language = options[:language]
+    @script = options[:script]
+  end
+
+  # Converts this class to Hash with its keys in lower CamelCase.
+  #
+  # Returns the new Hash.
+  def load_param
+    self.to_hash.select { |_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
+    {
+      entity_type: @entity_type,
+      language: @language,
+      script: @script,
+      text: @text
+    }
+  end
+end

data/lib/name_similarity_parameters.rb

@@ -0,0 +1,52 @@
+require_relative 'bad_request_error'
+require_relative 'name_parameter'
+
+# This class encapsulates parameters that are needed for name-similarity in
+# Rosette API.
+class NameSimilarityParameters
+  # genre to categorize the input data
+  attr_accessor :genre
+  # Name to be compared to name2
+  attr_accessor :name1
+  # Name to be compared to name1
+  attr_accessor :name2
+
+  def initialize(name1, name2, options = {}) #:notnew:
+    options = {
+      genre: nil
+    }.update options
+    @genre = options[:genre]
+    @name1 = name1
+    @name2 = name2
+  end
+
+  # Validates the parameters by checking if name1 and name2 are instances of
+  # a String or NameParameter.
+  def validate_params
+    if [String, NameParameter].none? { |clazz| @name1.is_a? clazz }
+      raise BadRequestError.new('name1 option can only be an instance of a String or NameParameter')
+    elsif [String, NameParameter].none? { |clazz| @name2.is_a? clazz }
+      raise BadRequestError.new('name2 option can only be an instance of a String or NameParameter')
+    end
+  end
+
+  # Converts this class to Hash with its keys in lower CamelCase.
+  #
+  # Returns the new Hash.
+  def load_params
+    self.validate_params
+    self.to_hash.select { |_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
+    {
+      name1: @name1.is_a?(NameParameter) ? @name1.load_param : @name1,
+      name2: @name2.is_a?(NameParameter) ? @name2.load_param : @name2
+    }
+  end
+end

data/lib/name_translation_parameters.rb

@@ -0,0 +1,70 @@
+require_relative 'rosette_api_error'
+
+# This class encapsulates parameters that are needed for name-translation in
+# Rosette API.
+class NameTranslationParameters
+  # Name's entity type (PERSON, LOCATION, ORGANIZATION) (optional)
+  attr_accessor :entity_type
+  # genre to categorize the input data
+  attr_accessor :genre
+  # Name to translate
+  attr_accessor :name
+  # ISO 693-3 code of the name's native language the name originates in (optional)
+  attr_accessor :source_language_of_origin
+  # ISO 693-3 code of the name's language of use (optional)
+  attr_accessor :source_language_of_use
+  # ISO 15924 code of the name's script (optional)
+  attr_accessor :source_script
+  # ISO 639-3 code of the translation language
+  attr_accessor :target_language
+  # Transliteration scheme for the translation (optional)
+  attr_accessor :target_scheme
+  # ISO 15924 code of name's script (optional)
+  attr_accessor :target_script
+
+  def initialize(name, target_language, options = {}) #:notnew:
+    options = {
+      entity_type: nil,
+      genre: nil,
+      source_language_of_origin: nil,
+      source_language_of_use: nil,
+      source_script: nil,
+      target_scheme: nil,
+      target_script: nil
+    }.update options
+    @name = name
+    @entity_type = options[:entity_type]
+    @genre = options[:genre]
+    @source_language_of_origin = options[:source_language_of_origin]
+    @source_language_of_use = options[:source_language_of_use]
+    @source_script = options[:source_script]
+    @target_language = target_language
+    @target_scheme = options[:target_scheme]
+    @target_script = options[:target_script]
+  end
+
+  # Converts this class to Hash with its keys in lower CamelCase.
+  #
+  # Returns the new Hash.
+  def load_params
+    self.to_hash.select { |_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
+    {
+      entity_type: @entity_type,
+      name: @name,
+      source_language_of_origin: @source_language_of_origin,
+      source_language_of_use: @source_language_of_use,
+      source_script: @source_script,
+      target_language: @target_language,
+      target_scheme: @target_scheme,
+      target_script: @target_script
+    }
+  end
+end

data/lib/request_builder.rb

@@ -0,0 +1,155 @@
+require 'net/http'
+require 'net/https'
+require 'json'
+require 'securerandom'
+require_relative 'rosette_api_error'
+
+# This class handles all Rosette API requests.
+class RequestBuilder
+  @retries = 5
+  # Alternate Rosette API URL
+  attr_reader :alternate_url
+  # Parameters to build the body of the request from
+  attr_accessor :params
+  # Rosette API key
+  attr_accessor :user_key
+
+  def initialize(user_key, alternate_url, params = {}) #:notnew:
+    @user_key = user_key
+    @alternate_url = alternate_url
+    @params = params
+  end
+
+  # Prepares a plain POST request for Rosette API.
+  #
+  # ==== Attributes
+  #
+  # * +params+ - Parameters to build the body of the request.
+  #
+  # Returns a HTTP connection and the built POST request.
+  def prepare_plain_request(params)
+    begin
+      uri = URI.parse @alternate_url
+      http = Net::HTTP.new uri.host, uri.port
+      http.use_ssl = uri.scheme == 'https'
+      request = Net::HTTP::Post.new uri.request_uri
+    rescue
+      raise RosetteAPIError.new 'connectionError', 'Failed to establish connection with Rosette API server.'
+    end
+
+    request['X-RosetteAPI-Key'] = @user_key
+    request['Content-Type'] = 'application/json'
+    request['Accept'] = 'application/json'
+    request.body = params.to_json
+
+    [http, request]
+  end
+
+  # Prepares a multipart/form-data POST request for Rosette API.
+  #
+  # ==== Attributes
+  #
+  # * +params+ - Parameters to build the body of the request.
+  #
+  # Returns a HTTP connection and the built POST request.
+  def prepare_multipart_request(params)
+    begin
+      file = File.open params['filePath'], 'r'
+      text = file.read
+    rescue => err
+      raise err
+    end
+
+    boundary = SecureRandom.hex
+    post_body = []
+    request_file = params.to_json
+
+    # Add the content data
+    post_body << "--#{boundary}\r\n"
+    post_body << "Content-Disposition: form-data; name=\"content\"; filename=\"#{File.basename(file)}\"\r\n"
+    post_body << "Content-Type: text/plain\r\n\r\n"
+    post_body << text
+
+    # Add the request data
+    post_body << "\r\n\r\n--#{boundary}\r\n"
+    post_body << "Content-Disposition: form-data; name=\"request\"\r\n"
+    post_body << "Content-Type: application/json\r\n\r\n"
+    post_body << request_file
+    post_body << "\r\n\r\n--#{boundary}--\r\n"
+
+    # Create the HTTP objects
+    uri = URI.parse @alternate_url
+    http = Net::HTTP.new uri.host, uri.port
+    http.use_ssl = uri.scheme == 'https'
+    request = Net::HTTP::Post.new uri.request_uri
+    request.add_field 'Content-Type', "multipart/form-data; boundary=#{boundary}"
+    request.add_field 'X-RosetteAPI-Key', @user_key
+    request.body = post_body.join
+
+    [http, request]
+  end
+
+  # Sends a GET request to Rosette API.
+  #
+  # Returns JSON response or raises RosetteAPIError if encountered.
+  def send_get_request
+    uri = URI.parse @alternate_url
+    http = Net::HTTP.new uri.host, uri.port
+    http.use_ssl = uri.scheme == 'https'
+
+    request = Net::HTTP::Get.new uri.request_uri
+    request['X-RosetteAPI-Key'] = @user_key
+
+    self.get_response http, request
+  end
+
+  # Sends a POST request to Rosette API.
+  #
+  # Returns JSON response or raises RosetteAPIError if encountered.
+  def send_post_request
+    params = (@alternate_url.to_s.include? '/info?clientVersion=') ? '{"body": "version check"}' : @params
+
+    if !params['filePath'].nil?
+      http, request = self.prepare_multipart_request params
+    else
+      http, request = self.prepare_plain_request params
+    end
+
+    self.get_response http, request
+  end
+
+  # Gets response from HTTP connection.
+  #
+  # ==== Attributes
+  #
+  # * +http+ - HTTP connection.
+  #
+  # * +request+ - Prepared Rosette API request.
+  #
+  # Returns JSON response or raises RosetteAPIError if encountered.
+  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']
+      if response.code == '429'
+        if @retries != 0
+          @retries = @retries - 1
+          sleep 15
+          self.get_response(http, request)
+        else
+          raise RosetteAPIError.new code, message
+        end
+      else
+        raise RosetteAPIError.new code, message
+      end
+    else
+      response_headers = {}
+      response.header.each_header { |key, value| response_headers[key] = value }
+      response_headers = { responseHeaders: response_headers }
+
+      JSON.parse(response.body).merge(response_headers)
+    end
+  end
+end

data/lib/rosette_api.rb

@@ -0,0 +1,338 @@
+require_relative 'request_builder'
+require_relative 'document_parameters'
+require_relative 'name_translation_parameters'
+require_relative 'name_similarity_parameters'
+require_relative 'rosette_api_error'
+require_relative 'bad_request_error'
+require_relative 'bad_request_format_error'
+
+# This class allows you to access all Rosette API endpoints.
+class RosetteAPI
+  # Version of Ruby binding
+  BINDING_VERSION = '1.0.2'
+  # Rosette API language endpoint
+  LANGUAGE_ENDPOINT = '/language'
+  # Rosette API morphology endpoint
+  MORPHOLOGY_ENDPOINT = '/morphology'
+  # Rosette API entities endpoint
+  ENTITIES_ENDPOINT = '/entities'
+  # Rosette API entities/linked endpoint
+  ENTITIES_LINKED_ENDPOINT = '/entities/linked'
+  # Rosette API categories endpoint
+  CATEGORIES_ENDPOINT = '/categories'
+  # Rosette API relationships endpoint
+  RELATIONSHIPS_ENDPOINT = '/relationships'
+  # Rosette API sentiment endpoint
+  SENTIMENT_ENDPOINT = '/sentiment'
+  # Rosette API name-translation endpoint
+  NAME_TRANSLATION_ENDPOINT = '/name-translation'
+  # Rosette API name-similarity endpoint
+  NAME_SIMILARITY_ENDPOINT = '/name-similarity'
+  # Rosette API tokens endpoint
+  TOKENS_ENDPOINT = '/tokens'
+  # Rosette API sentences endpoint
+  SENTENCES_ENDPOINT = '/sentences'
+  # Rosette API info endpoint
+  INFO = '/info'
+  # Rosette API version check endpoint
+  VERSION_CHECK = '/info?clientVersion=' + BINDING_VERSION
+  # Rosette API ping endpoint
+  PING = '/ping'
+
+  # Rosette API key
+  attr_accessor :user_key
+  # Alternate Rosette API URL
+  attr_accessor :alternate_url
+
+  def initialize(user_key, alternate_url = 'https://api.rosette.com/rest/v1') #:notnew:
+    @user_key = user_key
+    @alternate_url = alternate_url
+
+    if @alternate_url.to_s.end_with?('/')
+      @alternate_url = alternate_url.to_s.slice(0..-2)
+    end
+
+    self.check_version_compatibility
+  end
+
+  # Checks binding version compatibility against the Rosette API server.
+  def check_version_compatibility
+    response = RequestBuilder.new(@user_key, @alternate_url + VERSION_CHECK)
+                             .send_post_request
+
+    unless response['versionChecked']
+      puts JSON.pretty_generate(response)
+
+      exit
+    end
+  end
+
+  # Identifies in which language(s) the input is written.
+  #
+  # ==== Attributes
+  #
+  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  #
+  # Returns list of candidate languages in order of descending confidence.
+  def get_language(params)
+    check_params params
+
+    params = params.load_params
+
+    RequestBuilder.new(@user_key, @alternate_url + LANGUAGE_ENDPOINT, params)
+                  .send_post_request
+  end
+
+  # Extracts parts-of-speech, lemmas (dictionary form), compound components,
+  # and Han-readings for each token in the input.
+  #
+  # ==== Attributes
+  #
+  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  #
+  # Returns the lemmas, compound components, Han-readings, and parts-of-speech
+  # tags of the input for supported languages.
+  def get_morphology_complete(params)
+    check_params params
+
+    params = params.load_params
+
+    RequestBuilder.new(@user_key, @alternate_url + MORPHOLOGY_ENDPOINT + '/complete', params)
+                  .send_post_request
+  end
+
+  # Extracts compound-components from the input.
+  #
+  # ==== Attributes
+  #
+  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  #
+  # Returns list of components for each compound word of the input for supported
+  # languages.
+  def get_compound_components(params)
+    check_params params
+
+    params = params.load_params
+
+    RequestBuilder.new(@user_key, @alternate_url + MORPHOLOGY_ENDPOINT + '/compound-components', params)
+                  .send_post_request
+  end
+
+  # Extracts Han-readings from the input.
+  #
+  # ==== Attributes
+  #
+  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  #
+  # Returns list of Han-readings which provide pronunciation information for
+  # Han script, in both Chinese and Japanese input text.
+  def get_han_readings(params)
+    check_params params
+
+    params = params.load_params
+
+    RequestBuilder.new(@user_key, @alternate_url + MORPHOLOGY_ENDPOINT + '/han-readings', params)
+                  .send_post_request
+  end
+
+  # Extracts lemmas from the input.
+  #
+  # ==== Attributes
+  #
+  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  #
+  # Returns list of lemmas for each token of the input for supported languages.
+  def get_lemmas(params)
+    check_params params
+
+    params = params.load_params
+
+    RequestBuilder.new(@user_key, @alternate_url + MORPHOLOGY_ENDPOINT + '/lemmas', params)
+                  .send_post_request
+  end
+
+  # Extracts parts-of-speech from the input.
+  #
+  # ==== Attributes
+  #
+  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  #
+  # Returns list of part-of-speech (POS) tags for each of the words of the
+  # input, depending on the context of how it is used.
+  def get_parts_of_speech(params)
+    check_params params
+
+    params = params.load_params
+
+    RequestBuilder.new(@user_key, @alternate_url + MORPHOLOGY_ENDPOINT + '/parts-of-speech', params)
+                  .send_post_request
+  end
+
+  # Extracts entities from the input.
+  #
+  # ==== Attributes
+  #
+  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  #
+  # Returns each entity extracted from the input.
+  def get_entities(params)
+    check_params params
+
+    params = params.load_params
+
+    RequestBuilder.new(@user_key, @alternate_url + ENTITIES_ENDPOINT, params)
+                  .send_post_request
+  end
+
+  # Extracts entities from the input.
+  #
+  # ==== Attributes
+  #
+  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  #
+  # Returns list of entities that have been linked to entities in the knowledge
+  # base.
+  def get_entities_linked(params)
+    check_params params
+
+    params = params.load_params
+
+    RequestBuilder.new(@user_key, @alternate_url + ENTITIES_LINKED_ENDPOINT, params)
+                  .send_post_request
+  end
+
+  # Extracts Tier 1 contextual categories from the input.
+  #
+  # ==== Attributes
+  #
+  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  #
+  # Returns the contextual categories identified in the input.
+  def get_categories(params)
+    check_params params
+
+    params = params.load_params
+
+    RequestBuilder.new(@user_key, @alternate_url + CATEGORIES_ENDPOINT, params)
+                  .send_post_request
+  end
+
+  # Extracts relationships from the input.
+  #
+  # ==== Attributes
+  #
+  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  #
+  # Returns each relationship extracted from the input.
+  def get_relationships(params)
+    check_params params
+
+    params = params.load_params
+
+    RequestBuilder.new(@user_key, @alternate_url + RELATIONSHIPS_ENDPOINT, params)
+                  .send_post_request
+  end
+
+  # Analyzes the positive and negative sentiment expressed by the input.
+  #
+  # ==== Attributes
+  #
+  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  #
+  # Returns sentiment analysis results.
+  def get_sentiment(params)
+    check_params params
+
+    params = params.load_params
+
+    RequestBuilder.new(@user_key, @alternate_url + SENTIMENT_ENDPOINT, params)
+                  .send_post_request
+  end
+
+  # Translates a given name to a supported specified language.
+  #
+  # ==== Attributes
+  #
+  # * +params+ - NameTranslationParameters helps to build the request body in RequestBuilder.
+  #
+  # Returns the translation of a name.
+  def name_translation(params)
+    check_params params, 'Expects a NameTranslationParameters type as an argument', NameTranslationParameters
+
+    params = params.load_params
+
+    RequestBuilder.new(@user_key, @alternate_url + NAME_TRANSLATION_ENDPOINT, params)
+                  .send_post_request
+  end
+
+  # Compares two entity names (person, location, or organization) and returns a
+  # match score from 0 to 1.
+  #
+  # ==== Attributes
+  #
+  # * +params+ - NameSimilarityParameters helps to build the request body in RequestBuilder.
+  #
+  # Returns the confidence score of matching 2 names.
+  def name_similarity(params)
+    check_params params, 'Expects a NameSimilarityParameters type as an argument', NameSimilarityParameters
+
+    params = params.load_params
+
+    RequestBuilder.new(@user_key, @alternate_url + NAME_SIMILARITY_ENDPOINT, params)
+                  .send_post_request
+  end
+
+  # Divides the input into tokens.
+  #
+  # ==== Attributes
+  #
+  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  #
+  # Returns list of tokens of the input.
+  def get_tokens(params)
+    check_params params
+
+    params = params.load_params
+
+    RequestBuilder.new(@user_key, @alternate_url + TOKENS_ENDPOINT, params)
+                  .send_post_request
+  end
+
+  # Divides the input into sentences.
+  #
+  # ==== Attributes
+  #
+  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  #
+  # Returns list of linguistic sentences of the input.
+  def get_sentences(params)
+    check_params params
+
+    params = params.load_params
+
+    RequestBuilder.new(@user_key, @alternate_url + SENTENCES_ENDPOINT, params)
+                  .send_post_request
+  end
+
+  # Gets information about the Rosette API, returns name, version, build number
+  # and build time.
+  def info
+    RequestBuilder.new(@user_key, @alternate_url + INFO)
+                  .send_get_request
+  end
+
+  # Pings the Rosette API for a response indicting that the service is
+  # available.
+  def ping
+    RequestBuilder.new(@user_key, @alternate_url + PING)
+                  .send_get_request
+  end
+
+  private
+
+    # Checks that the right parameter type is being passed in.
+    def check_params(params, message = 'Expects a DocumentParameters type as an argument', type = DocumentParameters)
+      raise BadRequest.new message unless params.is_a? type
+    end
+end
+

data/lib/rosette_api_error.rb

@@ -0,0 +1,13 @@
+# This class encapsulates all Rosette API server errors encountered during
+# requests.
+class RosetteAPIError < StandardError
+  # Rosette API error's status code
+  attr_accessor :status_code
+  # Rosette API error's message
+  attr_accessor :message
+
+  def initialize(status_code, message) #:notnew:
+    @status_code = status_code
+    @message = message
+  end
+end

data/tests/tests_spec.rb

@@ -0,0 +1,470 @@
+# encoding: UTF-8
+require 'rosette_api'
+require 'rspec'
+require 'webmock/rspec'
+require 'json'
+WebMock.disable_net_connect!(allow_localhost: true)
+
+describe RosetteAPI do
+
+  describe '.get_language' do
+    request_file = File.read File.expand_path(File.join(File.dirname(__FILE__), '../mock-data/request/language.json'))
+    before do
+      stub_request(:post, 'https://api.rosette.com/rest/v1/info?clientVersion=1.0.2').
+          with(body: "\"{\\\"body\\\": \\\"version check\\\"}\"",
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'versionChecked': true}.to_json, headers: {})
+      stub_request(:post, 'https://api.rosette.com/rest/v1/language').
+          with(body: request_file,
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'test': 'language'}.to_json, headers: {})
+    end
+    it 'test language' do
+      params = DocumentParameters.new
+      params.content = 'Por favor Senorita, says the man.?'
+      response = RosetteAPI.new('0123456789').get_language(params)
+      expect(response).instance_of? Hash
+    end
+
+    it 'badRequestFormat: the format of the request is invalid: multiple content sources' do
+      params = DocumentParameters.new
+      params.content = 'Por favor Senorita, says the man.?'
+      params.content_uri = 'Por favor Senorita, says the man.?'
+      expect { RosetteAPI.new('0123456789').get_language(params) }.to raise_error(BadRequestFormatError)
+    end
+
+    it 'badRequestFormat: the format of the request is invalid: no content provided;' do
+      params = DocumentParameters.new
+      expect { RosetteAPI.new('0123456789')
+                         .get_language(params) }
+                         .to raise_error(BadRequestFormatError)
+    end
+  end
+
+  describe '.get_morphology_complete' do
+    request_file = File.read File.expand_path(File.join(File.dirname(__FILE__), '../mock-data/request/morphology_complete.json'))
+    before do
+      stub_request(:post, 'https://api.rosette.com/rest/v1/info?clientVersion=1.0.2').
+          with(body: "\"{\\\"body\\\": \\\"version check\\\"}\"",
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'versionChecked': true}.to_json, headers: {})
+      stub_request(:post, 'https://api.rosette.com/rest/v1/morphology/complete').
+          with(body: request_file,
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'test': 'morphology/complete'}.to_json, headers: {})
+    end
+    it 'test morphology complete' do
+      params = DocumentParameters.new
+      params.content = 'The quick brown fox jumped over the lazy dog. Yes he did.'
+      response = RosetteAPI.new('0123456789').get_morphology_complete(params)
+      expect(response).instance_of? Hash
+    end
+  end
+
+  describe '.get_compound_components' do
+    request_file = File.read File.expand_path(File.join(File.dirname(__FILE__), '../mock-data/request/morphology_compound_components.json'))
+    before do
+      stub_request(:post, 'https://api.rosette.com/rest/v1/info?clientVersion=1.0.2').
+          with(body: "\"{\\\"body\\\": \\\"version check\\\"}\"",
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'versionChecked': true}.to_json, headers: {})
+      stub_request(:post, 'https://api.rosette.com/rest/v1/morphology/compound-components').
+          with(body: request_file,
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'test': 'morphology/compound-components'}.to_json, headers: {})
+    end
+    it 'test morphology compound components' do
+      params = DocumentParameters.new
+      params.content = 'Rechtsschutzversicherungsgesellschaften'
+      response = RosetteAPI.new('0123456789').get_compound_components(params)
+      expect(response).instance_of? Hash
+    end
+  end
+
+  describe '.get_han_readings' do
+    request_file = File.read File.expand_path(File.join(File.dirname(__FILE__), '../mock-data/request/morphology_han_readings.json')), encoding: 'utf-8'
+    before do
+      stub_request(:post, 'https://api.rosette.com/rest/v1/info?clientVersion=1.0.2').
+          with(body: "\"{\\\"body\\\": \\\"version check\\\"}\"",
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'versionChecked': true}.to_json, headers: {})
+      stub_request(:post, 'https://api.rosette.com/rest/v1/morphology/han-readings').
+          with(body: request_file,
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'test': 'morphology/han-readings'}.to_json, headers: {})
+    end
+    it 'test morphology han readings' do
+      params = DocumentParameters.new
+      params.content = '北京大学生物系主任办公室内部会议'
+      response = RosetteAPI.new('0123456789').get_han_readings(params)
+      expect(response).instance_of? Hash
+    end
+  end
+
+  describe '.get_parts_of_speech' do
+    request_file = File.read File.expand_path(File.join(File.dirname(__FILE__), '../mock-data/request/morphology_parts_of_speech.json'))
+    before do
+      stub_request(:post, 'https://api.rosette.com/rest/v1/info?clientVersion=1.0.2').
+          with(body: "\"{\\\"body\\\": \\\"version check\\\"}\"",
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'versionChecked': true}.to_json, headers: {})
+      stub_request(:post, 'https://api.rosette.com/rest/v1/morphology/parts-of-speech').
+          with(body: request_file,
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'test': 'morphology/parts-of-speech'}.to_json, headers: {})
+    end
+    it 'test morphology parts of speech' do
+      params = DocumentParameters.new
+      params.content = "The fact is that the geese just went back to get a rest and I'm not banking on their return soon"
+      response = RosetteAPI.new('0123456789').get_parts_of_speech(params)
+      expect(response).instance_of? Hash
+    end
+  end
+
+  describe '.get_lemmas' do
+    request_file = File.read File.expand_path(File.join(File.dirname(__FILE__), '../mock-data/request/morphology_lemmas.json'))
+    before do
+      stub_request(:post, 'https://api.rosette.com/rest/v1/info?clientVersion=1.0.2').
+          with(body: "\"{\\\"body\\\": \\\"version check\\\"}\"",
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'versionChecked': true}.to_json, headers: {})
+      stub_request(:post, 'https://api.rosette.com/rest/v1/morphology/lemmas').
+          with(body: request_file,
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'test': 'morphology/lemmas'}.to_json, headers: {})
+    end
+    it 'test morphology lemmas' do
+      params = DocumentParameters.new
+      params.content = "The fact is that the geese just went back to get a rest and I'm not banking on their return soon"
+      response = RosetteAPI.new('0123456789').get_lemmas(params)
+      expect(response).instance_of? Hash
+    end
+  end
+
+  describe '.get_entities' do
+    request_file = File.read File.expand_path(File.join(File.dirname(__FILE__), '../mock-data/request/entities.json')), encoding: 'utf-8'
+    before do
+      stub_request(:post, 'https://api.rosette.com/rest/v1/info?clientVersion=1.0.2').
+          with(body: "\"{\\\"body\\\": \\\"version check\\\"}\"",
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'versionChecked': true}.to_json, headers: {})
+      stub_request(:post, 'https://api.rosette.com/rest/v1/entities').
+          with(body: request_file,
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'test': 'entities'}.to_json, headers: {})
+    end
+    it 'test entities' do
+      params = DocumentParameters.new
+      params.content = 'Bill Murray will appear in new Ghostbusters film: Dr. Peter Venkman was spotted filming a' \
+                       ' cameo in Boston this… http://dlvr.it/BnsFfS'
+      response = RosetteAPI.new('0123456789').get_entities(params)
+      expect(response).instance_of? Hash
+    end
+  end
+
+  describe '.get_entities_linked' do
+    request_file = File.read File.expand_path(File.join(File.dirname(__FILE__), '../mock-data/request/entities_linked.json'))
+    before do
+      stub_request(:post, 'https://api.rosette.com/rest/v1/info?clientVersion=1.0.2').
+          with(body: "\"{\\\"body\\\": \\\"version check\\\"}\"",
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'versionChecked': true}.to_json, headers: {})
+      stub_request(:post, 'https://api.rosette.com/rest/v1/entities/linked').
+          with(body: request_file,
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'test': 'entities/linked'}.to_json, headers: {})
+    end
+    it 'test entities linked' do
+      params = DocumentParameters.new
+      params.content = 'Last month director Paul Feig announced the movie will have an all-star female cast including' \
+                       ' Kristen Wiig, Melissa McCarthy, Leslie Jones and Kate McKinnon.'
+      response = RosetteAPI.new('0123456789').get_entities_linked(params)
+      expect(response).instance_of? Hash
+    end
+  end
+
+  describe '.get_categories' do
+    request_file = File.read File.expand_path(File.join(File.dirname(__FILE__), '../mock-data/request/categories.json'))
+    before do
+      stub_request(:post, 'https://api.rosette.com/rest/v1/info?clientVersion=1.0.2').
+          with(body: "\"{\\\"body\\\": \\\"version check\\\"}\"",
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'versionChecked': true}.to_json, headers: {})
+      stub_request(:post, 'https://api.rosette.com/rest/v1/categories').
+          with(body: request_file,
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'test': 'categories'}.to_json, headers: {})
+    end
+    it 'test categories' do
+      params = DocumentParameters.new
+      params.content_uri = 'http://www.onlocationvacations.com/2015/03/05/the-new-ghostbusters-movie-begins-filming-in-boston-in-june/'
+      response = RosetteAPI.new('0123456789').get_categories(params)
+      expect(response).instance_of? Hash
+    end
+  end
+
+  describe '.get_relationships' do
+    request_file = File.read File.expand_path(File.join(File.dirname(__FILE__), '../mock-data/request/relationships.json'))
+    before do
+      stub_request(:post, 'https://api.rosette.com/rest/v1/info?clientVersion=1.0.2').
+          with(body: "\"{\\\"body\\\": \\\"version check\\\"}\"",
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'versionChecked': true}.to_json, headers: {})
+      stub_request(:post, 'https://api.rosette.com/rest/v1/relationships').
+          with(body: request_file,
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'test': 'relationships'}.to_json, headers: {})
+    end
+    it 'test relationships' do
+      params = DocumentParameters.new
+      params.content = 'The Ghostbusters movie was filmed in Boston.'
+      response = RosetteAPI.new('0123456789').get_relationships(params)
+      expect(response).instance_of? Hash
+    end
+  end
+
+  describe '.name_translation' do
+    request_file = File.read File.expand_path(File.join(File.dirname(__FILE__), '../mock-data/request/name_translation.json')), encoding: 'utf-8'
+    before do
+      stub_request(:post, 'https://api.rosette.com/rest/v1/info?clientVersion=1.0.2').
+          with(body: "\"{\\\"body\\\": \\\"version check\\\"}\"",
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'versionChecked': true}.to_json, headers: {})
+      stub_request(:post, 'https://api.rosette.com/rest/v1/name-translation').
+          with(body: request_file,
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'test': 'name-translation'}.to_json, headers: {})
+    end
+    it 'test name translation' do
+      params = NameTranslationParameters.new('معمر محمد أبو منيار القذاف'.encode('UTF-8'), 'eng')
+      params.target_script = 'Latn'
+      response = RosetteAPI.new('0123456789').name_translation(params)
+      expect(response).instance_of? Hash
+    end
+  end
+
+  describe '.name_similarity' do
+    request_file = File.read File.expand_path(File.join(File.dirname(__FILE__), '../mock-data/request/name_similarity.json')), encoding: 'utf-8'
+    before do
+      stub_request(:post, 'https://api.rosette.com/rest/v1/info?clientVersion=1.0.2').
+          with(body: "\"{\\\"body\\\": \\\"version check\\\"}\"",
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'versionChecked': true}.to_json, headers: {})
+      stub_request(:post, 'https://api.rosette.com/rest/v1/name-similarity').
+          with(body: request_file,
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'test': 'name-similarity'}.to_json, headers: {})
+    end
+    it 'test name similarity' do
+      params = NameSimilarityParameters.new('Michael Jackson', '迈克尔·杰克逊')
+      response = RosetteAPI.new('0123456789').name_similarity(params)
+      expect(response).instance_of? Hash
+    end
+
+    it 'badRequestFormat: name2 option can only be an instance of a String or NameParameter' do
+      params = NameSimilarityParameters.new('Michael Jackson', 123)
+      expect { RosetteAPI.new('0123456789').name_similarity(params) }.to raise_error(BadRequestError)
+    end
+  end
+
+  describe '.get_tokens' do
+    request_file = File.read File.expand_path(File.join(File.dirname(__FILE__), '../mock-data/request/tokens.json')), encoding: 'utf-8'
+    before do
+      stub_request(:post, 'https://api.rosette.com/rest/v1/info?clientVersion=1.0.2').
+          with(body: "\"{\\\"body\\\": \\\"version check\\\"}\"",
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'versionChecked': true}.to_json, headers: {})
+      stub_request(:post, 'https://api.rosette.com/rest/v1/tokens').
+          with(body: request_file,
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'test': 'tokens'}.to_json, headers: {})
+    end
+    it 'test tokens' do
+      params = DocumentParameters.new
+      params.content = '北京大学生物系主任办公室内部会议'
+      response = RosetteAPI.new('0123456789').get_tokens(params)
+      expect(response).instance_of? Hash
+    end
+  end
+
+  describe '.get_sentences' do
+    request_file = File.read File.expand_path(File.join(File.dirname(__FILE__), '../mock-data/request/sentences.json'))
+    before do
+      stub_request(:post, 'https://api.rosette.com/rest/v1/info?clientVersion=1.0.2').
+          with(body: "\"{\\\"body\\\": \\\"version check\\\"}\"",
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'versionChecked': true}.to_json, headers: {})
+      stub_request(:post, 'https://api.rosette.com/rest/v1/sentences').
+          with(body: request_file,
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'test': 'sentences'}.to_json, headers: {})
+    end
+    it 'test sentences' do
+      params = DocumentParameters.new
+      params.content = 'This land is your land. This land is my land\nFrom California to the New York island;\nFrom' \
+                       ' the wood forest to the Gulf Stream waters\n\nThis land was made for you and Me.\n\nAs I was' \
+                       ' walking that ribbon of highway,\nI saw above me that endless skyway:\nI saw below me that' \
+                       ' golden valley:\nThis land was made for you and me.'
+      response = RosetteAPI.new('0123456789').get_sentences(params)
+      expect(response).instance_of? Hash
+    end
+  end
+
+  describe '.info' do
+    before do
+      stub_request(:post, 'https://api.rosette.com/rest/v1/info?clientVersion=1.0.2').
+          with(body: "\"{\\\"body\\\": \\\"version check\\\"}\"",
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'versionChecked': true}.to_json, headers: {})
+      stub_request(:get, 'https://api.rosette.com/rest/v1/info').
+          with(headers: {'Accept' => '*/*',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'test': 'info'}.to_json, headers: {})
+    end
+    it 'test info' do
+      response = RosetteAPI.new('0123456789').info
+      expect(response).instance_of? Hash
+    end
+  end
+
+  describe '.ping' do
+    before do
+      stub_request(:post, 'https://api.rosette.com/rest/v1/info?clientVersion=1.0.2').
+          with(body: "\"{\\\"body\\\": \\\"version check\\\"}\"",
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'versionChecked': true}.to_json, headers: {})
+      stub_request(:get, 'https://api.rosette.com/rest/v1/ping').
+          with(headers: {'Accept' => '*/*',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 200, body: {'test': 'ping'}.to_json, headers: {})
+    end
+    it 'test ping' do
+      response = RosetteAPI.new('0123456789').ping
+      expect(response).instance_of? Hash
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: rosette_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Basis Technology Corp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubysl-securerandom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Rosette API gem
+email: support@rosette.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/bad_request_error.rb
+- lib/bad_request_format_error.rb
+- lib/document_parameters.rb
+- lib/name_parameter.rb
+- lib/name_similarity_parameters.rb
+- lib/name_translation_parameters.rb
+- lib/request_builder.rb
+- lib/rosette_api.rb
+- lib/rosette_api_error.rb
+- tests/tests_spec.rb
+homepage: https://github.com/rosette-api/ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 2
+summary: Rosette API gem that supports multilingual text-analytics.
+test_files:
+- tests/tests_spec.rb