cambridge_dict 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c267c98cdc071799bc99ff46db6963e543bf79ba0a96ce1efb391d27fabcd40c
-  data.tar.gz: 3bfc706d541138132c78030a885a227eb3f66cb1405235b5c87022420f204b2c
+  metadata.gz: 83f7f7932b9333e01c7af904c306f9e0a215cd797c824285b301292924b880ec
+  data.tar.gz: 244ebce0e0e906b85d111fbbdea76b3870e02fea54f16d6c232fc2711db68be6
 SHA512:
-  metadata.gz: 6f31eeb418116539c5d61b9487a0bfc1d98c0bfa310c986bf7a4ac99a213c46e98e4032a7bc45f0b85ae87cb82ff2ea043fbd7979c600ad94d2442dc84fbb3ba
-  data.tar.gz: defbccf32f337d0ddbefac15a85853e27e0487cf6f4d67f77cde947228bc50fe77bc2d0270d948a26b5fe0dd47b93e891d06d75bf433f0781f0d036d03c3aef8
+  metadata.gz: 4071c55b3707412ef8681946aa61c8d16bdd2b98e074bf6a2c1d4ecc52a58b9398b08920a22032469ad324b699a78aa5702e9cb7494c297d0c61fc3013db3e44
+  data.tar.gz: 7e4e7927bc956849ed64f97c0d829a40696f95932adfdc0bc3fc74258728bc7449031182993c3edf5790fc6adf911f7ad75903250b6b9ddc2c6592e58c4fb0e6

data/README.md

@@ -11,9 +11,18 @@ gem install cambridge_dict
 ## Client Usage
 
 ```
+# throws error
+client = CambridgeDictionary::Client.lookup! "hello", "en"
+
+# returns nil if not found
+client = CambridgeDictionary::Client.lookup "hello", "en"
+
+# can also create instance
 client = CambridgeDictionary::Client.new
 result = client.lookup("back", language: "en")
 
+return if result.nil?
+
 =>
 {:word=>"back",                                                                                 
  :pos=>["adverb", "noun", "verb", "adjective"],                                                                                                                                                 
@@ -58,11 +67,14 @@ result = client.lookup("back", language: "en")
 ## Webserver Setup
 
 ```
+# add sinatra and sinatra-cors to gemfile
+
 # config.ru
-require 'cambridge_dictionary'
-run CambridgeDictionary::API
+require 'cambridge_dict'
+require 'cambridge_dict/server'
+run CambridgeDict::Server
 
-ruby config.ru
+rackup config.ru
 ```
 
 ## Development

data/config.ru

@@ -1,2 +1,3 @@
 require './lib/cambridge_dict'
-run CambridgeDictionary::API
+require './lib/cambridge_dict/server'
+run CambridgeDict::Server

data/lib/cambridge_dict/server.rb

@@ -0,0 +1,29 @@
+require 'sinatra'
+require 'sinatra/cors'
+
+module CambridgeDict
+  class Server < Sinatra::Base
+    register Sinatra::Cors
+
+    set :allow_origin, "*"
+    set :allow_methods, "GET,HEAD,POST"
+    set :allow_headers, "content-type,if-modified-since"
+    set :expose_headers, "location,link"
+
+    client = Client.new
+
+    get '/api/dictionary/:language/:entry' do
+      content_type :json
+
+      result = client.lookup(params[:entry], language: params[:language])
+
+      if result && !result[:word].empty?
+        status 200
+        result.to_json
+      else
+        status 404
+        {error: "word not found"}.to_json
+      end
+    end
+  end
+end

data/lib/cambridge_dict/version.rb

@@ -1,3 +1,3 @@
 module CambridgeDict
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/lib/cambridge_dict.rb

@@ -1,16 +1,25 @@
 require 'nokogiri'
 require 'httparty'
-require 'sinatra'
-require 'sinatra/cors'
-require 'cambridge_dict/version'
+
+require_relative 'cambridge_dict/version'
 
 module CambridgeDict
+  class Error < StandardError; end
+
   class Client
     def initialize
       @base_url = "https://dictionary.cambridge.org"
       @wiki_base = "https://simple.wiktionary.org/wiki"
     end
 
+    def self.lookup(word, language: 'en')
+      self.new.lookup(word, language: language)
+    end
+
+    def self.lookup!(word, language: 'en')
+      self.new.lookup!(word, language: language)
+    end
+
     def lookup(word, language: 'en')
       nation, dict_lang = parse_language(language)
       url = "#{@base_url}/#{nation}/dictionary/#{dict_lang}/#{word}"
@@ -23,8 +32,12 @@ module CambridgeDict
       doc = Nokogiri::HTML(response.body)
       wiki_verbs = fetch_verbs("#{@wiki_base}/#{word}")
 
+      word = extract_word(doc)
+
+      return nil if word.nil?
+
       {
-        word: extract_word(doc),
+        word: word,
         pos: extract_pos(doc),
         verbs: wiki_verbs,
         pronunciation: extract_pronunciation(doc),
@@ -32,6 +45,16 @@ module CambridgeDict
       }
     end
 
+    def lookup!(word, language: 'en')
+      result = lookup word, language: language
+
+      if result.nil?
+        raise Error.new "Word not found!"
+      end
+
+      result
+    end
+
     private
 
     def parse_language(lang)
@@ -69,7 +92,7 @@ module CambridgeDict
     end
 
     def extract_word(doc)
-      doc.at_css('.hw.dhw')&.text || ''
+      doc.at_css('.hw.dhw')&.text
     end
 
     def extract_pos(doc)
@@ -147,28 +170,4 @@ module CambridgeDict
     end
   end
 
-  class API < Sinatra::Base
-    register Sinatra::Cors
-
-    set :allow_origin, "*"
-    set :allow_methods, "GET,HEAD,POST"
-    set :allow_headers, "content-type,if-modified-since"
-    set :expose_headers, "location,link"
-
-    client = Client.new
-
-    get '/api/dictionary/:language/:entry' do
-      content_type :json
-
-      result = client.lookup(params[:entry], language: params[:language])
-
-      if result && !result[:word].empty?
-        status 200
-        result.to_json
-      else
-        status 404
-        {error: "word not found"}.to_json
-      end
-    end
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cambridge_dict
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ben D'Angelo
@@ -14,58 +14,30 @@ dependencies:
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.15'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.21'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.21'
-- !ruby/object:Gem::Dependency
-  name: sinatra
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: sinatra-cors
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +91,7 @@ files:
 - Rakefile
 - config.ru
 - lib/cambridge_dict.rb
+- lib/cambridge_dict/server.rb
 - lib/cambridge_dict/version.rb
 homepage: https://codeberg.org/bendangelo/cambridge_dict
 licenses: