snoo 0.0.1

data/lib/snoo/users.rb

@@ -0,0 +1,60 @@
+module Snoo
+  # Methods for interacting with users, such as adding and removing friends, getting user info, etc
+  #
+  # @author (see Snoo)
+  module User
+
+    # Friend a user
+    #
+    # @param name [String] The username to target
+    # @param note [String] A friend tag. Requires reddit gold.
+    # @return (see #clear_sessions)
+    def friend name, friend_id, note = nil
+      friend_wrapper(api_name = name, api_container = @userid, api_note = note, api_type = "friend")
+    end
+
+    # Unfriend a user
+    #
+    # @param id [String] The friend id to remove. Must be in t2_id form
+    # @return (see #clear_sessions)
+    def unfriend id
+      unfriend_wrapper api_id = id, api_container = @userid, api_type = "friend"
+    end
+
+    # Get a list of friends
+    #
+    # @return (see #clear_sessions)
+    def get_friends
+      logged_in?
+      get('/prefs/friends.json')
+    end
+
+    # Get info about a user account
+    #
+    # @param username [String] The username to target.
+    def get_user_info username
+      get("/user/#{username}/about.json")
+    end
+
+    # Get a listing of user posts. Some options may be restricted
+    #
+    # @param (see #get_user_info)
+    # @param (see LinksComments#info)
+    # @option opts [overview, submitted, comments, liked, disliked, hidden, saved] :type Type of post to return. Most users only allow the first 3 types.
+    # @option opts [new, hot, top, controversial] :sort The sort order
+    # @option opts [String] :after Return things *after* this id
+    # @option opts [String] :before Return things *before* this id
+    # @option opts [1..100] :limit Number of results to return
+    # @return (see #clear_sessions)
+    def get_user_listing username, opts = {}
+      raise ArgumentError, "type is invalid" unless %w{overview submitted commented liked disliked hidden saved}.include?(opts[:type]) or opts[:type].nil?
+      raise ArgumentError, "sort is invalid" unless %w{new hot top controversial}.include?(opts[:sort]) or opts[:type].nil?
+      raise ArgumentError, "limit must be within 1..100; is #{opts[:limit]}" unless (1..100).include?(opts[:limit]) or opts[:limit].nil?
+      opts[:type] = 'overview' if opts[:type].nil?
+      url = "/user/%s%s.json" % [username, ('/' + opts[:type] if opts[:type] != 'overview')]
+      opts.delete :type
+      query = opts
+      get(url, query: query)
+    end
+  end
+end

data/lib/snoo/utilities.rb

@@ -0,0 +1,73 @@
+module Snoo
+  # Utility functions.
+  # These are all private
+  #
+  # @author (see Snoo)
+  module Utilities
+    private
+      # HTTParty get wrapper. This serves to clean up code, as well as throw webserver errors wherever needed
+      #
+      def get *args, &block
+        response = self.class.get *args, &block
+        raise WebserverError, response.code unless response.code == 200
+        response
+      end
+
+      # HTTParty POST wrapper. This serves to clean up code, as well as throw webserver errors wherever needed, same as {#get}
+      #
+      def post *args, &block
+        response = self.class.post *args, &block
+        raise WebserverError, response.code unless response.code == 200
+        response
+      end
+      # Set the cookie header and instance variable
+      #
+      # @param cookie [String] The cookie text, as show in a 'set-cookie' header
+      def cookies cookie
+        @cookie = cookie
+        self.class.headers 'Cookie' => cookie
+      end
+
+      # Raises an error if we aren't currently logged in
+      #
+      def logged_in?
+        raise NotAuthenticated if @cookie.nil? or @modhash.nil?
+      end
+
+      # Posts to '/api/friend'. This method exists because there are tons of things that use this
+      #
+      # @param api_type [friend, moderator, contributor, banned] Type of action to use. All but friend target subreddits
+      # @param api_container [String] Thing ID, either subreddit (t5_) or user adding friend (t2_)
+      # @param api_name [String] Username to add
+      # @param api_note [String] Note to leave. Requires reddit gold
+      # @param api_subreddit [String] Subreddit name
+      # @return [HTTParty::Response] The response object.
+      def friend_wrapper api_type, api_container = nil, api_name = nil, api_note = nil, api_subreddit = nil
+        logged_in?
+        params = {type: api_type, uh: @modhash}
+        params[:container] = api_container if api_container
+        params[:name] = api_name if api_name
+        params[:note] = api_note if api_note
+        params[:r] = api_subreddit if api_subreddit
+        post('/api/friend', body: params)
+      end
+
+      # Posts to '/api/unfriend'. This method exists because there are a ton of things that use this.
+      #
+      # @param api_type [friend, enemy, moderator, contributor, banned] Type of removal
+      # @param api_container [String] Thing ID, either subreddit (t5_) or user adding friend (t2_)
+      # @param api_name [String] User name
+      # @param api_id [String] User ID of user being removed
+      # @param api_subreddit [String] Subreddit name
+      # @return (see #friend_wrapper)
+      def unfriend_wrapper api_type, api_container = nil, api_name = nil, api_id = nil, api_subreddit = nil
+        logged_in?
+        params = { type: api_type, uh: @modhash}
+        params[:container] = api_container if api_container
+        params[:name] = api_name if api_name
+        params[:id] = api_id if api_id
+        params[:r] = api_subreddit if api_subreddit
+        post('/api/unfriend', body: params)
+      end
+  end
+end

