redd 0.6.5 → 0.7.0

data/lib/redd/objects/wiki_page.rb

@@ -0,0 +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

data/lib/redd/rate_limit.rb

@@ -1,49 +1,50 @@
-module Redd
-  # The class that handles rate limiting for reddit. reddit does supply
-  # X-Ratelimit headers but only when logged in and 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 2 seconds.
-  #
-  # If you'd rather have short bursts or no rate limiting at all, 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::Unauthenticated.new(rate_limit: IWantToGetIPBanned.new)
-  #
-  # @note The class itself doesn't perform the rate limiting but only acts
-  #   as an updatable container for the values.
-  class RateLimit
-    # @!attribute [r] last_request_time
-    #   @return [String] The time when the last request took place.
-    attr_reader :last_request_time
-
-    # @param [Float, Integer] gap The minimum time between each request.
-    def initialize(gap = 2)
-      # Some time ages ago, because we never made a request.
-      @last_request_time = Time.at(0)
-      @gap = gap
-    end
-
-    # Sleep until 2 seconds have passed since the last request and perform the
-    # given request.
-    #
-    # @yield A block.
-    # @return The return value of the block.
-    def after_limit
-      seconds_passed = Time.now - @last_request_time
-      wait_time = @gap - seconds_passed
-      sleep(wait_time) if wait_time > 0
-      @last_request_time = Time.now
-      yield
-    end
-  end
-end
+# 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.
+  #
+  # If you'd rather have short bursts or no rate limiting at all, 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)
+  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
+
+    # @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)
+      @gap = gap
+    end
+
+    # Sleep until 2 seconds have passed since the last request and perform the
+    # given request.
+    #
+    # @yield A block.
+    # @return The return value of the block.
+    def after_limit
+      wait_time = @last_request_time + @gap - Time.now
+      sleep(wait_time) if wait_time > 0
+      @last_request_time = Time.now
+      yield
+    end
+  end
+end

data/lib/redd/response/parse_json.rb

@@ -1,33 +1,17 @@
-require "faraday_middleware"
-
-module Redd
-  # The module that contains middleware that alters the Faraday response.
-  module Response
-    # Faraday Middleware that parses JSON using Oj.
-    class ParseJson < Faraday::Middleware
-      dependency do
-        require "multi_json" unless defined?(::MultiJson)
-      end
-
-      # Call the middleware.
-      # @param faraday
-      def call(faraday)
-        @app.call(faraday).on_complete do |env|
-          env[:body] = parse(env[:body])
-        end
-      end
-
-      private
-
-      # Parse a JSON string and return a symbolized hash.
-      #
-      # @param [String] body The JSON string to parse.
-      # @return [Hash] A symbolized parsed JSON hash.
-      def parse(body)
-        MultiJson.load(body, symbolize_keys: true)
-      rescue MultiJson::ParseError
-        body
-      end
-    end
-  end
-end
+require "faraday/response"
+
+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 parse(body)
+        MultiJson.load(body, symbolize_keys: true)
+      rescue MultiJson::ParseError
+        body
+      end
+    end
+  end
+end

data/lib/redd/response/raise_error.rb

@@ -1,25 +1,16 @@
-require "faraday_middleware"
-require "redd/error"
-
-module Redd
-  module Response
-    # Raises the appropriate error when one comes up.
-    class RaiseError < Faraday::Middleware
-      # Call the middleware.
-      # @param faraday
-      def call(faraday)
-        @app.call(faraday).on_complete do |env|
-          error = Redd::Error.from_response(env)
-          if error
-            if error == Redd::Error::RateLimited
-              time = env.body[:json][:ratelimit]
-              fail error.new(env, time)
-            else
-              fail error.new(env)
-            end
-          end
-        end
-      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,5 +1,4 @@
-# The main Redd module.
-module Redd
-  # The semantic version number for Redd.
-  VERSION = "0.6.5"
-end
+module Redd # rubocop:disable Style/Documentation
+  # The semantic version number.
+  VERSION = "0.7.0"
+end

data/redd.gemspec

