neonredd 0.0.1

data/lib/redd/objects/thing.rb

@@ -0,0 +1,26 @@
+require_relative 'base'
+
+module Redd
+  module Objects
+    # A reddit thing.
+    # @see http://www.reddit.com/dev/api#fullnames
+    class Thing < Base
+      # Load up all the possible mixins for the thing.
+      Dir[File.join(File.dirname(__FILE__), 'thing', '*.rb')].each do |file|
+        require(file)
+      end
+
+      # Check for equality.
+      # @param other The other object.
+      # @return [Boolean]
+      def ==(other)
+        other.is_a?(Thing) && fullname == other.fullname
+      end
+
+      # @return [String] The fullname of the thing.
+      def fullname
+        self[:name] || "#{kind}_#{id}"
+      end
+    end
+  end
+end

data/lib/redd/objects/user.rb

@@ -0,0 +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..1000] :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

@@ -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

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

data/lib/redd/response/parse_json.rb

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

data/lib/redd/response/raise_error.rb

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

data/lib/redd/version.rb

@@ -0,0 +1,4 @@
+module Redd
+  # The semantic version number.
+  VERSION = '0.0.1'.freeze
+end

data/lib/redd.rb

@@ -0,0 +1,50 @@
+require_relative 'redd/version'
+require_relative 'redd/clients/installed'
+require_relative 'redd/clients/script'
+require_relative 'redd/clients/userless'
+require_relative 'redd/clients/web'
+
+# The main Redd module.
+module Redd
+  # @overload it(:installed, client_id, redirect_uri, **kwargs)
+  #   Authorize a user via an installed app.
+  #   @param [String] client_id The client ID provided by reddit.
+  #   @param [String] redirect_uri The exact uri you provided to reddit.
+  #   @param [Hash] kwargs The keyword arguments provided to the client.
+  #   @return [Clients::Installed]
+  #
+  # @overload it(:script, client_id, secret, username, password, **kwargs)
+  #   Authorize a user that you have full access to, i.e. a bot.
+  #   @param [String] client_id The client ID provided by reddit.
+  #   @param [String] secret The client secret provided by reddit.
+  #   @param [String] username The username.
+  #   @param [String] password The password of the user.
+  #   @param [Hash] kwargs The keyword arguments provided to the client.
+  #   @return [Clients::Script]
+  #
+  # @overload it(:userless, client_id, secret, **kwargs)
+  #   Connect to reddit from a web-app or a script without a specific user.
+  #   @param [String] client_id The client ID provided by reddit.
+  #   @param [String] secret The client secret provided by reddit.
+  #   @param [Hash] kwargs The keyword arguments provided to the client.
+  #   @return [Clients::Userless]
+  #
+  # @overload it(:web, client_id, secret, redirect_uri, **kwargs)
+  #   Authorize a user from a website.
+  #   @param [String] client_id The client ID provided by reddit.
+  #   @param [String] secret The client secret provided by reddit.
+  #   @param [String] redirect_uri The exact uri you provided to reddit.
+  #   @param [Hash] kwargs The keyword arguments provided to the client.
+  #   @return [Clients::Web]
+  #
+  def self.it(type, *args, **kwargs)
+    types = {
+      installed: Clients::Installed,
+      script: Clients::Script,
+      userless: Clients::Userless,
+      web: Clients::Web
+    }
+
+    types[type].new(*args, **kwargs)
+  end
+end

data/neonredd.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redd/version'
+
+# rubocop:disable Metrics/LineLength
+Gem::Specification.new do |spec|
+  spec.name          = 'neonredd'
+  spec.version       = Redd::VERSION
+  spec.authors       = ['SirNeon']
+  spec.email         = ['sirneon618@gmail.com']
+  spec.summary       = 'A Reddit API Wrapper for Ruby.'
+  spec.description   = 'This is literally just Redd that can grab up to 1000 listing items.'
+  spec.homepage      = 'https://gitlab.com/SirNeon/neonredd'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.1.0'
+  # rubocop:disable Style/RegexpLiteral
+  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

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/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

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

data/spec/spec_helper.rb

@@ -0,0 +1,71 @@
+$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 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
+
+  # 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

metadata

@@ -0,0 +1,225 @@
+--- !ruby/object:Gem::Specification
+name: neonredd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- SirNeon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.6
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.4
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.1
+- !ruby/object:Gem::Dependency
+  name: fastimage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+description: This is literally just Redd that can grab up to 1000 listing items.
+email:
+- sirneon618@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- Redd.LICENSE.md
+- RedditKit.LICENSE.md
+- lib/redd.rb
+- lib/redd/access.rb
+- lib/redd/clients/base.rb
+- lib/redd/clients/base/account.rb
+- lib/redd/clients/base/identity.rb
+- lib/redd/clients/base/none.rb
+- lib/redd/clients/base/privatemessages.rb
+- lib/redd/clients/base/read.rb
+- lib/redd/clients/base/stream.rb
+- lib/redd/clients/base/submit.rb
+- lib/redd/clients/base/utilities.rb
+- lib/redd/clients/base/wikiread.rb
+- lib/redd/clients/installed.rb
+- lib/redd/clients/script.rb
+- lib/redd/clients/userless.rb
+- lib/redd/clients/web.rb
+- lib/redd/error.rb
+- lib/redd/objects/base.rb
+- lib/redd/objects/comment.rb
+- lib/redd/objects/labeled_multi.rb
+- lib/redd/objects/listing.rb
+- lib/redd/objects/more_comments.rb
+- lib/redd/objects/private_message.rb
+- lib/redd/objects/submission.rb
+- lib/redd/objects/subreddit.rb
+- lib/redd/objects/thing.rb
+- lib/redd/objects/thing/editable.rb
+- lib/redd/objects/thing/hideable.rb
+- lib/redd/objects/thing/inboxable.rb
+- lib/redd/objects/thing/messageable.rb
+- lib/redd/objects/thing/moderatable.rb
+- lib/redd/objects/thing/refreshable.rb
+- lib/redd/objects/thing/saveable.rb
+- lib/redd/objects/thing/votable.rb
+- lib/redd/objects/user.rb
+- lib/redd/objects/wiki_page.rb
+- lib/redd/rate_limit.rb
+- lib/redd/response/parse_json.rb
+- lib/redd/response/raise_error.rb
+- lib/redd/version.rb
+- neonredd.gemspec
+- spec/redd/objects/base_spec.rb
+- spec/redd/response/raise_error_spec.rb
+- spec/redd_spec.rb
+- spec/spec_helper.rb
+homepage: https://gitlab.com/SirNeon/neonredd
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Reddit API Wrapper for Ruby.
+test_files:
+- spec/redd/objects/base_spec.rb
+- spec/redd/response/raise_error_spec.rb
+- spec/redd_spec.rb
+- spec/spec_helper.rb