redd 0.8.0.pre.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69d6cf992f71356b1db86a000bdc3be4508e351c
-  data.tar.gz: 01d0b098fb7c26a91e34ff001310417c93e3bd74
+  metadata.gz: ca106c8ea55f1c1278f643802a357163ebca48cc
+  data.tar.gz: 38302c79dbc6c94813c182b5b0ec2b0cae02c124
 SHA512:
-  metadata.gz: 4019ce12ee1cfac8927642bfdd327e4221835842a230ad73bce35b0ce3e1f0445523bf5a796aeca182b63c7061861ba1a28a587fe8814594d6d89531ece2c3a6
-  data.tar.gz: 292775ce9121b4de029ee49e451417508b64524940043569ebe53b807387fac0b1539a7cf5e37a13d494c83267421a1789a75e00ec96cadbaa2cf01128c0f9b7
+  metadata.gz: c379f17013fbd83957752e7e745b8f55bc37b96f7cb96ad4d08252f1857b57258cf2fe5fcb8a711f65217908ad703b2e4a506720833226fcc89d36fefe2e9f62
+  data.tar.gz: a95cee5b5b15124d6867f1a998c9abb21b7aace479d23ff32e85e86b06c6dac129ffa9dedfc169ce6612a1bfe07614b5a79d8b4d1e5fd506b938bc0bd8b4cdfb

data/README.md

@@ -40,6 +40,10 @@ end
 **Yes**, that's all there is to it! You don't need to handle rate-limiting, refresh access tokens
 or protect against issues on reddit's end (like 5xx errors).
 
+#### Where can I find the documentation?
+
+[**Latest**](www.rubydoc.info/gems/redd) / [**GitHub**](http://www.rubydoc.info/github/avinashbot/redd/master/Redd/Models/Session)
+
 #### How can I contact you?
 [Reddit](https://www.reddit.com/message/compose/?to=Mustermind) /
 [GitHub](https://github.com/avinashbot/redd/issues/new) /

data/bin/console

@@ -37,7 +37,7 @@ server.mount_proc '/authenticate' do |_, res|
       state: '0',
       redirect_uri: 'http://localhost:8000/redirect',
       'scope': %w(identity read subscribe privatemessages wikiread submit vote edit modposts history
-                  modflair modconfig)
+                  modflair modconfig modmail livemanage)
     )
   )
 end

data/lib/redd/api_client.rb

@@ -66,7 +66,7 @@ module Redd
 
     def model(verb, path, options = {})
       # XXX: make unmarshal explicit in methods?
-      unmarshal(request(verb, path, options).body)
+      unmarshal(send(verb, path, options).body)
     end
 
     # Makes a request, ensuring not to break the rate limit by sleeping.

data/lib/redd/models/basic_model.rb

@@ -56,6 +56,11 @@ module Redd
         @attributes
       end
 
+      # @return [Array<self>] an array representation of self
+      def to_ary
+        [self]
+      end
+
       # Checks whether an attribute is supported by method_missing.
       # @param method_name [Symbol] the method name or attribute to check
       # @param include_private [Boolean] whether to also include private methods

data/lib/redd/models/conversation.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative 'lazy_model'
+
+module Redd
+  module Models
+    # Represents a conversation in the new modmail.
+    # TODO: add message and modmail-specific user type
+    class Conversation < LazyModel
+      # Get a Conversation from its id.
+      # @option hash [String] :id the base36 id (e.g. abc123)
+      # @return [Conversation]
+      def self.from_response(client, hash)
+        id = hash.fetch(:id)
+        new(client) do |c|
+          response = c.get("/api/mod/conversations/#{id}").body
+          response[:conversation].merge(
+            messages: response[:messages],
+            user: response[:user],
+            mod_actions: response[:modActions]
+          )
+        end
+      end
+
+      # Get a Conversation from its id.
+      # @param id [String] the base36 id (e.g. abc123)
+      # @return [Conversation]
+      def self.from_id(client, id)
+        from_response(client, id: id)
+      end
+
+      # Mark this conversation as read.
+      def mark_as_read
+        @client.post('/api/mod/conversations/read', conversationIds: [get_attribute(:id)])
+      end
+
+      # Mark this conversation as unread.
+      def mark_as_unread
+        @client.post('/api/mod/conversations/unread', conversationIds: [get_attribute(:id)])
+      end
+
+      # Mark this conversation as archived.
+      def archive
+        perform_action(:post, 'archive')
+      end
+
+      # Removed this conversation from archived.
+      def unarchive
+        perform_action(:post, 'unarchive')
+      end
+
+      # Highlight this conversation.
+      def highlight
+        perform_action(:post, 'highlight')
+      end
+
+      # Remove the highlight on this conversation.
+      def unhighlight
+        perform_action(:delete, 'highlight')
+      end
+
+      # Mute this conversation.
+      def mute
+        perform_action(:post, 'mute')
+      end
+
+      # Unmute this conversation.
+      def unmute
+        perform_action(:post, 'unmute')
+      end
+
+      private
+
+      # Perform an action on a conversation.
+      # @param method [:post, :delete] the method to use
+      # @param action [String] the name of the action
+      def perform_action(method, action)
+        @client.send(method, "/api/mod/conversations/#{id}/#{action}")
+      end
+    end
+  end
+end

data/lib/redd/models/listing.rb

@@ -16,6 +16,11 @@ module Redd
         new(client, hash)
       end
 
+      # @return [Array<Comment, Submission, PrivateMessage>] an array representation of self
+      def to_ary
+        get_attribute(:children)
+      end
+
       %i([] each empty? first last).each do |method_name|
         define_method(method_name) do |*args, &block|
           get_attribute(:children).public_send(method_name, *args, &block)

data/lib/redd/models/live_thread.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative 'lazy_model'
+
+module Redd
+  module Models
+    # Represents a live thread.
+    class LiveThread < LazyModel
+      # Get a Conversation from its id.
+      # @option hash [String] :id the base36 id (e.g. abc123)
+      # @return [Conversation]
+      def self.from_response(client, hash)
+        id = hash.fetch(:id)
+        new(client, hash) { |c| c.get("/live/#{id}/about").body[:data] }
+      end
+
+      # Get a LiveThread from its id.
+      # @param id [String] the id
+      # @return [LiveThread]
+      def self.from_id(client, id)
+        from_response(client, id: id)
+      end
+
+      # Configure the settings of this live thread
+      # @param params [Hash] a list of params to send with the request
+      # @option params [String] :description the new description
+      # @option params [Boolean] :nsfw whether the thread is for users 18 and above
+      # @option params [String] :resources the new resources
+      # @option params [String] :title the thread title
+      def configure(**params)
+        @client.post("/api/live/#{get_attribute(:id)}/edit", params)
+      end
+
+      # Add an update to this live event.
+      # @param body [String] the update text
+      def update(body)
+        @client.post("/api/live/#{get_attribute(:id)}/update", body: body)
+      end
+
+      # @return [Array<User>] the contributors to this thread
+      def contributors
+        @client.get("/live/#{get_attribute(:id)}/contributors").body[0][:data].map do |user|
+          User.from_response(@client, user)
+        end
+      end
+
+      # @return [Array<User>] users invited to contribute to this thread
+      def invited_contributors
+        @client.get("/live/#{get_attribute(:id)}/contributors").body[1][:data].map do |user|
+          User.from_response(@client, user)
+        end
+      end
+
+      # Returns all discussions that link to this live thread.
+      # @param params [Hash] a list of params to send with the request
+      # @option params [String] :after return results after the given fullname
+      # @option params [String] :before return results before the given fullname
+      # @option params [Integer] :count the number of items already seen in the listing
+      # @option params [1..100] :limit the maximum number of things to return
+      #
+      # @return [Listing<Submission>]
+      def discussions(**params)
+        @client.model(:get, "/live/#{get_attribute(:id)}/discussions", params)
+      end
+    end
+  end
+end

data/lib/redd/models/mod_mail.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative 'basic_model'
+require_relative 'subreddit'
+require_relative 'conversation'
+
+module Redd
+  module Models
+    # A container for the new modmail.
+    # XXX: Instead of making ModMail a dumb container, could it be a lazy wrapper for #unread_count?
+    class ModMail < BasicModel
+      # @return [#highlighted, #notifications, #archived, #new, #inprogress, #mod] the number of
+      #   unread messages in each category
+      def unread_count
+        BasicModel.new(nil, @client.get('/api/mod/conversations/unread/count').body)
+      end
+
+      # @return [Array<Subreddit>] moderated subreddits that are enrolled in the new modmail
+      def enrolled
+        @client.get('/api/mod/conversations/subreddits').body[:subreddits].map do |_, s|
+          Subreddit.from_response(@client, s.merge(last_updated: s.delete(:lastUpdated)))
+        end
+      end
+
+      # Get the conversations
+      # @param after [String] base36 modmail conversation id
+      # @param subreddits [Subreddit, Array<Subreddit>] the subreddits to limit to
+      # @param limit [Integer] an integer (default: 25)
+      # @param sort [:recent, :mod, :user, :unread] the sort order
+      # @param state [:new, :inprogress, :mod, :notifications, :archived, :highlighted, :all] the
+      #   state to limit the conversations by
+      def conversations(subreddits: nil, **params)
+        params[:entity] = Array(subreddits).map(&:display_name).join(',') if subreddits
+        @client.get('/api/mod/conversations', **params).body
+      end
+
+      # Get a conversation from its base36 id.
+      # @param id [String] the conversation's id
+      # @return [Conversation]
+      def get(id)
+        Conversation.from_id(@client, id)
+      end
+    end
+  end
+end