data/lib/snoo/version.rb

@@ -0,0 +1,4 @@
+module Snoo
+  # The version string (duh)
+  VERSION = "0.0.1"
+end

data/snoo.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/snoo/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jeff Sandberg"]
+  gem.email         = ["paradox460@gmail.com"]
+  gem.description   = %q{Snoo is yet another reddit API wrapper. Unlike the other wrappers out there, this one strives to be an almost exact clone of the reddit api, however, it also makes many attempts to be easier to use. You won't be instantiating Snoo::Comment or anything like that. Just one instantiation, and you can do everything from there.}
+  gem.summary       = %q{A simple reddit api wrapper}
+  gem.homepage      = "https://github.com/paradox460/snoo"
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "snoo"
+  gem.require_paths = ["lib"]
+  gem.version       = Snoo::VERSION
+  gem.required_ruby_version = '>= 1.9'
+  gem.license       = 'MIT'
+
+  ['httparty'].each do |dependency|
+    gem.add_runtime_dependency dependency
+  end
+  ['rspec'].each do |dependency|
+    gem.add_development_dependency dependency
+  end
+end

data/spec/auth.rb

@@ -0,0 +1,6 @@
+# Test user account
+$testuser = ''
+# Test password
+$testpass = ''
+# Test subreddit (test account should have mod)
+$testreddit = ''

data/spec/snoo_spec.rb

@@ -0,0 +1,164 @@
+require 'snoo'
+require_relative 'auth'
+
+describe Snoo::Client do
+  before :all do
+      @client = Snoo::Client.new
+      @client.log_in $testuser, $testpass
+  end
+
+  describe "#new" do
+    after :each do
+      sleep 2
+    end
+    it "Creates a new Snoo::Client object" do
+      Snoo::Client.new.should be_an_instance_of(Snoo::Client)
+    end
+    it "Creates an unauthorized Snoo::Client" do
+      client = Snoo::Client.new
+      client.modhash.should be_nil
+      client.username.should be_nil
+      client.userid.should be_nil
+      client.cookie.should be_nil
+    end
+  end
+
+  describe "Account" do
+    after :each do
+      sleep 2
+    end
+
+    # Due to the constraints the reddit API provides us, we only log in once, and then use it as much as we can.
+    describe "#log_in" do
+      it "logs in and ensures all the instance variables are set" do
+        @client.modhash.should_not be_nil
+        @client.userid.should_not be_nil
+        @client.username.should_not be_nil
+        @client.cookie.should_not be_nil
+      end
+    end
+
+    describe "#clear_sessions" do
+      it "clears other sessions and looks for 'all other sessions have been cleared' from the server" do
+        response = @client.clear_sessions $testpass
+        response['jquery'][14][3][0].should eq"all other sessions have been logged out"
+      end
+    end
+
+    describe "#me" do
+      it "gets info about currently logged in user, and makes sure this matches $testuser" do
+        me = @client.me
+        me['data']['name'].should eq $testuser
+      end
+    end
+  end
+
+  describe "Flair" do
+    after :each  do
+      sleep 2
+    end
+    describe "#clear_flair_templates" do
+      after :each do
+        sleep 2
+      end
+      it "clears user flair templates" do
+        @client.clear_flair_templates('USER_FLAIR', $testreddit).code.should eq 200
+      end
+      it "clears link flair templates" do
+        @client.clear_flair_templates('LINK_FLAIR', $testreddit).code.should eq 200
+      end
+    end
+
+    describe "#flair" do
+      it "sets user flair on this user" do
+        flair = @client.flair $testreddit, css_class: "test", text: "test", name: $testuser
+        flair.code.should eq 200
+      end
+    end
+
+    describe "#delete_user_flair" do
+      it "deletes user flair from this user" do
+        @client.delete_user_flair($testuser, $testreddit).code.should eq 200
+      end
+    end
+
+    describe "#get_flair_list" do
+      it "should get a list of flair" do
+        @client.get_flair_list($testreddit).code.should eq 200
+      end
+    end
+  end
+
+  describe "Listings" do
+    after :each do
+      sleep 2
+    end
+    describe "#get_listing" do
+      it "gets a listing of links from reddit" do
+        listing = @client.get_listing subreddit: $testreddit
+        listing.code.should eq 200
+      end
+    end
+    describe "#search" do
+      it "searches reddit for 'test'" do
+        search = @client.search 'test'
+        search.code.should eq 200
+      end
+    end
+  end
+
+  describe "Private Messages" do
+    after :each do
+      sleep 2
+    end
+    describe "#send_pm" do
+      it "should send a private message to current user" do
+        send = @client.send_pm $testuser, 'test', 'testing'
+        send.code.should eq 200
+      end
+    end
+    describe "#get_messages" do
+      it "should get a list of private messages" do
+        messages = @client.get_messages
+        messages.code.should eq 200
+      end
+    end
+  end
+
+  describe "User" do
+    after :each do
+      sleep 2
+    end
+
+    describe "#get_friends" do
+      it "should get a list of friends" do
+        friends = @client.get_friends
+        friends.code.should eq 200
+      end
+    end
+
+    describe "#get_user_info" do
+      it "should get information about the current user account" do
+        info = @client.get_user_info $testuser
+        info.code.should eq 200
+      end
+    end
+
+    describe "#get_user_listing" do
+      it "should get a listing of user's posts" do
+        listing = @client.get_user_listing $testuser
+        listing.code.should eq 200
+      end
+    end
+  end
+
+  describe "#log_out" do
+    it "logs out and sets instance variables to nil" do
+      @client.log_out
+      @client.modhash.should be_nil
+      @client.userid.should be_nil
+      @client.username.should be_nil
+      @client.cookie.should be_nil
+    end
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: snoo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jeff Sandberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Snoo is yet another reddit API wrapper. Unlike the other wrappers out
+  there, this one strives to be an almost exact clone of the reddit api, however,
+  it also makes many attempts to be easier to use. You won't be instantiating Snoo::Comment
+  or anything like that. Just one instantiation, and you can do everything from there.
+email:
+- paradox460@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .yardopts
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/snoo.rb
+- lib/snoo/account.rb
+- lib/snoo/exceptions.rb
+- lib/snoo/flair.rb
+- lib/snoo/links_comments.rb
+- lib/snoo/listings.rb
+- lib/snoo/moderation.rb
+- lib/snoo/pms.rb
+- lib/snoo/subreddits.rb
+- lib/snoo/users.rb
+- lib/snoo/utilities.rb
+- lib/snoo/version.rb
+- snoo.gemspec
+- spec/auth.rb
+- spec/snoo_spec.rb
+homepage: https://github.com/paradox460/snoo
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A simple reddit api wrapper
+test_files:
+- spec/auth.rb
+- spec/snoo_spec.rb
+has_rdoc: