redd 0.7.10 → 0.8.0.pre.1

data/lib/redd/models/user.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative 'lazy_model'
+require_relative 'messageable'
+
+module Redd
+  module Models
+    # A reddit user.
+    class User < LazyModel
+      include Messageable
+
+      # Make a User from their name.
+      # @option hash [String] :name the user's name
+      # @return [User]
+      def self.from_response(client, hash)
+        name = hash.fetch(:name)
+        new(client, hash) { |c| c.get("/user/#{name}/about").body[:data] }
+      end
+
+      # Create a User from their name.
+      # @param client [APIClient] the api client to initialize the object with
+      # @param id [String] the username
+      # @return [User]
+      def self.from_id(client, id)
+        from_response(client, name: id)
+      end
+
+      # Compose a message to the moderators of a subreddit.
+      #
+      # @param subject [String] the subject of the message
+      # @param text [String] the message text
+      # @param from [Subreddit, nil] the subreddit to send the message on behalf of
+      def send_message(subject:, text:, from: nil)
+        super(to: get_attribute(:name), subject: subject, text: text, from: from)
+      end
+
+      # Get the appropriate listing.
+      # @param type [:overview, :submitted, :comments, :liked, :disliked, :hidden, :saved, :gilded]
+      #   the type of listing to request
+      # @param params [Hash] a list of params to send with the request
+      # @option params [:hot, :new, :top, :controversial] :sort the order of the 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 [:hour, :day, :week, :month, :year, :all] :time the time period to consider
+      #   when sorting
+      # @option params [:given] :show whether to show the gildings given
+      #
+      # @note The option :time only applies to the top and controversial sorts.
+      # @return [Listing<Submission>]
+      def listing(type, **params)
+        params[:t] = params.delete(:time) if params.key?(:time)
+        @client.model(:get, "/user/#{get_attribute(:name)}/#{type}.json", params)
+      end
+
+      # @!method overview(**params)
+      # @!method submitted(**params)
+      # @!method comments(**params)
+      # @!method liked(**params)
+      # @!method disliked(**params)
+      # @!method hidden(**params)
+      # @!method saved(**params)
+      # @!method gilded(**params)
+      #
+      # @see #listing
+      %i(overview submitted comments liked disliked hidden saved gilded).each do |type|
+        define_method(type) { |**params| listing(type, **params) }
+      end
+    end
+  end
+end

data/lib/redd/models/wiki_page.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'lazy_model'
+
+module Redd
+  module Models
+    # A reddit user.
+    class WikiPage < LazyModel
+      # Make a Wikipage from its title and subreddit.
+      # @option hash [String] :title the page's title
+      # @option hash [Subreddit] :subreddit the page's subreddit
+      # @return [WikiPage]
+      def self.from_response(client, hash)
+        title = hash.fetch(:title)
+        if hash.key?(:subreddit)
+          sr_name = hash[:subreddit].display_name
+          new(client, hash) { |c| c.get("/r/#{sr_name}/wiki/#{title}").body[:data] }
+        else
+          new(client, hash) { |c| c.get("/wiki/#{title}").body[:data] }
+        end
+      end
+    end
+  end
+end

data/lib/redd/utilities/error_handler.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative '../error'
+
+module Redd
+  module Utilities
+    # Handles response errors in API responses.
+    # TODO: handle [:json][:errors] array
+    class ErrorHandler
+      HTTP_ERRORS = {
+        400 => Redd::BadRequest,
+        404 => Redd::NotFound,
+        500 => Redd::ServerError,
+        502 => Redd::ServerError,
+        503 => Redd::ServerError,
+        504 => Redd::ServerError
+      }.freeze
+
+      AUTHORIZATION_ERRORS = {
+        'insufficient_scope' => Redd::InsufficientScope,
+        'invalid_token' => Redd::InvalidAccess
+      }.freeze
+
+      def check_error(response)
+        return HTTP_ERRORS[response.code].new(response) if HTTP_ERRORS.key?(response.code)
+        if response.code == 403
+          AUTHORIZATION_ERRORS.each do |key, klass|
+            return klass.new(response) if response.headers['www-authenticate'].include?(key)
+          end
+        end
+        nil
+      end
+    end
+  end
+end

data/lib/redd/utilities/rate_limiter.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Redd
+  module Utilities
+    # Manages rate limiting by sleeping.
+    class RateLimiter
+      def initialize(gap = 1)
+        @gap = 1
+        @last_request_time = Time.now - gap
+      end
+
+      def after_limit
+        sleep_time = (@last_request_time + @gap) - Time.now
+        sleep(sleep_time) if sleep_time > 0.01
+        response = yield
+        @last_request_time += @gap
+        response
+      end
+    end
+  end
+end

data/lib/redd/utilities/stream.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'enumerator'
+
+module Redd
+  module Utilities
+    # A forward-expading listing of items that can be enumerated forever.
+    class Stream
+      # A simple fixed-size ring buffer.
+      class RingBuffer
+        def initialize(size)
+          @size = size
+          @backing_array = Array.new(size)
+          @pointer = 0
+        end
+
+        def include?(el)
+          @backing_array.include?(el)
+        end
+
+        def add(el)
+          @backing_array[@pointer] = el
+          @pointer = (@pointer + 1) % @size
+        end
+      end
+
+      # Create a streamer.
+      # @yield [latest]
+      # @yieldparam latest [String, nil] the fullname of the latest model requested
+      # @yieldreturn [Listing] the models after the latest one
+      def initialize(&block)
+        @loader = block
+        @buffer = RingBuffer.new(100)
+        @latest = nil
+      end
+
+      # Make another request to reddit, yielding new elements.
+      # @yield [element] an element from the listings returned by the loader
+      def next_request
+        # Get the elements from the loader before the `latest` element
+        listing = @loader.call(@latest)
+        # If there's nothing new to process, request again.
+        return if listing.empty?
+        # Set the latest element to the latest one to be processed.
+        @latest = listing.first.name
+        # Iterate over the new elements, oldest to newest.
+        listing.reverse_each do |el|
+          next if @buffer.include?(el.name)
+          yield el
+          @buffer.add(el.name)
+        end
+      end
+
+      # Loop forever, yielding the elements from the loader
+      # @yield [element] an element from the listings returned by the loader
+      def stream
+        loop do
+          next_request { |el| yield el }
+        end
+      end
+    end
+  end
+end

data/lib/redd/utilities/unmarshaller.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Redd
+  module Utilities
+    # Unmarshals hashes into objects.
+    class Unmarshaller
+      # Contains the mapping from 'kind' strings to classes.
+      MAPPING = {
+        't1'           => Models::Comment,
+        't2'           => Models::User,
+        't3'           => Models::Submission,
+        't4'           => Models::PrivateMessage,
+        't5'           => Models::Subreddit,
+        'more'         => Models::MoreComments,
+        'wikipage'     => Models::WikiPage,
+        'Listing'      => Models::Listing,
+        'LabeledMulti' => Models::Multireddit
+      }.freeze
+
+      def initialize(client)
+        @client = client
+      end
+
+      def unmarshal(response)
+        if response[:json] && response[:json][:data]
+          if response[:json][:data][:things]
+            Models::Listing.from_response(@client, children: response[:json][:data][:things])
+          else
+            Models::BasicModel.new(@client, response[:json][:data])
+          end
+        elsif MAPPING.key?(response[:kind])
+          MAPPING[response[:kind]].from_response(@client, response[:data])
+        else
+          raise "unknown type to unmarshal: #{response[:kind].inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/redd/version.rb

@@ -1,4 +1,5 @@
-module Redd # rubocop:disable Style/Documentation
-  # The semantic version number.
-  VERSION = "0.7.10"
+# frozen_string_literal: true
+
+module Redd
+  VERSION = '0.8.0.pre.1'
 end

data/redd.gemspec

@@ -1,31 +1,35 @@
 # coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "redd/version"
+require 'redd/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "redd"
+  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.authors       = ['Avinash Dwarapu']
+  spec.email         = ['avinash@dwarapu.me']
+
+  spec.summary       = 'An intuitive and fun 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.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
 
-  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_dependency 'http', '~> 2.1'
 
-  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_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rubocop', '~> 0.47'
+  spec.add_development_dependency 'pry', '~> 0.10'
 
-  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"
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'simplecov', '~> 0.13'
+  spec.add_development_dependency 'webmock', '~> 2.3'
 end

metadata

@@ -1,141 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: redd
 version: !ruby/object:Gem::Version
-  version: 0.7.10
+  version: 0.8.0.pre.1
 platform: ruby
 authors:
 - Avinash Dwarapu
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2016-09-02 00:00:00.000000000 Z
+date: 2017-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
-  type: :development
+        version: '2.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.47'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.47'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: hashie
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :runtime
+        version: '3.5'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
-  type: :runtime
+        version: '0.13'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
-  name: fastimage
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
+        version: '2.3'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.3'
 description: 
 email:
 - avinash@dwarapu.me
@@ -148,56 +134,48 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
-- LICENSE.md
+- LICENSE.txt
 - README.md
 - Rakefile
-- RedditKit.LICENSE.md
+- TODO.md
+- bin/console
+- bin/setup
 - 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/api_client.rb
+- lib/redd/auth_strategies/auth_strategy.rb
+- lib/redd/auth_strategies/installed.rb
+- lib/redd/auth_strategies/script.rb
+- lib/redd/auth_strategies/userless.rb
+- lib/redd/auth_strategies/web.rb
+- lib/redd/client.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/models/access.rb
+- lib/redd/models/basic_model.rb
+- lib/redd/models/comment.rb
+- lib/redd/models/front_page.rb
+- lib/redd/models/inboxable.rb
+- lib/redd/models/lazy_model.rb
+- lib/redd/models/listing.rb
+- lib/redd/models/messageable.rb
+- lib/redd/models/moderatable.rb
+- lib/redd/models/more_comments.rb
+- lib/redd/models/multireddit.rb
+- lib/redd/models/postable.rb
+- lib/redd/models/private_message.rb
+- lib/redd/models/replyable.rb
+- lib/redd/models/session.rb
+- lib/redd/models/submission.rb
+- lib/redd/models/subreddit.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
 - redd.gemspec
-- spec/redd/objects/base_spec.rb
-- spec/redd/response/raise_error_spec.rb
-- spec/redd_spec.rb
-- spec/spec_helper.rb
-homepage: https://github.com/avidw/redd
+homepage: https://github.com/avinashbot/redd
 licenses:
 - MIT
 metadata: {}
@@ -209,20 +187,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: '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.6
+rubygems_version: 2.6.8
 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
+summary: An intuitive and fun API wrapper for reddit.
+test_files: []