data/lib/redd/models/more_comments.rb

@@ -19,6 +19,11 @@ module Redd
         )
       end
 
+      # @return [Array<String>] an array representation of self
+      def to_ary
+        get_attribute(:children)
+      end
+
       # Keep expanding until all top-level MoreComments are converted to comments
       def recursive_expand(link:, sort: 'best')
         # FIXME: this returns a flattened listing of comments and doesn't preserve the structure

data/lib/redd/models/postable.rb

@@ -56,6 +56,16 @@ module Redd
         vote(0)
       end
 
+      # Send replies to this thing to the user's inbox.
+      def enable_inbox_replies
+        @client.post('/api/sendreplies', id: get_attribute(:name), state: true)
+      end
+
+      # Stop sending replies to this thing to the user's inbox.
+      def disable_inbox_replies
+        @client.post('/api/sendreplies', id: get_attribute(:name), state: false)
+      end
+
       private
 
       # Send a vote.

data/lib/redd/models/session.rb

@@ -9,6 +9,16 @@ module Redd
     class Session < BasicModel
       include Searchable
 
+      # @return [ModMail] the new modmail
+      def modmail
+        ModMail.new(@client)
+      end
+
+      # @return [LiveThread] the live thread
+      def live_thread(id)
+        LiveThread.from_id(client, id)
+      end
+
       # @return [FrontPage] the user's front page
       def front_page
         FrontPage.new(@client)
@@ -62,20 +72,14 @@ module Redd
 
       # Return a listing of the user's inbox (including comment replies and private messages).
       #
-      # @param category ['inbox', 'unread', 'sent'] The category of messages
-      #   to view.
-      # @param mark [Boolean] Whether to remove the orangered from the
-      #   user's inbox.
-      # @param params [Hash] A list of optional params to send with the request.
-      # @option params [String] :after Return results after the given
-      #   fullname.
-      # @option params [String] :before Return results before the given
-      #   fullname.
-      # @option params [Integer] :count (0) The number of items already seen
-      #   in the listing.
-      # @option params [1..100] :limit (25) The maximum number of things to
-      #   return.
-      # @return [Listing]
+      # @param category ['inbox', 'unread', 'sent', 'moderator'] the category of messages to view
+      # @param mark [Boolean] whether to remove the orangered from the user's inbox
+      # @param params [Hash] a list of optional params to send with the request
+      # @option params [String] :after return results after the given fullname
+      # @option params [String] :before return results before the given fullname
+      # @option params [Integer] :count (0) the number of items already seen in the listing
+      # @option params [1..100] :limit (25) the maximum number of things to return
+      # @return [Listing<Comment, PrivateMessage>]
       def my_messages(category: 'inbox', mark: false, **params)
         @client.model(:get, "/message/#{category}.json", params.merge(mark: mark))
       end
@@ -84,6 +88,20 @@ module Redd
       def read_all_messages
         @client.post('/api/read_all_messages')
       end
+
+      # @return [Array<User>] the logged-in user's friends
+      def friends
+        @client.get('/api/v1/me/friends').body[:data][:children].map do |h|
+          User.from_response(@client, name: h[:name], id: h[:id].tr('t2_', ''), since: h[:date])
+        end
+      end
+
+      # @return [Array<User>] users blocked by the logged-in user
+      def blocked
+        @client.get('/prefs/blocked').body[:data][:children].map do |h|
+          User.from_response(@client, name: h[:name], id: h[:id].tr('t2_', ''), since: h[:date])
+        end
+      end
     end
   end
 end

data/lib/redd/models/submission.rb

@@ -33,6 +33,17 @@ module Redd
         end
       end
 
