redd 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc908201324aea927202ad7e528f0fbf32ae56be
-  data.tar.gz: 92b74d29e18b82bd9f378b5eb44f84bfac519c6f
+  metadata.gz: 48bf9a93a4b969191c7ca64548fb6a56e5b7fda2
+  data.tar.gz: 7423344e98a55f189dcd4fdae0c81c9cf88a2793
 SHA512:
-  metadata.gz: c4c793e73a7d8a65722678da3069cc3affe66d14b19195283dfc9b6fdcc29b183e1e67ea673f0ed5f68b069515a41f7d2fd6e46bb8cb80c36c70a6db225bb9c0
-  data.tar.gz: 69ba345a72d015d9e44a44c46de2ae26b57b4ff8474c48d270d4976caf1131f7d458ef184538f1108dd92f6e40547077d6a59bc1c0aec9ca3ef987cd99257639
+  metadata.gz: 2e254c453af7d312d23d86404ba7ff6b18018d717052caf4a7be0aa7031f7e2ea90994275300397c13fb7fa7f538d4d75ca07221a4b9b7d76e037591884c2da1
+  data.tar.gz: bbf195d1261025bc0299e48b11bf8dbf2012b05395ac3d3fa94aa361ad76076097580260e9f1b8dcc2ff467e8734990e5a2ef2a2bff07b5a8320db8478816a84

data/README.md

@@ -11,10 +11,9 @@
 
 #### Gemfile
 ```ruby
-gem "ruby", "~> 0.7.0"
-# if you're feeling adventurous
-# gem "redd", github: "avidw/redd", branch: "oauth2"
+gem "redd", "~> 0.7.0"
 
+# Optional fast JSON parser.
 gem "oj", platforms: :ruby
 ```
 
@@ -36,17 +35,33 @@ r.authorize!
 
 ```ruby
 # Access
+require "secure_random"
+require "sinatra"
+
+enable :sessions
+
+get "/auth" do
+  state = SecureRandom.urlsafe_base64
+  session[:state] = state
+  redirect w.auth_url(state, %w(identity), :permanent)
+end
+
 get "/redirect" do
+  halt 500, "Your state doesn't match!" unless session[:state] == params[:state]
   access = w.authorize!(params[:code])
   session[:access] = access.to_json
   redirect to("/name")
 end
 
 get "/name" do
-  session_access = Access.from_json(session[:access])
-  w.with(session_access) do |client|
-    client.refresh_access! if session_access.expired?
-    "Your username is #{client.me.name}"
+  if session[:access]
+    session_access = Redd::Access.from_json(session[:access])
+    w.with(session_access) do |client|
+      client.refresh_access! if session_access.expired?
+      "Your username is #{client.me.name}"
+    end
+  else
+    redirect to("/auth")
   end
 end
 

data/lib/redd/clients/base/none.rb

@@ -19,7 +19,7 @@ module Redd
         # @param iden [String] The captcha identifier.
         # @return The url for the captcha image.
         def captcha_url(iden)
-          "http://www.reddit.com/captcha/#{identifier}.png"
+          "http://www.reddit.com/captcha/#{iden}.png"
         end
       end
     end

data/lib/redd/clients/installed.rb

@@ -13,6 +13,7 @@ module Redd
       attr_reader :redirect_uri
 
       # @param [Hash] options The options to create the client with.
+      # @see Base#initialize
       # @see Redd.it
       def initialize(client_id, redirect_uri, **options)
         @client_id = client_id

data/lib/redd/clients/script.rb

@@ -11,6 +11,7 @@ module Redd
       attr_reader :username
 
       # @param [Hash] options The options to create the client with.
+      # @see Base#initialize
       # @see Redd.it
       def initialize(client_id, secret, username, password, **options)
         @client_id = client_id

data/lib/redd/clients/userless.rb

@@ -9,6 +9,7 @@ module Redd
       attr_reader :client_id
 
       # @param [Hash] options The options to create the client with.
+      # @see Base#initialize
       # @see Redd.it
       def initialize(client_id, secret, **options)
         @client_id = client_id

data/lib/redd/clients/web.rb

@@ -12,6 +12,7 @@ module Redd
       attr_reader :redirect_uri
 
       # @param [Hash] options The options to create the client with.
+      # @see Base#initialize
       # @see Redd.it
       def initialize(client_id, secret, redirect_uri, **options)
         @client_id = client_id

data/lib/redd/objects/subreddit.rb

@@ -14,6 +14,8 @@ module Redd
       alias_property :type, :subreddit_type
       alias_property :times_gilded, :gilded
 
+      # @!group Stylesheets
+
       # @return [String] The url for the subreddit's stylesheet.
       def stylesheet_url
         get("/r/#{display_name}/stylesheet").headers["location"]
@@ -24,6 +26,23 @@ module Redd
         Faraday.get(stylesheet_url).body
       end
 
+      # Edit the subreddit's stylesheet
+      #
+      # @param [String] contents The new CSS.
+      # @param [String] reason Why you modified the stylesheet.
+      # @author Takashi M (@beatak) and Avinash Dwarapu (@avidw)
+      # @note https://www.reddit.com/r/naut/about/stylesheet/ is a good place
+      #   to test if you have an error.
+      def edit_stylesheet(contents, reason = nil)
+        params = {op: "save", stylesheet_contents: contents}
+        params[:reason] = reason if reason
+        post("/r/#{display_name}/api/subreddit_stylesheet", params)
+      end
+
+      # @!endgroup
+
+      # @!group Invites
+
       # Accept a moderator invite from a subreddit.
       def accept_moderator_invite!
         post("/r/#{display_name}/api/accept_moderator_invite")
@@ -39,6 +58,10 @@ module Redd
         post("/api/leavemoderator", id: fullname)
       end
 
+      # @!endgroup
+
+      # @!group Flairs
+
       # Get a list of everbody on the subreddit with a user flair.
       #
       # @param [Hash] params A list of params to send with the request.
@@ -94,6 +117,10 @@ module Redd
         post("/r/#{display_name}/api/flair", text: text, css_class: css_class)
       end
 
+      # @!endgroup
+
+      # @!group Listings
+
       # @!method get_hot(**params)
       # @!method get_new(**params)
       # @!method get_top(**params)
@@ -144,9 +171,51 @@ module Redd
       # @see https://www.reddit.com/dev/api#GET_about_{location}
       %w(reports spam modqueue unmoderated edited).each do |sort|
         define_method :"get_#{sort}" do |**params|
-          request_object(:get, "/r/#{display_name}/about/#{sort}", params)
+          client.request_object(
+            :get, "/r/#{display_name}/about/#{sort}", params
+          )
+        end
+      end
+
+      # @!endgroup
+
+      # @!group Moderator Settings
+
+      # @return [Objects::Base] The current settings of a subreddit.
+      def admin_about
+        client.request_object(:get, "/r/#{display_name}/about/edit.json")
+      end
+
+      # Edit the subreddit's settings
+      # @param [Hash] attributes The subreddit's new settings.
+      # @author Takashi M (@beatak) and Avinash Dwarapu (@avidw)
+      # @note This method may make additional requests if not all of the
+      #   required attributes are provided.
+      # @see https://github.com/alaycock/MeetCal-bot/blob/master/serverInfo.conf
+      def admin_edit(attributes)
+        params = {sr: fullname}
+        required_attributes = %i(
+          allow_top collapse_deleted_comments comment_score_hide_mins
+          css_on_cname description exclude_banned_modqueue lang name over_18
+          public_description public_traffic show_cname_sidebar show_media
+          spam_comments spam_links spam_selfposts submit_link_label
+          submit_text submit_text_label title type wiki_edit_age
+          wiki_edit_karma wikimode header-title
+        )
+
+        if required_attributes.all? { |key| attributes.key?(key) }
+          params.merge!(attributes)
+        else
+          current = admin_about
+          current.delete(:kind)
+          complete = current.merge(attributes)
+          params.merge!(complete)
         end
+
+        post("/api/site_admin", params)
       end
+
+      # @!endgroup
     end
   end
 end

data/lib/redd/objects/user.rb

@@ -37,7 +37,7 @@ module Redd
       ).each do |type|
         define_method :"get_#{type}" do |**params|
           client.request_object(
-            :get, "/user/#{name}/#{type}.json",
+            :get, "/user/#{name}/#{type}.json", **params
           )
         end
       end

data/lib/redd/version.rb

@@ -1,4 +1,4 @@
 module Redd # rubocop:disable Style/Documentation
   # The semantic version number.
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redd
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Avinash Dwarapu