versacommerce-theme_api_client 0.1.3 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c58a3ccc7e4d17525a5a1d611cd4304ea1061287
-  data.tar.gz: 88fbc74106783012399df78915249e87aff0fb4e
+SHA256:
+  metadata.gz: 2475dfd16c9b90dd2a5d6d76a5611d39b188131152560698dbf7e215b0cac5e6
+  data.tar.gz: fe2ece15355542927dc8c3584c465b4a3c474e3a6d7e29abe1076f90ead03276
 SHA512:
-  metadata.gz: a798ab3ec485c237f9f7097758db624285c3b6e342f3f0459fbb18572824e84a866230f3a131bdbc21a70c30f123fdb5b9639f41eb1a91390c3e7bfcfe11d423
-  data.tar.gz: 5cc6eeb253aca9dcfc33656bff0ebdfb188570285a951afb6033498d445d09ea48f07739aa09cafe660646425b070ae6bb0578c47ac71eda1a885769cac4c83b
+  metadata.gz: 95bf32338399a00967aaa6e3454807e3563d5eaecc98761f14c0e80ad400c8c92252af7d8ab819a3215db2323b691898ff60fe7dec20f6678853f9c455e9cbde
+  data.tar.gz: 372c77b36a475243e133f48c0472b8c2acde9a752feee9f92ca923b641f00f8fa7011085d69434c6231d1896b3ddc2ae301e2715cf32d140886dda3bc441fd58

data/.ruby-version

@@ -0,0 +1 @@
+3.1.3

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.2] - 2025-10-30
+
+### Added
+- SSL verification configuration option (`ssl_verify` attribute)
+- Support for custom base URL configuration
+- Comprehensive configuration documentation in README
+
+### Changed
+- Default SSL verification is enabled (secure by default)
+- Fetcher now respects `ssl_verify` setting when making HTTP requests
+
+## [1.0.1] - Previous Release
+
+### Changed
+- Updated to Ruby 3.1+
+- Loosened gem dependencies

data/CLAUDE.md

