wordniknik 1.0.0.pre.beta.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fb440a0662f5612f8137956f1880bde5d0df786e57b641280984f702b31917a
-  data.tar.gz: 48bde3e097cca779a32bb3ddd675ed1e400a8a674b82e94440f73c8e4d089ba1
+  metadata.gz: ba0f7f6d3bcee957c78f5e64d10a1dfece0eda19f1f9dc4833fddd7747b97d86
+  data.tar.gz: de70b9f33a67bb7dad8e52cbcea8fa491c2e4d4837b97969bd263175dfec4a85
 SHA512:
-  metadata.gz: b9de81f28363c4138323228d2d2a81ed1aa3610c9f9a6c8e6e2cd3c2af022e2b31980bfbd888bfafef263414acebe7ccaa367fd3ef6548287cc44ec78f6a7091
-  data.tar.gz: 2b5e1bd3feef16edcc701b4e1dda03066a6f19ec6336f1d19ed86cdd61403b04cab4186e647835be1a53d71b32210751047e8708855feb9f317f0c45c78821fd
+  metadata.gz: 739b4382d12c5bfa2178e240511d1a22fd30352f3c0d654d1402cc89d3cec47dbe7222a59265f28d02e1dc3790ea27135609796302a433381c0b2a66600c6aae
+  data.tar.gz: 1dc00749d44738c7e9e333ac2113178645cad22891a2e67a43a3ef4164aca40ca15e754862687e8b130ed688870e696810cc56bb0a972d7644d73d6781036561

data/lib/wordniknik/client.rb

@@ -3,9 +3,14 @@
 require 'json'
 require 'net/http'
 
+# Wornkiknik is a Ruby client for the Wordnik API.
 module Wordniknik
+  # Error class for Wordniknik.
+  # This class is used to handle errors that occur during API calls.
   class Error < StandardError; end
 
+  # Client class for Wordniknik.
+  # This class is used to interact with the Wordnik API.
   class Client
     attr_accessor :configuration
 
@@ -116,7 +121,7 @@ module Wordniknik
 
       if @clean_up && is_404?(results)
         []
-      elsif @clean_up && is_404?(results)
+      elsif is_404?(results)
         results[:frequency]
       else
         results
@@ -223,8 +228,8 @@ module Wordniknik
 
       if @clean_up && is_404?(results)
         {}
-      elsif @clean_up && results.is_a?(Hash)
-        results
+      elsif is_404?(results)
+        raise Wordniknik::Error, "No example found for word: #{word}"
       else
         results
       end
@@ -420,8 +425,10 @@ module Wordniknik
       result.is_a?(Hash) && result[:status_code] == 404
     end
 
+    # rubocop:disable Naming/PredicateName
     def is_error?(result)
       result.is_a?(Hash) && result[:status_code] && result[:status_code] != 200 && result[:status_code] != 404
     end
+    # rubocop:enable Naming/PredicateName
   end
 end

data/lib/wordniknik/configuration.rb

@@ -4,6 +4,7 @@ require 'yaml'
 
 module Wordniknik
   WORDNIK_CONFIG_FILE = '.wordnik.yml'
+  # Wordnik API configuration class
   class Configuration
     attr_accessor :api_key, :api_host, :api_port, :api_version, :connection
 
@@ -20,7 +21,7 @@ module Wordniknik
       @api_version = loaded['api_version'] || defaults[:api_version]
       return unless @api_key.nil?
 
-      raise "No API key found. Please set it in the environment variable WORDNIK_API_KEY or in a #{WORDNIK_CONFIG_FILE} file."
+      raise "No API key found. Please set WORDNIK_API_KEY or in a #{WORDNIK_CONFIG_FILE} file."
     end
 
     def look_for_config_file

data/lib/wordniknik/utils.rb

@@ -3,6 +3,7 @@
 # deep transform keys of a hash to symbols in snake case
 require 'time'
 
+# Wordniknik module
 module Wordniknik
   module_function
 

data/lib/wordniknik/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Wordniknik
-  VERSION = '1.0.0-beta.1'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: wordniknik
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Will Fitzgerald
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-13 00:00:00.000000000 Z
+date: 2025-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -43,7 +42,6 @@ metadata:
   source_code_uri: https://github.com/willf/wordniknik
   changelog_uri: https://github.com/willf/wordniknik/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -58,8 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: A ruby wrapper for the Wordnik API
 test_files: []