test-words-api-client-sdk 1.0.0

data/lib/words_api/models/word_response.rb

@@ -0,0 +1,94 @@
+# words_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WordsApi
+  # This custom type contains the response for word API.
+  class WordResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The word that is searched.
+    # @return [String]
+    attr_accessor :word
+
+    # This field contains detailed information of the word.
+    # @return [Array[WordDetails]]
+    attr_accessor :results
+
+    # This model contains pronunciation details of a specific word.
+    # @return [Object]
+    attr_accessor :pronunciation
+
+    # The frequency of the word usage.
+    # @return [Float]
+    attr_accessor :frequency
+
+    # This custom type contains the syllable details for word API.
+    # @return [SyllableDetails]
+    attr_accessor :syllables
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['word'] = 'word'
+      @_hash['results'] = 'results'
+      @_hash['pronunciation'] = 'pronunciation'
+      @_hash['frequency'] = 'frequency'
+      @_hash['syllables'] = 'syllables'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pronunciation
+        frequency
+        syllables
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(word = nil, results = nil, pronunciation = SKIP,
+                   frequency = SKIP, syllables = SKIP)
+      @word = word
+      @results = results
+      @pronunciation = pronunciation unless pronunciation == SKIP
+      @frequency = frequency unless frequency == SKIP
+      @syllables = syllables unless syllables == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      word = hash.key?('word') ? hash['word'] : nil
+      # Parameter is an array, so we need to iterate through it
+      results = nil
+      unless hash['results'].nil?
+        results = []
+        hash['results'].each do |structure|
+          results << (WordDetails.from_hash(structure) if structure)
+        end
+      end
+
+      results = nil unless hash.key?('results')
+      pronunciation = hash.key?('pronunciation') ? hash['pronunciation'] : SKIP
+      frequency = hash.key?('frequency') ? hash['frequency'] : SKIP
+      syllables = SyllableDetails.from_hash(hash['syllables']) if hash['syllables']
+
+      # Create object from extracted values.
+      WordResponse.new(word,
+                       results,
+                       pronunciation,
+                       frequency,
+                       syllables)
+    end
+  end
+end

data/lib/words_api/utilities/date_time_helper.rb

@@ -0,0 +1,11 @@
+# words_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module WordsApi
+  # A utility  that supports dateTime conversion to different formats
+  class DateTimeHelper < CoreLibrary::DateTimeHelper
+  end
+end

data/lib/words_api/utilities/file_wrapper.rb

@@ -0,0 +1,16 @@
+# words_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WordsApi
+  # A utility to allow users to set the content-type for files
+  class FileWrapper < CoreLibrary::FileWrapper
+    # The constructor.
+    # @param [File] file The file to be sent in the request.
+    # @param [string] content_type The content type of the provided file.
+    def initialize(file, content_type: 'application/octet-stream')
+      super
+    end
+  end
+end

data/lib/words_api.rb

@@ -0,0 +1,49 @@
+# words_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+require 'json'
+
+require 'apimatic_core_interfaces'
+require 'apimatic_core'
+require 'apimatic_faraday_client_adapter'
+
+require_relative 'words_api/api_helper'
+require_relative 'words_api/client'
+
+# Utilities
+require_relative 'words_api/utilities/file_wrapper'
+require_relative 'words_api/utilities/date_time_helper'
+
+# Http
+require_relative 'words_api/http/http_call_back'
+require_relative 'words_api/http/http_method_enum'
+require_relative 'words_api/http/http_request'
+require_relative 'words_api/http/http_response'
+
+# Logger
+require_relative 'words_api/http/auth/custom_header_authentication'
+
+# Models
+require_relative 'words_api/models/base_model'
+require_relative 'words_api/models/definitions_response'
+require_relative 'words_api/models/examples_response'
+require_relative 'words_api/models/pronunciation_details'
+require_relative 'words_api/models/synonyms_response'
+require_relative 'words_api/models/frequency_response'
+require_relative 'words_api/models/word_details'
+require_relative 'words_api/models/word_response'
+require_relative 'words_api/models/pronunciation_response'
+require_relative 'words_api/models/frequency_details'
+require_relative 'words_api/models/syllable_details'
+
+# Exceptions
+require_relative 'words_api/exceptions/api_exception'
+
+require_relative 'words_api/configuration'
+
+# Controllers
+require_relative 'words_api/controllers/base_controller'
+require_relative 'words_api/controllers/ap_is_controller'

data/test/controllers/controller_test_base.rb

@@ -0,0 +1,29 @@
+# words_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'json'
+require 'minitest/autorun'
+require 'minitest/hell'
+require 'minitest/pride'
+require 'minitest/proveit'
+require 'words_api'
+require_relative '../http_response_catcher'
+
+class ControllerTestBase < Minitest::Test
+  parallelize_me!
+  include WordsApi
+  include CoreLibrary
+
+  # Create configuration and set any test parameters
+  def create_configuration
+    Configuration.new(http_callback: HttpResponseCatcher.new)
+  end
+
+  # Initializes the base test controller
+  def setup_class
+    _config = create_configuration
+    @client = Client.new(config: _config)
+  end
+end

data/test/controllers/test_ap_is_controller.rb

@@ -0,0 +1,171 @@
+# words_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require_relative 'controller_test_base'
+
+class APIsControllerTests < ControllerTestBase
+  # Called only once for the class before any test has executed
+  def setup
+    setup_class
+    @controller = @client.ap_is
+    @response_catcher = @controller.http_call_back
+  end
+
+  # Get synonyms of a word.
+  def test_synonyms
+    # Parameters for the API call
+    word = 'lovely'
+
+    # Perform the API call through the SDK function
+    result = @controller.synonyms(word)
+
+    # Test response code
+    assert_equal(200, @response_catcher.response.status_code)
+
+    # Test headers
+    expected_headers = {}
+    expected_headers['content-type'] = 'application/json'
+
+    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
+
+    # Test whether the captured response is as we expected
+    refute_nil(result)
+    expected_body = JSON.parse(
+      '{"word":"lovely","synonyms":["adorable","endearing","cover girl","pin-u'\
+      'p"]}'
+    )
+    received_body = JSON.parse(@response_catcher.response.raw_body)
+    assert(ComparisonHelper.match_body(expected_body, received_body))
+  end
+
+  # Get definitions of a word, including the part of speech.
+  def test_definitions
+    # Parameters for the API call
+    word = 'lovely'
+
+    # Perform the API call through the SDK function
+    result = @controller.definitions(word)
+
+    # Test response code
+    assert_equal(200, @response_catcher.response.status_code)
+
+    # Test headers
+    expected_headers = {}
+    expected_headers['content-type'] = 'application/json'
+
+    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
+
+    # Test whether the captured response is as we expected
+    refute_nil(result)
+    expected_body = JSON.parse(
+      '{"word":"lovely","definition":["lovable especially in a childlike or na'\
+      'ive way","a very pretty girl who works as a photographer\'s model","app'\
+      'ealing to the emotions as well as the eye"]}'
+    )
+    received_body = JSON.parse(@response_catcher.response.raw_body)
+    assert(ComparisonHelper.match_body(expected_body, received_body))
+  end
+
+  # How to pronounce a word, according to the International Phonetic Alphabet. May include multiple results if the word is pronounced differently depending on its part of speech.
+  def test_pronunciation
+    # Parameters for the API call
+    word = 'wind'
+
+    # Perform the API call through the SDK function
+    result = @controller.pronunciation(word)
+
+    # Test response code
+    assert_equal(200, @response_catcher.response.status_code)
+
+    # Test headers
+    expected_headers = {}
+    expected_headers['content-type'] = 'application/json'
+
+    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
+
+    # Test whether the captured response is as we expected
+    refute_nil(result)
+    expected_body = JSON.parse(
+      '{"word":"wind","pronunciation":{"all":"wɪnd","noun":"wɪnd","verb":"waɪn'\
+      'd"}}'
+    )
+    received_body = JSON.parse(@response_catcher.response.raw_body)
+    assert(ComparisonHelper.match_body(expected_body, received_body))
+  end
+
+  # Retrieve information about a word. Results can include definitions, part of speech, synonyms, related words, syllables, and pronunciation. This method is useful to see which relationships are attached to which definition and part of speech of a word.
+  def test_word
+    # Parameters for the API call
+    word = 'Testing'
+
+    # Perform the API call through the SDK function
+    result = @controller.word(word)
+
+    # Test response code
+    assert_equal(200, @response_catcher.response.status_code)
+
+    # Test headers
+    expected_headers = {}
+    expected_headers['content-type'] = 'application/json'
+
+    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
+  end
+
+  # Get examples of how the word is used.
+  def test_examples
+    # Parameters for the API call
+    word = 'wind'
+
+    # Perform the API call through the SDK function
+    result = @controller.examples(word)
+
+    # Test response code
+    assert_equal(200, @response_catcher.response.status_code)
+
+    # Test headers
+    expected_headers = {}
+    expected_headers['content-type'] = 'application/json'
+
+    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
+
+    # Test whether the captured response is as we expected
+    refute_nil(result)
+    expected_body = JSON.parse(
+      '{"word":"testing","examples":["there are laboratories for commercial te'\
+      'sting","it involved testing thousands of children for smallpox","they a'\
+      'greed to end the testing of atomic weapons"]}'
+    )
+    received_body = JSON.parse(@response_catcher.response.raw_body)
+    assert(ComparisonHelper.match_body(expected_body, received_body))
+  end
+
+  # Expands upon the frequency score returned by the main /words/{word} endpoint. Returns zipf, a score indicating how common the word is in the English language, with a range of 1 to 7; per Million, the number of times the word is likely to appear in a corpus of one million English words; and diversity, a 0-1 scale the shows the likelihood of the word appearing in an English document that is part of a corpus.
+  def test_frequency
+    # Parameters for the API call
+    word = 'lovely'
+
+    # Perform the API call through the SDK function
+    result = @controller.frequency(word)
+
+    # Test response code
+    assert_equal(200, @response_catcher.response.status_code)
+
+    # Test headers
+    expected_headers = {}
+    expected_headers['content-type'] = 'application/json'
+
+    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
+
+    # Test whether the captured response is as we expected
+    refute_nil(result)
+    expected_body = JSON.parse(
+      '{"word":"wind","frequency":{"zipf":4.81,"perMillion":64.22,"diversity":'\
+      '0.2}}'
+    )
+    received_body = JSON.parse(@response_catcher.response.raw_body)
+    assert(ComparisonHelper.match_body(expected_body, received_body))
+  end
+
+end

data/test/http_response_catcher.rb

@@ -0,0 +1,19 @@
+# words_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+class HttpResponseCatcher < WordsApi::HttpCallBack
+  attr_accessor :response
+
+  def on_before_request(request)
+  end
+
+  # Catching the response
+  def on_after_response(response)
+    @response = response
+  end
+end
+
+
+

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: test-words-api-client-sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sufyan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: apimatic_core_interfaces
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: apimatic_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.9
+- !ruby/object:Gem::Dependency
+  name: apimatic_faraday_client_adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.24.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.24.0
+- !ruby/object:Gem::Dependency
+  name: minitest-proveit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Words API lets you retrieve information about English words, including
+  definitions, synonyms, rhymes, pronunciation, syllables, and frequency of usage.
+  It also can tell you about relationships between words, for instance that “math”
+  has categories like “algebra” and “geometry”, or that a “finger” is part of a “hand”.
+email: []
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/words_api.rb
+- lib/words_api/api_helper.rb
+- lib/words_api/client.rb
+- lib/words_api/configuration.rb
+- lib/words_api/controllers/ap_is_controller.rb
+- lib/words_api/controllers/base_controller.rb
+- lib/words_api/exceptions/api_exception.rb
+- lib/words_api/http/auth/custom_header_authentication.rb
+- lib/words_api/http/http_call_back.rb
+- lib/words_api/http/http_method_enum.rb
+- lib/words_api/http/http_request.rb
+- lib/words_api/http/http_response.rb
+- lib/words_api/models/base_model.rb
+- lib/words_api/models/definitions_response.rb
+- lib/words_api/models/examples_response.rb
+- lib/words_api/models/frequency_details.rb
+- lib/words_api/models/frequency_response.rb
+- lib/words_api/models/pronunciation_details.rb
+- lib/words_api/models/pronunciation_response.rb
+- lib/words_api/models/syllable_details.rb
+- lib/words_api/models/synonyms_response.rb
+- lib/words_api/models/word_details.rb
+- lib/words_api/models/word_response.rb
+- lib/words_api/utilities/date_time_helper.rb
+- lib/words_api/utilities/file_wrapper.rb
+- test/controllers/controller_test_base.rb
+- test/controllers/test_ap_is_controller.rb
+- test/http_response_catcher.rb
+homepage: https://apimatic.io
+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.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Words API lets you retrieve information about English words, including definitions,
+  synonyms, rhymes, pronunciation, syllables, and frequency of usage.
+test_files: []