redditkit 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e238756c1925ce84c5d427e7c2c87fc176c376bc
-  data.tar.gz: 578a1aba9324a817ae38431f2b269584560c6014
+  metadata.gz: 5cebc62a3ed2c61e757d97c82eb5476eba7a1c74
+  data.tar.gz: c47a8e01b50625a3015eeab55c6a2a9e4960e7c4
 SHA512:
-  metadata.gz: c9a62dae47cf215362ad7b12423e975f3e8ec0d8b9d77e76eac7cc0f2c1e08cd56d48d1814695e49560fd30a25747b65a0d2953d0db34dc96f54bc58c75e5d33
-  data.tar.gz: da91b90dbe57312fddda981f374f69aa61ced51b73e7a431c8cdd84d29fa5b84ff35609c7889c5eb58a292a59f84bd3cc387f05490615fae99075c042eceb123
+  metadata.gz: 9ac50a6beb64a4a57d0e3c476381f70d264c14c0650889710ffb323c0cf3e65f0ce1a7844ae6ca776d851a07c8d079b086d0b34696fd444abc846989cf699f68
+  data.tar.gz: fa09d0b525b8e94b2caf567e595bd1a8894288a073387e1f0a828fe165d8086c6da05c3bd840c2e41820bacbea9605d5d46ccbf690208673b986d766615f07b2

data/README.md

@@ -2,19 +2,25 @@
 
 RedditKit.rb is a [reddit API](http://www.reddit.com/dev/api) wrapper, written in Ruby.
 
+[![Gem Version](https://badge.fury.io/rb/redditkit.png)][rubygem]
 [![Build Status](https://travis-ci.org/samsymons/RedditKit.rb.png?branch=master)][travis]
 [![Code Climate](https://codeclimate.com/github/samsymons/RedditKit.rb.png)][codeclimate]
 [![Coverage Status](https://coveralls.io/repos/samsymons/RedditKit.rb/badge.png?branch=master)][coveralls]
 
-[travis]: http://travis-ci.org/samsymons/RedditKit.rb
+[rubygem]: https://rubygems.org/gems/redditkit
+[travis]: https://travis-ci.org/samsymons/RedditKit.rb
 [codeclimate]: https://codeclimate.com/github/samsymons/RedditKit.rb
 [coveralls]: https://coveralls.io/r/samsymons/RedditKit.rb
 
+## Documentation
+
+[http://rdoc.info/gems/redditkit/](http://rdoc.info/gems/redditkit/)
+
 ## Installation
 
 Add this to your Gemfile:
 
-    gem 'redditkit', '~> 1.0'
+    gem 'redditkit', '~> 1.0.1'
 
 Or install it directly:
 
@@ -92,8 +98,6 @@ paginated_response.each do |link|
 end
 ```
 
-## Multiple Accounts
-
 ## Configuration
 
 You can configure various aspects of RedditKit.rb's operation, including its default API endpoint and user agent, by setting attributes on `RedditKit::Client`.

data/lib/redditkit.rb

@@ -1,10 +1,11 @@
 require 'redditkit/client'
+require 'uri'
 
 # The main RedditKit module.
 module RedditKit
   class << self
 
-    # A RedditKit::Client, used when calling methods on the RedditKit module itself. 
+    # A RedditKit::Client, used when calling methods on the RedditKit module itself.
     #
     # @return [RedditKit::Client]
     def client
@@ -13,7 +14,7 @@ module RedditKit
 
     def respond_to?(method_name, include_private = false)
       client.respond_to?(method_name, include_private) || super
-    end 
+    end
 
     private
 
@@ -21,6 +22,6 @@ module RedditKit
       return super unless client.respond_to?(method_name)
       client.send(method_name, *args, &block)
     end
-    
+
   end
 end

data/lib/redditkit/client.rb

@@ -58,9 +58,7 @@ module RedditKit
       @cookie = nil
       @modhash = nil
 
-      unless @username.nil? or @password.nil?
-        sign_in @username, @password 
-      end
+      sign_in(username, password) unless username.nil? || password.nil?
     end
 
     def api_endpoint
@@ -76,7 +74,7 @@ module RedditKit
     end
 
     def middleware
-      @middleware ||= Faraday::Builder.new do |builder|
+      @middleware ||= Faraday::RackBuilder.new do |builder|
         builder.use Faraday::Request::UrlEncoded
         builder.use RedditKit::Response::RaiseError
         builder.use RedditKit::Response::ParseJSON
@@ -113,14 +111,14 @@ module RedditKit
       else
         request_connection.send(method.to_sym, path, parameters).env
       end
-    rescue Faraday::Error::ClientError 
+    rescue Faraday::Error::ClientError
       raise RedditKit::RequestError
     end
 
     def authenticated_request_configuration(method, path, parameters)
-      raise RedditKit::NotAuthenticated unless signed_in?
+      fail RedditKit::NotAuthenticated unless signed_in?
 
-      Proc.new do |request|
+      proc do |request|
         request.headers['Cookie'] = "reddit_session=#{@cookie}"
         request.headers['X-Modhash'] = @modhash
       end
@@ -135,7 +133,7 @@ module RedditKit
     end
 
     def connection_with_url(url)
-      Faraday.new(url, { :builder => middleware })
+      Faraday.new url, :builder => middleware
     end
 
   end

data/lib/redditkit/client/apps.rb

@@ -3,7 +3,7 @@ module RedditKit
 
     # Methods for operating on apps in the current user's account.
     module Apps
-      
+
       # Create or update an app.
       #
       # @param name [String] The app's name.
@@ -20,35 +20,35 @@ module RedditKit
 
         post('api/updateapp', parameters)
       end
-      alias update_app create_app
-      
+      alias_method :update_app, :create_app
+
       # Delete an app.
       #
       # @param app_identifier [String] The identifier of the app.
       def delete_app(app_identifier)
-        post('api/deleteapp', { :client_id => app_identifier })
+        post 'api/deleteapp', :client_id => app_identifier
       end
 
       # Revoke an app.
       #
       # @param app_identifier [String] The identifier of the app.
       def revoke_app(app_identifier)
-        post('api/revokeapp', { :client_id => app_identifier })
+        post 'api/revokeapp', :client_id => app_identifier
       end
 
       # Add a user as a developer of an app.
-      # 
+      #
       # @param user [String, RedditKit::User] The username of the user to add, or a RedditKit::User.
       # @param app_identifier [String] The identifier of the app.
       def add_developer(user, app_identifier)
         username = extract_string user, :username
         parameters = { :name => username, :client_id => app_identifier }
 
-        post('api/adddeveloper', parameters)
+        post 'api/adddeveloper', parameters
       end
 
       # Remove an app's developer.
-      # 
+      #
       # @param user [String, RedditKit::User] The username of the user to add, or a RedditKit::User.
       # @param app_identifier [String] The identifier of the app.
       def remove_developer(user, app_identifier)

data/lib/redditkit/client/captcha.rb

@@ -8,7 +8,7 @@ module RedditKit
       #
       # @return [Boolean]
       def needs_captcha?
-        response = get('api/needs_captcha.json', nil)
+        response = get 'api/needs_captcha.json'
         needs_captcha = response[:body]
 
         needs_captcha.to_s == 'true'
@@ -18,7 +18,7 @@ module RedditKit
       #
       # @return [String] The CAPTCHA identifier.
       def new_captcha_identifier
-        response = post('api/new_captcha', { :api_type => :json })
+        response = post 'api/new_captcha', :api_type => :json
         data = response[:body][:json][:data]
 
         data[:iden]

data/lib/redditkit/client/comments.rb

@@ -16,7 +16,7 @@ module RedditKit
         comments.first
       end
 
-      # Get comments on a link. 
+      # Get comments on a link.
       #
       # @param link [String, RedditKit::Link] The identifier of the link, or a RedditKit::Link.
       # @option options [Integer] :limit The number of comments to return.
@@ -45,7 +45,7 @@ module RedditKit
         full_comment_data = response_data[:things].first
         comment_data = full_comment_data[:data]
         comment_full_name = comment_data[:id]
-        
+
         comment comment_full_name
       end
 

data/lib/redditkit/client/flair.rb

@@ -6,11 +6,11 @@ module RedditKit
     # Methods for interacting with flair in subreddits.
     module Flair
 
-      # Lists users and their flair in a subreddit. 
+      # Lists users and their flair in a subreddit.
       #
       # @param subreddit [String, RedditKit::Subreddit] A subreddit's name, or a RedditKit::Subreddit.
       # @option options [1..1000] :limit The number of items to return.
-      # @option options [String] :before Only return objects before this id. 
+      # @option options [String] :before Only return objects before this id.
       # @option options [String] :after Only return objects after this id.
       def flair_list(subreddit, options = {})
         subreddit_name = extract_string(subreddit, :display_name)
@@ -19,7 +19,7 @@ module RedditKit
 
         users.collect { |user| OpenStruct.new(user) }
       end
-      
+
       # Creates a flair template in a subreddit.
       #
       # @param subreddit [String, RedditKit::Subreddit] A subreddit's name, or a RedditKit::Subreddit.
@@ -48,12 +48,12 @@ module RedditKit
         post('api/deleteflairtemplate', parameters)
       end
 
-      # Toggles flair for a subreddit. 
+      # Toggles flair for a subreddit.
       #
       # @param subreddit [String, RedditKit::Subreddit] A subreddit's name, or a RedditKit::Subreddit.
-      # @param flair_enabled [Boolean] Whether to enable flair for the subreddit. 
+      # @param flair_enabled [Boolean] Whether to enable flair for the subreddit.
       def toggle_flair(subreddit, flair_enabled)
-        post('api/setflairenabled', { :r => subreddit, :flair_enabled => flair_enabled }) 
+        post('api/setflairenabled', { :r => subreddit, :flair_enabled => flair_enabled })
       end
 
       # Sets flair on a link or user.
@@ -132,15 +132,17 @@ module RedditKit
       #
       # @param subreddit [String, RedditKit::Subreddit] A subreddit's name, or a RedditKit::Subreddit.
       # @option options [Boolean] flair_enabled Whether to enable flair for the subreddit.
-      # @option options [left, right] flair_position The position of user flair. 
+      # @option options [left, right] flair_position The position of user flair.
       # @option options [left, right] link_flair_position The position of link flair.
       # @option options [Boolean] flair_self_assign_enabled Whether users may assign their own flair.
       # @option options [Boolean] link_flair_self_assign_enabled Whether users may assign their own link flair.
       def set_flair_options(subreddit, options = {})
+        options = options.clone
+
         subreddit_name = extract_string(subreddit, :display_name)
         options.merge!({ :r => subreddit_name, :uh => @modhash })
 
-        post('api/flairconfig', options) 
+        post('api/flairconfig', options)
       end
 
     end

data/lib/redditkit/client/links.rb

@@ -5,13 +5,13 @@ module RedditKit
 
     # Methods for retrieving, submitting and interacting with links.
     module Links
-      
+
       # Gets the links currently on the front page.
       #
-      # @option options [hot, new, rising, controversial, top] :category The category from which to retrieve links.  
+      # @option options [hot, new, rising, controversial, top, ads] :category The category from which to retrieve links.
       # @option options [hour, day, week, month, year, all] :time The time from which to retrieve links. Defaults to all time.
       # @option options [1..100] :limit The number of links to return.
-      # @option options [String] :before Only return links before this identifier. 
+      # @option options [String] :before Only return links before this identifier.
       # @option options [String] :after Only return links after this identifier.
       # @return [RedditKit::PaginatedResponse]
       def front_page(options = {})
@@ -21,13 +21,15 @@ module RedditKit
       # Gets an array of links from a specific subreddit.
       #
       # @param subreddit [String, RedditKit::Subreddit] The display name of the subreddit, or a RedditKit::Subreddit.
-      # @option options [hot, new, rising, controversial, top] :category The category from which to retrieve links.  
+      # @option options [hot, new, rising, controversial, top, ads] :category The category from which to retrieve links.
       # @option options [hour, day, week, month, year, all] :time The time from which to retrieve links. Defaults to all time.
       # @option options [1..100] :limit The number of links to return.
-      # @option options [String] :before Only return links before this identifier. 
+      # @option options [String] :before Only return links before this identifier.
       # @option options [String] :after Only return links after this identifier.
       # @return [RedditKit::PaginatedResponse]
       def links(subreddit, options = {})
+        options = options.clone
+
         subreddit_name = extract_string(subreddit, :display_name) if subreddit
         category = options[:category] || :hot
 
@@ -50,16 +52,18 @@ module RedditKit
         links.first
       end
 
-      # Gets links with a specific domain. 
+      # Gets links with a specific domain.
       #
       # @param domain [String] The domain for which to get links.
       # @option options [hour, day, week, month, year] :time The time from which to retrieve links. Defaults to all time.
       # @option options [1..100] :limit The number of links to return.
-      # @option options [String] :before Only return links before this identifier. 
+      # @option options [String] :before Only return links before this identifier.
       # @option options [String] :after Only return links after this identifier.
       # @return [RedditKit::PaginatedResponse]
       # @example links = RedditKit.links_with_domain "github.com"
       def links_with_domain(domain, options = {})
+        options = options.clone
+
         parameters = { :url => domain, :t => options[:time] }
         options.merge! parameters
         options.delete :t
@@ -67,10 +71,10 @@ module RedditKit
         objects_from_response(:get, 'api/info.json', options)
       end
 
-      # Submits a link or self post to reddit. 
+      # Submits a link or self post to reddit.
       #
       # @param title [String] The title of the post.
-      # @param subreddit [String, RedditKit::Subreddit] A subreddit's display name, or a RedditKit::Subreddit. 
+      # @param subreddit [String, RedditKit::Subreddit] A subreddit's display name, or a RedditKit::Subreddit.
       # @option options [String] :url The URL for the post. Note that if this value is present, :text will be ignored.
       # @option options [String] :text The text value for the post, as Markdown.
       # @option options [String] :captcha_identifier An identifier for a CAPTCHA, if the current user is required to fill one out.
@@ -85,7 +89,7 @@ module RedditKit
           :captcha => options[:captcha_value],
           :save => options[:save]
           }
-        
+
         if options[:url]
           parameters[:url] = options[:url]
           parameters[:kind] = 'link'
@@ -94,36 +98,36 @@ module RedditKit
           parameters[:kind] = 'self'
         end
 
-        post('api/submit', parameters)
+        post 'api/submit', parameters
       end
 
       # Marks a link as not safe for work.
       #
-      # @param link [String, RedditKit::Link] A link's full name, or a RedditKit::Link. 
+      # @param link [String, RedditKit::Link] A link's full name, or a RedditKit::Link.
       def mark_nsfw(link)
-        post('api/marknsfw', { :id => extract_full_name(link) })
+        post 'api/marknsfw', :id => extract_full_name(link)
       end
 
       # Marks a link as safe for work.
       #
-      # @param link [String, RedditKit::Subreddit] A link's full name, or a RedditKit::Link. 
+      # @param link [String, RedditKit::Subreddit] A link's full name, or a RedditKit::Link.
       def mark_sfw(link)
-        post('api/unmarknsfw', { :id => extract_full_name(link) })
+        post 'api/unmarknsfw', :id => extract_full_name(link)
       end
-      alias unmark_nsfw mark_sfw
+      alias_method :unmark_nsfw, :mark_sfw
 
       # Hides a link.
       #
-      # @param link [String, RedditKit::Link] A link's full name, or a RedditKit::Link. 
+      # @param link [String, RedditKit::Link] A link's full name, or a RedditKit::Link.
       def hide(link)
-        post('api/hide', { :id => extract_full_name(link) })
+        post 'api/hide', :id => extract_full_name(link)
       end
 
       # Unhides a link.
       #
-      # @param link [String, RedditKit::Link] A link's full name, or a RedditKit::Link. 
+      # @param link [String, RedditKit::Link] A link's full name, or a RedditKit::Link.
       def unhide(link)
-        post('api/unhide', { :id => extract_full_name(link) })
+        post 'api/unhide', :id => extract_full_name(link)
       end
 
       # Gets a random link.

data/lib/redditkit/client/miscellaneous.rb

@@ -6,7 +6,7 @@ module RedditKit
 
       # Edit the text or a self post or comment.
       #
-      # @param object [String, RedditKit::Comment, RedditKit::Link] A link or comment's full name, a RedditKit::Link, or a RedditKit::Subreddit. 
+      # @param object [String, RedditKit::Comment, RedditKit::Link] A link or comment's full name, a RedditKit::Link, or a RedditKit::Subreddit.
       # @option options [String] text The new text for the link or comment.
       def edit(object, options)
         parameters = { :text => options[:text], :thing_id => extract_full_name(object) }
@@ -15,36 +15,36 @@ module RedditKit
 
       # Deletes a link or comment.
       #
-      # @param object [String, RedditKit::Comment, RedditKit::Link] A link or comment's full name, a RedditKit::Link, or a RedditKit::Subreddit. 
+      # @param object [String, RedditKit::Comment, RedditKit::Link] A link or comment's full name, a RedditKit::Link, or a RedditKit::Subreddit.
       def delete(object)
         full_name = extract_full_name object
-        post('api/del', { :id => full_name })
+        post 'api/del', :id => full_name
       end
 
       # Saves a link or comment.
       #
-      # @param object [String, RedditKit::Link, RedditKit::Subreddit] A link or comment's full name, a RedditKit::Link, or a RedditKit::Subreddit. 
+      # @param object [String, RedditKit::Link, RedditKit::Subreddit] A link or comment's full name, a RedditKit::Link, or a RedditKit::Subreddit.
       def save(object)
         full_name = extract_full_name object
-        post('api/save', { :id => full_name })
+        post 'api/save', :id => full_name
       end
 
       # Unsaves a link or comment.
       #
-      # @param object [String, RedditKit::Link, RedditKit::Subreddit] A link or comment's full name, a RedditKit::Link, or a RedditKit::Subreddit. 
+      # @param object [String, RedditKit::Link, RedditKit::Subreddit] A link or comment's full name, a RedditKit::Link, or a RedditKit::Subreddit.
       def unsave(object)
         full_name = extract_full_name object
-        post('api/unsave', { :id => full_name })
+        post 'api/unsave', :id => full_name
       end
 
       # Reports a link or comment. The reddit API will also hide the link or comment.
       #
-      # @param object [String, RedditKit::Link, RedditKit::Comment] A link or comment's full name, a RedditKit::Link, or a RedditKit::Subreddit. 
+      # @param object [String, RedditKit::Link, RedditKit::Comment] A link or comment's full name, a RedditKit::Link, or a RedditKit::Subreddit.
       def report(object)
         full_name = extract_full_name object
-        post('api/report', { :id => full_name })
+        post 'api/report', :id => full_name
       end
-      
+
     end
   end
 end