redditkit 1.0.0

data/lib/redditkit/response/parse_json.rb

@@ -0,0 +1,29 @@
+require 'faraday'
+require 'json'
+
+module RedditKit
+
+  # Methods for handling responses from reddit.
+  module Response
+    class ParseJSON < Faraday::Response::Middleware
+
+      # Turn the response body into a JSON object.
+      #
+      # @note Because the reddit API sometimes returns invalid JSON objects with
+      #   an application/json header, we want to return the body itself if the
+      #   JSON parsing fails, because the response is still likely useful.
+      def parse(body)
+        JSON.parse(body, :symbolize_names => true) unless body.nil?
+      rescue JSON::ParserError
+        body
+      end
+
+      def on_complete(env)
+        if respond_to?(:parse)
+          env[:body] = parse(env[:body]) unless [204, 301, 302, 304].include?(env[:status])
+        end
+      end
+
+    end
+  end
+end

data/lib/redditkit/response/raise_error.rb

@@ -0,0 +1,21 @@
+require 'faraday'
+require 'redditkit/error'
+
+module RedditKit
+
+  # Methods for handling responses from reddit.
+  module Response
+    class RaiseError < Faraday::Response::Middleware
+
+      def on_complete(env)
+        status_code = env[:status]
+        body = env[:body]
+
+        if error = RedditKit::Error.from_status_code_and_body(status_code, body)
+          raise error
+        end
+      end
+
+    end
+  end
+end

data/lib/redditkit/subreddit.rb

@@ -0,0 +1,86 @@
+require 'redditkit/thing'
+require 'redditkit/creatable'
+
+module RedditKit
+
+  # A class representing a subreddit.
+  class Subreddit < RedditKit::Thing
+    include RedditKit::Creatable
+
+    # The number of users currently active in the subreddit.
+    attr_reader :accounts_active
+
+    # The number of minutes comment scores are hidden for.
+    attr_reader :comment_score_hide_mins
+
+    # The description of the subreddit, in Markdown.
+    attr_reader :description
+
+    # The description of the subreddit, as HTML.
+    attr_reader :description_html
+
+    # The subreddit's display name. For reddit.com/r/programming, the display name is 'programming'.
+    attr_reader :display_name
+
+    # The URL to the subreddit's header image, if it has one.
+    attr_reader :header_img
+
+    # The size of the subreddit's header image, if it has one.
+    attr_reader :header_size
+
+    # The subreddit's header title.
+    attr_reader :header_title
+
+    # Whether the subreddit has been marked as having content directed at people over 18 years old.
+    attr_reader :over18
+
+    # The subreddit's public description.
+    attr_reader :public_description
+
+    # Whether the subreddit's traffic page is publicly visible.
+    attr_reader :public_traffic
+    attr_reader :spam_comments
+    attr_reader :spam_links
+    attr_reader :spam_selfpost
+    attr_reader :submission_type
+    attr_reader :submit_link_label
+    attr_reader :submit_text
+    attr_reader :submit_text_html
+    attr_reader :submit_text_label
+
+    # The subreddit's type, either 'public' or 'private'.
+    attr_reader :subreddit_type
+
+    # The number of subscribers to the subreddit.
+    attr_reader :subscribers
+
+    # The subreddit's title.
+    attr_reader :title
+
+    # The URL to the subreddit.
+    attr_reader :url
+
+    # Whether the current user is banned from the subreddit.
+    attr_reader :user_is_banned
+
+    # Whether the current user is a contributor to the subreddit.
+    attr_reader :user_is_contributor
+
+    # Whether the current user is a moderator of the subreddit.
+    attr_reader :user_is_moderator
+
+    # Whether the current user is a subscriber to the subreddit.
+    attr_reader :user_is_subscriber
+
+    alias banned? user_is_banned
+    alias comment_spam_filter_strength spam_comments
+    alias contributor? user_is_contributor
+    alias link_spam_filter_strength spam_links
+    alias moderator? user_is_moderator
+    alias name display_name
+    alias nsfw? over18
+    alias self_post_spam_filter_strength spam_selfpost
+    alias subscriber? user_is_subscriber
+
+  end
+end

