redd 0.7.10 → 0.8.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1121cb3dc661cdca2b70098ec2a384c9138b7fd
-  data.tar.gz: bea834439ebe8bb0d24d41eadeaddfdc390090b9
+  metadata.gz: bc08060b2e7111adfd18a83c7d23e464f20a92dc
+  data.tar.gz: 79897c294f7f612e90acee7184b91a4982d54cb6
 SHA512:
-  metadata.gz: bba0bd482a22ad71a63170be6d8eddf3b655d7438cb44912cc0d692ee0c3c73d485989ab72f1d17aa1ef836c0c05c680430b46be9f4fd45e1f1462cc38ef7169
-  data.tar.gz: 9251eff0a74b121c7e6fe257b022edce3866346736cfbb6e6b6616a8021b6828308b534c0b67ff34301ac9057a61e98d3990c43bf578f5f6cece3301a4a3f62b
+  metadata.gz: 0ccfa94a4923e3748931c6ca5e5515f23c10bd23d979c1ef79e5f3f62a87c78ff66ed01f72033d95d3da3e8ca0e47cf9ebd412d758d3b751d3d935545abd787c
+  data.tar.gz: f2881316388b4b3b1183aebdc867184aa64750c57ac29cfb6b17532ef099f0c4de309f064f3160a3eb670ee4d70d91cee335367b9c43a34c5f70eb3254781743

data/.gitignore

@@ -1,34 +1,9 @@
-*.gem
-*.rbc
-/.config
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
 /coverage/
-/InstalledFiles
+/doc/
 /pkg/
 /spec/reports/
-/test/tmp/
-/test/version_tmp/
 /tmp/
-
-## 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

@@ -1,3 +1,3 @@
---require spec_helper
 --format documentation
+--require spec_helper
 --color

data/.rubocop.yml

@@ -1,5 +1,18 @@
-StringLiterals:
-  EnforcedStyle: double_quotes
+AllCops:
+  TargetRubyVersion: 2.3
 
-Style/SpaceInsideHashLiteralBraces:
+Metrics/LineLength:
+  Max: 100
+
+# Allows for raising Redd::ResponseErrors with a Response object.
+Style/RaiseArgs:
   Enabled: false
+
+# Many reddit calls demand a lot of parameters.
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
+# Stop rubocop from complaining about large `describe` blocks.
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb

data/.travis.yml

@@ -1,9 +1,15 @@
+sudo: false
 language: ruby
-before_install:
-  - gem install bundler -v 1.12
 rvm:
-  - ruby-2.1.0
-  - ruby-2.2.0
-  - ruby-2
-  - rbx-2
-  - jruby-9.0.0.0.pre1
+  - ruby-head
+  - 2.4.0
+  - 2.1.0
+  - jruby-head
+  - jruby-9.1.7.0
+matrix:
+  allow_failures:
+  - rvm: ruby-head
+  - rvm: jruby-head
+
+before_install: gem install bundler -v 1.13.7
+cache: bundler

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Avinash Dwarapu
+
+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

@@ -1,142 +1,56 @@
-<p align="center">
-  <img src="https://i.imgur.com/2JfE4M1.png" alt="redd"><br>
-  <a href="https://rubygems.org/gems/redd"><img src="http://img.shields.io/gem/v/redd.svg?style=flat-square" alt="Gem Version"></a>
-  <a href="https://travis-ci.org/avidw/redd"><img src="http://img.shields.io/travis/avinashbot/redd.svg?style=flat-square" alt="Build Status"></a>
-  <a href="https://rubygems.org/gems/redd"><img src="http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="MIT License"></a>
-</p>
+<div align="center">
+  <!-- Redd -->
+  <img src="logo.png" width="500"><br>
 
-**redd** is an API wrapper for [reddit](http://www.reddit.com/dev/api) written in ruby that focuses on being consistent and extensible. **Check out the latest documentation on [RubyDoc](http://www.rubydoc.info/github/avidw/redd/master/frames/Redd.it).**
+  <!-- Intro Text -->
+  <strong>Redd</strong> is an API wrapper
+  for <a href="https://www.reddit.com/dev/api">reddit</a>
+  that is all about being <strong>simple</strong>
+  and <strong>intuitive</strong>.
+</div>
 
 ---
 
-#### Gemfile
 ```ruby
-gem "redd", "~> 0.7"
+require 'redd'
 
-# Optional fast JSON parser.
-gem "oj", platforms: :ruby
-```
-
-#### Getting Started
-```ruby
-# Authorization (Web)
-w = Redd.it(:web, "CLIENT_ID", "SECRET", "REDIRECT_URI", user_agent: "TestSite v1.0.0")
-url = w.auth_url("random_state", ["identity", "read"], :temporary)
-puts "Please go to #{url} and enter the code below:"
-code = gets.chomp
-w.authorize!(code)
-
-# Authorization
-r = Redd.it(:script, "CLIENT_ID", "SECRET", "Unidan", "hunter2", user_agent: "TestBot v1.0.0")
-r.authorize!
-
-# See documentation for more grants.
-```
-
-```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
+session = Redd.it(
+  user_agent: 'Redd:RandomBot:v1.0.0 (by /u/Mustermind)',
+  client_id:  'PQgS0UaX9l70oQ',
+  secret:     'PsF_kVZrW8nSVCG5kNsIgl-AaXE',
+  username:   'RandomBot',
+  password:   'hunter2'
+)
 
-get "/name" do
-  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")
+session.subreddit('all').comment_stream do |comment|
+  if comment.body.include?('roll a dice')
+    comment.reply("I just rolled a dice! It's a #{rand(1..6)}!")
+  elsif comment.body.include?('flip a coin') || comment.body.include?('coin flip')
+    coin_face = (rand(0..1) == 1 ? 'heads' : 'tails')
+    comment.reply("I just flipped a coin! It's #{coin_face}!")
   end
 end
-
-```
-
-```ruby
-# Getting a model
-vargas = r.user_from_name("_vargas_")
-puts vargas.keys
-puts vargas.over_18?
-
-picturegame = r.subreddit_from_name("picturegame")
-puts picturegame.display_name
-puts picturegame.public_description
 ```
 
-```ruby
-# Listings
-hot = r.get_hot("all")
-hot.each { |link| puts "#{link.title} by /u/#{link.author}" }
-```
-
-```ruby
-# Streaming
-def stream_all!
-  r.stream :get_comments, "all" do |comment|
-    reddit.refresh_access! if reddit.access.expired? # for :web
-    comment.reply("World!") if comment.body == "Hello?"
-  end
-end
-```
-
-```ruby
-# Escaping Errors
-begin
-  stream_all!
-rescue Redd::Error::RateLimited => error
-  sleep(error.time)
-  retry
-rescue Redd::Error => error
-  # 5-something errors are usually errors on reddit's end.
-  raise error unless (500...600).include?(error.code)
-  retry
-end
-```
-
-#### Extras
-```ruby
-# Extending Redd.rb
+---
 
-module MyGildingExtension
-  def gild!
-    # We're using post instead of request_object, because we don't
-    # expect any object from the response.
-    post("/api/v1/gold/gild/#{fullname}")
-  end
-end
+### FAQ
 
-Redd::Objects::Comment.include(MyGildingExtension)
-Redd::Objects::Submission.include(MyGildingExtension)
-```
+#### Is that bot fully functional?
+**Yes**, that's all there is to it! You don't need to handle rate-limiting, refresh access tokens
+or protect against issues on reddit's end (like 5xx errors).
 
-```markdown
-# Contributing
-1. [Fork](https://github.com/avidw/redd/issues/new)
-2. [Pull](https://github.com/avidw/redd/compare)
-3. [Profit](https://www.reddit.com/r/requestabot)
+#### How can I contact you?
+[Reddit](https://www.reddit.com/message/compose/?to=Mustermind) /
+[GitHub](https://github.com/avinashbot/redd/issues/new) /
+[Email](mailto:avinash@dwarapu.me)
 
-# Request a Feature
-1. [Help](https://github.com/avidw/redd/issues/new)
-```
+---
 
-```ruby
-# Copyright.rb
-#
-# Copyright (c) Avinash Dwarapu under the MIT License. See LICENSE.md for more details.
-# Redd::Error has been modified from RedditKit.rb. See RedditKit.LICENSE.md for its license.
-```
+<div align="center">
+  <!-- Copyright Notice -->
+  <em>
+  This project is available under the MIT License. See LICENSE.txt for more details.<br>
+  The Redd logo uses the FARRAY font by Coquet Adrien.
+  </em>
+</div>

data/Rakefile

@@ -1,5 +1,12 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
 
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+RuboCop::RakeTask.new do |t|
+  t.fail_on_error = false
+end
 RSpec::Core::RakeTask.new(:spec)
-task default: :spec
+
+task default: [:rubocop, :spec]

data/TODO.md

@@ -0,0 +1,11 @@
+# v0.8.0 checklist
+
+- [ ] Make v0.8.0 feature-complete with v0.7.x
+  - [ ] `Messageable`
+  - [ ] `MoreComments` and expansion
+- [ ] make rubocop fail on error
+- [ ] unduplicate duplicated code
+- [ ] Write tests (oh boy)
+- [ ] More comprehensive error checking
+- [ ] A `FrontPage` object
+- [ ] Add `#==` and `#to_s` methods to models

data/bin/console

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'webrick'
+require 'redd'
+
+server = WEBrick::HTTPServer.new(
+  Port: 8000,
+  BindAddress: '0.0.0.0',
+  Logger: WEBrick::Log.new(File.open(File::NULL, 'w')),
+  AccessLog: []
+)
+
+server.mount_proc '/' do |_, res|
+  res.body = <<-EOS
+    <!doctype html>
+    <title>Redd Quickstart</title>
+    <style>
+      html, body { margin: 0; height: 100vh; }
+      .wrapper { padding-top: 30vh; text-align: center; font-family: sans-serif; }
+      #btn { background-color: #3D9970; margin: 5px; border-radius: 5px; padding: 10px; color: #fff; text-decoration: none; }
+    </style>
+    <div class="wrapper">
+      <h1>redd // quickstart</h1>
+      <a onclick="window.open('/authenticate', '', 'width=960,height=640')" href="#" id="btn">Start</a>
+      <span>a new session in your terminal?</span>
+    </div>
+  EOS
+end
+
+server.mount_proc '/authenticate' do |_, res|
+  res.set_redirect(
+    WEBrick::HTTPStatus[302],
+    Redd.url(
+      client_id: 'P4txR-D6TzF8cg',
+      response_type: 'code',
+      state: '0',
+      redirect_uri: 'http://localhost:8000/redirect',
+      'scope': %w(identity read subscribe privatemessages wikiread submit vote edit modposts history
+                  modflair)
+    )
+  )
+end
+
+server.mount_proc '/redirect' do |req, res|
+  err = req.query['error']
+  should_exit = err.nil? || err == 'access_denied'
+  res.body = <<-EOS
+    <!doctype html>
+    <title>Done!</title>
+    #{should_exit ? '<script>window.close();</script>' : "<p>Uh oh, there was an error: #{err}</p>"}
+  EOS
+
+  unless err
+    R = Redd.it(
+      user_agent: "Ruby:Redd-Quickstart:v#{Redd::VERSION} (by unknown)",
+      client_id: 'P4txR-D6TzF8cg',
+      redirect_uri: 'http://localhost:8000/redirect',
+      code: req.query['code']
+    )
+    server.stop
+  end
+end
+
+# Get the server going and shut it all down if user hits Ctrl-C
+begin
+  puts "Listening at \e[34mhttp://localhost:8000\e[0m..."
+  server.start
+rescue Interrupt
+  server.shutdown
+  exit
+end
+
+# Post a colourful welcome message
+suggestions = [
+  'R.me.link_karma',
+  "R.subreddit('pics').hot.first.title",
+  "puts R.subreddit('all').hot.map(&:title)"
+]
+puts "Welcome, \e[35m/u/#{R.me.name}\e[0m! Try `\e[34m#{suggestions.sample}\e[0m`."
+
+# Load Pry
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/redd.rb

@@ -1,50 +1,88 @@
-require_relative "redd/version"
-require_relative "redd/clients/installed"
-require_relative "redd/clients/script"
-require_relative "redd/clients/userless"
-require_relative "redd/clients/web"
+# frozen_string_literal: true
 
-# The main Redd module.
+require 'uri'
+
+# Redd Version
+require_relative 'redd/version'
+# Models
+Dir[File.join(__dir__, 'redd', 'models', '*.rb')].each { |f| require f }
+# Authentication Clients
+Dir[File.join(__dir__, 'redd', 'auth_strategies', '*.rb')].each { |f| require f }
+# Regular Client
+require_relative 'redd/api_client'
+
+# Redd is a simple and intuitive API wrapper.
 module Redd
-  # @overload it(:installed, client_id, redirect_uri, **kwargs)
-  #   Authorize a user via an installed app.
-  #   @param [String] client_id The client ID provided by reddit.
-  #   @param [String] redirect_uri The exact uri you provided to reddit.
-  #   @param [Hash] kwargs The keyword arguments provided to the client.
-  #   @return [Clients::Installed]
-  #
-  # @overload it(:script, client_id, secret, username, password, **kwargs)
-  #   Authorize a user that you have full access to, i.e. a bot.
-  #   @param [String] client_id The client ID provided by reddit.
-  #   @param [String] secret The client secret provided by reddit.
-  #   @param [String] username The username.
-  #   @param [String] password The password of the user.
-  #   @param [Hash] kwargs The keyword arguments provided to the client.
-  #   @return [Clients::Script]
-  #
-  # @overload it(:userless, client_id, secret, **kwargs)
-  #   Connect to reddit from a web-app or a script without a specific user.
-  #   @param [String] client_id The client ID provided by reddit.
-  #   @param [String] secret The client secret provided by reddit.
-  #   @param [Hash] kwargs The keyword arguments provided to the client.
-  #   @return [Clients::Userless]
-  #
-  # @overload it(:web, client_id, secret, redirect_uri, **kwargs)
-  #   Authorize a user from a website.
-  #   @param [String] client_id The client ID provided by reddit.
-  #   @param [String] secret The client secret provided by reddit.
-  #   @param [String] redirect_uri The exact uri you provided to reddit.
-  #   @param [Hash] kwargs The keyword arguments provided to the client.
-  #   @return [Clients::Web]
-  #
-  def self.it(type, *args, **kwargs)
-    types = {
-      installed: Clients::Installed,
-      script: Clients::Script,
-      userless: Clients::Userless,
-      web: Clients::Web
-    }
-
-    types[type].new(*args, **kwargs)
+  class << self
+    # Guesses the appropriate authentication strategy, creates an API client and starts you off with
+    # a {Models::Session}.
+    # @see https://www.reddit.com/prefs/apps
+    # @param opts [Hash] the options to create the object with
+    # @option opts [String] :user_agent your app's *unique* and *descriptive* user agent
+    # @option opts [String] :client_id the client id of your app
+    # @option opts [String] :secret the app secret (for confidential types, i.e. *not* *installed*)
+    # @option opts [String] :username the username of your bot (only for *script*)
+    # @option opts [String] :password the plaintext password of your bot (only for *script*)
+    # @option opts [String] :redirect_uri the provided redirect URI (only for *web* and *installed*)
+    # @option opts [String] :code the code given by reddit (required for *web* and *installed*)
+    # @return [Models::Session] a fresh {Models::Session} for you to make requests with
+    def it(opts = {})
+      api_client = script(opts) || web(opts) || installed(opts) || userless(opts)
+      raise "couldn't guess app type" unless api_client
+      Models::Session.new(api_client) { |client| client.get('/api/v1/me').body }
+    end
+
+    # Create a url to send to users for authorization.
+    # @param response_type ['code', 'token'] the type of response from reddit
+    # @param state [String] a randomly generated token to avoid CSRF attacks.
+    # @param client_id [String] the client id of the app
+    # @param redirect_uri [String] the URI for reddit to redirect to after authorization
+    # @param scope [Array<String>] an array of scopes to request
+    # @return [String] the generated url
+    def url(client_id:, redirect_uri:, response_type: 'code', state: '', scope: ['identity'])
+      'https://www.reddit.com/api/v1/authorize?' + URI.encode_www_form(
+        client_id: client_id,
+        redirect_uri: redirect_uri,
+        state: state,
+        scope: scope.join(','),
+        response_type: response_type
+      )
+    end
+
+    private
+
+    def filter_auth(opts)
+      opts.select { |k| %i(client_id secret username password redirect_uri user_agent).include?(k) }
+    end
+
+    def filter_api(opts)
+      opts.select { |k| %i(user_agent).include?(k) }
+    end
+
+    def script(opts = {})
+      return unless %i(client_id secret username password).all? { |o| opts.include?(o) }
+      api = APIClient.new(AuthStrategies::Script.new(**filter_auth(opts)), **filter_api(opts))
+      api.tap(&:authenticate)
+    end
+
+    def web(opts = {})
+      return unless %i(client_id secret redirect_uri code).all? { |o| opts.include?(o) }
+      code = opts.delete(:code)
+      api = APIClient.new(AuthStrategies::Web.new(**filter_auth(opts)), **filter_api(opts))
+      api.tap { |c| c.authenticate(code) }
+    end
+
+    def installed(opts = {})
+      return unless %i(client_id redirect_uri code).all? { |o| opts.include?(o) }
+      code = opts.delete(:code)
+      api = APIClient.new(AuthStrategies::Installed.new(**filter_auth(opts)), **filter_api(opts))
+      api.tap { |c| c.authenticate(code) }
+    end
+
+    def userless(opts = {})
+      return unless %i(client_id secret).all? { |o| opts.include?(o) }
+      api = APIClient.new(AuthStrategies::Userless.new(**filter_auth(opts)), **filter_api(opts))
+      api.tap(&:authenticate)
+    end
   end
 end