wordwiki 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9495d04ebb634a952d767ce4bf34c95d635f37a1ae43b83d644c45c571aeb545
+  data.tar.gz: 53e99fa5b036274aebdbc45b0960fe432a1005be5829ce9264504f1956afb5eb
+SHA512:
+  metadata.gz: 3fab08cebd11119ee4f922be0a629c886c8aa46dac01b32eee8bb424dcd62e361b81cc61fd398433586c792deb670a82d670ed5c5d2916adce7c319cd76a94c5
+  data.tar.gz: cec4d61cac4dce2a8e33e8ac88a1137c7c404dfb6fb3124fa432dfe0dac17db9f4f874c94ad4e6afb2dc176ea3a20acf13d6f16d46fdb3a369ce666cd75c62dd

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Lovepreet
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# wordwiki
+
+[![Gem Version](https://badge.fury.io/rb/wordwiki.svg)](https://rubygems.org/gems/wordwiki)
+[![Code Climate](https://codeclimate.com/github/lovepreetkaul/wordwiki/badges/gpa.svg)](https://codeclimate.com/github/lovepreetkaul/wordwiki)
+
+Simple commandline based dictionary and wiki. Definitions and answers at your fingertips.
+
+---
+
+- [Quick start](#quick-start)
+- [Support](#support)
+- [License](#license)
+- [Code of conduct](#code-of-conduct)
+- [Contribution guide](#contribution-guide)
+
+## Quick start
+
+```
+$ gem install wordwiki
+```
+
+```ruby
+require "wordwiki"
+```
+
+## Support
+
+If you want to report a bug, or have ideas, feedback or questions about the gem, [let me know via GitHub issues](https://github.com/lovepreetkaul/wordwiki/issues/new) and I will do my best to provide a helpful answer. Happy hacking!
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
+
+## Code of conduct
+
+Everyone interacting in this project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
+
+## Contribution guide
+
+Pull requests are welcome!

data/exe/wordwiki

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/wordwiki"
+
+Wordwiki::CLI.start(ARGV)

data/lib/wordwiki/cli.rb

@@ -0,0 +1,15 @@
+require 'thor'
+
+module Wordwiki
+  class CLI < Thor
+    include Wordwiki
+    class_option :verbose, :aliases => "-v"
+
+    desc "define WORD", "Get the definition for WORD"
+    def define(word)
+      #TODO Word validation
+      puts get_definition(word)
+    end
+    
+  end
+end

data/lib/wordwiki/constants.rb

@@ -0,0 +1,3 @@
+module Wordwiki
+    FREE_DICTIONARY_URL = "https://api.dictionaryapi.dev/api/v2/entries/en"
+end

data/lib/wordwiki/version.rb

@@ -0,0 +1,3 @@
+module Wordwiki
+  VERSION = "0.2.0".freeze
+end

data/lib/wordwiki.rb

@@ -0,0 +1,35 @@
+require 'faraday'
+require 'json'
+require 'colorize'
+
+require_relative "wordwiki/cli.rb"
+require_relative "wordwiki/version.rb"
+require_relative 'wordwiki/constants.rb'
+
+module Wordwiki
+    def get_definition(word)
+        response = Faraday.get("#{FREE_DICTIONARY_URL}/#{word}")
+        format_definition(response.body)
+    end
+
+    private
+
+    def format_definition(body)
+        #TODO Colorize and format output
+        #TODO Implement verbose mode
+        bodyhash = JSON.parse(body)
+        formatted_output = ""
+        bodyhash.each do |word|
+            formatted_output << ":: |- Word:   #{word["word"]}\n"
+            formatted_output << "::    |- Origin: #{word["origin"]}\n"
+            formatted_output << "::    |- Definitions::>\n"
+            word["meanings"].each do |meaning|
+                meaning["definitions"].each do |definition|
+                    formatted_output << "::       |- #{definition["definition"]}\n"
+                    formatted_output << "::          Example: #{definition["example"]}\n"
+                end
+            end
+        end
+        formatted_output
+    end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: wordwiki
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Lovepreet
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- lovepreetkaul23@gmail.com
+executables:
+- wordwiki
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- exe/wordwiki
+- lib/wordwiki.rb
+- lib/wordwiki/cli.rb
+- lib/wordwiki/constants.rb
+- lib/wordwiki/version.rb
+homepage: https://github.com/lovepreetkaul/wordwiki
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/lovepreetkaul/wordwiki/issues
+  changelog_uri: https://github.com/lovepreetkaul/wordwiki/releases
+  source_code_uri: https://github.com/lovepreetkaul/wordwiki
+  homepage_uri: https://github.com/lovepreetkaul/wordwiki
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.16
+signing_key:
+specification_version: 4
+summary: Commandline based dictionary and wiki.
+test_files: []