sirv_rest_api 1.0.0

data/lib/sirv_rest_api/errors.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module SirvRestApi
+  # Base error class for all Sirv API errors
+  class Error < StandardError; end
+
+  # Error raised when API returns an error response
+  class ApiError < Error
+    attr_reader :status_code, :error_code, :message
+
+    def initialize(message, status_code, error_code = nil)
+      @message = message
+      @status_code = status_code
+      @error_code = error_code
+      super(build_message)
+    end
+
+    private
+
+    def build_message
+      if @error_code
+        "#{@message} (status #{@status_code}, code #{@error_code})"
+      else
+        "#{@message} (status #{@status_code})"
+      end
+    end
+  end
+
+  # Error raised when authentication fails
+  class AuthenticationError < ApiError
+    def initialize(message = "Authentication failed", status_code = 401)
+      super(message, status_code, "authentication_error")
+    end
+  end
+
+  # Error raised when rate limit is exceeded
+  class RateLimitError < ApiError
+    def initialize(message = "Rate limit exceeded", status_code = 429)
+      super(message, status_code, "rate_limit_error")
+    end
+  end
+
+  # Error raised for invalid parameters
+  class ValidationError < ApiError
+    def initialize(message, status_code = 400)
+      super(message, status_code, "validation_error")
+    end
+  end
+
+  # Error raised when resource is not found
+  class NotFoundError < ApiError
+    def initialize(message = "Resource not found", status_code = 404)
+      super(message, status_code, "not_found")
+    end
+  end
+end

data/lib/sirv_rest_api/models.rb

