tightknit 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c25d587e79a5c9f72396b19a7ca2c983fe833397e475670319f7744e50e26eb
-  data.tar.gz: 56573cc74f9023577a2a51edde4c7f1d0cf84f808715ac5d17cca4c812e35505
+  metadata.gz: 930963313a29ee50d88f2d8e4f82630829a4595922271ef2a9754bc5778db604
+  data.tar.gz: e470f90293b160182439166009a60df6dda8d3be76da120f468ad0dc56652ef5
 SHA512:
-  metadata.gz: 3face97968c1f590c14083871411b41646d663d95d9bd4b56885241b5f55593a71aa717c83fe8d6edbd828d3517b7552fa1dbfc459af1c57179b988f48ff271f
-  data.tar.gz: 9079dd1b90c67ce1363f1a6e0a70f7b048d418fffe1186164c98be0d3850fbcb04b0bd3c1c0d5dfaa33826f75ee062ef7ae27a165a3fccad6f635b300d95d201
+  metadata.gz: 23ea56ffcd878838adfe54b0b564be1c56be899147248b30a82f9db064034473ae1fc77c3831324d5e8ab137e439154c44f5142cc7f1145436fbb51f59b0a951
+  data.tar.gz: 1fdb594e73c7eee8ec48dda0a5aefd2087213af31b753cc7f523a8a2c6e8d0ed2f6c2c9d51d51d7a06c2b6c3e58f68e2a405725629d9c8d73b4bb9114d54345f

data/README.md

@@ -34,9 +34,6 @@ client = Tightknit::Client.new(api_key: 'your_api_key')
 
 ### Calendar Events
 
-Currently, listing all CalendarEvents and getting a single CalendarEvent is supported.
-If you need more features here, feel free to contribute or chat with us: hello@lokbros.com
-
 #### List Events
 
 ```ruby
@@ -78,6 +75,40 @@ event = client.calendar_events.get('event_id')
 formatted_event = client.calendar_events.format_data(event[:data])
 ```
 
+### Feeds
+
+#### List Feeds
+
+```ruby
+# Get feeds with default pagination (page 0, per_page 10)
+feeds = client.feeds.list
+
+# With custom pagination
+feeds = client.feeds.list(
+  page: 1,
+  per_page: 20
+)
+```
+
+#### Get a Specific Feed
+
+```ruby
+feed = client.feeds.get('feed_id')
+```
+
+#### Get Posts from a Feed
+
+```ruby
+# Get posts with default pagination (page 0, per_page 10)
+posts = client.feeds.posts('feed_id')
+
+# With custom pagination
+posts = client.feeds.posts('feed_id', 
+  page: 1,
+  per_page: 20
+)
+```
+
 ## Documentation
 
 The gem includes comprehensive YARD documentation. To generate the documentation, first ensure you have the required dependencies:
@@ -117,7 +148,3 @@ Get in touch with us anytime: hello@lokbros.com
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 Maintained by [LokBros Studio](https://lokbros.com).
-
-## Code of Conduct
-
-Everyone interacting in the Tightknit project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/tightknit/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -14,7 +14,7 @@ begin
     t.options = ["--output-dir", "doc/yard"]
     t.stats_options = ["--list-undoc"]
   end
-  
+
   desc "Generate YARD documentation and open in browser"
   task :yard_open do
     Rake::Task["yard"].invoke

data/lib/tightknit/client.rb

@@ -9,34 +9,41 @@ module Tightknit
   #
   # @example Creating a client
   #   client = Tightknit::Client.new(api_key: "your_api_key")
-  #   
+  #
   class Client
     # @return [Faraday::Connection] The Faraday connection object used for HTTP requests
     attr_reader :conn
-    
+
     # Initialize a new Tightknit API client
     #
     # @param api_key [String] The API key to use for authentication
     # @raise [Tightknit::Error] If no API key is provided
     def initialize(api_key:)
       @api_key = api_key
-      
+
       raise Error, "API key is required" unless @api_key
-      
+
       @conn = Faraday.new(url: BASE_URL) do |faraday|
         faraday.headers["Authorization"] = "Bearer #{@api_key}"
         faraday.headers["Content-Type"] = "application/json"
         faraday.adapter Faraday.default_adapter
       end
     end
-    
+
     # Access the calendar events resource
     #
     # @return [Tightknit::Resources::CalendarEvents] The calendar events resource
     def calendar_events
       @calendar_events ||= Resources::CalendarEvents.new(self)
     end
-    
+
+    # Access the feeds resource
+    #
+    # @return [Tightknit::Resources::Feeds] The feeds resource
+    def feeds
+      @feeds ||= Resources::Feeds.new(self)
+    end
+
     # Make a GET request to the API
     #
     # @param path [String] The path to request
@@ -49,9 +56,9 @@ module Tightknit
     rescue Faraday::Error => e
       handle_error(e)
     end
-    
+
     private
-    
+
     # Handle the API response
     #
     # @param response [Faraday::Response] The Faraday response object
@@ -68,11 +75,11 @@ module Tightknit
         rescue JSON::ParserError
           response.body || "Unknown error"
         end
-        
+
         raise Error, "API Error (#{response.status}): #{error_message}"
       end
     end
-    
+
     # Handle Faraday errors
     #
     # @param error [Faraday::Error] The Faraday error
@@ -81,4 +88,4 @@ module Tightknit
       raise Error, "Network Error: #{error.message}"
     end
   end
-end 
+end

data/lib/tightknit/resources/calendar_events.rb

@@ -22,7 +22,7 @@ module Tightknit
       def initialize(client)
         @client = client
       end
-      
+
       # Get a list of calendar events
       #
       # @param options [Hash] Options for filtering events
@@ -35,20 +35,20 @@ module Tightknit
         page = options[:page] || 0
         per_page = options[:per_page] || 10
         time_filter = options[:time_filter]
-        status = options[:status] || 'published'
-        
+        status = options[:status] || "published"
+
         params = {
           page: page,
           per_page: per_page,
           status: status
         }
-        
+
         # Only add time_filter to params if it's specified
         params[:time_filter] = time_filter if time_filter
-        
-        @client.get('calendar_events', params)
+
+        @client.get("calendar_events", params)
       end
-      
+
       # Get both past and upcoming events
       #
       # @param options [Hash] Options for filtering events
@@ -59,26 +59,26 @@ module Tightknit
       def all(options = {})
         # Get upcoming events
         upcoming_options = options.dup
-        upcoming_options[:time_filter] = 'upcoming'
+        upcoming_options[:time_filter] = "upcoming"
         upcoming_response = list(upcoming_options)
-        
+
         # Get past events
         past_options = options.dup
-        past_options[:time_filter] = 'past'
+        past_options[:time_filter] = "past"
         past_response = list(past_options)
-        
+
         # Combine the results
         if upcoming_response[:success] && past_response[:success]
           combined_records = []
-          
+
           if upcoming_response[:data] && upcoming_response[:data][:records]
             combined_records += upcoming_response[:data][:records]
           end
-          
+
           if past_response[:data] && past_response[:data][:records]
             combined_records += past_response[:data][:records]
           end
-          
+
           # Create a combined response with the same structure
           {
             success: true,
@@ -92,7 +92,7 @@ module Tightknit
           upcoming_response[:success] ? upcoming_response : past_response
         end
       end
-      
+
       # Get a specific calendar event
       #
       # @param event_id [String] The ID of the event to retrieve
@@ -101,7 +101,7 @@ module Tightknit
       def get(event_id)
         @client.get("calendar_events/#{event_id}")
       end
-      
+
       # Format event data for the API
       #
       # @param event_data [Hash] The raw event data
@@ -110,29 +110,29 @@ module Tightknit
       def format_data(event_data)
         # Create a new hash to avoid modifying the original
         formatted = event_data.dup
-        
+
         # Format description if it's a string
         if formatted[:description].is_a?(String)
-          formatted[:description] = { text: formatted[:description] }
+          formatted[:description] = {text: formatted[:description]}
         end
-        
+
         # Format recap if it's a string
         if formatted[:recap].is_a?(String)
-          formatted[:recap] = { text: formatted[:recap] }
+          formatted[:recap] = {text: formatted[:recap]}
         end
-        
+
         # Format hosts if it's an array of IDs
         if formatted[:hosts].is_a?(Array)
-          formatted[:hosts] = { slack_user_ids: formatted[:hosts] }
+          formatted[:hosts] = {slack_user_ids: formatted[:hosts]}
         end
-        
+
         # Format speakers if it's an array of IDs
         if formatted[:speakers].is_a?(Array)
-          formatted[:speakers] = { slack_user_ids: formatted[:speakers] }
+          formatted[:speakers] = {slack_user_ids: formatted[:speakers]}
         end
-        
+
         formatted
-      end      
+      end
     end
   end
-end 
+end

data/lib/tightknit/resources/feeds.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Tightknit
+  # The Resources module contains classes for interacting with different API resources.
+  module Resources
+    # The Feeds class provides methods for interacting with the feeds API.
+    # It allows listing feeds and retrieving posts from feeds.
+    #
+    # @example List feeds
+    #   client = Tightknit.client
+    #   feeds = client.feeds.list
+    #
+    # @example Get a specific feed
+    #   client = Tightknit.client
+    #   feed = client.feeds.get("feed_id")
+    #
+    # @example Get posts from a feed
+    #   client = Tightknit.client
+    #   posts = client.feeds.posts("feed_id")
+    #
+    class Feeds
+      # Initialize a new Feeds resource
+      #
+      # @param client [Tightknit::Client] The client to use for API requests
+      def initialize(client)
+        @client = client
+      end
+
+      # Get a list of feeds in the community
+      #
+      # @param options [Hash] Options for pagination
+      # @option options [Integer] :page (0) Page number
+      # @option options [Integer] :per_page (10) Number of records per page
+      # @return [Hash] Response containing feeds data
+      def list(options = {})
+        page = options[:page] || 0
+        per_page = options[:per_page] || 10
+
+        params = {
+          page: page,
+          per_page: per_page
+        }
+
+        @client.get("feeds", params)
+      end
+
+      # Get a specific feed
+      #
+      # @param feed_id [String] The ID of the feed to retrieve
+      # @return [Hash] Response containing feed data
+      # @raise [Tightknit::Error] If the feed is not found or another error occurs
+      def get(feed_id)
+        @client.get("feeds/#{feed_id}")
+      end
+
+      # Get posts from a specific feed
+      #
+      # @param feed_id [String] The ID of the feed to retrieve posts from
+      # @param options [Hash] Options for pagination
+      # @option options [Integer] :page (0) Page number
+      # @option options [Integer] :per_page (10) Number of records per page
+      # @return [Hash] Response containing posts data
+      # @raise [Tightknit::Error] If the feed is not found or another error occurs
+      def posts(feed_id, options = {})
+        page = options[:page] || 0
+        per_page = options[:per_page] || 10
+
+        params = {
+          page: page,
+          per_page: per_page
+        }
+
+        @client.get("feeds/#{feed_id}/posts", params)
+      end
+    end
+  end
+end

data/lib/tightknit/utils/html_formatter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Tightknit
+  # The Utils module contains utility classes for various helper functions.
   module Utils
     # The HtmlFormatter class provides utilities for converting Slack blocks to HTML.
     # This is useful for displaying event descriptions that are stored in Slack block format.
@@ -22,7 +23,7 @@ module Tightknit
     #       ]
     #     }
     #   ]
-    #   
+    #
     #   html = Tightknit::Utils::HtmlFormatter.slack_blocks_to_html(blocks)
     #   # => "<p class='mb-4'>Hello, world!</p>"
     #
@@ -37,12 +38,12 @@ module Tightknit
         # @return [String] HTML representation of the Slack blocks
         def slack_blocks_to_html(blocks)
           return "" unless blocks.is_a?(Array)
-          
+
           html = ""
-          
+
           blocks.each do |block|
             next unless block.is_a?(Hash) && block[:type] == "rich_text" && block[:elements].is_a?(Array)
-            
+
             block[:elements].each do |element|
               if element[:type] == "rich_text_section" && element[:elements].is_a?(Array)
                 # Add a paragraph with margin for spacing
@@ -85,12 +86,12 @@ module Tightknit
               end
             end
           end
-          
+
           html
         end
-        
+
         private
-        
+
         # Process a text element from Slack blocks
         #
         # This method takes a text element from Slack blocks and converts it to HTML.
@@ -100,10 +101,10 @@ module Tightknit
         # @return [String] HTML representation of the text element
         def process_text_element(element)
           return "" unless element.is_a?(Hash)
-          
+
           if element[:type] == "text"
             text = element[:text].to_s
-            
+
             if element[:style]
               if element[:style][:bold]
                 return "<strong>#{text}</strong>"
@@ -115,15 +116,15 @@ module Tightknit
                 return "<code>#{text}</code>"
               end
             end
-            
+
             return text
           elsif element[:type] == "link"
             return "<a href='#{element[:url]}' target='_blank' class='text-primary hover:underline'>#{element[:text]}</a>"
           end
-          
+
           ""
         end
       end
     end
   end
-end 
+end

data/lib/tightknit/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module Tightknit
-  VERSION = "0.1.1"
+  # Current version of the Tightknit gem
+  VERSION = "0.1.2"
 end

data/lib/tightknit.rb

@@ -3,6 +3,7 @@
 require_relative "tightknit/version"
 require_relative "tightknit/client"
 require_relative "tightknit/resources/calendar_events"
+require_relative "tightknit/resources/feeds"
 require_relative "tightknit/utils/html_formatter"
 
 # The Tightknit module is the main namespace for the Tightknit API client.
@@ -15,7 +16,7 @@ require_relative "tightknit/utils/html_formatter"
 module Tightknit
   # Error class for Tightknit-specific exceptions
   class Error < StandardError; end
-  
+
   # Base URL for the Tightknit API
   BASE_URL = "https://api.tightknit.dev/admin/v0/"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: tightknit
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Saalik Lokhandwala
 bindir: exe
 cert_chain: []
-date: 2025-04-21 00:00:00.000000000 Z
+date: 2025-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -56,6 +56,7 @@ files:
 - lib/tightknit.rb
 - lib/tightknit/client.rb
 - lib/tightknit/resources/calendar_events.rb
+- lib/tightknit/resources/feeds.rb
 - lib/tightknit/utils/html_formatter.rb
 - lib/tightknit/version.rb
 - sig/tightknit.rbs