reddit_api 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 688cae4985298c52e9364068ca035ae3be2ae2e8
-  data.tar.gz: 89f51608f590d8bc11da5522c428c5a4ed947377
+  metadata.gz: b9857234245fc7df4fa6eeb8c4ccc4cd9fc9cb0f
+  data.tar.gz: 4b50dbe9dec2cc73d0ca957d7dd57a673452c978
 SHA512:
-  metadata.gz: c9d7b636fd32ba1389e5702b3dbf0156778fd3eac3089c6ee2c32a08a82caf80a8be7dc28f9f9a73a2aab2321d3429d37af7fd8a454e5fef738a47ecba05c09f
-  data.tar.gz: 101bb2f95867db17a117a7ac452998bdb6d97ce7c9f05748212665dd9242f0f608e24bba6683af4ab947b9b006b20298bcbf0a11c6c91c2e5f3e95f345167186
+  metadata.gz: 43a6de736b1ebc6bb82a802d29336fd2dc471b4fd873b9c8fa3c30b9a7a9f680a89f55e689fb0d113546f6462c0e5765be08ff7c4171810b043cf63f0a5b9773
+  data.tar.gz: 41b3f5c0428b39bb0162ab65d70d7656cf23d1833f98d3e2abc323ea5afebc4d2f573ae10759fac4d79e9f088c58e6d55cf8abb0108dcb4e57f9a059edf9882f

data/Rakefile

@@ -1,19 +1,2 @@
 require "bundler/gem_tasks"
 
-namespace :rspec do
-
-  desc "Runs all RSpec specs"
-  task :all do
-    set_environment("TEST")
-    run_all_specs
-  end
-
-  def set_environment(environment)
-    ENV["ENVIRONMENT"] = environment
-  end
-
-  def run_all_specs
-    system("rspec")
-  end
-
-end

data/lib/reddit_api/client.rb

@@ -13,30 +13,37 @@ module RedditApi
 
     attr_reader :agent, :id, :password, :secret, :username, :failures
 
-    MAXIMUM_RECORDS = 100
     MAX_FAILURES = 5
     ERROR_CODES = (400..511)
     SLEEP_TIME = self.sleep_time
 
-
     def initialize(args = {})
-      @agent = ENV["REDDIT_AGENT"]
       @client = args.fetch(:client, HTTParty)
-      @id = ENV["REDDIT_AGENT"]
-      @password = ENV["REDDIT_AGENT"]
-      @secret = ENV["REDDIT_AGENT"]
-      @username = ENV["REDDIT_AGENT"]
-      @base_url = "https://oauth.reddit.com/"
+      @requestor = args.fetch(:requestor, RedditApi::Requestor.new(client: client))
       @failures = args.fetch(:failures, 0)
       @null_response_factory = RedditApi:: NullResponse
       @last_record = nil
     end
 
     def get(endpoint, count, resource_type)
+      if count > 1
+        get_many(endpoint, count, resource_type)
+      else
+        get_one(endpoint, count, resource_type)
+      end
+    end
+
+    protected
+    attr_writer :failures, :last_record
+    private
+    attr_reader :client, :base_url, :null_response_factory, :last_record,
+                :requestor
+
+    def get_many(endpoint, count, resource_type)
       sleep(SLEEP_TIME)
       records = {}
       loop do
-        new_records = request_records(endpoint, resource_type)
+        new_records = request_records(endpoint, resource_type, count)
         collect_records(new_records, records, count)
         break if break_get?(records, count)
       end
@@ -44,10 +51,9 @@ module RedditApi
       records.keys
     end
 
-    protected
-    attr_writer :failures, :last_record
-    private
-    attr_reader :client, :base_url, :null_response_factory, :last_record
+    def get_one(endpoint, count, resource_type)
+      request_records(endpoint, resource_type, count)
+    end
 
     def collect_records(new_records, collected_records, count)
       new_records.each do |record|
@@ -56,24 +62,22 @@ module RedditApi
       end
     end
 
-    def request_records(endpoint, resource_type)
+    def request_records(endpoint, resource_type, count)
       response = send_request(endpoint, resource_type)
-      parse_response(response)
+      parse_response(response, count)
     end
 
     def send_request(endpoint, resource_type)
-      url = base_url + endpoint
-      headers = generate_headers
-      query = generate_query(resource_type)
-      response = client.get(url, headers: headers, query: query)
+      request = requestor.build(endpoint, resource_type, last_record)
+      response = client.get(*request)
       response || null_response_factory.new
     end
 
-    def parse_response(response)
+    def parse_response(response, count)
       if bad_response?(response)
-        handle_bad_response
+        handle_bad_response(count)
       else
-        handle_successful_response(response)
+        handle_successful_response(response, count)
       end
     end
 
@@ -81,16 +85,28 @@ module RedditApi
       ERROR_CODES.cover?(response.code) || response["error"]
     end
 
-    def handle_bad_response
+    def handle_bad_response(count)
       self.failures += 1
-      []
+      if count > 1
+        []
+      else
+        nil
+      end
     end
 
-    def handle_successful_response(response)
+    def handle_successful_response(response, count)
+      if count > 1
+        handle_plural_response(response)
+      else
+        response
+      end
+    end
+
+    def handle_plural_response(response)
       if records = response["data"]["children"]
         store_last_record(records)
       else
-        bad_response
+        handle_bad_response
       end
     end
 
@@ -103,49 +119,5 @@ module RedditApi
       records.length >= desired_count || failures >= MAX_FAILURES
     end
 
-    def generate_headers
-      access_token = generate_access_token
-      {
-        "Authorization" => "bearer #{access_token}",
-        "user-agent" => agent
-      }
-    end
-
-    def generate_query(resource_type)
-      {
-        limit: MAXIMUM_RECORDS,
-        after: generate_after(resource_type)
-      }
-    end
-
-    def generate_after(resource_type)
-      if last_record
-        build_after(resource_type)
-      else
-        nil
-      end
-    end
-
-    def build_after(resource_type)
-      prefix = TYPE_PREFIXES[resource_type]
-      last_resource_id = last_record["data"]["id"]
-      "#{prefix}_#{last_resource_id}"
-    end
-
-    def generate_access_token
-      url = "https://www.reddit.com/api/v1/access_token"
-      basic_auth = { username: id,
-                     password: secret }
-      headers = { "user-agent" => agent }
-      body = { grant_type:  "password",
-               username:  username,
-               password: password }
-      response = client.post(url,
-                             basic_auth: basic_auth,
-                             headers: headers,
-                             body: body)
-      response["access_token"]
-    end
-
   end
 end

data/lib/reddit_api/requestor.rb

@@ -0,0 +1,72 @@
+
+module RedditApi
+  class Requestor
+
+      MAXIMUM_RECORDS = 100
+      AGENT = ENV["REDDIT_AGENT"]
+      ID = ENV["REDDIT_AGENT"]
+      PASSWORD = ENV["REDDIT_AGENT"]
+      SECRET = ENV["REDDIT_AGENT"]
+      USERNAME = ENV["REDDIT_AGENT"]
+      BASE_URL = "https://oauth.reddit.com/"
+
+      def initialize(args = {})
+        @client = args.fetch(:client, HTTParty)
+      end
+
+      def build(endpoint, resource_type, last_record = nil)
+        url = BASE_URL + endpoint
+        headers = generate_headers
+        query = generate_query(resource_type, last_record)
+        [url, { headers: headers, query: query }]
+      end
+
+      private
+      attr_reader :client
+
+      def generate_headers
+        access_token = generate_access_token
+        {
+          "Authorization" => "bearer #{access_token}",
+          "user-agent" => AGENT
+        }
+      end
+
+      def generate_query(resource_type, last_record)
+        {
+          limit: MAXIMUM_RECORDS,
+          after: generate_after(resource_type, last_record)
+        }
+      end
+
+      def generate_after(resource_type, last_record)
+        if last_record
+          build_after(resource_type, last_record)
+        else
+          nil
+        end
+      end
+
+      def build_after(resource_type, record)
+        prefix = TYPE_PREFIXES[resource_type]
+        last_resource_id = record["data"]["id"]
+        "#{prefix}_#{last_resource_id}"
+      end
+
+      def generate_access_token
+        url = "https://www.reddit.com/api/v1/access_token"
+        basic_auth = { username: ID,
+                       password: SECRET }
+        headers = { "user-agent" => AGENT }
+        body = { grant_type:  "password",
+                 username:  USERNAME,
+                 password: PASSWORD }
+        response = client.post(url,
+                               basic_auth: basic_auth,
+                               headers: headers,
+                               body: body)
+        response["access_token"]
+      end
+
+  end
+end

data/lib/reddit_api/subreddits.rb

@@ -12,6 +12,12 @@ module RedditApi
       build_all_subreddits(subreddits_data)
     end
 
+    def data_for(subreddit)
+      endpoint = "r/#{subreddit.name}/about.json"
+      response = client.get(endpoint, 1, :subreddit)
+      build_subreddit(response)
+    end
+
     private
     attr_reader :client, :subreddit_factory
 

data/lib/reddit_api/version.rb

@@ -1,3 +1,3 @@
 module RedditApi
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/lib/reddit_api.rb

@@ -2,6 +2,7 @@ require "reddit_api/version"
 require "dotenv/load"
 require "reddit_api/null_response"
 require "reddit_api/resource_type_prefixes"
+require "reddit_api/requestor"
 require "reddit_api/client"
 require "reddit_api/subreddits"
 require "reddit_api/subreddit"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reddit_api
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Anthony Fuentes
@@ -149,6 +149,7 @@ files:
 - lib/reddit_api/null_response.rb
 - lib/reddit_api/post.rb
 - lib/reddit_api/posts.rb
+- lib/reddit_api/requestor.rb
 - lib/reddit_api/resource_type_prefixes.rb
 - lib/reddit_api/subreddit.rb
 - lib/reddit_api/subreddits.rb