reddit_listings 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 08630a82b448d9f5d03d6c0d8cf9eccf46105314
+  data.tar.gz: add8a12ed70d707914a763eb7574480bf512c635
+SHA512:
+  metadata.gz: d0314315b85c5f4f9d35b1f9357fa5ef6ea8532b6f9cd2cf3fc0d54c905dba50d2ca51a50b7d006a9bb04b65dc1c1b67bf6078899719e1e9f6514765b01dda4f
+  data.tar.gz: 07c0b8f488d3624f21e591f6be0beb32fa5734c655bac27ba018d0d02038603f33b650da8feb37e57c901c23e10f096743450a48e3ff94e75edbe373496d7b3c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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.rdoc

@@ -0,0 +1,82 @@
+= RedditListings
+
+Reddit_Listings allows you to quickly get an array of up to 100 listings (content posts and self posts) from any subreddit(s) and sorting methods possible.
+
+== Installation 
+
+* You can install the latest release from RubyGems:
+
+    gem install reddit_listings
+
+* If your application uses Bundler, add a line like this to your Gemfile:
+
+    gem "reddit_listings", "~> 1.0.1"
+
+== How to use
+  
+Initialise a variable with RedditListings.get:
+
+    @foo = RedditListings.get("subreddit", :timeframe => "x", :total => "x", ":sort_by => "x")
+
+The options after the subreddit are optional.
+
+To use more than one subreddit join them with a +
+
+The options for <b>:sort_by</b> are: <em>"hot"</em>, <em>"new"</em>, <em>"rising"</em>, <em>"controversial"</em>, <em>"top"</em>, <em>"gilded"</em>, <em>"promoted"</em>.
+
+The *:timeframe* option should only be included if <em>"top"</em> or <em>"controversial"</em>  <b>:sort_by</b> options were chosen. The options are: <em>"hour"</em>, <em>"week"</em>, <em>"month"</em>, <em>"year"</em> and <em>"all"</em>.
+
+The <b>:limit</b> option specifies how many listings should be returned, to a maximum of 100.
+
+The default options are <b>:sort_by</b> => <em>"top"</em>, <b>:total"</b> => <em>"5"</em> and <b>:timeframe</b> => <em>"day"</em>
+
+=== Examples
+
+   @foo = RedditListings.get("ruby+rails", :timeframe => "week", :total => "10")
+Would return the first 10 listings under the 'top' category on the ruby and rails subreddits combined in the last week.
+ 
+   @foo = RedditListings.get("ruby", :sort_by => "hot", :total => "2")
+Would return the first 2 listings in the ruby subreddit when sorted by hot.
+
+== Accessing the data
+
+Once you have the listings saved you can access them through <b>@foo[0][:option]</b> where <b>0</b> is the listing index you want and the <b>:option</b> is one of the following:
+
+
+* [:title]
+* [:author] 
+* [:num_comments]
+* [:permalink]
+* [:likes]
+* [:gilded]
+* [:stickied]
+* [:score]
+* [:approved_by]
+* [:over_18]
+* [:ups]
+* [:downs]
+* [:is_self]
+* [:created]
+* [:url]
+* [:distinguished]
+
+=== Examples
+   @foo = RedditListings.get("ruby", :sort_by => "hot", :total => "1")
+Would return the first listing in the ruby subreddit when sorted by hot.
+   @foo[0][:title]
+Would then return the title of that listing.
+
+   @bar = RedditListings.get("ruby+rails", :sort_by => "gilded")
+Would return the first 5 gilded listings in the ruby and rails subreddits combined
+   @bar[4][:author]
+Would then return the username of the 5th listing returned.
+
+
+== Further info
+This gem was created (and tested) using rails 4.0.3
+
+Please use in conjunction with reddit's API rules - https://github.com/reddit/reddit/wiki/API
+
+This project rocks and uses MIT-LICENSE.
+
+

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RedditListings'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/reddit_listings.rb

@@ -0,0 +1,47 @@
+require 'net/http'
+require 'json'
+
+module RedditListings
+
+  def self.get(subreddit, options = {})
+    @subreddit = subreddit
+    @limit = options[:total] || "5"
+    @time = options[:timeframe] || "day"
+    @sort = options[:sort_by] || "top"
+    @listings = []
+    @n = 0
+
+    if @sort == "top" || @sort == "controversial"
+        @uri = URI('http://www.reddit.com/r/' + @subreddit + '/' + @sort + '/.json?limit=' + @limit + '&t=' + @time)
+    else
+        @uri = URI('http://www.reddit.com/r/' + @subreddit + '/' + @sort + '/.json?limit=' + @limit)
+    end
+
+    @json = JSON.parse(Net::HTTP.get(@uri))        #HTTP.get returns a string which is parsed to JSON
+    
+    @limit.to_i.times do
+      @listings[@n] = { 
+        title: @json['data']['children'][@n]['data']['title'], 
+        author: @json['data']['children'][@n]['data']['author'], 
+        num_comments: @json['data']['children'][@n]['data']['num_comments'], 
+        permalink: @json['data']['children'][@n]['data']['permalink'], 
+        likes: @json['data']['children'][@n]['data']['likes'], 
+        gilded: @json['data']['children'][@n]['data']['gilded'], 
+        stickied: @json['data']['children'][@n]['data']['stickied'], 
+        score: @json['data']['children'][@n]['data']['score'],
+        approved_by: @json['data']['children'][@n]['data']['approved_by'],
+        over_18: @json['data']['children'][@n]['data']['over_18'],
+        ups: @json['data']['children'][@n]['data']['ups'],
+        downs: @json['data']['children'][@n]['data']['downs'],
+        is_self: @json['data']['children'][@n]['data']['is_self'],
+        created: @json['data']['children'][@n]['data']['created'],
+        url: @json['data']['children'][@n]['data']['url'],  
+        distinguised: @json['data']['children'][@n]['data']['distinguished'] 
+      }
+
+      @n +=1
+    end
+
+    @listings
+  end
+end

data/lib/tasks/reddit_listings_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :reddit_listings do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby.exe
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby.exe
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby.exe
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "reddit_listings"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,80 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end