lita-reddit 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee46f86490552d2009ed559059a365cc58440049
-  data.tar.gz: 0d3f1eb18bdd288aea454b932fd2957357900e7d
+  metadata.gz: 276e3bd121e48d563f8fd185f836cf5a135628f9
+  data.tar.gz: ef9ac64393a3d180ca496d2935fee4589c514206
 SHA512:
-  metadata.gz: 989b6433a109c62679b1c26ff24e130f3e0037e2401f5fb060c29fb513e4caab22de44447aa96644009cd93d4eae0a3264d9c2f49354e7d0ceae8f40509a1e74
-  data.tar.gz: f50dc828446ed92dca12e0ba2fc404694f815ac15c08746672d32f58674332fe600c597d31f43280f2e246f74e4ddc16253781219f5c92c3b872f43aa98335f8
+  metadata.gz: 311a90782184417049bb0ed2e61bd7c061bd753b1e5d8e16fb83c75159e18d45344c865b92b94ca780459d392f701083dff241bf0fb56ada30709d4fd27491d0
+  data.tar.gz: aba18ec03fc60acec0aa6a384c50b35fd2befede4da51d1c8cfd29b763a0e227cb1ace9958d9f429c08126a09938729a750d93924494c7b22b4343c5497fa789

data/.rubocop.yml

@@ -0,0 +1,46 @@
+AbcSize:
+  Enabled: false
+AlignParameters:
+  Enabled: false
+AndOr:
+  Enabled: false
+CaseEquality:
+  Enabled: false
+ClassLength:
+  Enabled: false
+Documentation:
+  Enabled: false
+DoubleNegation:
+  Enabled: false
+EachWithObject:
+  Enabled: false
+EndAlignment:
+  AlignWith: variable
+GuardClause:
+  Enabled: false
+IndentHash:
+  Enabled: false
+LineLength:
+  Max: 100
+MethodLength:
+  Enabled: false
+NonNilCheck:
+  Enabled: false
+ParameterLists:
+  Max: 6
+RegexpLiteral:
+  Enabled: false
+RescueException:
+  Enabled: false
+SignalException:
+  Enabled: false
+SpecialGlobalVars:
+  Enabled: false
+StringLiterals:
+  EnforcedStyle: double_quotes
+TrailingComma:
+  Enabled: false
+TrivialAccessors:
+  Enabled: false
+Style/FileName:
+  Enabled: false

data/README.md

@@ -13,16 +13,21 @@ gem "lita-reddit"
 ## Configuration
 
 ``` ruby
-# List of subreddit/channel to update pairs
-config.handlers.reddit.reddits = [{subreddit: "subreddit_name", channel: "##channel_to_update"}]
 # The client ID from the Reddit API
 config.handlers.reddit.client_id = "client_from_api"
 # The secret ID from the Reddit API
 config.handlers.reddit.client_secret = "secret_from_api"
+# List of subreddit/channel to update pairs
+config.handlers.reddit.reddits = [{subreddit: "subreddit_name", channel: "##channel_to_update"}]
 # The delay to wait before starting the polling in seconds (optional, defaults to 30s)
 config.handlers.reddit.startup_delay = 30
 # The interval in between requests (optional, defaults to 300s)
 config.handlers.reddit.poll_interval = 300
+# The limit of number of posts to output from any sub per poll (optional, defaults to 3)
+config.handlers.reddit.post_limit = 3
+# The string to use when posting to the channel. Supports %{user}, %{title}, %{subreddit}, %{id},
+# and ${shortlink}. (Optional, defaults to "/u/%{user}: %{title} | /r/%{subreddit} | %{shortlink}")
+config.handlers.reddit.post_text = "/u/%{user}: %{title} | /r/%{subreddit} | %{shortlink}"
 ```
 
 ## Usage

data/lib/lita-reddit.rb

@@ -5,6 +5,8 @@ Lita.load_locales Dir[File.expand_path(
 )]
 
 require "lita/handlers/reddit"
+require "lita/handlers/reddit/base"
+require "lita/handlers/reddit/subreddit_poster"
 
 Lita::Handlers::Reddit.template_root File.expand_path(
   File.join("..", "..", "templates"),

data/lib/lita/handlers/reddit.rb

@@ -1,80 +1,22 @@
 module Lita
   module Handlers
     class Reddit < Handler
-      config :reddits, types: Array, required: true
       config :client_id, type: String, required: true
       config :client_secret, type: String, required: true
-      config :mod do
-        config :reddits, type: Array
-      end
       config :startup_delay, type: Integer, default: 30
-      config :poll_interval, type: Integer, default: 300
-
-      on :connected, :setup
-
-      @@user_agent = 'ruby:lita-reddit:v0.0.7 (by /u/dosman711)'
 
-      def setup(payload)
-        after(config.startup_delay) do
-          update_token
-          refresh_posts
-        end
-        every (config.poll_interval) do
-          refresh_posts
-        end
-        # update userless token once per hour
-        every (3300) do
-          update_token
-        end
-      end
+      config :reddits, types: Array, required: true
+      config :post_text,
+        type: String,
+        default: "/u/%{user}: %{title} | /r/%{subreddit} | %{shortlink}"
+      config :poll_interval, type: Integer, default: 300
+      config :post_limit, type: Integer, default: 3
 
-      def update_token
-        log.debug('lita-reddit: updating userless oauth token')
-        request = http
-        request.basic_auth(config.client_id, config.client_secret)
-        auth_response = request.post do |req|
-          req.url 'https://www.reddit.com/api/v1/access_token'
-          req.headers['User-Agent'] = @@user_agent
-          req.body = 'grant_type=client_credentials'
-        end
-        response = MultiJson.load(auth_response.body)
-        @@access_token = response['access_token']
+      config :base_url, type: String
+      config :mod do
+        config :reddits, type: Array
       end
-
-      def refresh_posts
-        post_text = 'From /r/%s: %s (http://redd.it/%s)'
-        base_redis_key = 'seen_list_%s_%s'
-        config.reddits.each do |reddit|
-          log.debug('lita-reddit: updating posts for /r/%s' % [reddit[:subreddit]])
-          #new on the left
-          redis_key = base_redis_key % [reddit[:channel], reddit[:subreddit]]
-          post_limit = 3
-          seen_reddits = redis.lrange(redis_key, 0, 10)
-          request = http
-          resp = request.get do |req|
-            req.url 'https://oauth.reddit.com/r/%s/new.json' % [reddit[:subreddit]]
-            req.headers['Authorization'] = 'bearer %s' % [@@access_token]
-            req.headers['User-Agent'] = @@user_agent
-            req.headers['Content-Type'] = 'Application/json'
-            req.params['limit'] = post_limit
-            req.params['before'] = redis.lindex(redis_key, 0)
-          end
-          log.debug('lita-reddit: HTTP result of request %s' % [resp.status])
-          response_body = MultiJson.load(resp.body)
-          results = response_body['data']['children']
-          target = Source.new(room: reddit[:channel])
-          results.reverse.each do |post|
-            if !seen_reddits.include?(post['data']['id']) then
-              robot.send_message(target, post_text % [post['data']['subreddit'], post['data']['title'], post['data']['id']])
-              redis.lpush(redis_key, post['data']['id'])
-            end
-            # keep a few extra around, 10 is still instantaneous
-            redis.ltrim(redis_key, 0, 10)
-          end
-        end
-      end 
     end
-
     Lita.register_handler(Reddit)
   end
 end

data/lib/lita/handlers/reddit/api_calls.rb

@@ -0,0 +1,56 @@
+module Lita
+  module Handlers
+    class Reddit < Handler
+      class ApiCalls < Handler
+        def initialize(client_id, client_secret)
+          @client_id = client_id
+          @client_secret = client_secret
+        end
+
+        def user_agent
+          "ruby:lita-reddit:v0.0.8 (by /u/dosman711)"
+        end
+
+        def update_token
+          log.info("lita-reddit: updating userless auth token")
+          request = http
+          request.basic_auth(@client_id, @client_secret)
+          auth_response = request.post do |req|
+            req.url "https://www.reddit.com/api/v1/access_token"
+            req.headers["User-Agent"] = user_agent
+            req.body = "grant_type=client_credentials"
+          end
+          response = MultiJson.load(auth_response.body)
+          @access_token = response["access_token"]
+        rescue Exception => msg
+          log.error("lita-reddit: Exception during token update: #{msg}")
+        end
+
+        def get_posts(subreddit, redis_key, limit = 3)
+          resp = http.get do |req|
+            req.url "https://oauth.reddit.com/r/#{subreddit}/new.json"
+            req.headers["Authorization"] = "bearer #{@access_token}"
+            req.headers["User-Agent"] = user_agent
+            req.headers["Content-Type"] = "Application/json"
+            req.params["limit"] = limit
+            req.params["before"] = redis_key
+          end
+          response_body = MultiJson.load(resp.body)
+          results = response_body["data"]["children"]
+          results.collect do |r|
+            {
+              id: r["data"]["id"],
+              subreddit: r["data"]["subreddit"],
+              title: r["data"]["title"],
+              user: r["data"]["author"],
+              shortlink: format("http://redd.it/%s", r["data"]["id"])
+            }
+          end
+        rescue Exception => msg
+          log.error("lita-reddit: Exception during get_posts: #{msg}")
+          return []
+        end
+      end
+    end
+  end
+end

data/lib/lita/handlers/reddit/base.rb

@@ -0,0 +1,37 @@
+require_relative "api_calls"
+module Lita
+  module Handlers
+    class Reddit < Handler
+      class Base < Handler
+        namespace "reddit"
+
+        def reddits
+          config.reddits
+        end
+
+        def startup_delay
+          config.startup_delay
+        end
+
+        def poll_interval
+          config.poll_interval
+        end
+
+        def post_limit
+          config.post_limit
+        end
+
+        def post_text
+          config.post_text
+        end
+
+        def client
+          if @client.nil?
+            @client = Lita::Handlers::Reddit::ApiCalls.new(config.client_id, config.client_secret)
+          end
+          @client
+        end
+      end
+    end
+  end
+end

data/lib/lita/handlers/reddit/subreddit_poster.rb

@@ -0,0 +1,58 @@
+module Lita
+  module Handlers
+    class Reddit < Handler
+      class SubredditPoster < Base
+        namespace "reddit"
+        on :connected, :setup
+        on :reddit_update_token, :update_token
+        on :reddit_refresh_posts, :refresh_posts
+
+        def setup(_payload)
+          after startup_delay do
+            robot.trigger(:reddit_update_token)
+          end
+          every poll_interval do
+            robot.trigger(:reddit_refresh_posts)
+          end
+          # update userless token once per hour
+          every 3300 do
+            robot.trigger(:reddit_update_token)
+          end
+        end
+
+        def update_token(_payload)
+          client.update_token
+          robot.trigger(:reddit_refresh_posts)
+        rescue Exception => msg
+          log.error("lita-reddit: Exception during token update: #{msg}")
+        end
+
+        def refresh_posts(_payload)
+          base_redis_key = "seen_list_%s_%s"
+          reddits.each do |reddit|
+            log.debug("lita-reddit: updating posts for /r/#{reddit[:subreddit]}")
+            # new on the left
+            redis_key = format(base_redis_key, reddit[:channel], reddit[:subreddit])
+            seen_reddits = redis.lrange(redis_key, 0, 10)
+            target = Source.new(room: reddit[:channel])
+            results = client.get_posts(reddit[:subreddit],
+                                       redis.lindex(redis_key, 0),
+                                       post_limit)
+            results.reverse.each do |post|
+              unless seen_reddits.include?(post[:id])
+                robot.send_message(target, post_text % post)
+                redis.lpush(redis_key, post[:id])
+              end
+
+              # keep a few extra around, 10 is still instantaneous
+              redis.ltrim(redis_key, 0, 10)
+            end
+          end
+          rescue Exception => msg
+            log.error("lita-reddit: Exception during post update #{msg}")
+        end
+      end
+      Lita.register_handler(SubredditPoster)
+    end
+  end
+end

data/lita-reddit.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-reddit"
-  spec.version       = "0.0.7"
+  spec.version       = "0.0.8"
   spec.authors       = ["Chris Baker"]
   spec.email         = ["dosman711@gmail.com"]
-  spec.description   = %q{A Reddit handler for Lita.}
-  spec.summary       = %q{A Reddit handler for the lita chat robot.}
+  spec.description   = "A Reddit handler for Lita."
+  spec.summary       = "A Reddit handler for the lita chat robot."
   spec.homepage      = "https://github.com/dosman711/lita-reddit"
   spec.license       = "MIT"
   spec.metadata      = { "lita_plugin_type" => "handler" }
@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "lita", ">= 4.2"
+  spec.add_runtime_dependency "lita", ">= 4.3"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", ">= 3.0.0"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "rubocop"
 end

data/spec/lita/handlers/reddit_spec.rb

@@ -1,4 +1,55 @@
 require "spec_helper"
 
-describe Lita::Handlers::Reddit, lita_handler: true do
+describe Lita::Handlers::Reddit::SubredditPoster,
+         lita_handler: true,
+         additional_lita_handlers: Lita::Handlers::Reddit do
+  before :each do
+    registry.config.handlers.reddit.tap do |config|
+      config.client_id = "clientId"
+      config.client_secret = "clientSecret"
+    end
+    @standard_response = [{
+        id: "post_id",
+        subreddit: "test",
+        title: "title",
+        user: "user",
+        shortlink: "http://redd.it/post_id"
+      }]
+  end
+  it "outputs new posts to the specified channels" do
+    registry.config.handlers.reddit.tap do |config|
+      config.reddits = [{ subreddit: "test", channel: "test" }]
+    end
+    allow(subject.client).to receive(:get_posts).and_return(@standard_response)
+    robot.trigger(:reddit_refresh_posts)
+    expect(replies.last).to eq("/u/user: title | /r/test | http://redd.it/post_id")
+  end
+
+  it "does not output duplicate posts" do
+    registry.config.handlers.reddit.tap do |config|
+      config.reddits = [{ subreddit: "test", channel: "test" }]
+    end
+    allow(subject.client).to receive(:get_posts).and_return(@standard_response)
+    robot.trigger(:reddit_refresh_posts)
+    robot.trigger(:reddit_refresh_posts)
+    expect(replies.last).to eq("/u/user: title | /r/test | http://redd.it/post_id")
+    expect(replies.count).to be 1
+  end
+
+  it "still posts if there is an error during retrieval" do
+    registry.config.handlers.reddit.tap do |config|
+      config.reddits = [{ subreddit: "test", channel: "test" }]
+    end
+    allow(subject.client).to receive(:get_posts).and_raise(RuntimeError)
+    robot.trigger(:reddit_refresh_posts)
+    allow(subject.client).to receive(:get_posts).and_return(@standard_response)
+    robot.trigger(:reddit_refresh_posts)
+    expect(replies.last).to eq("/u/user: title | /r/test | http://redd.it/post_id")
+    expect(replies.count).to be 1
+  end
+
+  it "handles exception during update_token" do
+    allow(subject.client).to receive(:update_token).and_raise(RuntimeError)
+    expect { subject.update_token(nil) }.not_to raise_error
+  end
 end

metadata

@@ -1,111 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: lita-reddit
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Chris Baker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-24 00:00:00.000000000 Z
+date: 2015-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '4.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '4.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A Reddit handler for Lita.
@@ -115,14 +129,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/lita-reddit.rb
 - lib/lita/handlers/reddit.rb
+- lib/lita/handlers/reddit/api_calls.rb
+- lib/lita/handlers/reddit/base.rb
+- lib/lita/handlers/reddit/subreddit_poster.rb
 - lita-reddit.gemspec
 - locales/en.yml
 - spec/lita/handlers/reddit_spec.rb
@@ -139,17 +157,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A Reddit handler for the lita chat robot.