NeonRAW 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 970a9bd9f4ba95e3afe11b528a54eb5f0d295694
-  data.tar.gz: d9e3a3db3364aeddf7c5ec1ffe3b33c20a7066ac
+  metadata.gz: 258edd85169bec9950d3370ab238087bac331a55
+  data.tar.gz: b1b1e668cf8f36d2a32597c2cbb5e6233e90e3ea
 SHA512:
-  metadata.gz: b55607b79d30c14d976989585a4bd4b356a1487a16060623e3313df7c79c9b9bda13eea60b9b264a7c77c01e7bc9950f13c6b15ea1f45cc17992887ee8dd597b
-  data.tar.gz: 705d32e891bf11ba949af1bce88c5f4c89a3804fc8357dd9a5240cc92c06832e1022a2fd30e9eb5febb21ec0ba1ed5ac5dfaa6ec9deb7e7c9db5eeb1436bc7f9
+  metadata.gz: e9be8fd451588cb2de972a140273f6cf57934319523d6141dddef76259213789e2124bbe4590353ad9243710eb4006af4dbf3e5d1e30e592b097553c61fa587e
+  data.tar.gz: b36701af359541c021ff5b2fef8e4efb768cb208e0a133fc2b70071ede231ff8c7f77f82de133112dc0922f81c1725617a15c57fab573000eee83a2bf02cd75e

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+## 0.1.7
+
+* Changed Me#purge! so you can now edit archived posts.
+* Error handling has been refactored a bit.
+* Refactored how subreddit#submit buildings submission objects.
+* Renamed Comment#link_id and Comment#parent_id to link_name and parent_name.
+* \#distinguished renamed to distinguished!
+* Subreddit#info was moved to client#info and returns a listing now.
+* User/Me objects now have a \#username attribute and \#name returns the object's fullname now.
+
+### Added
+
+* Content streams have been added to user and subreddit objects.
+* Added support for /r/popular.
+* You can now sticky distinguished comments.
+* MoreComments object has a comment? method now to make sifting through listings easier.
+* Hashie is now a runtime dependency.
+* You can now fetch duplicates of submissions.
+* Comments now have a permalink method.
+* User objects have a \#suspended? attribute now.
+* Subreddits have a \#moderators method now.
+
 ## 0.1.6
 
 ### Added

data/NeonRAW.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['sirneon618@gmail.com']
   spec.summary       = 'A Reddit API wrapper for Ruby.'
   spec.description   = 'SirNeon\'s wonderful API wrapper for Reddit. BETA'
-  spec.homepage      = 'https://gitlab.com/SirNeon/NeonRAW'
+  spec.homepage      = 'https://github.com/SirNeon618/NeonRAW'
   spec.license       = 'MPL-2.0'
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = 'exe'
@@ -19,8 +19,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.1.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.11'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_dependency             'typhoeus', '~> 0.7'
+  spec.add_dependency             'typhoeus', '~> 1.0'
+  spec.add_dependency             'hashie', '~> 3.5'
 end

data/lib/NeonRAW/clients/base.rb

@@ -25,13 +25,15 @@ module NeonRAW
       end
 
       # Connects to Reddit for oAuth2 requests.
-      # @!method api_connection(path, meth, params)
+      # @!method api_connection(path, meth, params, opts = {}, json = true)
       # @param path [String] The API path.
       # @param meth [Symbol] The request method.
       # @param params [Hash] The parameters.
       # @param opts [Hash] Optional parameters for the request body.
+      # @param json [Boolean] Whether or not the expected response will be JSON.
       # @return [Typhoeus::Response] Returns the response.
-      def api_connection(path, meth, params, opts = {})
+      def api_connection(path, meth, params, opts = {}, json = true)
+        sleep(@ratelimit_reset) if @requests_remaining <= 0
         response = Typhoeus::Request.new(
           'https://oauth.reddit.com' + path,
           method: meth,
@@ -39,9 +41,9 @@ module NeonRAW
           headers: api_headers,
           params: params
         ).run
-        error = assign_errors(response)
+        error = assign_errors(response, json)
         raise error unless error.nil?
-        handle_ratelimit(response.headers)
+        update_ratelimit_info(response.headers)
         response
       end
 
@@ -59,7 +61,7 @@ module NeonRAW
           headers: { 'User-Agent' => @user_agent },
           params: params
         ).run
-        error = assign_errors(response)
+        error = assign_errors(response, true)
         raise error unless error.nil?
         response
       end
@@ -77,7 +79,7 @@ module NeonRAW
       end
 
       # Requests data from Reddit.
-      # @!method request_data(path, meth, params = {})
+      # @!method request_data(path, meth, params = {}, opts = {})
       # @param path [String] The API path to connect to.
       # @param meth [Symbol] The request method to use.
       # @param params [Hash] Parameters for the request.
@@ -102,7 +104,7 @@ module NeonRAW
       #   via the request body.
       def request_nonjson(path, meth, params = {}, opts = {})
         refresh_access! if @access.expired?
-        api_connection(path, meth, params, opts).body
+        api_connection(path, meth, params, opts, false).body
       end
     end
   end

data/lib/NeonRAW/clients/base/objectbuilder.rb

@@ -4,6 +4,7 @@ require_relative '../../objects/me'
 require_relative '../../objects/multireddit'
 require_relative '../../objects/wikipage'
 require_relative '../../objects/all'
+require_relative '../../objects/popular'
 
 module NeonRAW
   module Clients
@@ -38,13 +39,15 @@ module NeonRAW
         # Fetches a subreddit.
         # @!method subreddit(name)
         # @param name [String] The name of the subreddit.
-        # @return [NeonRAW::Objects::Subreddit/All] Returns the subreddit/all
-        #   object.
+        # @return [NeonRAW::Objects::Subreddit/All/Popular] Returns the
+        #   subreddit/all/popular object.
         def subreddit(name)
           if name == 'all'
             Objects::All.new(self)
+          elsif name == 'popular'
+            Objects::Popular.new(self)
           else
-            data = request_data("/r/#{name}/about.json", :get)[:data]
+            data = request_data("/r/#{name}/about", :get)[:data]
             Objects::Subreddit.new(self, data)
           end
         end
@@ -54,7 +57,7 @@ module NeonRAW
         # @param name [String] The name of the user.
         # @return [NeonRAW::Objects::User] Returns the user object.
         def user(name)
-          data = request_data("/user/#{name}/about.json", :get)[:data]
+          data = request_data("/user/#{name}/about", :get)[:data]
           Objects::User.new(self, data)
         end
 
@@ -162,7 +165,7 @@ module NeonRAW
         # @return [NeonRAW::Objects::WikiPage] Returns the wiki page object.
         def wikipage(page)
           params = { page: page }
-          path = "/wiki/#{page}.json"
+          path = "/wiki/#{page}"
           data = request_data(path, :get, params)
           data[:data][:name] = page
           Objects::WikiPage.new(self, data[:data])

data/lib/NeonRAW/clients/base/utilities.rb

@@ -27,7 +27,7 @@ module NeonRAW
         # @option params :show [String] Literally the string 'all'.
         # @return [NeonRAW::Objects::Listing] Returns a listing of all the
         #   subreddits.
-        %w(popular new gold defaults).each do |type|
+        %w[popular new gold defaults].each do |type|
           define_method :"#{type}" do |params = { limit: 25 }|
             type.chop! if type == 'defaults'
             build_listing("/subreddits/#{type}", params)
@@ -45,7 +45,7 @@ module NeonRAW
           stack = comments.dup
           until stack.empty?
             comment = stack.shift
-            if comment.is_a?(Objects::Comment)
+            if comment.is_a?(Objects::Comment) # MoreComments can be mixed in.
               replies = comment.replies
               stack = replies + stack unless replies.nil?
             end
@@ -58,8 +58,41 @@ module NeonRAW
         # @!method wikipages
         # @return [Array<String>] Returns a list of wiki pages.
         def wikipages
-          request_data('/wiki/pages.json', :get)[:data]
+          request_data('/wiki/pages', :get)[:data]
         end
+
+        # Streams listing items continuously.
+        # @!method stream(path, params)
+        # @param path [String] The API path for the listing you want streamed.
+        # @param params [Hash] The optional parameters for the request.
+        # @return [Enumerator] Returns an enumerator for the streamed data.
+        def stream(path, params)
+          Enumerator.new do |data_stream|
+            before = params[:before]
+            loop do
+              params[:before] = before
+              listing = build_listing(path, params)
+              listing.each { |thing| data_stream << thing }
+              before = listing.first.name unless listing.empty?
+              sleep(1)
+            end
+          end
+        end
+
+        # Get info on a link/comment/subreddit.
+        # @!method info(params = {})
+        # @param params [Hash] The parameters.
+        # @option params :name [String] The fullname of the thing.
+        # @option params :url [String] The URL of the thing.
+        # @return [NeonRAW::Objects::Listing] Returns a listing with the items.
+        # @note :name and :url can take multiple fullnames separated by commas.
+        # @see https://www.reddit.com/dev/api#fullnames
+        def info(params = {})
+          params[:id] = params[:name]
+          params.delete(:name)
+          build_listing('/api/info', params)
+        end
+        private :stream
       end
     end
   end

data/lib/NeonRAW/clients/installed.rb

@@ -8,6 +8,8 @@ module NeonRAW
       def initialize(client_id, redirect_uri, opts = {})
         @client_id = client_id
         @redirect_uri = redirect_uri
+        @requests_remaining = 1
+        @ratelimit_reset = 0
         @user_agent = opts[:user_agent] ||
                       "Powered by NeonRAW v#{NeonRAW::VERSION}"
       end

data/lib/NeonRAW/clients/script.rb

@@ -10,6 +10,8 @@ module NeonRAW
         @client_id = client_id
         @secret = secret
         @redirect_uri = opts[:redirect_uri] || 'http://127.0.0.1:'
+        @requests_remaining = 1
+        @ratelimit_reset = 0
         @user_agent = opts[:user_agent] ||
                       "Powered by NeonRAW v#{NeonRAW::VERSION}"
         authorize!

data/lib/NeonRAW/clients/web.rb

@@ -9,6 +9,8 @@ module NeonRAW
         @client_id = client_id
         @secret = secret
         @redirect_uri = redirect_uri
+        @requests_remaining = 1
+        @ratelimit_reset = 0
         @user_agent = opts[:user_agent] ||
                       "Powered by NeonRAW v#{NeonRAW::VERSION}"
       end

data/lib/NeonRAW/errors.rb

@@ -1,35 +1,43 @@
 # rubocop:disable all
 
+require 'hashie'
+
 module NeonRAW
   # Methods and classes for handling errors.
   module Errors
     # Reads the HTTP status of the Typhoeus response and gives an exception to
     # raise.
-    # @!method assign_errors(response)
+    # @!method assign_errors(response, json)
     # @param response [Typhoeus::Response] The response object.
+    # @param json [Boolean] Whether or not the response is JSON.
     # @return [StandardError, nil] Returns either the exception or nil if there
     #   is none.
-    def assign_errors(response)
+    def assign_errors(response, json)
       code = response.code
       body = response.body
       case code
       when 200
-        case body
-        when /access_denied/i             then OAuth2AccessDenied
-        when /unsupported_response_type/i then InvalidResponseType
-        when /unsupported_grant_type/i    then InvalidGrantType
-        when /invalid_scope/i             then InvalidScope
-        when /invalid_request/i           then InvalidRequest
-        when /invalid_grant/i             then ExpiredCode
-        when /wrong_password/i            then InvalidCredentials
-        when /bad_captcha/i               then InvalidCaptcha
-        when /ratelimit/i                 then RateLimited
-        when /quota_filled/i              then QuotaFilled
-        when /bad_css_name/i              then InvalidClassName
-        when /too_old/i                   then Archived
-        when /too_much_flair_css/i        then TooManyClassNames
-        when /user_required/i             then AuthenticationRequired
-        when /bad_flair_target/i          then BadFlairTarget
+        if json
+          errors = JSON.parse(body, symbolize_names: true)
+          errors.extend(Hashie::Extensions::DeepFind)
+          errors = errors.deep_find(:error) || errors.deep_find(:errors)
+          errors = errors.first if errors.is_a?(Array)
+          case errors
+          when /access_denied/i             then OAuth2AccessDenied
+          when /unsupported_response_type/i then InvalidResponseType
+          when /unsupported_grant_type/i    then InvalidGrantType
+          when /invalid_scope/i             then InvalidScope
+          when /invalid_request/i           then InvalidRequest
+          when /invalid_grant/i             then InvalidCredentials
+          when /wrong_password/i            then InvalidCredentials
+          when /bad_captcha/i               then InvalidCaptcha
+          when /ratelimit/i                 then RateLimited
+          when /quota_filled/i              then QuotaFilled
+          when /bad_css_name/i              then InvalidClassName
+          when /too_much_flair_css/i        then TooManyClassNames
+          when /user_required/i             then AuthenticationRequired
+          when /bad_flair_target/i          then BadFlairTarget
+          end
         end
       when 302 then UnexpectedRedirect
       when 400 then BadRequest
@@ -57,39 +65,30 @@ module NeonRAW
     # @param data [Array, Hash] The data.
     def parse_errors(data)
       # handles returns from toggleable methods
-      assign_data_errors([]) if data.empty?
-      if data.is_a?(Array) # handles returns from some flair methods
-        # handles multireddits
-        return assign_data_errors([]) unless data[0].key?(:errors)
-        messages = []
-        errors = data[0][:errors]
-        errors.each { |_key, error| messages << error } unless errors.empty?
-        assign_data_errors(messages)
-      elsif data.key?(:json) # handles pretty much everything else
-        assign_data_errors([]) unless data[:json].key?(:errors)
-        if data[:json][:errors].is_a?(Array)
-          errors = data[:json][:errors][0] || []
-          assign_data_errors(errors)
-        else
-          errors = data[:json][:errors] || []
-          assign_data_errors(errors)
-        end
-      elsif data.key?(:errors) # handles image uploading
-        errors = data[:errors] || []
-        assign_data_errors(errors)
-      elsif data.key?(:jquery) # handles submitting submissions
-        errors = data[:jquery][-7][3]
-        assign_data_errors(errors)
+      return assign_data_errors([]) if data.empty?
+      data.extend(Hashie::Extensions::DeepFind)
+
+      errors = data.deep_find(:errors)
+      return assign_data_errors([]) if errors.nil? || errors.empty?
+      return assign_data_errors(errors.first) if errors.first.is_a?(Array)
+      if errors.is_a?(Hash)
+        messages = errors.map { |_key, error| error } # handles multireddits
+        return assign_data_errors(messages)
       end
