jisho_api 0.1.0

data/jisho_api.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jisho_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jisho_api"
+  spec.version       = JishoAPI::VERSION
+  spec.authors       = ["tomholford"]
+  spec.email         = ["tomholford@users.noreply.github.com"]
+
+  spec.summary       = 'Ruby client gem for the unofficial Jisho API.'
+  spec.homepage      = "https://github.com/tomholford/jisho-api"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = 'https://github.com/tomholford/twitter-labs-api/blob/master/CHANGELOG.md'
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/jisho_api/client.rb

@@ -0,0 +1,53 @@
+require 'faraday'
+
+module JishoAPI
+  class APIError < StandardError; end
+
+  class Client
+    attr_accessor :response
+
+    URI = 'https://jisho.org/api/v1/search/words'.freeze
+
+    def initialize; end
+
+    def make_request(params: {})
+      params.merge!(keyword: query) unless params.key?(:keyword)
+      params.merge!(page: page) unless params.key?(:page)
+
+      self.response = connection.get do |req|
+        req.params = params
+      end
+
+      handle_response
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new(
+        url: URI,
+        headers: { 'Content-Type' => 'application/json' }
+      )
+    end
+
+    def handle_response
+      if response.status == 200 && api_status == 200
+        api_data
+      else
+        raise APIError, "#{response.status} response from API"
+      end
+    end
+
+    def api_status
+      parsed_response[:meta][:status]
+    end
+
+    def api_data
+      parsed_response[:data]
+    end
+
+    def parsed_response
+      @parsed_response ||= JSON.parse(response.body).with_indifferent_access
+    end
+  end
+end

data/lib/jisho_api/version.rb

@@ -0,0 +1,3 @@
+module JishoAPI
+  VERSION = "0.1.0"
+end

data/lib/jisho_api.rb

@@ -0,0 +1,46 @@
+require 'json'
+require 'active_support/core_ext/hash/indifferent_access'
+
+require 'jisho_api/version'
+require 'jisho_api/client'
+
+module JishoAPI
+  # Ruby gem for the unofficial Jisho API.
+  class JishoAPI
+    attr_accessor :page, :query
+
+    def initialize(query: nil, page: 1, debug: false)
+      @query = query
+      @page = page
+      require 'httplog' if debug
+    end
+
+    # Query using the query and page set initially, but can be overridden by passing in args.
+    # @param query (string) Search the API for a given query.
+    # @param page (integer) Which page to fetch; defaults to 1
+    def search(query: nil, page: nil)
+      query ||= self.query
+      page ||= self.page
+
+      client.make_request(params: { keyword: query, page: page })
+    end
+
+    # Fetches the next page of results, reusing the same query. Increments the internal page counter as a side effect.
+    def next_page!
+      self.page += 1
+
+      client.make_request(params: { keyword: query, page: page })
+    end
+
+    # @param query (string) Search the API for a given query and fetches the first page of results;
+    def self.search(query)
+      new.search(query: query)
+    end
+
+    private
+
+    def client
+      @client ||= Client.new
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: jisho_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tomholford
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+description: 
+email:
+- tomholford@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO
+- bin/console
+- bin/setup
+- data/sample.json
+- jisho_api.gemspec
+- lib/jisho_api.rb
+- lib/jisho_api/client.rb
+- lib/jisho_api/version.rb
+homepage: https://github.com/tomholford/jisho-api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tomholford/jisho-api
+  source_code_uri: https://github.com/tomholford/jisho-api
+  changelog_uri: https://github.com/tomholford/twitter-labs-api/blob/master/CHANGELOG.md
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby client gem for the unofficial Jisho API.
+test_files: []