@@ -1,31 +1,30 @@
-# 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 |s|
-  s.name          = "redd"
-  s.version       = Redd::VERSION
-  s.authors       = ["Avinash Dwarapu"]
-  s.email         = ["d.nash.avi@gmail.com"]
-  s.summary       = "A Reddit API Wrapper for Ruby."
-  s.description   = "A Reddit API Wrapper for Ruby."
-  s.homepage      = ""
-  s.license       = "MIT"
-
-  s.files         = `git ls-files -z`.split("\x0")
-  s.executables   = s.files.grep(/^bin\//) { |f| File.basename(f) }
-  s.test_files    = s.files.grep(/^(test|spec|features)\//)
-  s.require_paths = ["lib"]
-
-  s.add_development_dependency "bundler"
-  s.add_development_dependency "rake"
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "vcr"
-  s.add_development_dependency "webmock"
-
-  s.add_dependency "faraday", "~> 0.9.0"
-  s.add_dependency "faraday_middleware", "~> 0.9.1"
-  s.add_dependency "multi_json", "~> 1.10"
-  s.add_dependency "memoizable"
-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.8.1"
+  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"
+end

data/spec/redd/objects/base_spec.rb

@@ -0,0 +1 @@
+# There's no point in testing Base, since we'd basically be testing Hashie.

data/spec/redd/rate_limit_spec.rb

@@ -1,29 +1,29 @@
-describe Redd::RateLimit do
-  let(:rate_limit) { Redd::RateLimit.new }
-
-  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
+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

data/spec/redd/response/parse_json_spec.rb

@@ -0,0 +1,12 @@
+RSpec.describe Redd::Response::ParseJson do
+  it "parses valid JSON" do
+    parsed = subject.parse('{"hello": "world", "foo": {"bar": 2}}')
+    expect(parsed).to eq(hello: "world", foo: {bar: 2})
+  end
+
+  it "returns the JSON string if it's invalid" do
+    error = "comparision with banana failed."
+    parsed = subject.parse(error)
+    expect(parsed).to eq(error)
+  end
+end

data/spec/redd/response/raise_error_spec.rb

@@ -0,0 +1,11 @@
+RSpec.describe Redd::Response::RaiseError do
+  it "return nil if there's no error" do
+    error = subject.on_complete(
+      status: 200,
+      body: {success: true},
+      response_headers: {}
+    )
+
+    expect(error).to be(nil)
+  end
+end

data/spec/redd_spec.rb

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

data/spec/spec_helper.rb

@@ -1,50 +1,69 @@
-require "rspec"
-require "webmock"
-require "vcr"
-
-require "redd"
-
-def test_username; ENV["REDDIT_USERNAME"]; end
-def test_password; ENV["REDDIT_PASSWORD"]; end
-def test_subreddit; ENV["REDDIT_SUBREDDIT"]; end
-
-def test_link_id; ENV["REDDIT_LINKID"] || "t3_2gngbm"; end
-def test_wikipage; ENV["REDDIT_WIKIPAGE"] || "redd_wiki_test"; end
-
-def unauthenticated_client
-  $unauthenticated_client ||= Redd::Client::Unauthenticated.new
-end
-
-def authenticated_client
-  $authenticated_client ||= Redd::Client::Authenticated.new_from_credentials(test_username, test_password)
-end
-
-VCR.configure do |config|
-  config.cassette_library_dir = "spec/cassettes"
-  config.default_cassette_options = {record: :new_episodes}
-  config.hook_into :webmock
-  config.filter_sensitive_data("<PASSWORD>") { test_password }
-end
-
-RSpec.configure do |config|
-  config.filter_run :focus
-  config.run_all_when_everything_filtered = true
-  config.profile_examples = 10
-  config.order = :random
-  Kernel.srand config.seed
-
-  config.expect_with :rspec do |expectations|
-    expectations.syntax = :expect
-  end
-
-  config.mock_with :rspec do |mocks|
-    mocks.syntax = :expect
-    mocks.verify_partial_doubles = true
-  end
-
-  config.around :each do |example|
-    VCR.use_cassette example.metadata[:full_description] do
-      example.run
-    end
-  end
-end
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "vcr"
+require "redd"
+
+VCR.configure do |config|
+  config.cassette_library_dir = "spec/cassettes"
+  config.hook_into :webmock
+  config.default_cassette_options = {record: :new_episodes}
+  config.configure_rspec_metadata!
+end
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run_including :focus
+  config.run_all_when_everything_filtered = true
+
+  if ENV["TRAVIS_SECURE_ENV_VARS"] == "false"
+    config.filter_run_excluding :secure
+  end
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end