@@ -0,0 +1,319 @@
+# frozen_string_literal: true
+
+module SirvRestApi
+  # Token response from authentication
+  class TokenResponse
+    attr_accessor :token, :expires_in, :scope
+
+    def initialize(data = {})
+      @token = data["token"]
+      @expires_in = data["expiresIn"]
+      @scope = data["scope"] || []
+    end
+  end
+
+  # Account information
+  class AccountInfo
+    attr_accessor :alias, :cdn_url, :date_created, :fetching, :minify, :aliases, :file_size_limit
+
+    def initialize(data = {})
+      @alias = data["alias"]
+      @cdn_url = data["cdnURL"]
+      @date_created = data["dateCreated"]
+      @fetching = data["fetching"]
+      @minify = data["minify"]
+      @aliases = data["aliases"]
+      @file_size_limit = data["fileSizeLimit"]
+    end
+  end
+
+  # Rate limit information
+  class RateLimitInfo
+    attr_accessor :limit, :remaining, :reset, :count
+
+    def initialize(data = {})
+      @limit = data["limit"]
+      @remaining = data["remaining"]
+      @reset = data["reset"]
+      @count = data["count"]
+    end
+  end
+
+  # Account limits
+  class AccountLimits
+    attr_accessor :s3, :rest, :ftp
+
+    def initialize(data = {})
+      @s3 = data["s3"] ? RateLimitInfo.new(data["s3"]) : nil
+      @rest = data["rest"] ? RateLimitInfo.new(data["rest"]) : nil
+      @ftp = data["ftp"] ? RateLimitInfo.new(data["ftp"]) : nil
+    end
+  end
+
+  # Storage information
+  class StorageInfo
+    attr_accessor :allowance, :used, :files, :burstable
+
+    def initialize(data = {})
+      @allowance = data["allowance"]
+      @used = data["used"]
+      @files = data["files"]
+      @burstable = data["burstable"]
+    end
+  end
+
+  # Account user
+  class AccountUser
+    attr_accessor :user_id, :email, :first_name, :last_name, :role, :date_created
+
+    def initialize(data = {})
+      @user_id = data["userId"]
+      @email = data["email"]
+      @first_name = data["firstName"]
+      @last_name = data["lastName"]
+      @role = data["role"]
+      @date_created = data["dateCreated"]
+    end
+  end
+
+  # Plan price
+  class PlanPrice
+    attr_accessor :month, :year, :quarter
+
+    def initialize(data = {})
+      @month = data["month"]
+      @year = data["year"]
+      @quarter = data["quarter"]
+    end
+  end
+
+  # Billing plan
+  class BillingPlan
+    attr_accessor :id, :name, :description, :period, :storage, :data_transfer_limit, :price, :date_active
+
+    def initialize(data = {})
+      @id = data["id"]
+      @name = data["name"]
+      @description = data["description"]
+      @period = data["period"]
+      @storage = data["storage"]
+      @data_transfer_limit = data["dataTransferLimit"]
+      @price = data["price"] ? PlanPrice.new(data["price"]) : nil
+      @date_active = data["dateActive"]
+    end
+  end
+
+  # Account event
+  class AccountEvent
+    attr_accessor :id, :module, :type, :level, :message, :filename, :timestamp, :seen
+
+    def initialize(data = {})
+      @id = data["id"]
+      @module = data["module"]
+      @type = data["type"]
+      @level = data["level"]
+      @message = data["message"]
+      @filename = data["filename"]
+      @timestamp = data["timestamp"]
+      @seen = data["seen"]
+    end
+  end
+
+  # User information
+  class UserInfo
+    attr_accessor :user_id, :email, :first_name, :last_name, :date_created, :s3_key, :s3_secret
+
+    def initialize(data = {})
+      @user_id = data["userId"]
+      @email = data["email"]
+      @first_name = data["firstName"]
+      @last_name = data["lastName"]
+      @date_created = data["dateCreated"]
+      @s3_key = data["s3Key"]
+      @s3_secret = data["s3Secret"]
+    end
+  end
+
+  # File metadata
+  class FileMeta
+    attr_accessor :title, :description, :tags, :approved
+
+    def initialize(data = {})
+      @title = data["title"]
+      @description = data["description"]
+      @tags = data["tags"]
+      @approved = data["approved"]
+    end
+
+    def to_h
+      {
+        title: @title,
+        description: @description,
+        tags: @tags,
+        approved: @approved
+      }.compact
+    end
+  end
+
+  # File information
+  class FileInfo
+    attr_accessor :filename, :dirname, :basename, :is_directory, :size, :ctime, :mtime, :content_type, :meta
+
+    def initialize(data = {})
+      @filename = data["filename"]
+      @dirname = data["dirname"]
+      @basename = data["basename"]
+      @is_directory = data["isDirectory"]
+      @size = data["size"]
+      @ctime = data["ctime"]
+      @mtime = data["mtime"]
+      @content_type = data["contentType"]
+      @meta = data["meta"] ? FileMeta.new(data["meta"]) : nil
+    end
+
+    def directory?
+      @is_directory
+    end
+  end
+
+  # Product metadata
+  class ProductMeta
+    attr_accessor :id, :name, :brand, :category, :sku
+
+    def initialize(data = {})
+      @id = data["id"]
+      @name = data["name"]
+      @brand = data["brand"]
+      @category = data["category"]
+      @sku = data["sku"]
+    end
+
+    def to_h
+      {
+        id: @id,
+        name: @name,
+        brand: @brand,
+        category: @category,
+        sku: @sku
+      }.compact
+    end
+  end
+
+  # Folder contents
+  class FolderContents
+    attr_accessor :contents, :continuation
+
+    def initialize(data = {})
+      @contents = (data["contents"] || []).map { |item| FileInfo.new(item) }
+      @continuation = data["continuation"]
+    end
+  end
+
+  # Search result
+  class SearchResult
+    attr_accessor :hits, :total, :scroll_id
+
+    def initialize(data = {})
+      raw_hits = data["hits"] || []
+      @hits = raw_hits.map do |hit|
+        # Handle Elasticsearch _source format
+        source = hit["_source"] || hit
+        FileInfo.new(source)
+      end
+      # Handle Elasticsearch total format
+      total_data = data["total"]
+      @total = total_data.is_a?(Hash) ? total_data["value"] : total_data
+      @scroll_id = data["scrollId"]
+    end
+  end
+
+  # Batch delete result
+  class BatchDeleteResult
+    attr_accessor :job_id, :status, :results
+
+    def initialize(data = {})
+      @job_id = data["jobId"]
+      @status = data["status"]
+      @results = data["results"]
+    end
+  end
+
+  # Batch ZIP result
+  class BatchZipResult
+    attr_accessor :job_id, :status, :filename
+
+    def initialize(data = {})
+      @job_id = data["jobId"]
+      @status = data["status"]
+      @filename = data["filename"]
+    end
+  end
+
+  # JWT response
+  class JwtResponse
+    attr_accessor :url, :token
+
+    def initialize(data = {})
+      @url = data["url"]
+      @token = data["token"]
+    end
+  end
+
+  # Point of interest
+  class PointOfInterest
+    attr_accessor :name, :x, :y, :frame
+
+    def initialize(data = {})
+      @name = data["name"]
+      @x = data["x"]
+      @y = data["y"]
+      @frame = data["frame"]
+    end
+
+    def to_h
+      {
+        name: @name,
+        x: @x,
+        y: @y,
+        frame: @frame
+      }.compact
+    end
+  end
+
+  # HTTP statistics
+  class HttpStats
+    attr_accessor :date, :transfer, :requests
+
+    def initialize(data = {})
+      @date = data["date"]
+      @transfer = data["transfer"]
+      @requests = data["requests"]
+    end
+  end
+
+  # Spin view statistics
+  class SpinViewStats
+    attr_accessor :date, :views, :spins, :zooms, :fullscreens, :user_agent, :country
+
+    def initialize(data = {})
+      @date = data["date"]
+      @views = data["views"]
+      @spins = data["spins"]
+      @zooms = data["zooms"]
+      @fullscreens = data["fullscreens"]
+      @user_agent = data["userAgent"]
+      @country = data["country"]
+    end
+  end
+
+  # Storage statistics
+  class StorageStats
+    attr_accessor :date, :storage, :files
+
+    def initialize(data = {})
+      @date = data["date"]
+      @storage = data["storage"]
+      @files = data["files"]
+    end
+  end
+end