+      return assign_data_errors(errors)
     end
 
-    # Checks data for any errors that wouldn't have otherwise thrown an
+    # Checks data for any errors that wouldn't have otherwise raised an
     # exception.
     # @!method assign_data_errors(errors)
     # @param errors [Array<String>] The errors.
     def assign_data_errors(errors)
       return nil if errors.empty?
-      error = errors.first
+      error = if errors.first == :row # handles flair errors
+                errors[1]
+              else
+                errors.first
+              end
       case error
       when /improperly formatted row/i then BadFlairRowFormat
       when /no_subject/i               then NoSubject
@@ -121,16 +120,16 @@ module NeonRAW
       when /unable to resolve user/i   then CouldntResolveUser
       when /sr_rule_exists/i           then RuleExists
       when /sr_rule_too_many/i         then TooManyRules
+      when /too_old/i                  then Archived
       end
     end
 
     # Manages the API ratelimit for requesting stuff from Reddit.
-    # @!method handle_ratelimit(headers)
+    # @!method update_ratelimit_info(headers)
     # @param headers [Hash] The Typhoeus response headers.
-    def handle_ratelimit(headers)
-      requests_remaining = headers['X-Ratelimit-Remaining'].to_i
-      ratelimit_reset = headers['X-Ratelimit-Reset'].to_i
-      sleep(ratelimit_reset) if requests_remaining <= 0
+    def update_ratelimit_info(headers)
+      @requests_remaining = headers['X-Ratelimit-Remaining'].to_i
+      @ratelimit_reset = headers['X-Ratelimit-Reset'].to_i
     end
 
     # That URL has already been submitted.
@@ -142,7 +141,7 @@ module NeonRAW
 
     # Thing is archived and can't be edited/replied to.
     class Archived < StandardError
-      def initialize(msg = 'This thing is too old to edit/reply to.')
+      def initialize(msg = 'This thing is too old to reply to.')
         super(msg)
       end
     end
@@ -232,14 +231,6 @@ module NeonRAW
       end
     end
 
-    # You already received an access token using this code. They're only good
-    # for one use.
-    class ExpiredCode < StandardError
-      def initialize(msg = 'The code used to get the access token has expired.')
-        super(msg)
-      end
-    end
-
     # Only gold-only subreddits can do that.
     class GoldOnlySrRequired < StandardError
       def initialize(msg = 'Only gold-only subreddits can do that.')
@@ -284,7 +275,7 @@ module NeonRAW
 
     # Your username/password is wrong.
     class InvalidCredentials < StandardError
-      def initialize(msg = 'Invalid username/password')
+      def initialize(msg = 'Invalid username/password/client id/secret')
         super(msg)
       end
     end

data/lib/NeonRAW/objects/all.rb

@@ -28,12 +28,30 @@ module NeonRAW
       # @option params :limit [1..1000] The number of items to fetch.
       # @option params :show [String] Literally the string 'all'.
       # @return [NeonRAW::Objects::Listing] Returns the listing object.
-      %w(hot rising top old new controversial comments).each do |type|
+      %w[hot rising top old new controversial comments].each do |type|
         define_method :"#{type}" do |params = { limit: 25 }|
-          path = "/r/all/#{type}/.json"
+          path = "/r/all/#{type}"
           @client.send(:build_listing, path, params)
         end
       end
+
+      # Streams content from /r/all.
+      # @!method stream(queue, params = { limit: 25 })
+      # @param queue [Symbol] The queue to get data from [hot, top, new,
+      #   controversial, gilded, comments]
+      # @param params [Hash] The parameters for the request.
+      # @option params :t [String] Time for relevant sorting [hour, day, week,
+      #   month, year, all]
+      # @option params :after [String] The name of the next data block.
+      # @option params :before [String] The name of the previous data block.
+      # @option params :count [Integer] The number of items already in the
+      #   listing.
+      # @option params :limit [1..1000] The number of items to fetch.
+      # @option params :show [String] Literally the string 'all'.
+      # @return [Enumerator] Returns an enumerator for the streamed data.
+      def stream(queue, params = { limit: 25 })
+        @client.send(:stream, "/r/all/#{queue}", params)
+      end
     end
   end
 end