+      # Get all submissions for the same url.
+      # @param params [Hash] A list of optional params to send with the request.
+      # @option params [String] :after return results after the given fullname
+      # @option params [String] :before return results before the given fullname
+      # @option params [Integer] :count (0) the number of items already seen in the listing
+      # @option params [1..100] :limit (25) the maximum number of things to return
+      # @return [Listing<Submission>]
+      def duplicates(**params)
+        @client.unmarshal(@client.get("/duplicates/#{get_attribute(:id)}", params).body[1])
+      end
+
       # Mark the link as "Not Suitable For Work".
       def mark_as_nsfw
         @client.get('/api/marknsfw', id: get_attribute(:name))

data/lib/redd/models/subreddit.rb

@@ -141,6 +141,7 @@ module Redd
       # @return [Array<Hash>]
       def relationship_listing(type, **params)
         # TODO: add methods to determine if a certain user was banned/muted/etc
+        # TODO: return User types?
         user_list = @client.get("/r/#{get_attribute(:display_name)}/about/#{type}", params).body
         user_list[:data][:children]
       end

data/lib/redd/utilities/error_handler.rb

@@ -8,7 +8,7 @@ module Redd
     class ErrorHandler
       HTTP_ERRORS = {
         400 => Redd::BadRequest,
-        403 => Redd::Forbidden,
+        # 403 => Redd::Forbidden,
         404 => Redd::NotFound,
         500 => Redd::ServerError,
         502 => Redd::ServerError,
@@ -23,12 +23,13 @@ module Redd
 
       def check_error(response, raw:)
         # TODO: deal with errors of type { fields:, explanation:, message:, reason: }
-        if !raw && response.body[:json] && response.body[:json][:errors] &&
-           !response.body[:json][:errors].empty?
+        if !raw && response.body.is_a?(Hash) && response.body[:json] &&
+           response.body[:json][:errors] && !response.body[:json][:errors].empty?
           Redd::APIError.new(response)
         elsif HTTP_ERRORS.key?(response.code)
           HTTP_ERRORS[response.code].new(response)
-        elsif response.code == 401
+        elsif response.code == 401 || response.code == 403
+          # FIXME: i think insufficient_scope comes with 403 and invalid_token with 401
           AUTHORIZATION_ERRORS.each do |key, klass|
             auth_header = response.headers['www-authenticate']
             return klass.new(response) if auth_header && auth_header.include?(key)

data/lib/redd/utilities/unmarshaller.rb

@@ -5,16 +5,18 @@ module Redd
     # Unmarshals hashes into objects.
     class Unmarshaller
       # Contains the mapping from 'kind' strings to classes.
+      # TODO: UserList type!
       MAPPING = {
-        't1'           => Models::Comment,
-        't2'           => Models::User,
-        't3'           => Models::Submission,
-        't4'           => Models::PrivateMessage,
-        't5'           => Models::Subreddit,
-        'more'         => Models::MoreComments,
-        'wikipage'     => Models::WikiPage,
-        'Listing'      => Models::Listing,
-        'LabeledMulti' => Models::Multireddit
+        't1'              => Models::Comment,
+        't2'              => Models::User,
+        't3'              => Models::Submission,
+        't4'              => Models::PrivateMessage,
+        't5'              => Models::Subreddit,
+        'more'            => Models::MoreComments,
+        'wikipage'        => Models::WikiPage,
+        'Listing'         => Models::Listing,
+        'LabeledMulti'    => Models::Multireddit,
+        'LiveUpdateEvent' => Models::LiveThread
       }.freeze
 
       def initialize(client)

data/lib/redd/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Redd
-  VERSION = '0.8.0.pre.2'
+  VERSION = '0.8.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redd
 version: !ruby/object:Gem::Version
-  version: 0.8.0.pre.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Avinash Dwarapu
@@ -152,11 +152,14 @@ files:
 - lib/redd/models/access.rb
 - lib/redd/models/basic_model.rb
 - lib/redd/models/comment.rb
+- lib/redd/models/conversation.rb
 - lib/redd/models/front_page.rb
 - lib/redd/models/inboxable.rb
 - lib/redd/models/lazy_model.rb
 - lib/redd/models/listing.rb
+- lib/redd/models/live_thread.rb
 - lib/redd/models/messageable.rb
+- lib/redd/models/mod_mail.rb
 - lib/redd/models/moderatable.rb
 - lib/redd/models/more_comments.rb
 - lib/redd/models/multireddit.rb
@@ -191,9 +194,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.8