forem-ruby 0.1.0.beta1

data/lib/forem/services/video_service.rb

@@ -0,0 +1,33 @@
+module Forem
+  module Services
+    # Service for interacting with the Forem Videos API.
+    #
+    # Lists articles that contain video content.
+    # Access via {Client#videos}. All methods inject the client's requestor
+    # automatically so no additional configuration is required.
+    #
+    # @example
+    #   client = Forem::Client.new("your-api-key")
+    #   videos = client.videos.list(page: 1)
+    #
+    # @see Video
+    # @see https://developers.forem.com/api/v1#/operations/videos
+    class VideoService < BaseService
+      # List articles that contain videos.
+      #
+      # @param params [Hash] query parameters
+      # @option params [Integer] :page page number (default: 1)
+      # @option params [Integer] :per_page number of results per page
+      # @param opts [Hash] per-request options
+      # @return [Array<Video>] list of articles with video content
+      #
+      # @example
+      #   client.videos.list(page: 2)
+      #
+      # @see https://developers.forem.com/api/v1#/operations/videos
+      def list(params = {}, opts = {})
+        Video.list(params, opts_with_requestor(opts))
+      end
+    end
+  end
+end

data/lib/forem/util.rb

@@ -0,0 +1,43 @@
+module Forem
+  # Utility helpers used internally by the forem-ruby library.
+  #
+  # These methods are not part of the public API surface for end users but are
+  # documented here for contributors and library maintainers.
+  module Util
+    # Recursively convert a raw Ruby value into the appropriate Forem type.
+    #
+    # The conversion rules are:
+    # * +Hash+   → {ForemObject} (via {ForemObject.construct_from})
+    # * +Array+  → Array with each element passed through this method
+    # * anything else → returned unchanged
+    #
+    # This method is called during attribute assignment in {ForemObject} so
+    # that nested API response hashes automatically become {ForemObject}
+    # instances with dynamic attribute access.
+    #
+    # @param value [Object] the raw value to convert.
+    # @return [ForemObject, Array, Object] the converted value.
+    #
+    # @example Converting a hash
+    #   Forem::Util.convert_to_forem_object({ "id" => 1, "name" => "Alice" })
+    #   #=> #<Forem::ForemObject ...>
+    #
+    # @example Converting an array of hashes
+    #   Forem::Util.convert_to_forem_object([{ "id" => 1 }, { "id" => 2 }])
+    #   #=> [#<Forem::ForemObject ...>, #<Forem::ForemObject ...>]
+    #
+    # @example Passing through a scalar value
+    #   Forem::Util.convert_to_forem_object("hello")  #=> "hello"
+    #   Forem::Util.convert_to_forem_object(42)       #=> 42
+    def self.convert_to_forem_object(value)
+      case value
+      when Hash
+        ForemObject.construct_from(value)
+      when Array
+        value.map { |v| convert_to_forem_object(v) }
+      else
+        value
+      end
+    end
+  end
+end

data/lib/forem/version.rb

@@ -0,0 +1,4 @@
+module Forem
+  # The current version of the forem-ruby gem.
+  VERSION = "0.1.0.beta1"
+end

data/lib/forem.rb

@@ -0,0 +1,91 @@
+require "forem/version"
+require "forem/configuration"
+require "forem/errors"
+require "forem/forem_response"
+require "forem/connection_manager"
+require "forem/util"
+require "forem/api_operations/request"
+require "forem/list_object"
+require "forem/forem_object"
+require "forem/api_operations/retrieve"
+require "forem/api_operations/create"
+require "forem/api_operations/update"
+require "forem/api_operations/delete"
+require "forem/api_operations/list"
+require "forem/api_operations/save"
+require "forem/api_resource"
+require "forem/api_requestor"
+require "forem/resources/article"
+require "forem/resources/user"
+require "forem/resources/comment"
+require "forem/resources/organization"
+require "forem/resources/tag"
+require "forem/resources/follow"
+require "forem/resources/follower"
+require "forem/resources/reading_list"
+require "forem/resources/podcast_episode"
+require "forem/resources/video"
+require "forem/resources/profile_image"
+require "forem/resources/billboard"
+require "forem/resources/page"
+require "forem/resources/segment"
+require "forem/resources/reaction"
+require "forem/resources/recommended_articles_list"
+require "forem/resources/agent_session"
+require "forem/resources/survey"
+require "forem/resources/analytics"
+require "forem/resources/health_check"
+require "forem/resources/admin_user"
+require "forem/resources/trend"
+require "forem/resources/concept"
+require "forem/resources/admin_concept"
+require "forem/resources/request_redirect"
+require "forem/services/base_service"
+require "forem/services/article_service"
+require "forem/services/user_service"
+require "forem/services/comment_service"
+require "forem/services/organization_service"
+require "forem/services/tag_service"
+require "forem/services/follow_service"
+require "forem/services/follower_service"
+require "forem/services/reading_list_service"
+require "forem/services/podcast_episode_service"
+require "forem/services/video_service"
+require "forem/services/profile_image_service"
+require "forem/services/billboard_service"
+require "forem/services/page_service"
+require "forem/services/segment_service"
+require "forem/services/reaction_service"
+require "forem/services/recommended_articles_list_service"
+require "forem/services/agent_session_service"
+require "forem/services/survey_service"
+require "forem/services/analytics_service"
+require "forem/services/health_check_service"
+require "forem/services/admin_user_service"
+require "forem/services/trend_service"
+require "forem/services/concept_service"
+require "forem/services/admin_concept_service"
+require "forem/services/request_redirect_service"
+require "forem/client"
+
+# Top-level namespace for the forem-ruby gem.
+#
+# All API access goes through {Forem::Client}. The library does not maintain
+# any global state — each {Client} instance carries its own configuration and
+# {APIRequestor}, so multiple clients (e.g. for different Forem instances or
+# different API keys) can coexist in the same process without interfering
+# with each other.
+#
+# == Quick start
+#
+#   require "forem"
+#
+#   client = Forem::Client.new(ENV["FOREM_API_KEY"])
+#
+#   articles = client.articles.list(per_page: 5)
+#   articles.each { |a| puts a.title }
+#
+# @see Forem::Client
+# @see https://developers.forem.com/api/v1 Forem API documentation
+module Forem
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: forem-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0.beta1
+platform: ruby
+authors:
+- Forem
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby client library for the Forem API, modeled after stripe-ruby patterns.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- forem-ruby.gemspec
+- lib/forem.rb
+- lib/forem/api_operations/create.rb
+- lib/forem/api_operations/delete.rb
+- lib/forem/api_operations/list.rb
+- lib/forem/api_operations/request.rb
+- lib/forem/api_operations/retrieve.rb
+- lib/forem/api_operations/save.rb
+- lib/forem/api_operations/update.rb
+- lib/forem/api_requestor.rb
+- lib/forem/api_resource.rb
+- lib/forem/client.rb
+- lib/forem/configuration.rb
+- lib/forem/connection_manager.rb
+- lib/forem/errors.rb
+- lib/forem/forem_object.rb
+- lib/forem/forem_response.rb
+- lib/forem/list_object.rb
+- lib/forem/resources/admin_concept.rb
+- lib/forem/resources/admin_user.rb
+- lib/forem/resources/agent_session.rb
+- lib/forem/resources/analytics.rb
+- lib/forem/resources/article.rb
+- lib/forem/resources/billboard.rb
+- lib/forem/resources/comment.rb
+- lib/forem/resources/concept.rb
+- lib/forem/resources/follow.rb
+- lib/forem/resources/follower.rb
+- lib/forem/resources/health_check.rb
+- lib/forem/resources/organization.rb
+- lib/forem/resources/page.rb
+- lib/forem/resources/podcast_episode.rb
+- lib/forem/resources/profile_image.rb
+- lib/forem/resources/reaction.rb
+- lib/forem/resources/reading_list.rb
+- lib/forem/resources/recommended_articles_list.rb
+- lib/forem/resources/request_redirect.rb
+- lib/forem/resources/segment.rb
+- lib/forem/resources/survey.rb
+- lib/forem/resources/tag.rb
+- lib/forem/resources/trend.rb
+- lib/forem/resources/user.rb
+- lib/forem/resources/video.rb
+- lib/forem/services/admin_concept_service.rb
+- lib/forem/services/admin_user_service.rb
+- lib/forem/services/agent_session_service.rb
+- lib/forem/services/analytics_service.rb
+- lib/forem/services/article_service.rb
+- lib/forem/services/base_service.rb
+- lib/forem/services/billboard_service.rb
+- lib/forem/services/comment_service.rb
+- lib/forem/services/concept_service.rb
+- lib/forem/services/follow_service.rb
+- lib/forem/services/follower_service.rb
+- lib/forem/services/health_check_service.rb
+- lib/forem/services/organization_service.rb
+- lib/forem/services/page_service.rb
+- lib/forem/services/podcast_episode_service.rb
+- lib/forem/services/profile_image_service.rb
+- lib/forem/services/reaction_service.rb
+- lib/forem/services/reading_list_service.rb
+- lib/forem/services/recommended_articles_list_service.rb
+- lib/forem/services/request_redirect_service.rb
+- lib/forem/services/segment_service.rb
+- lib/forem/services/survey_service.rb
+- lib/forem/services/tag_service.rb
+- lib/forem/services/trend_service.rb
+- lib/forem/services/user_service.rb
+- lib/forem/services/video_service.rb
+- lib/forem/util.rb
+- lib/forem/version.rb
+homepage: https://github.com/forem/forem-ruby
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Ruby client for the Forem API
+test_files: []