weinc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c0f85cf01f891fcff5ed7911b51acc5594c5ed0b5c63d979a09b536c06a44b07
+  data.tar.gz: 636f171cb639c1a5d1b4e930977341bf2275655f85b63933b1c521354f454dcb
+SHA512:
+  metadata.gz: a7af57efdb8bb6913f1df4b631e7d6acefeb4150d02af3f4207d594a23457d4d229b7a395c851133dbcf150110f4cc3aa40b3cfc16b2b854876a7d30b1b27b1a
+  data.tar.gz: 040fbd9a5d86c8f05a7894ec481dc35ec526ecf287f70af54fcf74f0edc424ccfc8aed9a554054af1f544debb705e86e9d35fe30182edae850e7a3e71de2e1c5

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 WeInc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,99 @@
+# weinc
+
+**WeInc AI website builder API client** for Ruby. Zero dependencies (pure standard library, `Net::HTTP` only).
+
+WeInc ([we.inc](https://we.inc)) is an AI website builder: describe an app in natural language and get a live, deployable React + Vite + Tailwind site. This gem is a thin, honest client for the WeInc v1 REST API — it wraps the documented endpoints and adds nothing else.
+
+- API docs: <https://my.we.inc/docs/api>
+- OpenAPI spec: <https://my.we.inc/api/v1/docs>
+- Website: <https://we.inc>
+
+## Install
+
+```bash
+gem install weinc
+```
+
+Or in your Gemfile:
+
+```ruby
+gem "weinc"
+```
+
+Requires Ruby 2.6+.
+
+## Quickstart
+
+Get an API key (starts with `wk_`) from your WeInc agency dashboard.
+
+```ruby
+require "weinc"
+
+weinc = WeInc::Client.new(api_key: ENV["WEINC_API_KEY"])
+
+# 1. List your projects
+result = weinc.list_projects(limit: 10)
+puts result["total"]
+
+# 2. Fetch one project
+project = weinc.get_project(result["projects"].first["id"])["project"]
+
+# 3. Create a project for a client
+created = weinc.create_project(
+  "client_email" => "client@example.com",
+  "name" => "New Site"
+)
+
+# 4. Where is it live?
+preview = weinc.get_preview_urls(project["id"])
+puts preview["published_url"] # nil if never published
+
+# 5. Clients, templates, plans, analytics
+clients   = weinc.list_clients
+templates = weinc.list_templates
+plans     = weinc.list_plans
+analytics = weinc.get_analytics(days: 30)
+```
+
+## API
+
+All methods return parsed JSON (Hash/Array) and raise `WeInc::Error` on any failure (with `#status` and `#body` when the server responded).
+
+| Method | Endpoint |
+|---|---|
+| `list_projects(limit:, offset:, client_id:, status:)` | `GET /projects` |
+| `get_project(project_id)` | `GET /projects/{id}` |
+| `create_project(data)` | `POST /projects` (`client_email`, `name` required) |
+| `update_project(project_id, data)` | `PATCH /projects/{id}` |
+| `delete_project(project_id)` | `DELETE /projects/{id}` |
+| `get_preview_urls(project_id)` | `GET /projects/{id}/preview` |
+| `list_clients` | `GET /clients` |
+| `create_client(data)` | `POST /clients` (`email` required) |
+| `get_client(client_id)` | `GET /clients/{id}` |
+| `update_client(client_id, data)` | `PATCH /clients/{id}` |
+| `list_templates` | `GET /templates` |
+| `list_plans` | `GET /plans` |
+| `get_analytics(days:, project_id:)` | `GET /analytics` |
+
+An escape hatch is included for endpoints this client does not wrap:
+
+```ruby
+webhooks = weinc.request("GET", "/webhooks")
+```
+
+## Notes on accuracy
+
+- All wrapped endpoints match the published OpenAPI spec at <https://my.we.inc/api/v1/docs>, except `get_preview_urls`, which is implemented by the API but **not yet listed in the OpenAPI document**; its shape was verified against the WeInc server source on 2026-08-04. If the spec later documents it differently, the spec wins.
+- Authentication: `Authorization: Bearer wk_...` org API key.
+
+## Testing
+
+```bash
+ruby test/smoke.rb
+```
+
+The smoke test uses a mocked transport — no live API calls are made.
+
+## License
+
+MIT

data/lib/weinc/client.rb

@@ -0,0 +1,223 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/http"
+require "uri"
+
+module WeInc
+  # Raised for every failed request (non-2xx response, network failure, or
+  # invalid input).
+  #
+  # @!attribute [r] status
+  #   @return [Integer, nil] HTTP status code, if a response was received.
+  # @!attribute [r] body
+  #   @return [Object, nil] Parsed response body (Hash/Array if JSON, else raw String).
+  class Error < StandardError
+    attr_reader :status, :body
+
+    def initialize(message, status: nil, body: nil)
+      super(message)
+      @status = status
+      @body = body
+    end
+  end
+
+  # weinc — thin client for the WeInc v1 REST API.
+  #
+  # Base URL: https://my.we.inc/api/v1
+  # Auth: org API key passed as +Authorization: Bearer wk_...+
+  #
+  # Endpoint shapes were taken from the live OpenAPI spec
+  # (https://my.we.inc/api/v1/docs) where available. The preview endpoint is
+  # implemented by the API but not yet listed in the OpenAPI document; its
+  # shape was verified against the server source on 2026-08-04.
+  #
+  # Pure standard library: uses Net::HTTP only.
+  #
+  # @example
+  #   weinc = WeInc::Client.new(api_key: ENV["WEINC_API_KEY"])
+  #   result = weinc.list_projects(limit: 10)
+  #   puts result["total"]
+  class Client
+    DEFAULT_BASE_URL = "https://my.we.inc/api/v1"
+
+    attr_reader :base_url
+
+    # @param api_key [String] Org API key from the agency dashboard (starts with +wk_+).
+    # @param base_url [String] Override the API base URL.
+    # @param transport [#call, nil] Custom transport for tests. Called with
+    #   (method, uri, headers, body) and must return [Integer status, String body].
+    def initialize(api_key:, base_url: DEFAULT_BASE_URL, transport: nil)
+      raise Error, "api_key must be a non-empty string" unless api_key.is_a?(String) && !api_key.empty?
+
+      @api_key = api_key
+      @base_url = base_url.sub(%r{/+\z}, "")
+      @transport = transport
+    end
+
+    # ------------------------------------------------------------- Projects
+
+    # List projects in your org. +GET /projects+.
+    #
+    # @param limit [Integer, nil] Max results (server default 50).
+    # @param offset [Integer, nil] Pagination offset.
+    # @param client_id [String, nil] Filter by client UUID.
+    # @param status [String, nil] Filter by project status.
+    # @return [Hash] +{"projects" => [...], "total" => Integer}+
+    def list_projects(limit: nil, offset: nil, client_id: nil, status: nil)
+      request("GET", "/projects", query: { limit: limit, offset: offset, client_id: client_id, status: status })
+    end
+
+    # Get one project by ID. +GET /projects/{projectId}+.
+    def get_project(project_id)
+      request("GET", "/projects/#{id!(project_id, 'project_id')}")
+    end
+
+    # Create a project for a client. +POST /projects+.
+    #
+    # Required keys: +client_email+, +name+. Optional: +description+,
+    # +template_id+ (clone files from an org template).
+    def create_project(data)
+      request("POST", "/projects", body: data)
+    end
+
+    # Update a project. +PATCH /projects/{projectId}+.
+    def update_project(project_id, data)
+      request("PATCH", "/projects/#{id!(project_id, 'project_id')}", body: data)
+    end
+
+    # Delete a project. +DELETE /projects/{projectId}+.
+    def delete_project(project_id)
+      request("DELETE", "/projects/#{id!(project_id, 'project_id')}")
+    end
+
+    # Get preview / published URLs for a project.
+    #
+    # +GET /projects/{projectId}/preview+ — implemented by the API but not yet
+    # in the OpenAPI spec (shape verified against server source 2026-08-04).
+    #
+    # @return [Hash] +{"published_url" => String|nil, "has_published" => Boolean, "embed_preview_path" => String}+
+    def get_preview_urls(project_id)
+      request("GET", "/projects/#{id!(project_id, 'project_id')}/preview")
+    end
+
+    # -------------------------------------------------------------- Clients
+
+    # List clients. +GET /clients+.
+    def list_clients
+      request("GET", "/clients")
+    end
+
+    # Create a client. +POST /clients+. Required key: +email+.
+    # Optional: +name+, +company+, +plan_id+.
+    def create_client(data)
+      request("POST", "/clients", body: data)
+    end
+
+    # Get client details. +GET /clients/{clientId}+.
+    def get_client(client_id)
+      request("GET", "/clients/#{id!(client_id, 'client_id')}")
+    end
+
+    # Update a client. +PATCH /clients/{clientId}+.
+    def update_client(client_id, data)
+      request("PATCH", "/clients/#{id!(client_id, 'client_id')}", body: data)
+    end
+
+    # --------------------------------------------------- Templates / Plans
+
+    # List org templates. +GET /templates+.
+    def list_templates
+      request("GET", "/templates")
+    end
+
+    # List client plans. +GET /plans+.
+    def list_plans
+      request("GET", "/plans")
+    end
+
+    # ------------------------------------------------------------ Analytics
+
+    # Get aggregated analytics. +GET /analytics+.
+    #
+    # @param days [Integer, nil]
+    # @param project_id [String, nil]
+    def get_analytics(days: nil, project_id: nil)
+      request("GET", "/analytics", query: { days: days, project_id: project_id })
+    end
+
+    # ------------------------------------------------------------- Plumbing
+
+    # Perform an authenticated JSON request. Exposed for calling endpoints
+    # this client does not wrap yet.
+    #
+    # @param method [String] HTTP method.
+    # @param path [String] Path relative to the base URL, e.g. +"/projects"+.
+    # @param query [Hash] Query parameters (nil values are dropped).
+    # @param body [Hash, nil] JSON request body.
+    # @return [Object] Parsed JSON response body.
+    def request(method, path, query: {}, body: nil)
+      uri = URI.parse(@base_url + path)
+      pairs = query.reject { |_k, v| v.nil? }
+      uri.query = URI.encode_www_form(pairs) unless pairs.empty?
+
+      headers = {
+        "Authorization" => "Bearer #{@api_key}",
+        "Accept" => "application/json"
+      }
+      payload = nil
+      unless body.nil?
+        headers["Content-Type"] = "application/json"
+        payload = JSON.generate(body)
+      end
+
+      status, text = send_request(method, uri, headers, payload)
+
+      data =
+        if text.nil? || text.empty?
+          nil
+        else
+          begin
+            JSON.parse(text)
+          rescue JSON::ParserError
+            text
+          end
+        end
+
+      unless (200..299).cover?(status)
+        server_message = data.is_a?(Hash) && data["error"].is_a?(String) ? data["error"] : "HTTP #{status}"
+        raise Error.new("#{method} #{path} failed: #{server_message}", status: status, body: data)
+      end
+
+      data
+    end
+
+    private
+
+    def send_request(method, uri, headers, payload)
+      return @transport.call(method, uri, headers, payload) if @transport
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      http.open_timeout = 10
+      http.read_timeout = 30
+
+      req = Net::HTTP.const_get(method.capitalize).new(uri.request_uri, headers)
+      req.body = payload if payload
+
+      begin
+        res = http.request(req)
+      rescue StandardError => e
+        raise Error, "Network error calling #{method} #{uri.path}: #{e.message}"
+      end
+
+      [res.code.to_i, res.body.to_s]
+    end
+
+    def id!(value, name)
+      raise Error, "#{name} must be a non-empty string" unless value.is_a?(String) && !value.empty?
+
+      URI.encode_www_form_component(value).gsub("+", "%20")
+    end
+  end
+end

data/lib/weinc.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# weinc — WeInc AI website builder API client.
+#
+# Thin, zero-dependency client for the WeInc v1 REST API
+# (https://my.we.inc/api/v1). See https://my.we.inc/docs/api for API docs
+# and https://we.inc for the product.
+module WeInc
+  VERSION = "0.1.0"
+end
+
+require_relative "weinc/client"

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: weinc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- WeInc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-08-15 00:00:00.000000000 Z
+dependencies: []
+description: 'Thin, zero-dependency Ruby client (Net::HTTP only) for the WeInc v1
+  REST API: projects, clients, templates, plans, and analytics.'
+email:
+- support@weinc.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/weinc.rb
+- lib/weinc/client.rb
+homepage: https://github.com/umairalisadaqat/weinc-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/umairalisadaqat/weinc-ruby
+  source_code_uri: https://github.com/umairalisadaqat/weinc-ruby
+  documentation_uri: https://my.we.inc/docs/api
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+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: WeInc AI website builder API client
+test_files: []