redd 0.7.8 → 0.7.9

data/lib/redd/objects/user.rb

@@ -1,52 +1,52 @@
-require_relative "thing"
-
-module Redd
-  module Objects
-    # The model for a reddit user
-    class User < Thing
-      include Thing::Messageable
-
-      # @!method get_overview(**params)
-      # @!method get_submitted(**params)
-      # @!method get_comments(**params)
-      # @!method get_liked(**params)
-      # @!method get_disliked(**params)
-      # @!method get_hidden(**params)
-      # @!method get_saved(**params)
-      # @!method get_gilded(**params)
-      #
-      # Get the appropriate listing.
-      # @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.
-      # @option params [:hot, :new, :top, :controversial] :sort The type of
-      #   sort to use.
-      # @option params [:hour, :day, :week, :month, :year, :all] :t The
-      #   time period to consider when sorting.
-      # @option params [:given] :show For {#get_gilded}, whether to show the
-      #   gildings given.
-      # @note The option :t only applies to the top and controversial sorts.
-      # @return [Listing<Submission>]
-      %w(
-        overview submitted comments liked disliked hidden saved gilded
-      ).each do |type|
-        define_method :"get_#{type}" do |**params|
-          client.request_object(
-            :get, "/user/#{name}/#{type}.json", **params
-          )
-        end
-      end
-
-      # Get posts that the user has gilded.
-      # @see #get_gilded
-      def get_gildings_given(**params)
-        get_gilded(**params.merge(show: "given"))
-      end
-    end
-  end
-end
+require_relative "thing"
+
+module Redd
+  module Objects
+    # The model for a reddit user
+    class User < Thing
+      include Thing::Messageable
+
+      # @!method get_overview(**params)
+      # @!method get_submitted(**params)
+      # @!method get_comments(**params)
+      # @!method get_liked(**params)
+      # @!method get_disliked(**params)
+      # @!method get_hidden(**params)
+      # @!method get_saved(**params)
+      # @!method get_gilded(**params)
+      #
+      # Get the appropriate listing.
+      # @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.
+      # @option params [:hot, :new, :top, :controversial] :sort The type of
+      #   sort to use.
+      # @option params [:hour, :day, :week, :month, :year, :all] :t The
+      #   time period to consider when sorting.
+      # @option params [:given] :show For {#get_gilded}, whether to show the
+      #   gildings given.
+      # @note The option :t only applies to the top and controversial sorts.
+      # @return [Listing<Submission>]
+      %w(
+        overview submitted comments liked disliked hidden saved gilded
+      ).each do |type|
+        define_method :"get_#{type}" do |**params|
+          client.request_object(
+            :get, "/user/#{name}/#{type}.json", **params
+          )
+        end
+      end
+
+      # Get posts that the user has gilded.
+      # @see #get_gilded
+      def get_gildings_given(**params)
+        get_gilded(**params.merge(show: "given"))
+      end
+    end
+  end
+end

data/lib/redd/objects/wiki_page.rb

@@ -1,15 +1,15 @@
-require_relative "thing"
-
-module Redd
-  module Objects
-    # A submission made in a subreddit.
-    class WikiPage < Thing
-      alias_property :content, :content_md
-      alias_property :body, :content_md
-
-      def revision_user
-        @revision_by ||= client.object_from_body(revision_by)
-      end
-    end
-  end
-end
+require_relative "thing"
+
+module Redd
+  module Objects
+    # A submission made in a subreddit.
+    class WikiPage < Thing
+      alias_property :content, :content_md
+      alias_property :body, :content_md
+
+      def revision_user
+        @revision_by ||= client.object_from_body(revision_by)
+      end
+    end
+  end
+end

data/lib/redd/rate_limit.rb

@@ -1,88 +1,88 @@
-# The main Redd module.
-module Redd
-  # The class that handles rate limiting for reddit.
-  #
-  # If you'd rather have an asynchronous or queue-based limiting, it's easy to
-  # write one yourself. A rate limiting class is any class that has an
-  # {#after_limit} method. The block returns a Faraday::Response object, so you
-  # can also extract the headers from the response and use those instead. To
-  # remove rate limiting entirely, follow the example below.
-  #
-  # @example To remove rate limiting entirely, just burst forever.
-  #     rt = Redd::RateLimit.new
-  #     rt.burst!(Float::INFINITY)
-  class RateLimit
-    # @!attribute [rw] gap
-    # @return [Integer, Float] The minimum time between requests.
-    attr_accessor :gap
-
-    # @!attribute [rw] burst_length
-    # @return [Integer] The number of requests left to burst.
-    attr_accessor :burst_length
-
-    # @!attribute [r] last_request
-    # @return [Time] The time the last request was made.
-    attr_reader :last_request
-
-    # @!attribute [r] used
-    # @!attribute [r] remaining
-    # @!attribute [r] reset
-    # @return [Integer] The data from reddit's response headers.
-    attr_reader :used, :remaining, :reset
-
-    # @param [Float, Integer] gap The minimum time between each request.
-    def initialize(gap)
-      # Some time ages ago, because we never made a request.
-      @last_request = Time.at(0)
-      @gap = gap
-      @burst_length = 0
-    end
-
-    # Don't sleep for the next few requests.
-    # @param [Integer] times The number of times to ignore limiting.
-    # @return [Integer] The total times rate limiting will be ignored.
-    def burst!(times)
-      @burst_length += times
-    end
-
-    # Sleep until 1 second has passed since the last request and perform the
-    # given request unless bursting.
-    #
-    # @yield [Faraday::Response] A response.
-    # @return [Faraday::Response] The response.
-    def after_limit
-      response = yield
-      update!(response)
-      sleep(wait_time)
-      response
-    end
-
-    private
-
-    # Update necessary info with each request.
-    # @param [Faraday::Response] response The response to the request made.
-    def update!(response)
-      @last_request_time = Time.now
-      %w(used remaining reset).each do |type|
-        value = response.headers["x-ratelimit-#{type}"]
-        instance_variable_set("@#{type}", value.to_i) unless value.nil?
-      end
-    end
-
-    # @return [Float, Integer] The number of seconds to sleep.
-    def wait_time
-      if @burst_length > 0 && @remaining > 0
-        # Don't sleep if we are in burst mode.
-        @burst_length -= 1
-        0
-      elsif @reset.nil? || @remaining.nil?
-        # Just guess if no headers were given (max 1 sec after last request).
-        time = @last_request_time - Time.now + @gap
-        time > 0 ? time : 0
-      else
-        # Most cases, spread out requests over available time.
-        @reset.to_f / (@gap * @remaining + 1)
-      end
-    end
-  end
-end
+# The main Redd module.
+module Redd
+  # The class that handles rate limiting for reddit.
+  #
+  # If you'd rather have an asynchronous or queue-based limiting, it's easy to
+  # write one yourself. A rate limiting class is any class that has an
+  # {#after_limit} method. The block returns a Faraday::Response object, so you
+  # can also extract the headers from the response and use those instead. To
+  # remove rate limiting entirely, follow the example below.
+  #
+  # @example To remove rate limiting entirely, just burst forever.
+  #     rt = Redd::RateLimit.new
+  #     rt.burst!(Float::INFINITY)
+  class RateLimit
+    # @!attribute [rw] gap
+    # @return [Integer, Float] The minimum time between requests.
+    attr_accessor :gap
+
+    # @!attribute [rw] burst_length
+    # @return [Integer] The number of requests left to burst.
+    attr_accessor :burst_length
+
+    # @!attribute [r] last_request
+    # @return [Time] The time the last request was made.
+    attr_reader :last_request
+
+    # @!attribute [r] used
+    # @!attribute [r] remaining
+    # @!attribute [r] reset
+    # @return [Integer] The data from reddit's response headers.
+    attr_reader :used, :remaining, :reset
+
+    # @param [Float, Integer] gap The minimum time between each request.
+    def initialize(gap)
+      # Some time ages ago, because we never made a request.
+      @last_request = Time.at(0)
+      @gap = gap
+      @burst_length = 0
+    end
+
+    # Don't sleep for the next few requests.
+    # @param [Integer] times The number of times to ignore limiting.
+    # @return [Integer] The total times rate limiting will be ignored.
+    def burst!(times)
+      @burst_length += times
+    end
+
+    # Sleep until 1 second has passed since the last request and perform the
+    # given request unless bursting.
+    #
+    # @yield [Faraday::Response] A response.
+    # @return [Faraday::Response] The response.
+    def after_limit
+      response = yield
+      update!(response)
+      sleep(wait_time)
+      response
+    end
+
+    private
+
+    # Update necessary info with each request.
+    # @param [Faraday::Response] response The response to the request made.
+    def update!(response)
+      @last_request_time = Time.now
+      %w(used remaining reset).each do |type|
+        value = response.headers["x-ratelimit-#{type}"]
+        instance_variable_set("@#{type}", value.to_i) unless value.nil?
+      end
+    end
+
+    # @return [Float, Integer] The number of seconds to sleep.
+    def wait_time
+      if @burst_length > 0 && @remaining > 0
+        # Don't sleep if we are in burst mode.
+        @burst_length -= 1
+        0
+      elsif @reset.nil? || @remaining.nil?
+        # Just guess if no headers were given (max 1 sec after last request).
+        time = @last_request_time - Time.now + @gap
+        time > 0 ? time : 0
+      else
+        # Most cases, spread out requests over available time.
+        @reset.to_f / (@gap * @remaining + 1)
+      end
+    end
+  end
+end

data/lib/redd/response/parse_json.rb

@@ -1,18 +1,18 @@
-require "faraday/response"
-require_relative "../error"
-
-module Redd
-  # The module that contains middleware that alters the Faraday response.
-  module Response
-    # Faraday Middleware that parses JSON using OJ, via MultiJson.
-    class ParseJson < Faraday::Response::Middleware
-      dependency "multi_json"
-
-      def on_complete(env)
-        env[:body] = MultiJson.load(env[:body], symbolize_keys: true)
-      rescue MultiJson::ParseError
-        raise JSONError.new(env), env[:body]
-      end
-    end
-  end
-end
+require "faraday/response"
+require_relative "../error"
+
+module Redd
+  # The module that contains middleware that alters the Faraday response.
+  module Response
+    # Faraday Middleware that parses JSON using OJ, via MultiJson.
+    class ParseJson < Faraday::Response::Middleware
+      dependency "multi_json"
+
+      def on_complete(env)
+        env[:body] = MultiJson.load(env[:body], symbolize_keys: true)
+      rescue MultiJson::ParseError
+        raise ::Redd::Error::JSONError.new(env), env[:body]
+      end
+    end
+  end
+end

data/lib/redd/response/raise_error.rb

@@ -1,16 +1,16 @@
-require "faraday/response"
-require_relative "../error"
-
-module Redd
-  # The module that contains middleware that alters the Faraday response.
-  module Response
-    # Faraday Middleware that raises an error if there's one.
-    # @see Error
-    class RaiseError < Faraday::Response::Middleware
-      def on_complete(env)
-        error = Redd::Error.from_response(env)
-        fail error.new(env), env[:body] if error
-      end
-    end
-  end
-end
+require "faraday/response"
+require_relative "../error"
+
+module Redd
+  # The module that contains middleware that alters the Faraday response.
+  module Response
+    # Faraday Middleware that raises an error if there's one.
+    # @see Error
+    class RaiseError < Faraday::Response::Middleware
+      def on_complete(env)
+        error = Redd::Error.from_response(env)
+        fail error.new(env), env[:body] if error
+      end
+    end
+  end
+end

data/lib/redd/version.rb

@@ -1,4 +1,4 @@
-module Redd # rubocop:disable Style/Documentation
-  # The semantic version number.
-  VERSION = "0.7.8"
-end
+module Redd # rubocop:disable Style/Documentation
+  # The semantic version number.
+  VERSION = "0.7.9"
+end

data/redd.gemspec

@@ -1,31 +1,31 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "redd/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "redd"
-  spec.version       = Redd::VERSION
-  spec.authors       = ["Avinash Dwarapu"]
-  spec.email         = ["avinash@dwarapu.me"]
-  spec.summary       = "A Reddit API Wrapper for Ruby."
-  spec.homepage      = "https://github.com/avidw/redd"
-  spec.license       = "MIT"
-  spec.required_ruby_version = ">= 2.1.0"
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.10.6"
-  spec.add_development_dependency "rake", "~> 10.4.2"
-  spec.add_development_dependency "rspec", "~> 3.2.0"
-  spec.add_development_dependency "vcr", "~> 2.9.3"
-  spec.add_development_dependency "webmock", "~> 1.20.4"
-
-  spec.add_dependency "hashie", "~> 3.4.0"
-  spec.add_dependency "faraday", "~> 0.9.1"
-  spec.add_dependency "multi_json", "~> 1.10.1"
-  spec.add_dependency "fastimage", "~> 1.6.6"
-end
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "redd/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "redd"
+  spec.version       = Redd::VERSION
+  spec.authors       = ["Avinash Dwarapu"]
+  spec.email         = ["avinash@dwarapu.me"]
+  spec.summary       = "A Reddit API Wrapper for Ruby."
+  spec.homepage      = "https://github.com/avidw/redd"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.1.0"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 11.2"
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 2.1"
+
+  spec.add_dependency "hashie", "~> 3.4"
+  spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "multi_json", "~> 1.12"
+  spec.add_dependency "fastimage", "~> 2.0"
+end