urbandict 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1135ac26088eeecd1842ba4883b0138d9fbab3e3
+  data.tar.gz: e6f240767d5dd62e67db88fc1a6b6a8918c80861
+SHA512:
+  metadata.gz: de87ef03cb9a9344e9ec49dce0b9e79a8cab23ba9ad8992bb3dbca2bc06234d60b991651e70bf6cce14987fcefbf89b2e0cb672a5de40aef1f5e4b9254985242
+  data.tar.gz: ea520d303882176d34437b2cf639625f27f00202262926aa4a7d4141f757f337893b67cf52c28ce18af049f55918e77e8456373379058cd3283eb20c8d277a87

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+## Version 1
+### 1.0.0
+* Initial release.

data/lib/slang.rb

@@ -0,0 +1,61 @@
+class Slang
+  # @return [Integer] The UrbanDictionary definition ID.
+  attr_reader :id
+
+  # @return [String] The word being defined.
+  attr_reader :word
+
+  # @return [String] The author of the definition.
+  attr_reader :author
+
+  # @return [String] A permalink to the definition.
+  attr_reader :permalink
+
+  # @return [String] The actual definition.
+  attr_reader :definition
+
+  # @return [String] An example of the word's usage.
+  attr_reader :example
+
+  # @return [Integer] The number of thumbs-up the definition has received.
+  attr_reader :upvotes
+
+  # @return [Integer] The number of thumbs-down the definition has received.
+  attr_reader :downvotes
+
+  # Creates a new Slang object.
+  # @param opts [Hash] The options hash.
+  # @option opts [Integer] :id The definition ID.
+  # @option opts [String] :word The word being defined.
+  # @option opts [String] :author The author of the definition.
+  # @option opts [String] :permalink The permalink for the definition.
+  # @option opts [String] :definition The definition for the :word
+  # @option opts [String] :example An example of its usage.
+  # @option opts [Integer] :thumbs_up The number of upvotes the definition has received.
+  # @option opts [Integer] :thumbs_down The number of downvotes the definition has received.
+  def initialize(opts = {})
+    @id = opts['defid'] || opts[:defid]
+    @word = opts['word'] || opts[:word]
+    @author = opts['author'] || opts[:author]
+    @permalink = opts['permalink'] || opts[:permalink]
+    @definition = opts['definition'] || opts[:definition]
+    @example = opts['example'] || opts[:example]
+    @upvotes = opts['thumbs_up'] || opts[:thumbs_up]
+    @downvotes = opts['thumbs_down'] || opts[:thumbs_down]
+  end
+
+  # Returns a hash representation of this Slang object.
+  # @return [Hash<Symbol, Integer/String>] See the source for details.
+  def to_h
+    {
+      id: @id,
+      word: @word,
+      author: @author,
+      permalink: @permalink,
+      definition: @definition,
+      example: @example,
+      upvotes: @upvotes,
+      downvotes: @downvotes
+    }
+  end
+end

data/lib/urbandict.rb

@@ -0,0 +1,25 @@
+require 'httpclient'
+require 'json'
+require_relative 'slang'
+
+module UrbanDictionary
+  module_function
+
+  URL = 'http://api.urbandictionary.com/v0/define'
+
+  # Gets the definitions for the word.
+  # @param word [String] The word to define.
+  # @return [Array<Slang>] An array of #{Slang} objects.
+  def define(word)
+    params = {
+      term: word
+    }
+    @client = HTTPClient.new if @client.nil?
+    response = JSON.parse(@client.get(URI.parse(URL), params).body)
+    ret = []
+    response['list'].each do |hash|
+      ret << Slang.new(hash)
+    end
+    ret
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: urbandict
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Eli Foster
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+description: An interface to the Urban Dictionary API
+email: elifosterwy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- lib/slang.rb
+- lib/urbandict.rb
+homepage: https://github.com/elifoster/urbandict-rb
+licenses:
+- CC-BY-ND-4.0
+metadata:
+  issue_tracker: https://github.com/elifoster/urbandict-rb/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: An interface to the Urban Dictionary API
+test_files: []