data/lib/redditkit/thing.rb

@@ -0,0 +1,20 @@
+require 'redditkit/base'
+
+module RedditKit
+
+  # A base class for objects which have both a kind and an identifier.
+  class Thing < RedditKit::Base
+
+    attr_reader :id
+    attr_reader :kind
+
+    def ==(other)
+      full_name == other.full_name
+    end
+
+    # Returns the object's full name.
+    def full_name
+      @full_name ||= "#{kind}_#{id}"
+    end
+  end
+end

data/lib/redditkit/user.rb

@@ -0,0 +1,30 @@
+require 'redditkit/thing'
+require 'redditkit/creatable'
+
+module RedditKit
+
+  # A class representing a reddit user.
+  class User < RedditKit::Thing
+    include RedditKit::Creatable
+
+    attr_reader :name
+    attr_reader :comment_karma
+    attr_reader :link_karma
+    attr_reader :has_mail
+    attr_reader :has_mod_mail
+    attr_reader :has_verified_email
+    attr_reader :is_gold
+    attr_reader :is_friend
+    attr_reader :is_mod
+    attr_reader :over_18
+
+    alias friend? is_friend
+    alias gold? is_gold
+    alias mail? has_mail
+    alias mod? is_mod
+    alias mod_mail? has_mod_mail
+    alias over_18? over_18
+    alias username name
+    alias verified? has_verified_email
+  end
+end

data/lib/redditkit/version.rb

@@ -0,0 +1,19 @@
+module RedditKit
+
+  # A class for managing RedditKit's version number.
+  class Version
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 0
+
+    class << self
+
+      # Return RedditKit.rb's version number as a string.
+      def to_s
+        [MAJOR, MINOR, PATCH].join('.')
+      end
+
+    end
+
+  end
+end

data/lib/redditkit/votable.rb

@@ -0,0 +1,37 @@
+module RedditKit
+
+  # Methods which determine the voting status of objects.
+  module Votable
+    
+    # The number of upvotes an item has.
+    def upvotes
+      @attributes[:ups]
+    end
+
+    # The number of downvotes an item has.
+    def downvotes
+      @attributes[:downs]
+    end
+
+    # The score for an item.
+    def score
+      @attributes[:score]
+    end
+
+    # Whether the current user has upvoted this item.
+    def upvoted?
+      @attributes[:likes] == true
+    end
+
+    # Whether the current user has downvotes this item.
+    def downvoted?
+      @attributes[:likes] == false
+    end
+
+    # Whether the user has voted on this item (either upvoted or downvoted).
+    def voted?
+      !@attributes[:likes].nil? 
+    end
+
+  end
+end

data/redditkit.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redditkit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redditkit"
+  spec.version       = RedditKit::Version
+  spec.authors       = ["Sam Symons"]
+  spec.email         = ["samsymons@me.com"]
+  spec.description   = "A simple reddit API library, covering 100% of the reddit API."
+  spec.summary       = "A simple reddit API library."
+  spec.homepage      = "http://redditkit.com/"
+  spec.license       = "MIT"
+
+  spec.files = %w(LICENSE.md README.md Rakefile redditkit.gemspec)
+  spec.files += Dir.glob("lib/**/*.rb")
+  spec.files += Dir.glob("spec/**/*")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday', "~> 0.8"
+  spec.add_development_dependency 'dotenv'
+end

data/spec/cassettes/RedditKit_Client/should_raise_an_error_with_invalid_credentials.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://ssl.reddit.com/api/login
+    body:
+      encoding: US-ASCII
+      string: user=samsymons&passwd=hunter2&api_type=json
+    headers:
+      User-Agent:
+      - Faraday v0.8.8
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sun, 10 Nov 2013 22:21:42 GMT
+      Connection:
+      - close
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '72'
+      Server:
+      - "'; DROP TABLE servertypes; --"
+    body:
+      encoding: UTF-8
+      string: "{\"json\": {\"errors\": [[\"WRONG_PASSWORD\", \"invalid password\",
+        \"passwd\"]]}}"
+    http_version: 
+  recorded_at: Sun, 10 Nov 2013 22:21:41 GMT
+recorded_with: VCR 2.6.0

data/spec/cassettes/RedditKit_Client_Account/_sign_in/signs_the_user_in.yml

@@ -0,0 +1,132 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://ssl.reddit.com/api/login
+    body:
+      encoding: US-ASCII
+      string: user=<REDDIT_USERNAME>&passwd=<REDDIT_USERNAME>Password&api_type=json
+    headers:
+      User-Agent:
+      - Faraday v0.8.8
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sun, 10 Nov 2013 19:36:01 GMT
+      Connection:
+      - close
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '182'
+      Set-Cookie:
+      - reddit_session=20332937%2C2013-11-10T11%3A36%3A01%2C3a94801911c4cba77d627c03ef1728c0b9452267;
+        Domain=reddit.com; Path=/; HttpOnly
+      Server:
+      - "'; DROP TABLE servertypes; --"
+    body:
+      encoding: UTF-8
+      string: "{\"json\": {\"errors\": [], \"data\": {\"modhash\": \"4a8hmswyon7999c6fc14c9b9882324382339cfb661896efda8\",
+        \"cookie\": \"20332937,2013-11-10T11:36:01,3a94801911c4cba77d627c03ef1728c0b9452267\"}}}"
+    http_version: 
+  recorded_at: Sun, 10 Nov 2013 19:35:59 GMT
+- request:
+    method: get
+    uri: http://www.reddit.com/user/<REDDIT_USERNAME>/about.json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.8
+      Cookie:
+      - reddit_session=20332937,2013-11-10T11:36:01,3a94801911c4cba77d627c03ef1728c0b9452267
+      X-Modhash:
+      - 4a8hmswyon7999c6fc14c9b9882324382339cfb661896efda8
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '362'
+      Cache-Control:
+      - no-cache
+      Pragma:
+      - no-cache
+      Server:
+      - "'; DROP TABLE servertypes; --"
+      Date:
+      - Sun, 10 Nov 2013 19:36:01 GMT
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: "{\"kind\": \"t2\", \"data\": {\"has_mail\": false, \"name\": \"<REDDIT_USERNAME>\",
+        \"is_friend\": false, \"created\": 1371758712.0, \"modhash\": \"qnb8yblbase93a673767165f25ce13096d6d0acc3deed51118\",
+        \"created_utc\": 1371755112.0, \"link_karma\": 1, \"comment_karma\": 0, \"over_18\":
+        true, \"is_gold\": false, \"is_mod\": true, \"has_verified_email\": null,
+        \"id\": \"c3szt\", \"has_mod_mail\": true}}"
+    http_version: 
+  recorded_at: Sun, 10 Nov 2013 19:35:59 GMT
+- request:
+    method: get
+    uri: http://www.reddit.com/api/me.json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.8
+      Cookie:
+      - reddit_session=20332937,2013-11-10T11:36:01,3a94801911c4cba77d627c03ef1728c0b9452267
+      X-Modhash:
+      - 4a8hmswyon7999c6fc14c9b9882324382339cfb661896efda8
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '362'
+      Cache-Control:
+      - no-cache
+      Pragma:
+      - no-cache
+      Server:
+      - "'; DROP TABLE servertypes; --"
+      Date:
+      - Sun, 10 Nov 2013 19:36:01 GMT
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: "{\"kind\": \"t2\", \"data\": {\"has_mail\": false, \"name\": \"<REDDIT_USERNAME>\",
+        \"is_friend\": false, \"created\": 1371758712.0, \"modhash\": \"3ctrgpd6g5dd6a9bbd57786bcd7eadc9848307bdd9234f141e\",
+        \"created_utc\": 1371755112.0, \"link_karma\": 1, \"comment_karma\": 0, \"over_18\":
+        true, \"is_gold\": false, \"is_mod\": true, \"has_verified_email\": null,
+        \"id\": \"c3szt\", \"has_mod_mail\": true}}"
+    http_version: 
+  recorded_at: Sun, 10 Nov 2013 19:36:00 GMT
+recorded_with: VCR 2.6.0