simply_reddit 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9314ce9fad38780acb879c80600ddaf188372609fa06e8b19149e6765c70dc29
-  data.tar.gz: 2f24334b16b57cfb7c408e48577568683180315d219c117776580d43a2066e7d
+  metadata.gz: 7b190572f13f32f358a3170d73f3bbd407b086c1fc07fdb70a420120445bf290
+  data.tar.gz: 26cdcac41d91a02dc8d9fb9dc40d1d1793864c0d8dbaf87bf526725086a3e7bd
 SHA512:
-  metadata.gz: ab18e24d65fa371193607a3485c93e079de22aa3ea0691de0b96e69378f10706c700ef8483d7e42b7a1945b682a77adb36bc609290fbed94ae3538e3b6a4b347
-  data.tar.gz: 904d5aff3627c644fdd27b4699e60bff99acd66265628d253874b5b3263d763fbf6211ebce5302261d9ab7cb37ee823f41c4ba33976996f515ef9825dd7ab344
+  metadata.gz: d677d6c7f8aa9d8182c23bdbc8ffdff479b8f920f91215bca24de71feac824d203ba57e643a2753d264795fdc9277260f4ee90eb8500ca1c1368495051abcd06
+  data.tar.gz: 953de1f9852f38829a7bd2cb312dd1b728778e0792f176c8af8320d2b45fcb9a74979ef9f0424dbc5809f4687249e626b598b31275093f608b1e57b5ce25a396

data/README.md

@@ -1,35 +1,94 @@
 # SimplyReddit
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/simply_reddit`. To experiment with that code, run `bin/console` for an interactive prompt.
+A simple Ruby wrapper for the Reddit API.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simply_reddit'
+```
 
-Install the gem and add to the application's Gemfile by executing:
+And then execute:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle install
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or install it yourself as:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install simply_reddit
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Authentication
+
+```ruby
+require 'simply_reddit'
+
+client = SimplyReddit::Client.new(
+  client_id: 'your_client_id',
+  secret: 'your_client_secret',
+  username: 'your_username',
+  password: 'your_password'
+)
+```
+
+### Getting Current User Information
+
+```ruby
+# Get information about the authenticated user
+response = client.me
+puts response.body # User data as JSON
+puts response.status # HTTP status code
+```
+
+### Working with Subreddits
 
-## Development
+```ruby
+# Access a specific subreddit
+subreddit = client.subreddit('ruby')
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+# The subreddit object provides access to subreddit-specific functionality
+# (specific methods depend on your Subreddit class implementation)
+```
+
+### Working with Users
+
+```ruby
+# Access a specific user's profile
+user = client.user('spez')
+
+# The user object provides access to user-specific functionality  
+# (specific methods depend on your User class implementation)
+```
+
+### Response Format
+
+All API responses are wrapped in a `Response` object with the following structure:
+
+```ruby
+response.status  # HTTP status code (200, 404, etc.)
+response.headers # HTTP headers as a hash
+response.body    # Parsed JSON response body
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+### Error Handling
 
-## Contributing
+```ruby
+response = client.me
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/simply_reddit.
+case response.status
+when 200
+  puts "Success: #{response.body}"
+when 401
+  puts "Authentication failed"
+when 403
+  puts "Forbidden - check your credentials"
+else
+  puts "Error: #{response.status}"
+end
+```

data/lib/simply_reddit/base_client.rb

@@ -0,0 +1,68 @@
+require "faraday"
+
+class SimplyReddit::BaseClient
+  # Response struct to wrap API responses
+  Response = Struct.new(:status, :headers, :body)
+
+  def initialize(base_url:, adapter: Faraday.default_adapter, headers: {})
+    @base_url = base_url
+    @adapter = adapter
+    @default_headers = headers
+    @connection = nil
+  end
+
+  # HTTP methods
+  def get(path, params = {})
+    response = connection.get(path, params)
+    wrap_response(response)
+  end
+
+  def post(path, body = {})
+    response = connection.post(path, body)
+    wrap_response(response)
+  end
+
+  def put(path, body = {})
+    response = connection.put(path, body)
+    wrap_response(response)
+  end
+
+  def delete(path, params = {})
+    response = connection.delete(path, params)
+    wrap_response(response)
+  end
+
+  protected
+
+  def configure_connection(conn)
+    conn.request :json
+    conn.response :json, content_type: "application/json"
+  end
+
+  def connection_headers
+    @default_headers
+  end
+
+  private
+
+  def wrap_response(faraday_response)
+    Response.new(
+      body: faraday_response.body,
+      status: faraday_response.status,
+      headers: faraday_response.headers
+    )
+  end
+
+  def connection
+    @connection ||= Faraday.new do |conn|
+      conn.url_prefix = @base_url
+      conn.adapter @adapter
+
+      connection_headers.each do |key, value|
+        conn.headers[key] = value
+      end
+
+      configure_connection(conn)
+    end
+  end
+end

data/lib/simply_reddit/client.rb

@@ -0,0 +1,63 @@
+require "faraday"
+require_relative "base_client"
+require_relative "subreddit"
+require_relative "user"
+
+class SimplyReddit::Client < SimplyReddit::BaseClient
+  BASE_URL = "https://oauth.reddit.com"
+  DEFAULT_GRANT_TYPE = "client_credentials"
+  USER_AGENT = "Ruby:SimplyReddit:v#{SimplyReddit::VERSION} (by unknown)"
+
+  def initialize(client_id:, secret:, username:, password:, adapter: Faraday.default_adapter)
+    @user_agent = USER_AGENT
+    @client_id = client_id
+    @secret = secret
+    @username = username
+    @password = password
+    @access_token = request_access_token
+    
+    super(
+      base_url: BASE_URL,
+      adapter: adapter,
+      headers: {
+        "User-Agent" => @user_agent,
+        "Authorization" => "Bearer #{@access_token}"
+      }
+    )
+  end
+
+  def subreddit(name)
+    SimplyReddit::Subreddit.new(client: self, name: name)
+  end
+
+  def user(username)
+    SimplyReddit::User.new(client: self, username: username)
+  end
+
+  def me
+    get("/api/v1/me")
+  end
+
+  private
+
+  def request_access_token(grant_type = DEFAULT_GRANT_TYPE, options = {})
+    endpoint = "https://www.reddit.com/api/v1/access_token"
+
+    auth_connection = Faraday.new do |conn|
+      conn.headers['User-Agent'] = @user_agent
+      conn.request :authorization, :basic, @client_id, @secret
+      conn.response :json, content_type: "application/json"
+    end
+    
+    response = auth_connection.post(endpoint) do |req|
+      req.body = URI.encode_www_form({
+        grant_type: grant_type,
+        username: @username,
+        password: @password
+      })
+    end
+    
+    response.body["access_token"]
+  end
+end
+

data/lib/simply_reddit/subreddit.rb

@@ -0,0 +1,26 @@
+class SimplyReddit::Subreddit
+  def initialize(client:, name:)
+    @client = client
+    @name = name
+  end
+
+  def hot(limit: 25)
+    @client.get("/r/#{@name}/hot", limit: limit)
+  end
+
+  def new(limit: 25)
+    @client.get("/r/#{@name}/new", limit: limit)
+  end
+
+  def top(limit: 25, t: 'day')
+    @client.get("/r/#{@name}/top", limit: limit, t: t)
+  end
+
+  def rising(limit: 25)
+    @client.get("/r/#{@name}/rising", limit: limit)
+  end
+
+  def about
+    @client.get("/r/#{@name}/about")
+  end
+end

data/lib/simply_reddit/user.rb

@@ -0,0 +1,18 @@
+class SimplyReddit::User
+  def initialize(client:, username:)
+    @client = client
+    @username = username
+  end
+
+  def about
+    @client.get("/user/#{@username}/about")
+  end
+
+  def posts(limit: 25, sort: 'new')
+    @client.get("/user/#{@username}/submitted", limit: limit, sort: sort)
+  end
+
+  def comments(limit: 25, sort: 'new')
+    @client.get("/user/#{@username}/comments", limit: limit, sort: sort)
+  end
+end

data/lib/simply_reddit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SimplyReddit
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/simply_reddit.rb

@@ -1,12 +1,24 @@
 # frozen_string_literal: true
 
 require_relative "simply_reddit/version"
-require "simply_reddit/translator"
+
 
 module SimplyReddit
+  autoload :BaseClient, "simply_reddit/base_client"
+  autoload :Client, "simply_reddit/client"
+  autoload :Subreddit, "simply_reddit/subreddit"
+  autoload :User, "simply_reddit/user"
+
   class Error < StandardError; end
-  def self.hi(language = "english")
-    translator = Translator.new(language)
-    puts translator.hi
+
+  # Convenience method for creating a client
+  def self.client(client_id:, secret:, username:, password:, **options)
+    Client.new(
+      client_id: client_id,
+      secret: secret,
+      username: username,
+      password: password,
+      **options
+    )
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simply_reddit
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Ken Lu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-08-23 00:00:00.000000000 Z
+date: 2025-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -34,7 +34,10 @@ files:
 - README.md
 - Rakefile
 - lib/simply_reddit.rb
-- lib/simply_reddit/translator.rb
+- lib/simply_reddit/base_client.rb
+- lib/simply_reddit/client.rb
+- lib/simply_reddit/subreddit.rb
+- lib/simply_reddit/user.rb
 - lib/simply_reddit/version.rb
 - sig/simply_reddit.rbs
 homepage: https://github.com/kenyounot123/simply_reddit

data/lib/simply_reddit/translator.rb

@@ -1,14 +0,0 @@
-class SimplyReddit::Translator
-  def initialize(language)
-    @language = language
-  end
-
-  def hi
-    case @language
-    when "spanish"
-      "hola mundo"
-    else
-      "hello world"
-    end 
-  end
-end