@@ -0,0 +1,104 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+This is a Ruby gem that provides an API client for the VersaCommerce Theme API. It allows developers to programmatically manage theme files and directories for VersaCommerce shops.
+
+## Requirements
+
+- Ruby >= 3.3.0
+- Dependencies: http (~> 5.0), activesupport (>= 4.2, < 8.0), activemodel (>= 4.2, < 8.0)
+
+## Common Commands
+
+### Setup and Development
+```bash
+bin/setup              # Install dependencies
+bin/console            # Launch interactive console for experimentation
+bundle install         # Install gem dependencies
+```
+
+### Building and Publishing
+```bash
+rake build             # Build the gem
+rake install           # Build and install gem locally
+rake release           # Create git tag, build and push gem to rubygems.org
+```
+
+## Architecture
+
+### Core Components
+
+**Client (lib/versacommerce/theme_api_client.rb)**
+- Entry point for the gem
+- Initialized with authorization token
+- Provides `directories()` and `files()` methods that return relation objects
+- Configurable `base_url` (defaults to https://theme-api.versacommerce.de)
+- Dynamically creates resource classes tied to the client instance
+
+**Fetcher (lib/versacommerce/theme_api_client/fetcher.rb)**
+- HTTP communication layer using the `http` gem
+- Handles all HTTP verbs (GET, POST, PATCH, DELETE, HEAD)
+- Adds Theme-Authorization header to all requests
+- Defines custom errors: `RecordNotFoundError` and `UnauthorizedError`
+- Extends HTTP::Response with a `json` method for parsing JSON responses
+
+**Relation (lib/versacommerce/theme_api_client/relation.rb)**
+- Base class for DirectoryRelation and FileRelation
+- Implements Enumerable for iteration
+- Provides ActiveRecord-like interface: `find()`, `build()`, `create()`, `delete()`
+- Supports path scoping with `in_path()` method
+- Handles recursive vs non-recursive queries
+
+**Resource (lib/versacommerce/theme_api_client/resource.rb)**
+- Base class for Directory and File resources
+- Uses ActiveModel for validations and dirty tracking
+- Implements `save()`, `update()`, `new_record?` methods
+- Each resource class is dynamically created per client instance (see `directory_class` and `file_class` in client)
+
+### Resource Types
+
+**Directory (lib/versacommerce/theme_api_client/resources/directory.rb)**
+- Represents theme directories
+- Has `path` attribute
+- Provides `files()` method to access files within the directory
+
+**File (lib/versacommerce/theme_api_client/resources/file.rb)**
+- Represents theme files
+- Has `path` and `content` attributes
+- Content loading is conditional: text files load automatically, binary files require explicit `load_content: true`
+- Provides `reload_content()` and `has_content?` methods
+
+### Key Design Patterns
+
+**Dynamic Class Creation**: The client creates subclasses of Directory and File at runtime (via `directory_class` and `file_class`), binding them to the specific client instance. This allows each resource to access the client's fetcher and configuration.
+
+**Relation Pattern**: Inspired by ActiveRecord, relations provide chainable query interfaces and lazy evaluation. The `in_path()` method modifies the relation's path scope without executing queries.
+
+**Path Helpers**: The client provides `directory_path()`, `file_path()`, `download_path()`, and `tree_path()` helper methods that build Pathname objects for API endpoints.
+
+## Module Structure
+
+```
+lib/versacommerce/
+  theme_api_client.rb              # Main client class
+  theme_api_client/
+    client.rb                       # (Appears to be duplicate/alternative entry point)
+    fetcher.rb                      # HTTP client wrapper
+    relation.rb                     # Base relation class
+    resource.rb                     # Base resource class with ActiveModel
+    version.rb                      # Gem version constant
+    relations/
+      directory_relation.rb
+      file_relation.rb
+    resources/
+      directory.rb
+      file.rb
+      file_behaviour.rb             # Shared file behavior module
+```
+
+## Testing
+
+This gem does not appear to have a test suite in the repository. When adding tests, consider creating a spec/ or test/ directory.

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 VersaCommerce
+Copyright (c) 2025 VersaCommerce
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -6,7 +6,7 @@ Versacommerce::ThemeAPIClient is a library to consume the VersaCommerce Theme AP
 
 ## Requirements
 
-Ruby ≥ 2.0.0
+Ruby ≥ 3.1.0
 
 ## Installation
 
@@ -41,6 +41,42 @@ client = Versacommerce::ThemeAPIClient.new(authorization: authorization)
 
 The client object is tied to a single theme, depending on the authorization. You can get an authorization from your shop's admin section.
 
+### Configuration Options
+
+The client accepts the following configuration options:
+
+```ruby
+client = Versacommerce::ThemeAPIClient.new(
+  authorization: 'YOUR_AUTHORIZATION',  # Required: API authorization token
+  base_url: 'https://theme-api.versacommerce.de',  # Optional: Custom API endpoint
+  ssl_verify: true  # Optional: Enable/disable SSL certificate verification (default: true)
+)
+```
+
+#### SSL Verification
+
+By default, SSL certificate verification is enabled. You can disable it for development/testing environments with self-signed certificates:
+
+```ruby
+client = Versacommerce::ThemeAPIClient.new(
+  authorization: 'YOUR_AUTHORIZATION',
+  ssl_verify: false  # Disable SSL verification (not recommended for production)
+)
+```
+
+**Warning:** Disabling SSL verification is not recommended for production environments.
+
+#### Custom Base URL
+
+If you need to connect to a different API endpoint (e.g., staging environment):
+
+```ruby
+client = Versacommerce::ThemeAPIClient.new(
+  authorization: 'YOUR_AUTHORIZATION',
+  base_url: 'https://staging-theme-api.example.com'
+)
+```
+
 ### Working with Directories
 
 #### Finding Directories

data/lib/versacommerce/theme_api_client/fetcher.rb

@@ -84,7 +84,17 @@ module Versacommerce
       end
 
       def with_headers
-        HTTP.with_headers(accept: 'application/json', 'Theme-Authorization' => authorization)
+        http_client = HTTP.headers(accept: 'application/json', 'Theme-Authorization' => authorization)
+
+        # Apply SSL verification setting if explicitly disabled
+        unless client.ssl_verify
+          require 'openssl'
+          ssl_context = OpenSSL::SSL::SSLContext.new
+          ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          http_client = http_client.use(ssl_context: ssl_context)
+        end
+
+        http_client
       end
     end
   end

data/lib/versacommerce/theme_api_client/resources/file.rb

@@ -73,7 +73,7 @@ module Versacommerce
 
         def delete
           unless new_record?
-            response = fetcher.delete(file_path(path))
+            fetcher.delete(file_path(path))
             content_will_change!
             self.new_record = true
           end
@@ -94,7 +94,7 @@ module Versacommerce
           unless new_record?
             response = fetcher.get(download_path(path))
             self.content = response.to_s
-            clear_attribute_changes(:content)
+            clear_attribute_changes([:content])
           end
 
           self

data/lib/versacommerce/theme_api_client/version.rb

@@ -1,5 +1,5 @@
 module Versacommerce
   class ThemeAPIClient
-    VERSION = Gem::Version.new('0.1.3')
+    VERSION = Gem::Version.new('1.0.2')
   end
 end

data/lib/versacommerce/theme_api_client.rb

@@ -7,10 +7,12 @@ require 'versacommerce/theme_api_client/version'
 
 module Versacommerce
   class ThemeAPIClient
-    attr_accessor :authorization
+    attr_accessor :authorization, :ssl_verify
     attr_writer :base_url, :fetcher
 
     def initialize(attributes = {})
+      @ssl_verify = true  # Default to true (secure by default)
+
       attributes.each do |key, value|
         public_send("#{key}=", value)
       end

data/versacommerce-theme_api_client.gemspec

@@ -3,8 +3,7 @@ require_relative 'lib/versacommerce/theme_api_client/version'
 Gem::Specification.new do |spec|
   spec.name          = 'versacommerce-theme_api_client'
   spec.version       = Versacommerce::ThemeAPIClient::VERSION
-  spec.authors       = ['Tobias Bühlmann']
-  spec.email         = ['buehlmann@versacommerce.de']
+  spec.authors       = ['VersaCommerce GmbH']
 
   spec.summary       = 'API Client for the VersaCommercer Theme API.'
   spec.description   = 'This Gem acts as an API Client for the VersaCommerce Theme API.'
@@ -16,14 +15,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(/\Aexe/) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = '>= 3.1.0'
 
-  spec.add_runtime_dependency 'http', '>= 0.8.12', '< 1.0.0'
-  spec.add_runtime_dependency 'activesupport', '~> 4.2'
-  spec.add_runtime_dependency 'activemodel', '~> 4.2'
+  spec.add_runtime_dependency 'http', '~> 5.0'
+  spec.add_runtime_dependency 'activesupport', '>= 4.2', '< 7.0'
+  spec.add_runtime_dependency 'activemodel', '>= 4.2', '< 7.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.8'
-  spec.add_development_dependency 'rake', '~> 10.4'
-  spec.add_development_dependency 'pry', '0.10.1'
-  spec.add_development_dependency 'pry-stack_explorer', '0.4.9.2'
+  spec.add_development_dependency 'bundler', '>= 1.8'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'pry', '~> 0.14'
+  spec.add_development_dependency 'pry-stack_explorer', '~> 0.6'
 end

metadata

@@ -1,75 +1,81 @@
 --- !ruby/object:Gem::Specification
 name: versacommerce-theme_api_client
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.2
 platform: ruby
 authors:
-- Tobias Bühlmann
-autorequire: 
+- VersaCommerce GmbH
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2015-06-18 00:00:00.000000000 Z
+date: 2025-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.8.12
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.8.12
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.8'
 - !ruby/object:Gem::Dependency
@@ -78,50 +84,52 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: pry-stack_explorer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.9.2
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.9.2
+        version: '0.6'
 description: This Gem acts as an API Client for the VersaCommerce Theme API.
 email:
-- buehlmann@versacommerce.de
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
+- CHANGELOG.md
+- CLAUDE.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -144,7 +152,7 @@ homepage: https://github.com/versacommerce/versacommerce-theme_api_client
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -152,16 +160,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: API Client for the VersaCommercer Theme API.
 test_files: []