ruby_jisho 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35ddea43216caf20e4ed6fbb03ec4c0b960cd0ce
+  data.tar.gz: 904c8952ed59616abc041bef93dee1cff5813efa
+SHA512:
+  metadata.gz: cbdc70492e084a2ba1f9a147979560167d173bf3b85c12ed7c1ce0e2118ed26e16abeef331fe82ed026a0d8a26f018483e10d4212461b5033b00744e1b964573
+  data.tar.gz: 33f100e86b302bb058fee30634db22b33c254e0e32dd2495d41003ad1e330a51a1d7977ec878f8e762f0e032260ed7a79845259c2697285aae70166578b6ffbc

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.hound.yml

@@ -0,0 +1,3 @@
+ruby:
+  config_file: .rubocop.yml
+fail_on_violations: true

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,3 @@
+Metrics/BlockLength:
+  ExcludedMethods:
+    describe

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.3

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,43 @@
+# RubyJisho
+
+A Ruby wrapper for the [Jisho](https://jisho.org) API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_jisho'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_jisho
+
+## Usage
+
+To search Jisho, use the `.search` method:
+
+```ruby
+RubyJisho.search("リス")
+```
+
+Responses will be in the form of a `RubyJisho::Results` object.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dysnomian/ruby_jisho.
+
+## Thanks
+
+My sincerest thanks to the Jisho team for building such a beautiful and thoughtful tool.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'ruby_jisho'
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/ruby_jisho/result.rb

@@ -0,0 +1,41 @@
+module RubyJisho
+  # A single result from the API response
+  class Result
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+
+    def keys
+      response.keys
+    end
+
+    def senses
+      response.fetch(:senses)
+              .map { |s| Sense.new(s) }
+    end
+
+    def to_h
+      keys.each_with_object({}) do |k, hash|
+        hash[k] = begin
+                    send(k)
+                  rescue NoMethodError
+                    response.fetch(k, nil)
+                  end
+      end
+    end
+
+    def method_missing(sym, *args, &block)
+      if keys.include?(sym)
+        response.fetch(sym)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      keys.include?(method_name) || super
+    end
+  end
+end

data/lib/ruby_jisho/results.rb

@@ -0,0 +1,45 @@
+require 'json'
+
+module RubyJisho
+  # Enumberable to store metadata and wrap Result objects cleanly
+  class Results
+    include Enumerable
+
+    attr_reader :payload
+
+    def initialize(payload)
+      @payload = JSON.parse(payload, symbolize_names: true)
+    end
+
+    def meta
+      payload.fetch(:meta, {})
+    end
+
+    def keys
+      payload.keys
+    end
+
+    def each
+      data.each { |r| yield r }
+    end
+
+    def method_missing(sym, *args, &block)
+      if keys.include?(sym)
+        payload.fetch(sym)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      keys.include?(method_name) || super
+    end
+
+    private
+
+    def data
+      payload.fetch(:data, [{}])
+             .map { |r| Result.new(r) }
+    end
+  end
+end

data/lib/ruby_jisho/search.rb

@@ -0,0 +1,26 @@
+require 'faraday'
+
+module RubyJisho
+  # Queries the Jisho API and returns a Results object
+  class Search
+    attr_reader :query
+
+    def initialize(query)
+      @query = query
+    end
+
+    def results
+      @results ||= Results.new(json_response)
+    end
+
+    private
+
+    def json_response
+      @json_response ||= Faraday.get(endpoint + query).body
+    end
+
+    def endpoint
+      'http://jisho.org/api/v1/search/words?keyword='
+    end
+  end
+end

data/lib/ruby_jisho/sense.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RubyJisho
+  # Wrapper for sense hashes from the Jisho API
+  class Sense
+    attr_reader :response
+
+    def initialize(response_hash)
+      @response = response_hash
+    end
+
+    def parts_of_speech
+      response.fetch(:parts_of_speech, [''])
+              .map { |p| p.downcase.to_sym }
+    end
+
+    def to_h
+      response
+    end
+
+    def keys
+      response.keys
+    end
+
+    def method_missing(sym, *args, &block)
+      if keys.include?(sym)
+        response.fetch(sym)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      keys.include?(method_name) || super
+    end
+  end
+end

data/lib/ruby_jisho/version.rb

@@ -0,0 +1,3 @@
+module RubyJisho
+  VERSION = '0.1.0'.freeze
+end

data/lib/ruby_jisho.rb

@@ -0,0 +1,15 @@
+require 'ruby_jisho/version'
+require 'ruby_jisho/search'
+require 'ruby_jisho/result'
+require 'ruby_jisho/sense'
+require 'ruby_jisho/results'
+require 'json'
+
+# Gem namespace module plus convenience methods
+module RubyJisho
+  module_function
+
+  def search(query)
+    Search.new(query).results
+  end
+end

data/ruby_jisho.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_jisho/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ruby_jisho'
+  spec.version       = RubyJisho::VERSION
+  spec.authors       = ['Liss McCabe']
+  spec.email         = ['liss@eristiccode.com']
+
+  spec.summary       = 'Gem adapter for the Jisho search API'
+  spec.homepage      = 'https://github.com/dysnomian/ruby_jisho'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake',    '~> 10.0'
+  spec.add_development_dependency 'rspec',   '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.42'
+  spec.add_development_dependency 'pry',     '~> 0.10'
+  spec.add_dependency             'faraday', '~> 0.9'
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: ruby_jisho
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Liss McCabe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.42'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.42'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: 
+email:
+- liss@eristiccode.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruby_jisho.rb
+- lib/ruby_jisho/result.rb
+- lib/ruby_jisho/results.rb
+- lib/ruby_jisho/search.rb
+- lib/ruby_jisho/sense.rb
+- lib/ruby_jisho/version.rb
+- ruby_jisho.gemspec
+homepage: https://github.com/dysnomian/ruby_jisho
+licenses: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Gem adapter for the Jisho search API
+test_files: []