weeb 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9915938edda957206ae587f49a1dd536f113558ca866dffc10133dd2a4d2f43
-  data.tar.gz: 99cac3b5e83da4655a2539d115a1c5e921189e7d845c2f9c654dc5c78c4e2372
+  metadata.gz: 48e8ce683d4a3c5bd5cef4074be39d9e39c39a15e067271d5832cd2163d6d016
+  data.tar.gz: 7b297145af275b2670b67347662b4082122882e19d93aaa7cea930cbcbcb263f
 SHA512:
-  metadata.gz: 85d0d2efebbc6747a5e3f93c57e29411aa148e99385a50e82849f68d5dcafb93ae31abc6067f2b100b626710cfe323dccf7e0245dce36b2036b0f9556f91fde4
-  data.tar.gz: dfeb4ac2515f3c2803349e9afcb32a96ab43d3adbf0d74490645e6639599174543dae06c0e3cab68caede164a08241baf7e9c7608f5355184bf0219977cc11db
+  metadata.gz: 93c342bdbf155da57880b061eb7d8f349b44682f40b1df9b84ac2f9bc1f75b0d6be0348635321dccdc27aa194ccbf2a988ae27e9c69bef601093f9dab1d6f0a8
+  data.tar.gz: 4f0a455d913de4a60d86246b64307d49f900237f456ae81018425b48cb079f7c6ab3ba5d88393220a0952c5f0c772eeb15b5be1d225909524172c22499764af4

data/lib/weeb/api.rb

@@ -9,6 +9,7 @@ module WeebSh
   module API
     module_function
 
+    # Request an endpoint easily
     def request(type, *attributes)
       parse_json(RestClient.send(type, *attributes))
     rescue RestClient::RequestEntityTooLarge
@@ -39,12 +40,14 @@ module WeebSh
       raise e
     end
 
+    # @!visibility private
     def format_user_agent(user_agent)
       user_agent = "#{user_agent['botname']}/#{user_agent['version']}#{"/#{user_agent['env']}" if user_agent['env']}" if user_agent.is_a?(Hash)
       return nil unless user_agent.is_a?(String) && !user_agent.empty?
       user_agent
     end
 
+    # @!visibility private
     def parse_json(raw)
       JSON.parse(raw)
     rescue JSON::ParserError

data/lib/weeb/api/korra.rb

@@ -6,7 +6,74 @@ module WeebSh
     # API endpoints for Korra
     module Korra
       BASE = '/auto-image'.freeze
-      # module_function
+
+      module_function
+
+      def discord_status(interface, query)
+        WeebSh::API.request(
+          :get,
+          "#{interface.api_url}#{BASE}/discord-status?#{URI.encode_www_form(query)}",
+          {
+            Authorization: interface.auth,
+            'User-Agent': interface.user_agent
+          }
+        )
+      end
+
+      def simple(interface, query)
+        WeebSh::API.request(
+          :get,
+          "#{interface.api_url}#{BASE}/generate?#{URI.encode_www_form(query)}",
+          {
+            Authorization: interface.auth,
+            'User-Agent': interface.user_agent
+          }
+        )
+      end
+
+      def license(interface, title, avatar, badges, widgets)
+        WeebSh::API.request(
+          :post,
+          "#{interface.api_url}#{BASE}/license",
+          {
+            title: title,
+            avatar: avatar,
+            badges: badges,
+            widgets: widgets
+          }.to_json,
+          {
+            Authorization: interface.auth,
+            'User-Agent': interface.user_agent
+          }
+        )
+      end
+
+      def waifu_insult(interface, url)
+        WeebSh::API.request(
+          :post,
+          "#{interface.api_url}#{BASE}/waifu-insult",
+          { avatar: url }.to_json,
+          {
+            Authorization: interface.auth,
+            'User-Agent': interface.user_agent
+          }
+        )
+      end
+
+      def love_ship(interface, target1, target2)
+        WeebSh::API.request(
+          :post,
+          "#{interface.api_url}#{BASE}/love-ship",
+          {
+            targetOne: target1,
+            targetTwo: target2
+          }.to_json,
+          {
+            Authorization: interface.auth,
+            'User-Agent': interface.user_agent
+          }
+        )
+      end
     end
   end
 end

data/lib/weeb/api/shimakaze.rb

@@ -6,7 +6,98 @@ module WeebSh
     # API endpoints for Shimakaze
     module Shimakaze
       BASE = '/reputation'.freeze
-      # module_function
+
+      module_function
+
+      def get(interface, bot, user)
+        WeebSh::API.request(
+          :get,
+          "#{interface.api_url}#{BASE}/#{bot}/#{user}",
+          {
+            Authorization: interface.auth,
+            'User-Agent': interface.user_agent
+          }
+        )
+      end
+
+      def give(interface, bot, from, to)
+        WeebSh::API.request(
+          :post,
+          "#{interface.api_url}#{BASE}/#{bot}/#{to}",
+          {
+            source_user: from
+          }.to_json,
+          {
+            Authorization: interface.auth,
+            'User-Agent': interface.user_agent
+          }
+        )
+      end
+
+      def reset(interface, bot, user, reset_cooldown = true)
+        WeebSh::API.request(
+          :post,
+          "#{interface.api_url}#{BASE}/#{bot}/#{user}/reset",
+          {
+            cooldown: reset_cooldown
+          }.to_json,
+          {
+            Authorization: interface.auth,
+            'User-Agent': interface.user_agent
+          }
+        )
+      end
+
+      def increase(interface, bot, user, amount)
+        WeebSh::API.request(
+          :post,
+          "#{interface.api_url}#{BASE}/#{bot}/#{user}/increase",
+          {
+            increase: amount
+          }.to_json,
+          {
+            Authorization: interface.auth,
+            'User-Agent': interface.user_agent
+          }
+        )
+      end
+
+      def decrease(interface, bot, user, amount)
+        WeebSh::API.request(
+          :post,
+          "#{interface.api_url}#{BASE}/#{bot}/#{user}/decrease",
+          {
+            decrease: amount
+          }.to_json,
+          {
+            Authorization: interface.auth,
+            'User-Agent': interface.user_agent
+          }
+        )
+      end
+
+      def get_settings(interface)
+        WeebSh::API.request(
+          :get,
+          "#{interface.api_url}#{BASE}/settings",
+          {
+            Authorization: interface.auth,
+            'User-Agent': interface.user_agent
+          }
+        )
+      end
+
+      def set_settings(interface, settings)
+        WeebSh::API.request(
+          :post,
+          settings.to_json,
+          "#{interface.api_url}#{BASE}/settings",
+          {
+            Authorization: interface.auth,
+            'User-Agent': interface.user_agent
+          }
+        )
+      end
     end
   end
 end

data/lib/weeb/data.rb

@@ -1,4 +1,5 @@
 require 'weeb/api'
+require 'time'
 
 module WeebSh
   # Mixin for objects with IDs
@@ -25,9 +26,10 @@ module WeebSh
     # @return [String] the URL being used for weeb.sh.
     attr_reader :api_url
 
-    # @param token [String] the token required to use weeb.sh.
+    # @param auth [String] the authentication required to use weeb.sh.
     # @param user_agent [String, Hash] the user agent to use on endpoints.
     # @param api_url [String] the URL to use when using the weeb.sh API.
+    # @param client [Client] the client this is tied to.
     def initialize(auth, user_agent = nil, api_url: 'https://api.weeb.sh', client: nil)
       @user_agent = WeebSh::API.format_user_agent(user_agent)
       @auth = auth
@@ -40,6 +42,7 @@ module WeebSh
       puts "[#{self.class.name}] Your User Agent is not ideal. Please consider adding a user agent to help identify issues easier." if !user_agent.nil? && user_agent.split('/').count < 2
     end
 
+    # @!visibility private
     def inspect
       "#<#{self.class.name} @api_url=#{@api_url.inspect} @user_agent=#{@user_agent.inspect}>"
     end
@@ -67,6 +70,7 @@ module WeebSh
       @url = data['url']
     end
 
+    # @!visibility private
     def inspect
       "#<WeebSh::PreviewImage @url=#{@url.inspect} @type=#{@type.inspect}>"
     end
@@ -131,7 +135,7 @@ module WeebSh
     end
 
     # Remove a tag to the image
-    # @param tags [String, Tag] the affected tag
+    # @param tag [String, Tag] the affected tag
     def remove_tag(tag)
       @interface.remove_tags_to_image(self, [tag])
     end
@@ -142,6 +146,7 @@ module WeebSh
     end
     alias_method :remove, :delete
 
+    # @!visibility private
     def inspect
       "#<WeebSh::WeebImage @url=#{@url.inspect} @type=#{@type.inspect} @nsfw=#{@nsfw.inspect}>"
     end
@@ -169,8 +174,161 @@ module WeebSh
       @account = data['account']
     end
 
+    # @!visibility private
     def inspect
       "#<WeebSh::Tag @name=#{@name.inspect} @hidden=#{@hidden.inspect} @account=#{@account.inspect}>"
     end
   end
+
+  # Represents a user for shimakaze
+  class User
+    include IDObject
+
+    # @return [Integer] the reputation of the user
+    attr_reader :reputation
+    alias_method :rep, :reputation
+
+    # @return [String] the ID of the bot that issues reputation
+    attr_reader :bot_id
+
+    # @return [String] the ID of the account from the token
+    attr_reader :account
+
+    # @return [Array<Time>] the last time(s) this user has given reputation to another user
+    attr_reader :cooldown
+    alias_method :taken_reputation, :cooldown
+
+    # @return [Array<Time>] the last time(s) this user has received reputation from another user
+    attr_reader :given_reputation
+
+    # @return [Integer, nil] the amount to times the user may give reputation
+    attr_reader :available_reputation
+
+    # @return [Array<Time>, nil] the timestamps referring to the remaining cooldown time until the user can give out reputation from now
+    attr_reader :next_available_reputation
+
+    # @!visibility private
+    def initialize(data, interface)
+      @interface = interface
+      patch(data)
+      @available_reputation = data['availableReputation']
+      @next_available_reputation = data['nextAvailableReputation'] ? data['nextAvailableReputation'].map { |t| Time.parse(t) } : nil
+    end
+
+    # Increases the user's reputation
+    # @param amount [Integer] the amount of reputation that will increase
+    # @return [User] the class itself
+    def increase(amount)
+      response = WeebSh::API::Shimakaze.increase(@interface, @bot_id, @id, amount)
+      patch(response['user'])
+      self
+    end
+
+    # Decreases the user's reputation
+    # @param amount [Integer] the amount of reputation that will decrease
+    # @return [User] the class itself
+    def decrease(amount)
+      response = WeebSh::API::Shimakaze.decrease(@interface, @bot_id, @id, amount)
+      patch(response['user'])
+      self
+    end
+
+    # Resets the user
+    # @return [User] the class itself
+    def reset
+      response = WeebSh::API::Shimakaze.reset(@interface, @bot_id, @id)
+      patch(response['user'])
+      self
+    end
+
+    # Gives reputation to another user
+    # @Param user [User, String, #resolve_id] the user to give reputation to
+    # @return [User] the class itself
+    def give(user)
+      user_id = user.resolve_id if user.respond_to?(:resolve_id)
+      response = API::Shimakaze.give(@interface, @bot_id, @id, user_id || user)
+      patch(response['sourceUser'])
+      user.patch(response['targetUser']) if user.is_a?(User)
+      self
+    end
+
+    # Recieves reputation to another user
+    # @Param user [User, String, #resolve_id] the user to get reputation from
+    # @return [User] the class itself
+    def recieve(user)
+      user_id = user.resolve_id if user.respond_to?(:resolve_id)
+      response = API::Shimakaze.give(@interface, @bot_id, user_id || user, @id)
+      patch(response['targetUser'])
+      user.patch(response['sourceUser']) if user.is_a?(User)
+      self
+    end
+
+    # @!visibility private
+    def patch(data)
+      @reputation = data['reputation']
+      @id = data['userId']
+      @bot_id = data['botId']
+      @account = data['account']
+      @cooldown = data['cooldown'].map { |t| Time.parse(t) }
+      @given_reputation = data['givenReputation'].map { |t| Time.parse(t) }
+      @available_reputation = data['availableReputation'] if data['availableReputation'].nil?
+      @next_available_reputation = data['nextAvailableReputation'].map { |t| Time.parse(t) } if data['nextAvailableReputation'].nil?
+    end
+
+    # @!visibility private
+    def inspect
+      "#<WeebSh::User @reputation=#{@reputation.inspect} @id=#{@id.inspect} @bot_id=#{@bot_id.inspect}>"
+    end
+  end
+
+  # Represents a reputation settings object for shimakaze
+  class ReputationSettings
+    include IDObject
+
+    # @return [Integer] the number of reputations a user may give out per cooldown
+    attr_accessor :reputation_per_day
+    alias_method :rep_per_day, :reputation_per_day
+
+    # @return [Integer] the maximum reputation a user may receive
+    attr_accessor :max_reputation
+    alias_method :max_rep, :max_reputation
+
+    # @return [Integer] the maximum reputation a user may receive per day
+    attr_accessor :max_reputation_per_day
+    alias_method :max_rep_per_day, :max_reputation_per_day
+
+    # @return [Integer] the cooldown per reputation, this is set to time in seconds
+    attr_accessor :reputation_cooldown
+    alias_method :rep_cooldown, :reputation_cooldown
+
+    # @return [String, nil] the ID of the account from the token
+    attr_accessor :account
+
+    # @!visibility private
+    def initialize(data, interface)
+      @interface = interface
+      @reputation_per_day = data['reputationPerDay']
+      @max_reputation = data['maximumReputation']
+      @max_reputation_per_day = data['maximumReputationReceivedDay']
+      @reputation_cooldown = data['reputationCooldown']
+      @account = data['account']
+    end
+
+    # Save the settings on this object
+    # @return [ReputationSettings] the class itself
+    def save
+      WeebSh::API::Shimakaze.set_settings(@interface, {
+        reputationPerDay: @reputation_per_day,
+        maximumReputation: @max_reputation,
+        maximumReputationReceivedDay: @max_reputation_per_day,
+        reputationCooldown: @reputation_cooldown
+      })
+      self
+    end
+
+    # @!visibility private
+    def inspect
+      "#<WeebSh::ReputationSettings @reputation_per_day=#{@reputation_per_day.inspect} @max_reputation=#{@max_reputation.inspect} @max_reputation_per_day=#{@max_reputation_per_day.inspect} @reputation_cooldown=#{@reputation_cooldown.inspect}>"
+    end
+  end
 end

