wordsapi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ff450a4b563e5fca11d53b9cf94cbb5aac089b493edf3248537b2e8d07e2cae7
+  data.tar.gz: 4f7122b5bc61a26dd0b094dd9859d9573009acb90a8562e6c74a0fe8c30e8df9
+SHA512:
+  metadata.gz: 7e1055ac20be31841797d96db6ac262e71eb7d5567c16be040c1ce04aee95ba7c4538b2a9b45671ecf5a0e438c290035fcd5771c83f6a8bd520f57c8aa09c7a6
+  data.tar.gz: 21000cc30f9e520bd9597bf597ffbdcf0f515aac20f670cf2f306fa3372d2e89bad2e1db3e32b56f20f6d4ad971c9b835e151029717ea7507168df0eb8f4505b

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2018 Nardo Nykolyszyn
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: 'spec'

data/lib/wordsapi.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'wordsapi/base'
+
+class WordsAPI < Base
+
+  def service_url
+    'https://wordsapiv1.p.rapidapi.com/words'
+  end
+
+  def has_types?(word)
+    response = connection.get has_types_endpoint(word)
+    response = process_response(response)
+    OpenStruct.new(success?: true, body: response)
+  rescue Faraday::ClientError => exception
+    OpenStruct.new(success?: false, message: 'Wrong data provided', details: exception.response[:body].to_s)
+  rescue Faraday::Error::TimeoutError, Faraday::ConnectionFailed, Timeout::Error => e
+    OpenStruct.new(success?: false, message: 'Words API is not available')
+  end
+
+  def type_of?(word)
+    response = connection.get type_of_endpoint(word)
+    response = process_response(response)
+    OpenStruct.new(success?: true, body: response)
+  rescue Faraday::ClientError => exception
+    OpenStruct.new(success?: false, message: 'Wrong data provided', details: exception.response[:body].to_s)
+  rescue Faraday::Error::TimeoutError, Faraday::ConnectionFailed, Timeout::Error => e
+    OpenStruct.new(success?: false, message: 'Words API is not available')
+  end
+
+  def part_of?(word)
+    response = connection.get part_of_endpoint(word)
+    response = process_response(response)
+    OpenStruct.new(success?: true, body: response)
+  rescue Faraday::ClientError => exception
+    OpenStruct.new(success?: false, message: 'Wrong data provided', details: exception.response[:body].to_s)
+  rescue Faraday::Error::TimeoutError, Faraday::ConnectionFailed, Timeout::Error => e
+    OpenStruct.new(success?: false, message: 'Words API is not available')
+  end
+
+  def has_parts?(word)
+    response = connection.get has_parts_endpoint(word)
+    response = process_response(response)
+    OpenStruct.new(success?: true, body: response)
+  rescue Faraday::ClientError => exception
+    OpenStruct.new(success?: false, message: 'Wrong data provided', details: exception.response[:body].to_s)
+  rescue Faraday::Error::TimeoutError, Faraday::ConnectionFailed, Timeout::Error => e
+    OpenStruct.new(success?: false, message: 'Words API is not available')
+  end
+
+  def similar_to(word)
+    response = connection.get similar_to_endpoint(word)
+    response = process_response(response)
+    OpenStruct.new(success?: true, body: response)
+  rescue Faraday::ClientError => exception
+    OpenStruct.new(success?: false, message: 'Wrong data provided', details: exception.response[:body].to_s)
+  rescue Faraday::Error::TimeoutError, Faraday::ConnectionFailed, Timeout::Error => e
+    OpenStruct.new(success?: false, message: 'Words API is not available')
+  end
+
+  def usage_of(word)
+    response = connection.get usage_of_endpoint(word)
+    response = process_response(response)
+    OpenStruct.new(success?: true, body: response)
+  rescue Faraday::ClientError => exception
+    OpenStruct.new(success?: false, message: 'Wrong data provided', details: exception.response[:body].to_s)
+  rescue Faraday::Error::TimeoutError, Faraday::ConnectionFailed, Timeout::Error => e
+    OpenStruct.new(success?: false, message: 'Words API is not available')
+  end
+
+  
+
+  private
+
+  def has_types_endpoint(word)
+    "/#{word}/hasTypes"
+  end
+
+  def type_of_endpoint(word)
+    "/#{word}/typeOf"
+  end
+
+  def part_of_endpoint(word)
+    "/#{word}/partOf"
+  end
+
+  def has_parts_endpoint(word)
+    "/#{word}/hasParts"
+  end
+
+  def similar_to_endpoint(word)
+    "/#{word}/similarTo"
+  end
+
+  def usage_of_endpoint(word)
+    "/#{word}/usageOf"
+  end
+end

data/lib/wordsapi/active_support/deep_symbolize_keys.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module SymbolizeHelper
+  extend self
+
+  def symbolize_recursive(hash)
+    {}.tap do |h|
+      hash.each { |key, value| h[key.to_sym] = transform(value) }
+    end
+  end
+
+  private
+
+  def transform(thing)
+    case thing
+    when Hash; symbolize_recursive(thing)
+    when Array; thing.map { |v| transform(v) }
+    else; thing
+    end
+  end
+
+  refine Hash do
+    def deep_symbolize_keys
+      SymbolizeHelper.symbolize_recursive(self)
+    end
+  end
+end

data/lib/wordsapi/base.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'faraday/request_id'
+require 'faraday_middleware'
+require 'wordsapi/active_support/deep_symbolize_keys'
+
+class Base
+  using SymbolizeHelper
+  attr_reader :access_token
+
+  def initialize(access_token: '')
+    @access_token = access_token
+  end
+
+  def service_url
+    raise NotImplementedError
+  end
+
+  private
+
+  def connection
+    @connection ||= Faraday.new(service_url) do |config|
+      config.request :json
+      config.response :raise_error
+      config.response :json, content_type: /\bjson$/
+      config.use :instrumentation
+      config.options[:timeout] = 10
+      config.use Faraday::RequestId
+      config.adapter Faraday.default_adapter
+      config.headers['X-RapidAPI-Key'] = access_token
+    end
+  end
+
+  def process_response(response)
+    if response.success?
+      body = response.body
+      if body.empty?
+        {}
+      elsif body.is_a?(Array)
+        body.map(&:deep_symbolize_keys)
+      else
+        body.deep_symbolize_keys
+      end
+    end
+  end
+end

data/lib/wordsapi/version.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module WordsAPI
+  class Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+
+    class << self
+      # @return [String]
+      def to_s
+        [MAJOR, MINOR, PATCH].compact.join('.')
+      end
+    end
+  end
+end
+

data/wordsapi.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wordsapi/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'wordsapi'
+  spec.version = WordsAPI::Version
+  spec.authors = ['Nardo Nykolyszyn']
+  spec.email = ['devpolish@protonmail.com']
+  spec.summary = 'Words API gem'
+  spec.description = 'A Ruby interface to the Words API'
+  spec.homepage = 'https://github.com/devpolish/wordsapi'
+  spec.license = 'MIT'
+
+  spec.files = %w[LICENSE.txt README.md Rakefile wordsapi.gemspec]
+  spec.files += Dir.glob('lib/**/*.rb')
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = Dir.glob('test/**/*')
+  spec.require_paths = ['lib']
+  spec.required_rubygems_version = '>= 1.3.5'
+
+  # Development dependencies
+  spec.add_development_dependency 'bundler',  '~> 1.5'
+  spec.add_development_dependency 'rake',     '~> 0'
+  spec.add_development_dependency 'rspec',    '~> 3.3.0'
+
+  # Productions dependencies
+  spec.add_dependency 'faraday', '~> 0.9.0'
+  spec.add_dependency 'faraday_middleware'
+  spec.add_dependency 'json'
+  spec.add_dependency 'request_id'
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: wordsapi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nardo Nykolyszyn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  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: json
+  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: request_id
+  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: A Ruby interface to the Words API
+email:
+- devpolish@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/wordsapi.rb
+- lib/wordsapi/active_support/deep_symbolize_keys.rb
+- lib/wordsapi/base.rb
+- lib/wordsapi/version.rb
+- wordsapi.gemspec
+homepage: https://github.com/devpolish/wordsapi
+licenses:
+- MIT
+metadata: {}
+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: 1.3.5
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Words API gem
+test_files: []