redd 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68ca6da5f545b524f8b03e08e6b493b3df260202
-  data.tar.gz: 6358bd923e9c302160b7f4a9bb095d4691741d8b
+  metadata.gz: d85e07d35f21832e40d2a17c6063d758b2051171
+  data.tar.gz: d91adb52b18dd74a382369e5ff57384f27bc9cae
 SHA512:
-  metadata.gz: 8bb2902ebe6c5e959e24fc8ba672be642acd35c90667ba3a35023e5fa69ec8336e3f51d6489133e9417377417012879f5954fe405580c17a422a5542bfee7adc
-  data.tar.gz: c7f7c8816778a0c26aa7a49a8ffc514a64dcb22d3e1bb755856cbedb1888e7d6ee3946a0b396167328d090328f90dfbc9e290aa797145d110d7b4e6f42260326
+  metadata.gz: b1330d62998349feaa50b8a9266ba295145dfe0d633b290f77ecf72a5eadaba36733467d2e9c5138bc89fa9f7043b6616d28408384ce67832ca43db3500750d2
+  data.tar.gz: 64b1c5d48b6e8c34e4fa6eb0b28465766240955966d4ef5e4235276dce8d791f0a78cbc83109b8565e4a430e082394ee83902063e2ebb3a895af8489348e78db

data/.rspec

@@ -1,2 +1,4 @@
 --color
---format documentation
+--warnings
+--format documentation
+--require spec_helper

data/README.md

@@ -66,7 +66,7 @@ Ruby and redd make creating reddit bots accessible and fun. To demonstrate, let'
      time_left = e.time
      sleep(time_left)
    rescue Redd::Error => e
-     status = e.message.status
+     status = e.code
      # 5-something errors are usually errors on reddit's end.
      raise e unless (500...600).include?(status)
    end

data/lib/redd/client/authenticated.rb

@@ -45,6 +45,10 @@ module Redd
       # @return [String] The site to connect to authenticate with.
       attr_accessor :auth_endpoint
 
+      def self.new_from_credentials(username, password, options = {})
+        Redd::Client::Unauthenticated.new.login(username, password, options)
+      end
+
       # Set up an authenticated connection to reddit.
       #
       # @param [String] cookie The cookie to use when sending a request.
@@ -68,20 +72,13 @@ module Redd
 
       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::RaiseError
-          faraday.use Redd::Response::ParseJson
-          faraday.adapter Faraday.default_adapter
-
-          faraday.headers["User-Agent"] = user_agent
-          faraday.headers["Cookie"] = "reddit_session=#{cookie}"
-          faraday.headers["X-Modhash"] = modhash
-        end
+      # @return [Hash] The headers that are sent with every request.
+      def headers
+        @headers ||= {
+          "User-Agent" => @user_agent,
+          "Cookie" => "reddit_session=#{@cookie}",
+          "X-Modhash" => @modhash
+        }
       end
     end
   end

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

@@ -2,23 +2,42 @@ module Redd
   module Client
     class Authenticated
       module Flair
-        def get_flair_list(subreddit = nil, params = {})
-          name = extract_attribute(subreddit, :display_name) if subreddit
+        def get_flair_list(subreddit, params = {})
+          name = extract_attribute(subreddit, :display_name)
 
           path = "/api/flairlist.json"
-          path = path.prepend("/r/#{name}") if name
+          path = path.prepend("/r/#{name}")
 
           get(path, params)[:users]
         end
 
         # @see http://ruby-doc.org/core-1.9.3/String.html#method-i-casecmp
-        def get_flair(user, subreddit = nil)
+        def get_flair(subreddit, user)
           username = extract_attribute(user, :name)
           options = {name: username}
 
           flair = get_flair_list(subreddit, options).first
           flair if flair[:user].casecmp(username.downcase) == 0
         end
+
+        def set_flair(subreddit, user_or_link, text = "", css_class = "")
+          name = extract_attribute(subreddit, :display_name)
+
+          path = "/api/flair"
+          path = path.prepend("/r/#{name}")
+          params = {api_type: "json", text: text, css_class: css_class}
+
+          case user_or_link
+          when Redd::Object::User
+            params[:name] = extract_attribute(user_or_link, :name)
+          when Redd::Object::Submission
+            params[:link] = extract_attribute(user_or_link, :display_name)
+          else
+            fail "You should provide a User or Submission object."
+          end
+
+          post path, params
+        end
       end
     end
   end

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

@@ -2,8 +2,34 @@ module Redd
   module Client
     class Authenticated
       module LinksComments
+        def submit(
+          title, kind, text_or_url, captcha = nil, identifier = nil,
+          options = {}
+        )
+          # Set required parameters
+          params = {
+            api_type: "json", extension: "json", title: title, kind: kind
+          }
+
+          # Set url or selftext depending on kind
+          case kind.to_sym
+          when :self
+            params[:text] = text_or_url
+          when :link
+            params[:url] = text_or_url
+          end
+
+          # Optional captcha
+          params << {captcha: captcha, iden: identifier} if captcha
+
+          # Fill in the rest of the options
+          params << options
+
+          post "/api/submit", params
+        end
+
         # @todo return the edited object.
-        def add_comment(thing, text, return_element = true)
+        def add_comment(thing, text)
           fullname = extract_fullname(thing)
           post "/api/comment", api_type: "json", text: text, thing_id: fullname
         end

data/lib/redd/client/unauthenticated.rb

@@ -57,6 +57,11 @@ module Redd
 
       private
 
+      # @return [Hash] The headers that are sent with every request.
+      def headers
+        @headers ||= {"User-Agent" => @user_agent}
+      end
+
       # Gets the Faraday connection or creates one if it doesn't exist yet.
       #
       # @return [Faraday] A new Faraday connection.
@@ -67,7 +72,7 @@ module Redd
           faraday.use Redd::Response::ParseJson
           faraday.adapter Faraday.default_adapter
 
-          faraday.headers["User-Agent"] = user_agent
+          faraday.headers = headers
         end
       end
 

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

@@ -2,18 +2,15 @@ module Redd
   module Client
     class Unauthenticated
       module Account
-        def login(username, password, remember = false)
-          meth = :post
-          path = "/api/login"
-          params = {
-            
-          }
+        def login(username, password, remember = false, options = {})
           response = post "/api/login",
             api_type: "json", user: username, passwd: password, rem: remember
           data = response[:json][:data]
 
           require "redd/client/authenticated"
-          Redd::Client::Authenticated.new(data[:cookie], data[:modhash])
+          Redd::Client::Authenticated.new(
+            data[:cookie], data[:modhash], options
+          )
         end
       end
     end

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

@@ -5,10 +5,10 @@ module Redd
         # @note Reddit does accept a subreddit, but with fullnames and urls, I
         #   assumed that was unnecessary.
         def get_info(params = {})
-          object_from_response :get, "/api/info.json"
+          object_from_response :get, "/api/info.json", params
         end
 
-        def get_comments(submission)
+        def submission_comments(submission)
           id = extract_id(submission)
           comments_from_response :get, "/comments/#{id}.json"
         end
@@ -19,24 +19,36 @@ module Redd
           object_from_body(replies)
         end
 
-        # FIX THIS ASAP
-        def replace_morecomments(morecomments)
+        def replace_morecomments(morecomments, submission = nil)
           parent_id = morecomments.parent_id
-          link_id = 
-            if parent_id.start_with?("t1_")
-              get_info(id: parent_id).first.link_id
+          link_id =
+            if submission
+              submission
             elsif parent_id.start_with?("t3_")
               parent_id
+            elsif parent_id.start_with?("t1_")
+              get_info(id: parent_id).first.link_id
             end
 
-          meth = :post
-          path = "/api/morechildren"
-          params = {
-            api_type: "json", link_id: link_id,
-            children: morecomments.children.join(",")
-          }
+          response = post "/api/morechildren", api_type: "json",
+            link_id: link_id, children: morecomments.children.join(",")
+          comments = response[:json][:data][:things]
+
+          # No idea how to increase the depth of the comments.
+          comments.select! { |comment| comment[:kind] == "t1" }
 
-          send(meth, path, params)
+          comments.map do |comment|
+            object_from_body(
+              kind: comment[:kind],
+              data: {
+                parent_id: comment[:data][:parent],
+                body: comment[:data][:contentText],
+                body_html: comment[:data][:contentHTML],
+                link_id: comment[:data][:link],
+                name: comment[:data][:id]
+              }
+            )
+          end
         end
       end
     end

data/lib/redd/client/unauthenticated/utilities.rb

@@ -6,6 +6,7 @@ require "redd/object/private_message"
 require "redd/object/submission"
 require "redd/object/subreddit"
 require "redd/object/user"
+require "redd/object/wiki_page"
 
 module Redd
   module Client
@@ -65,6 +66,8 @@ module Redd
             Redd::Object::PrivateMessage
           when "t5"
             Redd::Object::Subreddit
+          when "wikipage"
+            Redd::Object::WikiPage
           else
             Redd::Thing
           end

data/lib/redd/client/unauthenticated/wiki.rb

@@ -2,7 +2,17 @@ module Redd
   module Client
     class Unauthenticated
       module Wiki
-        
+        def get_wikipages(subreddit = nil)
+          path = "/wiki/pages.json"
+          path.prepend("/r/#{subreddit}") if subreddit
+          get(path)[:data]
+        end
+
+        def wikipage(page, subreddit = nil, params = {})
+          path = "/wiki/#{page}.json"
+          path.prepend("/r/#{subreddit}") if subreddit
+          object_from_response :get, path, params
+        end
       end
     end
   end

data/lib/redd/error.rb

@@ -1,5 +1,16 @@
 module Redd
   class Error < StandardError
+
+    attr_reader :code
+    attr_reader :headers
+    attr_reader :body
+
+    def initialize(env)
+      @code = env.status
+      @headers = env.response_headers
+      @body = env.body
+    end
+
     class << self
       # @note I ripped off RedditKit.rb :|
       def from_response(response) # rubocop:disable Style/CyclomaticComplexity Style/MethodLength
@@ -80,7 +91,11 @@ module Redd
 
     class RateLimited < Error
       attr_reader :time
-      def initialize(time = 0)
+
+      def initialize(env, time)
+        @code = env.status
+        @headers = env.response_headers
+        @body = env.body
         @time = time
       end
     end

data/lib/redd/object/submission.rb

@@ -53,7 +53,7 @@ module Redd
       end
 
       def comments
-        @comments ||= client.get_comments(id)
+        @comments ||= client.submission_comments(id)
       end
 
       def created

data/lib/redd/object/unauthenticated.rb

@@ -0,0 +1,116 @@
+require "faraday"
+require "redd/version"
+require "redd/rate_limit"
+require "redd/response/parse_json"
+require "redd/response/raise_error"
+
+module Redd
+  module Client
+    # The Client used to connect without needing login credentials.
+    class Unauthenticated
+      require "redd/client/unauthenticated/account"
+      require "redd/client/unauthenticated/captcha"
+      require "redd/client/unauthenticated/links_comments"
+      require "redd/client/unauthenticated/listing"
+      require "redd/client/unauthenticated/live"
+      require "redd/client/unauthenticated/moderation"
+      require "redd/client/unauthenticated/subreddits"
+      require "redd/client/unauthenticated/utilities"
+      require "redd/client/unauthenticated/wiki"
+
+      include Redd::Client::Unauthenticated::Account
+      include Redd::Client::Unauthenticated::Captcha
+      include Redd::Client::Unauthenticated::LinksComments
+      include Redd::Client::Unauthenticated::Listing
+      include Redd::Client::Unauthenticated::Live
+      include Redd::Client::Unauthenticated::Moderation
+      include Redd::Client::Unauthenticated::Subreddits
+      include Redd::Client::Unauthenticated::Utilities
+      include Redd::Client::Unauthenticated::Wiki
+
+      # @!attribute [r] api_endpoint
+      # @return [String] The site to connect to.
+      attr_accessor :api_endpoint
+
+      # @!attribute [r] user_agent
+      # @return [String] The user-agent used to communicate with reddit.
+      attr_accessor :user_agent
+
+      # @!attribute [r] rate_limit
+      # @return [#after_limit] The handler that takes care of rate limiting.
+      attr_accessor :rate_limit
+
+      # Set up an unauthenticated connection to reddit.
+      #
+      # @param [Hash] options A hash of options to connect using.
+      # @option options [#after_limit] :rate_limit The handler that takes care
+      #   of rate limiting.
+      # @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.
+      def initialize(options = {})
+        @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/"
+      end
+
+      private
+
+      # @return [Hash] The headers that are sent with every request.
+      def headers
+        @headers ||= {"User-Agent" => @user_agent}
+      end
+
+      # 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::RaiseError
+          faraday.use Redd::Response::ParseJson
+          faraday.adapter Faraday.default_adapter
+
+          faraday.headers = headers
+        end
+      end
+
+      # Send a request to the given path.
+      #
+      # @param [#to_sym] method The HTTP verb to use.
+      # @param [String] path The path under the api endpoint to request from.
+      # @param [Hash] params The additional parameters to send (defualt: {}).
+      # @return [String] The response body.
+      def request(method, path, params = {})
+        rate_limit.after_limit do
+          connection.send(method.to_sym, path, params).body
+        end
+      end
+
+      # Performs a GET request via {#request}.
+      # @see #request
+      def get(*args)
+        request(:get, *args)
+      end
+
+      # Performs a POST request via {#request}.
+      # @see #request
+      def post(*args)
+        request(:post, *args)
+      end
+
+      # Performs a PUT request via {#request}.
+      # @see #request
+      def put(*args)
+        request(:put, *args)
+      end
+
+      # Performs a DELETE request via {#request}.
+      # @see #request
+      def delete(*args)
+        request(:delete, *args)
+      end
+    end
+  end
+end

data/lib/redd/object/wiki_page.rb

@@ -0,0 +1,27 @@
+require "redd/base"
+
+module Redd
+  module Object
+    # A submission made in a subreddit.
+    class WikiPage < Redd::Base
+      attr_reader :kind
+      attr_reader :may_revise
+      attr_reader :content_md
+      attr_reader :content_html
+
+      alias_method :content, :content_md
+      alias_method :body, :content_md
+
+      # HACK
+      def revision_by
+        @revision_by ||= client.send(
+          :object_from_body, @attributes[:revision_by]
+        )
+      end
+
+      def revision_date
+        @created ||= Time.at(@attributes[:revision_date])
+      end
+    end
+  end
+end

data/lib/redd/response/raise_error.rb

@@ -8,13 +8,12 @@ module Redd
       # @param faraday
       def call(faraday)
         @app.call(faraday).on_complete do |env|
-          error = Redd::Error.from_response(env)
-          if error
+          if error = Redd::Error.from_response(env)
             if error == Redd::Error::RateLimited
-              seconds = env[:body][:json][:ratelimit]
-              fail error.new(seconds), env
+              time = env.body[:json][:ratelimit]
+              fail error.new(env, time)
             else
-              fail error, env
+              fail error.new(env)
             end
           end
         end

data/lib/redd/version.rb

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

data/spec/redd/client/unauthenticated_spec.rb

@@ -0,0 +1,15 @@
+describe Redd::Client::Unauthenticated, :vcr do
+  let(:client) { Redd::Client::Unauthenticated.new }
+
+  it "has configurable options" do
+    newclient = Redd::Client::Unauthenticated.new(
+      rate_limit: "SPEC_RATELIMIT",
+      user_agent: "SPEC_USERAGENT",
+      api_endpoint: "SPEC_ENDPOINT.COM"
+    )
+
+    expect(newclient.rate_limit).to eq("SPEC_RATELIMIT")
+    expect(newclient.user_agent).to eq("SPEC_USERAGENT")
+    expect(newclient.api_endpoint).to eq("SPEC_ENDPOINT.COM")
+  end
+end

data/spec/redd/rate_limit_spec.rb

@@ -0,0 +1,29 @@
+describe Redd::RateLimit do
+  let(:rate_limit) { Redd::RateLimit.new }
+
+  it "waits two seconds between consecutive requests" do
+    rate_limit.after_limit {  }
+    start_time = Time.now
+    rate_limit.after_limit {  }
+    end_time = Time.now
+
+    expect(end_time - start_time).to be_within(0.1).of(2)
+  end
+
+  it "doesn't wait if two seconds have passed since last request" do
+    rate_limit.after_limit {  }
+    sleep(2)
+    start_time = Time.now
+    rate_limit.after_limit {  }
+    end_time = Time.now
+
+    expect(end_time - start_time).to be_within(0.1).of(0)
+  end
+
+  it "stores the time the last request was made" do
+    time = Time.now
+    rate_limit.after_limit {  }
+
+    expect(rate_limit.last_request_time).to be_within(0.1).of(time)
+  end
+end

data/spec/redd_spec.rb

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

data/spec/spec_helper.rb

@@ -6,6 +6,7 @@ require "redd"
 
 VCR.configure do |config|
   config.cassette_library_dir = "spec/cassettes"
+  config.default_cassette_options = {record: :new_episodes}
   config.hook_into :webmock
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redd
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Avinash Dwarapu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-07 00:00:00.000000000 Z
+date: 2014-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -201,13 +201,17 @@ files:
 - lib/redd/object/private_message.rb
 - lib/redd/object/submission.rb
 - lib/redd/object/subreddit.rb
+- lib/redd/object/unauthenticated.rb
 - lib/redd/object/user.rb
+- lib/redd/object/wiki_page.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/client/unauthenticated_spec.rb
+- spec/redd/rate_limit_spec.rb
 - spec/redd_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -235,6 +239,8 @@ signing_key:
 specification_version: 4
 summary: A Reddit API Wrapper for Ruby.
 test_files:
+- spec/redd/client/unauthenticated_spec.rb
+- spec/redd/rate_limit_spec.rb
 - spec/redd_spec.rb
 - spec/spec_helper.rb
 has_rdoc: