redd 0.1.0

data/lib/redd/object/submission.rb

@@ -0,0 +1,94 @@
+require "redd/thing"
+
+module Redd
+  module Object
+    # A submission made in a subreddit.
+    class Submission < Redd::Thing
+      # @!attribute [r] title
+      # @return [String] The title of the submission.
+      attr_reader :title
+
+      # @!attribute [r] url
+      # @return [String] The url the submission links to.
+      attr_reader :url
+
+      # @!attribute [r] num_comments
+      # @return [Integer] The number of comments the submission has.
+      attr_reader :num_comments
+
+      # @!attribute [r] domain
+      # @return [String] The domain the url belongs to.
+      attr_reader :domain
+
+      # @!attribute [r] subreddit
+      # @return [String] The name of the subreddit this comment belongs to.
+      # @todo Convert to a Subreddit object?
+      attr_reader :subreddit
+
+      # @!attribute [r] is_self?
+      # @return [Boolean] Whether the submission is a self submission.
+      attr_reader :self?, :is_self
+
+      # @!attribute [r] thumbnail
+      # @return [String] The url for the thumbnail of the submission.
+      attr_reader :thumbnail
+      alias_method :thumbnail_url, :thumbnail
+
+      # @!attribute [r] selftext
+      # @return [String] The text of the submission in markdown.
+      # @note This returns "" if the submission is not a self submission.
+      attr_reader :selftext
+
+      # @!attribute [r] selftext_html
+      # @return [String] The text of the submission in html.
+      # @note This returns nil if the submission is not a self submission.
+      # @note Be warned: this isn't actual html, but escaped html. So all the
+      #   <'s and >'s are converted to &lt;'s and &gt;'s.
+      attr_reader :selftext_html
+
+      # @!attribute [r] link_flair_text
+      # @return [String] The submission's flair.
+      attr_reader :link_flair_text
+
+      # @!attribute [r] link_flair_css_class
+      # @return [String] The CSS class of the submission's flair.
+      attr_reader :link_flair_css_class
+
+      # @!attribute [r] author_flair_text
+      # @return [String] The user's flair.
+      attr_reader :author_flair_text
+
+      # @!attribute [r] author_flair_css_class
+      # @return [String] The CSS class of the user's flair.
+      attr_reader :author_flair_css_class
+
+      # @!attribute [r] clicked
+      # @return [Boolean] Whether the user already clicked on the link before.
+      # @note This only works for users with reddit gold.
+      attr_reader :clicked
+
+      # @!attribute [r] visited
+      # @return [Boolean] Whether the user already visited on the link before.
+      # @note I have no idea what the difference between this and {#clicked} is
+      attr_reader :visited
+
+      # @!attribute [r] stickied
+      # @return [Boolean] Whether the submission was stickied in the subreddit.
+      attr_reader :stickied
+
+      # @!attribute [r] nsfw?
+      # @return [Boolean] Whether the post is marked as NSFW.
+      attr_reader :nsfw?, :over_18
+
+      # @return [String] The full url to the post on reddit.com.
+      def permalink
+        "http://www.reddit.com" + attributes[:permalink]
+      end
+
+      # @return [String] The short url on redd.it.
+      def short_url
+        "http://redd.it/" + id
+      end
+    end
+  end
+end

data/lib/redd/object/subreddit.rb

@@ -0,0 +1,10 @@
+require "redd/thing"
+
+module Redd
+  module Object
+    # A comment made on links.
+    # @note This model can sure benefit from some lazy-loading...
+    class Subreddit < Redd::Thing
+    end
+  end
+end

data/lib/redd/rate_limit.rb

@@ -0,0 +1,48 @@
+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
+
+    def initialize
+      # Some time ages ago, because we never made a request.
+      @last_request_time = Time.at(0)
+    end
+
+    # Sleep until 2 seconds have passed since the last request and perform the
+    # given request.
+    #
+    # @param [Float, Integer] gap The minimum time between each request.
+    # @yield A block.
+    # @return The return value of the block.
+    def after_limit(gap = 2)
+      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

data/lib/redd/response/parse_json.rb

@@ -0,0 +1,31 @@
+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 "oj" unless defined?(::Oj)
+      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)
+        Oj.load(body, symbol_keys: true)
+      rescue Oj::ParseError
+        body
+      end
+    end
+  end
+end

data/lib/redd/response/raise_error.rb

@@ -0,0 +1,20 @@
+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
+            info = Redd::Error.parse_error(env[:body])
+            fail error, info
+          end
+        end
+      end
+    end
+  end
+end

data/lib/redd/thing.rb

@@ -0,0 +1,27 @@
+require "redd/base"
+
+module Redd
+  # A reddit thing.
+  # @see http://www.reddit.com/dev/api#fullnames
+  class Thing < Redd::Base
+    # @!attribute [r] id
+    # @return [String] The id value for the thing.
+    attr_reader :id
+
+    # @!attribute [r] kind
+    # @return [String] The kind of the thing.
+    attr_reader :kind
+
+    # Check for equality.
+    # @param other The other object.
+    # @return [Boolean]
+    def ==(other)
+      other.is_a?(Redd::Thing) && full_name == other.full_name
+    end
+
+    # @return [String] The fullname of the thing.
+    def fullname
+      @fullname ||= (attributes[:name] || "#{kind}_#{id}")
+    end
+  end
+end

data/lib/redd/version.rb

@@ -0,0 +1,5 @@
+# The main Redd module.
+module Redd
+  # The semantic version number for Redd.
+  VERSION = "0.1.0"
+end

data/redd.gemspec

@@ -0,0 +1,32 @@
+# 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", "~> 1.6"
+  s.add_development_dependency "rubocop"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "yard"
+  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 "memoizable"
+  s.add_dependency "oj"
+end

data/spec/redd_spec.rb

@@ -0,0 +1,7 @@
+require_relative "spec_helper"
+
+describe Redd do
+  it "has a semantic version number" do
+    expect(Redd::VERSION).to match(/\d\.\d\.\d/)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+require "rspec"
+require "webmock"
+require "vcr"
+
+require "redd"
+
+VCR.configure do |config|
+  config.cassette_library_dir = "spec/cassettes"
+  config.hook_into :webmock
+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

metadata

@@ -0,0 +1,234 @@
+--- !ruby/object:Gem::Specification
+name: redd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Avinash Dwarapu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: memoizable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Reddit API Wrapper for Ruby.
+email:
+- d.nash.avi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .travis.yml
+- .yardopts
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- github/redd.png
+- lib/redd.rb
+- lib/redd/RedditKit.LICENSE.md
+- lib/redd/base.rb
+- lib/redd/client/authenticated.rb
+- lib/redd/client/authenticated/account.rb
+- lib/redd/client/authenticated/apps.rb
+- lib/redd/client/authenticated/flair.rb
+- lib/redd/client/authenticated/gold.rb
+- lib/redd/client/authenticated/links_comments.rb
+- lib/redd/client/authenticated/live.rb
+- lib/redd/client/authenticated/moderation.rb
+- lib/redd/client/authenticated/multis.rb
+- lib/redd/client/authenticated/private_messages.rb
+- lib/redd/client/authenticated/subreddits.rb
+- lib/redd/client/authenticated/users.rb
+- lib/redd/client/authenticated/wiki.rb
+- lib/redd/client/oauth2.rb
+- lib/redd/client/unauthenticated.rb
+- lib/redd/client/unauthenticated/account.rb
+- lib/redd/client/unauthenticated/links_comments.rb
+- lib/redd/client/unauthenticated/listing.rb
+- lib/redd/client/unauthenticated/subreddits.rb
+- lib/redd/client/unauthenticated/utilities.rb
+- lib/redd/client/unauthenticated/wiki.rb
+- lib/redd/error.rb
+- lib/redd/object/comment.rb
+- lib/redd/object/listing.rb
+- lib/redd/object/submission.rb
+- lib/redd/object/subreddit.rb
+- lib/redd/rate_limit.rb
+- lib/redd/response/parse_json.rb
+- lib/redd/response/raise_error.rb
+- lib/redd/thing.rb
+- lib/redd/version.rb
+- redd.gemspec
+- spec/redd_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: A Reddit API Wrapper for Ruby.
+test_files:
+- spec/redd_spec.rb
+- spec/spec_helper.rb
+has_rdoc: