ventureinkorea 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6ab3dad5ecde3a5cfab9883b03ff2664ab51f3c274ee41411d2e3b686e0071ca
+  data.tar.gz: 6b4ebfb2f4caa9b16e2e97a773317a97c733264e513b71b2ab119a61d1dbc853
+SHA512:
+  metadata.gz: fd814374cfb6b84f60870b47f33e8c267bebfd979df93c1b45b46dd915c0eaf38eae4b330f6c669ff8ef0d01b722fff76cfc2fcb5c876c1eb281ec8d473ce2d2
+  data.tar.gz: d69f5ff5bb999a9d04664573f098da80f17def10a9a1f83a1a5618de7977f7eeef85e2f01c053d636329eddb6db5472f7d1ce5164dc099d572223db78ad6164b

data/lib/ventureinkorea/client.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+require "uri"
+
+module VentureInKorea
+  # HTTP client for the VentureInKorea REST API.
+  #
+  # All methods return typed Ruby objects (GlossaryTerm, BlogPost, Company).
+  # Zero runtime dependencies — uses only Ruby stdlib (net/http, json, uri).
+  #
+  #   client = VentureInKorea::Client.new
+  #   terms = client.list_terms
+  #   term = client.get_term("venture-certification")
+  #   puts term.name
+  #
+  class Client
+    DEFAULT_BASE_URL = "https://ventureinkorea.com"
+    DEFAULT_TIMEOUT  = 30
+
+    def initialize(base_url: DEFAULT_BASE_URL, timeout: DEFAULT_TIMEOUT)
+      @base_url = base_url.chomp("/")
+      @timeout = timeout
+    end
+
+    # List all glossary terms.
+    #
+    # @param params [Hash] optional query parameters
+    # @return [Array<GlossaryTerm>]
+    def list_terms(**params)
+      data = get("/api/v1/terms/", params)
+      results = data["results"] || []
+      results.map { |h| GlossaryTerm.from_hash(h) }
+    end
+
+    # Get a glossary term by slug.
+    #
+    # @param slug [String] term slug
+    # @return [GlossaryTerm]
+    # @raise [NotFoundError] if the term does not exist
+    def get_term(slug)
+      data = get("/api/v1/terms/#{slug}/")
+      GlossaryTerm.from_hash(data)
+    end
+
+    # List all blog posts.
+    #
+    # @param params [Hash] optional query parameters
+    # @return [Array<BlogPost>]
+    def list_posts(**params)
+      data = get("/api/v1/posts/", params)
+      results = data["results"] || []
+      results.map { |h| BlogPost.from_hash(h) }
+    end
+
+    # Get a blog post by slug.
+    #
+    # @param slug [String] post slug
+    # @return [BlogPost]
+    # @raise [NotFoundError] if the post does not exist
+    def get_post(slug)
+      data = get("/api/v1/posts/#{slug}/")
+      BlogPost.from_hash(data)
+    end
+
+    # List all venture-certified companies.
+    #
+    # @param params [Hash] optional query parameters
+    # @return [Array<Company>]
+    def list_companies(**params)
+      data = get("/api/v1/companies/", params)
+      results = data["results"] || []
+      results.map { |h| Company.from_hash(h) }
+    end
+
+    # Get a company by primary key.
+    #
+    # @param pk [Integer] company ID
+    # @return [Company]
+    # @raise [NotFoundError] if the company does not exist
+    def get_company(pk)
+      data = get("/api/v1/companies/#{pk}/")
+      Company.from_hash(data)
+    end
+
+    # List all post categories.
+    #
+    # @return [Array<PostCategory>]
+    def list_categories
+      data = get("/api/v1/categories/")
+      results = data["results"] || []
+      results.map { |h| PostCategory.from_hash(h) }
+    end
+
+    # List aggregated FAQs.
+    #
+    # @param params [Hash] optional query parameters
+    # @return [Array<FAQ>]
+    def list_faqs(**params)
+      data = get("/api/v1/faq/", params)
+      results = data["results"] || []
+      results.map { |h| FAQ.from_hash(h) }
+    end
+
+    # Get platform-wide statistics.
+    #
+    # @return [PlatformStats]
+    def get_stats
+      data = get("/api/v1/stats/")
+      PlatformStats.from_hash(data)
+    end
+
+    # Search across all content.
+    #
+    # @param query [String] search query
+    # @return [Hash] search results with :results, :query, :total
+    def search(query)
+      get("/api/v1/search/", q: query)
+    end
+
+    # Autocomplete suggestions.
+    #
+    # @param query [String] partial query
+    # @return [Hash] autocomplete results
+    def autocomplete(query)
+      get("/api/v1/autocomplete/", q: query)
+    end
+
+    private
+
+    def get(path, params = {})
+      uri = URI("#{@base_url}#{path}")
+      uri.query = URI.encode_www_form(params.reject { |_, v| v.nil? || v.to_s.empty? }) unless params.empty?
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      http.open_timeout = @timeout
+      http.read_timeout = @timeout
+
+      request = Net::HTTP::Get.new(uri)
+      response = http.request(request)
+
+      case response
+      when Net::HTTPSuccess
+        JSON.parse(response.body)
+      when Net::HTTPNotFound
+        raise NotFoundError, "Not found: #{path}"
+      when Net::HTTPTooManyRequests
+        retry_after = response["Retry-After"]&.to_i
+        raise RateLimitError.new("Rate limit exceeded", retry_after: retry_after)
+      else
+        raise Error, "API error (HTTP #{response.code}): #{response.body}"
+      end
+    end
+  end
+end

data/lib/ventureinkorea/errors.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module VentureInKorea
+  # General API error.
+  class Error < StandardError; end
+
+  # Raised when the server returns HTTP 404.
+  class NotFoundError < Error; end
+
+  # Raised when the server returns HTTP 429.
+  # Exposes the Retry-After header value when present.
+  class RateLimitError < Error
+    attr_reader :retry_after
+
+    def initialize(message = "Rate limit exceeded", retry_after: nil)
+      @retry_after = retry_after
+      super(message)
+    end
+  end
+end

data/lib/ventureinkorea/types.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+module VentureInKorea
+  # A Korean venture/startup glossary term.
+  class GlossaryTerm
+    attr_reader :name, :slug, :definition, :category, :related_terms, :url
+
+    def initialize(name:, slug:, definition: "", category: "", related_terms: [], url: "")
+      @name = name
+      @slug = slug
+      @definition = definition
+      @category = category
+      @related_terms = related_terms
+      @url = url
+    end
+
+    def self.from_hash(hash)
+      new(
+        name: hash["name"],
+        slug: hash["slug"],
+        definition: hash["definition"] || "",
+        category: hash["category"] || "",
+        related_terms: hash["related_terms"] || [],
+        url: hash["url"] || ""
+      )
+    end
+  end
+
+  # A blog post about the Korean startup ecosystem.
+  class BlogPost
+    attr_reader :title, :slug, :excerpt, :content, :category, :published_at, :faqs, :url
+
+    def initialize(title:, slug:, excerpt: "", content: "", category: "",
+                   published_at: "", faqs: [], url: "")
+      @title = title
+      @slug = slug
+      @excerpt = excerpt
+      @content = content
+      @category = category
+      @published_at = published_at
+      @faqs = faqs
+      @url = url
+    end
+
+    def self.from_hash(hash)
+      new(
+        title: hash["title"],
+        slug: hash["slug"],
+        excerpt: hash["excerpt"] || "",
+        content: hash["content"] || "",
+        category: hash["category"] || "",
+        published_at: hash["published_at"] || "",
+        faqs: (hash["faqs"] || []).map { |f| FAQ.from_hash(f) },
+        url: hash["url"] || ""
+      )
+    end
+  end
+
+  # A venture-certified company (벤처인증기업).
+  class Company
+    attr_reader :id, :name, :description, :industry, :certification_type, :founded_year, :url
+
+    def initialize(id:, name:, description: "", industry: "", certification_type: "",
+                   founded_year: nil, url: "")
+      @id = id
+      @name = name
+      @description = description
+      @industry = industry
+      @certification_type = certification_type
+      @founded_year = founded_year
+      @url = url
+    end
+
+    def self.from_hash(hash)
+      new(
+        id: hash["id"],
+        name: hash["name"],
+        description: hash["description"] || "",
+        industry: hash["industry"] || "",
+        certification_type: hash["certification_type"] || "",
+        founded_year: hash["founded_year"],
+        url: hash["url"] || ""
+      )
+    end
+  end
+
+  # A frequently asked question.
+  class FAQ
+    attr_reader :question, :answer, :source_type, :source_slug
+
+    def initialize(question:, answer:, source_type: "", source_slug: "")
+      @question = question
+      @answer = answer
+      @source_type = source_type
+      @source_slug = source_slug
+    end
+
+    def self.from_hash(hash)
+      new(
+        question: hash["question"],
+        answer: hash["answer"],
+        source_type: hash["source_type"] || "",
+        source_slug: hash["source_slug"] || ""
+      )
+    end
+  end
+
+  # A post category.
+  class PostCategory
+    attr_reader :name, :slug, :post_count
+
+    def initialize(name:, slug:, post_count: 0)
+      @name = name
+      @slug = slug
+      @post_count = post_count
+    end
+
+    def self.from_hash(hash)
+      new(
+        name: hash["name"],
+        slug: hash["slug"],
+        post_count: hash["post_count"] || 0
+      )
+    end
+  end
+
+  # Platform-wide statistics.
+  class PlatformStats
+    attr_reader :total_companies, :total_posts, :total_terms, :total_faqs
+
+    def initialize(total_companies: 0, total_posts: 0, total_terms: 0, total_faqs: 0)
+      @total_companies = total_companies
+      @total_posts = total_posts
+      @total_terms = total_terms
+      @total_faqs = total_faqs
+    end
+
+    def self.from_hash(hash)
+      new(
+        total_companies: hash["total_companies"] || 0,
+        total_posts: hash["total_posts"] || 0,
+        total_terms: hash["total_terms"] || 0,
+        total_faqs: hash["total_faqs"] || 0
+      )
+    end
+  end
+end

data/lib/ventureinkorea/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module VentureInKorea
+  VERSION = "0.1.0"
+end

data/lib/ventureinkorea.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative "ventureinkorea/version"
+require_relative "ventureinkorea/errors"
+require_relative "ventureinkorea/types"
+require_relative "ventureinkorea/client"

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: ventureinkorea
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- dobestan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: API client for ventureinkorea.com. Search venture-certified companies,
+  startup glossary terms, and blog posts about Korea's innovation economy. Zero dependencies.
+email:
+- hello@ventureinkorea.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ventureinkorea.rb
+- lib/ventureinkorea/client.rb
+- lib/ventureinkorea/errors.rb
+- lib/ventureinkorea/types.rb
+- lib/ventureinkorea/version.rb
+homepage: https://ventureinkorea.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://ventureinkorea.com
+  source_code_uri: https://github.com/dobestan/ventureinkorea-rb
+  changelog_uri: https://github.com/dobestan/ventureinkorea-rb/blob/main/CHANGELOG.md
+  documentation_uri: https://ventureinkorea.com/developers/
+  bug_tracker_uri: https://github.com/dobestan/ventureinkorea-rb/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Ruby client for the VentureInKorea Korean venture startup API
+test_files: []