acnh_informations 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1376f9d5370f4e616af22ece0333821840a47c36b4d0af66c91583a640b90d4f
+  data.tar.gz: cb84e7af63bbbe7365c90cf87ab013f936c4300c121e56ab474c1c1a6abc2434
+SHA512:
+  metadata.gz: e173270f17792509d0f426b44e3807067563c53c191f79f9f470ff260d51c84f82f388a97c80cd365328c3bf567b3b88ccf4d645870fe149f808799d7969ddb3
+  data.tar.gz: a39c65112399fbea6c2acea525a007875efa1aed040de713f55ddf9088481eddeed4cb8a1a0d38002e448b91da75c5ffe432c35dfb0656c7fa818ac0f94bac3f

data/lib/acnh_informations/api.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "rest-client"
+require "json"
+
+module AcnhInformations
+  # Scrape informations from 'acnhapi' api
+  class Api
+    # The base URL to scrape
+    BASE_URL = "https://acnhapi.com"
+    # All available categories
+    CATEGORIES = %w[fish sea bugs fossils villagers icons images songs music art houseware].freeze
+
+    ##
+    # Verify if the object exists
+    #
+    # @param [Symbol, StringIO] category The category to find the object
+    # @param id [Symbol, StringIO, NilClass] The id to get
+    # @return [Boolean] True or False, if the wanted research exists
+    def self.valid?(category, id = nil)
+      RestClient.get("#{BASE_URL}/v1/#{category.to_s}/#{id ? id.to_s.ascii_only? ? id.to_s : "" : ""}")
+      true
+    rescue RestClient::NotFound
+      false
+    end
+
+    ##
+    # Scrape informations from API
+    #
+    # @param [Symbol, StringIO] category The category to find the object
+    # @param id [Symbol, StringIO, NilClass] The id to get
+    # @return [Object] The result as a Hash
+    # @see Api#valid?
+    def self.scrape(category, id = nil)
+      return false unless valid?(category, id)
+
+      JSON.parse(RestClient.get("#{BASE_URL}/v1/#{category.to_s}/#{id ? id.to_s : ""}"), :symbolize_names => true)
+    end
+  end
+end

data/lib/acnh_informations/tools.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "api" unless defined?(AcnhInformations::API)
+
+module AcnhInformations
+  # Some tools for the project
+  class Api
+    ##
+    # Get a thing by an approximative name
+    # @param [String] category The category to get the object
+    # @param [String] name the approximative name
+    # @return [Hash, Boolean] False if the program didn't find anything, or the thing hash
+    def self.get_by_name(category, name)
+      result = false
+      return false unless valid?(category.to_s)
+
+      scrape(category.to_s).each do |element|
+        element[1][:name].each_value do |language_name|
+          result = element[1] if language_name.match(/#{name.to_s}/)
+          break if result
+        end
+      end
+      result
+    end
+  end
+end

data/lib/acnh_informations/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module AcnhInformations
+  # The current version of the gem
+  VERSION = "0.1.2"
+end

data/lib/acnh_informations.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require_relative "acnh_informations/version"
+require_relative "acnh_informations/api"
+require_relative "acnh_informations/tools"
+
+# The main module
+module AcnhInformations
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: acnh_informations
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- senchuu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-06-15 00:00:00.000000000 Z
+dependencies: []
+description: 'Get things informations from Animal Crossing New Horizons using https://acnhapi.com/.
+  Warning: That doesn''t get informations from players. Only included things.'
+email:
+- senchuuuu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/acnh_informations.rb
+- lib/acnh_informations/api.rb
+- lib/acnh_informations/tools.rb
+- lib/acnh_informations/version.rb
+homepage: https://github.com/Senchuu/AcnhInformations
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/Senchuu/AcnhInformations
+  source_code_uri: https://github.com/Senchuu/AcnhInformations
+  changelog_uri: https://github.com/Senchuu/AcnhInformations
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.20
+signing_key: 
+specification_version: 4
+summary: Get fish, fossiles, villagers [...] informations from Animal Crossing New
+  Horizons
+test_files: []