redd 0.7.5 → 0.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c90f67d9e2534cad626e22954ec8d4b901219fde
-  data.tar.gz: 3a100caa0269c8fdbd4b14dfc1a6c8a1664b707a
+  metadata.gz: a9bef7701b48a6df684f8014d9514b6968406860
+  data.tar.gz: 65b56eae484015cea298b41ff8f8f254db735e4a
 SHA512:
-  metadata.gz: 03f52c6f88fefb1f14e6ae690d98bf53240dc9f7bf76039ff2b236e6e98c41f774f327c8a9fab85780ace0cf3c623188d13b971a5878369f0ed9f870463cf5d9
-  data.tar.gz: 33fb6ee0ce7d72dca59af56a93b43284f0417f624945329466970c91a2dee84dbd51d9845dbaf63d40dd8c9d2ad26a86793ff514e5aa67fce403f3c69591a069
+  metadata.gz: 5e35f19510578de13aedbfb4ba552e9de82d3360cc041e4d5a2d5c6fc7aa0e46c6e3c5c9ffc09e4177e3a40adc4db95b08370b518dc8450f5adcf14ff1ca53c8
+  data.tar.gz: 4fb1df95bd17fd235d75a440f5dc6f508a6696f2f29479b5a64ee8cb498bd9f7489dd72cef3a489b23790487d0cbd72c65baac76c78e7068ac3291fb9d2b3450

data/lib/redd.rb

@@ -45,6 +45,6 @@ module Redd
       web: Clients::Web
     }
 
-    @client = types[type].new(*args, **kwargs)
+    types[type].new(*args, **kwargs)
   end
 end

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

@@ -45,7 +45,7 @@ module Redd
         # @param [Hash] body A JSON hash.
         # @return [Objects::Thing, Objects::Listing]
         def object_from_body(body)
-          return nil unless body.is_a?(Hash) && body.key?(:kind)
+          return nil unless body.is_a?(Hash)
           object = object_from_kind(body[:kind])
           flat = flatten_body(body)
           object.new(self, flat)
@@ -73,8 +73,6 @@ module Redd
           flattened
         end
 
-        private
-
         # Get a given property of a given object.
         # @param [Objects::Base, String] object The object with the property.
         # @param [Symbol] property The property to get.
@@ -82,12 +80,14 @@ module Redd
           object.respond_to?(property) ? object.send(property) : object.to_s
         end
 
+        private
+
         # Take a multilevel body ({kind: "tx", data: {...}}) and flatten it
         # into something like {kind: "tx", ...}
         # @param [Hash] body The response body.
         # @return [Hash] The flattened hash.
         def flatten_body(body)
-          data = body[:data]
+          data = body[:data] || body
           data[:kind] = body[:kind]
           data
         end

data/lib/redd/error.rb

@@ -27,6 +27,7 @@ module Redd
         when /wrong_password/i            then InvalidCredentials
         when /bad_captcha/i               then InvalidCaptcha
         when /ratelimit/i                 then RateLimited
+        when /quota_filled/i              then RateLimited
         when /bad_css_name/i              then InvalidClassName
         when /too_old/i                   then Archived
         when /too_much_flair_css/i        then TooManyClassNames
@@ -120,7 +121,7 @@ module Redd
       attr_reader :time
 
       def initialize(env)
-        @time = env[:body][:json][:ratelimit]
+        @time = env[:body][:json][:ratelimit] || 60*60
         super
       end
     end

data/lib/redd/objects/comment.rb

@@ -15,7 +15,7 @@ module Redd
 
       # @return [Listing] The comment's replies.
       def replies
-        @replies ||= client.object_from_body(self[:replies])
+        @replies ||= (client.object_from_body(self[:replies]) || [])
       end
     end
   end

data/lib/redd/objects/listing.rb

@@ -21,7 +21,7 @@ module Redd
         @before = attributes[:before]
         @after = attributes[:after]
         attributes[:children].each do |child|
-          self << client.object_from_body(child) || child
+          self << (client.object_from_body(child) || child)
         end
       end
     end

data/lib/redd/objects/subreddit.rb

@@ -41,7 +41,7 @@ module Redd
           resubmit: resubmit, sendreplies: sendreplies
         }
 
-        params << {captcha: captcha, iden: identifier} if captcha
+        params.merge!(captcha: captcha, iden: identifier) if captcha
         params[:kind], params[:text] = :self, text if text
         params[:kind], params[:url] = :link, url if url
 
@@ -150,15 +150,16 @@ module Redd
       # @param [String] text The text to set the flair to.
       # @param [String] css_class The css_class of the flair.
       def set_flair(thing, type = nil, text = nil, css_class = nil)
+        params = {text: text, css_class: css_class}
         if thing.is_a?(Objects::User) || type == :user
           params[:name] = client.property(thing, :name)
-        elsif thing.is_a?(Objects::Submission) || type == :user
+        elsif thing.is_a?(Objects::Submission) || type == :link
           params[:link] = client.property(thing, :fullname)
         else
           fail "You should provide a proper type."
         end
 
-        post("/r/#{display_name}/api/flair", text: text, css_class: css_class)
+        post("/r/#{display_name}/api/flair", params)
       end
 
       # @!endgroup
@@ -282,16 +283,16 @@ module Redd
         else
           about = admin_about
           final = about
-            .select { |k, _| required.include?(k) }
-            .merge(
-              name: display_name,
-              type: about[:subreddit_type],
-              lang: about[:language],
-              link_type: about[:content_options],
-              allow_top: true,
-              css_on_cname: true
-            )
-            .merge(attributes)
+                  .select { |k, _| required.include?(k) }
+                  .merge(
+                    name: display_name,
+                    type: about[:subreddit_type],
+                    lang: about[:language],
+                    link_type: about[:content_options],
+                    allow_top: true,
+                    css_on_cname: true
+                  )
+                  .merge(attributes)
           params.merge!(final)
         end
 

data/lib/redd/rate_limit.rb

@@ -1,50 +1,88 @@
 # The main Redd module.
 module Redd
-  # The class that handles rate limiting for reddit. reddit does supply
-  # X-Ratelimit headers but using those headers instead would just lead to
-  # short bursts, so it's better to go at a constant speed and space out
-  # requests every second.
+  # The class that handles rate limiting for reddit.
   #
-  # If you'd rather have short bursts or no rate limiting at all, it's easy to
+  # 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 No Rate Limiting
-  #   class IWantToGetIPBanned
-  #     def after_limit
-  #       yield
-  #     end
-  #   end
-  #
-  #   client = Redd.it(..., rate_limit: IWantToGetIPBanned.new)
+  # @example To remove rate limiting entirely, just burst forever.
+  #     rt = Redd::RateLimit.new
+  #     rt.burst!(Float::INFINITY)
   class RateLimit
-    # @!attribute [r] last_request_time
-    # @return [Time] The time when the last request took place.
-    attr_reader :last_request_time
-
     # @!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 = Time.at(0)
+      @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 2 seconds have passed since the last request and perform the
-    # given request.
+    # Sleep until 1 second has passed since the last request and perform the
+    # given request unless bursting.
     #
-    # @yield A block.
-    # @return The return value of the block.
+    # @yield [Faraday::Response] A response.
+    # @return [Faraday::Response] The response.
     def after_limit
-      wait_time = @last_request_time + @gap - Time.now
-      sleep(wait_time) if wait_time > 0
-      @last_request_time = Time.now
-      yield
+      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.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/version.rb

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

data/redd.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.8.1"
+  spec.add_development_dependency "bundler", "~> 1.9.4"
   spec.add_development_dependency "rake", "~> 10.4.2"
   spec.add_development_dependency "rspec", "~> 3.2.0"
   spec.add_development_dependency "vcr", "~> 2.9.3"

data/spec/redd_spec.rb

@@ -1,5 +1,3 @@
-require "redd/version"
-
 RSpec.describe Redd do
   it "has a version number" do
     expect(Redd::VERSION).to be_a(String)

data/spec/spec_helper.rb

@@ -40,6 +40,8 @@ RSpec.configure do |config|
   config.filter_run_including :focus
   config.run_all_when_everything_filtered = true
 
+  # If we don't have the details to perform authentication, we can't do those
+  # tests. 
   if ENV["TRAVIS_SECURE_ENV_VARS"] == "false"
     config.filter_run_excluding :secure
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redd
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.7.6
 platform: ruby
 authors:
 - Avinash Dwarapu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-19 00:00:00.000000000 Z
+date: 2015-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 1.9.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 1.9.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -194,7 +194,6 @@ files:
 - lib/redd/version.rb
 - redd.gemspec
 - spec/redd/objects/base_spec.rb
-- spec/redd/rate_limit_spec.rb
 - spec/redd/response/parse_json_spec.rb
 - spec/redd/response/raise_error_spec.rb
 - spec/redd_spec.rb
@@ -219,15 +218,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A Reddit API Wrapper for Ruby.
 test_files:
 - spec/redd/objects/base_spec.rb
-- spec/redd/rate_limit_spec.rb
 - spec/redd/response/parse_json_spec.rb
 - spec/redd/response/raise_error_spec.rb
 - spec/redd_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/spec/redd/rate_limit_spec.rb

@@ -1,29 +0,0 @@
-RSpec.describe Redd::RateLimit do
-  let(:rate_limit) { Redd::RateLimit.new(2) }
-
-  it "waits two seconds between consecutive requests" do
-    rate_limit.after_limit {}
-    start_time = Time.now
-    rate_limit.after_limit {}
-    end_time = Time.now
-
-    expect(end_time - start_time).to be_within(0.1).of(2)
-  end
-
-  it "doesn't wait if two seconds have passed since last request" do
-    rate_limit.after_limit {}
-    sleep(2)
-    start_time = Time.now
-    rate_limit.after_limit {}
-    end_time = Time.now
-
-    expect(end_time - start_time).to be_within(0.1).of(0)
-  end
-
-  it "stores the time the last request was made" do
-    time = Time.now
-    rate_limit.after_limit {}
-
-    expect(rate_limit.last_request_time).to be_within(0.1).of(time)
-  end
-end