redd 0.8.8 → 0.9.0.pre.1

data/lib/redd/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Redd
-  VERSION = '0.8.8'
+  VERSION = '0.9.0.pre.1'
 end

data/redd.gemspec

@@ -1,35 +1,38 @@
-# coding: utf-8
 # frozen_string_literal: true
 
 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']
+Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
+  spec.name     = 'redd'
+  spec.version  = Redd::VERSION
+  spec.authors  = ['Avinash Dwarapu']
+  spec.email    = ['avinash@dwarapu.me']
+  spec.summary  = 'A batteries-included API wrapper for reddit.'
+  spec.homepage = 'https://github.com/avinashbot/redd'
+  spec.license  = 'MIT'
+  spec.required_ruby_version = '>= 2.1.0'
 
-  spec.summary       = 'A batteries-included API wrapper for reddit.'
-  spec.homepage      = 'https://github.com/avinashbot/redd'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files -z`
-                       .split("\x0")
-                       .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.add_dependency 'http', '~> 2.2'
+  spec.add_dependency 'lazy_lazer', '~> 0.6'
 
+  spec.add_development_dependency 'pry', '~> 0.10'
   spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'rake', '~> 12.0'
-  spec.add_development_dependency 'rubocop', '~> 0.47'
-  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'yard', '~> 0.9.9'
+  spec.add_development_dependency 'rubocop', '~> 0.50'
 
   spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
   spec.add_development_dependency 'simplecov', '~> 0.13'
   spec.add_development_dependency 'webmock', '~> 2.3'
   spec.add_development_dependency 'vcr', '~> 3.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redd
 version: !ruby/object:Gem::Version
-  version: 0.8.8
+  version: 0.9.0.pre.1
 platform: ruby
 authors:
 - Avinash Dwarapu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-02 00:00:00.000000000 Z
+date: 2017-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: lazy_lazer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -53,33 +81,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.47'
+        version: 0.9.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.47'
+        version: 0.9.9
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.50'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.50'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +122,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -148,11 +204,15 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CONTRIBUTING.md
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
 - bin/console
+- bin/guard
 - bin/setup
 - lib/redd.rb
 - lib/redd/api_client.rb
@@ -161,34 +221,40 @@ files:
 - lib/redd/auth_strategies/userless.rb
 - lib/redd/auth_strategies/web.rb
 - lib/redd/client.rb
-- lib/redd/error.rb
+- lib/redd/errors.rb
 - lib/redd/middleware.rb
 - lib/redd/models/access.rb
-- lib/redd/models/basic_model.rb
 - lib/redd/models/comment.rb
 - lib/redd/models/front_page.rb
 - lib/redd/models/gildable.rb
 - lib/redd/models/inboxable.rb
-- lib/redd/models/lazy_model.rb
 - lib/redd/models/listing.rb
 - lib/redd/models/live_thread.rb
+- lib/redd/models/live_update.rb
 - lib/redd/models/messageable.rb
-- lib/redd/models/mod_mail.rb
+- lib/redd/models/mod_action.rb
+- lib/redd/models/model.rb
 - lib/redd/models/moderatable.rb
+- lib/redd/models/modmail.rb
+- lib/redd/models/modmail_conversation.rb
+- lib/redd/models/modmail_message.rb
 - lib/redd/models/more_comments.rb
 - lib/redd/models/multireddit.rb
+- lib/redd/models/paginated_listing.rb
 - lib/redd/models/postable.rb
 - lib/redd/models/private_message.rb
 - lib/redd/models/replyable.rb
+- lib/redd/models/reportable.rb
 - lib/redd/models/searchable.rb
+- lib/redd/models/self.rb
 - lib/redd/models/session.rb
 - lib/redd/models/submission.rb
 - lib/redd/models/subreddit.rb
+- lib/redd/models/trophy.rb
 - lib/redd/models/user.rb
 - lib/redd/models/wiki_page.rb
 - lib/redd/utilities/error_handler.rb
 - lib/redd/utilities/rate_limiter.rb
-- lib/redd/utilities/stream.rb
 - lib/redd/utilities/unmarshaller.rb
 - lib/redd/version.rb
 - logo.png
@@ -205,12 +271,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.8

data/lib/redd/error.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-module Redd
-  # An error raised by {Redd::Middleware} when there was an error returned by reddit.
-  class TokenRetrievalError < StandardError; end
-
-  # An error with the API.
-  class APIError < StandardError
-    attr_reader :response, :name
-
-    def initialize(response)
-      @response = response
-      @name, message = response.body[:json][:errors][0]
-      super(message)
-    end
-  end
-
-  # Represents an error from reddit returned in a response.
-  class ResponseError < StandardError
-    attr_accessor :response
-
-    def initialize(response)
-      super(response.raw_body.length <= 80 ? response.raw_body : "#{response.raw_body[0..80]}...")
-      @response = response
-    end
-  end
-
-  # An error returned by AuthStrategy.
-  # @note A common cause of this error is not having a bot account registered as a developer on
-  #   the app.
-  class AuthenticationError < ResponseError; end
-
-  # An error with Redd, probably (let me know!)
-  class BadRequest < ResponseError; end
-
-  # Whatever it is, you're not allowed to do it.
-  class Forbidden < ResponseError; end
-
-  # You don't have the correct scope to do this.
-  class InsufficientScope < ResponseError; end
-
-  # The access object supplied was invalid.
-  class InvalidAccess < ResponseError; end
-
-  # Returned when reddit raises a 404 error.
-  class NotFound < ResponseError; end
-
-  # Too many requests and not enough rate limiting.
-  class TooManyRequests < ResponseError; end
-
-  # An unknown error on reddit's end. Usually fixed with a retry.
-  class ServerError < ResponseError; end
-end

data/lib/redd/models/basic_model.rb

@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-module Redd
-  module Models
-    # The base class for all models.
-    class BasicModel
-      # @abstract Create an instance from a value.
-      # @param _client [APIClient] the api client to initialize the object with
-      # @param _value [Object] the object to coerce
-      # @return [BasicModel]
-      def self.from_id(_client, _value)
-        # TODO: abstract this out?
-        raise "coercion not implemented for #{name}"
-      end
-
-      # @return [APIClient] the client the model was initialized with
-      attr_reader :client
-
-      # Create a non-lazily initialized class.
-      # @param client [APIClient] the client that the model uses to make requests
-      # @param attributes [Hash] the class's attributes
-      def initialize(client, attributes = {})
-        @client = client
-        @attributes = attributes
-        after_initialize
-      end
-
-      # @return [Hash] a Hash representation of the object
-      def to_h
-        @attributes
-      end
-
-      # @return [Array<self>] an array representation of self
-      def to_ary
-        [self]
-      end
-
-      # @return [String] an easily readable representation of the object
-      def inspect
-        "#{super}\n" + @attributes.map { |a, v| "  #{a}: #{v}" }.join("\n")
-      end
-
-      # Checks whether an attribute is supported by method_missing.
-      # @param method_name [Symbol] the method name or attribute to check
-      # @param include_private [Boolean] whether to also include private methods
-      # @return [Boolean] whether the method is handled by method_missing
-      def respond_to_missing?(method_name, include_private = false)
-        @attributes.key?(method_name) || @attributes.key?(depredicate(method_name)) || super
-      end
-
-      # Return an attribute or raise a NoMethodError if it doesn't exist.
-      # @param method_name [Symbol] the name of the attribute
-      # @return [Object] the result of the attribute check
-      def method_missing(method_name, *args, &block)
-        return get_attribute(method_name) if @attributes.key?(method_name)
-        return get_attribute(depredicate(method_name)) if @attributes.key?(depredicate(method_name))
-        super
-      end
-
-      private
-
-      # @abstract Lets us plug in custom code without making a mess
-      def after_initialize; end
-
-      # Remove a trailing '?' from a symbol name.
-      # @param method_name [Symbol] the symbol to "depredicate"
-      # @return [Symbol] the symbol but with the '?' removed
-      def depredicate(method_name)
-        method_name.to_s.chomp('?').to_sym
-      end
-
-      # Get an attribute, raising KeyError if not present.
-      # @param name [Symbol] the attribute to check and get
-      # @return [Object] the value of the attribute
-      def get_attribute(name)
-        @attributes.fetch(name)
-      end
-    end
-  end
-end

data/lib/redd/models/lazy_model.rb

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'basic_model'
-
-module Redd
-  module Models
-    # The base class for lazily-initializable models.
-    class LazyModel < BasicModel
-      # Create a lazily initialized class.
-      # @param client [APIClient] the client that the model uses to make requests
-      # @param base_attributes [Hash] the already-known attributes that do not need to be looked up
-      # @yield [client] the model's client
-      # @yieldparam client [APIClient]
-      # @yieldreturn [Hash] the response of "initializing" the lazy model
-      def initialize(client, base_attributes = {}, &block)
-        super(client, base_attributes)
-        @lazy_loader = block
-        @definitely_fully_loaded = false
-      end
-
-      # Force the object to make a request to reddit.
-      # @return [self]
-      def force_load
-        @attributes.merge!(@lazy_loader ? @lazy_loader.call(@client) : default_loader)
-        @definitely_fully_loaded = true
-        after_initialize
-        self
-      end
-      alias reload force_load
-
-      # Convert the object to a hash, making a request to fetch additional attributes if needed.
-      # @return [Hash]
-      def to_h
-        ensure_fully_loaded
-        super
-      end
-
-      # Checks whether an attribute is supported by method_missing. Since we don't know whether an
-      # attribute exists until we load it, we have to respond true until we load it.
-      # @param method_name [Symbol] the method name or attribute to check
-      # @param include_private [Boolean] whether to also include private methods
-      # @return [Boolean] whether the method is handled by method_missing
-      def respond_to_missing?(method_name, include_private = false)
-        @definitely_fully_loaded ? super : true
-      end
-
-      # Return an attribute or raise a NoMethodError if it doesn't exist.
-      # @param method_name [Symbol] the name of the attribute
-      # @return [Object] the result of the attribute check
-      def method_missing(method_name, *args, &block)
-        ensure_fully_loaded unless @attributes.key?(method_name)
-        super
-      end
-
-      private
-
-      # @abstract A lazy loader to use when one is not provided.
-      def default_loader
-        {}
-      end
-
-      # Make sure the model is loaded at least once.
-      def ensure_fully_loaded
-        force_load unless @definitely_fully_loaded
-      end
-
-      # Gets the attribute and loads it if it may be available from the response.
-      def get_attribute(name)
-        # XXX: Replace get_attribute calls with simple method calls?
-        ensure_fully_loaded unless @attributes.key?(name)
-        super
-      end
-    end
-  end
-end