spinels-redd 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '097e7d4ed4b2fb64354aaa5383205904e31f486335ad058dced128d5e90ebaf0'
+  data.tar.gz: 5e7232d3ab19e0f9d0513d92b8266d34110ea0b8c315b14c52b05e98968d1f5c
+SHA512:
+  metadata.gz: 1b4e42e6020f621a2d6190bc20ada4ac4974e4e3e6959b604bad9f59a65df1a6e0c86701c040daf664c8720c2989a83222edb65b65e5baa6cc12a525172a36d0
+  data.tar.gz: d5572740470f872ba55d66442a25f60be50bcc55a83357d99207589a38437a04954fd9b615021387898687b2810224cfc78fd2d8844ba3d226c6c0d4d6912fcf

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    vendor: true

data/.github/workflows/ci.yml

@@ -0,0 +1,52 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - { ruby: 2.6.7 }
+          - { ruby: 2.7.3 }
+          - { ruby: 3.0.1 }
+          - { ruby: head, allow-failure: true }
+          - { ruby: jruby-9.3.4.0 }
+          - { ruby: jruby-head, allow-failure: true }
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Setup Ruby ${{ matrix.ruby }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+
+    - name: Run tests
+      run: bundle exec rake
+      continue-on-error: ${{ matrix.allow-failure || false }}
+
+  install:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Setup Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.0.1'
+
+    - name: Build gem
+      run: gem build spinels-redd
+
+    - name: Install gem
+      run: gem install *.gem

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--require spec_helper
+--color

data/.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Metrics/LineLength:
+  Max: 100
+
+Style/MutableConstant:
+  Enabled: false
+
+# Dumb, but also brand new.
+Style/NumericPredicate:
+  Enabled: false
+
+# 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
+
+Naming/FileName:
+  Enabled: false

data/CONTRIBUTING.md

@@ -0,0 +1,63 @@
+# Contributing
+
+This is the documentation that contains information on contributing to Redd.
+Note that I would appreciate contributions to this document itself.
+
+There isn't an official code of conduct, just
+[don't be a dick](https://twitter.com/wilw/status/5966220832).
+
+### Filing an Issue / Making a Pull Request
+
+**The quickest way to get a feature into Redd is by raising an issue.**
+
+Please try to provide as much information as possible when submitting an
+issue. I'm not going to get mad if the issue is inconsequential, so don't
+hesitate to ask even simple questions about the gem.
+
+When making a pull request, you don't really have to write tests for the
+time being (what a relief for you!). Just make sure you have manually tested
+the call yourself and rubocop doesn't whine about it too much.
+
+### Architecture
+The central part of the gem is the `Client`. It knows how to make HTTP
+requests. For specific reddit behaviour, there is a subclass named
+`APIClient`. Keep in mind that neither of these are actually aware of the API
+methods, just how to interact with the API.
+
+To simplify the architecture as much as humanly possible, everything is
+represented as a model. A model holds a client and some attributes. It has
+some methods that make API requests using the client and maybe some of its
+attributes.
+
+Each authentication method has an `AuthStrategy` associated with it. This only
+provides API keys and is aware of the OAuth2 protocol.
+
+The `Redd.it` method combines all of these:
+
+1. It creates an `AuthStrategy`.
+2. It creates an `APIClient` using the `AuthStrategy`.
+3. It creates a `Session` model using the `APIClient`.
+4. It returns the created `Session`.
+
+This seems complicated but trust me on this, this gem has gone through three
+rewrites.
+
+### Reddit API
+
+Here are some links where you can find helpful information about the reddit
+API:
+
+1. [API reference](https://www.reddit.com/dev/api)
+2. [GitHub Wiki](https://github.com/reddit/reddit/wiki/API)
+3. [API Subreddit](https://www.reddit.com/r/redditdev)
+
+### Testing
+
+Unit testing has turned out to be ultimately pointless; the API is a total
+mess and requires a deep knowledge of how reddit works. Testing the multitude
+of parameters that each call takes, it's safe to assume individual unit tests
+will span a few thousand lines and be incredibly brittle. So when you submit a
+pull-request, I expect you to have *manually tested the calls yourself*.
+
+To help you, there is a console that can be found at `./bin/console`. Give it
+a shot — I think you'll love it!

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'bundle exec rspec -fp' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb})      { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end

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

@@ -0,0 +1,119 @@
+<div align="center">
+  <p>
+    <!-- Redd -->
+    <img src="https://raw.githubusercontent.com/avinashbot/redd/master/logo.png" width="500"><br>
+    <!-- Badges -->
+    <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://github.com/spinels/redd/actions?query=workflow%3ACI">
+      <img src="https://github.com/spinels/redd/workflows/CI/badge.svg?branch=master" alt="Build Status">
+    </a>
+    <a href="https://rubygems.org/gems/redd">
+      <img src="http://img.shields.io/gem/dt/redd.svg?style=flat-square" alt="Gem Downloads">
+    </a>
+  </p>
+  <!-- Intro Text -->
+  <p>
+    <strong>Redd</strong> is a <strong>batteries-included</strong>
+    API wrapper for <a href="https://www.reddit.com/dev/api">reddit</a>.
+  </p>
+</div>
+
+---
+
+### Features
+
+- Supports most of the reddit API, including live threads and the beta mod-mail.
+- Includes support for streaming new posts and comments.
+- Built-in rate limiting and error handling.
+- Automatic retrying of failed requests.
+
+### Demo
+
+#### Reddit Bot
+
+```ruby
+require 'redd'
+
+session = Redd.it(
+  user_agent: 'Redd:RandomBot:v1.0.0 (by /u/Mustermind)',
+  client_id:  'PQgS0UaX9l70oQ',
+  secret:     'PsF_kVZrW8nSVCG5kNsIgl-AaXE',
+  username:   'RandomBot',
+  password:   'hunter2'
+)
+
+session.subreddit('all').comments.stream do |comment|
+  if comment.body.include?('roll a dice')
+    comment.reply("It's a #{rand(1..6)}!")
+  elsif comment.body.include?('flip a coin')
+    comment.reply("It's a #{%w(heads tails).sample}!")
+  end
+end
+```
+
+#### Web Application
+
+```ruby
+require 'sinatra'
+require 'redd/middleware'
+
+use Rack::Session::Cookie
+use Redd::Middleware,
+    user_agent:   'Redd:Username App:v1.0.0 (by /u/Mustermind)',
+    client_id:    'PQgS0UaX9l70oQ',
+    secret:       'PsF_kVZrW8nSVCG5kNsIgl-AaXE',
+    redirect_uri: 'http://localhost:4567/auth/reddit/callback',
+    scope:        %w(identity),
+    via:          '/auth/reddit'
+
+get '/' do
+  reddit = request.env['redd.session']
+
+  if reddit
+    "Hello /u/#{reddit.me.name}! <a href='/logout'>Logout</a>"
+  else
+    "<a href='/auth/reddit'>Sign in with reddit</a>"
+  end
+end
+
+get '/auth/reddit/callback' do
+  redirect to('/') unless request.env['redd.error']
+  "Error: #{request.env['redd.error'].message} (<a href='/'>Back</a>)"
+end
+
+get '/logout' do
+  request.env['redd.session'] = nil
+  redirect to('/')
+end
+```
+
+### FAQ
+
+#### Are those examples 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).
+
+#### Where can I find the documentation?
+
+[**Gem**](http://www.rubydoc.info/gems/redd/Redd/Models/Session) / [**GitHub**](http://www.rubydoc.info/github/avinashbot/redd/master/Redd/Models/Session)
+
+#### Where can I ask for help if I'm having issues?
+Check out the [**official subreddit**](https://www.reddit.com/r/Redd) or raise a [**GitHub issue**](https://github.com/avinashbot/redd/issues/new).
+
+#### How do I request a feature / contribute?
+Take a look at  [**CONTRIBUTING.md**](https://github.com/avinashbot/redd/blob/master/CONTRIBUTING.md).
+
+#### How can I contact you?
+[Reddit](https://www.reddit.com/message/compose/?to=Mustermind) /
+[Email](mailto:avinash@dwarapu.me)
+
+---
+
+<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

@@ -0,0 +1,12 @@
+# 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: %i[rubocop spec]