data/lib/sirv_rest_api/version.rb

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

data/lib/sirv_rest_api.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "sirv_rest_api/version"
+require_relative "sirv_rest_api/errors"
+require_relative "sirv_rest_api/models"
+require_relative "sirv_rest_api/client"
+
+# Sirv REST API SDK for Ruby
+#
+# @example Basic usage
+#   require 'sirv_rest_api'
+#
+#   client = SirvRestApi::Client.new(
+#     client_id: 'your-client-id',
+#     client_secret: 'your-client-secret'
+#   )
+#
+#   client.connect
+#   account = client.get_account_info
+#   puts "CDN URL: #{account.cdn_url}"
+#
+module SirvRestApi
+  class << self
+    # Create a new client instance
+    #
+    # @param options [Hash] Client options
+    # @return [Client] New client instance
+    def new(**options)
+      Client.new(**options)
+    end
+  end
+end

data/sirv_rest_api.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "lib/sirv_rest_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "sirv_rest_api"
+  spec.version = SirvRestApi::VERSION
+  spec.authors = ["Sirv"]
+  spec.email = ["support@sirv.com"]
+
+  spec.summary = "Official Ruby SDK for the Sirv REST API"
+  spec.description = "A simple, type-safe way to interact with Sirv's image hosting and processing platform. " \
+                     "Features include automatic token management, retry logic, and comprehensive coverage of all 40+ API endpoints."
+  spec.homepage = "https://github.com/sirv/sirv-rest-api-ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/sirv/sirv-rest-api-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/sirv/sirv-rest-api-ruby/blob/main/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "https://www.rubydoc.info/gems/sirv_rest_api"
+  spec.metadata["bug_tracker_uri"] = "https://github.com/sirv/sirv-rest-api-ruby/issues"
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Runtime dependencies - none required, uses stdlib only
+
+  # Development dependencies
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rubocop", "~> 1.0"
+  spec.add_development_dependency "yard", "~> 0.9"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: sirv_rest_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sirv
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2026-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: A simple, type-safe way to interact with Sirv's image hosting and processing
+  platform. Features include automatic token management, retry logic, and comprehensive
+  coverage of all 40+ API endpoints.
+email:
+- support@sirv.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- docs/index.html
+- examples/basic_usage.rb
+- icon.png
+- lib/sirv_rest_api.rb
+- lib/sirv_rest_api/client.rb
+- lib/sirv_rest_api/errors.rb
+- lib/sirv_rest_api/models.rb
+- lib/sirv_rest_api/version.rb
+- sirv_rest_api.gemspec
+homepage: https://github.com/sirv/sirv-rest-api-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sirv/sirv-rest-api-ruby
+  source_code_uri: https://github.com/sirv/sirv-rest-api-ruby
+  changelog_uri: https://github.com/sirv/sirv-rest-api-ruby/blob/main/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/sirv_rest_api
+  bug_tracker_uri: https://github.com/sirv/sirv-rest-api-ruby/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.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: Official Ruby SDK for the Sirv REST API
+test_files: []