resourcespace-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 12ee38b0f2c62de30514d7c97cb16c75869d80b3887e13b6c9a662f949bfbea6
+  data.tar.gz: ee59831391f451cb97fe9e4e796349cc0f4fdd4cb67b27ad09fbf82da976e2b2
+SHA512:
+  metadata.gz: cf1a67fa696a6535f9743649f485230129bdf36ffaeaeddea73461bdc9202b9ca5dc8ec93d73f5e3f00aef7193b4bbb565a6264e1ca4f0a06c3c907be9692031
+  data.tar.gz: 0314fdd3b2d5f6c03a98f9bc121855789efe99c3032d4851844edbd783a45dd26e74cf185c5a8b52c5f99e93d14393ffa2c42051d6d5e7a8b862772ba436947f

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+# Omakase Ruby styling for Rails
+inherit_gem: { rubocop-rails-omakase: rubocop.yml }
+
+# Overwrite or add rules to create your own house style
+#
+# # Use `[a, [b, c]]` not `[ a, [ b, c ] ]`
+# Layout/SpaceInsideArrayLiteralBrackets:
+#   Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.4.4

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# 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).
+
+## [0.1.0] - 2024-03-21
+
+### Added
+- Initial release of BrowserMCP wrapper
+- Basic browser automation functionality
+  - Navigation (navigate_to, go_back, go_forward)
+  - Element interaction (click, hover, type, select_option)
+  - Element properties (text, value, attributes, state)
+  - Page state management
+  - Screenshot and console log capture
+  - JavaScript evaluation
+- Robust error handling with automatic retries
+- Comprehensive configuration options
+- Integration tests
+- Documentation

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Your Name
+
+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,355 @@
+# ResourceSpace Ruby Client
+
+A comprehensive Ruby client library for the [ResourceSpace](https://www.resourcespace.com/) open-source Digital Asset Management system. This gem provides an easy-to-use interface for managing web assets including images, CSS files, JavaScript files, fonts, and other digital resources.
+
+[![Gem Version](https://badge.fury.io/rb/resourcespace-ruby.svg)](https://badge.fury.io/rb/resourcespace-ruby)
+[![Build Status](https://github.com/survey-flunkie/resourcespace-ruby/workflows/CI/badge.svg)](https://github.com/survey-flunkie/resourcespace-ruby/actions)
+[![Documentation](https://img.shields.io/badge/docs-rubydoc.info-blue)](https://rubydoc.info/gems/resourcespace-ruby)
+
+## Features
+
+- **Complete API Coverage**: Supports all major ResourceSpace API endpoints
+- **Web Asset Focused**: Optimized for managing web development assets (images, CSS, JS, fonts, icons)
+- **Authentication**: Secure SHA256 signature-based authentication
+- **File Operations**: Upload, download, and manage files with ease
+- **Search & Collections**: Powerful search capabilities and collection management
+- **Metadata Management**: Comprehensive metadata and field management
+- **Error Handling**: Robust error handling with specific exception types
+- **Configurable**: Flexible configuration options with global and instance-level settings
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resourcespace-ruby'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install resourcespace-ruby
+```
+
+## Quick Start
+
+### Basic Configuration
+
+```ruby
+require 'resourcespace'
+
+# Configure globally
+ResourceSpace.configure do |config|
+  config.url = "https://your-resourcespace.com/api/"
+  config.user = "your_username"
+  config.private_key = "your_private_key" # Get this from your ResourceSpace profile
+  config.timeout = 30
+end
+
+# Or configure per instance
+client = ResourceSpace::Client.new(
+  url: "https://your-resourcespace.com/api/",
+  user: "your_username",
+  private_key: "your_private_key"
+)
+```
+
+### Basic Usage
+
+```ruby
+# Test connection
+status = client.test_connection
+puts "Connected to ResourceSpace #{status['version']}"
+
+# Search for web assets
+results = client.search.search_web_assets("images")
+puts "Found #{results.length} image assets"
+
+# Upload a web asset
+uploaded = client.resources.upload_file(
+  File.open("assets/logo.png"),
+  caption: "Company Logo"
+)
+
+# Create a collection for web assets
+collection = client.collections.create_web_asset_collection(
+  "Website Assets",
+  asset_type: "images"
+)
+
+# Add resource to collection
+client.collections.add_resource_to_collection(uploaded['ref'], collection['ref'])
+```
+
+## Web Asset Management
+
+This gem is specifically designed to work well with web development assets:
+
+### Upload Web Assets
+
+```ruby
+# Upload different types of web assets
+logo = client.resources.upload_file("assets/logo.png")
+stylesheet = client.resources.upload_file("assets/main.css")
+script = client.resources.upload_file("assets/app.js")
+font = client.resources.upload_file("assets/custom-font.woff2")
+```
+
+### Search for Specific Asset Types
+
+```ruby
+# Search by asset type
+images = client.search.search_web_assets("images")
+css_files = client.search.search_web_assets("css")
+js_files = client.search.search_web_assets("javascript")
+fonts = client.search.search_web_assets("fonts")
+
+# Search by file extension
+svg_files = client.search.search_by_extension(["svg"])
+web_fonts = client.search.search_by_extension(["woff", "woff2", "ttf"])
+```
+
+### Organize with Collections
+
+```ruby
+# Create collections for different asset types
+image_collection = client.collections.create_web_asset_collection(
+  "Website Images",
+  asset_type: "images"
+)
+
+css_collection = client.collections.create_web_asset_collection(
+  "Stylesheets",
+  asset_type: "css"
+)
+
+# Get all web asset collections
+web_collections = client.collections.get_web_asset_collections
+```
+
+### Manage Web Asset Metadata
+
+```ruby
+# Set up web asset metadata fields (one-time setup)
+client.metadata.create_web_asset_fields
+
+# Update resource with web asset metadata
+client.metadata.update_web_asset_metadata(resource_id, {
+  title: "Hero Background Image",
+  asset_type: "Image",
+  dimensions: "1920x1080",
+  usage_rights: "Creative Commons",
+  purpose: "Website header background"
+})
+```
+
+## Advanced Usage
+
+### Resource Management
+
+```ruby
+# Create a new resource
+resource = client.resources.create_resource(
+  name: "Company Logo",
+  resource_type: 1,
+  metadata: {
+    12 => "logo, branding, company", # Keywords field
+    51 => "Image" # Custom asset type field
+  }
+)
+
+# Get resource details
+details = client.resources.get_resource_data(resource_id)
+
+# Update resource metadata
+client.resources.update_field(resource_id, 8, "New Title")
+
+# Download resource
+client.resources.download_resource(resource_id, "/local/path/file.jpg")
+
+# Get alternative files
+alternatives = client.resources.get_alternative_files(resource_id)
+```
+
+### Advanced Search
+
+```ruby
+# Advanced search with multiple criteria
+results = client.search.advanced_search({
+  title: "logo",
+  extensions: ["png", "svg"],
+  from_date: "2023-01-01",
+  to_date: "2023-12-31"
+}, {
+  order_by: "date",
+  sort: "desc",
+  fetchrows: 20
+})
+
+# Search by date range
+recent = client.search.search_by_date_range("2023-01-01", "2023-12-31")
+
+# Get recently added resources
+latest = client.search.recent_resources(10)
+```
+
+### Collection Management
+
+```ruby
+# Create collection
+collection = client.collections.create_collection(
+  "Marketing Assets",
+  public: false,
+  allow_changes: true
+)
+
+# Add multiple resources
+resource_ids = [123, 124, 125]
+client.collections.add_resources_to_collection(resource_ids, collection_id)
+
+# Search public collections
+public_collections = client.collections.search_public_collections("web")
+```
+
+### User & Permissions
+
+```ruby
+# Check user capabilities
+capabilities = client.users.capabilities
+puts "Can upload: #{capabilities[:upload]}"
+puts "Can edit: #{capabilities[:edit_resources]}"
+
+# Check specific permissions
+can_download = client.users.can_download?
+has_admin = client.users.admin?
+
+# Check resource-specific permissions
+can_edit_resource = client.users.can_edit_resource?(resource_id)
+```
+
+## Configuration Options
+
+```ruby
+ResourceSpace.configure do |config|
+  config.url = "https://your-resourcespace.com/api/"  # Required
+  config.user = "username"                           # Required
+  config.private_key = "your_private_key"           # Required
+  config.timeout = 30                               # Request timeout (seconds)
+  config.retries = 3                                # Number of retry attempts
+  config.verify_ssl = true                          # Verify SSL certificates
+  config.auth_mode = "userkey"                      # Authentication mode
+  config.debug = false                              # Enable debug logging
+  config.logger = Logger.new(STDOUT)               # Custom logger
+end
+```
+
+## Error Handling
+
+The gem provides specific exception types for different error conditions:
+
+```ruby
+begin
+  resource = client.resources.get_resource_data(999)
+rescue ResourceSpace::NotFoundError => e
+  puts "Resource not found: #{e.message}"
+rescue ResourceSpace::AuthenticationError => e
+  puts "Authentication failed: #{e.message}"
+rescue ResourceSpace::AuthorizationError => e
+  puts "Access denied: #{e.message}"
+rescue ResourceSpace::ValidationError => e
+  puts "Invalid data: #{e.message}"
+rescue ResourceSpace::ServerError => e
+  puts "Server error: #{e.message}"
+rescue ResourceSpace::NetworkError => e
+  puts "Network error: #{e.message}"
+end
+```
+
+## Rails Integration
+
+For Rails applications, add an initializer:
+
+```ruby
+# config/initializers/resourcespace.rb
+ResourceSpace.configure do |config|
+  config.url = ENV['RESOURCESPACE_URL']
+  config.user = ENV['RESOURCESPACE_USER']
+  config.private_key = ENV['RESOURCESPACE_PRIVATE_KEY']
+  config.timeout = 30
+end
+```
+
+Then use in your application:
+
+```ruby
+class AssetsController < ApplicationController
+  def upload
+    client = ResourceSpace::Client.new
+    uploaded = client.resources.upload_file(params[:file])
+
+    # Store reference in your model
+    @asset = Asset.create(
+      name: uploaded['title'],
+      resourcespace_id: uploaded['ref'],
+      file_type: uploaded['file_extension']
+    )
+  end
+end
+```
+
+## Testing
+
+Run the test suite:
+
+```bash
+$ bundle exec rspec
+```
+
+Run tests with coverage:
+
+```bash
+$ COVERAGE=1 bundle exec rspec
+```
+
+## Development
+
+After checking out the repo, run:
+
+```bash
+$ bin/setup
+$ bundle exec rake spec
+```
+
+To install this gem onto your local machine:
+
+```bash
+$ bundle exec rake install
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## API Reference
+
+For complete API documentation, see the [ResourceSpace API documentation](https://www.resourcespace.com/knowledge-base/api/).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Support
+
+- Documentation: [https://rubydoc.info/gems/resourcespace-ruby](https://rubydoc.info/gems/resourcespace-ruby)
+- Issues: [https://github.com/survey-flunkie/resourcespace-ruby/issues](https://github.com/survey-flunkie/resourcespace-ruby/issues)
+- ResourceSpace Documentation: [https://www.resourcespace.com/knowledge-base/](https://www.resourcespace.com/knowledge-base/)

data/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative "config/application"
+
+Rails.application.load_tasks

data/lib/resourcespace/client.rb

@@ -0,0 +1,245 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday/multipart"
+require "json"
+require "digest"
+require "uri"
+
+module ResourceSpace
+  # Main client class for interacting with ResourceSpace API
+  #
+  # @example
+  #   client = ResourceSpace::Client.new(
+  #     url: "https://your-resourcespace.com/api/",
+  #     user: "your_username",
+  #     private_key: "your_private_key"
+  #   )
+  class Client
+    # @return [Configuration] client configuration
+    attr_reader :config
+
+    # @return [Resource] resource management interface
+    attr_reader :resources
+
+    # @return [Collection] collection management interface
+    attr_reader :collections
+
+    # @return [Search] search interface
+    attr_reader :search
+
+    # @return [User] user management interface
+    attr_reader :users
+
+    # @return [Metadata] metadata management interface
+    attr_reader :metadata
+
+    # Initialize a new ResourceSpace client
+    #
+    # @param url [String] ResourceSpace API URL
+    # @param user [String] ResourceSpace username
+    # @param private_key [String] ResourceSpace private API key
+    # @param config [Configuration] configuration object
+    # @param options [Hash] additional configuration options
+    def initialize(url: nil, user: nil, private_key: nil, config: nil, **options)
+      @config = config || ResourceSpace.config.dup
+
+      # Set configuration from parameters
+      @config.url = url if url
+      @config.user = user if user
+      @config.private_key = private_key if private_key
+
+      # Apply additional options
+      options.each { |key, value| @config.public_send("#{key}=", value) if @config.respond_to?("#{key}=") }
+
+      # Validate configuration
+      @config.validate!
+
+      # Initialize API interfaces
+      @resources = Resource.new(self)
+      @collections = Collection.new(self)
+      @search = Search.new(self)
+      @users = User.new(self)
+      @metadata = Metadata.new(self)
+    end
+
+    # Make a GET request to the ResourceSpace API
+    #
+    # @param function [String] API function name
+    # @param params [Hash] request parameters
+    # @return [Hash] parsed JSON response
+    def get(function, params = {})
+      request(:get, function, params)
+    end
+
+    # Make a POST request to the ResourceSpace API
+    #
+    # @param function [String] API function name
+    # @param params [Hash] request parameters
+    # @return [Hash] parsed JSON response
+    def post(function, params = {})
+      request(:post, function, params)
+    end
+
+    # Upload a file to ResourceSpace
+    #
+    # @param file [File, String] file object or file path
+    # @param params [Hash] additional parameters
+    # @return [Hash] parsed JSON response
+    def upload_file(file, params = {})
+      file_param = if file.is_a?(String)
+                     Faraday::UploadIO.new(file, mime_type_for_file(file))
+                   else
+                     Faraday::UploadIO.new(file, mime_type_for_file(file.path))
+                   end
+
+      params = params.merge(filedata: file_param)
+      request(:post, "upload_file", params, multipart: true)
+    end
+
+    # Download a file from ResourceSpace
+    #
+    # @param download_url [String] download URL
+    # @param file_path [String] local file path to save to
+    # @return [Boolean] true if successful
+    def download_file(download_url, file_path)
+      response = connection.get(download_url)
+
+      if response.success?
+        File.write(file_path, response.body)
+        true
+      else
+        handle_error_response(response)
+      end
+    end
+
+    # Test the API connection
+    #
+    # @return [Hash] system status information
+    def test_connection
+      get("get_system_status")
+    end
+
+    private
+
+    # Make an HTTP request to the ResourceSpace API
+    #
+    # @param method [Symbol] HTTP method (:get or :post)
+    # @param function [String] API function name
+    # @param params [Hash] request parameters
+    # @param multipart [Boolean] whether to use multipart encoding
+    # @return [Hash] parsed JSON response
+    def request(method, function, params = {}, multipart: false)
+      # Prepare base parameters
+      request_params = {
+        user: config.user,
+        function: function
+      }.merge(params)
+
+      # Build query string for signing
+      query_string = URI.encode_www_form(request_params.reject { |_k, v| v.is_a?(Faraday::UploadIO) })
+
+      # Generate signature
+      signature = generate_signature(query_string)
+      request_params[:sign] = signature
+      request_params[:authmode] = config.auth_mode
+
+      # Make the request
+      response = if method == :get
+                   connection.get("", request_params)
+                 else
+                   if multipart
+                     connection.post("", request_params)
+                   else
+                     connection.post("", URI.encode_www_form(request_params))
+                   end
+                 end
+
+      handle_response(response)
+    end
+
+    # Generate SHA256 signature for API authentication
+    #
+    # @param query_string [String] URL-encoded query string
+    # @return [String] SHA256 hexadecimal signature
+    def generate_signature(query_string)
+      Digest::SHA256.hexdigest("#{config.private_key}#{query_string}")
+    end
+
+    # Get the Faraday connection instance
+    #
+    # @return [Faraday::Connection] configured connection
+    def connection
+      @connection ||= Faraday.new(url: config.url) do |conn|
+        conn.request :multipart
+        conn.request :url_encoded
+        conn.adapter Faraday.default_adapter
+
+        # Set timeout
+        conn.options.timeout = config.timeout
+
+        # Set headers
+        conn.headers["User-Agent"] = config.user_agent
+        config.default_headers.each { |key, value| conn.headers[key] = value }
+
+        # Add response middleware
+        conn.response :logger, config.logger if config.debug && config.logger
+      end
+    end
+
+    # Handle API response and parse JSON
+    #
+    # @param response [Faraday::Response] HTTP response
+    # @return [Hash] parsed JSON response
+    # @raise [Error] if response indicates an error
+    def handle_response(response)
+      if response.success?
+        parse_json_response(response.body)
+      else
+        handle_error_response(response)
+      end
+    end
+
+    # Handle error responses and raise appropriate exceptions
+    #
+    # @param response [Faraday::Response] HTTP response
+    # @raise [Error] appropriate error based on status code
+    def handle_error_response(response)
+      message = "HTTP #{response.status}"
+
+      # Try to extract error message from response body
+      if response.body && !response.body.empty?
+        begin
+          parsed_body = JSON.parse(response.body)
+          message = parsed_body["error"] || parsed_body["message"] || message
+        rescue JSON::ParserError
+          message = response.body.length > 200 ? "#{response.body[0..200]}..." : response.body
+        end
+      end
+
+      raise ResourceSpace.from_response(response.status, message, response.body)
+    end
+
+    # Parse JSON response body
+    #
+    # @param body [String] response body
+    # @return [Hash] parsed JSON
+    # @raise [ParseError] if JSON parsing fails
+    def parse_json_response(body)
+      return {} if body.nil? || body.empty?
+
+      JSON.parse(body)
+    rescue JSON::ParserError => e
+      raise ParseError.new("Failed to parse JSON response: #{e.message}", data: { body: body })
+    end
+
+    # Get MIME type for a file
+    #
+    # @param file_path [String] file path
+    # @return [String] MIME type
+    def mime_type_for_file(file_path)
+      require "mime/types"
+      MIME::Types.type_for(file_path).first&.content_type || "application/octet-stream"
+    end
+  end
+end