memerator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 89269102e6a4f1a26aacfdd71394cc549844e20c
+  data.tar.gz: c9bc3131f6b1f93d970dbfb69b73e8a4a3c8089b
+SHA512:
+  metadata.gz: dc3a0b7e6457dff88296d417106d92cc203b7d7295ecd78bc0735f31ca884ef455dc7591e1aeb5fea6a80c61c396299e1c5ea81f7dc5a52a326b437667aa96e7
+  data.tar.gz: 0b078cf671b0474045b1e513e144cd9502c036a0449d198218406cf17ce0c18c5e39c339774af1da581eb1dd721007220778a3c0ddeeb47d0589dc840b8ad3d4

data/README.md

@@ -0,0 +1,54 @@
+# Memerator API for Ruby
+
+A ruby library for Memerator.
+
+## What is this for?
+
+I mean, why not.
+
+## Disclaimer
+
+The gem is currently in Beta! Until you see that nice 1.0.0, expect bugs!
+
+What the API has that this gem can't do yet:
+
+* Set your username
+* Get recent memes
+* Get top memes
+* Get top memers
+* Submit a meme
+
+## Usage
+
+Put this near the top of your ruby whatever:
+
+```ruby
+require 'memerator'
+
+Meme = Memerator.new(token: api_token)
+```
+
+Now, when you need to run a method, run Meme.method.
+
+Example for getting profile.
+
+```ruby
+"My username is #{Meme.profile.username}!"
+# => "My username is Chew!"
+```
+
+## Lost? allowsMultipleStreams?
+
+We have a nice helpful support channel on our official Discord Server! Join with [this link](https://discord.gg/FxjjnSF). IRC lover? Join #memerator on irc.chew.pro or irc.freenode.net
+
+## Documentation
+
+Stuck? Know Ruby? Check out the [documentation](https://rubydocs.chew.pro/docs/memerator).
+
+## Contributing
+
+We love contributors! Feel free to open a PR and we will review it.
+
+## But ruby sucks
+
+no it's great

data/lib/memerator.rb

@@ -0,0 +1,80 @@
+# Require external gems
+require 'json'
+require 'rest-client'
+
+# All Memerator functionality, whether extended or just here.
+class Memerator
+  # Initialize a new Memerator object, via a token.
+  # @param token [String] API token, taken from the Memerator Website.
+  def initialize(token: nil)
+    @token = token
+  end
+
+  # @param perso [String, Integer] the ID of the user, or their username
+  # @raise [Memerator::Errors::InvalidUser] if the user does not exist
+  # @return [User] the user's profile
+  def user(perso)
+    return profile if perso.downcase == 'me'
+
+    data = JSON.parse(RestClient.get("https://memerator.me/api/v1/profile/#{perso}", Authorization: @token))
+
+    User.new(data)
+  rescue RestClient::NotFound
+    raise Memerator::Errors::InvalidUser, "This user doesn't exist!"
+  end
+
+  # @return [Profile] your profile
+  def profile
+    data = JSON.parse(RestClient.get('https://memerator.me/api/v1/profile/me', Authorization: @token))
+    Profile.new(data, token: @token)
+  end
+
+  # Get a meme by its id
+  # @param id [String] the Meme ID
+  # @raise [Memerator::Errors::InvalidMeme] if the meme does not exist.
+  # @return [Meme] the meme
+  def meme(id)
+    data = JSON.parse(RestClient.get("https://memerator.me/api/v1/meme/#{id}", Authorization: @token))
+
+    Meme.new(data, token: @token)
+  rescue RestClient::NotFound
+    raise Memerator::Errors::InvalidMeme, "This meme doesn't exist!"
+  end
+
+  # Get a random meme
+  # @return [Meme] the meme
+  def randommeme
+    data = JSON.parse(RestClient.get("https://memerator.me/api/v1/meme/random", Authorization: @token))
+    Meme.new(data, token: @token)
+  end
+
+  # @return [Stats] the site's stats
+  def stats
+    data = JSON.parse(RestClient.get('https://memerator.me/api/v1/stats', Authorization: @token))
+    Stats.new(data)
+  end
+
+  # @return [Array<Notification>] your notifications
+  def notifications
+    notifications = JSON.parse(RestClient.get('https://memerator.me/api/v1/notifications', Authorization: @token))
+    notifications.map { |notification_data| Notification.new(notification_data) }
+  end
+
+  # @return [Array<Report>] your reports
+  def reports
+    reports = JSON.parse(RestClient.get('https://memerator.me/api/v1/reports', Authorization: @token))
+    reports.map { |report_data| Report.new(report_data) }
+  end
+
+  # Get the token from instantiation
+  attr_reader :token
+end
+
+# Require files.
+require_relative 'memerator/meme'
+require_relative 'memerator/errors'
+require_relative 'memerator/stats'
+require_relative 'memerator/report'
+require_relative 'memerator/notification'
+require_relative 'memerator/user'
+require_relative 'memerator/profile'

data/lib/memerator/errors.rb

@@ -0,0 +1,22 @@
+# Errors are the death of us all. If you get an error, delete your account.
+module Memerator::Errors
+  # Raised if a selected meme is Invalid.
+  # Probably means it doesn't exist.
+  class InvalidMeme < ArgumentError; end
+
+  # Raised if a selected user is invalid.
+  # Probably means they doesn't exist.
+  class InvalidUser < ArgumentError; end
+
+  # Raised if your token sucks
+  class InvalidToken < ArgumentError; end
+
+  # Raised if the meme status didn't really change
+  class NoChange < StandardError; end
+
+  # Raised if you don't have access to the requested resource
+  class NoPermission < StandardError; end
+
+  # Raised if you try to modify a disabled meme.
+  class DisabledMeme < StandardError; end
+end

data/lib/memerator/meme.rb

@@ -0,0 +1,140 @@
+# A meme on memerator
+class Memerator::Meme
+  # @!visibility private
+  def initialize(data, token: nil)
+    @data = data
+    @token = token
+  end
+
+  # @group Meme Information Methods
+
+  # @return [String] the meme's ID.
+  def memeid
+    @data['memeid']
+  end
+
+  # @return [String, nil] the caption, if there is one.
+  def caption
+    @data['caption']
+  end
+
+  # @return [String] the URL of the image.
+  def image_url
+    @data['url']
+  end
+
+  # @return [Float] the average rating.
+  def average_rating
+    @data['rating']['average']
+  end
+
+  # @return [Time] the time this meme was submitted.
+  def timestamp
+    Time.parse(@data['timestamp'])
+  end
+
+  # @return [User] the author of this meme.
+  def author
+    Memerator::User.new(@data['author'])
+  end
+
+  # @return [String] the URL to the meme
+  def meme_url
+    @data['permalink']
+  end
+
+  # Usually, the only people who can see disabled memes are Staff and the owners of the meme.
+  # This will most likely always be false.
+  # @return [true, false] the meme disabled status.
+  def disabled?
+    @data['disabled']
+  end
+
+  # @endgroup
+
+  # @group Meme Modification Methods
+
+  # Disables the meme, only works if you own the meme!
+  # @raise [Memerator::Errors::NoPermission] if you don't have access to disable the meme
+  # @raise [Memerator::Errors::NoChange] if the meme is already disabled
+  # @raise [Memerator::Errors::InvalidToken] if your token is bad.
+  # @return [true] when successful
+  def disable!
+    response = JSON.parse(RestClient.put("https://memerator.me/api/v1/meme/#{memeid}/disable", {}, Authorization: @token))
+    @data['disabled'] = true
+    response['success']
+  rescue RestClient::NotFound
+    raise Memerator::Errors::NoPermission, "your token doesn't grant you access to this meme"
+  rescue RestClient::BadRequest
+    raise Memerator::Errors::NoChange, "This Meme is already disabled!"
+  rescue RestClient::Unauthorized
+    raise Memerator::Errors::InvalidToken, "Your token expired!"
+  end
+
+  # Enable the meme, only works if you own the meme!
+  # @raise [Memerator::Errors::NoPermission] if you don't have access to enable the meme
+  # @raise [Memerator::Errors::NoChange] if the meme is already enabled
+  # @raise [Memerator::Errors::InvalidToken] if your token is bad.
+  # @return [true] when successful
+  def enable!
+    response = JSON.parse(RestClient.put("https://memerator.me/api/v1/meme/#{memeid}/enable", {}, Authorization: @token))
+    @data['disabled'] = false
+    response['success']
+  rescue RestClient::NotFound
+    raise Memerator::Errors::NoPermission, "your token doesn't grant you access to this meme"
+  rescue RestClient::BadRequest
+    raise Memerator::Errors::NoChange, "This Meme is already disabled!"
+  rescue RestClient::Unauthorized
+    raise Memerator::Errors::InvalidToken, "Your token expired!"
+  end
+
+  # Set the meme caption, only works if you own the meme!
+  # @raise [Memerator::Errors::NoPermission] if you don't have access to modify the meme
+  # @raise [Memerator::Errors::DisabledMeme] if the meme is disabled
+  # @raise [Memerator::Errors::InvalidToken] if your token is bad.
+  # @return [true] when successful
+  def caption=(newcap)
+    raise Memerator::Errors::DisabledMeme, "This meme is disabled and can't be interacted with" if disabled?
+
+    response = JSON.parse(RestClient.put("https://memerator.me/api/v1/meme/#{memeid}/caption", {"caption" => newcap}.to_json, Authorization: @token, 'Content-Type': :json))
+    @data['caption'] = newcap
+    response['success']
+  rescue RestClient::NotFound
+    raise Memerator::Errors::NoPermission, "your token doesn't grant you access to this meme"
+  rescue RestClient::Unauthorized
+    raise Memerator::Errors::InvalidToken, "Your token expired!"
+  end
+
+  # Shorthand for #disable! and #enable!
+  # @see #disable!
+  # @see #enable!
+  # @param dis [true, false] should we disable or enable
+  # @raise [ArgumentError] if you didn't provide true or false
+  # @return [true] if the meme was disabled
+  # @return [false] if the meme was enabled
+  def disabled=(dis)
+    case dis
+    when true
+      disable!
+    when false
+      enable!
+    else
+      raise ArgumentError, "please provide true or false"
+    end
+  end
+
+  # Rate a meme
+  # This was a long running joke, in fact, until recently, you couldn't even rate a meme from the API! You're welcome.
+  # @param rating [Integer] the rating to give this meme
+  def rate(rating)
+    raise Memerator::Errors::DisabledMeme, "This meme is disabled and can't be interacted with" if disabled?
+    raise ArgumentError, "Your rating is bad mate!" if rating > 5 || rating < 1 || rating.to_i != rating
+
+    response = JSON.parse(RestClient.post("https://memerator.me/api/v1/meme/#{memeid}/rate", {"rating" => rating}.to_json, Authorization: @token, 'Content-Type': :json))
+    response['success']
+  rescue RestClient::NotFound
+    raise Memerator::Errors::NoPermission, "your token doesn't grant you access to this meme"
+  rescue RestClient::Unauthorized
+    raise Memerator::Errors::InvalidToken, "Your token expired!"
+  end
+end

data/lib/memerator/notification.rb

@@ -0,0 +1,58 @@
+# A notification
+class Memerator::Notification
+  # @!visibility private
+  def initialize(data)
+    @data = data
+  end
+
+  # @return [Integer] the ID of this notification
+  def id
+    @data['id']
+  end
+
+  # @return [User] the sender of this notification.
+  def sender
+    Memerator::User.new(@data['sender'])
+  end
+
+  # @return [Time] the time this was sent
+  def timestamp
+    Time.parse(@data['timestamp'])
+  end
+
+  # @return [String] the notification, formatted.
+  def message
+    @data['message']
+  end
+
+  # @return [String] the raw message as it appears on Memerator.me
+  def raw
+    @data['raw']
+  end
+
+  # The type is mostly used internally but is useful for cliens implementing notification sorting.
+  # Type 0 is a meme rating notification
+  # Type 1 is a follow notification
+  # Type 2 is a notice.
+  # Type 3 is a report status update
+  # @return [Integer] the type of this message
+  def type
+    @data['type']
+  end
+
+  # For meme ratings, the meme ID is returned, if you need it!
+  # @return [String, nil] the meme ID, if type == 0
+  def memeid
+    return nil if @data['meme'].nil?
+
+    @data['meme']['memeid']
+  end
+
+  # For meme ratings, the meme rating is returned, if you need it!
+  # @return [Integer, nil] the meme rating, if type == 0
+  def memeid
+    return nil if @data['meme'].nil?
+
+    @data['meme']['rating']
+  end
+end

data/lib/memerator/profile.rb

@@ -0,0 +1,27 @@
+# A profile is a user, but has more details.
+# Usually, only the authenticated user can see these.
+class Memerator::Profile < Memerator::User
+  # @!visibility private
+  def initialize(data, token: nil)
+    @data = data
+    @token = token
+  end
+
+  # @return [Time, nil] the time when your Pro subscription expires, if you have one
+  def pro_expires
+    Time.parse(@data['pro']['expires'])
+  end
+
+  # @return [Time, nil] the time when your Pro subscription started, if you have one
+  def pro_since
+    Time.parse(@data['pro']['since'])
+  end
+
+  # Update your Bio!
+  # @return [true] the success
+  def bio=(new_bio)
+    response = JSON.parse(RestClient.post("https://memerator.me/api/v1/profile/me", { "bio" => new_bio }.to_json, Authorization: @token, 'Content-Type': :json))
+    @data['bio'] = new_bio
+    response['success']
+  end
+end

data/lib/memerator/report.rb

@@ -0,0 +1,63 @@
+# A report!
+class Memerator::Report
+  # @!visibility private
+  def initialize(data)
+    @data = data
+  end
+
+  # @return [Integer] the report ID.
+  def id
+    @data['id']
+  end
+
+  # The status of the meme. Used to see where the report is.
+  # Status 0 means it's open and unclaimed
+  # Status 1 means it's claimed, but not settled.
+  # Status 2 means it's resolved.
+  def status
+    @data['status']
+  end
+
+  # @return [String] the ID of the meme being reported.
+  def memeid
+    @data['memeid']
+  end
+
+  # @return [String] the reason for the report.
+  def reason
+    @data['message']['reason']
+  end
+
+  # @return [String] more detailed explanation
+  def description
+    @data['message']['description']
+  end
+
+  # @return [User] the staff member assigned to this report
+  # @return [nil] if no one is assigned.
+  def assignee
+    return nil if @data['assignee'].nil?
+
+    Memerator::User.new(@data['assignee'])
+  end
+
+  # @return [String, nil] the staff member's comment, if they responded.
+  def comment
+    @data['comment']
+  end
+
+  # @return [true, false] if the report is open
+  def open?
+    status == 0
+  end
+
+  # @return [true, false] if the report is assigned to someone
+  def assigned?
+    status == 1
+  end
+
+  # @return [true, false] if the report is closed
+  def closed?
+    status == 2
+  end
+end

data/lib/memerator/stats.rb

@@ -0,0 +1,27 @@
+# The Memerator Stats
+class Memerator::Stats
+  # @!visibility private
+  def initialize(data)
+    @data = data
+  end
+
+  # @return [Integer] the total number of Memerator memes
+  def memes
+    @data['memes']
+  end
+
+  # @return [Integer] the total number of ratings
+  def ratings
+    @data['ratings']
+  end
+
+  # @return [Integer] the number of registered website users
+  def users
+    @data['website_users']
+  end
+
+  # @return [Integer] the total number of people who have submitted a meme
+  def memers
+    @data['unique_memers']
+  end
+end

data/lib/memerator/user.rb

@@ -0,0 +1,67 @@
+# A user is a Memerator User. Data everyone (with a token) can access
+class Memerator::User
+  # @!visibility private
+  def initialize(data)
+    @data = data
+  end
+
+  # @return [String] the user's username
+  def username
+    @data['username']
+  end
+
+  # @return [Integer] the user's ID
+  def id
+    @data['id']
+  end
+
+  # @return [String] the user's bio
+  def bio
+    @data['bio']
+  end
+
+  # @return [Integer] the amount of followers this user has
+  def followers
+    @data['stats']['followers']
+  end
+
+  # @return [Integer] the amount of users this user is following
+  def following
+    @data['stats']['following']
+  end
+
+  # @return [Integer] the amount of memes this user has
+  def memes
+    @data['stats']['memes']
+  end
+
+  # @return [true, false] the user's verification status
+  def verified?
+    @data['perks']['verified']
+  end
+
+  # @return [true, false] the user's staff member status
+  def staff?
+    @data['perks']['staff']
+  end
+
+  # @return [true, false] the user's translator status
+  def translator?
+    @data['perks']['translator']
+  end
+
+  # @return [true, false] the user's pro status
+  def pro?
+    @data['perks']['pro']
+  end
+
+  # @return [String] the user's profile link
+  def link
+    @data['permalink']
+  end
+
+  # @return [Time] the user's join time
+  def joined
+    Time.parse(@data['joined'])
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: memerator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chew
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0.rc1
+description: The Memerator.me API Libary wrapper in Ruby.
+email: chew@memerator.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/memerator.rb
+- lib/memerator/errors.rb
+- lib/memerator/meme.rb
+- lib/memerator/notification.rb
+- lib/memerator/profile.rb
+- lib/memerator/report.rb
+- lib/memerator/stats.rb
+- lib/memerator/user.rb
+homepage: https://github.com/Memerator/memerator-sdk-ruby
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/Memerator/memerator-sdk-ruby/issues
+  changelog_uri: https://github.com/Memerator/memerator-sdk-ruby/releases
+  documentation_uri: https://rubydocs.chew.pro/docs/memerator
+  homepage_uri: https://github.com/Memerator/memerator-sdk-ruby
+  source_code_uri: https://github.com/Memerator/memerator-sdk-ruby
+  wiki_uri: https://github.com/Memerator/memerator-sdk-ruby/wiki
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.4
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: The Memerator.me API Libary wrapper in Ruby
+test_files: []