jisho_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f084d032b9f636ddcf347b1eb71743ae70532c6e846c2e80892fbf4d173783f1
+  data.tar.gz: cbf0021ece4f5fe0ee1d434c121f3cee0ca08bde0eddf1ebbce513a23ff6fa61
+SHA512:
+  metadata.gz: c4f1975c60a3c82f39d95b39a6382888b8c8298a5aeaadae4bc7ea4fa40a6241fb0031a8c311f204a553f0c5a5771c90968dc68b270466b697262734379dc77d
+  data.tar.gz: ee757dbaf087b7260e248903d3eb27c05ef6baf3cbed837b10287cce783460155201d7b0b7ee8cf538e492b5c74389204bd6db1cf62f86bf849a2f2efb893398

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0
+
+- Initial commit

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'activesupport', '~> 6'
+
+gem 'faraday', '~> 1'
+gem 'httplog', '~> 1.4'

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    jisho_api (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    concurrent-ruby (1.1.6)
+    faraday (1.0.0)
+      multipart-post (>= 1.2, < 3)
+    httplog (1.4.2)
+      rack (>= 1.0)
+      rainbow (>= 2.0.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.0)
+    multipart-post (2.1.1)
+    rack (2.2.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    zeitwerk (2.1.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 6)
+  bundler (~> 2.0)
+  faraday (~> 1)
+  httplog (~> 1.4)
+  jisho_api!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 tomholford
+
+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,88 @@
+# JishoAPI
+
+An unofficial Ruby gem client for [Jisho](https://jisho.org), a Japanese dictionary. 
+
+For details about the API, check out [this thread](https://jisho.org/forum/54fefc1f6e73340b1f160000-is-there-any-kind-of-search-api) by the [developer](https://github.com/Kimtaro).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jisho_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jisho_api
+
+## Usage
+
+### Querying
+
+A search `query` is required, and can be set in a few ways:
+
+```ruby
+require 'jisho_api'
+
+# Class method
+JishoAPI::JishoAPI.search('hamburger')
+>> [{ ... }]
+
+# Initializer
+api = JishoAPI::JishoAPI.new(query: 'ピザ')
+
+# Accessor
+api.query = '#jlpt-n5'
+
+# Instance method
+api.search # will use the internally stored query
+>> [{ ... }]
+
+api.search(query: 'something else') # will override (but not set) the internally stored query
+>> [{ ... }]
+
+```
+
+### Pagination
+
+By default, the gem will fetch the first page of results. There are also a few ways to override this behavior:
+
+```ruby
+
+# Initializer
+api = JishoAPI::JishoAPI.new(query: 'ピザ', page: 2)
+
+# Accessor
+api.page = 3
+
+# Instance methods
+# Fetching a page for a given query
+api.search(query: 'something else', page: 2)
+>> [{ ... }]
+
+# This increments the internal page counter and executes a request
+api.next_page!
+>> [{ ... }]
+
+puts api.page
+>> 4
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/tomholford/jisho-api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jisho_api"
+require 'irb'
+
+api = JishoAPI::JishoAPI.new(debug: true)
+
+binding.irb

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here