data/lib/weeb/err.rb

@@ -3,6 +3,7 @@ module WeebSh
   module Err
     # Raised when a token is invalid or incorrect.
     class BadAuth < RuntimeError
+      # The default message for the error
       def message
         'Token invalid'
       end
@@ -10,6 +11,7 @@ module WeebSh
 
     # Raised when too many files were uploaded.
     class MissingScope < RuntimeError
+      # The default message for the error
       def message
         'Too many files requested!'
       end
@@ -17,6 +19,7 @@ module WeebSh
 
     # Raised when a server error occurs
     class ServerFail < RuntimeError
+      # The default message for the error
       def message
         'Server tried to do a thing and borked!'
       end
@@ -24,6 +27,7 @@ module WeebSh
 
     # Raised when requested file(s) have too much bytes.
     class TooLarge < RuntimeError
+      # The default message for the error
       def message
         'File(s) are too large!'
       end
@@ -31,6 +35,7 @@ module WeebSh
 
     # Raised when an invalid mime type was given.
     class InvalidMIME < RuntimeError
+      # The default message for the error
       def message
         'You gave an unsupported MIME type!'
       end
@@ -38,6 +43,7 @@ module WeebSh
 
     # Raised when trying to add an existing tag to an image
     class TagExists < RuntimeError
+      # The default message for the error
       def message
         'Tags existed already or had no content!'
       end
@@ -45,6 +51,7 @@ module WeebSh
 
     # Raised when trying to interact with a non-existant image
     class InvalidImage < RuntimeError
+      # The default message for the error
       def message
         'Non-existant image!'
       end
@@ -52,6 +59,7 @@ module WeebSh
 
     # Raised when loading a file recieves an error
     class FileError < RuntimeError
+      # The default message for the error
       def message
         'Unknown'
       end

data/lib/weeb/interfaces/client.rb

@@ -35,8 +35,9 @@ module WeebSh
     alias_method :settings, :tama
 
     # Groups all interfaces into one.
-    # @param token [String] the token required to use weeb.sh.
+    # @param auth [String] the authentication required to use weeb.sh.
     # @param user_agent [String, Hash] the user agent to use with requests.
+    # @param api_url [String] the URL to use when using the weeb.sh API.
     def initialize(auth, user_agent = nil, api_url: 'https://api.weeb.sh')
       @user_agent = WeebSh::API.format_user_agent(user_agent)
       @auth = auth

data/lib/weeb/interfaces/shimakaze.rb

@@ -4,5 +4,46 @@ require 'weeb/data'
 module WeebSh
   # Reputation API
   class Shimakaze < Interface
+    # Makes a class with your bot ID to do requests easier
+    # @param bot [String] the ID of the bot
+    # @return [ShimakazeBot] the bot class
+    def bot(bot)
+      ShimakazeBot.new(bot, self)
+    end
+
+    # Get's a user
+    # @param bot [String] the ID of the bot
+    # @Param user [User, String, #resolve_id] the user to get
+    # @return [User] the user requested
+    def get(bot, user)
+      user_id = user.resolve_id if user.respond_to?(:resolve_id)
+      response = API::Shimakaze.get(self, bot, user_id || user)
+      user.patch(response['user']) if user.is_a?(User)
+      new User(response['user'], self)
+    end
+
+    # Gets the currentyly used settings
+    # @return [ReputationSettings] the user requested
+    def settings
+      new ReputationSettings(response['settings'], self)
+    end
+  end
+
+  # Bot class for shimakaze
+  class ShimakazeBot
+    include IDObject
+
+    # @!visibility private
+    def initialize(id, interface)
+      @interface = interface
+      @id = id
+    end
+
+    # Get's a user
+    # @Param user [User, String, #resolve_id] the user to get
+    # @return [User] the user requested
+    def get(user)
+      @interface.get(@id, user)
+    end
   end
 end

data/lib/weeb/interfaces/toph.rb

@@ -99,7 +99,7 @@ module WeebSh
     # @param tags [Array<String, Tag>] the affected tags
     # @return [WeebImage] Returns the image with the given ID.
     def add_tags_to_image(image, tags)
-      image = image.resolve_id if id.respond_to?(:resolve_id)
+      image = image.resolve_id if image.respond_to?(:resolve_id)
       tags = tags.map { |t| t.name if t.is_a(Tag) }
       WeebImage.new(API::Toph.add_tags_to_image(self, image, tags), self)
     end
@@ -109,7 +109,7 @@ module WeebSh
     # @param tags [Array<String, Tag>] the affected tags
     # @return [WeebImage] Returns the image with the given ID.
     def remove_tags_to_image(image, tags)
-      image = image.resolve_id if id.respond_to?(:resolve_id)
+      image = image.resolve_id if image.respond_to?(:resolve_id)
       tags = tags.map { |t| t.name if t.is_a(Tag) }
       WeebImage.new(API::Toph.remove_tags_to_image(self, image, tags), self)
     end
@@ -120,7 +120,7 @@ module WeebSh
     # @param hidden [true, false] if true, you can only get back hidden tags you added
     # @param nsfw [true, false, String] whether or not preview images could be NSFW. Setting this to "only" restricts it to NSFW images.
     # @param file_type [String] the file type an image is required to be for selection
-    # @param page [Number] the page number of images to use
+    # @param page [Integer] the page number of images to use
     # @param account [String] the account ID to get images from
     # @return [WeebImage] Returns image that was randomly selected.
     def list(type: nil, tags: [], hidden: false, nsfw: false, file_type: nil, page: 0, account: nil)
@@ -139,5 +139,5 @@ module WeebSh
   end
 
   # Alias for the class {Toph}
-  Image = Toph
+  Images = Toph
 end

data/lib/weeb/ver.rb

@@ -1,3 +1,3 @@
 module WeebSh
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.1.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: weeb
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Snazzah
@@ -38,6 +38,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement