redd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eefcb4605d95ff4dd74d15293cfc83ad525d1c6a
+  data.tar.gz: f9f7689a053500c5d0021edf35476cbd019b0ca2
+SHA512:
+  metadata.gz: 5b1ce4746c616835b1115000c04685f8f24b009a79e26857f60d0bce2f50c3a53078d0ec5f46dc28819bc92dd46d4d645899901219a80fdf8556e2d03cc376ca
+  data.tar.gz: 6ab5345939dae63c5cc132a5ca9b91efb331c55c3a7e137659306094ce2ffbe7ceb150df490e688f06484f062e2f614395797384e96cef64473c38099429f700

data/.gitignore

@@ -0,0 +1,38 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Working on Codio!
+# Seriously, it's free and it's awesome.
+.codio
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,5 @@
+StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - ruby-head
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+  - rbx
+before_install:
+  - gem update bundler

data/.yardopts

@@ -0,0 +1 @@
+--private

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in redd.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Avinash Dwarapu
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,10 @@
+<p align="center">
+  <img src="github/redd.png?raw=true" alt="redd"><br>
+</p>
+
+**redd** is an API wrapper for [reddit](http://reddit.com/dev/api) written in ruby that focuses on being *simple and extensible*.  
+**NOTE: Major features are not implemented yet!**
+
+---
+
+## 

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+require "yard"
+
+RSpec::Core::RakeTask.new
+RuboCop::RakeTask.new
+YARD::Rake::YardocTask.new
+
+task default: [:spec, :rubocop, :yard]

data/lib/redd.rb

@@ -0,0 +1,14 @@
+require "redd/client/unauthenticated"
+require "redd/client/authenticated"
+require "redd/client/oauth2"
+
+module Redd
+  def self.client(username = nil, password = nil)
+    client = Redd::Client::Unauthenticated.new
+    if username.nil? || password.nil?
+      client
+    else
+      client.login(username, password)
+    end
+  end
+end

data/lib/redd/RedditKit.LICENSE.md

@@ -0,0 +1,13 @@
+The errors file would have been impossible if it weren't for @samsymons :)
+
+---
+
+Copyright (c) 2013 Sam Symons
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/redd/base.rb

@@ -0,0 +1,35 @@
+require "memoizable"
+
+module Redd
+  # A container for various models with attributes and a client.
+  class Base
+    include Memoizable
+
+    # @!attribute [r] attributes
+    # @return [Hash] A list of attributes returned by reddit for this object.
+    attr_reader :attributes
+    alias_method :to_h, :attributes
+
+    # @!attribute [r] client
+    # @return The client instance used to make requests with this object.
+    attr_reader :client
+
+    # Define and memoize the method that returns a key from the
+    # attributes hash.
+    # @param [Symbol, String] key The key to construct a method out of.
+    # @param [Symbol] attribute The attribute in the given hash to return.
+    def self.attr_reader(key, attribute = key)
+      define_method(key) { @attributes[attribute] }
+      memoize(key)
+    end
+
+    # @param client The client to use when making requests with this object.
+    #   This is similar to reddit_session in praw.
+    # @param [Hash] attributes
+    def initialize(client, attributes)
+      @client = client
+      @attributes = attributes[:data]
+      @attributes[:kind] = attributes[:kind]
+    end
+  end
+end

data/lib/redd/client/authenticated.rb

@@ -0,0 +1,88 @@
+module Redd
+  module Client
+    # The class that handles requests when authenticated using a username and
+    # password.
+    class Authenticated < Redd::Client::Unauthenticated
+      require "redd/client/authenticated/account"
+      require "redd/client/authenticated/apps"
+      require "redd/client/authenticated/flair"
+      require "redd/client/authenticated/gold"
+      require "redd/client/authenticated/links_comments"
+      require "redd/client/authenticated/live"
+      require "redd/client/authenticated/moderation"
+      require "redd/client/authenticated/multis"
+      require "redd/client/authenticated/private_messages"
+      require "redd/client/authenticated/subreddits"
+      require "redd/client/authenticated/users"
+      require "redd/client/authenticated/wiki"
+
+      include Redd::Client::Authenticated::Account
+      include Redd::Client::Authenticated::Apps
+      include Redd::Client::Authenticated::Flair
+      include Redd::Client::Authenticated::Gold
+      include Redd::Client::Authenticated::LinksComments
+      include Redd::Client::Authenticated::Live
+      include Redd::Client::Authenticated::Moderation
+      include Redd::Client::Authenticated::Multis
+      include Redd::Client::Authenticated::PrivateMessages
+      include Redd::Client::Authenticated::Subreddits
+      include Redd::Client::Authenticated::Users
+      include Redd::Client::Authenticated::Wiki
+
+      # @!attribute [r] username
+      # 	@return [String] The username of the logged-in user.
+      attr_reader :username
+
+      # @!attribute [r] cookie
+      # 	@return [String] The cookie used to store the current session.
+      attr_reader :cookie
+
+      # @!attribute [r] modhash
+      # 	@return [String] The returned modhash used when making requests.
+      attr_reader :modhash
+
+      # @!attribute [rw] auth_endpoint
+      #   @return [String] The site to connect to authenticate with.
+      attr_accessor :auth_endpoint
+
+      # Set up an authenticated connection to reddit.
+      #
+      # @param [String] cookie The cookie to use when sending a request.
+      # @param [String] modhash The modhash to use when sending a request.
+      # @param [Hash] options A hash of options to connect using.
+      # @option options [String] :user_agent The User-Agent string to use in the
+      #   header of every request.
+      # @option options [String] :api_endpoint The main domain to connect to, in
+      #   this case, the URL for reddit.
+      # @option options [String] :auth_endpoint The domain to login with, in
+      #   this case, the ssl subdomain using https.
+      def initialize(cookie, modhash, options = {})
+        @cookie = cookie
+        @modhash = modhash
+
+        @rate_limit = options[:rate_limit] || Redd::RateLimit.new
+        @user_agent = options[:user_agent] || "Redd/Ruby, v#{Redd::VERSION}"
+        @api_endpoint = options[:api_endpoint] || "http://www.reddit.com/"
+        @auth_endpoint = options[:auth_endpoint] || "https://ssl.reddit.com/"
+      end
+
+      private
+
+      # Gets the Faraday connection or creates one if it doesn't exist yet.
+      #
+      # @return [Faraday] A new Faraday connection.
+      def connection
+        @connection ||= Faraday.new(url: api_endpoint) do |faraday|
+          faraday.use Faraday::Request::UrlEncoded
+          faraday.use Redd::Response::ParseJson
+          faraday.use Redd::Response::RaiseError
+          faraday.adapter Faraday.default_adapter
+
+          faraday.headers["User-Agent"] = user_agent
+          faraday.headers["Cookie"] = "reddit_session=#{cookie}"
+          faraday.headers["X-Modhash"] = modhash
+        end
+      end
+    end
+  end
+end

data/lib/redd/client/authenticated/account.rb

@@ -0,0 +1,9 @@
+module Redd
+  module Client
+  	class Authenticated
+      module Accounts
+        
+      end
+    end
+  end
+end

data/lib/redd/client/authenticated/apps.rb

@@ -0,0 +1,12 @@
+module Redd
+  module Client
+  	class Authenticated
+      module Apps
+        # Low-Priority
+        #
+        # There should be very little reasons for bots to mess around with app
+        # settings, so this module might be worked on later or not at all.
+      end
+    end
+  end
+end

data/lib/redd/client/authenticated/flair.rb

@@ -0,0 +1,9 @@
+module Redd
+  module Client
+  	class Authenticated
+      module Flair
+        
+      end
+    end
+  end
+end

data/lib/redd/client/authenticated/gold.rb

@@ -0,0 +1,12 @@
+module Redd
+  module Client
+  	class Authenticated
+      module Gold
+        # Low-Priority
+        #
+        # Yeeaahh... Handing conrol of spending money to some code is pretty
+        # stupid. This might not be developed.
+      end
+    end
+  end
+end

data/lib/redd/client/authenticated/links_comments.rb

@@ -0,0 +1,9 @@
+module Redd
+  module Client
+  	class Authenticated
+      module LinksComments
+				
+      end
+    end
+  end
+end

data/lib/redd/client/authenticated/live.rb

@@ -0,0 +1,12 @@
+module Redd
+  module Client
+  	class Authenticated
+      module Live
+				# Low-priority
+				#
+        # When was this a thing? Let's just hope this doesn't become popular
+        # that quickly before I get to it.
+      end
+    end
+  end
+end

data/lib/redd/client/authenticated/moderation.rb

@@ -0,0 +1,9 @@
+module Redd
+  module Client
+  	class Authenticated
+      module Moderation
+				
+      end
+    end
+  end
+end

data/lib/redd/client/authenticated/multis.rb

@@ -0,0 +1,9 @@
+module Redd
+  module Client
+  	class Authenticated
+      module Multis
+				
+      end
+    end
+  end
+end

data/lib/redd/client/authenticated/private_messages.rb

@@ -0,0 +1,40 @@
+module Redd
+  module Client
+  	class Authenticated
+      module PrivateMessages
+        def block_message(message)
+          fullname = extract_fullname(message)
+          send(:post, "/api/block", id: fullname)
+        end
+
+        def compose_message(to, subject, text, captcha = nil, identifier = nil)
+          meth = :post
+          path = "/api/compose"
+          params = {
+            api_type: "json", to: to.to_s, subject: subject, text: text
+          }
+          params << {captcha: captcha, iden: identifier} if captcha
+
+          send(meth, path, params)
+        end
+
+        def mark_as_read(message)
+          fullname = extract_fullname(message)
+          send(:post, "/api/read_message", id: fullname)
+        end
+
+        def mark_as_unread(message)
+          fullname = extract_fullname(message)
+          send(:post, "/api/unread_message", id: fullname)
+        end
+
+        def messages(category = "inbox", params = {})
+          meth = :get
+          path = "/message/#{category}.json"
+
+          object_from_response(meth, path, params)
+        end
+      end
+    end
+  end
+end

data/lib/redd/client/authenticated/subreddits.rb

@@ -0,0 +1,9 @@
+module Redd
+  module Client
+  	class Authenticated
+      module Subreddits
+				
+      end
+    end
+  end
+end

data/lib/redd/client/authenticated/users.rb

@@ -0,0 +1,9 @@
+module Redd
+  module Client
+  	class Authenticated
+      module Users
+				
+      end
+    end
+  end
+end